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
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
|
<!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" /><meta name="description" content="IronOS Open Source Soldering Iron firmware for Miniware and Pinecil" /><link rel="canonical" href="https://ralim.github.io/IronOS/" />
<link rel="shortcut icon" href="img/favicon.ico" />
<title>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 = "Home";
var mkdocs_page_input_path = "index.md";
var mkdocs_page_url = "/IronOS/";
</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 class="current">
<li class="toctree-l1 current"><a class="reference internal current" href=".">Home</a>
<ul class="current">
<li class="toctree-l2"><a class="reference internal" href="#getting-started">Getting Started</a>
</li>
<li class="toctree-l2"><a class="reference internal" href="#installation">Installation</a>
</li>
<li class="toctree-l2"><a class="reference internal" href="#key-features">Key Features</a>
</li>
<li class="toctree-l2"><a class="reference internal" href="#menu-system">Menu System</a>
</li>
<li class="toctree-l2"><a class="reference internal" href="#feedback">Feedback</a>
</li>
</ul>
</li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="GettingStarted/">Getting Started</a>
</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>
<li class="toctree-l1"><a class="reference internal" href="PortingToNewDevice/">New Hardware Requirements</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>
<ul>
<li class="toctree-l1"><a class="reference internal" href="History/">Changelog</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">Home</li>
<li class="wy-breadcrumbs-aside">
<a href="https://github.com/ralim/IronOS/edit/dev/Documentation/index.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="ironos-flexible-soldering-iron-control-firmware">IronOS - Flexible Soldering iron control Firmware</h1>
<p>The firmware implements all of the standard features of a 'smart' soldering iron, with lots of little extras and tweaks.
I highly recommend reading the installation guide fully when installing on your iron. And after install just explore the settings menu.</p>
<p>For soldering irons that are designed to be powered by 'smart' power sources (PD and QC), the firmware supports settings around the negotiated power and voltage.
For soldering irons that are designed to be powered by batteries (TS100 & Pinecil), settings for a cutoff voltage for battery protection are supported.</p>
<p>Currently <strong>31</strong> languages are supported. When downloading the firmware for your soldering iron, take note of the language code in the file name.</p>
<p>This project is considered stable & feature complete for everyday use with a supported device, <em>so please suggest any feature improvements you would like!</em></p>
<p><em>This firmware does <strong>NOT</strong> 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.</em></p>
<table>
<thead>
<tr>
<th style="text-align: center;">Device</th>
<th style="text-align: center;">DC</th>
<th style="text-align: center;">QC</th>
<th style="text-align: center;">PD</th>
<th style="text-align: center;">EPR</th>
<th style="text-align: center;">BLE</th>
<th style="text-align: center;">Battery</th>
<th style="text-align: center;">Recommended</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align: center;">MHP30</td>
<td style="text-align: center;">❌</td>
<td style="text-align: center;">❌</td>
<td style="text-align: center;">✔️</td>
<td style="text-align: center;">❌</td>
<td style="text-align: center;">❌</td>
<td style="text-align: center;">❌</td>
<td style="text-align: center;">✔️</td>
</tr>
<tr>
<td style="text-align: center;">Pinecil V1</td>
<td style="text-align: center;">✔️</td>
<td style="text-align: center;">✔️</td>
<td style="text-align: center;">✔️</td>
<td style="text-align: center;">❌</td>
<td style="text-align: center;">❌</td>
<td style="text-align: center;">✔️</td>
<td style="text-align: center;">✔️</td>
</tr>
<tr>
<td style="text-align: center;">Pinecil V2</td>
<td style="text-align: center;">✔️</td>
<td style="text-align: center;">✔️</td>
<td style="text-align: center;">✔️</td>
<td style="text-align: center;">✔️</td>
<td style="text-align: center;">✔️</td>
<td style="text-align: center;">✔️</td>
<td style="text-align: center;">✔️</td>
</tr>
<tr>
<td style="text-align: center;">TS80P</td>
<td style="text-align: center;">❌</td>
<td style="text-align: center;">✔️</td>
<td style="text-align: center;">✔️</td>
<td style="text-align: center;">❌</td>
<td style="text-align: center;">❌</td>
<td style="text-align: center;">✔️</td>
<td style="text-align: center;">✔️</td>
</tr>
<tr>
<td style="text-align: center;">TS100</td>
<td style="text-align: center;">✔️</td>
<td style="text-align: center;">❌</td>
<td style="text-align: center;">❌</td>
<td style="text-align: center;">❌</td>
<td style="text-align: center;">❌</td>
<td style="text-align: center;">✔️</td>
<td style="text-align: center;">❌</td>
</tr>
<tr>
<td style="text-align: center;">TS80</td>
<td style="text-align: center;">❌</td>
<td style="text-align: center;">✔️</td>
<td style="text-align: center;">❌</td>
<td style="text-align: center;">❌</td>
<td style="text-align: center;">❌</td>
<td style="text-align: center;">✔️</td>
<td style="text-align: center;">❌</td>
</tr>
</tbody>
</table>
<p>*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 <strong><em>no longer recommended</em></strong>.</p>
<h2 id="getting-started">Getting Started</h2>
<p>To get started with IronOS firmware, please jump to <a href="https://ralim.github.io/IronOS/GettingStarted/">Getting Started Guide</a>.
But the <a href="https://www.merriam-webster.com/dictionary/TL%3BDR">TL;DR</a> is to press the button near the front of the iron to heat up. Use the button near the back of the iron to enter the settings menu.
Long hold the rear button in soldering mode to exit back to the start screen.</p>
<h2 id="installation">Installation</h2>
<p>For notes on installation for your device, please refer to 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>But the <em>generic</em> <a href="https://www.merriam-webster.com/dictionary/TL%3BDR">TL;DR</a> is to:</p>
<ul>
<li><a href="https://github.com/Ralim/IronOS/releases">download firmware from here</a> for the correct model with suitable language support;</li>
<li>put a device into DFU/bootloader mode (usually by keep holding A/+/front button while connecting a device to power source to power device on);</li>
<li>flash the firmware by drag-n-drop the firmware file using a file manager of your OS <strong>or</strong> using a separate flashing tool.</li>
</ul>
<h2 id="key-features">Key Features</h2>
<ul>
<li>PID style iron temperature control</li>
<li>Automatic sleep with selectable sensitivity</li>
<li>Motion wake support</li>
<li>All settings exposed in the intuitive menu</li>
<li>(TS100) Set a voltage lower limit for Lithium batteries so you don't kill your battery pack</li>
<li>(TS80) Set 18 W or 24 W settings for your power bank</li>
<li>(TS80P) Automatically negotiates appropriate PD and falls back to QC mode like TS80</li>
<li>(Pinecil) Supports all 3 power modes (PD, QC, DC In).</li>
<li>(Pinecilv2) Supports USB-PD EPR for 28V operation.</li>
<li>Improved readability Fonts, supporting multiple languages</li>
<li>Use hardware features to improve reliability</li>
<li>Can disable movement detection if desired</li>
<li>Boost mode lets you temporarily change the temperature when soldering (i.e. raise the temperature for short periods)</li>
<li>(TS100/Pinecil) Battery charge level indicator if power source set to a lipo cell count</li>
<li>(TS80/TS80P/Pinecil) Power bank operating voltage is displayed</li>
<li><a href="https://ralim.github.io/IronOS/Logo/">Custom boot up logo support</a></li>
<li>Automatic LCD rotation based on the orientation</li>
</ul>
<h2 id="menu-system">Menu System</h2>
<p>This new firmware uses a new menu system to allow access to the settings on the device.
When on the main screen and having the tip plugged in, the unit shows a pair of prompts for the two most common operations.</p>
<ul>
<li>Pressing the button near the tip enters the <em>soldering mode</em></li>
<li>Pressing the button near the USB end enters the <em>settings menu</em></li>
<li>When not in <em>soldering mode</em>, holding down the button near the tip will enter <em>soldering temperature adjust mode</em> (This is the same as the one in the <em>soldering mode</em>, but allows to adjust the temperature before heating up), in <em>soldering mode</em> however this will activate <em>boost mode</em> as long as you hold down the button.</li>
<li>Holding down the button near the USB end will show the <em><a href="https://ralim.github.io/IronOS/DebugMenu/">debug menu</a>.</em> In <em>soldering mode</em> this ends the heating.</li>
</ul>
<p>Operation details are over in the <a href="https://ralim.github.io/IronOS/Menu/">Menu information.</a></p>
<h2 id="feedback">Feedback</h2>
<p>If you would like to:</p>
<ul>
<li>report any issue related to IronOS</li>
<li>request a feature</li>
<li>provide some suggestion</li>
</ul>
<p>then you can <a href="https://github.com/Ralim/IronOS/issues/new/choose">fill this form</a> using github account*.</p>
<p>And if you would like to:</p>
<ul>
<li>ask more generic question about IronOS/supported hardware/something you're curious about/etc.</li>
<li>reach out community to chat with</li>
<li>share your soldering & DIY skills</li>
<li>share some interesting finding</li>
<li>share useful related hardware/software with others</li>
</ul>
<p>or <em>anything</em> like that, then you can use forum-like <a href="https://github.com/Ralim/IronOS/discussions">Discussions here</a>.</p>
<p>*: You may need to create it first if you don't have one - it's free of charge.</p>
</div>
</div><footer>
<div class="rst-footer-buttons" role="navigation" aria-label="Footer Navigation">
<a href="GettingStarted/" class="btn btn-neutral float-right" title="Getting Started">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="GettingStarted/" 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>
<!--
MkDocs version : 1.5.3
Build Date UTC : 2024-04-08 20:00:24.549484+00:00
-->
|
