me/IronOS
1
0
Fork 1
mirror of https://github.com/Ralim/IronOS.git synced 2025-02-26 07:53:55 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

update readme again...

Browse Source
This commit is contained in:
Ben V. Brown
2017-09-27 11:41:55 +10:00
parent 77204f306e
commit daa04d0c80
1 changed files with 43 additions and 42 deletions
Download Patch File Download Diff File Expand all files Collapse all files

85
README.md
View File

@@ -7,34 +7,36 @@ This firmware is not complete, it is missing some features such as :
* Needs some polish on information screens * Needs some polish on information screens
* Motion sensitivity needs more polish for sensitivity levels * Motion sensitivity needs more polish for sensitivity levels
* Auto tuning PID? * Auto tuning PID?
* Input voltage calibration
While it most likely will work, It is not meant for production use just yet! While it most likely will work, It is not meant for production use just yet!
# TS100 # TS100
This is a complete rewrite of the open source software for the ts100 soldering iron. This is a complete rewrite of the open source software for the ts100 soldering iron.
This project is feature complete for use as a soldering iron, *so please suggest any feature improvements you would like!* The version two fork of this code has no shared code with the original firmware from Miniware (E-design) group.
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 project is concidered feature complete for use as a soldering iron, *so please suggest any feature improvements you would like!*
This project was started to remove the need for USB for changing system settings. 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).
In the latest official firmware they have also added a settings menu system, so it is still worth comparing the two firmwares to select your preferred option. This video was created on an earlier 1.x version of the firmware, so alot has changed and a new video will be coming soon for the 2.x fork.
**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 exceeds this rating, and is done so at your own risk. *This firmware does **NOT** support the usb port while running for changing settings. This is done through the onscreen menu only. Logos are editing using the tool or python script and uploaded in DFU mode.*
Please calibrate your irons voltage reading when you are using a lithium battery after any firmware upgrades.**
*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.*
## Features ## Features
* Soldering / Temperature control * PID iron temperature control
* Full PID iron temperature control
* Automatic sleep with selectable sensitivity * Automatic sleep with selectable sensitivity
* Motion wake support * Motion wake support
* Settings menu * Settings menu on the unit
* Set a voltage lower limit for Lithium batteries so you dont kill your battery pack. Please calibrate your input voltage first! * Set a voltage lower limit for Lithium batteries so you dont kill your battery pack
* All settings saved * All settings saved to flash when you exit the menu
* Improved readability Fonts * Improved readability Fonts
* Use hardware features to improve reliability * Use hardware features to improve reliability
* Can disable movement detection if desired * Can disable movement detection if desired
* Calibration of the temperature offset * Calibration of the thermocouple offset
* Boost mode lets you temporarily change the temperature when soldering * 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. * Battery charge level indicatior if power source set to a lipo cell count.
* Custom bootup logo support * Custom bootup logo support
* Automatic LCD rotation based on orientation * Automatic LCD rotation based on orientation
@@ -69,12 +71,14 @@ This new firmware uses a new menu system to allow access to the settings on the
When on the main screen, the unit shows prompts for the two most common operations. When on the main screen, the unit shows prompts for the two most common operations.
* Pressing the button near the tip enters soldering mode * Pressing the button near the tip enters soldering mode
* Pressing the button near the power input enters the settings menu. * Pressing the button near the power input enters the settings menu.
* Pressing both buttons together enters the Extras menu * 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).
## Soldering mode ## 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). In this mode the iron works as you would expect, pressing either button will take you to a temperature change screen.
Pressing both buttons will also exit the soldering mode. 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 ## Settings Menu
@@ -88,26 +92,22 @@ If you leave the unit alone (ie don't press any buttons) on a setting, after 3 s
* SLTME -> Sleep time, how long it takes before the unit goes to sleep * SLTME -> Sleep time, how long it takes before the unit goes to sleep
* SHTME -> Shutdown Time, how long the unit will wait after movement before shutting down completely * SHTME -> Shutdown Time, how long the unit will wait after movement before shutting down completely
* MSENSE -> Motion Sensitivity,0*9,0 means motion sensing is turned off, 9 is most sensitive, 1 is least sensitive (ie takes more movement to trigger) * MSENSE -> Motion Sensitivity,0*9,0 means motion sensing is turned off, 9 is most sensitive, 1 is least sensitive (ie takes more movement to trigger)
* TMPUNIT -> Temperature unit, C or F * ADVDSP -> Enable the advanced display (shows more details)
* TMPRND -> Temperature Rounding, {1,5,10}
* TMPSPD -> How fast the temperature should update in the soldering status screen.
* DSPROT -> Display rotation mode, Automatic, Left handed or Right handed * DSPROT -> Display rotation mode, Automatic, Left handed or Right handed
* BOOST -> Enable boost mode * BOOST -> Enable boost mode
* BTMP -> Set the temperature for the boost mode * BTMP -> Set the temperature for the boost mode
* ASART -> Automatically start the unit when power is applied (i.e. the unit will go straight into soldering mode)
Temperature rounding means that the unit will round off the temperature before displaying. This can helpt to reduce the flickering of the temperature when the unit oscillates between two temperatures. * CLBLNK -> Blink the screen as an alert when cooling down
* TMP CAL -> Use to calibrate offset on the tip temperature
## Extras Menu * RESET -> Use to force a complete reset on exit of the settings menu
* TMPUNIT -> Temperature unit, C or F
This menu defaults to showing the current temperature on the tip.
Pressing the button near the iron tip will show the current input voltage. Pressing the other button while this is show will allow you to calibrate the reading if your iron is like mine and is not overly accurate out of the factory. (Press buttons to change measurement up and down, press both to exit and save).
Pressing the button near the usb enters the temperature offset setting menu, when the iron is cold, pressing the other button will start the unit calibrating for any offset in the tip temperature.
### Calibrating input voltage ### 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. 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, Please, calibrate your iron if you have any issues with the cutoff voltage. This is more critical than before with the new cell count based cutout voltage. 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: To calibrate your Iron:
@@ -133,15 +133,15 @@ Some tips will have an offset on their readings, to calibrate this out perform t
1. Connect power to your iron 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) 2. Make sure the tip is at room temperature (ie. wait for a fair while after using the iron before calibration)
3. Press both buttons on the idle screen (showing the logo for the iron. The screen you see after power is applied). 3. Enter the settings menu
4. The iron will now show the current tip temperature. 4. Scroll down to *TMP CAL*
5. Press the button near the USB port. 5. Press the button to change the option (tip button)
6. The display will change to "CAL TEMP" 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. 7. Press the button near the tip of the iron to confirm.
8. The display should change to "CAL OK". If you recieve "CAL FAIL" let your tip cool down for longer, its too hot. 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. Press the button near the USB port to exit back to live temperature display 9. The display will then go back to *TMP CAL*
10. Press both buttons at the same time to return to the idle screen. 10. Calibration is done, just exit the settings menu as normal
11. You're done. Enjoy your iorn. 11. You're done. Enjoy your iron.
### Boost mode ### Boost mode
@@ -149,10 +149,6 @@ This allows you to change the front key (one near the tip) to become a boost but
The boost temperature is set in the settings menu. The boost temperature is set in the settings menu.
## 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 hanging around. If this firmware does make you money, it would be nice to recieve a donation, however there is no enforcement.
## Thanks ## Thanks
@@ -162,4 +158,9 @@ If you love this firmware and want to continue my caffine addiction, you can do
The code in this repository that is based on the STM tools is under a BSD like 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 communitiy is GNU GPLv3.
The FreeRToS is under its own licence. 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.