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

Flashing links

Browse Source
This commit is contained in:
Ben V. Brown
2022-09-21 21:35:33 +10:00
parent c128a899d1
commit 395f3e1583
5 changed files with 45 additions and 30 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
Documentation/Flashing/Pinecil V1.md
View File

@@ -125,7 +125,7 @@ Two Options for Windows
dfu-util -D Pinecil_EN.dfu
```
- If you have errors, see Troubleshooting [above](https://ralim.github.io/IronOS/Flashing/#troubleshooting).
- If you have errors, see Troubleshooting above.
### Option 2: use the GUI tool from chip vendor
@@ -156,4 +156,4 @@ dfu-util -D Pinecil_EN.dfu
18. Do not need to press any buttons, a new screen should appear.
19. To confirm upgrade, hold the minus (`-`) button down for a few seconds, it then shows new firmware version v2.xx.x....date
- If you have errors, see Troubleshooting [above](https://ralim.github.io/IronOS/Flashing/#troubleshooting).
- If you have errors, see Troubleshooting above.

15
Documentation/GettingStarted.md
View File

@@ -1,7 +1,15 @@
# Getting Started
Getting started with IronOS on your Pinecil/TS80/TS80P/TS100.
If your device did not come with IronOS already installed, or if you need to update to the latest version; please see the [Flashing Guide](https://ralim.github.io/IronOS/Flashing/). It is recommended to update to the newest stable release.
If your device did not come with IronOS already installed, or if you need to update to the latest version; please see the flashing guide for your device:
- [MHP30](https://ralim.github.io/IronOS/Flashing/MHP30)
- [Pinecil V1](https://ralim.github.io/IronOS/Flashing/Pinecil%20V1/)
- [Pinecil V2](https://ralim.github.io/IronOS/Flashing/Pinecil%20V2/)
- [TS80 / TS80P](https://ralim.github.io/IronOS/Flashing/TS80%28P%29/)
- [TS100](https://ralim.github.io/IronOS/Flashing/TS100)
It is recommended to update to the newest stable release.
Once your Iron has been flashed, on first power on it _may_ warn you about the system settings being reset.
_Do not panic_; this is 100% completely normal. This is here to note to you that they have been reset to handle the internal structure changing.
@@ -59,14 +67,13 @@ In Sleep mode, the temperature of the iron automatically lowers to 150 °C (defa
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.
#### Optional Hall Effect Feature (Pinecil only):
Pinecil has an unpopulated footprint (U14) for a hall effect sensor (Si7210-B-00-IV). Adding the sensor and placing a neodymium magnet on the holder stand will trigger Pinecil to sleep after it enters the stand, and Zzzz will appear on-screen. The magnet is positioned on the stand in proximity to the sensor/handle which then activates one of 10 user defined settings (0=off, 1=lowest sensitivity, 9=highest sensitivity). Read the Hall Sensor document for [details on installation](https://ralim.github.io/IronOS/HallSensor/).
Pinecil has an unpopulated footprint (U14) for a hall effect sensor (Si7210-B-00-IV). Adding the sensor and placing a neodymium magnet on the holder stand will trigger Pinecil to sleep after it enters the stand, and Zzzz will appear on-screen. The magnet is positioned on the stand in proximity to the sensor/handle which then activates one of 10 user defined settings (0=off, 1=lowest sensitivity, 9=highest sensitivity). Read the Hall Sensor document for [details on installation](https://ralim.github.io/IronOS/HallSensor/).
### Idle Shutdown
If, after entering sleep mode, the iron still does not see movement for a much longer time (default=10 minutes); it will shut down and return to the home screen.
## Settings Menu
The settings menu is the most evolving aspect of the firmware, so each option is not documented here. However, do not panic, as every menu option has an on-screen description so you don't _need_ to come back here to figure them all out.
@@ -82,7 +89,7 @@ You can long hold buttons to change through options faster, and there is some ac
There is a small scrollbar that appears along the right edge of the screen to indicate how far through the current list you are (looks like a dot).
Additionally, this scrollbar will blink rapidly when you are on the last value in a range of a sub-menu. For example, if you are in Motion Sensitivity, which has a range of 0 - 9, it will blink when you are at 9.
Additionally, this scrollbar will blink rapidly when you are on the last value in a range of a sub-menu. For example, if you are in Motion Sensitivity, which has a range of 0 - 9, it will blink when you are at 9.
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 your needs.

25
Documentation/index.md
View File

@@ -12,15 +12,14 @@ This project is considered feature complete for use as a soldering iron, _so ple
_This firmware does **NOT** support the USB port while running for changing settings. This is done through the onscreen menu only. Logos are edited on a computer and flashed like firmware._
| Device | DC | QC | PD | EPR | BLE | Battery | Recommended |
|:----------:|:--:|:--:|:--:|:---:|:---:|:-------:|:-----------:|
| MHP30 |❌ | ❌ | ✔️ | ❌ | ❌ | ❌ | ✔️ |
| Pinecil V1 |✔️ | ✔️ | ✔️ | ❌ | ❌ | ✔️ | ✔️ |
| Pinecil V2 |✔️ | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ |
| TS80P |❌ | ✔️ | ✔️ | ❌ | ❌ | ✔️ | ✔️ |
| TS100 |✔️ | ❌ | ❌ | ❌ | ❌ | ✔️ | ❌ |
| TS80 |❌ | ✔️ | ❌ | ❌ | ❌ | ✔️ | ❌ |
| Device | DC | QC | PD | EPR | BLE | Battery | Recommended |
| :--------: | :-: | :-: | :-: | :-: | :-: | :-----: | :---------: |
| MHP30 | ❌ | ❌ | ✔️ | ❌ | ❌ | ❌ | ✔️ |
| Pinecil V1 | ✔️ | ✔️ | ✔️ | ❌ | ❌ | ✔️ | ✔️ |
| Pinecil V2 | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ |
| TS80P | ❌ | ✔️ | ✔️ | ❌ | ❌ | ✔️ | ✔️ |
| TS100 | ✔️ | ❌ | ❌ | ❌ | ❌ | ✔️ | ❌ |
| TS80 | ❌ | ✔️ | ❌ | ❌ | ❌ | ✔️ | ❌ |
\*Please note that Miniware started shipping TS100's using cloned STM32 Chips. While these do work with IronOS, their DFU bootloader works terribly, and it is hard to get it to successfully flash larger firmware images like IronOS without timing out. This is the main reason why the TS100 is **_no longer recommended_**.
@@ -32,7 +31,13 @@ Long hold the rear button in soldering mode to exit back to the start screen.
## Installation
For notes on installation for your device, please refer to the [Flashing Guide](https://ralim.github.io/IronOS/Flashing/).
For notes on installation for your device, please refer to the flashing guide for your device:
- [MHP30](https://ralim.github.io/IronOS/Flashing/MHP30)
- [Pinecil V1](https://ralim.github.io/IronOS/Flashing/Pinecil%20V1/)
- [Pinecil V2](https://ralim.github.io/IronOS/Flashing/Pinecil%20V2/)
- [TS80 / TS80P](https://ralim.github.io/IronOS/Flashing/TS80%28P%29/)
- [TS100](https://ralim.github.io/IronOS/Flashing/TS100)
## Key Features

26
README.md
View File

@@ -20,16 +20,14 @@ This project is considered feature complete for use as a soldering iron, _so ple
_This firmware does **NOT** support the USB port while running for changing settings. This is done through the onscreen menu only. Logos are edited on a computer and flashed like firmware._
| Device | DC | QC | PD | EPR | BLE | Battery | Recommended |
|:----------:|:--:|:--:|:--:|:---:|:---:|:-------:|:-----------:|
| MHP30 |❌ | ❌ | ✔️ | ❌ | ❌ | ❌ | ✔️ |
| Pinecil V1 |✔️ | ✔️ | ✔️ | ❌ | ❌ | ✔️ | ✔️ |
| Pinecil V2 |✔️ | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ |
| TS80P |❌ | ✔️ | ✔️ | ❌ | ❌ | ✔️ | ✔️ |
| TS100 |✔️ | ❌ | ❌ | ❌ | ❌ | ✔️ | ❌ |
| TS80 |❌ | ✔️ | ❌ | ❌ | ❌ | ✔️ | ❌ |
| Device | DC | QC | PD | EPR | BLE | Battery | Recommended |
| :--------: | :-: | :-: | :-: | :-: | :-: | :-----: | :---------: |
| MHP30 | ❌ | ❌ | ✔️ | ❌ | ❌ | ❌ | ✔️ |
| Pinecil V1 | ✔️ | ✔️ | ✔️ | ❌ | ❌ | ✔️ | ✔️ |
| Pinecil V2 | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ |
| TS80P | ❌ | ✔️ | ✔️ | ❌ | ❌ | ✔️ | ✔️ |
| TS100 | ✔️ | ❌ | ❌ | ❌ | ❌ | ✔️ | ❌ |
| TS80 | ❌ | ✔️ | ❌ | ❌ | ❌ | ✔️ | ❌ |
\*Please note that Miniware started shipping TS100's using cloned STM32 Chips. While these do work with IronOS, their DFU bootloader works terribly, and it is hard to get it to successfully flash larger firmware images like IronOS without timing out. This is the main reason why the TS100 is **_no longer recommended_**.
@@ -41,7 +39,13 @@ Long hold the rear button in soldering mode to exit back to the start screen.
## Installation
For notes on installation for your device, please refer to the [Flashing Guide](https://ralim.github.io/IronOS/Flashing/).
For notes on installation for your device, please refer to the flashing guide for your device:
- [MHP30](https://ralim.github.io/IronOS/Flashing/MHP30)
- [Pinecil V1](https://ralim.github.io/IronOS/Flashing/Pinecil%20V1/)
- [Pinecil V2](https://ralim.github.io/IronOS/Flashing/Pinecil%20V2/)
- [TS80 / TS80P](https://ralim.github.io/IronOS/Flashing/TS80%28P%29/)
- [TS100](https://ralim.github.io/IronOS/Flashing/TS100)
## Key Features

5
mkdocs.yml
View File

@@ -22,9 +22,8 @@ nav:
- Hardware:
- Hall Sensor (Pinecil): HallSensor.md
- Hardware Notes: Hardware.md
- Troubleshooting:
- Troubleshooting: Troubleshooting.md
- Known Hardware Issues: HardwareIssues.md
- Troubleshooting: Troubleshooting.md
- Known Hardware Issues: HardwareIssues.md
- Translations: Translation.md
- Development: Development.md