diff options
| -rw-r--r-- | Documentation/GettingStarted.md | 32 | ||||
| -rw-r--r-- | Documentation/HardwareIssues.md | 16 | ||||
| -rw-r--r-- | README.md | 75 |
3 files changed, 63 insertions, 60 deletions
diff --git a/Documentation/GettingStarted.md b/Documentation/GettingStarted.md index 4d492b12..d80b0c77 100644 --- a/Documentation/GettingStarted.md +++ b/Documentation/GettingStarted.md @@ -22,19 +22,19 @@ The soldering iron symbol on the screen will appear near the tip. This is here t And naturally, the spanner like icon represents that pressing the button near the rear of the soldering iron will enter the settings menu. -In the settings you can turn on an advanted idle screen instead. The buttons still function the same, however, the image will be swapped for text telling you the current status of the iron with extra details. +In the settings, you can turn on an advanced idle screen instead. The buttons still function the same, however, the image will be swapped for a text telling you the current status of the iron with extra details. -Depending on how your device is being powered, at one end of the screen, the firmware will either draw text to show you the current voltage your unit is being provided with, a battery icon (if battery mode is enabled) or a power plug icon. +Depending on how your device is being powered, at one end of the screen, the firmware will either draw text to show you the current-voltage your unit is being provided with, a battery icon (if battery mode is enabled) or a power plug icon. -If you see exclamation marks (!!!) where the solderion icon should be, this indicates that the firmware can't see the tip connected. This could indicate a problem with the iron or tip if there is one inserted. First try removing and reinstalling the tip. If the issue persists please see the [hardware issues section](Documentation/HardwareIssues.md). +If you see exclamation marks (!!!) where the soldering iron should be, this indicates that the firmware can't see the tip connected. This could indicate a problem with the iron or tip if there is one inserted. First, try removing and reinstalling the tip. If the issue persists please see the [hardware issues section](Documentation/HardwareIssues.md). -This screen features a burn-in protection feature, where if no buttons or movement have been detected for a while it will automatically blank the screen to try and reduce burn in if the iron is left unattended. Any movement or button press will wake the screen. +This screen features a burn-in protection feature, where if no buttons or movement have been detected for a while it will automatically blank the screen to try and reduce burn-in if the iron is left unattended. Any movement or button press will wake the screen. ### Hidden Extras Additionally to the two icons shown, there are two "hidden" actions that can be performed on this menu. -If you press and hold on the button near the tip of the soldering iron, this will bring up the temperature adjustment screen. Normally this is not required; but if you would like to adjust the set temperature _before_ the tip starts to heat, this can be useful. +If you press and hold on to the button near the tip of the soldering iron, this will bring up the temperature adjustment screen. Normally this is not required; but if you would like to adjust the set temperature _before_ the tip starts to heat, this can be useful. If you press and hold the button near the rear of the iron it will take you into the [debug menu](Documentation/DebugMenu.md). @@ -46,15 +46,15 @@ The firmware defaults to 320C as the set point for the soldering mode, however o Pressing and holding the button near the tip will enter **boost** mode. This allows temporarily overriding the set temperature to a higher (or lower) value. This can be useful as a way to force the tip to a higher temperature to drive more wattage into a large joint when the thermal connection is not ideal. -Pressing and holding the rear button will exit soldering mode and land you back at the home screen. You can also do this by pressing both buttons at once and this will also work, this is a bit harder to do but is kept for compatibility to the Miniware firmware. +Pressing and holding the rear button will exit soldering mode and land you back at the home screen. You can also do this by pressing both buttons at once and this will also work, this is a bit harder to do but is kept for compatibility with the Miniware firmware. -Pressing and holding **both** buttons at once will enter locked mode, which will prevent the buttons doing anything. You can in the settings allow boost mode in locked mode optionally. This can be useful if you find yourself hitting the buttons and entering into the temperature adjustment screen by accident. +Pressing and holding **both** buttons at once will enter locked mode, which will prevent the buttons from doing anything. You can in the settings allow boost mode in locked mode optionally. This can be useful if you find yourself hitting the buttons and entering into the temperature adjustment screen by accident. ### Idle sleep -If the iron detects a period of time without any significant movement, it will enter into a sleep mode. This is indicated with a graphic one the screen similar to ZZzz (or text in detailed mode). +If the iron detects a period of time without any significant movement, it will enter into a sleep mode. This is indicated with a graphic on the screen similar to ZZzz (or text in detailed mode). -In this mode the temperature of the iron will automatically reduce down to a temperature just below the melting point of solder. This helps reduce the rate of oxidation and damage to the iron tip. +In this mode, the temperature of the iron will automatically reduce down to a temperature just below the melting point of the solder. This helps reduce the rate of oxidation and damage to the iron tip. Simply picking up or moving the iron will wake it back up into soldering mode. You can also press any button and this will also wake the iron up. @@ -62,23 +62,23 @@ The Pinecil has a footprint (unpopulated) on the PCB for a hall effect sensor (S ### Idle shutdown -If, after entering sleep mode the iron still does not see movement for a much longer time; it will shutdown and return to the home screen. +If, after entering sleep mode the iron still does not see movement for a much longer time; it will shut down and return to the home screen. ## Settings Menu -The settings menu is the most often evolving aspect of the firmware, so each option is not documented here. However, do not panic, as every menu option has a description so that you dont _need_ to come back here to figure them all out. +The settings menu is the most often evolving aspect of the firmware, so each option is not documented here. However, do not panic, as every menu option has a description so that you don't _need_ to come back here to figure them all out. -To navigate the menu, the two buttons act seperately. +To navigate the menu, the two buttons act separately. The button that you pressed to enter the menu (rear) cycles down the options, and the other button (front) will change the current option. -To see a description of an option, just pause and wait and after a little bit it will scroll across the screen. +To see a description of an option, just pause and wait and after a little bit, it will scroll across the screen. -The menu is comprised of a "main menu" of categories and then sub items that allow you to adjust parameters. +The menu is comprised of a "main menu" of categories and then sub-items that allows you to adjust parameters. -You can long hold buttons to change through options faster, and there is some acceleration on when holding the buttons. +You can long hold buttons to change through options faster, and there is some acceleration when holding the buttons. There is a small scrollbar that will be shown along the edge of the screen to indicate how far through the current list you are. Additionally, this scrollbar will blink rapidly when you are on the last item in a menu choice. -I highly reccomend taking a few minutes to go through all of the options in the menu to get a feel for what you can change, almost every aspect of the internal system is adjustable to suit yourself. +I highly recommend taking a few minutes to go through all of the options in the menu to get a feel for what you can change, almost every aspect of the internal system is adjustable to suit you. diff --git a/Documentation/HardwareIssues.md b/Documentation/HardwareIssues.md index cbf91341..b59bb0a5 100644 --- a/Documentation/HardwareIssues.md +++ b/Documentation/HardwareIssues.md @@ -1,26 +1,28 @@ # Hardware Issues -While we would love everything to work perfectly, sometimes that just doesnt happen. +While we would love everything to work perfectly, sometimes that just doesn't happen. +Please do not email maintainers directly, these will generally be ignored. +Keep issue discussions to GitHub issues or the discussions page so that the whole community can help and work together. ## No Accelerometer detected -If your iron was previously working, this could be a bug (and we are very sorry). Please check the currently open and recently closed issues to check if anyone else has run into this. You can try going back a release on the firmware to test if this is a new issue before opening an issue. +If your iron was previously working, this could be a bug (and we are very sorry). Please check the currently open and recently closed issues to check if anyone else has run into this. You can try going back to a release on the firmware to test if this is a new issue before opening an issue. -If this is a new iron, also feel free to open an issue if you dont see any; a vendor _could_ have changed the model of the accelerometer on us without warning _again_. In which case support should come shortly. +If this is a new iron, also feel free to open an issue if you don't see any; a vendor _could_ have changed the model of the accelerometer on us without warning _again_. In which case, support should come shortly. If your iron is new, there is a slim chance your accelerometer may be DOA and need replacement. **Note this warning will only be shown the first few times until settings are reset** -## No USB-PD ic detected +## No USB-PD IC detected -Generally this means either something went very arwy in the firmware or the chip is not answering as would normally be expected. Try rolling back to an earlier release to confirm if the issue still persists then the device may need repair. If you have some form of seller protection / support you most likely want to reach out to this to be safe. If you don't, you can always attempt replacing the IC yourself. As of writing both the TS80P and Pinecil use the FUSB302. +Generally, this means either something went very awry in the firmware or the chip is not answering as would normally be expected. Try rolling back to an earlier release to confirm if the issue still persists then the device may need repair. If you have some form of seller protection/support you most likely want to reach out to this to be safe. If you don't, you can always attempt to replace the IC yourself. As of writing both the TS80P and Pinecil use the FUSB302. **Note this warning will only be shown the first few times until settings are reset** ## No tip detected -if your tip is not being detected, the most likely cause is that the heater element has been damaged from over temperature, being dropped or bad luck. As the heater coil is part of the temperature measurement circuit neither will work if its damaged. +if your tip is not being detected, the most likely cause is that the heater element has been damaged from over-temperature, being dropped or bad luck. As the heater coil is part of the temperature measurement circuit neither will work if it's damaged. The best way to see if this is the case is to measure the resistance across the contacts to the tip using a multimeter. -you are expecting to see a measurement in the range of 4-10 ohms. Anything higher than 10 ohms is _generally_ an issue. +you are expecting to see measurements in the range of 4-10 ohms. Anything higher than 10 ohms is _generally_ an issue. @@ -4,7 +4,7 @@ # IronOS - Flexible Soldering iron control Firmware -*This repository was formerly known as TS100, its the same great code. Just with more supported devices* +_This repository was formerly known as TS100, its the same great code. Just with more supported devices_ Originally concieved as an alternative firmware for the TS100, this firmware has evolved into a complex soldering iron control firmware. @@ -16,29 +16,30 @@ For soldering irons that are designed to be powered by batteries (TS100), settin There are 25 languages currently supported as of present. When downloading the firmware for your soldering iron take note 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 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.* +_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._ +To get started with this firmware, please jump over to [here](Documentation/GettingStarted.md) ## Key Features -* PID style iron temperature control -* Automatic sleep with selectable sensitivity -* Motion wake support -* 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 -* (TS80P) Automatically negotiates appropriate PD and falls back to QC mode like TS80 -* (Pinecil) Supports all 3 power modes (PD,QC, DC In). -* Improved readability Fonts, supporting multiple languages -* Use hardware features to improve reliability -* Can disable movement detection if desired -* Boost mode lets you temporarily change the temperature when soldering (i.e. raise the temperature for short periods of time) -* (TS100/Pinecil) Battery charge level indicator if power source set to a lipo cell count -* (TS80/TS80P/Pinecil) Power bank operating voltage is displayed -* [Custom boot up logo support](Documentation/Logo.md) -* Automatic LCD rotation based on the orientation +- PID style iron temperature control +- Automatic sleep with selectable sensitivity +- Motion wake support +- 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 +- (TS80P) Automatically negotiates appropriate PD and falls back to QC mode like TS80 +- (Pinecil) Supports all 3 power modes (PD,QC, DC In). +- Improved readability Fonts, supporting multiple languages +- Use hardware features to improve reliability +- Can disable movement detection if desired +- Boost mode lets you temporarily change the temperature when soldering (i.e. raise the temperature for short periods of time) +- (TS100/Pinecil) Battery charge level indicator if power source set to a lipo cell count +- (TS80/TS80P/Pinecil) Power bank operating voltage is displayed +- [Custom boot up logo support](Documentation/Logo.md) +- Automatic LCD rotation based on the orientation ## Installation @@ -49,10 +50,10 @@ For installation for your device, please refer to the [Flashing Guide](Documenta 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. -* Pressing the button near the tip enters soldering mode -* Pressing the button near the USB enters the settings 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) -* Holding the button near the USB end will show the [debug menu](Documentation/DebugMenu.md) +- Pressing the button near the tip enters soldering mode +- Pressing the button near the USB enters the settings 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) +- Holding the button near the USB end will show the [debug menu](Documentation/DebugMenu.md) Detailed operation details are over in the [Menu information.](Documentation/Menu.md) @@ -63,19 +64,19 @@ I also want to give a shout out to all of the [Fantastic Contributors](https://g Especially to the following users, who have helped in various ways that are massively appreciated: -* [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) -* [GeminiServer](https://github.com/GeminiServer) -* [Patrick Horlebein](https://github.com/PixelPirate) -* [Firebie](https://github.com/Firebie) -* [Agatti](https://github.com/agatti) -* [Discip](https://github.com/discip) -* [Paul Fertser](https://github.com/paulfertser) +- [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) +- [GeminiServer](https://github.com/GeminiServer) +- [Patrick Horlebein](https://github.com/PixelPirate) +- [Firebie](https://github.com/Firebie) +- [Agatti](https://github.com/agatti) +- [Discip](https://github.com/discip) +- [Paul Fertser](https://github.com/paulfertser) Plus the huge number of people who have contributed translations, your effort is massively appreciated. @@ -86,6 +87,6 @@ Other components such as FreeRTOS/USB-PD have their own licence. ## Commercial Use -This software is provided as-is, so I cannot provide any commercial support for the firmware. +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. |