Merge pull request #461 from Ralim/UpdatingDocs

Its about time this gets a damn update...

2 files changed, 127 insertions, 83 deletions

diff --git a/README.md b/README.md
index c5db456e..d010a608 100644
--- a/README.md
+++ b/README.md
@@ -1,62 +1,70 @@
-# TS100
+# TS100 & TS80 Firmware
 
-This is a complete rewrite of the open source software for the ts100 soldering iron.
-The version two fork of this code has no shared code with the original firmware from Miniware (E-design) group.
+This firmware is a fresh start for these soldering irons. Designed from the ground up as fully featured control software that leaves nothing to be desired.
+It originally started back back at the end of 2016 and has since seen vast improvements, especially some very smart work by community members.
 
-This project is considered feature complete for use as a soldering iron, *so please suggest any feature improvements you would like!*
+The firmware supports everything you would expect in the soldering iron, and has the same features as the stock firmware with some nice extras packed in.
+There is a comprehensive menu system in the iron that allows for adjustment of all the settings on the unit, and support for various languages is added by the communitiy.
 
-A short(ish) video that goes through every single menu option in the firmware is available [over here](https://www.youtube.com/watch?v=WlnpboYfxNk).
-This video was created on an earlier 1.x version of the firmware, so alot has changed but should be fairly intuitive as the menu has vastly improved.
+On the TS100 there are settings to allow you to specify a cutoff voltage for different lithium iron battery packs to protect your power source.
+For the TS80 these are removed and replaced with the selection of 18W or 24W depending on what your QC power bank can support.
+Otherwise both systems work very similar and should support all the features.
 
-*This firmware does **NOT** support the usb port while running for changing settings. This is done through the onscreen menu only. Logos are edited using the tool or python script and uploaded in DFU mode.*
+This project is considered feature complete for use as a soldering iron, *so please suggest any feature improvements you would like!*
 
-*Please note that when running the iron off a Lithium battery pack, the Iron is only rated to 24V input. So using a fully charged 6S battery *slightly* exceeds this rating, and is done so at your own risk.
-Please calibrate your irons voltage reading when you are using a lithium battery after any firmware upgrades.*
+*This firmware does **NOT** support the usb port while running for changing settings. This is done through the onscreen menu only. Logos are edited using the tool or python script and uploaded in DFU mode.*
 
-## Features
+## Core Features
 
 * PID iron temperature control
 * Automatic sleep with selectable sensitivity
 * Motion wake support
 * Settings menu on the unit
-* Set a voltage lower limit for Lithium batteries so you dont kill your battery pack
+* (TS100) Set a voltage lower limit for Lithium batteries so you dont kill your battery pack
+* (TS80 ) Set 18W or 24W settings for your power bank
 * All settings saved to flash when you exit the menu
 * Improved readability Fonts
 * Use hardware features to improve reliability
 * Can disable movement detection if desired
-* Calibration of the thermocouple offset
+* Full tip profile calibration
 * Boost mode lets you temporarily change the temperature when soldering (ie raise temperature for short periods of time)
-* Battery charge level indicatior if power source set to a lipo cell count.
-* Custom bootup logo support
+* (TS100) Battery charge level indicator if power source set to a lipo cell count.
+* (TS80) Power bank operating voltage is displayed.
+* Custom boot up logo support.
 * Automatic LCD rotation based on orientation
-* Supports both the version 1 and version 2 hardware
+* Supports both the version 1 and version 2 hardware (different accelerometers)
 
-## Upgrading your ts100 iron
+# Upgrading your iron
 
-This is completely safe, if it goes wrong just put the .hex file from the official website onto the unit and your 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 *ts100_EN.hex* unless you want the translations, they are ts100_*language short name*.hex.
+This is completely safe, if it goes wrong just put the .hex file from the official website onto the unit and your 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. 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. Disable Teracopy or other Explorer replacements.
-2. Hold the button closest to the tip, and plug in the USB to the computer.
-3. The unit will appear as a USB drive.
-4. Drag the .hex file onto the USB drive.
-5. The unit will disconnect and reconnect.
-6. The filename will have changed to end in .RDY (=success) or .ERR (=error)
-7. If it ends with .RDY you're done! Otherwise something went wrong, retry. E.g. try to copy the firmware with the windows command line tool "copy" instead of explorer
+```
+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 didnt 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 adventurerous out there, you can also load this firmware onto the device using a SWD programmer.
+For the more adventurous out there, you can also load this firmware onto the device using a SWD programmer.
 On the bottom of the MCU riser pcb, there are 4 pads for programming.
-There is a complete device flash backup included in this repository. (Note this includes the bootloader, so will need a SWD programmer to load onto the unit). Please do not use the backup of the bootloader for anything malicious, its only saved here for those who are tinkering with their iron and decide to replace it.
+There is a complete device flash backup included in this repository. (Note this includes the bootloader, so will need a 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
 
 ## 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.
+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.
 
-## New Menu System
+# Menu System
 
 This new firmware uses a new menu system to allow access to the settings on the device.
 When on the main screen, the unit shows prompts for the two most common operations.
@@ -66,74 +74,33 @@ When on the main screen, the unit shows prompts for the two most common operatio
 * Holding the button near the tip will enter soldering temperature adjust mode (This is the same as the one in the soldering menu, just to let you edit before heating up).
 * Holding the button near the USB end will show the firmware version details.
 
-## 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.
+More details are over in the [Menu information.](menu.md)
 
-### 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.
-This is more critical than before with the new cell count based cutout voltage.
-
-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 minimise the error to your original measurement
-7. Hold both buttons to save and exit to the menu
-
-### Calibrating tip offset
-
-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.
+## Thanks
 
-### 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.
+If you love this firmware and want to continue my caffeine addiction, you can do so here (or email me for other options) : https://paypal.me/RalimTek
+I also want to should out to all of the [Fantastic Contributors](https://github.com/Ralim/ts100/graphs/contributors).
 
-The boost temperature is set in the settings menu.
+Especially to the following users, who have helped in various ways that are massively appreciated.:
 
-## Thanks
+* [dhiltonp](https://github.com/dhiltonp)
+* [Mrkvozrout](https://github.com/Mrkvozrout)
+* [jonnieZG](https://github.com/jonnieZG)
+* [federck](https://github.com/federck)
+* [jvitkauskas](https://github.com/jvitkauskas)
+* [doegox](https://github.com/doegox)
+* [perillamint](https://github.com/perillamint)
 
-If you love this firmware and want to continue my caffine addiction, you can do so here (or email me for other options) : https://paypal.me/RalimTek
 
 ## Licence
 
 The code in this repository that is based on the STM tools is under a BSD like licence.
-The code created by the communitiy is GNU GPLv3.
+The code created by the community is GNU GPLv3. Unless noted elsewhere.
 The FreeRToS is under its own licence.
 
 ## Commercial Use
 
 This software is provided as-is, so I cannot provide any commercial support for the firmware. However you are more than welcome to distribute links to the firmware, or provide irons with this software on them. 
 Please do not re-host the files, but rather link to this page, so that there are not old versions of the firmware scattered around. If this firmware does make you money, it would be nice to recieve a donation, however there is no enforcement.
+
diff --git a/menu.md b/menu.md
new file mode 100644
index 00000000..66a59aaf
--- /dev/null
+++ b/menu.md
@@ -0,0 +1,77 @@
+# Menu System
+
+
+## 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.
+This is more critical than before with the new cell count based cutout voltage.
+
+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 promped 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 measuing the tip temperature directly. This tends to be significantly more accurate.
+
+If you do calibrate your own values for a tip because its missing from the menu or because you think the one in the menu is really wrong, raise an issue on github and I'm 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.