Remove old codeship + docs updates

Documentation/Development.md

@@ -0,0 +1,20 @@
+# Development
+
+Building this software can be performed two ways, using the STMCubeIDE or using command line tools.
+
+## STM Cube IDE
+
+The repository is setup to try and make this painless, when starting the IDE you can import the project by pointing the internal search to the workspace folder of this repository. If you start with a fresh installation, close the welcome screen tab, and then in the left sidebar, there is an option to "import". Select General -> Import existing projects -> Set the top location option to this repositories workspace -> Should find the TS100 project.
+
+## Developing with command line tools & building a release
+
+In the `workspace/TS100` folder there is a makefile that can be used to build the repository using command line tools.
+when running the `make` command, specify which model of the device & the language you would like to use.
+
+`make -j8 lang=EN model=TS80`
+
+To build a release instead, run the build.sh script. This will update translations and also build every language for both TS100 and TS80 models.
+
+## Updating languages
+
+To update the language translation files & associated font map, execute the `make_translation.py` code from the translations directory.

Documentation/History.md

@@ -0,0 +1,148 @@
+# Version Changes
+
+## V2.11
+
+* First TS80P support
+* Added in a USB-PD driver stack for the FUSB302
+* Fixed some graphical glitches
+
+## V2.10
+
+* GUI polish (animations and scroll bars)
+* Power pulse to keep power supplies alive
+* Adjustable tip response gain
+
+## V2.09
+
+* Adjustable steps in temperature adjustment
+* Git hash now in build string
+* Adjustable language to set if US units are available or not
+* Some minor QC3 improvements
+
+## V2.08
+
+* Fixes auto start in sleep mode
+* Power limiters
+
+## V2.07
+
+* QC fixes 
+* Cosmetic fixes for leading 0's
+
+## V2.06
+
+* Warning on settings reset
+* Temp temp re-write
+* Display calibration offset
+* Hide some leading 0's
+* Menu timeouts
+
+## V2.05
+
+* Language updates
+
+
+## V2.04
+
+* GUI updates
+
+## V2.03
+
+* Support for new accelerometers
+
+## V2.02
+
+* Adds small font
+
+## V2.01
+
+* Newer settings menu
+
+## V2.00
+
+* Complete re-write of the low layer system to use the STM32 HAL for easier development
+* This allowed easier setup for the new ADC auto measuring system
+* Better tip PWM control
+* Moved to FreeRTOS for scheduling
+* Complete re-write from blank
+* Added detailed screen views
+* Added smaller font for said screen views
+
+
+## V1.17
+
+* Added blinking cooldown display
+* Allowed smaller sleep timeout values
+* New font!
+* Automatic startup option
+
+## V1.16
+
+* Added automatic rotation support
+* Added power display graph
+
+## V1.15
+
+* Added support for a custom bootup logo to be programmed via the DFU bootloader
+
+## V1.14
+
+* Changed input voltage cutoff to be based on cell count rather than voltage
+
+## V1.13
+
+* Swapped buttons for menu to prevent accidentally changing first menu item
+* Added auto key repeat
+
+## V1.12
+
+* Increases sensitivity options to be 1*9 with 0 off state
+* Fixes issue where going from COOL *> soldering can leave screen off
+
+## V1.11
+
+* Boost mode
+* Change sensitivity options to be 1*8
+
+## V1.10
+
+* Adds help text to settings
+* Improves settings for the display update rate
+
+## V1.09
+
+* Adds display modes, for slowing down or simplifying the display
+
+## V1.08
+
+* Fix settings menu not showing flip display
+
+## V1.07
+
+* Adds shutdown time to automatically shutdown the iron after inactivity
+
+## V1.06
+
+* Changes H and C when the iron is heating to the minidso chevron like images
+
+## V1.05
+
+* Adds ability to calibrate the input voltage measurement
+
+## V1.04
+
+* Increased accuracy of the temperature control
+* Improved PID response slightly
+* Allows temperature offset calibration
+* Nicer idle screen
+
+## V1.03
+
+* Improved Button handling
+* Ability to set motion sensitivity
+* DC voltmeter page shows input voltage
+
+## V1.02
+
+* Adds hold both buttons on IDLE to access the therometer mode
+* Changes the exit soldering mode to be holding both buttons (Like original firmware)

Documentation/Menu.md

