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

Deployed b5f9ac05 with MkDocs version: 1.3.1

Browse Source
This commit is contained in:
github-actions[bot]
2022-09-21 08:11:08 +00:00
commit 2ce821f7e4
50 changed files with 10251 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

0
.nojekyll Normal file
View File

120
404.html Normal file
View File

@@ -0,0 +1,120 @@
<!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="shortcut icon" href="/IronOS/img/favicon.ico" />
<title>IronOS</title>
<link rel="stylesheet" href="/IronOS/css/theme.css" />
<link rel="stylesheet" href="/IronOS/css/theme_extra.css" />
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.5.0/styles/github.min.css" />
<script src="/IronOS/js/jquery-3.6.0.min.js" defer></script>
<!--[if lt IE 9]>
<script src="/IronOS/js/html5shiv.min.js"></script>
<![endif]-->
<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.5.0/highlight.min.js"></script>
<script>hljs.initHighlightingOnLoad();</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="/IronOS/." class="icon icon-home"> IronOS
</a><div role="search">
<form id ="rtd-search-form" class="wy-form" action="/IronOS//search.html" method="get">
<input type="text" name="q" placeholder="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="/IronOS/.">Home</a>
</li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="/IronOS/GettingStarted/">Getting Started</a>
</li>
</ul>
<p class="caption"><span class="caption-text">Troubleshooting</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="/IronOS/Troubleshooting/">Troubleshooting</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="/IronOS/HardwareIssues/">Known Hardware Issues</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/.">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="/IronOS/." class="icon icon-home" alt="Docs"></a> &raquo;</li>
<li class="wy-breadcrumbs-aside">
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div class="section" itemprop="articleBody">
<h1 id="404-page-not-found">404</h1>
<p><strong>Page not found</strong></p>
</div>
</div><footer>
<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>
</div>
<script>var base_url = '/IronOS/';</script>
<script src="/IronOS/js/theme_extra.js" defer></script>
<script src="/IronOS/js/theme.js" defer></script>
<script src="/IronOS/search/main.js" defer></script>
<script defer>
window.onload = function () {
SphinxRtdTheme.Navigation.enable(true);
};
</script>
</body>
</html>

211
DebugMenu/index.html Normal file
View File

@@ -0,0 +1,211 @@
<!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/DebugMenu/" />
<link rel="shortcut icon" href="../img/favicon.ico" />
<title>Debugging Menu - 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/10.5.0/styles/github.min.css" />
<script>
// Current page data
var mkdocs_page_name = "Debugging Menu";
var mkdocs_page_input_path = "DebugMenu.md";
var mkdocs_page_url = "/IronOS/DebugMenu/";
</script>
<script src="../js/jquery-3.6.0.min.js" defer></script>
<!--[if lt IE 9]>
<script src="../js/html5shiv.min.js"></script>
<![endif]-->
<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.5.0/highlight.min.js"></script>
<script>hljs.initHighlightingOnLoad();</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" 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>
<li class="toctree-l1"><a class="reference internal" href="../GettingStarted/">Getting Started</a>
</li>
</ul>
<p class="caption"><span class="caption-text">Troubleshooting</span></p>
<ul>
<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>
</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" alt="Docs"></a> &raquo;</li>
<li>Debugging Menu</li>
<li class="wy-breadcrumbs-aside">
<a href="https://github.com/ralim/IronOS/edit/master/docs/DebugMenu.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="debugging-menu">Debugging Menu</h1>
<p>In this firmware there is extra debugging information in a hidden sub-menu.
This menu is meant to be simple, so it has no fancy GUI animations.</p>
<ul>
<li>Access it by pressing the rear button (<code>-/B</code>) on the iron while it is on the home screen.</li>
<li>Use the front button (<code>+/A</code>) to scroll through the menu.</li>
<li>To exit, use the rear button (<code>-/B</code>) again.</li>
</ul>
<h2 id="menu-items">Menu items</h2>
<p>Items are shown in the menu on a single line, so they use short codes and appear in this order:</p>
<h3 id="id">ID</h3>
<ul>
<li>This is used by Irons that have an ID and serial number to help check if the iron is authentic. All Pinecil V1 show the same ID number as this is the number programmed into the MCU.</li>
<li>The new Pinecil V2 released Aug. 2, 2022 now uses MCU BL706, which enables generating a unique ID/Serial number to every iron. This can be used to verify your <a href="https://pinecil.pine64.org/">Pinecil authenticity here</a>.</li>
</ul>
<h3 id="acc">ACC</h3>
<p>This indicates the accelerometer that is fitted inside the unit.</p>
<ul>
<li>MMA8652</li>
<li>LIS2DH12</li>
<li>BMA223</li>
<li>MSA301</li>
<li>SC7A20</li>
<li>None -&gt; running in fallback without movement detection</li>
<li>Scanning -&gt; Still searching I2C for one</li>
</ul>
<h3 id="pwr">PWR</h3>
<p>This indicates the current power source for the iron.
This may change during power up as the sources are negotiated in turn.</p>
<ul>
<li><strong>DC</strong> input (dumb)</li>
<li><strong>QC</strong> input (We used QC2/3 negotiation for current supply)</li>
<li><strong>PD W. VBus</strong> input (PD subsystem is used to negotiate for current supply); and VBus is connected to your input power source</li>
<li><strong>PD No VBus</strong> input (PD subsystem is used to negotiate for current supply); and VBus is <strong>NOT</strong> connected to your input power source. If it is Not required or possible to do a special mod of your PCB (i.e. late model V1, some early Green PCB models) then [PD No VBus] displays on-screen (<a href="/Documentation/DebugMenu.md#pd-debug-menu">see details and PD Debug section below</a>).</li>
</ul>
<h3 id="vin">Vin</h3>
<p>The input voltage as read by the internal ADC. Can be used to sanity check it is being read correctly.</p>
<h3 id="tip-c">Tip C</h3>
<p>This is the tip temperature in °C.
This can be used with RTip for assessing temperature processing performance.</p>
<h3 id="han-c">Han C</h3>
<p>This is the handle temperature or more accurately the reading of the Cold Junction Compensation (CJC) temperature sensor. This is expressed in °C. Range of 20-40 °C is normal depending on how hot/cold the room is and how long power has been plugged in which warms the PCB further.
This is used for CJC of the tip temperature.</p>
<blockquote>
<p>If CHan is extremely high, this indicates the temperature sensor isn't reading correctly (<a href="/Documentation/Troubleshooting.md">see Troubleshooting</a>)</p>
</blockquote>
<h3 id="max-c">Max C</h3>
<p>This indicates the max temperature in °C that the system estimates it can measure the tip reliably to.
This is dependent on a few factors including the handle temperature so it can move around during use. As you use the iron, the Max increases to a point.</p>
<h3 id="uptime">UpTime</h3>
<p>This shows how many deciseconds the unit has been powered for (600 ds = 1 minute).</p>
<h3 id="move">Move</h3>
<p>This is the last timestamp of movement. When the iron is moved, this should update to match the Time field (previous menu item).
This can be used for checking performance of the movement detection code.</p>
<h3 id="tip-res">Tip Res</h3>
<p>This indicates the tip resistance that the device is currently using. For devices with multiple possible values to choose from (Pinecil V2), the appropriate value is automatically detected at every boot-up. Tip should be installed before boot-up or reading can not be done.</p>
<h3 id="tip-r">Tip R</h3>
<p>This is the raw tip reading in μV. Tip must be installed or reading will be high/inaccurate. At cool, the range of 700-1000 is normal for larger tips and ~1500 for smaller tips (TS80). This is used to evaluate the calibration routines.</p>
<h3 id="tip-o">Tip O</h3>
<p>This is the offset resulting from the <em>'Cold Junction Compensation Calibration'</em>.</p>
<h3 id="hw-g">HW G</h3>
<p>This indicates the high water mark for the stack for the GUI thread. The smaller this number is, the less headroom we have in the stack.
As this is a high-water mater, you should only trust this once you have walked through all GUI options to "hit" the worst one.</p>
<h3 id="hw-m">HW M</h3>
<p>This indicates the high-water mark for the stack for the movement detection thread. The smaller this number is, the less headroom we have in the stack.</p>
<h3 id="hw-p">HW P</h3>
<p>This indicates the high-water mark for the stack for the PID thread. The smaller this number is, the less headroom we have in the stack.</p>
<h3 id="hall">Hall</h3>
<p>This appears if your device is capable of having a hall effect sensor installed (Pinecil).
This shows the current magnetic field strength reading from the sensor. It is used to check if the sensor is operational, and for diagnostics and optimal placement of magnets on a stand (higher number is better/stronger). <a href="/Documentation/HallSensor.md">See Hall Sensor for details</a>. </p>
<h1 id="pd-debug-menu">PD Debug menu</h1>
<p>On the Pinecil; if the iron is booted up while long holding the front button (<code>+</code>); it will show an extra hidden menu for inspecting USB-PD power adapters. We can also connect to any PD USB power to check Vbus status, even some cell phones with a USB-C port will work if it is PD. It will not show PD messages when Pinecil is powered by DC port, QC, or USB 5V (non-PD). For example, if you connect to a QC charger, you may simply see "PD State 6" which indicates "waiting for source" as no PD messages will be ever be sent and you will not be able to use (<code>+</code>) to scroll through PD negotiated messages.</p>
<p>Pressing (<code>+</code>) cycles through elements, and (<code>-</code>) or unplugging will exit the menu.</p>
<p>The first page shows the PD negotiation stage number; which can be used for diagnosing if PD is not working. Once negotiation is complete; use (<code>+</code>) button to advance to other screens which show the different proposals advertised for voltage and current (State 12 means all is good with the PD charger).</p>
<h4 id="below-is-a-method-for-user-modification-to-convert-some-early-models-of-pinecil-v1-to-safely-support-24v-on-the-dc5525-barrel">Below is a method for user modification to convert some early models of Pinecil V1 to safely support 24V on the DC5525 barrel.</h4>
<p>⚠️ Warning: do this at your own risk, read everything in this document, and go to the <a href="https://wiki.pine64.org/wiki/Pinecil#Community_links">Pine64 community chat</a> if you desire advice. An incorrect cut of the trace could render the Pinecil non-working.</p>
<p>Background: a simple user modification to the PCB on <em>some models</em> of original V1 allows it to safely use DC barrel 24V by cutting a trace line to the Vbus which held it back to 21V. You can check whether your Pinecil V1 needs the update or can benefit from it by using a hidden trick in the PD debug menu.</p>
<ul>
<li>Follow instructions above to enter the PD Debug menu.</li>
<li>After a few seconds or after PD negotiates (state above 5) it will show <code>[PD No VBus]</code> if it is not needed (i.e., late model V1). Alternately, if it shows <code>[VBus]</code>, then the mod has not been done and there is still a connection to the Vbus (the Vbus connection limits you to 21V until you do the mod).</li>
<li>If you need to do the mod, then follow the instructions/links below which have photos. Careful to only cut the trace and nothing else.</li>
<li>Then use the PD debug menu again to check for <code>[PD No Vbus]</code> before attaching any 24V PSU to the DC barrel. If you do not get the message, then try cutting the trace a little deeper or using alcohol to clear the gap of copper dust. Then check PD messages again. If you need advice/tips, join the Pine64 chat room. </li>
</ul>
<p>The mod method is shown in the <a href="https://www.pine64.org/2022/02/15/february-update-chat-with-the-machine/">February 2022 PINE64 community updates</a>. Early Pinecil V1 models required cutting a trace to achieve 24V safety with DC barrel PSU. Late model V1 made sometime in 2022 came with <code>[No Vbus]</code> already displayed, and no mod is required.</p>
<p>| Pinecil V2 model released Aug. 2, 2022 is an overhaul of the PCB with all relevant components capable of 28V. V2 requires no mods to support the use of 24V DC Barrel jack charger. |
:--------</p>
</div>
</div><footer>
<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>
</div>
<script>var base_url = '..';</script>
<script src="../js/theme_extra.js" defer></script>
<script src="../js/theme.js" defer></script>
<script src="../search/main.js" defer></script>
<script defer>
window.onload = function () {
SphinxRtdTheme.Navigation.enable(true);
};
</script>
</body>
</html>

197
Development/index.html Normal file
View File

@@ -0,0 +1,197 @@
<!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/Development/" />
<link rel="shortcut icon" href="../img/favicon.ico" />
<title>Development - 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/10.5.0/styles/github.min.css" />
<script>
// Current page data
var mkdocs_page_name = "Development";
var mkdocs_page_input_path = "Development.md";
var mkdocs_page_url = "/IronOS/Development/";
</script>
<script src="../js/jquery-3.6.0.min.js" defer></script>
<!--[if lt IE 9]>
<script src="../js/html5shiv.min.js"></script>
<![endif]-->
<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.5.0/highlight.min.js"></script>
<script>hljs.initHighlightingOnLoad();</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" 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>
<li class="toctree-l1"><a class="reference internal" href="../GettingStarted/">Getting Started</a>
</li>
</ul>
<p class="caption"><span class="caption-text">Troubleshooting</span></p>
<ul>
<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>
</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" alt="Docs"></a> &raquo;</li>
<li>Development</li>
<li class="wy-breadcrumbs-aside">
<a href="https://github.com/ralim/IronOS/edit/master/docs/Development.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="development">Development</h1>
<p>Building this software can be performed two ways: using the STM32CubeIDE or using command line tools.</p>
<h2 id="stm32cubeide">STM32CubeIDE</h2>
<p>The easiest way to start working with the STM32CubeIDE is to create a new project for the STM32F103RCTx.
Once this is created, remove the auto-generated source code.
Next, drag the contents of the <code>source</code> folder into the project and choose to link to files.
You will need to update the build settings for include paths and point to the new <code>.ld</code> linker file.</p>
<h2 id="command-line-tools-and-building-a-release">Command line tools and building a release</h2>
<p>In the <code>source</code> folder there is a <code>Makefile</code> that can be used to build the repository using command line tools.
When running the <code>make</code> command, specify which model of the device and the language(s) you would like to use.</p>
<h3 id="macos">macOS</h3>
<p>Use the following steps to set up a build environment for IronOS on the command line (in Terminal).</p>
<ol>
<li><a href="https://github.com/glegrain/STM32-with-macOS#0---installing-the-toolchain">Follow steps 1 – 3 here to install the toolchain</a> needed to compile for STM32 microcontrollers.</li>
<li>Install <code>python</code>:</li>
</ol>
<pre><code>brew install python
</code></pre>
<ol>
<li>(Optional) Update <code>pip</code> so it doesn't warn you about being out-of-date:</li>
</ol>
<pre><code>python3 -m pip install --upgrade pip
</code></pre>
<ol>
<li>Change to the <code>source</code> directory:</li>
</ol>
<pre><code>cd source
</code></pre>
<ol>
<li>Create a Python virtual environment for IronOS named <code>ironos-venv</code> to keep your Python installation clean:</li>
</ol>
<pre><code>python3 -m venv ironos-venv
</code></pre>
<ol>
<li>Activate the Python virtual environment:</li>
</ol>
<pre><code>source ironos-venv/bin/activate
</code></pre>
<ol>
<li>Install the dependencies required to run <code>make-translation.py</code>:</li>
</ol>
<pre><code>pip install bdflib
</code></pre>
<ol>
<li>All done! See some examples below for how you can build your own IronOS.</li>
</ol>
<h3 id="examples">Examples</h3>
<p>To build a single language Simplified Chinese firmware for the TS80P with 8 simultaneous jobs:</p>
<pre><code>make -j8 model=TS80P firmware-ZH_CN
</code></pre>
<p>To build a European multi-language firmware for the Pinecil with as many simultaneous jobs as there are logical processors on Linux:</p>
<pre><code>make -j$(nproc) model=Pinecil firmware-multi_European
</code></pre>
<p>To build a Cyrillic compressed multi-language firmware for the Pinecil with as many simultaneous jobs as there are logical processors on macOS:</p>
<pre><code>make -j$(sysctl -n hw.logicalcpu) model=Pinecil firmware-multi_compressed_Bulgarian+Russian+Serbian+Ukrainian
</code></pre>
<p>To build a custom multi-language firmware including English and Simplified Chinese for the TS80:</p>
<pre><code>make -j8 model=TS80 custom_multi_langs=&quot;EN ZH_CN&quot; firmware-multi_Custom
</code></pre>
<p>To build a custom compressed multi-language firmware including German, Spanish, and French for the TS100 (note if <code>model</code> is unspecified, it will default to <code>TS100</code>):</p>
<pre><code>make -j8 custom_multi_langs=&quot;DE ES FR&quot; firmware-multi_compressed_Custom
</code></pre>
<p>To build a release instead, run the <code>build.sh</code> script. This will update translations and also build every language for all device models. For macOS users, replace <code>make -j$(nproc)</code> in the script with <code>make -j$(sysctl -n hw.logicalcpu)</code> before running.</p>
<h2 id="updating-languages">Updating languages</h2>
<p>To update the language translation files and their associated font maps, execute the <code>make_translation.py</code> code from the <code>Translations</code> directory.
If you edit the translation definitions or the English translation, please also run <code>gen_menu_docs.py</code> to update the settings menu documentation automatically.</p>
<h2 id="building-pinecil-v1">Building Pinecil V1</h2>
<p>I highly recommend using the command line tools and using Docker to run the compiler.
It's a bit fussier on setup than the STM tooling, and this is by far the easiest way.
If you <em>need</em> an IDE I have used <a href="https://nucleisys.com/download.php">Nuclei's IDE</a>.
Follow the same idea as the STM Cube IDE notes above.</p>
<h2 id="building-pinecil-v2">Building Pinecil V2</h2>
</div>
</div><footer>
<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>
</div>
<script>var base_url = '..';</script>
<script src="../js/theme_extra.js" defer></script>
<script src="../js/theme.js" defer></script>
<script src="../search/main.js" defer></script>
<script defer>
window.onload = function () {
SphinxRtdTheme.Navigation.enable(true);
};
</script>
</body>
</html>

