sv/IronOS
1
0
Fork 0
forked from me/IronOS
Code Pull Requests Activity

Deployed a1d84fff with MkDocs version: 1.3.1

Browse Source
This commit is contained in:
github-actions[bot]
2022-09-21 09:33:57 +00:00
parent 4e0b2a82a7
commit f367e75a42
9 changed files with 14 additions and 14 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
GettingStarted/index.html
View File

@@ -141,10 +141,10 @@
<h1 id="getting-started">Getting Started</h1>
<p>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 <a href="/Documentation/Flashing.md">Flashing Guide</a>. It is recommended to update to the newest stable release.</p>
If your device did not come with IronOS already installed, or if you need to update to the latest version; please see the <a href="https://ralim.github.io/IronOS/Flashing/">Flashing Guide</a>. It is recommended to update to the newest stable release.</p>
<p>Once your Iron has been flashed, on first power on it <em>may</em> warn you about the system settings being reset.
<em>Do not panic</em>; this is 100% completely normal. This is here to note to you that they have been reset to handle the internal structure changing.</p>
<p>If you receive a warning about the accelerometer or USB-PD not being detected, please see <a href="/Documentation/HardwareIssues.md">here</a>.</p>
<p>If you receive a warning about the accelerometer or USB-PD not being detected, please see <a href="https://ralim.github.io/IronOS/HardwareIssues/">here</a>.</p>
<h2 id="the-home-screen-or-idle-screen">The Home screen (or idle screen)</h2>
<p>This is the landing page of the firmware, from here you can choose to either go into the <a href="#Settings-Menu">settings menu</a> or go into <a href="#Soldering-Mode">soldering mode</a>.</p>
<p>By default this will show a screen similar to the one below:</p>
@@ -154,12 +154,12 @@ If your device did not come with IronOS already installed, or if you need to upd
<p>And naturally, the spanner like icon represents that pressing the button near the rear of the soldering iron will enter the settings menu.</p>
<p>In the settings, you can turn on a detailed 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.</p>
<p>Depending on how your device is being powered, at right side of the screen, the firmware will either show the voltage your unit is being provided with, a battery icon (if battery mode is enabled) or a power plug icon.</p>
<p>If you see an (<strong>X</strong>) 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. First, try removing the tip screw and tip and gently reinstalling both; ensure that the tip is seated all the way back. If the issue persists please see the <a href="/Documentation/HardwareIssues.md">hardware issues section</a>.</p>
<p>If you see an (<strong>X</strong>) 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. First, try removing the tip screw and tip and gently reinstalling both; ensure that the tip is seated all the way back. If the issue persists please see the <a href="https://ralim.github.io/IronOS/HardwareIssues/">hardware issues section</a>.</p>
<p>This OLED screen features burn-in protection; if no buttons or movement have been detected for a while it will automatically blank the screen to reduce burn-in when the iron is left unattended. Any movement or button press will wake the screen.</p>
<h3 id="hidden-extras">Hidden Extras</h3>
<p>Additionally to the two icons shown, there are two "hidden" actions that can be performed on this menu.</p>
<p>If you press and hold the button near the tip (<code>+/A</code>), this enters the temperature adjustment screen. Normally this is not required; but if you would like to adjust the set temperature <em>before</em> the tip starts to heat, this can be useful.</p>
<p>If you press and hold the button near the rear of the iron (<code>-/B</code>), it will take you into the <a href="/Documentation/DebugMenu.md">debug menu</a>.</p>
<p>If you press and hold the button near the rear of the iron (<code>-/B</code>), it will take you into the <a href="https://ralim.github.io/IronOS/DebugMenu/">debug menu</a>.</p>
<h2 id="soldering-mode">Soldering Mode</h2>
<p>When you press the button to enter the soldering mode, the iron will instantly start to heat up the tip.</p>
<p>The firmware defaults to 320 °C as the set point for the soldering mode, however on this screen you can enter into the adjustment screen by pressing either button.</p>
@@ -171,7 +171,7 @@ If your device did not come with IronOS already installed, or if you need to upd
<p>In Sleep mode, the temperature of the iron automatically lowers to 150 °C (default), which is just below the melting point of the solder. This helps reduce rate of oxidation and damage to the iron tip. In general, when not using the iron, unplug it or let it sleep to increase the longevity of replaceable tips. The default sleep temperature can be customized.</p>
<p>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.</p>
<h4 id="optional-hall-effect-feature-pinecil-only">Optional Hall Effect Feature (Pinecil only):</h4>
<p>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 <a href="/Documentation/HallSensor.md">details on installation</a>.</p>
<p>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 <a href="https://ralim.github.io/IronOS/HallSensor/">details on installation</a>.</p>
<h3 id="idle-shutdown">Idle Shutdown</h3>
<p>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.</p>
<h2 id="settings-menu">Settings Menu</h2>