@@ -0,0 +1,77 @@
+# Menu System
+
+In this firmware for these soldering irons, all settings are adjustable on the device itself. This means you do **not** require a computer to change any settings.
+
+## Soldering mode
+
+In this mode the iron works as you would expect, pressing either button will take you to a temperature change screen.
+Use each button to go up and down in temperature. Pressing both buttons will exit you from the temperature menu (or wait 3 seconds and it will time out).
+Pressing both buttons or holding the button near the USB will exit the soldering mode.
+Holding the button at the front of the iron will enter boost mode (if enabled).
+
+## Settings Menu
+
+This menu allows you to cycle through all the options and set their values.
+The button near the USB cycles through the options, and the one near the tip changes the selected option.
+Note that settings are not saved until you exit the menu.
+If you leave the unit alone (ie don't press any buttons) on a setting, after 3 seconds the screen will scroll a rough description of the setting.
+
+The menu is arranged so that the most often used settings are first.
+With submenu's being selected to enter using the front button (as if you were going to change the setting).
+Scrolling through the submenu will return you back to its entry location after you scroll through all of the options.
+
+### Calibrating input voltage
+
+Due to the tolerance on the resistors used for the input voltage divider, some irons can be up to 0.6V out on the voltage measurement.
+Please calibrate your iron if you have any issues with the cutoff voltage.
+Note that cutoff messages can also be triggered by using a power supply that is too weak and fails under the load of the iron.
+
+To calibrate your iron:
+
+1. Measure the input voltage with a multimeter and note it down.
+2. Connect the input to your iron.
+3. Enter the settings menu
+4. Under the advanced submenu
+5. Select the calibrate voltage option
+6. Use the front and back buttons to adjust the displayed voltage to minimize the error to your original measurement
+7. Hold both buttons to save and exit to the menu
+
+### Tip Model Selection
+
+The menu now lets you select which tip you are using with your iron. This lets the unit know which gain value to use for your tip, this varies slightly between models and can help with temperature accuracy.
+There is also an option for a *custom* tip. This basically means that you will tune the tip parameters yourself.
+
+### Calibrating tip offset (Set tip model)
+
+Some tips will have an offset on their readings, to calibrate this out perform the following steps:
+
+1. Connect power to your iron
+2. Make sure the tip is at room temperature (ie. wait for a fair while after using the iron before calibration)
+3. Enter the settings menu
+4. Scroll down to the advanced menu, and then the temperature calibration
+5. Press the button to change the option (tip button)
+6. The display will start to scroll a warning message to check that the tip is at ambient temperature!
+7. Press the button near the tip of the iron to confirm
+8. The display will go to "...." for a short period of time as the unit measures the tip temperature and the handle temperature and compares them
+9. The display will then go back to *TMP CAL*
+10. Calibration is done, just exit the settings menu as normal
+11. You're done, enjoy your iron!
+
+### Calibration of custom tip
+
+There are two methods to calibrate the tip, the simple mode which requires boiling water, and an advanced mode that requires a method of measuring the actual tip of the tip.
+
+Advanced mode is preffered.
+
+In simple mode you first need to have the tip at room temperature to start, and then when prompted place the tip into a cup of boiling water, wait a few seconds and then press a button to confirm.
+
+In advanced mode, follow instructions on the screen, you will need to adjust the ranges to find two calibration points by measuring the tip temperature directly. This tends to be significantly more accurate.
+
+If you do calibrate your own values for a tip because it's missing from the menu or because you think the one in the menu is really wrong, raise an issue on github and I'll be happy to look at adding it or revising the existing settings.
+
+
+### Boost mode
+
+This allows you to change the front key (one near the tip) to become a boost button when you hold it for > 2 seconds. This allows you to set this button to change the soldering temperature for short periods. For example when soldering a big joint and you want to boost the temperature a bit.
+
+The boost temperature is set in the settings menu.

Documentation/Power.md

@@ -0,0 +1,24 @@
+# Power & Performance
+
+Both the TS100 and TS80 are PWM controlled resistive heating elements.
+This means that the electronics in the handle can only turn the heating element on and off.
+This *means* that the power proivded in the tip is 100% controlled by the supply voltage used.
+
+Both irons at their simplest are just a resistor connected to your power source via a switch.
+
+When the switch is on, the power in the resistor is `Current (I) times Volts (V)`.
+Current through the resistor is `Volts (V) divided by Resistance (R)`.
+Combining these two gives the common equation, power is `Volts (V) squared / Resistance (R)`.
+
+The resistance of the tip is fixed, 8.5 ohms for the TS100 and 4.5 ohms for the TS80.
+
+This means that for both irons, the power delivered to the soldering tip is proportional to the voltage used, squared.
+This is why the TS100 performs poorly when run off 12V power supplies.
+
+## Output Control & Regulation
+
+Both soldering irons use a FET to switch the power to the soldering iron tip. This is a P-MOSFET and its controlled via a small transistor circuit, which in turn is controlled via the STM32. The STM32 controls this PWM output proportional to the output from the PID control loop running in the software.
+
+To measure the tip temperature in the iron, the iron has a small op-amp connected across the terminals, this is setup to measure the voltage across the same terminals that are used the power the tip. In order to be able to read the small voltage generated by the thermocouple junction, the irons output must be turned off.
+Once the output is turned off (via the FET), the system has a recovery time as the tip capacitance discharges and the op-amp exits saturation. After this delay period, the STM32 ADC samples the output of the op-amp 8 times quickly and then sets a flag to turn the PWM output back on.
+This enforces a small dead time in the output signal while this occurs, so there is a balance between sampling the temperature often to maintain stable tip temperature control and sampling less often to increase the maximum power deliverable to the tip

Documentation/Translation.md

@@ -0,0 +1,6 @@
+# Translation
+If you would like to contribute a translation, use the [Translation Editor](http://htmlpreview.github.io/?https://github.com/Ralim/ts100/blob/master/Translation%20Editor/TranslationEditor.html).
+
+[Open a reference language file and optionally a target language file](https://github.com/Ralim/ts100/tree/master/Translation%20Editor).
+
+You can create a pull request with the new / updated json configuration file, and this will include this language into the new builds for the firmware.

Documentation/Upgrading.md

@@ -0,0 +1,72 @@
+# Upgrading your iron
+
+## Miniware irons (TS100, TS80, TS80P)
+
+This is completely safe, but if it goes wrong just put the .hex file from the official website onto the unit and you're back to the old firmware. Downloads for the hex files to flash are available on the [releases page.](https://github.com/Ralim/ts100/releases) The file you want is called *(MODEL)_EN.hex* unless you want the translations, they are (MODEL)_*language short name*.hex. Where (MODEL) is either TS100 or TS80.
+
+Officially the bootloader on the iron only works under Windows (use the built-in File Explorer, as alternative file managers or copy handlers like Teracopy will fail). However, users have reported that it does work under Mac, and can be made to work under Linux *sometimes*. Details over on the [wiki page](https://github.com/Ralim/ts100/wiki/Upgrading-Firmware). 
+
+
+
+1. Hold the button closest to the tip, and plug in the USB to the computer.
+2. The unit will appear as a USB drive.
+3. Drag the .hex file onto the USB drive.
+4. The unit will disconnect and reconnect.
+5. The filename will have changed to end in .RDY or .ERR
+6. If it ends with .RDY you're done! Otherwise, something went wrong.
+7. If it didn't work the first time, try copying the file again without disconnecting the iron, often it will work on the second shot.
+8. Disconnect the USB and power up the iron. You're good to go.
+
+
+
+For the more adventurous out there, you can also load this firmware onto the device using an SWD programmer.
+
+On the bottom of the MCU riser PCB, there are 4 pads for programming. On v2.51A PCB revision `USB_D+` is shorted to `SWDIO` and `USB_D-` is shorted to `SWCLK` so debugging works without disassembly (attach while staying in the bootloader). Installing [dapboot from eDesignOSS](https://github.com/eDesignOSS/dapboot) (`make TARGET=TS100 -C src`) is recommended as it allows reliable flashing of binary files with [dfu-util](http://dfu-util.sourceforge.net/).
+
+There is a complete device flash backup included in this repository. (Note this includes the bootloader, so will need an SWD programmer to load onto the unit).
+
+For the TS80 the SWD pins are used for the QC negotiation, so you can actually connect to the SWD power via the USB connector.
+
+
+### FAQ
+
+#### The file is showing up with the extension `.ERR`
+
+This can occur duing the programming process if any of the checks in the bootloader fail. This is often triggered by anti-virus software or using a non-windows host OS.
+
+First, try just copying the file a second time.
+
+1. Attach the iron in DFU mode
+2. Copy the hex file to the device
+3. The device disconnects and connects with the `.ERR` file
+4. Copy the same hex file again  **DO NOT TRY AND DELETE THE OLD ONE**
+5. The device will disconnect and reconnect again
+6. The device _should_ now have the `.RDY` file
+7. Your done.
+
+If this fails, if you are on Mac or Linux reading the wiki page about programming can help. There is also a very long issue thread going through all of the different attempts around this too.
+
+If you are on windows, its often to try another computer (friends, work, partners etc).
+
+#### Device randomly disconnects or does not show up in DFU mode
+
+First, check the USB cable your using has the data pins; test it on another device. There are a surprisingly large number of usb-micro cables that are power _only_.
+
+Secondly, try other USB ports. Often different USB controllers will interact with the units differently due to design quirks in the miniware design.
+
+## Setting a custom bootup image
+
+This firmware uses a different method of updating the bootup image.
+This removes the need for emulating a USB drive on the iron just to allow for a bootup image to be setup.
+There are further instructions on the [wiki](https://github.com/Ralim/ts100/wiki/Logo-Editor).
+Instructions are kept on the wiki so that users can update the information if they find extra helpful information.
+
+## Alternative bootloader
+
+If you are an advanced user, and you have used `usb-dfu` tools before, or you would like to learn; there is an alternative bootloader for these irons.
+This will **NOT** show up as a USB storage drive, but instead show up using a standard DFU protocol device. You can then use dfu tools or GUI's to upgrade the iron using the `.bin` files that are posted to the releases page.
+
+To change to dapboot based alternative bootloader, you need to flash the hex file from [here](https://github.com/eDesignOSS/ts100-bl-flasher/releases).
+`ts100-stockbl.hex` will reflash the stock bootloader, `ts100-dapboot.hex` will flash the new dapboot based usb bootloader.
+
+Note that this is only reccomended for users who know what they doing. If you dont not understand how this works; please dont flash this.