345
Flashing/index.html Normal file
View File

@@ -0,0 +1,345 @@
<!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/Flashing/" />
<link rel="shortcut icon" href="../img/favicon.ico" />
<title>Flashing / Upgrading your iron - 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/10.5.0/styles/github.min.css" />
<script>
// Current page data
var mkdocs_page_name = "Flashing / Upgrading your iron";
var mkdocs_page_input_path = "Flashing.md";
var mkdocs_page_url = "/IronOS/Flashing/";
</script>
<script src="../js/jquery-3.6.0.min.js" defer></script>
<!--[if lt IE 9]>
<script src="../js/html5shiv.min.js"></script>
<![endif]-->
<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.5.0/highlight.min.js"></script>
<script>hljs.initHighlightingOnLoad();</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" 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>
<li class="toctree-l1"><a class="reference internal" href="../GettingStarted/">Getting Started</a>
</li>
</ul>
<p class="caption"><span class="caption-text">Troubleshooting</span></p>
<ul>
<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>
</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" alt="Docs"></a> &raquo;</li>
<li>Flashing / Upgrading your iron</li>
<li class="wy-breadcrumbs-aside">
<a href="https://github.com/ralim/IronOS/edit/master/docs/Flashing.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="flashing-upgrading-your-iron">Flashing / Upgrading your iron</h1>
<h2 id="downloading-source-file">Downloading source file</h2>
<p>In the development of this firmware, there are three <em>types</em> of firmware released.
These are the "Main" stable releases, which generally have high confidence in being bug free.
Release candidates are released slightly more often, and these are generally perfectly fine for everyday use. These are released early to allow for translation checking and for wonderful people to help spot bugs and regressions.
Finally, there are the "mainline" builds, which are built from the main git branch.
These are built on every change and can be found on the Actions tab (see below).</p>
<h3 id="main-release">Main release</h3>
<p>Main releases are made to the <a href="https://github.com/Ralim/IronOS/releases">releases page</a>.
Download the zip file that matches your model of soldering iron and extract it.
Select the appropriate file type for your unit, in general Miniware devices need <code>.hex</code> and Pinecil needs <code>.dfu</code>.
Flash according to details below</p>
<h3 id="bleeding-edge-latest">Bleeding edge / latest</h3>
<p>For the <em>latest</em> code, you will need to download the zip file from the artifacts page on the build for what you want.
Head to the <a href="https://github.com/Ralim/IronOS/actions">Actions</a> page and then select the run for the appropriate branch you would like.
In general you probably want <code>master</code>.</p>
<p>Once you click on a run, scroll down to the "Artifacts" section and then click on your model to download a zip file.
Then this works the same as a production release (use the correct file).</p>
<h1 id="miniware-devices-ts100-ts80-ts80p-mhp30">Miniware devices (TS100, TS80, TS80P &amp; MHP30)</h1>
<p>This is completely safe, but if it goes wrong just put the <code>.hex</code> file from the official website (<a href="https://www.minidso.com/forum.php?mod=viewthread&amp;tid=868&amp;extra=page%3D1">TS100</a>, <a href="https://www.minidso.com/forum.php?mod=viewthread&amp;tid=3202&amp;extra=page%3D1">TS80</a>, <a href="https://www.minidso.com/forum.php?mod=viewthread&amp;tid=4070&amp;extra=page%3D1">TS80P</a> &amp; <a href="https://www.minidso.com/forum.php?mod=viewthread&amp;tid=4385&amp;extra=page%3D1">MHP30</a>) onto the unit and you're back to the old firmware. Downloads for the <code>.hex</code> files to flash are available on the <a href="https://github.com/Ralim/IronOS/releases">releases page.</a> The file you want is called <em>(MODEL)_EN.hex</em> unless you want the translations, they are (MODEL)_<em>language short name</em>.hex. Where (MODEL) is either TS100 or TS80.</p>
<p>Officially the bootloader on the devices only works under Windows (use the built-in File Explorer, as alternative file managers or copy handlers like Teracopy will fail). However, users have reported that it does work under Mac, and can be made to work under Linux <em>sometimes</em>. Details over on the <a href="https://github.com/Ralim/ts100/wiki/Upgrading-Firmware">wiki page</a>.</p>
<ol>
<li>Hold the button closest to the tip (MHP30 the left button on the back), and plug in the USB to the computer.</li>
<li>The unit will appear as a USB drive. (Screen will say <code>DFU</code> on it.)</li>
<li>Drag the <code>.hex</code> file onto the USB drive.</li>
<li>The unit will disconnect and reconnect.</li>
<li>The filename will have changed to end in <em>.RDY</em> or <em>.ERR</em></li>
<li>If it ends with <em>.RDY</em> you're done! Otherwise, something went wrong.</li>
<li>If it didn't work the first time, try copying the file again without disconnecting the device, often it will work on the second shot.</li>
<li>Disconnect the USB and power up the device. You're good to go.</li>
</ol>
<p>For the more adventurous out there, you can also load this firmware onto the device using an SWD programmer, for easier installation follow the guide at the end of this document.</p>
<p>On the bottom of the MCU riser PCB, there are 4 pads for programming. On v2.51A PCB revision <code>USB_D+</code> is shorted to <code>SWDIO</code> and <code>USB_D-</code> is shorted to <code>SWCLK</code> so debugging works without disassembly (attach while staying in the bootloader). Installing <a href="https://github.com/Ralim/IronOS-dfu">IronOS-dfu</a> is recommended as it allows reliable flashing of binary files with <a href="http://dfu-util.sourceforge.net/">dfu-util</a>.</p>
<p>There is a complete device flash backup included in this repository. (Note this includes the bootloader, so will need an SWD programmer to load onto the unit).</p>
<p>For the TS80 the SWD pins are used for the QC negotiation, so you can actually connect to the SWD power via the USB connector.</p>
<h2 id="mac">Mac</h2>
<p>sgr1ff1n (Shane) commented in <a href="https://github.com/Ralim/ts100/issues/11">issue 11</a> that upgrading worked on their Mac as per normal:</p>
<blockquote>
<p>I just wanted to say that I was able to update the firmware on my ts100 from the stock version to 1.08 found in this repository using my Mac. I simply followed the same steps however through Finder. I have a MacBook Pro (13-inch, Mid 2012) running Sierra 10.12.4 (16E195).</p>
</blockquote>
<h2 id="linux">Linux</h2>
<p>While in the past there were reports of unreliable upgrades, the consensus in <a href="https://github.com/Ralim/ts100/issues/11">issue 11</a> is that things work mostly as expected in Linux.</p>
<p>@awigen has contributed a script <a href="https://raw.githubusercontent.com/Ralim/ts100/master/Flashing/flash_ts100_linux.sh">flash_ts100_linux.sh</a> that works on Ubuntu 16.04 as well as other distros.</p>
<p>If you want to do it manually (or if the script does not work for some reason) the general procedure is the same as for Windows, the differences are in the way to mount the unit and copy the firmware.
Remember that after flashing, the firmware filename will have changed to end in <code>.RDY</code> or <code>.ERR</code> or <code>.NOT</code> and only <code>.RDY</code> means the flashing was successful!</p>
<ul>
<li>The unit has to be mounted as <code>msdos</code> type (thanks @balrog-kun for having spotted it). You may disable automount, but unmounting the automounted drive and remounting as <code>msdos</code> works fine. You do not need to turn off automounting, but you do need to unmount the device with <code>umount</code>.</li>
<li>It is recommended to use an all-caps filename for the firmware, even if successful flashing were done with lower case names.</li>
<li>Avoid USB hubs, plug directly in your computer.</li>
<li>If it fails, try again several times without unplugging. Just let it remount.</li>
</ul>
<p>Example, to be run as root, once the unit has been plugged in DFU mode and auto-mounted:</p>
<pre><code class="language-bash">FW=ts100.hex
unset NAME
eval $(lsblk -P -p -d --output NAME,MODEL|grep &quot;DFU[ _]Disk&quot;)
[ -z ${NAME+x} ] &amp;&amp; exit 1 # Could not find DFU device
umount &quot;$NAME&quot;
mkdir /tmp/mntdfu
mount -t msdos &quot;$NAME&quot; /tmp/mntdfu
cp &quot;$FW&quot; &quot;/tmp/mntdfu/$(basename $FW|tr a-z A-Z)&quot;
sync
umount /tmp/mntdfu
rmdir /tmp/mntdfu
</code></pre>
<p>Device will reboot and automount will rerun if not disabled.
Check the extension of your firmware, it should be <code>.RDY</code> now.</p>
<h1 id="pinecil-v2-pine64">Pinecil V2 (Pine64)</h1>
<ul>
<li>The MCU in V2 is Bouffalo BL706 and does <em>not</em> use usb-dfu for flashing as the previous MCU did.</li>
<li>The current firmware (2.18) is very fresh and no upgrade is available/needed.</li>
<li>When an update is released for V2, then IronOS will also include an update method to follow.</li>
<li>Background on the <a href="https://lupyuen.github.io/articles/bl706">BL706 chipset</a></li>
</ul>
<h1 id="pinecil-v1-pine64">Pinecil V1 (Pine64)</h1>
<ul>
<li>The MCU used in Pinecil supports usb-dfu. Reference <a href="https://wiki.pine64.org/wiki/Pinecil">Pinecil Wiki</a>.</li>
<li>Recommended Updater: the <a href="https://github.com/pine64/pinecil-firmware-updater/releases">Pine64 Updater</a>, is an easy-to-use GUI app. It is fast and works in several types of OS, i.e. Windows/Mac. It will automatically fetch the newest stable version of IronOS from GitHub.</li>
<li>Troubleshooting: if you have issues using the Pine64 Updater or your install fails, please go to troubleshooting tips below.</li>
<li>Community chat: if troubleshooting doesn't work, then join the Pine64 &gt; Pinecil channel. There are knowledgeable members in Discord/Telegram/Matrix. Discord has a bridge bot connection to Telegram and Matrix so that all pine volunteers/members can see advice for Pinecil and related items or just get tips on which Power supply to purchase.</li>
<li>One advantage of Pinecil is that you cannot permanently damage it doing a firmware update (because DFU is in ROM); an update could render Pinecil temporarily inoperable if you flash an invalid firmware. But no worries, simply re-flashing with a working firmware copy will fix everything.</li>
<li>USB-C cable is required to do an update. Generally, all USB controllers work, but some hubs have issues, so it is preferred to avoid USB hubs for updates.</li>
<li>Alternate Update Methods: if your OS is not currently supported by the <a href="https://github.com/pine64/pinecil-firmware-updater/releases">Updater</a> or it does not meet your needs, i.e., you want to install a beta version, the below manual methods may be used. </li>
</ul>
<h2 id="linux-and-mac">Linux and Mac</h2>
<h3 id="steps">Steps</h3>
<p>⛔ Do not use the DC barrel jack while updating firmware or you may destroy your PC. ⛔</p>
<ol>
<li>Highly recommend updating <code>dfu-util</code> to the newest version before starting.</li>
<li>Download and extract the firmware package from GitHub <a href="https://github.com/Ralim/IronOS/releases">IronOS Releases</a>.</li>
<li>Enter DFU mode: press and hold (<code>-</code>) button at the back of the iron before you connect the USB-C cable.</li>
<li>Connect USB to PC, and USB-C to back of Pinecil, keep holding (<code>-</code>) button down.</li>
<li>Once the USB cable is connected at two ends, wait ~10 seconds more, then release the (<code>-</code>) button.</li>
<li>The screen will stay <strong>black/off</strong> to indicate the Pinecil is in DFU mode. This is normal.</li>
<li>Using <code>dfu-util</code> you can flash the firmware using a command line like this:</li>
</ol>
<pre><code>dfu-util -D Pinecil_EN.dfu
</code></pre>
<p>Choose the file name from the folder with the appropriate 2-letter country code for your chosen language (i.e., EN = English).</p>
<h3 id="troubleshooting">Troubleshooting:</h3>
<ul>
<li>If you get a message stating that <code>More than one DFU capable USB device found!</code> when running the above command you probably have an old version of <code>dfu-util</code> installed. Might be worth updating. You can still install on the old version, but you will have to specify which DFU interface to flash to. Running the command <code>dfu-util -l</code> will show you if there are several DFU devices detected. Example:</li>
</ul>
<pre><code>Found DFU: [28e9:0189] ver=0100, devnum=48, cfg=1, intf=0, path=&quot;1-1&quot;, alt=1, name=&quot;@Option Bytes /0x1FFFF800/01*016Be&quot;, serial=&quot;??&quot;
Found DFU: [28e9:0189] ver=0100, devnum=48, cfg=1, intf=0, path=&quot;1-1&quot;, alt=0, name=&quot;@Internal Flash /0x08000000/128*001Kg&quot;, serial=&quot;??&quot;
</code></pre>
<p>In this example we see that more than one part of the Pinecil is detected as a DFU interface and we need to specify which one we want to flash to. We want the <code>Internal Flash</code> so in this case we can use <code>alt=0</code> to identify which interface to target. The command would then look like this:</p>
<pre><code>dfu-util -D Pinecil_EN.dfu -a 0
</code></pre>
<ul>
<li>Note: if you use an older release of <code>dfu-util</code> and do not see <code>alt=0, name="@Internal Flash /0x08000000/128*001Kg"</code> when running <code>dfu-util -l</code> you likely will not be able to update without first updating 'dfu-util'.</li>
<li>If your update is crashing part-way into the update, there is sometimes an issue with older/fussy USB controllers (they can show up/disappear/then show up again)<ul>
<li>Try a direct connection to the USB port, do not use a USB hub, and use shorter cable. If possible, pick a port connected to the main board.</li>
<li>Switch to a different PC/Laptop and use different ports. USB-C ports are recommended but some have also reported having a fussy C port.</li>
<li>Hold down the (-) button for the entire firmware update, do not release until near the end.</li>
</ul>
</li>
<li><code>DC Low</code> message: a pc/laptop cannot fully power Pinecil, it generally can only get 5 V (non-PD) to communicate for firmware updates and Pinecil will report 'DC Low'. This is normal.</li>
<li>If <code>dfu-util</code> aborts with an error like
<code>dfu-util: Cannot open DFU device 28e9:0189 found on devnum 42 (LIBUSB_ERROR_IO)</code>
and <code>dmesg</code> reports USB errors like these
<code>kernel: usb 1-1: reset full-speed USB device number 42 using xhci_hcd
kernel: usb 1-1: device descriptor read/64, error -71
kernel: usb 1-1: device descriptor read/64, error -71
kernel: usb 1-1: reset full-speed USB device number 42 using xhci_hcd
kernel: usb 1-1: device descriptor read/64, error -71
kernel: usb 1-1: device descriptor read/64, error -71
kernel: usb 1-1: reset full-speed USB device number 42 using xhci_hcd
kernel: usb 1-1: Device not responding to setup address.
kernel: usb 1-1: Device not responding to setup address.
kernel: usb 1-1: device not accepting address 42, error -71</code>
then try to disable USB autosuspend.
This can be done with a set of udev rules specifically for the Pinecil:
<code>udev
SUBSYSTEM=="usb", ATTR{idVendor}=="28e9", ATTR{idProduct}=="0189", MODE:="0660"
SUBSYSTEM=="usb", ATTR{idVendor}=="28e9", ATTR{idProduct}=="0189", GROUP="plugdev"
SUBSYSTEM=="usb", ATTR{idVendor}=="28e9", ATTR{idProduct}=="0189", TEST=="power/control", ATTR{power/control}="on"</code></li>
</ul>
<h2 id="windows">Windows</h2>
<p>Two Options for Windows</p>
<h3 id="option-1-use-command-line">Option 1: use command line</h3>
<h3 id="steps_1">Steps</h3>
<p>⛔ Do not use the DC barrel jack while updating firmware or you may destroy your PC. ⛔</p>
<ol>
<li>Using command line <code>dfu-util</code> is similar to above for Linux / Mac.</li>
<li>Highly recommend updating <code>dfu-util</code> to the newest version.</li>
<li>Download and extract the firmware package from GitHub <a href="https://github.com/Ralim/IronOS/releases">IronOS Releases</a>.</li>
<li>Enter DFU mode: press and hold (-) button at the back of the iron (do not release).</li>
<li>Connect USB to PC, and USB-C to the back of Pinecil, keep holding (-) button down.</li>
<li>Screen will stay <strong>black/off</strong> to indicate the Pinecil is in DFU mode. This is normal.</li>
<li>After the USB cable is connected at both ends, wait ~10 seconds more, then release the (-) button.</li>
<li>Open PowerShell or Command window.</li>
<li>Change to the directory of the unzipped firmware files</li>
<li>Using <code>dfu-util,</code> flash the firmware using a command like this:</li>
</ol>
<pre><code>dfu-util -D Pinecil_EN.dfu
</code></pre>
<ul>
<li>If you have errors, see Troubleshooting <a href="/Documentation/Flashing.md#troubleshooting">above</a>.</li>
</ul>
<h3 id="option-2-use-the-gui-tool-from-chip-vendor">Option 2: use the GUI tool from chip vendor</h3>
<h3 id="steps_2">Steps</h3>
<p>⛔ Do not use the DC barrel jack while updating firmware or you may destroy your PC. ⛔</p>
<ol>
<li>If you are uncomfortable with the command line, then this chip vendor supplied GUI tool/drivers is an option.</li>
<li>Download and extract the firmware package from GitHub <a href="https://github.com/Ralim/IronOS/releases">IronOS Releases</a>.</li>
<li>Download both the <code>GD32 MCU DFU TOOL</code> and the <code>GD32 Dfu Drivers</code>.</li>
<li>GD32 DFU Tool <a href="http://www.gd32mcu.com/en/download?kw=GD32+MCU+Dfu+Tool&amp;lan=en">here</a>. If the link breaks, search for "GD32 MCU Dfu Tool" at this <a href="http://www.gd32mcu.com/en/download/">link</a>.</li>
<li>GD32 DFU Drivers <a href="http://www.gd32mcu.com/en/download?kw=GD32+Dfu+Drivers&amp;lan=en">here</a>. If the link breaks, search for "GD32 Dfu Drivers" at this <a href="http://www.gd32mcu.com/en/download/">link</a>.</li>
<li>Check properties of both downloads, tick Unblock if needed, then Unzip</li>
<li>Install the drivers and the GD32 DFU tool (ignore prompts to update the tool).</li>
<li>Enter DFU mode: press and hold (<code>-</code>) button at the back of Pinecil (do not release).</li>
<li>Connect Pinecil to a PC via USB cable (do not release the (<code>-</code>) yet).</li>
<li>Screen will stay <strong>black/off</strong> to indicate the Pinecil is in DFU mode. This is normal.</li>
<li>You may hear a beep from Windows as it connects to Pinecil in DFU mode.</li>
<li>If you see windows notification that it <code>does not recognize USB device</code>, then you didn't connect, repeat step 3-8.</li>
<li>Open the GD32 DFU Tool (ignore prompts to update tool).</li>
<li>At the top of the DFU tool, you should see <code>GD DFU DEVICE 1</code> appear if you successfully connected Pinecil.</li>
<li>If DFU Device box at top is blank, then Pinecil is not connected in DFU mode, repeat steps 3-11.</li>
<li>If it has been more than 10 seconds since you connected the USB cable, Release the (<code>-</code>) button. (don't use Upload from Device section)</li>
<li>Select <code>Download to device</code> &gt; Open &gt; Browse to folder you unzipped in step 2. </li>
<li>Select the <code>hex</code> file for language. English is Pinecil_EN.hex , tick <code>Verify after download</code>.</li>
<li>Click <code>OK</code> at bottom. After a few minutes you will see 0-100%, Download successfully! Click <code>Leave DFU</code> at the top. </li>
<li>Disconnect Pinecil cable from PC, plug it into a power supply.</li>
<li>Do not need to press any buttons, a new screen should appear.</li>
<li>
<p>To confirm upgrade, hold the minus (<code>-</code>) button down for a few seconds, it then shows new firmware version v2.xx.x....date</p>
</li>
<li>
<p>If you have errors, see Troubleshooting <a href="/Documentation/Flashing.md#troubleshooting">above</a>.</p>
</li>
</ol>
<h2 id="faq">FAQ</h2>
<h4 id="miniware-the-file-is-showing-up-with-the-extension-err">[Miniware] The file is showing up with the extension <code>.ERR</code></h4>
<p>This can occur during the programming process if any of the checks in the bootloader fail. This is often triggered by anti-virus software or using a non-Windows host OS.</p>
<p>First, try just copying the file a second time.</p>
<ol>
<li>Attach the iron in DFU mode.</li>
<li>Copy the <code>.hex</code> file to the device.</li>
<li>The device disconnects and connects with the <code>.ERR</code> file.</li>
<li>Copy the same <code>.hex</code> file again <strong>⛔ DO NOT TRY AND DELETE THE OLD ONE ⛔</strong>.</li>
<li>The device will disconnect and reconnect again.</li>
<li>The device <em>should</em> now have the <code>.RDY</code> file.</li>
<li>You're done.</li>
</ol>
<p>If this fails and you are on Mac or Linux reading the wiki page about programming can help. There is also a very long issue thread going through all of the different attempts around this too.</p>
<p>If you are on Windows, it's often best to try another computer (friends, work, partners etc.).</p>
<h4 id="miniware-device-randomly-disconnects-or-does-not-show-up-in-dfu-mode">[Miniware] Device randomly disconnects or does not show up in DFU mode</h4>
<ol>
<li>
<p>Check if the USB cable you are using has the data pins; test it on another device. There are a surprisingly large number of micro-USB cables that are power <em>only</em>.</p>
</li>
<li>
<p>Try other USB ports. Often different USB controllers will interact with the units differently due to design quirks in the Miniware design.</p>
</li>
</ol>
<h3 id="miniware-alternative-bootloader">[Miniware] Alternative bootloader</h3>
<p>If you are an advanced user, and you have used <code>usb-dfu</code> tools before, or you would like to learn; there is an alternative bootloader for these irons.
This will <strong>NOT</strong> show up as a USB storage drive, but instead show up using a standard DFU protocol device. You can then use dfu tools or GUIs to upgrade the iron using the <code>.bin</code> files that are posted to the releases page.</p>
<p>To install this alternative bootloader, follow the instructions <a href="https://github.com/Ralim/IronOS-dfu/blob/mainline/docs/Bootloader.md">here</a>.</p>
<p>Note that this is only recommended for users who know what they are doing. If you don't understand how this works, please don't flash this.</p>
</div>
</div><footer>
<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>
</div>
<script>var base_url = '..';</script>
<script src="../js/theme_extra.js" defer></script>
<script src="../js/theme.js" defer></script>
<script src="../search/main.js" defer></script>
<script defer>
window.onload = function () {
SphinxRtdTheme.Navigation.enable(true);
};
</script>
</body>
</html>

201
GettingStarted/index.html Normal file
View File

@@ -0,0 +1,201 @@
<!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/10.5.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>
<script src="../js/jquery-3.6.0.min.js" defer></script>
<!--[if lt IE 9]>
<script src="../js/html5shiv.min.js"></script>
<![endif]-->
<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.5.0/highlight.min.js"></script>
<script>hljs.initHighlightingOnLoad();</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" 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="#settings-menu">Settings Menu</a>
</li>
</ul>
</li>
</ul>
<p class="caption"><span class="caption-text">Troubleshooting</span></p>
<ul>
<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>
</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" alt="Docs"></a> &raquo;</li>
<li>Getting Started</li>
<li class="wy-breadcrumbs-aside">
<a href="https://github.com/ralim/IronOS/edit/master/docs/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 <a href="/Documentation/Flashing.md">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>
<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="/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 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>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>
<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="/Documentation/HallSensor.md">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>
<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 &gt; 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="../Troubleshooting/" class="btn btn-neutral float-right" title="Troubleshooting">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">&laquo; Previous</a></span>
<span><a href="../Troubleshooting/" style="color: #fcfcfc">Next &raquo;</a></span>
</span>
</div>
<script>var base_url = '..';</script>
<script src="../js/theme_extra.js" defer></script>
<script src="../js/theme.js" defer></script>
<script src="../search/main.js" defer></script>
<script defer>
window.onload = function () {
SphinxRtdTheme.Navigation.enable(true);
};
</script>
</body>
</html>

141
HallSensor/index.html Normal file
View File

@@ -0,0 +1,141 @@
<!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/HallSensor/" />
<link rel="shortcut icon" href="../img/favicon.ico" />
<title>Hall Effect Sensor - 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/10.5.0/styles/github.min.css" />
<script>
// Current page data
var mkdocs_page_name = "Hall Effect Sensor";
var mkdocs_page_input_path = "HallSensor.md";
var mkdocs_page_url = "/IronOS/HallSensor/";
</script>
<script src="../js/jquery-3.6.0.min.js" defer></script>
<!--[if lt IE 9]>
<script src="../js/html5shiv.min.js"></script>
<![endif]-->
<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.5.0/highlight.min.js"></script>
<script>hljs.initHighlightingOnLoad();</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" 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>
<li class="toctree-l1"><a class="reference internal" href="../GettingStarted/">Getting Started</a>
</li>
</ul>
<p class="caption"><span class="caption-text">Troubleshooting</span></p>
<ul>
<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>
</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" alt="Docs"></a> &raquo;</li>
<li>Hall Effect Sensor</li>
<li class="wy-breadcrumbs-aside">
<a href="https://github.com/ralim/IronOS/edit/master/docs/HallSensor.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="hall-effect-sensor">Hall Effect Sensor</h1>
<h2 id="sleep-mode-menu">Sleep Mode Menu</h2>
<p>In Sleep mode, the iron automatically lowers the temperature to 150 °C (default). This default was chosen as it is just below the melting point of many solders. A stand-by lower temperature helps reduce the rate of oxidation and prevents damage to iron tips. 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 moving the iron or pressing any button will wake it back up into soldering mode.</p>
<h3 id="optional-hall-effect-feature-pinecil-only">Optional Hall Effect Feature (Pinecil only):</h3>
<p>Inside the <a href="https://github.com/Ralim/IronOS/blob/dev/Documentation/Settings.md#setting-sleep-temp">Sleep Menu</a> is an additional type of sleep setting. Pinecil has an unpopulated footprint (<strong>U14</strong>) for a hall effect sensor, Silicon Labs <strong>Si7210-B-00-IV</strong>. After installing the hall effect sensor (HES), it is possible to auto-trigger Pinecil to enter sleep mode when it enters the stand, and <em>Zzzz</em> will appear (or text in detailed mode). This could be a fun enhancement for any Pinecil and adds a feature typically only found in more expensive high-end irons. The HES is available at many electronic stores for ~$2-$6.</p>
<p>After installing the HES on the PCB, place a magnet on the stand close enough to the sensor to activate one of ten user selectable settings.
- 0=off, 1=1000, 2=750, 3=500, 4=250, 5=150, 6=100, 7=75, 8=50, 9=25 (9 has the highest sensitivity to magnets)
- Setting of 1 might be used if you solder on PCBs with magnets and do not wish Pinecil to auto-sleep constantly. A very strong/large magnet would be required on the stand to activate the sleep mode if you use setting 1.
- Setting of 9 would be useful if you only had a small magnet and are not concerned about Pinecil falsely triggering sleep mode near magnetized items/tools.
- Actively watch the <em>hall</em> number change while you slowly move the magnet around to seek the best locations &amp; whether you have too many or too few magnets. Position the magnet(s) where you have the highest hall number will ensure consistent sleep mode when you place the iron in the stand. This requires some experimenting.
- <a href="/Documentation/DebugMenu.md">See debug menu for how to display the <em>Hall</em> number</a>
- Note that the sensor is physically located near the copper contacts for the tip at the front of the handle. <a href="https://files.pine64.org/doc/Pinecil/Pinecil_schematic_v1.0a_20201120.pdf">Reference Schematics U14</a>.
- Neodymium magnets are recommended. If using small magnets, 2-3 may be required, but too many could also be detrimental.
- Positioning/type/quantity of magnets is important for best results. Sometimes too many magnets breaks the effect by distorting the magnetic field <strong><a href="https://www.youtube.com/shorts/afkqKwCX00I">as seen in this demo video</a></strong>. The video shows magnets at the top of the stand, and the pinecil goes correctly into Zzzz with <em>only</em> those magnets. When more magnets are added at the side, the Pinecil did not go to sleep, which is contrary to the goal. See the PDF below for details on magnetic fields with SI7210-B.
- Orientation of North and South faces of magnets is important to increase reaction of the hall sensor <a href="https://www.silabs.com/documents/public/application-notes/an1018-si72xx-sensors.pdf">see data sheet SI7210-B-00-IV</a>.</p>
</div>
</div><footer>
<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>
</div>
<script>var base_url = '..';</script>
<script src="../js/theme_extra.js" defer></script>
<script src="../js/theme.js" defer></script>
<script src="../search/main.js" defer></script>
<script defer>
window.onload = function () {
SphinxRtdTheme.Navigation.enable(true);
};
</script>
</body>
</html>

133
Hardware/index.html Normal file
View File

@@ -0,0 +1,133 @@
<!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/Hardware/" />
<link rel="shortcut icon" href="../img/favicon.ico" />
<title>Hardware - 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/10.5.0/styles/github.min.css" />
<script>
// Current page data
var mkdocs_page_name = "Hardware";
var mkdocs_page_input_path = "Hardware.md";
var mkdocs_page_url = "/IronOS/Hardware/";
</script>
<script src="../js/jquery-3.6.0.min.js" defer></script>
<!--[if lt IE 9]>
<script src="../js/html5shiv.min.js"></script>
<![endif]-->
<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.5.0/highlight.min.js"></script>
<script>hljs.initHighlightingOnLoad();</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" 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>
<li class="toctree-l1"><a class="reference internal" href="../GettingStarted/">Getting Started</a>
</li>
</ul>
<p class="caption"><span class="caption-text">Troubleshooting</span></p>
<ul>
<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>
</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" alt="Docs"></a> &raquo;</li>
<li>Hardware</li>
<li class="wy-breadcrumbs-aside">
<a href="https://github.com/ralim/IronOS/edit/master/docs/Hardware.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">
<h2 id="notes-on-the-various-supported-hardware">Notes on the various supported hardware</h2>
<h3 id="mhp30">MHP30</h3>
<ul>
<li>Accelerometer is the MSA301, this is mounted roughly in the middle of the unit</li>
<li>USB-PD is using the FUSB302</li>
<li>The hardware I2C bus on PB6/7 is used for the MSA301 and FUSB302</li>
<li>The OLED is the same SSD1306 as everything else, but it’s on a bit-banged bus</li>
</ul>
</div>
</div><footer>
<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>
</div>
<script>var base_url = '..';</script>
<script src="../js/theme_extra.js" defer></script>
<script src="../js/theme.js" defer></script>
<script src="../search/main.js" defer></script>
<script defer>
window.onload = function () {
SphinxRtdTheme.Navigation.enable(true);
};
</script>
</body>
</html>

163
HardwareIssues/index.html Normal file
View File

@@ -0,0 +1,163 @@
<!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/HardwareIssues/" />
<link rel="shortcut icon" href="../img/favicon.ico" />
<title>Known Hardware Issues - 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/10.5.0/styles/github.min.css" />
<script>
// Current page data
var mkdocs_page_name = "Known Hardware Issues";
var mkdocs_page_input_path = "HardwareIssues.md";
var mkdocs_page_url = "/IronOS/HardwareIssues/";
</script>
<script src="../js/jquery-3.6.0.min.js" defer></script>
<!--[if lt IE 9]>
<script src="../js/html5shiv.min.js"></script>
<![endif]-->
<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.5.0/highlight.min.js"></script>
<script>hljs.initHighlightingOnLoad();</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" 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>
<li class="toctree-l1"><a class="reference internal" href="../GettingStarted/">Getting Started</a>
</li>
</ul>
<p class="caption"><span class="caption-text">Troubleshooting</span></p>
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="../Troubleshooting/">Troubleshooting</a>
</li>
<li class="toctree-l1 current"><a class="reference internal current" href="./">Known Hardware Issues</a>
<ul class="current">
<li class="toctree-l2"><a class="reference internal" href="#no-accelerometer-detected">No Accelerometer detected</a>
</li>
<li class="toctree-l2"><a class="reference internal" href="#no-usb-pd-ic-detected">No USB-PD IC detected</a>
</li>
<li class="toctree-l2"><a class="reference internal" href="#no-tip-detected">No tip detected</a>
</li>
<li class="toctree-l2"><a class="reference internal" href="#iron-will-not-heat-up-and-displays-a-high-temperature">Iron will not heat up and displays a high temperature</a>
</li>
</ul>
</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" alt="Docs"></a> &raquo;</li>
<li>Troubleshooting &raquo;</li>
<li>Known Hardware Issues</li>
<li class="wy-breadcrumbs-aside">
<a href="https://github.com/ralim/IronOS/edit/master/docs/HardwareIssues.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="hardware-issues">Hardware Issues</h1>
<p>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.</p>
<h2 id="no-accelerometer-detected">No Accelerometer detected</h2>
<p>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.</p>
<p>If this is a new iron, also feel free to open an issue if you don't see any; a vendor <em>could</em> have changed the model of the accelerometer on us without warning <em>again</em>. In which case, support should come shortly.</p>
<p>If your iron is new, there is a slim chance your accelerometer may be DOA and need replacement.</p>
<p><strong>Note this warning will only be shown the first few times until settings are reset</strong></p>
<h2 id="no-usb-pd-ic-detected">No USB-PD IC detected</h2>
<p>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.</p>
<p><strong>Note this warning will only be shown the first few times until settings are reset</strong></p>
<h2 id="no-tip-detected">No tip detected</h2>
<p>If your tip is not being detected, the most likely cause is that the heater element inside the tip 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.</p>
<p>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 measurements in the range of 4-10 ohms. Anything higher than 10 ohms is <em>generally</em> an issue.</p>
<h2 id="iron-will-not-heat-up-and-displays-a-high-temperature">Iron will not heat up and displays a high temperature</h2>
<p>Check the Rtip and CHan numbers (<a href="/Documentation/DebugMenu.md">see debug menu</a>). Extremly high CHan is suspect to a problem with the cold junction compensation temperature sensor.</p>
<p>For Pinecil V1, inspect near U10 which is the TMP36 sensor (<a href="https://github.com/Ralim/IronOS/issues/1234">see issue here</a>). You may be able to reflow/resolder the TMP36 chip at U10 to correct a weak solder joint.</p>
<p>If it worked on older firmware, but not on 2.16+, weak solder joints are suspect. The newer firmware runs the ADC a bit faster to keep tighter control of the tip temperature. Normally this wont cause an issue as the output from the TMP36 is powerful enough to keep up without any issue. But if you have a weak or cold solder joint this could cause issues.</p>
<p>If the CHan is extremely high, and reflowing the temperature sensor does not resolve the issue; inspect the pins in the main MCU, possibly try giving them a light squeeze to the board while watching CHan.</p>
<p>If you have a different device, follow the same logic and locate the temperature sensor on your device.</p>
</div>
</div><footer>
<div class="rst-footer-buttons" role="navigation" aria-label="Footer Navigation">
<a href="../Troubleshooting/" class="btn btn-neutral float-left" title="Troubleshooting"><span class="icon icon-circle-arrow-left"></span> Previous</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="../Troubleshooting/" style="color: #fcfcfc">&laquo; Previous</a></span>
</span>
</div>
<script>var base_url = '..';</script>
<script src="../js/theme_extra.js" defer></script>
<script src="../js/theme.js" defer></script>
<script src="../search/main.js" defer></script>
<script defer>
window.onload = function () {
SphinxRtdTheme.Navigation.enable(true);
};
</script>
</body>
</html>

402
History/index.html Normal file
View File

@@ -0,0 +1,402 @@
<!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/History/" />
<link rel="shortcut icon" href="../img/favicon.ico" />
<title>Version Changes - 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/10.5.0/styles/github.min.css" />
<script>
// Current page data
var mkdocs_page_name = "Version Changes";
var mkdocs_page_input_path = "History.md";
var mkdocs_page_url = "/IronOS/History/";
</script>
<script src="../js/jquery-3.6.0.min.js" defer></script>
<!--[if lt IE 9]>
<script src="../js/html5shiv.min.js"></script>
<![endif]-->
<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.5.0/highlight.min.js"></script>
<script>hljs.initHighlightingOnLoad();</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" 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>
<li class="toctree-l1"><a class="reference internal" href="../GettingStarted/">Getting Started</a>
</li>
</ul>
<p class="caption"><span class="caption-text">Troubleshooting</span></p>
<ul>
<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>
</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" alt="Docs"></a> &raquo;</li>
<li>Version Changes</li>
<li class="wy-breadcrumbs-aside">
<a href="https://github.com/ralim/IronOS/edit/master/docs/History.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="version-changes">Version Changes</h1>
<h2 id="v219">V2.19</h2>
<ul>
<li>Bug-fix Infinite Boot Logo</li>
<li>Shutdown settings for MHP30</li>
<li>Accelerometer sensitivity for MHP30</li>
<li>Allow showing unique device ID</li>
<li>Bug-fix chance of a power pulse at device boot</li>
<li>Updated translations</li>
<li>Improved documents, added features table</li>
</ul>
<h2 id="v218">V2.18</h2>
<ul>
<li>Support for animated bootup logo's</li>
<li>Bootup logo's moved to their own IronOS-Meta repo</li>
<li>New Vietnamese translation (limited due to screen size)</li>
<li>Fixes for SC7A20 in TS80(P)</li>
<li>Updated translations</li>
<li>Better Instructions/documents</li>
</ul>
<h2 id="v217">V2.17</h2>
<h3 id="big-changes">Big changes</h3>
<ul>
<li>Indicate status of VBus for modding Pinecil (debug menu)</li>
<li>Better hall effect sensor sensitivity adjustment (larger range with more steps)</li>
<li>Temperature increment will "round" to nearest multiple of increase amount</li>
<li>Build setup migrated to Alpine (You can now build in docker easily, and on PinePhone/PinePhonePro)</li>
<li>-&gt; Removed proprietary compiler for Pinecil RISCV now all uses normal gcc</li>
<li>-&gt; Removed using the arm specific build of gcc for the one that alpine ships (Miniware devices)</li>
<li>Logo generator python script creates <code>.dfu</code> files for ease of use with Pinecil</li>
<li>Upgrades to translations</li>
<li>Support for new GD32103 based TS100 units turning up on the market</li>
<li>Raw hall effect reading now shows in the Pinecil debug menu</li>
<li>Fixed automatic orientation for newer TS80P's with the SC7 accelerometer</li>
<li>User interface slight changes</li>
<li>New <code>metadata.zip</code> file to allow the Pine Updater to automatically fetch information on releases</li>
</ul>
<h3 id="notes">Notes</h3>
<ul>
<li>VBus mod detection may not play well with all PPS chargers. If your iron reboots when you view this in the debug menu its not a fault. (<a href="https://github.com/Ralim/IronOS/issues/1226">#1226</a>)</li>
<li><code>metadata.zip</code> is only designed for use by automatic software, ignore it for normal use</li>
<li>More details on Pinecil VBus mod coming via other channels.</li>
<li>Hall effect sensor is not fitted to Pinecil's by default, you have to fit this yourself if you want the feature</li>
<li>Tweaks to the Accelerometer code means the drivers are slightly more fussy. If you run into any issues let us know in the discussion or issues.</li>
<li>-&gt; Release has been updated to build <code>e065be3</code> after one bug with the BMA223 was found.</li>
</ul>
<h2 id="v216">V2.16</h2>
<ul>
<li>Overhaul of the Timer+ADC setup with help from @sandmanRO</li>
<li>Overhaul of the PID with help from @sandmanRO</li>
<li>Settings <em>should</em> now upgrade in place to future versions, with resets only happening to new/changed settings</li>
<li>Shows error if tip runaway (failed temperature sensor) is detected</li>
<li>USB-PD now has a timeout, to allow forcing QC3 negotiation to start faster</li>
<li>QC3 Voltages are now adjustable to user desired setpoint</li>
<li>Added a small tolerance to allow "overvoltage" on QC3 above unit specifications.</li>
<li>
<ul>
<li>Please note: Doing this is entirely at your own risk!</li>
</ul>
</li>
<li>New Advanced view that is much nicer to use and a very good daily driver option from @Mel-kior</li>
<li>OLED brightness and contrast thanks to @alvinhochun</li>
<li>Scrollbar is fixed so it doesnt jump around when menus are shown/hidden</li>
<li>Moved to <code>.dfu</code> files from <code>.bin</code> to make flashing commands easier</li>
<li>Every language had translation updates I believe</li>
<li>Romanian language added</li>
</ul>
<h2 id="v215">V2.15</h2>
<h2 id="feature-upgrades">Feature upgrades:</h2>
<ul>
<li>MHP30 support</li>
<li>Multi-lingual firmware combinations now exist for Pinecil</li>
<li>More fine grained voltage controlled options</li>
<li>USB-PD improvements (version one and two)</li>
<li>More configuration options for power pulse</li>
<li>All font / character encoding has been very reworked</li>
<li>More translation updates than one can count </li>
<li>More languages 😱 </li>
</ul>
<h3 id="mhp30">MHP30</h3>
<p>The MHP30 is a small reflow station from Miniware.
Thanks to a massive amount of help from @g3gg0 this firmware brings the beginnings of support for this unit.
Also kudo's to @Vinigas and @GoJian for helping with testing.
This is not a <em>final</em> version I'm sure, but this is a working, usable version of firmware support.
Programs the same as any one Miniware unit using drag and drop.
<strong>Note: The boot logo scripts will need updates for this unit, so not supported yet.</strong></p>
<p>The flood doors are now open for feature requests for this unit :)</p>
<h2 id="v214">V2.14</h2>
<ul>
<li>Fixing auto rotation bug in the LIS accelerometer in the TS80/TS80P</li>
<li>Adds support for two new accelerometers
-- SC7A20 (Future Pinecil batch) #786
-- MSA301 (Newer TS80P) #761</li>
<li>Add warnings if accelerometer or USB-PD IC's are not detected #752
-- Only shows for first few boots, to help catch unsupported models</li>
<li>Fixed cooling down blink to be sane speed #769</li>
<li>
<p>Cleanup of threads and slightly faster power negotiation #790</p>
</li>
<li>
<p>Updates to flashing scripts #775</p>
</li>
<li>Documentation updates all over the place (and the wiki was given a cleanup)|</li>
<li>Updates to makefile #792 #787</li>
<li>Cleanup the folder name of the source code #800</li>
<li>clang-format spec setup #801</li>
</ul>
<h2 id="v213">V2.13</h2>
<ul>
<li>First <em>official</em> Pinecil release</li>
<li>All of the wire for Pinecil releases added</li>
<li>Updated Translations</li>
<li>Delay accelerometer to help with entering sleep on startup</li>
<li>Dual speed PWM to help with power limit control</li>
<li>Improve heat up time</li>
<li>Adds locking mode</li>
<li>Improved docs all over the place</li>
<li>Repo rename occured TS100 -&gt; IronOS</li>
<li>Hall effect sensor support added (not fitted in Pinecil but optional)</li>
<li>QC 20V support for Pinecil</li>
<li>CI upgrades for faster builds</li>
<li>Fixed bug with accelerometer model on Pinecil</li>
<li>Rework of all of the temperature curves for better accuracy</li>
</ul>
<h2 id="v212">V2.12</h2>
<ul>
<li>Only released as pre-release</li>
<li>[TS80P] Improvements to the PD negotiation to handle a few more adapters cleanly</li>
<li>Pause on the last item in a list</li>
<li>Clean up the menu (removed both enables and settings, so that you can turn things off easier)</li>
<li>Removing the very old single line menu style.</li>
</ul>
<h2 id="v211">V2.11</h2>
<ul>
<li>First TS80P support</li>
<li>Added in a USB-PD driver stack for the FUSB302</li>
<li>Fixed some graphical glitches</li>
</ul>
<h2 id="v210">V2.10</h2>
<ul>
<li>GUI polish (animations and scroll bars)</li>
<li>Power pulse to keep power supplies alive</li>
<li>Adjustable tip response gain</li>
</ul>
<h2 id="v209">V2.09</h2>
<ul>
<li>Adjustable steps in temperature adjustment</li>
<li>Git hash now in build string</li>
<li>Adjustable language to set if US units are available or not</li>
<li>Some minor QC3 improvements</li>
</ul>
<h2 id="v208">V2.08</h2>
<ul>
<li>Fixes auto start in sleep mode</li>
<li>Power limiters</li>
</ul>
<h2 id="v207">V2.07</h2>
<ul>
<li>QC fixes</li>
<li>Cosmetic fixes for leading 0's</li>
</ul>
<h2 id="v206">V2.06</h2>
<ul>
<li>Warning on settings reset</li>
<li>Temp temp re-write</li>
<li>Display calibration offset</li>
<li>Hide some leading 0's</li>
<li>Menu timeouts</li>
</ul>
<h2 id="v205">V2.05</h2>
<ul>
<li>Language updates</li>
</ul>
<h2 id="v204">V2.04</h2>
<ul>
<li>GUI updates</li>
</ul>
<h2 id="v203">V2.03</h2>
<ul>
<li>Support for new accelerometers</li>
</ul>
<h2 id="v202">V2.02</h2>
<ul>
<li>Adds small font</li>
</ul>
<h2 id="v201">V2.01</h2>
<ul>
<li>Newer settings menu</li>
</ul>
<h2 id="v200">V2.00</h2>
<ul>
<li>Complete re-write of the low layer system to use the STM32 HAL for easier development</li>
<li>This allowed easier setup for the new ADC auto measuring system</li>
<li>Better tip PWM control</li>
<li>Moved to FreeRTOS for scheduling</li>
<li>Complete re-write from blank</li>
<li>Added detailed screen views</li>
<li>Added smaller font for said screen views</li>
</ul>
<h2 id="v117">V1.17</h2>
<ul>
<li>Added blinking cooldown display</li>
<li>Allowed smaller sleep timeout values</li>
<li>New font!</li>
<li>Automatic startup option</li>
</ul>
<h2 id="v116">V1.16</h2>
<ul>
<li>Added automatic rotation support</li>
<li>Added power display graph</li>
</ul>
<h2 id="v115">V1.15</h2>
<ul>
<li>Added support for a custom bootup logo to be programmed via the DFU bootloader</li>
</ul>
<h2 id="v114">V1.14</h2>
<ul>
<li>Changed input voltage cutoff to be based on cell count rather than voltage</li>
</ul>
<h2 id="v113">V1.13</h2>
<ul>
<li>Swapped buttons for menu to prevent accidentally changing first menu item</li>
<li>Added auto key repeat</li>
</ul>
<h2 id="v112">V1.12</h2>
<ul>
<li>Increases sensitivity options to be 1*9 with 0 off state</li>
<li>Fixes issue where going from COOL *&gt; soldering can leave screen off</li>
</ul>
<h2 id="v111">V1.11</h2>
<ul>
<li>Boost mode</li>
<li>Change sensitivity options to be 1*8</li>
</ul>
<h2 id="v110">V1.10</h2>
<ul>
<li>Adds help text to settings</li>
<li>Improves settings for the display update rate</li>
</ul>
<h2 id="v109">V1.09</h2>
<ul>
<li>Adds display modes, for slowing down or simplifying the display</li>
</ul>
<h2 id="v108">V1.08</h2>
<ul>
<li>Fix settings menu not showing flip display</li>
</ul>
<h2 id="v107">V1.07</h2>
<ul>
<li>Adds shutdown time to automatically shutdown the iron after inactivity</li>
</ul>
<h2 id="v106">V1.06</h2>
<ul>
<li>Changes H and C when the iron is heating to the minidso chevron like images</li>
</ul>
<h2 id="v105">V1.05</h2>
<ul>
<li>Adds ability to calibrate the input voltage measurement</li>
</ul>
<h2 id="v104">V1.04</h2>
<ul>
<li>Increased accuracy of the temperature control</li>
<li>Improved PID response slightly</li>
<li>Allows temperature offset calibration</li>
<li>Nicer idle screen</li>
</ul>
<h2 id="v103">V1.03</h2>
<ul>
<li>Improved Button handling</li>
<li>Ability to set motion sensitivity</li>
<li>DC voltmeter page shows input voltage</li>
</ul>
<h2 id="v102">V1.02</h2>
<ul>
<li>Adds hold both buttons on IDLE to access the therometer mode</li>
<li>Changes the exit soldering mode to be holding both buttons (Like original firmware)</li>
</ul>
</div>
</div><footer>
<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>
</div>
<script>var base_url = '..';</script>
<script src="../js/theme_extra.js" defer></script>
<script src="../js/theme.js" defer></script>
<script src="../search/main.js" defer></script>
<script defer>
window.onload = function () {
SphinxRtdTheme.Navigation.enable(true);
};
</script>
</body>
</html>

164
Logo/index.html Normal file
View File

@@ -0,0 +1,164 @@
<!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/Logo/" />
<link rel="shortcut icon" href="../img/favicon.ico" />
<title>Startup Logos - 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/10.5.0/styles/github.min.css" />
<script>
// Current page data
var mkdocs_page_name = "Startup Logos";
var mkdocs_page_input_path = "Logo.md";
var mkdocs_page_url = "/IronOS/Logo/";
</script>
<script src="../js/jquery-3.6.0.min.js" defer></script>
<!--[if lt IE 9]>
<script src="../js/html5shiv.min.js"></script>
<![endif]-->
<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.5.0/highlight.min.js"></script>
<script>hljs.initHighlightingOnLoad();</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" 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>
<li class="toctree-l1"><a class="reference internal" href="../GettingStarted/">Getting Started</a>
</li>
</ul>
<p class="caption"><span class="caption-text">Troubleshooting</span></p>
<ul>
<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>
</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" alt="Docs"></a> &raquo;</li>
<li>Startup Logos</li>
<li class="wy-breadcrumbs-aside">
<a href="https://github.com/ralim/IronOS/edit/master/docs/Logo.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="startup-logos">Startup Logos</h1>
<p>This firmware supports a user created bootup logo.
By default, there is <em>not</em> one included in the firmware. This means that once flashed they generally stay. If you want no logo again, you would have to flash a blank image to the bootup logo. </p>
<h2 id="generating-the-logo-files">Generating the Logo files</h2>
<p>There are community logo's already converted and ready to use in <a href="https://github.com/Ralim/IronOS-Meta/releases">IronOS-Meta/releases</a>.
Download the zip for Pinecil or Miniware and then install using the instructions in the Flashing section below.</p>
<p>If you want to make custom art then it needs to be converted with a Python script. The script and other needed files are in <a href="https://github.com/Ralim/IronOS-Meta/">IronOS-Meta</a>. Go to that folder, then it is easiest to select the green Code button (upper right), then Download Zip. This way you get all the files you need and some extras. You only need what is inside Boot Logos. Put your custom image inside the Boot Logos folder with all python script files already there.</p>
<p>The Python script converts an image passed into it on the command line into both a <code>.hex</code> file and a <code>.dfu</code> to be uploaded to the iron in DFU mode. The image can be in color and any size, but it will be resized and converted to 1-bit color. However, it looks best if you create a 96x16 image (Png or Bmp) in any image editor and color the pixels black &amp; white manually.</p>
<p>The converter requires at least Python3 and Pillow apps. Follow online instructions for installing Python and Pillow.</p>
<p>For Windows, it is recommended to use Windows PowerShell instead of Command.
Open Powershell (run as administrator), type python to install it, it will open microsoft store where you can install it free.
Go back to Powershell and install Pillow. What works can vary, but this command may work:</p>
<pre><code>python -m pip install Pillow
</code></pre>
<p>or
python3 -m pip install pillow</p>
<p>If the above does not work, see <a href="https://stackoverflow.com/a/20061019/6705343">this page</a> on StackOverflow about installing Pillow.
Now that Python and Pillow are successfuly installed, you can convert an image.</p>
<p>Go back to Powershell and type this command (change infile.png to the name of your image):</p>
<ul>
<li><code>python img2logo.py infile.png out -m</code> for Miniware</li>
<li><code>python img2logo.py infile.png out -p</code> for Pinecil</li>
</ul>
<p>Run <code>python img2logo.py --help</code> to see available options. Replace the word python with python3 if you have multiple versions of python installed. </p>
<p>Note: make sure your image file is in the same folder as script files (img2logo.py, output_dfu.py, output_hex.py).</p>
<h2 id="flashing-the-logo">Flashing the Logo</h2>
<h3 id="miniware-ts100ts80ts80p">Miniware (TS100/TS80/TS80P)</h3>
<p>Upload the HEX file to the iron in DFU mode and, if the file's extension changes to .RDY, your custom splash screen should show up on startup.
You perform this the same way as if you were flashing a new firmware, and all the existing notes around this apply.</p>
<p>If you have flashed the <code>IronOS-dfu</code> alternative bootloader, you should use the <code>.dfu</code> files instead</p>
<h3 id="pinecil-v1">Pinecil V1</h3>
<p>For Pinecil V1, we require using dfu-util to flash the logo art (Pinecil does not use hex).
<a href="https://github.com/pine64/pine64_updater/releases">Pine64 Updater</a> is the easiest way to load the Bootup logo onto Pinecil as it already includes the necessary DFU library. Connect Pinecil to a PC, and open the Updater the same as updating firmware.
Select Custom &gt; Browse to the DFU image file you just made &gt; Update to install.</p>
<p>The bootup logo is stored in a separate location than the IronOS firmware and you do not have to worry about it changing or breaking the IronOS.</p>
<p>You could also use dfu-util and use Command line to install it.</p>
<ul>
<li><code>dfu-util -D logo_file.dfu</code></li>
</ul>
</div>
</div><footer>
<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>
</div>
<script>var base_url = '..';</script>
<script src="../js/theme_extra.js" defer></script>
<script src="../js/theme.js" defer></script>
<script src="../search/main.js" defer></script>
<script defer>
window.onload = function () {
SphinxRtdTheme.Navigation.enable(true);
};
</script>
</body>
</html>

177
Menu/index.html Normal file
View File

@@ -0,0 +1,177 @@
<!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/Menu/" />
<link rel="shortcut icon" href="../img/favicon.ico" />
<title>Menu System - 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/10.5.0/styles/github.min.css" />
<script>
// Current page data
var mkdocs_page_name = "Menu System";
var mkdocs_page_input_path = "Menu.md";
var mkdocs_page_url = "/IronOS/Menu/";
</script>
<script src="../js/jquery-3.6.0.min.js" defer></script>
<!--[if lt IE 9]>
<script src="../js/html5shiv.min.js"></script>
<![endif]-->
<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.5.0/highlight.min.js"></script>
<script>hljs.initHighlightingOnLoad();</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" 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>
<li class="toctree-l1"><a class="reference internal" href="../GettingStarted/">Getting Started</a>
</li>
</ul>
<p class="caption"><span class="caption-text">Troubleshooting</span></p>
<ul>
<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>
</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" alt="Docs"></a> &raquo;</li>
<li>Menu System</li>
<li class="wy-breadcrumbs-aside">
<a href="https://github.com/ralim/IronOS/edit/master/docs/Menu.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="menu-system">Menu System</h1>
<p>In this firmware for these soldering irons, all settings are adjustable on the device itself. This means a computer is <strong>not</strong> required to change any setting.</p>
<h2 id="soldering-mode">Soldering mode</h2>
<p>In this mode the iron works as you would expect, pressing either button will take you to a temperature change screen.
- Use each button to go up/down in temperature. Pressing both buttons exits the temperature menu (or wait 3 seconds and it will time out).
- Pressing both buttons or holding the rear button (<code>-/B</code>) will exit Soldering Mode.
- Holding the front button (<code>+/A</code>) will enter <a href="/Documentation/Menu.md#boost-mode">Boost mode</a> (if enabled).</p>
<h2 id="settings-mode">Settings mode</h2>
<p>This mode allows you to cycle through all the options and set custom values.
The menu is arranged so that the most often used settings are first.</p>
<ul>
<li>The rear button (<code>-/B</code>) cycles through the main options.</li>
<li>The front button (<code>+/A</code>) changes the selected option.</li>
<li>Note that settings are not saved until you exit the menu.</li>
<li>If you idle on a setting (i.e., don't press any buttons), after 3 seconds, the screen scrolls a brief description (mini help guide).</li>
<li>Enter submenus using the front button (<code>+/A</code>) if you are going to change it or wish to view it.</li>
<li>Scrolling through the all options of a submenu will return you back to its entry location.</li>
</ul>
<h3 id="calibrating-input-voltage">Calibrating input voltage</h3>
<p>Due to the tolerance on the resistors used for the input voltage divider, some irons can be up to 0.6 V out on the voltage measurement.
Please calibrate your iron if you have any issues with the cutoff voltage. This calibration is not required if you have no issues.
Note that cutoff messages can also be triggered by using a power supply that is too weak and fails under the load of the iron.</p>
<p>To calibrate your iron:</p>
<ol>
<li>Measure the input voltage with a multimeter and note it down.</li>
<li>Connect the input to your iron.</li>
<li>Enter the settings menu</li>
<li>Under the Advanced submenu</li>
<li>Select the calibrate voltage option</li>
<li>Use the front and back buttons to adjust the displayed voltage to minimize the error to your original measurement</li>
<li>Press both buttons at the same time to Save and Exit to the menu</li>
</ol>
<h3 id="calibrate-tip-cjc">Calibrate Tip CJC</h3>
<p>This performs a Tip Cold Junction Calibration (CJC) (<a href="/Documentation/Temperature.md">see Temperature for details</a>). This is normally not needed unless you have an issue with tip temperature or your tips are wearing out prematurely. Changing tip lengths does not necessarily mean a calibration is needed. Check first that your tips are not defective, and measured resistance is close to specifications (Pinecil/TS100 short tips 6.2 Ω, long tips 8 Ω, TS80(P) ~4.5 Ω).</p>
<p>What this is for: some tips have an offset on their readings which causes issues, i.e., the actual temperature of the tip is much higher than displayed. To calibrate this out, perform the following steps. </p>
<p>Caution: if the method below is not followed, the iron could be worse than before calibration. If you need to repeat the method, first unplug and let the handle/PCB cool down to room temperature.</p>
<ol>
<li>Connect power to your device.</li>
<li>Go to <strong><code>Advanced Settings</code></strong> using (<code>-/B</code>) and press (<code>+/A</code>) to select it. Use (<code>-/B</code>) to scroll to <strong><code>Calibrate CJC at next boot</code></strong> and confirm with (<code>+/A</code>).</li>
<li>Accept the <em>'warning text'</em> with (<code>+/A</code>).</li>
<li>Exit the settings menu as usual by pressing and holding (<code>-/B</code>).</li>
<li>Unplug you device.</li>
<li><strong>Critical: Make sure a tip is attached &amp; wait until the tip &amp; handle are at room temperature.</strong> (Wait a reasonable amount of time after having used the device.)</li>
<li>Power the device and ideally keep it out of your hands (You know it might get warm.).</li>
<li>The display shows <strong><code>....</code></strong> for a short time while the device measures and compares the tip and handle voltages.</li>
<li>As a result the new <em>Offset value</em> is displayed. This value can later be viewed in the <strong><code>Debug menu</code></strong>.</li>
<li>Calibration is done and the device proceeds booting.</li>
</ol>
<p>Note: offsets are dependant on your tip, temperature sensor, and the MCU. It's the culmination of tolerances at rest. Typical values are 700-1000 range. This is only designed to be used at boot while cold (ambient room temperature), as temperatures drift apart as soon as power is connected. Doing this reading repeatedly could result in wide varience of the offset number and/or incorrect calibration.</p>
<h3 id="boost-mode">Boost mode</h3>
<p>This allows you to change the front button (<code>+/A</code>) to become a boost button when you hold it for &gt; 2 seconds. A boost button changes the soldering temperature for short periods. For example, when soldering a big joint and you need a much higher temperature, hold the (<code>+/A</code>) button down and it will temporarily increase the temperature to your 'boost' setting. When you release the button, the temperature will gradually go back to the normal set temperature.</p>
<p>The boost temperature is set in Soldering settings.</p>
</div>
</div><footer>
<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>
</div>
<script>var base_url = '..';</script>
<script src="../js/theme_extra.js" defer></script>
<script src="../js/theme.js" defer></script>
<script src="../search/main.js" defer></script>
<script defer>
window.onload = function () {
SphinxRtdTheme.Navigation.enable(true);
};
</script>
</body>
</html>

262
Power/index.html Normal file
View File

@@ -0,0 +1,262 @@
<!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/Power/" />
<link rel="shortcut icon" href="../img/favicon.ico" />
<title>Power & Performance - 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/10.5.0/styles/github.min.css" />
<script>
// Current page data
var mkdocs_page_name = "Power \u0026 Performance";
var mkdocs_page_input_path = "Power.md";
var mkdocs_page_url = "/IronOS/Power/";
</script>
<script src="../js/jquery-3.6.0.min.js" defer></script>
<!--[if lt IE 9]>
<script src="../js/html5shiv.min.js"></script>
<![endif]-->
<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.5.0/highlight.min.js"></script>
<script>hljs.initHighlightingOnLoad();</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" 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>
<li class="toctree-l1"><a class="reference internal" href="../GettingStarted/">Getting Started</a>
</li>
</ul>
<p class="caption"><span class="caption-text">Troubleshooting</span></p>
<ul>
<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>
</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" alt="Docs"></a> &raquo;</li>
<li>Power & Performance</li>
<li class="wy-breadcrumbs-aside">
<a href="https://github.com/ralim/IronOS/edit/master/docs/Power.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="power-performance">Power &amp; Performance</h1>
<p>All of the irons are <a href="https://www.digikey.com/en/blog/pulse-width-modulation#">PWM controlled</a> resistive heating elements.
This means that the electronics in the handle can only turn the heating element on and off.
This <em>means</em> that the power provided in the tip is 100% controlled by the supply voltage used (higher voltage PSU = higher performance).</p>
<p>Irons at their simplest are just a resistor (Ω) connected to your power source via a switch.</p>
<ul>
<li>When the switch is on, the power in the resistor is: $P(watts) = V(volts) \times\ I(current=amps)$</li>
<li>Current through the resistor is: $I(amps) = V(volts) ÷ Ω (resistance)$</li>
<li>Combining these gives some common equations for Power</li>
</ul>
<p>$P(watts) = V(volts) * I(amps)$ or $P = V^2 ÷ Ω$</p>
<p>The resistance of the tip is a fixed constant in ohms (Ω):
- 6.2 Ω Pine64 short tip
- 8.0 Ω TS100/Pinecil long tip
- 4.5 Ω TS80(P)</p>
<p>This means the power delivered to the soldering tip is proportional to the voltage squared.
Therefore the Pinecil and TS100 perform poorly when run off 12V power supplies and may issue a <code>Thermal Runaway</code> message (weak power supply).</p>
<h4 id="use-an-ohm-calculator-to-quickly-derive-watts">Use an <a href="https://www.rapidtables.com/calc/electric/power-calculator.html#dc">Ohm calculator</a> to quickly derive watts.</h4>
<table>
<thead>
<tr>
<th align="center">Type</th>
<th align="center">Volts</th>
<th align="center">/</th>
<th align="center">Tip Ω</th>
<th align="center">=</th>
<th align="center">Amps</th>
<th align="center">*</th>
<th align="center">Volts</th>
<th align="center">=</th>
<th align="center">Watts</th>
</tr>
</thead>
<tbody>
<tr>
<td align="center">USB QC3.0</td>
<td align="center">9V</td>
<td align="center">/</td>
<td align="center">4.5 Ω</td>
<td align="center">=</td>
<td align="center">2.0A</td>
<td align="center">*</td>
<td align="center">9V</td>
<td align="center">=</td>
<td align="center">18W</td>
</tr>
<tr>
<td align="center">USB-C PD</td>
<td align="center">12V</td>
<td align="center">/</td>
<td align="center">4.5 Ω</td>
<td align="center">=</td>
<td align="center">3.0A</td>
<td align="center">*</td>
<td align="center">12V</td>
<td align="center">=</td>
<td align="center">32W</td>
</tr>
<tr>
<td align="center">USB-C PD</td>
<td align="center">20V</td>
<td align="center">/</td>
<td align="center">8.0 Ω</td>
<td align="center">=</td>
<td align="center">2.5A</td>
<td align="center">*</td>
<td align="center">20V</td>
<td align="center">=</td>
<td align="center">50W</td>
</tr>
<tr>
<td align="center">USB-C PD</td>
<td align="center">20V</td>
<td align="center">/</td>
<td align="center">6.2 Ω</td>
<td align="center">=</td>
<td align="center">3.2A</td>
<td align="center">*</td>
<td align="center">20V</td>
<td align="center">=</td>
<td align="center">64W</td>
</tr>
<tr>
<td align="center">DC Barrel</td>
<td align="center">24V</td>
<td align="center">/</td>
<td align="center">8.0 Ω</td>
<td align="center">=</td>
<td align="center">3.0A</td>
<td align="center">*</td>
<td align="center">24V</td>
<td align="center">=</td>
<td align="center">72W</td>
</tr>
<tr>
<td align="center">DC Barrel</td>
<td align="center">24V</td>
<td align="center">/</td>
<td align="center">6.2 Ω</td>
<td align="center">=</td>
<td align="center">3.8A</td>
<td align="center">*</td>
<td align="center">24V</td>
<td align="center">=</td>
<td align="center">92W</td>
</tr>
<tr>
<td align="center">EPR PD3.1</td>
<td align="center">28V</td>
<td align="center">/</td>
<td align="center">8.0 Ω</td>
<td align="center">=</td>
<td align="center">3.5A</td>
<td align="center">*</td>
<td align="center">28V</td>
<td align="center">=</td>
<td align="center">98W</td>
</tr>
<tr>
<td align="center">EPR PD3.1</td>
<td align="center">28V</td>
<td align="center">/</td>
<td align="center">6.2 Ω</td>
<td align="center">=</td>
<td align="center">4.5A</td>
<td align="center">*</td>
<td align="center">28V</td>
<td align="center">=</td>
<td align="center">126W</td>
</tr>
</tbody>
</table>
<h2 id="output-control-regulation">Output Control &amp; Regulation</h2>
<p>These soldering irons use a FET to switch the power to the soldering iron tip. This is a P-MOSFET and its controlled via a small transistor circuit, which in turn is controlled via the MCU (i.e., STM32). The MCU controls this PWM output proportional to the output from the PID control loop running in the software.</p>
<p>To measure the tip temperature in the iron, the iron has a small op-amp connected across the terminals at the cold end of the tip. This is setup to measure the voltage across the same terminals that are used to power the tip. In order to read the very small voltage generated by the <a href="/Documentation/Temperature.md">thermocouple cold junction</a>, the iron's output must be turned off for a moment.</p>
<p>Once the output is turned off (via the FET), the system has a recovery time as the tip capacitance discharges and the op-amp exits saturation. After this delay period, the MCU's ADC (analog-to-digital converter) samples the output of the op-amp 8 times quickly and then sets a flag to turn the PWM output back on.
This enforces a small dead time in the output signal while this occurs, so there is a balance between sampling the temperature often to maintain a stable tip temperature control and sampling less often to increase the maximum power deliverable to the tip (<a href="/Documentation/Temperature.md#complexity-of-measurement">see Complexity of measurement</a>).</p>
</div>
</div><footer>
<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>
</div>
<script>var base_url = '..';</script>
<script src="../js/theme_extra.js" defer></script>
<script src="../js/theme.js" defer></script>
<script src="../search/main.js" defer></script>
<script defer>
window.onload = function () {
SphinxRtdTheme.Navigation.enable(true);
};
</script>
</body>
</html>

286
Settings/index.html Normal file
View File

@@ -0,0 +1,286 @@
<!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/Settings/" />
<link rel="shortcut icon" href="../img/favicon.ico" />
<title>Settings - 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/10.5.0/styles/github.min.css" />
<script>
// Current page data
var mkdocs_page_name = "Settings";
var mkdocs_page_input_path = "Settings.md";
var mkdocs_page_url = "/IronOS/Settings/";
</script>
<script src="../js/jquery-3.6.0.min.js" defer></script>
<!--[if lt IE 9]>
<script src="../js/html5shiv.min.js"></script>
<![endif]-->
<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.5.0/highlight.min.js"></script>
<script>hljs.initHighlightingOnLoad();</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" 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>
<li class="toctree-l1"><a class="reference internal" href="../GettingStarted/">Getting Started</a>
</li>
</ul>
<p class="caption"><span class="caption-text">Troubleshooting</span></p>
<ul>
<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>
</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" alt="Docs"></a> &raquo;</li>
<li>Settings</li>
<li class="wy-breadcrumbs-aside">
<a href="https://github.com/ralim/IronOS/edit/master/docs/Settings.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">
<!-- This is an automatically generated file. DO NOT EDIT. Edit gen_menu_docs.py instead -->
<h1 id="ironos-settings-menu">IronOS Settings Menu</h1>
<p>The below breaks down the menu's and what each setting means.</p>
<h2 id="menu-categories">Menu Categories</h2>
<p>In the menu there are a few main categories that are used to keep the list manageable.</p>
<h3 id="category-power-settings">Category: Power settings</h3>
<p>Menu for settings related to power. Main settings to do with the input voltage.</p>
<h3 id="category-soldering-settings">Category: Soldering settings</h3>
<p>Settings for soldering mode, such as boost temps, the increment used when pressing buttons and if button locking is enabled.</p>
<h3 id="category-sleep-mode">Category: Sleep mode</h3>
<p>Settings to do with power saving, such as sleep mode, sleep temps, and shutdown modes.</p>
<h3 id="category-user-interface">Category: User interface</h3>
<p>User interface related settings, such as units.</p>
<h3 id="category-advanced-settings">Category: Advanced settings</h3>
<p>Advanced settings. Misc catchall for settings that don't fit anywhere else or settings that require some thought before use.</p>
<h2 id="settings">Settings</h2>
<p>These are all of the settings possible in the menu.
<strong>Not all settings are visible for all devices.</strong>
For example, the TS100 does not have USB-PD settings.</p>
<p>When using the device, if unsure you can pause (press nothing) on a setting and after a short delay help text will scroll across the screen.
This is the "on device help text".</p>
<h3 id="setting-power-source">Setting: Power source</h3>
<p>When the device is powered by a battery, this adjusts the low voltage threshold for when the unit should turn off the heater to protect the battery.</p>
<p>On device help text:</p>
<p>Set cutoff voltage to prevent battery over-drain. (DC 10V) (S=3.3V per cell, disable PWR limit)</p>
<h3 id="setting-sleep-temp">Setting: Sleep temp</h3>
<p>Temperature the device will drop down to while asleep. Typically around halfway between off and soldering temperature.</p>
<p>On device help text:</p>
<p>Tip temperature while in "sleep mode"</p>
<h3 id="setting-sleep-timeout">Setting: Sleep timeout</h3>
<p>How long of a period without movement / button-pressing is required before the device drops down to the sleep temperature.</p>
<p>On device help text:</p>
<p>Interval before "sleep mode" starts (s=seconds | m=minutes)</p>
<h3 id="setting-shutdown-timeout">Setting: Shutdown timeout</h3>
<p>How long of a period without movement / button-pressing is required before the device turns off the tip heater completely and returns to the main idle screen.</p>
<p>On device help text:</p>
<p>Interval before the iron shuts down (m=minutes)</p>
<h3 id="setting-motion-sensitivity">Setting: Motion sensitivity</h3>
<p>Scale of how sensitive the device is to movement. Higher numbers == more sensitive. 0 == motion detection turned off.</p>
<p>On device help text:</p>
<p>0=off | 1=least sensitive | ... | 9=most sensitive</p>
<h3 id="setting-temperature-unit">Setting: Temperature unit</h3>
<p>If the device shows temperatures in °C or °F.</p>
<p>On device help text:</p>
<p>C=Celsius | F=Fahrenheit</p>
<h3 id="setting-detailed-idle-screen">Setting: Detailed idle screen</h3>
<p>Should the device show an 'advanced' view on the idle screen. The advanced view uses text to show more details than the typical icons.</p>
<p>On device help text:</p>
<p>Display detailed info in a smaller font on idle screen</p>
<h3 id="setting-display-orientation">Setting: Display orientation</h3>
<p>If the display should rotate automatically or if it should be fixed for left- or right-handed mode.</p>
<p>On device help text:</p>
<p>R=right-handed | L=left-handed | A=automatic</p>
<h3 id="setting-boost-temp">Setting: Boost temp</h3>
<p>When the unit is in soldering mode. You can hold down the button at the front of the device to temporarily override the soldering temperature to this value. This SETS the temperature, it does not ADD to it.</p>
<p>On device help text:</p>
<p>Tip temperature used in "boost mode"</p>
<h3 id="setting-start-up-behavior">Setting: Start-up behavior</h3>
<p>When the device powers up, should it enter into a special mode. These settings set it to either start into soldering mode, sleeping mode or auto mode (Enters into soldering mode on the first movement).</p>
<p>On device help text:</p>
<p>O=off | S=heat to soldering temp | Z=standby at sleep temp until moved | R=standby, heat-off until moved</p>
<h3 id="setting-cooldown-flashing">Setting: Cooldown flashing</h3>
<p>If the idle screen should blink the tip temperature for attention while the tip is over 50°C. Intended as a 'tip is still hot' warning.</p>
<p>On device help text:</p>
<p>Flash temperature reading at idle if tip is hot</p>
<h3 id="setting-calibrate-cjc-at-next-boot">Setting: Calibrate CJC at next boot</h3>
<p>Note:
If the difference between the target temperature and the measured temperature is less than 5°C, <strong>calibration is NOT required at all</strong>.</p>
<p>This is used to calibrate the offset between ADC and Op-amp of the tip at next boot (Idealy it has to be done at boot, before internal components get warm.). But this setting is <strong><em>not permanent!</em></strong> It resetes after the calibration is completed (At next boot the checkbox will be unchecked!). If you need to repeat the calibration however, you have to set the checkbox <em>again</em>, unplug your device and let it cool down to room/ambient temperature &amp; power it up, idealy while it sits on the desk.</p>
<p>Hence, never repeat the calibration in quick succession!</p>
<p>On device help text:</p>
<p>Calibrate tip Cold Junction Compensation at the next boot (not required if Delta T is &lt; 5°C)</p>
<h3 id="setting-restore-default-settings">Setting: Restore default settings</h3>
<p>Resets all settings and calibrations to factory defaults. Does NOT erase custom user boot up logo's.</p>
<p>On device help text:</p>
<p>Reset default settings for this firmware ver.</p>
<h3 id="setting-calibrate-input-voltage">Setting: Calibrate input voltage</h3>
<p>Enters an adjustment mode where you can gradually adjust the measured voltage to compensate for any unit-to-unit variance in the voltage sense resistors.</p>
<p>On device help text:</p>
<p>Start VIN calibration (long press to exit)</p>
<h3 id="setting-detailed-solder-screen">Setting: Detailed solder screen</h3>
<p>Should the device show an 'advanced' soldering view. This is a text-based view that shows more information at the cost of no nice graphics.</p>
<p>On device help text:</p>
<p>Display detailed info in a smaller font on soldering screen</p>
<h3 id="setting-scrolling-speed">Setting: Scrolling speed</h3>
<p>How fast the description text scrolls when hovering on a menu. Faster speeds may induce tearing, but allow reading the whole description faster.</p>
<p>On device help text:</p>
<p>Speed info text scrolls past at (S=slow | F=fast)</p>
<h3 id="setting-qc-voltage">Setting: QC voltage</h3>
<p>This adjusts the maximum voltage the QC negotiation will adjust to. Does NOT affect USB-PD. Should be set safely based on the current rating of your power supply.</p>
<p>On device help text:</p>
<p>Max QC voltage the iron should negotiate for</p>
<h3 id="setting-pd-timeout">Setting: PD timeout</h3>
<p>How long until firmware stops trying to negotiate for USB-PD and tries QC instead. Longer times may help dodgy / old PD adapters, faster times move onto PD quickly. Units of 100ms. Recommended to keep small values.</p>
<p>On device help text:</p>
<p>PD negotiation timeout in 100ms steps for compatibility with some QC chargers</p>
<h3 id="setting-power-limit">Setting: Power limit</h3>
<p>Allows setting a custom wattage for the device to aim to keep the AVERAGE power below. The unit can't control its peak power no matter how you set this. (Except for MHP30 which will regulate nicely to this). If USB-PD is in use, the limit will be set to the lower of this and the supplies advertised wattage.</p>
<p>On device help text:</p>
<p>Maximum power the iron can use (W=watt)</p>
<h3 id="setting-swap-keys">Setting: Swap + - keys</h3>
<p>Swaps which button increments and decrements on temperature change screens.</p>
<p>On device help text:</p>
<p>Reverse assignment of buttons for temperature adjustment</p>
<h3 id="setting-temp-change-short">Setting: Temp change short</h3>
<p>Factor by which the temperature is changed with a quick press of the buttons.</p>
<p>On device help text:</p>
<p>Temperature-change-increment on short button press</p>
<h3 id="setting-temp-change-long">Setting: Temp change long</h3>
<p>Factor by which the temperature is changed with a hold of the buttons.</p>
<p>On device help text:</p>
<p>Temperature-change-increment on long button press</p>
<h3 id="setting-power-pulse">Setting: Power pulse</h3>
<p>Enables and sets the wattage of the power pulse. Power pulse causes the device to briefly turn on the heater to draw power to avoid power banks going to sleep.</p>
<p>On device help text:</p>
<p>Intensity of power of keep-awake-pulse (watt)</p>
<h3 id="setting-hall-sensor-sensitivity">Setting: Hall sensor sensitivity</h3>
<p>If the unit has a hall effect sensor (Pinecil), this adjusts how sensitive it is at detecting a magnet to put the device into sleep mode.</p>
<p>On device help text:</p>
<p>Sensitivity to magnets (0=off | 1=least sensitive | ... | 9=most sensitive)</p>
<h3 id="setting-allow-locking-buttons">Setting: Allow locking buttons</h3>
<p>If locking the buttons against accidental presses is enabled.</p>
<p>On device help text:</p>
<p>While soldering, hold down both buttons to toggle locking them (D=disable | B=boost mode only | F=full locking)</p>
<h3 id="setting-minimum-voltage">Setting: Minimum voltage</h3>
<p>When powered by a battery, this adjusts the minimum voltage per cell before shutdown. (This is multiplied by the cell count.)</p>
<p>On device help text:</p>
<p>Minimum allowed voltage per battery cell (3S: 3 - 3.7V | 4-6S: 2.4 - 3.7V)</p>
<h3 id="setting-anim-loop">Setting: Anim. loop</h3>
<p>Should the menu animations loop. Only visible if the animation speed is not set to "Off"</p>
<p>On device help text:</p>
<p>Loop icon animations in main menu</p>
<h3 id="setting-anim-speed">Setting: Anim. speed</h3>
<p>How fast should the menu animations loop, or if they should not loop at all.</p>
<p>On device help text:</p>
<p>Pace of icon animations in menu (O=off | S=slow | M=medium | F=fast)</p>
<h3 id="setting-power-pulse-delay">Setting: Power pulse delay</h3>
<p>Adjusts the time interval between power pulses. Longer gaps reduce undesired heating of the tip, but needs to be fast enough to keep your power bank awake.</p>
<p>On device help text:</p>
<p>Delay before keep-awake-pulse is triggered (x 2.5s)</p>
<h3 id="setting-power-pulse-duration">Setting: Power pulse duration</h3>
<p>How long should the power pulse go for. Some power banks require seeing the power draw be sustained for a certain duration to keep awake. Should be kept as short as possible to avoid wasting power / undesired heating of the tip.</p>
<p>On device help text:</p>
<p>Keep-awake-pulse duration (x 250ms)</p>
<h3 id="setting-language-en-english">Setting: Language: EN English</h3>
<p>Changes the device language on multi-lingual builds.</p>
<p>On device help text:</p>
<p>Current firmware language</p>
<h3 id="setting-screen-brightness">Setting: Screen brightness</h3>
<p>Display brightness. Higher values age the OLED faster due to burn-in. (However, it is notable that most of these screens die from other causes first.)</p>
<p>On device help text:</p>
<p>Adjust the OLED screen brightness</p>
<h3 id="setting-invert-screen">Setting: Invert screen</h3>
<p>Inverts the entire OLED.</p>
<p>On device help text:</p>
<p>Invert the OLED screen colors</p>
<h3 id="setting-boot-logo-duration">Setting: Boot logo duration</h3>
<p>Sets the duration for the boot logo (s=seconds).</p>
<p>On device help text:</p>
<p>Set Boot logo duration (off | s=seconds | infinity)</p>
</div>
</div><footer>
<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>
</div>
<script>var base_url = '..';</script>
<script src="../js/theme_extra.js" defer></script>
<script src="../js/theme.js" defer></script>
<script src="../search/main.js" defer></script>
<script defer>
window.onload = function () {
SphinxRtdTheme.Navigation.enable(true);
};
</script>
</body>
</html>

157
Temperature/index.html Normal file
View File

@@ -0,0 +1,157 @@
<!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/Temperature/" />
<link rel="shortcut icon" href="../img/favicon.ico" />
<title>Tip temperature measurement - 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/10.5.0/styles/github.min.css" />
<script>
// Current page data
var mkdocs_page_name = "Tip temperature measurement";
var mkdocs_page_input_path = "Temperature.md";
var mkdocs_page_url = "/IronOS/Temperature/";
</script>
<script src="../js/jquery-3.6.0.min.js" defer></script>
<!--[if lt IE 9]>
<script src="../js/html5shiv.min.js"></script>
<![endif]-->
<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.5.0/highlight.min.js"></script>
<script>hljs.initHighlightingOnLoad();</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" 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>
<li class="toctree-l1"><a class="reference internal" href="../GettingStarted/">Getting Started</a>
</li>
</ul>
<p class="caption"><span class="caption-text">Troubleshooting</span></p>
<ul>
<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>
</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" alt="Docs"></a> &raquo;</li>
<li>Tip temperature measurement</li>
<li class="wy-breadcrumbs-aside">
<a href="https://github.com/ralim/IronOS/edit/master/docs/Temperature.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="tip-temperature-measurement">Tip temperature measurement</h1>
<p>The soldering irons use a modified N-type thermocouple in the tip to measure the tip temperature.
This is constructed for free by using a different type of metal to join one of the rings to the heating coil. This effectively creates a free temperature sensor for very low cost and construction difficulty.</p>
<p>The downsides of this are twofold; one, it is made using non-optimal metals and has a non-constant temperature response; and two, as this uses the same connections as the heating current, you can't measure the temperature while you are heating the tip.</p>
<h2 id="how-a-thermocouple-works-brief">How a thermocouple works (brief)</h2>
<p><a href="https://www.youtube.com/watch?v=v7NUi88Lxi8">Thermocouples use a junction of two dissimilar metals</a> to create a very small amount of power (microvolts). This can then be measured and used with a known transfer function to derive the temperature of the junction.
This has some fairly large limitations, but it also has the benefit of being extremely cheap.</p>
<p>Conventionally a thermocouple is created using two dissimilar metals that join, and then the other ends of these metals are terminated to copper contacts. These copper contacts are also part of the construction of the thermocouple and are referred to as the cold junction.
As there are these extra two joins between the thermocouple wires and the copper; these also have properties of their own in their reactions with temperature.</p>
<p>If the cold junction is held at 0 degrees Celsius, then their effect is considered to be null, and so they can be ignored. However, in the real world the joins to copper are often at room temperature, and as such the measured voltage from the thermocouple must be compensated to remove the influence of these joints. This process is often called cold junction compensation.</p>
<p>Every time in the circuit there is a join between two different metals, then a small thermocouple is created, this means that <em>every</em> soldered connection is also one. </p>
<h2 id="how-these-irons-implement-the-temperature-reading">How these irons implement the temperature reading</h2>
<p>If you analyse one of the open circuit schematics (Pinecil, TS100, TS80) they all use the same approximate formula.
This consists of an op-amp that is connected directly across the heating connections to the tip, and a separate handle temperature sensor.</p>
<p>When the iron is <strong>not</strong> heating the tip, the microcontroller uses the ADC to read the output from the op-amp. This produces a voltage that <em>should</em> be linear to the temperature of (tip-handle). This value is then offset compensated (to remove ADC+op-amp offsets), and then converted into a temperature delta in °C/K. This temperature delta can then be added to the handle temperature to derive the tip temperature in degrees Celsius.</p>
<p>Depending on the construction of the tip, the lookup values used for converting the tip reading in µV into °C/K varies. It is worth noting, however, that TS100 and Pinecil tips are approximately the same as the Hakko T12 tips. (In @Ralim's testing, to within measurement error). This makes sense as the T12 tips are an excellent and cheap design for Miniware to mimic in making the TS100 in the first place.</p>
<h2 id="implications-of-this">Implications of this</h2>
<h3 id="reading-accuracy-vs-heating-performance-tradeoff">Reading accuracy vs Heating performance tradeoff</h3>
<p>Because the tip can only be measured when the unit is not heating, the more often the tip is measured (for finer temperature control) the less time the unit can spend heating up the tip. This means that for fast heat up and fine temperature control the firmware now implements two speeds to the controller loop. During heating up the system runs fewer temperature measurements and instead allows the tip to spend more time burning power. Once the unit is up to temperature, the rate of taking temperature readings is doubled to allow for faster reaction times.</p>
<h3 id="tip-heat-up-lag-time">Tip heat up lag time</h3>
<p>As the temperature sensor is a part of the heater coil inside of the tip (or very close by, not entirely certain); the temperature reading is of the <em>inside</em> of the tip, rather than the outside. The outside temperature is the most critical for the user as this is where the solder is actually melting and performing work.</p>
<p>The PID controller in the firmware is tuned to be slightly underdamped and thus more "jumpy" than some people would expect. This is based on the theory that if the inside of the tip is seeing the temperature drop; the outside temperature has dropped more and so we should overcompensate until they equalise.</p>
<p>This is why sometimes the temperature may flick around a little during use but the tip temperature itself is quite stable. The thermal mass of the tip smooths these small amounts out nicely for the user. Though seeing larger jumps on some tips than others <em>may</em> indicate that the tip does not have optimal internal thermal bonding between the heater coil and the tip itself.</p>
<p>The firmware uses the theory that these irons are aimed more to the power users territory than most, so it tries to <em>not</em> hide the actual temperature. Some soldering iron controllers hide the actual measurement once you are within a certain tolerance of this. For example, on a digital Weller unit that Ralim has, if set to 350 °C, it will regulate to within around +/- 3°C but not indicate you are outside of the margin of error until you exceed +/- 5°C. This gives the illusion that it's holding the temperature perfectly when in actuality it's moving around as well.</p>
<p>Given enough time (3-5 seconds) with no external cooling, the inside and outside temperatures of the tip will be equal. When testing the tip temperature accuracy try to allow time for the system to stabilise.</p>
<h3 id="complexity-of-measurement">Complexity of measurement</h3>
<p>The firmware in these irons does a <em>best-effort</em> of calculating an accurate temperature. As always there is a tradeoff between perfect accuracy and firmware complexity and setup. These irons are built down to a cost; expecting accuracy greater than 1% is not really an option as the voltage reference is only 1% accurate at best. So <em>all</em> measurements are affected by its accuracy. The low-cost chips used in the irons do not come calibrated from the factory so we do not have an internal calibration we can use to try and measure this inaccuracy.</p>
<p>The firmware only accounts for <a href="https://www.tegam.com/what-exactly-is-cold-junction-compensation/">cold junction compensation</a> and then treats the remaining error as being a constant offset.
While the error is small, it is actually composed of both a constant offset as well as an offset that is linear to the handle temperature.
This offset that is linear to handle temperature is as of current not modelled into the firmware and is assumed to be constant. This is generally <em>close enough</em> as once the unit is in use, the handle temperature is usually within 10 °C as the components inside warm-up from use. This means that this error is "relatively" constant once the unit is being used. </p>
<p><code>However, this can cause odd behaviour when the tip temperature ~= room temperature. It can cause some jumping and movement in the readings when attempting to control the tip to sub 100 °C.</code></p>
<p>This is a known tradeoff that is made as the irons intended use case means that it will spend most of its time above 150 °C, at which point these errors are no longer the dominant error sources in the system.</p>
</div>
</div><footer>
<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>
</div>
<script>var base_url = '..';</script>
<script src="../js/theme_extra.js" defer></script>
<script src="../js/theme.js" defer></script>
<script src="../search/main.js" defer></script>
<script defer>
window.onload = function () {
SphinxRtdTheme.Navigation.enable(true);
};
</script>
</body>
</html>

129
Translation/index.html Normal file
View File

@@ -0,0 +1,129 @@
<!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/Translation/" />
<link rel="shortcut icon" href="../img/favicon.ico" />
<title>Translation - 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/10.5.0/styles/github.min.css" />
<script>
// Current page data
var mkdocs_page_name = "Translation";
var mkdocs_page_input_path = "Translation.md";
var mkdocs_page_url = "/IronOS/Translation/";
</script>
<script src="../js/jquery-3.6.0.min.js" defer></script>
<!--[if lt IE 9]>
<script src="../js/html5shiv.min.js"></script>
<![endif]-->
<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.5.0/highlight.min.js"></script>
<script>hljs.initHighlightingOnLoad();</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" 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>
<li class="toctree-l1"><a class="reference internal" href="../GettingStarted/">Getting Started</a>
</li>
</ul>
<p class="caption"><span class="caption-text">Troubleshooting</span></p>
<ul>
<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>
</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" alt="Docs"></a> &raquo;</li>
<li>Translation</li>
<li class="wy-breadcrumbs-aside">
<a href="https://github.com/ralim/IronOS/edit/master/docs/Translation.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="translation">Translation</h1>
<p>If you would like to contribute a translation, use the <a href="http://htmlpreview.github.io/?https://github.com/Ralim/ts100/blob/master/Translations/TranslationEditor.html">Translation Editor</a>.</p>
<p><a href="https://github.com/Ralim/ts100/tree/master/Translations">Open a reference language file and optionally a target language file</a>.</p>
<p>You can create a pull request with the new / updated json configuration file, and this will include this language into the new builds for the firmware.</p>
</div>
</div><footer>
<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>
</div>
<script>var base_url = '..';</script>
<script src="../js/theme_extra.js" defer></script>
<script src="../js/theme.js" defer></script>
<script src="../search/main.js" defer></script>
<script defer>
window.onload = function () {
SphinxRtdTheme.Navigation.enable(true);
};
</script>
</body>
</html>

208
Troubleshooting/index.html Normal file
View File

@@ -0,0 +1,208 @@
<!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/Troubleshooting/" />
<link rel="shortcut icon" href="../img/favicon.ico" />
<title>Troubleshooting - 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/10.5.0/styles/github.min.css" />
<script>
// Current page data
var mkdocs_page_name = "Troubleshooting";
var mkdocs_page_input_path = "Troubleshooting.md";
var mkdocs_page_url = "/IronOS/Troubleshooting/";
</script>
<script src="../js/jquery-3.6.0.min.js" defer></script>
<!--[if lt IE 9]>
<script src="../js/html5shiv.min.js"></script>
<![endif]-->
<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.5.0/highlight.min.js"></script>
<script>hljs.initHighlightingOnLoad();</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" 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>
<li class="toctree-l1"><a class="reference internal" href="../GettingStarted/">Getting Started</a>
</li>
</ul>
<p class="caption"><span class="caption-text">Troubleshooting</span></p>
<ul class="current">
<li class="toctree-l1 current"><a class="reference internal current" href="./">Troubleshooting</a>
<ul class="current">
<li class="toctree-l2"><a class="reference internal" href="#high-tip-temp-reading-when-the-tip-is-cool">High tip temp reading when the tip is cool</a>
<ul>
<li class="toctree-l3"><a class="reference internal" href="#rtip-is-out-of-spec">RTip is out of spec</a>
</li>
<li class="toctree-l3"><a class="reference internal" href="#chan-is-out-of-spec">CHan is out of spec</a>
</li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="#no-display-or-dots-on-the-display">No display OR dots on the display</a>
</li>
<li class="toctree-l2"><a class="reference internal" href="#tip-heats-when-not-in-heating-mode">Tip heats when not in heating mode</a>
</li>
<li class="toctree-l2"><a class="reference internal" href="#accelerometer-not-detected">Accelerometer not detected</a>
</li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../HardwareIssues/">Known Hardware Issues</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" alt="Docs"></a> &raquo;</li>
<li>Troubleshooting &raquo;</li>
<li>Troubleshooting</li>
<li class="wy-breadcrumbs-aside">
<a href="https://github.com/ralim/IronOS/edit/master/docs/Troubleshooting.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="troubleshooting">Troubleshooting</h1>
<p>If your device is not operating as expected; and you are within the manufacturer support window, please first contact your manufacturer and RMA / warranty your device.</p>
<p>If your iron is not working as expected, <a href="../DebugMenu/">the Debug menu</a> exposes internal measurements to help you narrow down the root cause of the issue.</p>
<p>Alongside all of these, issues with the soldering of the main MCU could cause all of these as well; and should always be checked.</p>
<p>The tip is important for the operation of your iron. T100 and Pinecil tips are around 8 ohms, and TS80(P) tips are around 4.5 ohms.</p>
<p>You are welcome to open discussions about issues as well, or if you bought your Pinecil from an official store; use the <a href="https://wiki.pine64.org/wiki/Pinecil#Community_links">Pinecil community chat</a> for support.
But it is helpful to do some basic diagnostics first just in case the issue is easily fixed.</p>
<p>The <strong>VAST</strong> majority of issues are poor soldering or cold solder joints.
If you can open up your iron, give it a good look at all the connection points, and use another iron to reflow any suspicious ones, this can fix most issues.</p>
<h2 id="high-tip-temp-reading-when-the-tip-is-cool">High tip temp reading when the tip is cool</h2>
<p>If you are finding the tip is reading high; the first fields to check in the Debug menu are <code>RTip</code> and <code>CHan</code>.</p>
<ul>
<li><code>RTip</code> is the raw tip reading in μV; at cool this should be around 700-1000 for larger tips and ~1500 for smaller tips (TS80's)</li>
<li><code>CHan</code> is the temperature of the temperature sensor on the PCB in degrees Celsius * 10. So 29 °C ambient should read as 290</li>
</ul>
<h3 id="rtip-is-out-of-spec">RTip is out of spec</h3>
<p><code>RTip</code> will over-read on bad contacts or no tip inserted.</p>
<p>If <code>RTip</code> is overreading, you may have one of the following:</p>
<ul>
<li>Partially stuck on main MOSFET</li>
<li>Slow reacting main MOSFET driver transistor</li>
<li>Damaged Op-Amp</li>
<li>Poor soldering on the Op-Amp circuitry</li>
<li>No tip inserted or tip that is not connecting correctly</li>
</ul>
<p>If <code>RTip</code> is under-reading you most likely have issues with the Op-Amp or the tip. The signal should be pulled high by hardware (reading hot), so this often means the MCU is not reading the signal correctly. Check MCU soldering.</p>
<h3 id="chan-is-out-of-spec">CHan is out of spec</h3>
<p>CHan reading comes directly from the cold junction compensation temperature sensor.
This is usually a TMP36 (Pinecil V1), or an NTC thermistor (MHP30, TS80P, Pinecil V2).</p>
<p>If <code>CHan</code> is reading low:</p>
<ul>
<li>Check the connection from the MCU to the handle temperature sensor.</li>
<li>Check the power pin connection on the TMP36</li>
<li>Check pullup resistor on the NTC thermistor</li>
<li>Check no bridged pins or weak shorts on the signal to nearby pins on MCU or temperature sensor</li>
<li>Reflow/resolder the aforementioned components</li>
</ul>
<p>If <code>CHan</code> is reading higher</p>
<ul>
<li>Check ground connections on the sensors</li>
<li>Check no bridged pins or weak shorts on the signal to nearby pins on MCU or temperature sensor</li>
<li>Reflow/resolder the aforementioned components</li>
</ul>
<h2 id="no-display-or-dots-on-the-display">No display OR dots on the display</h2>
<p>If when you power up your iron you get no display, the first test is to (carefully) attempt to heat the tip.
Press the front button (<code>+/A</code>) on your device and check if the tip heats up.
If the tip does not heat up, it is worth trying to reflash the firmware first in case it is corrupted.</p>
<p>The main failure mode of the OLED display module is usually poor soldering on the OLED display cable to the main PCB.
As this is soldered by hand generally, it's the most prone to failures.</p>
<p>If you have a poor connection or a floating pin, you can end up with a state where the screen works <em>sometimes</em> and then freezes or only works on some power cycles. It might work on very old versions of IronOS but not the newest ones. You could try to reflow the pins for the OLED. On 96x16 screens, carefully peel it back from the adhesive and reflow the solder on the pins. If needed, replacement Oled screens are common and low cost.</p>
<p>As the OLED runs on an I2C bus, there are pull up resistors on the SDA and SCL pins. It is worth checking these as well, while they don't often fail, issues with these can cause <em>weird</em> display issues.</p>
<h2 id="tip-heats-when-not-in-heating-mode">Tip heats when not in heating mode</h2>
<p>⚠️ DISCONNECT YOUR TIP ⚠️</p>
<p>Most likely you have either a blown MOSFET or shorted pin.
Check the MOSFET and also its driver transistor.
The firmware will not enable the tip until you are in soldering mode.</p>
<h2 id="accelerometer-not-detected">Accelerometer not detected</h2>
<p>Your Iron may have a new accelerometer that is not supported yet (happens every year or so) OR there is a soldering issue with the accelerometer (reflow/resolder).</p>
</div>
</div><footer>
<div class="rst-footer-buttons" role="navigation" aria-label="Footer Navigation">
<a href="../GettingStarted/" class="btn btn-neutral float-left" title="Getting Started"><span class="icon icon-circle-arrow-left"></span> Previous</a>
<a href="../HardwareIssues/" class="btn btn-neutral float-right" title="Known Hardware Issues">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">&laquo; Previous</a></span>
<span><a href="../HardwareIssues/" style="color: #fcfcfc">Next &raquo;</a></span>
</span>
</div>
<script>var base_url = '..';</script>
<script src="../js/theme_extra.js" defer></script>
<script src="../js/theme.js" defer></script>
<script src="../search/main.js" defer></script>
<script defer>
window.onload = function () {
SphinxRtdTheme.Navigation.enable(true);
};
</script>
</body>
</html>

BIN
css/fonts/Roboto-Slab-Bold.woff Normal file
View File

Binary file not shown.

BIN
css/fonts/Roboto-Slab-Bold.woff2 Normal file
View File

Binary file not shown.

BIN
css/fonts/Roboto-Slab-Regular.woff Normal file
View File

Binary file not shown.

BIN
css/fonts/Roboto-Slab-Regular.woff2 Normal file
View File

Binary file not shown.

BIN
css/fonts/fontawesome-webfont.eot Normal file
View File

Binary file not shown.

2671
css/fonts/fontawesome-webfont.svg Normal file
View File

File diff suppressed because it is too large Load Diff
Side by Side

After

Width:  |  Height:  |  Size: 434 KiB

BIN
css/fonts/fontawesome-webfont.ttf Normal file
View File

Binary file not shown.

BIN
css/fonts/fontawesome-webfont.woff Normal file
View File

Binary file not shown.

BIN
css/fonts/fontawesome-webfont.woff2 Normal file
View File

Binary file not shown.

BIN
css/fonts/lato-bold-italic.woff Normal file
View File

Binary file not shown.

BIN
css/fonts/lato-bold-italic.woff2 Normal file
View File

Binary file not shown.

BIN
css/fonts/lato-bold.woff Normal file
View File

Binary file not shown.

BIN
css/fonts/lato-bold.woff2 Normal file
View File

Binary file not shown.

BIN
css/fonts/lato-normal-italic.woff Normal file
View File

Binary file not shown.

BIN
css/fonts/lato-normal-italic.woff2 Normal file
View File

Binary file not shown.

BIN
css/fonts/lato-normal.woff Normal file
View File

Binary file not shown.

BIN
css/fonts/lato-normal.woff2 Normal file
View File

Binary file not shown.

13
css/theme.css Normal file
View File

File diff suppressed because one or more lines are too long

191
css/theme_extra.css Normal file
View File

@@ -0,0 +1,191 @@
/*
* Wrap inline code samples otherwise they shoot of the side and
* can't be read at all.
*
* https://github.com/mkdocs/mkdocs/issues/313
* https://github.com/mkdocs/mkdocs/issues/233
* https://github.com/mkdocs/mkdocs/issues/834
*/
.rst-content code {
white-space: pre-wrap;
word-wrap: break-word;
padding: 2px 5px;
}
/**
* Make code blocks display as blocks and give them the appropriate
* font size and padding.
*
* https://github.com/mkdocs/mkdocs/issues/855
* https://github.com/mkdocs/mkdocs/issues/834
* https://github.com/mkdocs/mkdocs/issues/233
*/
.rst-content pre code {
white-space: pre;
word-wrap: normal;
display: block;
padding: 12px;
font-size: 12px;
}
/**
* Fix code colors
*
* https://github.com/mkdocs/mkdocs/issues/2027
*/
.rst-content code {
color: #E74C3C;
}
.rst-content pre code {
color: #000;
background: #f8f8f8;
}
/*
* Fix link colors when the link text is inline code.
*
* https://github.com/mkdocs/mkdocs/issues/718
*/
a code {
color: #2980B9;
}
a:hover code {
color: #3091d1;
}
a:visited code {
color: #9B59B6;
}
/*
* The CSS classes from highlight.js seem to clash with the
* ReadTheDocs theme causing some code to be incorrectly made
* bold and italic.
*
* https://github.com/mkdocs/mkdocs/issues/411
*/
pre .cs, pre .c {
font-weight: inherit;
font-style: inherit;
}
/*
* Fix some issues with the theme and non-highlighted code
* samples. Without and highlighting styles attached the
* formatting is broken.
*
* https://github.com/mkdocs/mkdocs/issues/319
*/
.rst-content .no-highlight {
display: block;
padding: 0.5em;
color: #333;
}
/*
* Additions specific to the search functionality provided by MkDocs
*/
.search-results {
margin-top: 23px;
}
.search-results article {
border-top: 1px solid #E1E4E5;
padding-top: 24px;
}
.search-results article:first-child {
border-top: none;
}
form .search-query {
width: 100%;
border-radius: 50px;
padding: 6px 12px; /* csslint allow: box-model */
border-color: #D1D4D5;
}
/*
* Improve inline code blocks within admonitions.
*
* https://github.com/mkdocs/mkdocs/issues/656
*/
.rst-content .admonition code {
color: #404040;
border: 1px solid #c7c9cb;
border: 1px solid rgba(0, 0, 0, 0.2);
background: #f8fbfd;
background: rgba(255, 255, 255, 0.7);
}
/*
* Account for wide tables which go off the side.
* Override borders to avoid weirdness on narrow tables.
*
* https://github.com/mkdocs/mkdocs/issues/834
* https://github.com/mkdocs/mkdocs/pull/1034
*/
.rst-content .section .docutils {
width: 100%;
overflow: auto;
display: block;
border: none;
}
td, th {
border: 1px solid #e1e4e5 !important; /* csslint allow: important */
border-collapse: collapse;
}
/*
* Without the following amendments, the navigation in the theme will be
* slightly cut off. This is due to the fact that the .wy-nav-side has a
* padding-bottom of 2em, which must not necessarily align with the font-size of
* 90 % on the .rst-current-version container, combined with the padding of 12px
* above and below. These amendments fix this in two steps: First, make sure the
* .rst-current-version container has a fixed height of 40px, achieved using
* line-height, and then applying a padding-bottom of 40px to this container. In
* a second step, the items within that container are re-aligned using flexbox.
*
* https://github.com/mkdocs/mkdocs/issues/2012
*/
.wy-nav-side {
padding-bottom: 40px;
}
/*
* The second step of above amendment: Here we make sure the items are aligned
* correctly within the .rst-current-version container. Using flexbox, we
* achieve it in such a way that it will look like the following:
*
* [No repo_name]
* Next >> // On the first page
* << Previous Next >> // On all subsequent pages
*
* [With repo_name]
* <repo_name> Next >> // On the first page
* <repo_name> << Previous Next >> // On all subsequent pages
*
* https://github.com/mkdocs/mkdocs/issues/2012
*/
.rst-versions .rst-current-version {
padding: 0 12px;
display: flex;
font-size: initial;
justify-content: space-between;
align-items: center;
line-height: 40px;
}
/*
* Please note that this amendment also involves removing certain inline-styles
* from the file ./mkdocs/themes/readthedocs/versions.html.
*
* https://github.com/mkdocs/mkdocs/issues/2012
*/
.rst-current-version span {
flex: 1;
text-align: center;
}

BIN
images/HomeScreen.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 696 B

BIN
img/favicon.ico Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 1.1 KiB

136
index.html Normal file
View File

@@ -0,0 +1,136 @@
<!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/10.5.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>
<script src="js/jquery-3.6.0.min.js" defer></script>
<!--[if lt IE 9]>
<script src="js/html5shiv.min.js"></script>
<![endif]-->
<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.5.0/highlight.min.js"></script>
<script>hljs.initHighlightingOnLoad();</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" 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>
</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">Troubleshooting</span></p>
<ul>
<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>
</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" alt="Docs"></a> &raquo;</li>
<li>Home</li>
<li class="wy-breadcrumbs-aside">
<a href="https://github.com/ralim/IronOS/edit/master/docs/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">
</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 &raquo;</a></span>
</span>
</div>
<script>var base_url = '.';</script>
<script src="js/theme_extra.js" defer></script>
<script src="js/theme.js" defer></script>
<script src="search/main.js" defer></script>
<script defer>
window.onload = function () {
SphinxRtdTheme.Navigation.enable(true);
};
</script>
</body>
</html>
<!--
MkDocs version : 1.3.1
Build Date UTC : 2022-09-21 08:11:07.995116+00:00
-->

4
js/html5shiv.min.js vendored Normal file
View File

@@ -0,0 +1,4 @@
/**
* @preserve HTML5 Shiv 3.7.3 | @afarkas @jdalton @jon_neal @rem | MIT/GPL2 Licensed
*/
!function(a,b){function c(a,b){var c=a.createElement("p"),d=a.getElementsByTagName("head")[0]||a.documentElement;return c.innerHTML="x<style>"+b+"</style>",d.insertBefore(c.lastChild,d.firstChild)}function d(){var a=t.elements;return"string"==typeof a?a.split(" "):a}function e(a,b){var c=t.elements;"string"!=typeof c&&(c=c.join(" ")),"string"!=typeof a&&(a=a.join(" ")),t.elements=c+" "+a,j(b)}function f(a){var b=s[a[q]];return b||(b={},r++,a[q]=r,s[r]=b),b}function g(a,c,d){if(c||(c=b),l)return c.createElement(a);d||(d=f(c));var e;return e=d.cache[a]?d.cache[a].cloneNode():p.test(a)?(d.cache[a]=d.createElem(a)).cloneNode():d.createElem(a),!e.canHaveChildren||o.test(a)||e.tagUrn?e:d.frag.appendChild(e)}function h(a,c){if(a||(a=b),l)return a.createDocumentFragment();c=c||f(a);for(var e=c.frag.cloneNode(),g=0,h=d(),i=h.length;i>g;g++)e.createElement(h[g]);return e}function i(a,b){b.cache||(b.cache={},b.createElem=a.createElement,b.createFrag=a.createDocumentFragment,b.frag=b.createFrag()),a.createElement=function(c){return t.shivMethods?g(c,a,b):b.createElem(c)},a.createDocumentFragment=Function("h,f","return function(){var n=f.cloneNode(),c=n.createElement;h.shivMethods&&("+d().join().replace(/[\w\-:]+/g,function(a){return b.createElem(a),b.frag.createElement(a),'c("'+a+'")'})+");return n}")(t,b.frag)}function j(a){a||(a=b);var d=f(a);return!t.shivCSS||k||d.hasCSS||(d.hasCSS=!!c(a,"article,aside,dialog,figcaption,figure,footer,header,hgroup,main,nav,section{display:block}mark{background:#FF0;color:#000}template{display:none}")),l||i(a,d),a}var k,l,m="3.7.3",n=a.html5||{},o=/^<|^(?:button|map|select|textarea|object|iframe|option|optgroup)$/i,p=/^(?:a|b|code|div|fieldset|h1|h2|h3|h4|h5|h6|i|label|li|ol|p|q|span|strong|style|table|tbody|td|th|tr|ul)$/i,q="_html5shiv",r=0,s={};!function(){try{var a=b.createElement("a");a.innerHTML="<xyz></xyz>",k="hidden"in a,l=1==a.childNodes.length||function(){b.createElement("a");var a=b.createDocumentFragment();return"undefined"==typeof a.cloneNode||"undefined"==typeof a.createDocumentFragment||"undefined"==typeof a.createElement}()}catch(c){k=!0,l=!0}}();var t={elements:n.elements||"abbr article aside audio bdi canvas data datalist details dialog figcaption figure footer header hgroup main mark meter nav output picture progress section summary template time video",version:m,shivCSS:n.shivCSS!==!1,supportsUnknownElements:l,shivMethods:n.shivMethods!==!1,type:"default",shivDocument:j,createElement:g,createDocumentFragment:h,addElements:e};a.html5=t,j(b),"object"==typeof module&&module.exports&&(module.exports=t)}("undefined"!=typeof window?window:this,document);

2
js/jquery-3.6.0.min.js vendored Normal file
View File

File diff suppressed because one or more lines are too long

2
js/theme.js Normal file
View File

File diff suppressed because one or more lines are too long

8
js/theme_extra.js Normal file
View File

@@ -0,0 +1,8 @@
/*
* Assign 'docutils' class to tables so styling and
* JavaScript behavior is applied.
*
* https://github.com/mkdocs/mkdocs/issues/2028
*/
$('div.rst-content table').addClass('docutils');

127
search.html Normal file
View File

@@ -0,0 +1,127 @@
<!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="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/10.5.0/styles/github.min.css" />
<script src="./js/jquery-3.6.0.min.js" defer></script>
<!--[if lt IE 9]>
<script src="./js/html5shiv.min.js"></script>
<![endif]-->
<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.5.0/highlight.min.js"></script>
<script>hljs.initHighlightingOnLoad();</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" 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>
<li class="toctree-l1"><a class="reference internal" href="./GettingStarted/">Getting Started</a>
</li>
</ul>
<p class="caption"><span class="caption-text">Troubleshooting</span></p>
<ul>
<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>
</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" alt="Docs"></a> &raquo;</li>
<li class="wy-breadcrumbs-aside">
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div class="section" itemprop="articleBody">
<h1 id="search">Search Results</h1>
<form id="content_search" action="search.html">
<span role="status" aria-live="polite" class="ui-helper-hidden-accessible"></span>
<input name="q" id="mkdocs-search-query" type="text" class="search_input search-query ui-autocomplete-input" placeholder="Search the Docs" autocomplete="off" autofocus title="Type search term here">
</form>
<div id="mkdocs-search-results" class="search-results" data-no-results-text="No results found">
Searching...
</div>
</div>
</div><footer>
<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>
</div>
<script>var base_url = '.';</script>
<script src="./js/theme_extra.js" defer></script>
<script src="./js/theme.js" defer></script>
<script src="./search/main.js" defer></script>
<script defer>
window.onload = function () {
SphinxRtdTheme.Navigation.enable(true);
};
</script>
</body>
</html>

3475
search/lunr.js Normal file
View File

File diff suppressed because it is too large Load Diff

109
search/main.js Normal file
View File

@@ -0,0 +1,109 @@
function getSearchTermFromLocation() {
var sPageURL = window.location.search.substring(1);
var sURLVariables = sPageURL.split('&');
for (var i = 0; i < sURLVariables.length; i++) {
var sParameterName = sURLVariables[i].split('=');
if (sParameterName[0] == 'q') {
return decodeURIComponent(sParameterName[1].replace(/\+/g, '%20'));
}
}
}
function joinUrl (base, path) {
if (path.substring(0, 1) === "/") {
// path starts with `/`. Thus it is absolute.
return path;
}
if (base.substring(base.length-1) === "/") {
// base ends with `/`
return base + path;
}
return base + "/" + path;
}
function escapeHtml (value) {
return value.replace(/&/g, '&amp;')
.replace(/"/g, '&quot;')
.replace(/</g, '&lt;')
.replace(/>/g, '&gt;');
}
function formatResult (location, title, summary) {
return '<article><h3><a href="' + joinUrl(base_url, location) + '">'+ escapeHtml(title) + '</a></h3><p>' + escapeHtml(summary) +'</p></article>';
}
function displayResults (results) {
var search_results = document.getElementById("mkdocs-search-results");
while (search_results.firstChild) {
search_results.removeChild(search_results.firstChild);
}
if (results.length > 0){
for (var i=0; i < results.length; i++){
var result = results[i];
var html = formatResult(result.location, result.title, result.summary);
search_results.insertAdjacentHTML('beforeend', html);
}
} else {
var noResultsText = search_results.getAttribute('data-no-results-text');
if (!noResultsText) {
noResultsText = "No results found";
}
search_results.insertAdjacentHTML('beforeend', '<p>' + noResultsText + '</p>');
}
}
function doSearch () {
var query = document.getElementById('mkdocs-search-query').value;
if (query.length > min_search_length) {
if (!window.Worker) {
displayResults(search(query));
} else {
searchWorker.postMessage({query: query});
}
} else {
// Clear results for short queries
displayResults([]);
}
}
function initSearch () {
var search_input = document.getElementById('mkdocs-search-query');
if (search_input) {
search_input.addEventListener("keyup", doSearch);
}
var term = getSearchTermFromLocation();
if (term) {
search_input.value = term;
doSearch();
}
}
function onWorkerMessage (e) {
if (e.data.allowSearch) {
initSearch();
} else if (e.data.results) {
var results = e.data.results;
displayResults(results);
} else if (e.data.config) {
min_search_length = e.data.config.min_search_length-1;
}
}
if (!window.Worker) {
console.log('Web Worker API not supported');
// load index in main thread
$.getScript(joinUrl(base_url, "search/worker.js")).done(function () {
console.log('Loaded worker');
init();
window.postMessage = function (msg) {
onWorkerMessage({data: msg});
};
}).fail(function (jqxhr, settings, exception) {
console.error('Could not load worker.js');
});
} else {
// Wrap search in a web worker
var searchWorker = new Worker(joinUrl(base_url, "search/worker.js"));
searchWorker.postMessage({init: true});
searchWorker.onmessage = onWorkerMessage;
}

1
search/search_index.json Normal file
View File

File diff suppressed because one or more lines are too long

133
search/worker.js Normal file
View File

@@ -0,0 +1,133 @@
var base_path = 'function' === typeof importScripts ? '.' : '/search/';
var allowSearch = false;
var index;
var documents = {};
var lang = ['en'];
var data;
function getScript(script, callback) {
console.log('Loading script: ' + script);
$.getScript(base_path + script).done(function () {
callback();
}).fail(function (jqxhr, settings, exception) {
console.log('Error: ' + exception);
});
}
function getScriptsInOrder(scripts, callback) {
if (scripts.length === 0) {
callback();
return;
}
getScript(scripts[0], function() {
getScriptsInOrder(scripts.slice(1), callback);
});
}
function loadScripts(urls, callback) {
if( 'function' === typeof importScripts ) {
importScripts.apply(null, urls);
callback();
} else {
getScriptsInOrder(urls, callback);
}
}
function onJSONLoaded () {
data = JSON.parse(this.responseText);
var scriptsToLoad = ['lunr.js'];
if (data.config && data.config.lang && data.config.lang.length) {
lang = data.config.lang;
}
if (lang.length > 1 || lang[0] !== "en") {
scriptsToLoad.push('lunr.stemmer.support.js');
if (lang.length > 1) {
scriptsToLoad.push('lunr.multi.js');
}
if (lang.includes("ja") || lang.includes("jp")) {
scriptsToLoad.push('tinyseg.js');
}
for (var i=0; i < lang.length; i++) {
if (lang[i] != 'en') {
scriptsToLoad.push(['lunr', lang[i], 'js'].join('.'));
}
}
}
loadScripts(scriptsToLoad, onScriptsLoaded);
}
function onScriptsLoaded () {
console.log('All search scripts loaded, building Lunr index...');
if (data.config && data.config.separator && data.config.separator.length) {
lunr.tokenizer.separator = new RegExp(data.config.separator);
}
if (data.index) {
index = lunr.Index.load(data.index);
data.docs.forEach(function (doc) {
documents[doc.location] = doc;
});
console.log('Lunr pre-built index loaded, search ready');
} else {
index = lunr(function () {
if (lang.length === 1 && lang[0] !== "en" && lunr[lang[0]]) {
this.use(lunr[lang[0]]);
} else if (lang.length > 1) {
this.use(lunr.multiLanguage.apply(null, lang)); // spread operator not supported in all browsers: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/Spread_operator#Browser_compatibility
}
this.field('title');
this.field('text');
this.ref('location');
for (var i=0; i < data.docs.length; i++) {
var doc = data.docs[i];
this.add(doc);
documents[doc.location] = doc;
}
});
console.log('Lunr index built, search ready');
}
allowSearch = true;
postMessage({config: data.config});
postMessage({allowSearch: allowSearch});
}
function init () {
var oReq = new XMLHttpRequest();
oReq.addEventListener("load", onJSONLoaded);
var index_path = base_path + '/search_index.json';
if( 'function' === typeof importScripts ){
index_path = 'search_index.json';
}
oReq.open("GET", index_path);
oReq.send();
}
function search (query) {
if (!allowSearch) {
console.error('Assets for search still loading');
return;
}
var resultDocuments = [];
var results = index.search(query);
for (var i=0; i < results.length; i++){
var result = results[i];
doc = documents[result.ref];
doc.summary = doc.text.substring(0, 200);
resultDocuments.push(doc);
}
return resultDocuments;
}
if( 'function' === typeof importScripts ) {
onmessage = function (e) {
if (e.data.init) {
init();
} else if (e.data.query) {
postMessage({ results: search(e.data.query) });
} else {
console.error("Worker - Unrecognized message: " + e);
}
};
}

83
sitemap.xml Normal file
View File

@@ -0,0 +1,83 @@
<?xml version="1.0" encoding="UTF-8"?>
<urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">
<url>
<loc>https://ralim.github.io/IronOS/</loc>
<lastmod>2022-09-21</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://ralim.github.io/IronOS/DebugMenu/</loc>
<lastmod>2022-09-21</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://ralim.github.io/IronOS/Development/</loc>
<lastmod>2022-09-21</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://ralim.github.io/IronOS/Flashing/</loc>
<lastmod>2022-09-21</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://ralim.github.io/IronOS/GettingStarted/</loc>
<lastmod>2022-09-21</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://ralim.github.io/IronOS/HallSensor/</loc>
<lastmod>2022-09-21</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://ralim.github.io/IronOS/Hardware/</loc>
<lastmod>2022-09-21</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://ralim.github.io/IronOS/HardwareIssues/</loc>
<lastmod>2022-09-21</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://ralim.github.io/IronOS/History/</loc>
<lastmod>2022-09-21</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://ralim.github.io/IronOS/Logo/</loc>
<lastmod>2022-09-21</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://ralim.github.io/IronOS/Menu/</loc>
<lastmod>2022-09-21</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://ralim.github.io/IronOS/Power/</loc>
<lastmod>2022-09-21</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://ralim.github.io/IronOS/Settings/</loc>
<lastmod>2022-09-21</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://ralim.github.io/IronOS/Temperature/</loc>
<lastmod>2022-09-21</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://ralim.github.io/IronOS/Translation/</loc>
<lastmod>2022-09-21</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://ralim.github.io/IronOS/Troubleshooting/</loc>
<lastmod>2022-09-21</lastmod>
<changefreq>daily</changefreq>
</url>
</urlset>

BIN
sitemap.xml.gz Normal file
View File

Binary file not shown.