Merge pull request #644 from Ralim/docs
Updating some of the markdown docs
This commit is contained in:
Ben V. Brown
GitHub
88
README.md
88
README.md
@@ -1,72 +1,40 @@
|
||||
[](https://app.codeship.com/projects/379118)
|
||||
|
||||
|
||||
# TS100 & TS80 Firmware
|
||||
# Flexible Soldering iron control Firmware
|
||||
|
||||
Originally concieved as an alternative firmware for the TS100, this firmware has evolved into a complex soldering iron control firmware.
|
||||
|
||||
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 at the end of 2016 and has since seen vast improvements, especially some very smart work by community members.
|
||||
The firmware implements all of the standard features of a "smart" soldering iron, with lots of little extras and tweaks.
|
||||
I highly reccomend reading the installation guide fully when installing on your iron.
|
||||
|
||||
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 community.
|
||||
For soldering irons that are designed to be powered by "smart" power sources (QC and PD), the firmware supports settings around the negotiated power and voltage.
|
||||
For soldering irons that are designed to be powered by batteries (TS100), settings for a cutoff voltage for battery protection are supported.
|
||||
|
||||
On the TS100 there are settings to allow you to specify a cutoff voltage for different lithium-ion 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.
|
||||
There are 25 languages currently supported as of present. When downloading the firmware for your soldering iron take node of the language code in the file name.
|
||||
|
||||
This project is considered feature complete for use as a soldering iron, *so please suggest any feature improvements you would like!*
|
||||
|
||||
*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.*
|
||||
|
||||
## Core Features
|
||||
## Key Features
|
||||
|
||||
* PID iron temperature control
|
||||
* PID style iron temperature control
|
||||
* Automatic sleep with selectable sensitivity
|
||||
* Motion wake support
|
||||
* Settings menu on the unit
|
||||
* All settings exposed in intuitive menu
|
||||
* (TS100) Set a voltage lower limit for Lithium batteries so you don't kill your battery pack
|
||||
* (TS80 ) Set 18W or 24W settings for your power bank
|
||||
* All settings saved to flash when you exit the menu
|
||||
* (TS80) Set 18W or 24W settings for your power bank
|
||||
* Improved readability Fonts
|
||||
* Use hardware features to improve reliability
|
||||
* Can disable movement detection if desired
|
||||
* Full tip profile calibration
|
||||
* Boost mode lets you temporarily change the temperature when soldering (ie raise the temperature for short periods of time)
|
||||
* Boost mode lets you temporarily change the temperature when soldering (i.e. raise the temperature for short periods of time)
|
||||
* (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
|
||||
* [Custom boot up logo support](upgrading.md)
|
||||
* Automatic LCD rotation based on the orientation
|
||||
* Supports both the version 1 and version 2 hardware (different accelerometers)
|
||||
|
||||
# Upgrading your iron
|
||||
|
||||
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. 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.
|
||||
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.
|
||||
|
||||
## 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.
|
||||
|
||||
# Menu System
|
||||
|
||||
This new firmware uses a new menu system to allow access to the settings on the device.
|
||||
@@ -77,32 +45,34 @@ 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
|
||||
|
||||
More details are over in the [Menu information.](menu.md)
|
||||
Detailed operation details are over in the [Menu information.](menu.md)
|
||||
|
||||
## Thanks
|
||||
|
||||
|
||||
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
|
||||
If you love this firmware and want to continue my caffeine addiction, you can do so [here](https://paypal.me/RalimTek) (or email me for other options).
|
||||
I also want to give a shout out to all of the [Fantastic Contributors](https://github.com/Ralim/ts100/graphs/contributors).
|
||||
|
||||
Especially to the following users, who have helped in various ways that are massively appreciated:
|
||||
|
||||
* [dhiltonp](https://github.com/dhiltonp)
|
||||
* [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)
|
||||
|
||||
* [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)
|
||||
* [GeminiServer](https://github.com/GeminiServer)
|
||||
* [PixelPirate](https://github.com/PixelPirate)
|
||||
* [Firebie](https://github.com/Firebie)
|
||||
* [Agatti](https://github.com/agatti)
|
||||
* [Discip](https://github.com/discip)
|
||||
|
||||
## Licence
|
||||
|
||||
The code in this repository that is based on the STM tools is under a BSD-like licence.
|
||||
The code created by the community is GNU GPLv3. Unless noted elsewhere.
|
||||
The FreeRToS is under its own licence.
|
||||
Other components such as FreeRTOS have their 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 no old versions of the firmware scattered around. If this firmware does make you money, it would be nice to receive a donation, however, there is no enforcement.
|
||||
Please do not re-host the files, but rather link to this page, so that there are no old versions of the firmware scattered around.
|
||||
|
||||
2
menu.md
2
menu.md
@@ -1,5 +1,6 @@
|
||||
# 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
|
||||
|
||||
@@ -24,7 +25,6 @@ Scrolling through the submenu will return you back to its entry location after y
|
||||
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:
|
||||
|
||||
|
||||
69
upgrading.md
Normal file
69
upgrading.md
Normal file
@@ -0,0 +1,69 @@
|
||||
# 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. 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.
|
||||
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.
|
||||
Reference in New Issue
Block a user