1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
|
<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
<meta charset="utf-8" />
<meta http-equiv="X-UA-Compatible" content="IE=edge" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><link rel="canonical" href="https://ralim.github.io/IronOS/GettingStarted/" />
<link rel="shortcut icon" href="../img/favicon.ico" />
<title>Getting Started - IronOS</title>
<link rel="stylesheet" href="../css/theme.css" />
<link rel="stylesheet" href="../css/theme_extra.css" />
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.8.0/styles/github.min.css" />
<script>
// Current page data
var mkdocs_page_name = "Getting Started";
var mkdocs_page_input_path = "GettingStarted.md";
var mkdocs_page_url = "/IronOS/GettingStarted/";
</script>
<!--[if lt IE 9]>
<script src="../js/html5shiv.min.js"></script>
<![endif]-->
<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.8.0/highlight.min.js"></script>
<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.8.0/languages/yaml.min.js"></script>
<script>hljs.highlightAll();</script>
</head>
<body class="wy-body-for-nav" role="document">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side stickynav">
<div class="wy-side-scroll">
<div class="wy-side-nav-search">
<a href=".." class="icon icon-home"> IronOS
</a><div role="search">
<form id ="rtd-search-form" class="wy-form" action="../search.html" method="get">
<input type="text" name="q" placeholder="Search docs" aria-label="Search docs" title="Type search term here" />
</form>
</div>
</div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
<ul>
<li class="toctree-l1"><a class="reference internal" href="..">Home</a>
</li>
</ul>
<ul class="current">
<li class="toctree-l1 current"><a class="reference internal current" href="./">Getting Started</a>
<ul class="current">
<li class="toctree-l2"><a class="reference internal" href="#the-home-screen-or-idle-screen">The Home screen (or idle screen)</a>
<ul>
<li class="toctree-l3"><a class="reference internal" href="#hidden-extras">Hidden Extras</a>
</li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="#soldering-mode">Soldering Mode</a>
<ul>
<li class="toctree-l3"><a class="reference internal" href="#idle-sleep">Idle Sleep</a>
<ul>
<li class="toctree-l4"><a class="reference internal" href="#optional-hall-effect-feature-pinecil-only">Optional Hall Effect Feature (Pinecil only):</a>
</li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="#idle-shutdown">Idle Shutdown</a>
</li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="#profile-mode-mhp30-only">Profile Mode (MHP30 only)</a>
</li>
<li class="toctree-l2"><a class="reference internal" href="#settings-menu">Settings Menu</a>
</li>
</ul>
</li>
</ul>
<p class="caption"><span class="caption-text">Flashing the firmware</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../Flashing/MHP30/">MHP30</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../Flashing/Pinecil%20V1/">Pinecil V1</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../Flashing/Pinecil%20V2/">Pinecil V2</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../Flashing/TS80%28P%29/">TS80(P)</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../Flashing/TS100/">TS100</a>
</li>
</ul>
<p class="caption"><span class="caption-text">Operation</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../Menu/">Main Menu</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../Settings/">Settings</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../DebugMenu/">Debug Menu</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../Power/">Power</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../Temperature/">Temperature</a>
</li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../Logo/">Startup Logo</a>
</li>
</ul>
<p class="caption"><span class="caption-text">Hardware</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../HallSensor/">Hall Sensor (Pinecil)</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../Bluetooth/">Bluetooth (Pinecil V2)</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../Hardware/">Hardware Notes</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../Troubleshooting/">Troubleshooting</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../HardwareIssues/">Known Hardware Issues</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../PowerSources/">Power sources</a>
</li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../Translation/">Translations</a>
</li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../Development/">Development</a>
</li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" role="navigation" aria-label="Mobile navigation menu">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="..">IronOS</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content"><div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
<li><a href=".." class="icon icon-home" aria-label="Docs"></a> »</li>
<li class="breadcrumb-item active">Getting Started</li>
<li class="wy-breadcrumbs-aside">
<a href="https://github.com/ralim/IronOS/edit/dev/Documentation/GettingStarted.md" class="icon icon-github"> Edit on GitHub</a>
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div class="section" itemprop="articleBody">
<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 flashing guide for your device:</p>
<ul>
<li><a href="https://ralim.github.io/IronOS/Flashing/MHP30">MHP30</a></li>
<li><a href="https://ralim.github.io/IronOS/Flashing/Pinecil%20V1/">Pinecil V1</a></li>
<li><a href="https://ralim.github.io/IronOS/Flashing/Pinecil%20V2/">Pinecil V2</a></li>
<li><a href="https://ralim.github.io/IronOS/Flashing/TS80%28P%29/">TS80 / TS80P</a></li>
<li><a href="https://ralim.github.io/IronOS/Flashing/TS100">TS100</a></li>
</ul>
<p>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="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>
<p><img alt="Home Screen" src="https://raw.githubusercontent.com/Ralim/IronOS/dev/Documentation/images/HomeScreen.png" /></p>
<p>Note that this may be drawn mirrored depending on the orientation of your screen (detailed mode shows a different home screen).</p>
<p>The soldering iron symbol on the screen will appear near the tip. This is here to indicate that pressing the button closest to the front of the iron will enter soldering mode.</p>
<p>And naturally, the slider controls icon (or spanner icon in older versions) 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="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>On devices that do not support profile mode, 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="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>
<p>Pressing and holding the button near the tip will enter <strong>Boost</strong> mode. This allows a temporary override of 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.</p>
<p>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.</p>
<p>Pressing and holding <strong>both</strong> 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.</p>
<h3 id="idle-sleep">Idle Sleep</h3>
<p>If the iron detects a period of time without any significant movement, it will enter sleep mode. This is indicated with a screen graphic similar to Zzzz (or text in detailed mode).</p>
<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="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="profile-mode-mhp30-only">Profile Mode (MHP30 only)</h2>
<p>On devices that support it, a long press on <code>(+/A)</code> takes you into profile mode, which initiates the profile selected in the relevant settings.</p>
<p>Profile mode plays out as follows:</p>
<ol>
<li>Check if the temperature is below 55C. If not, you will get a warning and cannot enter profile mode.</li>
<li>Preheat by raising the target temperature to the configured preheat temperature with the configured preheat speed.</li>
<li>Wait for the device to reach the preheat temperature.</li>
<li>Gradually move the target temperature to the configured end temperature of the first phase over the configured duration. </li>
<li>Wait for the device to reach the end temperature. </li>
<li>Repeat steps 4 and 5 for the next phases until there are no more phases configured.</li>
<li>Cool down by lowering the target temperature to 0 with the configured cooldown speed. </li>
<li>Once the temperature is below 55C, sound the buzzer (if available) and exit profile mode. </li>
</ol>
<p>You can manually exit profile mode manually in the same way as the soldering mode, by pressing and holding the rear button or pressing both buttons at once.</p>
<h2 id="settings-menu">Settings Menu</h2>
<p>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 <em>need</em> to come back here to figure them all out.</p>
<p>To navigate the menu, the two buttons act separately.
The rear button (<code>-/B</code>) is pressed to enter the menu and scrolls down the main options, and the other front button (<code>+/A</code>) will enter and change the current option.</p>
<p>To see a description of an option, just wait, and after a few seconds, it will scroll across the screen.</p>
<p>The menu is comprised of a 'main menu' of categories and then sub-items that allow you to adjust parameters.</p>
<p>You can long hold buttons to change through options faster, and there is some acceleration when holding the buttons.</p>
<p>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).</p>
<p>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.</p>
<p>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.</p>
<p>If you want to start over, simply go to Advanced settings > Restore default settings, confirm using the front (<code>+/A</code>) button. This sets all menu items to defaults, and keeps the same version firmware.</p>
</div>
</div><footer>
<div class="rst-footer-buttons" role="navigation" aria-label="Footer Navigation">
<a href=".." class="btn btn-neutral float-left" title="Home"><span class="icon icon-circle-arrow-left"></span> Previous</a>
<a href="../Flashing/MHP30/" class="btn btn-neutral float-right" title="MHP30">Next <span class="icon icon-circle-arrow-right"></span></a>
</div>
<hr/>
<div role="contentinfo">
<!-- Copyright etc -->
</div>
Built with <a href="https://www.mkdocs.org/">MkDocs</a> using a <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<div class="rst-versions" role="note" aria-label="Versions">
<span class="rst-current-version" data-toggle="rst-current-version">
<span>
<a href="https://github.com/ralim/IronOS/" class="fa fa-github" style="color: #fcfcfc"> GitHub</a>
</span>
<span><a href=".." style="color: #fcfcfc">« Previous</a></span>
<span><a href="../Flashing/MHP30/" style="color: #fcfcfc">Next »</a></span>
</span>
</div>
<script src="../js/jquery-3.6.0.min.js"></script>
<script>var base_url = "..";</script>
<script src="../js/theme_extra.js"></script>
<script src="../js/theme.js"></script>
<script src="../search/main.js"></script>
<script>
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</body>
</html>
|
