Deployed 40655a95 with MkDocs version: 1.6.1

404.html

@@ -85,6 +85,8 @@
                   </li>
                   <li class="toctree-l1"><a class="reference internal" href="/IronOS/PowerSources/">Power sources</a>
                   </li>
+                  <li class="toctree-l1"><a class="reference internal" href="/IronOS/PortingToNewDevice/">New Hardware Requirements</a>
+                  </li>
               </ul>
               <ul>
                 <li class="toctree-l1"><a class="reference internal" href="/IronOS/Translation/">Translations</a>

Bluetooth/index.html

@@ -82,7 +82,7 @@
               <ul class="current">
                   <li class="toctree-l1"><a class="reference internal" href="../HallSensor/">Hall Sensor (Pinecil)</a>
                   </li>
-                  <li class="toctree-l1 current"><a class="reference internal current" href="./">Bluetooth (Pinecil V2)</a>
+                  <li class="toctree-l1 current"><a class="reference internal current" href="#">Bluetooth (Pinecil V2)</a>
     <ul class="current">
     <li class="toctree-l2"><a class="reference internal" href="#using-the-ble-interface">Using the BLE Interface</a>
     </li>
@@ -124,6 +124,8 @@
                   </li>
                   <li class="toctree-l1"><a class="reference internal" href="../PowerSources/">Power sources</a>
                   </li>
+                  <li class="toctree-l1"><a class="reference internal" href="../PortingToNewDevice/">New Hardware Requirements</a>
+                  </li>
               </ul>
               <ul>
                 <li class="toctree-l1"><a class="reference internal" href="../Translation/">Translations</a>

DebugMenu/index.html

@@ -67,13 +67,13 @@
                   </li>
                   <li class="toctree-l1"><a class="reference internal" href="../Settings/">Settings</a>
                   </li>
-                  <li class="toctree-l1 current"><a class="reference internal current" href="./">Debug Menu</a>
+                  <li class="toctree-l1 current"><a class="reference internal current" href="#">Debug Menu</a>
     <ul class="current">
     <li class="toctree-l2"><a class="reference internal" href="#menu-items">Menu items</a>
         <ul>
     <li class="toctree-l3"><a class="reference internal" href="#version">Version</a>
     </li>
-    <li class="toctree-l3"><a class="reference internal" href="#date">Date</a>
+    <li class="toctree-l3"><a class="reference internal" href="#timestamp">Timestamp</a>
     </li>
     <li class="toctree-l3"><a class="reference internal" href="#id">ID</a>
     </li>
@@ -134,6 +134,8 @@
                   </li>
                   <li class="toctree-l1"><a class="reference internal" href="../PowerSources/">Power sources</a>
                   </li>
+                  <li class="toctree-l1"><a class="reference internal" href="../PortingToNewDevice/">New Hardware Requirements</a>
+                  </li>
               </ul>
               <ul>
                 <li class="toctree-l1"><a class="reference internal" href="../Translation/">Translations</a>
@@ -207,9 +209,9 @@ This menu is meant to be simple, so it has no fancy GUI animations.</p>
 - <code>v2.22R.5E6F7G8H</code> means firmware with official release version of <code>2.22</code> and it's properly tagged with <code>v2.22</code> git tag &amp; with commit ID <code>5E6F7G8H</code>'</p>
 <hr />
 <p><strong>Additional scroll-able items appear in this order</strong>:</p>
-<h3 id="date">Date</h3>
+<h3 id="timestamp">Timestamp</h3>
 <ul>
-<li>This is a date of firmware compilation and it has the following format: <code>DD-MM-YY</code> (i.e., <code>01-07-23</code> means it has been built in July, 1st, 2023)</li>
+<li>This is a timestamp of firmware compilation and it has the following format: <code>YYYYMMDD HHMMSS</code> (i.e., <code>20230701 213456</code> means it has been built in July, 1st, 2023 at 9:34:56 pm)</li>
 </ul>
 <h3 id="id">ID</h3>
 <ul>

Development/index.html

@@ -92,18 +92,22 @@
                   </li>
                   <li class="toctree-l1"><a class="reference internal" href="../PowerSources/">Power sources</a>
                   </li>
+                  <li class="toctree-l1"><a class="reference internal" href="../PortingToNewDevice/">New Hardware Requirements</a>
+                  </li>
               </ul>
               <ul>
                 <li class="toctree-l1"><a class="reference internal" href="../Translation/">Translations</a>
                 </li>
               </ul>
               <ul class="current">
-                <li class="toctree-l1 current"><a class="reference internal current" href="./">Development</a>
+                <li class="toctree-l1 current"><a class="reference internal current" href="#">Development</a>
     <ul class="current">
     <li class="toctree-l2"><a class="reference internal" href="#stm32cubeide">STM32CubeIDE</a>
     </li>
     <li class="toctree-l2"><a class="reference internal" href="#command-line-tools-and-building-a-release">Command line tools and building a release</a>
         <ul>
+    <li class="toctree-l3"><a class="reference internal" href="#windows-msys2-environment">Windows (MSYS2 environment)</a>
+    </li>
     <li class="toctree-l3"><a class="reference internal" href="#macos">macOS</a>
     </li>
     <li class="toctree-l3"><a class="reference internal" href="#examples">Examples</a>
@@ -163,6 +167,46 @@ You will need to update the build settings for include paths and point to the ne
 <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="windows-msys2-environment">Windows (MSYS2 environment)</h3>
+<ol>
+<li>Download <code>msys2</code> install package from the <a href="https://msys2.org">official website</a> and install it according to the instruction there;</li>
+<li>Install requried packages (here and for the future commands use <strong><code>mingw64.exe</code></strong> terminal):</li>
+</ol>
+<pre><code>$ pacman -S mingw-w64-x86_64-arm-none-eabi-gcc mingw-w64-x86_64-libwinpthread-git python3 python3-pip make unzip git
+</code></pre>
+<ol>
+<li>Download <em>3rd party RISC-V toolchain</em> <code>xpack-riscv-none-elf-gcc-...-win32-x64.zip</code> from <a href="https://github.com/xpack-dev-tools/riscv-none-elf-gcc-xpack/releases">this repository</a>;</li>
+<li>Move downloaded <code>xpack-riscv-none-elf-gcc-...-win32-x64.zip</code> to <code>msys64</code> <em>Windows</em> directory (e.g., <code>C:\msys64\</code>);</li>
+<li>Extract files from <code>xpack-riscv-none-elf-gcc-...-win32-x64.zip</code> and go back to <em>home</em> directory:</li>
+</ol>
+<pre><code>$ cd /
+$ unzip xpack-riscv-none-elf-gcc-...-win32-x64.zip
+$ cd ~
+</code></pre>
+<ol>
+<li>Permanently set <code>PATH</code> environment variable, so all required toolchains could be available for <code>make</code> and for other build scripts:</li>
+</ol>
+<pre><code>$ echo 'export PATH=/xpack-riscv-none-elf-gcc-.../bin:${PATH}' &gt;&gt; ~/.bashrc
+$ source ~/.bashrc
+</code></pre>
+<ol>
+<li>Additionally, <code>OpenOCD</code> and/or <code>ST-Link</code> can be installed as well to help with flashing:</li>
+</ol>
+<pre><code>$ pacman -S mingw-w64-x86_64-openocd
+$ pacman -S mingw-w64-x86_64-stlink
+</code></pre>
+<ol>
+<li>Clone <em>IronOS</em> repo:</li>
+</ol>
+<pre><code>$ git clone --recursive https://github.com/Ralim/IronOS.git
+$ cd IronOS
+</code></pre>
+<ol>
+<li>Follow steps <em>4-8</em> from <a href="#macos">macOS section</a>;</li>
+<li><code>pip</code> can be updated inside <code>venv</code> only:</li>
+</ol>
+<pre><code>$ python3 -m pip install --upgrade pip
+</code></pre>
 <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>
@@ -207,7 +251,7 @@ When running the <code>make</code> command, specify which model of the device an
 <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
+<pre><code>make -j$(sysctl -n hw.logicalcpu) model=Pinecil firmware-multi_compressed_Belorussian+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

Flashing/MHP30/index.html

@@ -50,7 +50,7 @@
               </ul>
               <p class="caption"><span class="caption-text">Flashing the firmware</span></p>
               <ul class="current">
-                  <li class="toctree-l1 current"><a class="reference internal current" href="./">MHP30</a>
+                  <li class="toctree-l1 current"><a class="reference internal current" href="#">MHP30</a>
     <ul class="current">
     <li class="toctree-l2"><a class="reference internal" href="#downloading-source-file">Downloading source file</a>
         <ul>
@@ -102,6 +102,8 @@
                   </li>
                   <li class="toctree-l1"><a class="reference internal" href="../../PowerSources/">Power sources</a>
                   </li>
+                  <li class="toctree-l1"><a class="reference internal" href="../../PortingToNewDevice/">New Hardware Requirements</a>
+                  </li>
               </ul>
               <ul>
                 <li class="toctree-l1"><a class="reference internal" href="../../Translation/">Translations</a>
@@ -159,8 +161,8 @@ 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="mhp30">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=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 MHP30.zip. Inside the zip file (make sure to extract the file before flashing with it) will be a file called <code>MHP30_{Language-Code}.hex</code>.</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/IronOS/wiki/Upgrading-Firmware">wiki page</a>.</p>
+<p>This is completely safe, but if it goes wrong just put the corresponding <code>.hex</code> file from <a href="https://e-design.com.cn/en/NewsDetail/4203645.html">the official website</a> (<a href="https://github.com/Ralim/IronOS-Meta/tree/main/Firmware/Miniware">mirror backup</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 MHP30.zip. Inside the zip file (make sure to extract the file before flashing with it) will be a file called <code>MHP30_{Language-Code}.hex</code>.</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 <a href="#mac">Mac</a>, and can be made to work under <a href="#linux">Linux</a> <em>sometimes</em> (look for details below).</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>

Flashing/Pinecil V1/index.html

@@ -52,7 +52,7 @@
               <ul class="current">
                   <li class="toctree-l1"><a class="reference internal" href="../MHP30/">MHP30</a>
                   </li>
-                  <li class="toctree-l1 current"><a class="reference internal current" href="./">Pinecil V1</a>
+                  <li class="toctree-l1 current"><a class="reference internal current" href="#">Pinecil V1</a>
     <ul class="current">
     <li class="toctree-l2"><a class="reference internal" href="#downloading-source-file">Downloading source file</a>
         <ul>
@@ -102,6 +102,8 @@
                   </li>
                   <li class="toctree-l1"><a class="reference internal" href="../../PowerSources/">Power sources</a>
                   </li>
+                  <li class="toctree-l1"><a class="reference internal" href="../../PortingToNewDevice/">New Hardware Requirements</a>
+                  </li>
               </ul>
               <ul>
                 <li class="toctree-l1"><a class="reference internal" href="../../Translation/">Translations</a>

Flashing/Pinecil V2/index.html

@@ -54,7 +54,7 @@
                   </li>
                   <li class="toctree-l1"><a class="reference internal" href="../Pinecil%20V1/">Pinecil V1</a>
                   </li>
-                  <li class="toctree-l1 current"><a class="reference internal current" href="./">Pinecil V2</a>
+                  <li class="toctree-l1 current"><a class="reference internal current" href="#">Pinecil V2</a>
     <ul class="current">
     <li class="toctree-l2"><a class="reference internal" href="#downloading-source-file">Downloading source file</a>
         <ul>
@@ -102,6 +102,8 @@
                   </li>
                   <li class="toctree-l1"><a class="reference internal" href="../../PowerSources/">Power sources</a>
                   </li>
+                  <li class="toctree-l1"><a class="reference internal" href="../../PortingToNewDevice/">New Hardware Requirements</a>
+                  </li>
               </ul>
               <ul>
                 <li class="toctree-l1"><a class="reference internal" href="../../Translation/">Translations</a>

Flashing/TS100/index.html

@@ -58,7 +58,7 @@
                   </li>
                   <li class="toctree-l1"><a class="reference internal" href="../TS80%28P%29/">TS80(P)</a>
                   </li>
-                  <li class="toctree-l1 current"><a class="reference internal current" href="./">TS100</a>
+                  <li class="toctree-l1 current"><a class="reference internal current" href="#">TS100</a>
     <ul class="current">
     <li class="toctree-l2"><a class="reference internal" href="#downloading-source-file">Downloading source file</a>
         <ul>
@@ -102,6 +102,8 @@
                   </li>
                   <li class="toctree-l1"><a class="reference internal" href="../../PowerSources/">Power sources</a>
                   </li>
+                  <li class="toctree-l1"><a class="reference internal" href="../../PortingToNewDevice/">New Hardware Requirements</a>
+                  </li>
               </ul>
               <ul>
                 <li class="toctree-l1"><a class="reference internal" href="../../Translation/">Translations</a>
@@ -159,8 +161,8 @@ 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="ts100">TS100</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> 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 TS100.zip. Inside the zip file (make sure to extract the file before flashing with it) will be a file called <code>TS100_{Language-Code}.hex</code>.</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/IronOS/wiki/Upgrading-Firmware">wiki page</a>.</p>
+<p>This is completely safe, but if it goes wrong just put the corresponding <code>.hex</code> file from <a href="https://e-design.com.cn/en/NewsDetail/4203645.html">the official website</a> (<a href="https://github.com/Ralim/IronOS-Meta/tree/main/Firmware/Miniware">mirror backup</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 TS100.zip. Inside the zip file (make sure to extract the file before flashing with it) will be a file called <code>TS100_{Language-Code}.hex</code>.</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 <a href="#mac">Mac</a>, and can be made to work under <a href="#linux">Linux</a> <em>sometimes</em> (look for details below).</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>

Flashing/TS80(P)/index.html

@@ -56,7 +56,7 @@
                   </li>
                   <li class="toctree-l1"><a class="reference internal" href="../Pinecil%20V2/">Pinecil V2</a>
                   </li>
-                  <li class="toctree-l1 current"><a class="reference internal current" href="./">TS80(P)</a>
+                  <li class="toctree-l1 current"><a class="reference internal current" href="#">TS80(P)</a>
     <ul class="current">
     <li class="toctree-l2"><a class="reference internal" href="#downloading-source-file">Downloading source file</a>
         <ul>
@@ -102,6 +102,8 @@
                   </li>
                   <li class="toctree-l1"><a class="reference internal" href="../../PowerSources/">Power sources</a>
                   </li>
+                  <li class="toctree-l1"><a class="reference internal" href="../../PortingToNewDevice/">New Hardware Requirements</a>
+                  </li>
               </ul>
               <ul>
                 <li class="toctree-l1"><a class="reference internal" href="../../Translation/">Translations</a>
@@ -159,8 +161,8 @@ 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="ts80-ts80p">TS80 / TS80P</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">TS80</a>/<a href="https://www.minidso.com/forum.php?mod=viewthread&amp;tid=4070&amp;extra=page%3D1">TS80P</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 TS80.zip or TS80P.zip. Inside the zip file (make sure to extract the file before flashing with it) will be a file called <code>TS80_{Language-Code}.hex</code>/<code>TS80P_{Language-Code}.hex</code>.</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/TS80/wiki/Upgrading-Firmware">wiki page</a>.</p>
+<p>This is completely safe, but if it goes wrong just put the corresponding <code>.hex</code> file from <a href="https://e-design.com.cn/en/NewsDetail/4203645.html">the official website</a> (<a href="https://github.com/Ralim/IronOS-Meta/tree/main/Firmware/Miniware">mirror backup</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 TS80.zip or TS80P.zip. Inside the zip file (make sure to extract the file before flashing with it) will be a file called <code>TS80_{Language-Code}.hex</code>/<code>TS80P_{Language-Code}.hex</code>.</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 <a href="#mac">Mac</a>, and can be made to work under <a href="#linux">Linux</a> <em>sometimes</em> (look for details below).</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>
@@ -171,6 +173,7 @@ Then this works the same as a production release (use the correct file).</p>
 <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>If you get a message when copying: "Are you sure you want to move this file without its properties?" then this can cause an issue where the iron thinks that the file has finished copying before it actually has and can cause a .ERR file. Since this dialog prompt is caused by copying a file from NTFS to FAT (the iron's filesystem) in windows, you can fix this by formatting a thumbdrive as FAT32 and then storing the hex file on that before copying the file to the iron. As there will be no NTFS properties on the file when stored on a FAT32 filesystem, there will be no prompt, and the copy will then proceed normally.</p>
 <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 USB port, <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>
 <h2 id="mac">Mac</h2>

GettingStarted/index.html

@@ -45,7 +45,7 @@
                 </li>
               </ul>
               <ul class="current">
-                <li class="toctree-l1 current"><a class="reference internal current" href="./">Getting Started</a>
+                <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>
@@ -116,6 +116,8 @@
                   </li>
                   <li class="toctree-l1"><a class="reference internal" href="../PowerSources/">Power sources</a>
                   </li>
+                  <li class="toctree-l1"><a class="reference internal" href="../PortingToNewDevice/">New Hardware Requirements</a>
+                  </li>
               </ul>
               <ul>
                 <li class="toctree-l1"><a class="reference internal" href="../Translation/">Translations</a>
@@ -163,7 +165,7 @@ If your device did not come with IronOS already installed, or if you need to upd
 <li><a href="https://ralim.github.io/IronOS/Flashing/TS80%28P%29/">TS80 / TS80P</a></li>
 <li><a href="https://ralim.github.io/IronOS/Flashing/TS100">TS100</a></li>
 </ul>
-<p>It is recommended to update to the newest stable release.</p>
+<p>It is recommended to update to the newest stable release when you first receive your device to ensure you are up to date.</p>
 <p>Once your Iron has been flashed, on first power on it <em>may</em> warn you about the system settings being reset.
 <em>Do not panic</em>; this is 100% completely normal. This is here to note to you that they have been reset to handle the internal structure changing.</p>
 <p>If you receive a warning about the accelerometer or USB-PD not being detected, please see <a href="https://ralim.github.io/IronOS/HardwareIssues/">here</a>.</p>

HallSensor/index.html

@@ -80,11 +80,11 @@
               </ul>
               <p class="caption"><span class="caption-text">Hardware</span></p>
               <ul class="current">
-                  <li class="toctree-l1 current"><a class="reference internal current" href="./">Hall Sensor (Pinecil)</a>
+                  <li class="toctree-l1 current"><a class="reference internal current" href="#">Hall Sensor (Pinecil)</a>
     <ul class="current">
     <li class="toctree-l2"><a class="reference internal" href="#sleep-mode-menu">Sleep Mode Menu</a>
         <ul>
-    <li class="toctree-l3"><a class="reference internal" href="#optional-hall-effect-feature-pinecil-only">Optional Hall Effect Feature (Pinecil only):</a>
+    <li class="toctree-l3"><a class="reference internal" href="#optional-hall-effect-feature-pinecil-v1v2-only">Optional Hall Effect Feature (Pinecil (v1/v2) only):</a>
     </li>
         </ul>
     </li>
@@ -100,6 +100,8 @@
                   </li>
                   <li class="toctree-l1"><a class="reference internal" href="../PowerSources/">Power sources</a>
                   </li>
+                  <li class="toctree-l1"><a class="reference internal" href="../PortingToNewDevice/">New Hardware Requirements</a>
+                  </li>
               </ul>
               <ul>
                 <li class="toctree-l1"><a class="reference internal" href="../Translation/">Translations</a>
@@ -140,9 +142,9 @@
               
                 <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>In sleep mode, the iron automatically lowers the temperature to 150°C (default). This default setting was chosen as it is just below the melting point of a wide range of solders. A lower standby temperature helps reduce the oxidation rate and prevent damage to the soldering tips. As a general rule, when not in use, unplug the unit or let it go into sleep mode to extend the life of the replaceable tips. The default sleep temperature can be adjusted to your preference.</p>
+<p>Simply moving the iron or pressing any button will wake it back up into soldering mode. The sensitivity is adjustable. It is recommended to adjust this to suit your environment so that it reliably stays in sleep mode when not in use, but does not go into sleep mode when in use. (This may vary depending on the amount of movement during soldering.)</p>
+<h3 id="optional-hall-effect-feature-pinecil-v1v2-only">Optional Hall Effect Feature (Pinecil (v1/v2) only):</h3>
 <p>Inside the <a href="https://ralim.github.io/IronOS/Settings/#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.</p>
 <ul>

Hardware/index.html

@@ -84,18 +84,8 @@
                   </li>
                   <li class="toctree-l1"><a class="reference internal" href="../Bluetooth/">Bluetooth (Pinecil V2)</a>
                   </li>
-                  <li class="toctree-l1 current"><a class="reference internal current" href="./">Hardware Notes</a>
+                  <li class="toctree-l1 current"><a class="reference internal current" href="#">Hardware Notes</a>
     <ul class="current">
-    <li class="toctree-l2"><a class="reference internal" href="#ts100">TS100</a>
-    </li>
-    <li class="toctree-l2"><a class="reference internal" href="#ts80">TS80</a>
-    </li>
-    <li class="toctree-l2"><a class="reference internal" href="#ts80p">TS80P</a>
-    </li>
-    <li class="toctree-l2"><a class="reference internal" href="#mhp30">MHP30</a>
-    </li>
-    <li class="toctree-l2"><a class="reference internal" href="#pinecil">Pinecil</a>
-    </li>
     </ul>
                   </li>
                   <li class="toctree-l1"><a class="reference internal" href="../Troubleshooting/">Troubleshooting</a>
@@ -104,6 +94,8 @@
                   </li>
                   <li class="toctree-l1"><a class="reference internal" href="../PowerSources/">Power sources</a>
                   </li>
+                  <li class="toctree-l1"><a class="reference internal" href="../PortingToNewDevice/">New Hardware Requirements</a>
+                  </li>
               </ul>
               <ul>
                 <li class="toctree-l1"><a class="reference internal" href="../Translation/">Translations</a>
@@ -143,29 +135,47 @@
             <div class="section" itemprop="articleBody">
               
                 <h2 id="notes-on-the-various-supported-hardware">Notes on the various supported hardware</h2>
+<p>Below are short summaries / notes around the hardware. This is not an in-depth comparison of the features of the units. Please do your own research before purchasing.</p>
+<p>Due to descisions out of our control, Miniware no longer provides source-code/schematics/support for any open source firmware on their devices. This does mean that only (TS100/TS80/TS80P) are "open" to any extent. TS80P is pushing that as it was never open at all but just happens to be very close to the TS80. While this generally shouldn't affect the performance of the device, it does mean that their newer products can be slow to be supported or some issues are harder to resolve.</p>
+<p>Sequre has so far been supportive of the S60 by providing schematics.</p>
+<p>The Pine64 units (Pinecil) are schematics-available (i.e you can download them on the Pine64 Wiki). They are currently the only vendor that has provided financial support of the project. They are also the only vendor that allows contact directly to the engineering teams for hardware issues. This results in generally better support for these devices. It does <strong>not</strong> mean that this firmware is designed around them, but it does help however that they are designed with this firmware in mind as Ralim talks to them. Where possible features are designed to work across all devices but the time for support may vary depending on the hardware and its quirks.</p>
+<h2 id="a-quick-note-on-power-supplies">A quick note on power supplies</h2>
+<p>For all devices listed <strong>except</strong> the MHP30:</p>
+<p>These soldering irons do <em>NOT</em> contain DC/DC converters.
+This means that your power at the tip is a function of the supplied voltage. Just because the iron "supports" running at a wide range of voltages, you should always use a voltage near the upper limit where possible.
+It is highly recommended to use a PD adapter where possible as this allows the iron to <em>know</em> the limitations of your supply.
+The marked irons can only turn the tip on and off in software, this means that they can't control the maximum power drawn from the supply. This is why when using PD the iron may select a lower voltage than your power supplies maximum. This is to prevent your power supply failing from over current. For more information about power management underhood, please, <a href="https://ralim.github.io/IronOS/Power/">see the related documentation section</a>.</p>
+<p>For the MHP30, it contains a buck DC/DC, which means it can utilise most power supplies fairly well, but you should still aim for highest voltage that is reasonable to use.</p>
 <h3 id="ts100">TS100</h3>
-<p>TS100* is a neat soldering iron:</p>
+<p>The TS100 was the first supported soldering iron, and is generally a very capable device.
+Its now generally not reccomended to buy new as other devices have all of its features and more, and can often be the same price or cheaper. It's still fully supported though, nothing will be taken away from it.</p>
 <ul>
 <li>can run from 9-25V DC;</li>
 <li>provides a power range that is determined by the input voltage;</li>
 <li>voltages below 12V don't overly work well for any substantial mass;</li>
-<li>the default firmware can be found <a href="https://www.minidso.com/forum.php?mod=viewthread&amp;tid=892&amp;extra=page%3D1">here</a>.</li>
+<li>the original firmware can be found <a href="https://e-design.com.cn/en/NewsDetail/4203645.html">here</a>(<a href="https://github.com/Ralim/IronOS-Meta/tree/main/Firmware/Miniware">mirror backup</a>).</li>
 </ul>
 <p><img alt="" src="https://brushlesswhoop.com/images/ts100-og.jpg" /></p>
+<h3 id="ts101">TS101</h3>
+<p>The TS101 is the direct replacement of the TS100 with the same tip compatibility.
+It adds a spring pressure tip holding mechanism instead of using a screw so tips are easier to swap on the fly (But are held less securely and can pull out depending on the use case). It adds USB-C PD support and the hardware is compatible with 28V EPR power supplies (under both IronOS and official firmware).</p>
+<p>It unfortunately uses an STM32 clone MCU with quirks, so performance of the screen isn't as good as it could be but its perfectly usable. The bootloader for programming is the biggest weakness of this device and programming can be a pain. Fortunately, IronOS is relatively stable feature wise, so you shouldn't need to update the device often.</p>
+<p>The Miniware bootup logo is burned into their bootloader, so IronOS cant remove this. IronOS can show your own logo when it starts however. There are quirks to loading a logo on this device, so be sure to read the documentation if you are coming from other devices.</p>
 <h3 id="ts80">TS80</h3>
-<p>TS80* is a successor to TS100:</p>
+<p>TS80 is a successor to TS100, it moves to custom smaller tips that perform better at lower wattages. It is optimised for a 9V/2A Quick Charge 3.0 power supply. This is commonly found on older power banks on the USB-A port.
+It does <strong>not</strong> support USB-PD and will not work when powered from a USB-C power supply in most cases.</p>
 <ul>
 <li>uses <em>Quick Charge 3.0</em> / <em>QC3</em> capable charger only (18W max);</li>
 <li>doesn't support PD as it is not designed on the hardware level;</li>
-<li>the default firmware can be found <a href="https://www.minidso.com/forum.php?mod=viewthread&amp;tid=3208&amp;extra=page%3D1">here</a>.</li>
+<li>the original firmware can be found <a href="https://e-design.com.cn/en/NewsDetail/4203645.html">here</a>(<a href="https://github.com/Ralim/IronOS-Meta/tree/main/Firmware/Miniware">mirror backup</a>).</li>
 </ul>
-<p><img alt="" src="https://core-electronics.com.au/media/catalog/product/4/2/4244-01.jpg" /></p>
+<p><img alt="Image of TS80" src="https://core-electronics.com.au/media/catalog/product/4/2/4244-01.jpg" /></p>
 <h3 id="ts80p">TS80P</h3>
-<p>TS80P* is a successor to TS80:</p>
+<p>The TS80P is the direct successor to the TS80 and essentially what the TS80 should have been from its debut. It is nearly identical except it adds USB-PD support for far better compatibility with modern power banks as well as a faster tip removal method.</p>
 <ul>
-<li>supports <em>Quick Charge 3.0</em> (<em>QC3</em>: 9V/3A, 18W max);</li>
+<li>supports <em>Quick Charge 3.0</em> (<em>QC3</em>: 9V/2A,12V/1.5A 18W max);</li>
 <li>supports <em>Power Delivery</em> (<em>PD</em>: 9V/3A &amp; 12V/3A, 30W max)**;</li>
-<li>the default firmware can be found <a href="https://www.minidso.com/forum.php?mod=viewthread&amp;tid=4085&amp;extra=page%3D1">here</a>.</li>
+<li>the original firmware can be found <a href="https://e-design.com.cn/en/NewsDetail/4203645.html">here</a>(<a href="https://github.com/Ralim/IronOS-Meta/tree/main/Firmware/Miniware">mirror backup</a>).</li>
 </ul>
 <p>**: use valid PD device that supports 12V/3A as power source to get full 30W potential, otherwise the iron will fall back to 9V/18W power mode.</p>
 <p><img alt="" src="https://static.eleshop.nl/mage/media/catalog/product/cache/10/image/800x/040ec09b1e35df139433887a97daa66f/s/-/s-l1600_5.jpg" /></p>
@@ -175,16 +185,16 @@
 <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>
+<li>the OLED is the same SSD1306 as everything else, but it’s on a bit-banged bus;</li>
+<li>the original firmware can be found <a href="https://e-design.com.cn/en/NewsDetail/4203645.html">here</a>(<a href="https://github.com/Ralim/IronOS-Meta/tree/main/Firmware/Miniware">mirror backup</a>).</li>
 </ul>
 <h3 id="pinecil">Pinecil</h3>
-<p>Pincecil*:</p>
+<p>Pincecil:</p>
 <ul>
 <li>first model of soldering iron from PINE64;</li>
 <li>the default firmware can be found <a href="https://files.pine64.org/os/Pinecil/Pinecil_firmware_20201115.zip">here</a>.</li>
 </ul>
 <p><img alt="" src="https://pine64.com/wp-content/uploads/2020/11/pinecil-bb2-04.jpg?v=0446c16e2e66" /></p>
-<p>*: Please note: these soldering irons do <em>NOT</em> contain DC/DC converters. This means that your power at the tip is a function of the supplied voltage. Just because the iron "supports" running at a wide range of voltages, you should always use a voltage near the upper limit where possible. It is highly recommended to use a PD adapter where possible as this allows the iron to <em>know</em> the limitations of your supply. The marked irons can only turn the tip on and off in software, this means that they can't control the maximum power drawn from the supply. This is why when using PD the iron may select a lower voltage than your power supplies maximum. This is to prevent your power supply failing from over current. For more information about power management underhood, please, <a href="https://ralim.github.io/IronOS/Power/">see the related documentation section</a>.</p>
               
             </div>
           </div><footer>

HardwareIssues/index.html

@@ -88,7 +88,7 @@
                   </li>
                   <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>
+                  <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>
@@ -102,6 +102,8 @@
                   </li>
                   <li class="toctree-l1"><a class="reference internal" href="../PowerSources/">Power sources</a>
                   </li>
+                  <li class="toctree-l1"><a class="reference internal" href="../PortingToNewDevice/">New Hardware Requirements</a>
+                  </li>
               </ul>
               <ul>
                 <li class="toctree-l1"><a class="reference internal" href="../Translation/">Translations</a>

History/index.html

@@ -92,6 +92,8 @@
                   </li>
                   <li class="toctree-l1"><a class="reference internal" href="../PowerSources/">Power sources</a>
                   </li>
+                  <li class="toctree-l1"><a class="reference internal" href="../PortingToNewDevice/">New Hardware Requirements</a>
+                  </li>
               </ul>
               <ul>
                 <li class="toctree-l1"><a class="reference internal" href="../Translation/">Translations</a>
@@ -102,8 +104,126 @@
                 </li>
               </ul>
               <ul class="current">
-                <li class="toctree-l1 current"><a class="reference internal current" href="./">Changelog</a>
+                <li class="toctree-l1 current"><a class="reference internal current" href="#">Changelog</a>
     <ul class="current">
+    <li class="toctree-l2"><a class="reference internal" href="#v222">v2.22</a>
+        <ul>
+    <li class="toctree-l3"><a class="reference internal" href="#new-hardware-support">New Hardware Support</a>
+        <ul>
+    <li class="toctree-l4"><a class="reference internal" href="#sequre-s60">Sequre S60</a>
+    </li>
+    <li class="toctree-l4"><a class="reference internal" href="#ts101">TS101</a>
+    </li>
+        </ul>
+    </li>
+    <li class="toctree-l3"><a class="reference internal" href="#features-changes">Features &amp; changes</a>
+        <ul>
+    <li class="toctree-l4"><a class="reference internal" href="#pinecilv2-notes">PinecilV2 notes</a>
+    </li>
+    <li class="toctree-l4"><a class="reference internal" href="#profile-heating-mode-for-mhp30">Profile heating mode for MHP30</a>
+    </li>
+    <li class="toctree-l4"><a class="reference internal" href="#note-on-newer-oleds">Note on newer OLED's</a>
+    </li>
+    <li class="toctree-l4"><a class="reference internal" href="#smaller-updates">Smaller updates</a>
+    </li>
+        </ul>
+    </li>
+        </ul>
+    </li>
+    <li class="toctree-l2"><a class="reference internal" href="#v221">v2.21</a>
+        <ul>
+    <li class="toctree-l3"><a class="reference internal" href="#features-changes_1">Features &amp; changes</a>
+    </li>
+    <li class="toctree-l3"><a class="reference internal" href="#pinecilv2-notes_1">PinecilV2 notes</a>
+    </li>
+        </ul>
+    </li>
+    <li class="toctree-l2"><a class="reference internal" href="#v220">v2.20</a>
+    </li>
+    <li class="toctree-l2"><a class="reference internal" href="#v219">v2.19</a>
+    </li>
+    <li class="toctree-l2"><a class="reference internal" href="#v218">v2.18</a>
+    </li>
+    <li class="toctree-l2"><a class="reference internal" href="#v217">v2.17</a>
+        <ul>
+    <li class="toctree-l3"><a class="reference internal" href="#features-changes_2">Features &amp; changes</a>
+    </li>
+    <li class="toctree-l3"><a class="reference internal" href="#notes">Notes</a>
+    </li>
+        </ul>
+    </li>
+    <li class="toctree-l2"><a class="reference internal" href="#v216">v2.16</a>
+    </li>
+    <li class="toctree-l2"><a class="reference internal" href="#v215">v2.15</a>
+        <ul>
+    <li class="toctree-l3"><a class="reference internal" href="#features-changes_3">Features &amp; changes</a>
+    </li>
+    <li class="toctree-l3"><a class="reference internal" href="#mhp30-support">MHP30 support</a>
+    </li>
+        </ul>
+    </li>
+    <li class="toctree-l2"><a class="reference internal" href="#v214">v2.14</a>
+    </li>
+    <li class="toctree-l2"><a class="reference internal" href="#v213">v2.13</a>
+    </li>
+    <li class="toctree-l2"><a class="reference internal" href="#v212">v2.12</a>
+    </li>
+    <li class="toctree-l2"><a class="reference internal" href="#v211">v2.11</a>
+    </li>
+    <li class="toctree-l2"><a class="reference internal" href="#v210">v2.10</a>
+    </li>
+    <li class="toctree-l2"><a class="reference internal" href="#v209">v2.09</a>
+    </li>
+    <li class="toctree-l2"><a class="reference internal" href="#v208">v2.08</a>
+    </li>
+    <li class="toctree-l2"><a class="reference internal" href="#v207">v2.07</a>
+    </li>
+    <li class="toctree-l2"><a class="reference internal" href="#v206">v2.06</a>
+    </li>
+    <li class="toctree-l2"><a class="reference internal" href="#v205">v2.05</a>
+    </li>
+    <li class="toctree-l2"><a class="reference internal" href="#v204">v2.04</a>
+    </li>
+    <li class="toctree-l2"><a class="reference internal" href="#v203">v2.03</a>
+    </li>
+    <li class="toctree-l2"><a class="reference internal" href="#v202">v2.02</a>
+    </li>
+    <li class="toctree-l2"><a class="reference internal" href="#v201">v2.01</a>
+    </li>
+    <li class="toctree-l2"><a class="reference internal" href="#v200">v2.00</a>
+    </li>
+    <li class="toctree-l2"><a class="reference internal" href="#v117">v1.17</a>
+    </li>
+    <li class="toctree-l2"><a class="reference internal" href="#v116">v1.16</a>
+    </li>
+    <li class="toctree-l2"><a class="reference internal" href="#v115">v1.15</a>
+    </li>
+    <li class="toctree-l2"><a class="reference internal" href="#v114">v1.14</a>
+    </li>
+    <li class="toctree-l2"><a class="reference internal" href="#v113">v1.13</a>
+    </li>
+    <li class="toctree-l2"><a class="reference internal" href="#v112">v1.12</a>
+    </li>
+    <li class="toctree-l2"><a class="reference internal" href="#v111">v1.11</a>
+    </li>
+    <li class="toctree-l2"><a class="reference internal" href="#v110">v1.10</a>
+    </li>
+    <li class="toctree-l2"><a class="reference internal" href="#v109">v1.09</a>
+    </li>
+    <li class="toctree-l2"><a class="reference internal" href="#v108">v1.08</a>
+    </li>
+    <li class="toctree-l2"><a class="reference internal" href="#v107">v1.07</a>
+    </li>
+    <li class="toctree-l2"><a class="reference internal" href="#v106">v1.06</a>
+    </li>
+    <li class="toctree-l2"><a class="reference internal" href="#v105">v1.05</a>
+    </li>
+    <li class="toctree-l2"><a class="reference internal" href="#v104">v1.04</a>
+    </li>
+    <li class="toctree-l2"><a class="reference internal" href="#v103">v1.03</a>
+    </li>
+    <li class="toctree-l2"><a class="reference internal" href="#v102">v1.02</a>
+    </li>
     </ul>
                 </li>
               </ul>
@@ -132,8 +252,39 @@
             <div class="section" itemprop="articleBody">
               
                 <h1 id="version-changes">Version Changes</h1>
-<h1 id="v221">V2.21</h1>
+<h2 id="v222">v2.22</h2>
+<h3 id="new-hardware-support">New Hardware Support</h3>
+<h4 id="sequre-s60">Sequre S60</h4>
+<p>The <a href="https://sequremall.com/products/sequre-s60-nano-electric-soldering-iron-support-pd-qc-power-supply-compatible-with-c210-soldering-iron-tips-precision-electronic-mobile-phone-repair-tool-anti-static-soldering-pen?variant=42361945096380">Sequre S60</a> uses JBC tips, which makes it quite useful for the smaller tip types and extra options available.</p>
+<h4 id="ts101">TS101</h4>
+<p>The TS101 is the evolution of the TS100, picking up USB-PD.
+It has otherwise similar tip support to the TS100/Pinecil/PinecilV2.</p>
+<p>Absolutely massive kudos goes to @VioletEternity for her work on the reverse engineering of this. If you at all are helped by IronOS running on this device more credit goes to her than to I. Also big thanks to @whitequark for organising + supporting + magic.</p>
 <h3 id="features-changes">Features &amp; changes</h3>
+<h4 id="pinecilv2-notes">PinecilV2 notes</h4>
+<ol>
+<li>BLE is fixed on all devices.</li>
+<li>Bootup Logo support is finalised and working.</li>
+<li>Improved the tip control, improving accuracy and remove most oscillations.</li>
+</ol>
+<h4 id="profile-heating-mode-for-mhp30">Profile heating mode for MHP30</h4>
+<p>This lets you define a heat profile and run this profile akin to a proper reflow device.
+This can be used on the MHP30 by long-holding the A button (aka start button).
+Profile can be edited in settings.</p>
+<h4 id="note-on-newer-oleds">Note on newer OLED's</h4>
+<p>To prevent this release being held up forever, the TS101 and S60 are being released with a limitation on the OLED screen.
+The current code will only draw to the upper left corner of the screen.
+Assets have been made for rendering this at full size, but the code is not complete yet.</p>
+<h4 id="smaller-updates">Smaller updates</h4>
+<ul>
+<li>Filtering added to MHP tilt-exit to make it less sensitive</li>
+<li>Warning if a tip is detected to be shorted (TS101 + PinecilV2)</li>
+<li>Translation updates ❤️</li>
+<li>Documentation updates</li>
+<li>Lots of tooling and code cleanups</li>
+</ul>
+<h2 id="v221">v2.21</h2>
+<h3 id="features-changes_1">Features &amp; changes</h3>
 <ul>
 <li>Bluetooth Low Energy support for PinecilV2</li>
 <li>Large cleanup of translation files; and refactor of how we handle fonts for translations</li>
@@ -141,11 +292,11 @@
 <li>Option for using adjustable profiles on USB-PD or not</li>
 <li>Cleanups and improvements to the generated <a href="https://ralim.github.io/IronOS">documents website</a></li>
 </ul>
-<h3 id="pinecilv2-notes">PinecilV2 notes</h3>
+<h3 id="pinecilv2-notes_1">PinecilV2 notes</h3>
 <p>For Pinecil V2 users blisp is currently my recommended CLI tool for updating the device. It is built for all main OS's automatically. This does not apply to V1 devices. If your iron came with a blue grip, its a V1 and update the same as always. If your device came with a green silicone grip its a V2 device.</p>
 <p>Alternatively you can use Spagett1's PineFlash tool that should provide a GUI interface for PinecilV1 &amp; PinecilV2.</p>
 <p>For a small number of V2 Pinecil devices there appears to be an interference issue between the Bluetooth Low Energy and some devices; more information here. If this occurs to you, please let us know in the issue and rollback to 2.20 for now.</p>
-<h1 id="v220">V2.20</h1>
+<h2 id="v220">v2.20</h2>
 <ul>
 <li>First "full" release for PinecilV2</li>
 <li>Loots of documentation updates</li>
@@ -153,7 +304,7 @@
 <li>A fair collection of bugfixes for PinecilV2</li>
 <li>Cold Junction Calibration was reworked and now occurs <em>at next boot</em> to make it easier to perform when the device is cold</li>
 </ul>
-<h1 id="v219">V2.19</h1>
+<h2 id="v219">v2.19</h2>
 <ul>
 <li>Bug-fix Infinite Boot Logo</li>
 <li>Shutdown settings for MHP30</li>
@@ -163,7 +314,7 @@
 <li>Updated translations</li>
 <li>Improved documents, added features table</li>
 </ul>
-<h1 id="v218">V2.18</h1>
+<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>
@@ -172,8 +323,8 @@
 <li>Updated translations</li>
 <li>Better Instructions/documents</li>
 </ul>
-<h1 id="v217">V2.17</h1>
-<h3 id="features-changes_1">Features &amp; changes</h3>
+<h2 id="v217">v2.17</h2>
+<h3 id="features-changes_2">Features &amp; 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>
@@ -198,7 +349,7 @@
 <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>
-<h1 id="v216">V2.16</h1>
+<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>
@@ -217,8 +368,8 @@
 <li>Every language had translation updates I believe</li>
 <li>Romanian language added</li>
 </ul>
-<h1 id="v215">V2.15</h1>
-<h3 id="features-changes_2">Features &amp; changes</h3>
+<h2 id="v215">v2.15</h2>
+<h3 id="features-changes_3">Features &amp; changes</h3>
 <ul>
 <li>MHP30 support</li>
 <li>Multi-lingual firmware combinations now exist for Pinecil</li>
@@ -237,7 +388,7 @@ This is not a <em>final</em> version I'm sure, but this is a working, usable ver
 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>
-<h1 id="v214">V2.14</h1>
+<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
@@ -257,7 +408,7 @@ Programs the same as any one Miniware unit using drag and drop.
 <li>Cleanup the folder name of the source code #800</li>
 <li>clang-format spec setup #801</li>
 </ul>
-<h1 id="v213">V2.13</h1>
+<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>
@@ -274,7 +425,7 @@ Programs the same as any one Miniware unit using drag and drop.
 <li>Fixed bug with accelerometer model on Pinecil</li>
 <li>Rework of all of the temperature curves for better accuracy</li>
 </ul>
-<h1 id="v212">V2.12</h1>
+<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>
@@ -282,36 +433,36 @@ Programs the same as any one Miniware unit using drag and drop.
 <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>
-<h1 id="v211">V2.11</h1>
+<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>
-<h1 id="v210">V2.10</h1>
+<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>
-<h1 id="v209">V2.09</h1>
+<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>
-<h1 id="v208">V2.08</h1>
+<h2 id="v208">v2.08</h2>
 <ul>
 <li>Fixes auto start in sleep mode</li>
 <li>Power limiters</li>
 </ul>
-<h1 id="v207">V2.07</h1>
+<h2 id="v207">v2.07</h2>
 <ul>
 <li>QC fixes</li>
 <li>Cosmetic fixes for leading 0's</li>
 </ul>
-<h1 id="v206">V2.06</h1>
+<h2 id="v206">v2.06</h2>
 <ul>
 <li>Warning on settings reset</li>
 <li>Temp temp re-write</li>
@@ -319,27 +470,27 @@ Programs the same as any one Miniware unit using drag and drop.
 <li>Hide some leading 0's</li>
 <li>Menu timeouts</li>
 </ul>
-<h1 id="v205">V2.05</h1>
+<h2 id="v205">v2.05</h2>
 <ul>
 <li>Language updates</li>
 </ul>
-<h1 id="v204">V2.04</h1>
+<h2 id="v204">v2.04</h2>
 <ul>
 <li>GUI updates</li>
 </ul>
-<h1 id="v203">V2.03</h1>
+<h2 id="v203">v2.03</h2>
 <ul>
 <li>Support for new accelerometers</li>
 </ul>
-<h1 id="v202">V2.02</h1>
+<h2 id="v202">v2.02</h2>
 <ul>
 <li>Adds small font</li>
 </ul>
-<h1 id="v201">V2.01</h1>
+<h2 id="v201">v2.01</h2>
 <ul>
 <li>Newer settings menu</li>
 </ul>
-<h1 id="v200">V2.00</h1>
+<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>
@@ -349,80 +500,80 @@ Programs the same as any one Miniware unit using drag and drop.
 <li>Added detailed screen views</li>
 <li>Added smaller font for said screen views</li>
 </ul>
-<h1 id="v117">V1.17</h1>
+<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>
-<h1 id="v116">V1.16</h1>
+<h2 id="v116">v1.16</h2>
 <ul>
 <li>Added automatic rotation support</li>
 <li>Added power display graph</li>
 </ul>
-<h1 id="v115">V1.15</h1>
+<h2 id="v115">v1.15</h2>
 <ul>
 <li>Added support for a custom bootup logo to be programmed via the DFU bootloader</li>
 </ul>
-<h1 id="v114">V1.14</h1>
+<h2 id="v114">v1.14</h2>
 <ul>
 <li>Changed input voltage cutoff to be based on cell count rather than voltage</li>
 </ul>
-<h1 id="v113">V1.13</h1>
+<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>
-<h1 id="v112">V1.12</h1>
+<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>
-<h1 id="v111">V1.11</h1>
+<h2 id="v111">v1.11</h2>
 <ul>
 <li>Boost mode</li>
 <li>Change sensitivity options to be 1*8</li>
 </ul>
-<h1 id="v110">V1.10</h1>
+<h2 id="v110">v1.10</h2>
 <ul>
 <li>Adds help text to settings</li>
 <li>Improves settings for the display update rate</li>
 </ul>
-<h1 id="v109">V1.09</h1>
+<h2 id="v109">v1.09</h2>
 <ul>
 <li>Adds display modes, for slowing down or simplifying the display</li>
 </ul>
-<h1 id="v108">V1.08</h1>
+<h2 id="v108">v1.08</h2>
 <ul>
 <li>Fix settings menu not showing flip display</li>
 </ul>
-<h1 id="v107">V1.07</h1>
+<h2 id="v107">v1.07</h2>
 <ul>
 <li>Adds shutdown time to automatically shutdown the iron after inactivity</li>
 </ul>
-<h1 id="v106">V1.06</h1>
+<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>
-<h1 id="v105">V1.05</h1>
+<h2 id="v105">v1.05</h2>
 <ul>
 <li>Adds ability to calibrate the input voltage measurement</li>
 </ul>
-<h1 id="v104">V1.04</h1>
+<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>
-<h1 id="v103">V1.03</h1>
+<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>
-<h1 id="v102">V1.02</h1>
+<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>

Logo/index.html

@@ -75,9 +75,13 @@
                   </li>
               </ul>
               <ul class="current">
-                <li class="toctree-l1 current"><a class="reference internal current" href="./">Startup Logo</a>
+                <li class="toctree-l1 current"><a class="reference internal current" href="#">Startup Logo</a>
     <ul class="current">
     <li class="toctree-l2"><a class="reference internal" href="#generating-the-logo-files">Generating the Logo files</a>
+        <ul>
+    <li class="toctree-l3"><a class="reference internal" href="#ts101-quirks">TS101 Quirks</a>
+    </li>
+        </ul>
     </li>
     <li class="toctree-l2"><a class="reference internal" href="#flashing-the-logo">Flashing the Logo</a>
         <ul>
@@ -108,6 +112,8 @@
                   </li>
                   <li class="toctree-l1"><a class="reference internal" href="../PowerSources/">Power sources</a>
                   </li>
+                  <li class="toctree-l1"><a class="reference internal" href="../PortingToNewDevice/">New Hardware Requirements</a>
+                  </li>
               </ul>
               <ul>
                 <li class="toctree-l1"><a class="reference internal" href="../Translation/">Translations</a>
@@ -171,15 +177,29 @@ The model should be replaced by one of the following options:</p>
 <li><code>miniware</code> for older Miniware Irons -&gt; TS100, TS80, TS80P</li>
 <li><code>pinecilv1</code> for the Pinecil V1</li>
 <li><code>pinecilv2</code> for the Pinecil V2</li>
-<li><code>ts101</code> for the Miniware TS101 [^1]</li>
-<li><code>s60</code> for the Squire S60 [^1]</li>
+<li><code>ts101</code> for the Miniware TS101 [^1] [^2]</li>
+<li><code>s60</code> for the Sequre S60 [^1]</li>
 <li><code>mhp30</code> for the Miniware MHP30</li>
 </ul>
 <p>Different models are used for different flash locations for the image storage.
 This means that files are <strong>not</strong> interchangeable between devices. If you are flashing multiple devices you will need to create a different file for different models.</p>
 <p>After processing its expected to have a <code>.hex</code> and <code>.dfu</code> file created to be used. Which one to use will depend on your device.</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>
-<p>[^1] Note that these devices have larger resolution screens that the logo system supports right now. Fixes are coming for this soon, roughly scheduled for 2.23.</p>
+<p>[^1] Note that these devices have larger resolution screens that the logo system supports right now. Fixes are coming for this soon, roughly scheduled for 2.23.
+[^2] The TS101 requires extra steps, see below.</p>
+<h3 id="ts101-quirks">TS101 Quirks</h3>
+<p>When Miniware designed the TS101 they cut cost by using an STM32 clone with some odd quirks. They also re-wrote their USB bootloader, which has introduced new bugs for us to deal with.
+Their bootloader appears to have kept the existing limit of not being able to flash small hex files, but they no longer fall for the older "just repeat the content" trick and instead reject the file.
+Additionally, while the MCU in use has 128K of flash, their bootloader (at least for me) fails to write to anything above 99K. It <em>looks</em> like a watchdog reset or hard crash. Unsure.</p>
+<p>This has flow on effects, where the settings can still be located in the upper ~28K of flash, but it cant be used for anything we flash over USB.
+Of that 100K we can use, they waste 32K of it for their bootloader (Old bootloaders were 16K).
+This means the main "app" of IronOS is limited to around 67K (100K-32K for bootloader, -1K for logo).</p>
+<p>For this device the Logo is not located at the end of flash but instead at the last writable page (99K).</p>
+<p>Additionally, as we need to do a large write, to avoid having to waste more flash space; the logo is merged with the normal firmware. This means that the firmware and logo are flashed together once.
+Future updates can be done without merging as it will leave the logo data there as normal firmware doesnt touch that area of flash.</p>
+<p>To do this, download the latest version of IronOS and merge it with the logo using the <code>--merge</code> command line argument.</p>
+<p>To create the logo file for a TS101 the full command looks like <code>python3 img2logo.py &lt;image file path&gt; &lt;output folder path&gt; -m ts101 --merge &lt;Path to main firmware&gt;</code>.</p>
+<p>For this reason, there are no TS101 logo's generated by the IronOS-Meta repo.</p>
 <h2 id="flashing-the-logo">Flashing the Logo</h2>
 <h3 id="upload-via-virtual-disk-ts100ts101ts80ts80ps60mhp30">Upload via virtual disk (TS100,TS101,TS80,TS80P,S60,MHP30)</h3>
 <p>If you normally update your firmware by having your device show up as a flash drive this is the method for you.

Menu/index.html

@@ -63,7 +63,7 @@
               </ul>
               <p class="caption"><span class="caption-text">Operation</span></p>
               <ul class="current">
-                  <li class="toctree-l1 current"><a class="reference internal current" href="./">Main Menu</a>
+                  <li class="toctree-l1 current"><a class="reference internal current" href="#">Main Menu</a>
     <ul class="current">
     <li class="toctree-l2"><a class="reference internal" href="#soldering-mode">Soldering mode</a>
     </li>
@@ -108,6 +108,8 @@
                   </li>
                   <li class="toctree-l1"><a class="reference internal" href="../PowerSources/">Power sources</a>
                   </li>
+                  <li class="toctree-l1"><a class="reference internal" href="../PortingToNewDevice/">New Hardware Requirements</a>
+                  </li>
               </ul>
               <ul>
                 <li class="toctree-l1"><a class="reference internal" href="../Translation/">Translations</a>

PortingToNewDevice/index.html

@@ -0,0 +1,265 @@
+<!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/PortingToNewDevice/" />
+      <link rel="shortcut icon" href="../img/favicon.ico" />
+    <title>New Hardware Requirements - IronOS</title>
+    <link rel="stylesheet" href="../css/theme.css" />
+    <link rel="stylesheet" href="../css/theme_extra.css" />
+        <link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.8.0/styles/github.min.css" />
+    
+      <script>
+        // Current page data
+        var mkdocs_page_name = "New Hardware Requirements";
+        var mkdocs_page_input_path = "PortingToNewDevice.md";
+        var mkdocs_page_url = "/IronOS/PortingToNewDevice/";
+      </script>
+    
+    <!--[if lt IE 9]>
+      <script src="../js/html5shiv.min.js"></script>
+    <![endif]-->
+      <script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.8.0/highlight.min.js"></script>
+        <script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.8.0/languages/yaml.min.js"></script>
+      <script>hljs.highlightAll();</script> 
+</head>
+
+<body class="wy-body-for-nav" role="document">
+
+  <div class="wy-grid-for-nav">
+    <nav data-toggle="wy-nav-shift" class="wy-nav-side stickynav">
+    <div class="wy-side-scroll">
+      <div class="wy-side-nav-search">
+          <a href=".." class="icon icon-home"> IronOS
+        </a><div role="search">
+  <form id ="rtd-search-form" class="wy-form" action="../search.html" method="get">
+      <input type="text" name="q" placeholder="Search docs" aria-label="Search docs" title="Type search term here" />
+  </form>
+</div>
+      </div>
+
+      <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
+              <ul>
+                <li class="toctree-l1"><a class="reference internal" href="..">Home</a>
+                </li>
+              </ul>
+              <ul>
+                <li class="toctree-l1"><a class="reference internal" href="../GettingStarted/">Getting Started</a>
+                </li>
+              </ul>
+              <p class="caption"><span class="caption-text">Flashing the firmware</span></p>
+              <ul>
+                  <li class="toctree-l1"><a class="reference internal" href="../Flashing/MHP30/">MHP30</a>
+                  </li>
+                  <li class="toctree-l1"><a class="reference internal" href="../Flashing/Pinecil%20V1/">Pinecil V1</a>
+                  </li>
+                  <li class="toctree-l1"><a class="reference internal" href="../Flashing/Pinecil%20V2/">Pinecil V2</a>
+                  </li>
+                  <li class="toctree-l1"><a class="reference internal" href="../Flashing/TS80%28P%29/">TS80(P)</a>
+                  </li>
+                  <li class="toctree-l1"><a class="reference internal" href="../Flashing/TS100/">TS100</a>
+                  </li>
+              </ul>
+              <p class="caption"><span class="caption-text">Operation</span></p>
+              <ul>
+                  <li class="toctree-l1"><a class="reference internal" href="../Menu/">Main Menu</a>
+                  </li>
+                  <li class="toctree-l1"><a class="reference internal" href="../Settings/">Settings</a>
+                  </li>
+                  <li class="toctree-l1"><a class="reference internal" href="../DebugMenu/">Debug Menu</a>
+                  </li>
+                  <li class="toctree-l1"><a class="reference internal" href="../Power/">Power</a>
+                  </li>
+                  <li class="toctree-l1"><a class="reference internal" href="../Temperature/">Temperature</a>
+                  </li>
+              </ul>
+              <ul>
+                <li class="toctree-l1"><a class="reference internal" href="../Logo/">Startup Logo</a>
+                </li>
+              </ul>
+              <p class="caption"><span class="caption-text">Hardware</span></p>
+              <ul class="current">
+                  <li class="toctree-l1"><a class="reference internal" href="../HallSensor/">Hall Sensor (Pinecil)</a>
+                  </li>
+                  <li class="toctree-l1"><a class="reference internal" href="../Bluetooth/">Bluetooth (Pinecil V2)</a>
+                  </li>
+                  <li class="toctree-l1"><a class="reference internal" href="../Hardware/">Hardware Notes</a>
+                  </li>
+                  <li class="toctree-l1"><a class="reference internal" href="../Troubleshooting/">Troubleshooting</a>
+                  </li>
+                  <li class="toctree-l1"><a class="reference internal" href="../HardwareIssues/">Known Hardware Issues</a>
+                  </li>
+                  <li class="toctree-l1"><a class="reference internal" href="../PowerSources/">Power sources</a>
+                  </li>
+                  <li class="toctree-l1 current"><a class="reference internal current" href="#">New Hardware Requirements</a>
+    <ul class="current">
+    <li class="toctree-l2"><a class="reference internal" href="#hard-requirements">Hard requirements</a>
+    </li>
+    <li class="toctree-l2"><a class="reference internal" href="#soft-requirements">Soft requirements</a>
+    </li>
+    <li class="toctree-l2"><a class="reference internal" href="#planned-features">Planned features</a>
+    </li>
+    <li class="toctree-l2"><a class="reference internal" href="#notes">Notes</a>
+        <ul>
+    <li class="toctree-l3"><a class="reference internal" href="#note-a-flash-storage-space">Note A - Flash storage space</a>
+    </li>
+    <li class="toctree-l3"><a class="reference internal" href="#note-b-pinmap-for-the-microcontroller">Note B - Pinmap for the microcontroller</a>
+    </li>
+        </ul>
+    </li>
+    <li class="toctree-l2"><a class="reference internal" href="#example-request-for-adding-a-new-device">Example request for adding a new device</a>
+        <ul>
+    <li class="toctree-l3"><a class="reference internal" href="#hardware-details">Hardware details</a>
+    </li>
+        </ul>
+    </li>
+    </ul>
+                  </li>
+              </ul>
+              <ul>
+                <li class="toctree-l1"><a class="reference internal" href="../Translation/">Translations</a>
+                </li>
+              </ul>
+              <ul>
+                <li class="toctree-l1"><a class="reference internal" href="../Development/">Development</a>
+                </li>
+              </ul>
+              <ul>
+                <li class="toctree-l1"><a class="reference internal" href="../History/">Changelog</a>
+                </li>
+              </ul>
+      </div>
+    </div>
+    </nav>
+
+    <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
+      <nav class="wy-nav-top" role="navigation" aria-label="Mobile navigation menu">
+          <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
+          <a href="..">IronOS</a>
+        
+      </nav>
+      <div class="wy-nav-content">
+        <div class="rst-content"><div role="navigation" aria-label="breadcrumbs navigation">
+  <ul class="wy-breadcrumbs">
+    <li><a href=".." class="icon icon-home" aria-label="Docs"></a></li>
+          <li class="breadcrumb-item">Hardware</li>
+      <li class="breadcrumb-item active">New Hardware Requirements</li>
+    <li class="wy-breadcrumbs-aside">
+          <a href="https://github.com/ralim/IronOS/edit/dev/Documentation/PortingToNewDevice.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="requesting-support-for-a-new-device">Requesting support for a new device</h1>
+<p>IronOS is largely designed to run on devices that are using <em>fairly</em> modern microcontrollers at their core. Generally this means an ARM Cortex or RISC-V processor.
+At this point in time it is not planned to support 8051 or similar cored devices. This is largely due to the reliance on FreeRTOS at the moment.</p>
+<p>When requesting a port for a new device, please try and find out if the hardware meets the below requirements.</p>
+<p>The feature list's below are organised into three categories; Hard requirements that as of current must be met, soft requirements that <em>should</em> be met for full featured performance and the final category of planned <em>but not yet implemented</em> features; which can be implemented but can result in delays as these are not yet implemented.</p>
+<p>Aside from the below, keep in mind IronOS is really designed for soldering irons. This has expanded out into hot-plates as they are exceptionally similar devices.</p>
+<h2 id="hard-requirements">Hard requirements</h2>
+<ol>
+<li>Supported processor (Arm Cortex or RISC-V). (Though generally anything that has an existing FreeRTOS port is possible).</li>
+<li>64K of flash or larger (See note A)</li>
+<li>16K of ram or larger</li>
+<li>Device has one or more heating elements that can be controlled by a main temperature sensor</li>
+<li>If the main temperature sensor is a thermocouple, a reference temperature sensor for cold junction compensation must exist and be close to the sensor contacts</li>
+<li>Means of the user updating the device without opening</li>
+<li>Known pinmap for the microcontroller. (see note B)</li>
+</ol>
+<h2 id="soft-requirements">Soft requirements</h2>
+<ol>
+<li>USB-PD is strongly preferred over Quick Charge; Quick Charge only devices are considered legacy and will likely not be prioritiesd.</li>
+<li>Open source or at the least schematics available is <strong>strongly</strong> preferred and will prioritise the device.</li>
+<li>Likewise friendly vendors will help dramatically with support, due to both questions and also appearances to help the community.</li>
+<li>Hardware PWM wired up to the tip control is nice to have but not essential</li>
+<li>Very strong preference against devices that use the endless sea of STM32 clones.</li>
+</ol>
+<h2 id="planned-features">Planned features</h2>
+<p>These features are planned for eventual support, but will likely not be done until devices need them.</p>
+<ul>
+<li>Colour screens</li>
+<li>More than 2 buttons for input, or encoder inputs</li>
+<li>WiFi/Zigbee/ any other networking</li>
+</ul>
+<h2 id="notes">Notes</h2>
+<h3 id="note-a-flash-storage-space">Note A - Flash storage space</h3>
+<p>64KB is generally the minimum recommended size for the hardware to have.
+Larger is <em>definitely</em> preferred as it enables more features or the multi-pack language firmwares.
+Keep in mind that on some devices we loose space to a USB DFU bootloader (Older STM32F1's) so the firmware <em>can</em> work with less. But it can come at the cost of features.
+128KB or larger is <strong>great</strong>.
+For devices that have BLE or WiFi or other features, often code requirements are significantly larger. These are considered non essential features so will be ignored if we run into size issues.</p>
+<h3 id="note-b-pinmap-for-the-microcontroller">Note B - Pinmap for the microcontroller</h3>
+<p>In order to be able to write the interfacing code to communicate with the hardware, we need to know what pins on the microcontroller go to what hardware.
+It is also loosely required to have an understanding of the rest of the device, we do not need details on a lot of the boring aspects,but if for example a USB-PD interface IC is used we would want to know which one.</p>
+<h2 id="example-request-for-adding-a-new-device">Example request for adding a new device</h2>
+<p>Device Name:
+Device Type:
+Approximate Price:
+Example purchase locations:</p>
+<h3 id="hardware-details">Hardware details</h3>
+<p>Microcontroller version: <code>STM32F103C8Tx</code>
+Flash size (If external to the MCU):<code>N/A</code>
+Microcontroller Pinout: <!-- Either link to manufacturer information, a forum documenting this or a discussion where the pinout has been roughly figured out already-->
+Device type: <!-- Soldering Iron/Hot Plate/ Reflow oven etc-->
+Device meets hard requirements list []
+Device meets soft requirements list []</p>
+<p>Device features USB-PD []
+Device features USB-QC []
+Device features DC Input []
+Device features BLE []</p>
+              
+            </div>
+          </div><footer>
+    <div class="rst-footer-buttons" role="navigation" aria-label="Footer Navigation">
+        <a href="../PowerSources/" class="btn btn-neutral float-left" title="Power sources"><span class="icon icon-circle-arrow-left"></span> Previous</a>
+        <a href="../Translation/" class="btn btn-neutral float-right" title="Translations">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="../PowerSources/" style="color: #fcfcfc">&laquo; Previous</a></span>
+    
+    
+      <span><a href="../Translation/" style="color: #fcfcfc">Next &raquo;</a></span>
+    
+  </span>
+</div>
+    <script src="../js/jquery-3.6.0.min.js"></script>
+    <script>var base_url = "..";</script>
+    <script src="../js/theme_extra.js"></script>
+    <script src="../js/theme.js"></script>
+      <script src="../search/main.js"></script>
+    <script>
+        jQuery(function () {
+            SphinxRtdTheme.Navigation.enable(true);
+        });
+    </script>
+
+</body>
+</html>

Power/index.html

@@ -69,7 +69,7 @@
                   </li>
                   <li class="toctree-l1"><a class="reference internal" href="../DebugMenu/">Debug Menu</a>
                   </li>
-                  <li class="toctree-l1 current"><a class="reference internal current" href="./">Power</a>
+                  <li class="toctree-l1 current"><a class="reference internal current" href="#">Power</a>
     <ul class="current">
     <li class="toctree-l2"><a class="reference internal" href="#use-an-ohm-calculator-to-quickly-derive-watts">Use an Ohm calculator to quickly derive watts.</a>
     </li>
@@ -100,6 +100,8 @@
                   </li>
                   <li class="toctree-l1"><a class="reference internal" href="../PowerSources/">Power sources</a>
                   </li>
+                  <li class="toctree-l1"><a class="reference internal" href="../PortingToNewDevice/">New Hardware Requirements</a>
+                  </li>
               </ul>
               <ul>
                 <li class="toctree-l1"><a class="reference internal" href="../Translation/">Translations</a>
@@ -144,15 +146,17 @@ This means that the electronics in the handle can only turn the heating element
 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>When the switch is on, the power in the resistor is: <em><code>P(watts) = V(volts) \times\ I(current=amps)</code></em></li>
+<li>Current through the resistor is:  <em><code>I(amps) = V(volts) ÷ Ω (resistance)</code></em></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><em><code>P(watts) = V(volts) * I(amps)</code></em> or <em><code>P = V^2 ÷ Ω</code></em></p>
+<p>The resistance of the tip is a fixed constant in ohms (Ω):</p>
+<ul>
+<li>6.2 Ω  Pine64 short tip</li>
+<li>8.0 Ω  TS100/Pinecil long tip</li>
+<li>4.5 Ω  TS80(P)</li>
+</ul>
 <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>

PowerSources/index.html

@@ -90,7 +90,7 @@
                   </li>
                   <li class="toctree-l1"><a class="reference internal" href="../HardwareIssues/">Known Hardware Issues</a>
                   </li>
-                  <li class="toctree-l1 current"><a class="reference internal current" href="./">Power sources</a>
+                  <li class="toctree-l1 current"><a class="reference internal current" href="#">Power sources</a>
     <ul class="current">
     <li class="toctree-l2"><a class="reference internal" href="#qc3">QC(3)</a>
         <ul>
@@ -108,6 +108,8 @@
     </li>
     </ul>
                   </li>
+                  <li class="toctree-l1"><a class="reference internal" href="../PortingToNewDevice/">New Hardware Requirements</a>
+                  </li>
               </ul>
               <ul>
                 <li class="toctree-l1"><a class="reference internal" href="../Translation/">Translations</a>
@@ -351,7 +353,7 @@
           </div><footer>
     <div class="rst-footer-buttons" role="navigation" aria-label="Footer Navigation">
         <a href="../HardwareIssues/" class="btn btn-neutral float-left" title="Known Hardware Issues"><span class="icon icon-circle-arrow-left"></span> Previous</a>
-        <a href="../Translation/" class="btn btn-neutral float-right" title="Translations">Next <span class="icon icon-circle-arrow-right"></span></a>
+        <a href="../PortingToNewDevice/" class="btn btn-neutral float-right" title="New Hardware Requirements">Next <span class="icon icon-circle-arrow-right"></span></a>
     </div>
 
   <hr/>
@@ -381,7 +383,7 @@
       <span><a href="../HardwareIssues/" style="color: #fcfcfc">&laquo; Previous</a></span>
     
     
-      <span><a href="../Translation/" style="color: #fcfcfc">Next &raquo;</a></span>
+      <span><a href="../PortingToNewDevice/" style="color: #fcfcfc">Next &raquo;</a></span>
     
   </span>
 </div>

Settings/index.html

@@ -65,7 +65,7 @@
               <ul class="current">
                   <li class="toctree-l1"><a class="reference internal" href="../Menu/">Main Menu</a>
                   </li>
-                  <li class="toctree-l1 current"><a class="reference internal current" href="./">Settings</a>
+                  <li class="toctree-l1 current"><a class="reference internal current" href="#">Settings</a>
     <ul class="current">
     <li class="toctree-l2"><a class="reference internal" href="#menu-categories">Menu Categories</a>
         <ul>
@@ -143,7 +143,7 @@
     </li>
     <li class="toctree-l3"><a class="reference internal" href="#setting-power-pulse-duration">Setting: Power pulse duration</a>
     </li>
-    <li class="toctree-l3"><a class="reference internal" href="#setting-language-en-english">Setting: Language:  EN     English</a>
+    <li class="toctree-l3"><a class="reference internal" href="#setting-language-en-english">Setting: Language: EN English</a>
     </li>
     <li class="toctree-l3"><a class="reference internal" href="#setting-screen-brightness">Setting: Screen brightness</a>
     </li>
@@ -180,6 +180,8 @@
                   </li>
                   <li class="toctree-l1"><a class="reference internal" href="../PowerSources/">Power sources</a>
                   </li>
+                  <li class="toctree-l1"><a class="reference internal" href="../PortingToNewDevice/">New Hardware Requirements</a>
+                  </li>
               </ul>
               <ul>
                 <li class="toctree-l1"><a class="reference internal" href="../Translation/">Translations</a>

Temperature/index.html

@@ -71,7 +71,7 @@
                   </li>
                   <li class="toctree-l1"><a class="reference internal" href="../Power/">Power</a>
                   </li>
-                  <li class="toctree-l1 current"><a class="reference internal current" href="./">Temperature</a>
+                  <li class="toctree-l1 current"><a class="reference internal current" href="#">Temperature</a>
     <ul class="current">
     <li class="toctree-l2"><a class="reference internal" href="#how-a-thermocouple-works-brief">How a thermocouple works (brief)</a>
     </li>
@@ -108,6 +108,8 @@
                   </li>
                   <li class="toctree-l1"><a class="reference internal" href="../PowerSources/">Power sources</a>
                   </li>
+                  <li class="toctree-l1"><a class="reference internal" href="../PortingToNewDevice/">New Hardware Requirements</a>
+                  </li>
               </ul>
               <ul>
                 <li class="toctree-l1"><a class="reference internal" href="../Translation/">Translations</a>

Translation/index.html

@@ -92,9 +92,11 @@
                   </li>
                   <li class="toctree-l1"><a class="reference internal" href="../PowerSources/">Power sources</a>
                   </li>
+                  <li class="toctree-l1"><a class="reference internal" href="../PortingToNewDevice/">New Hardware Requirements</a>
+                  </li>
               </ul>
               <ul class="current">
-                <li class="toctree-l1 current"><a class="reference internal current" href="./">Translations</a>
+                <li class="toctree-l1 current"><a class="reference internal current" href="#">Translations</a>
     <ul class="current">
     </ul>
                 </li>
@@ -142,7 +144,7 @@ All translations are stored as <code>json</code> files in the repository. Curren
             </div>
           </div><footer>
     <div class="rst-footer-buttons" role="navigation" aria-label="Footer Navigation">
-        <a href="../PowerSources/" class="btn btn-neutral float-left" title="Power sources"><span class="icon icon-circle-arrow-left"></span> Previous</a>
+        <a href="../PortingToNewDevice/" class="btn btn-neutral float-left" title="New Hardware Requirements"><span class="icon icon-circle-arrow-left"></span> Previous</a>
         <a href="../Development/" class="btn btn-neutral float-right" title="Development">Next <span class="icon icon-circle-arrow-right"></span></a>
     </div>
 
@@ -170,7 +172,7 @@ All translations are stored as <code>json</code> files in the repository. Curren
         </span>
     
     
-      <span><a href="../PowerSources/" style="color: #fcfcfc">&laquo; Previous</a></span>
+      <span><a href="../PortingToNewDevice/" style="color: #fcfcfc">&laquo; Previous</a></span>
     
     
       <span><a href="../Development/" style="color: #fcfcfc">Next &raquo;</a></span>

Troubleshooting/index.html

@@ -86,7 +86,7 @@
                   </li>
                   <li class="toctree-l1"><a class="reference internal" href="../Hardware/">Hardware Notes</a>
                   </li>
-                  <li class="toctree-l1 current"><a class="reference internal current" href="./">Troubleshooting</a>
+                  <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="#tip-shorted-warning">Tip Shorted warning</a>
     </li>
@@ -110,6 +110,8 @@
                   </li>
                   <li class="toctree-l1"><a class="reference internal" href="../PowerSources/">Power sources</a>
                   </li>
+                  <li class="toctree-l1"><a class="reference internal" href="../PortingToNewDevice/">New Hardware Requirements</a>
+                  </li>
               </ul>
               <ul>
                 <li class="toctree-l1"><a class="reference internal" href="../Translation/">Translations</a>

css/theme_extra.css

@@ -103,7 +103,7 @@ pre .cs, pre .c {
 form .search-query {
     width: 100%;
     border-radius: 50px;
-    padding: 6px 12px;  /* csslint allow: box-model */
+    padding: 6px 12px;
     border-color: #D1D4D5;
 }
 
@@ -135,7 +135,7 @@ form .search-query {
 }
 
 td, th {
-    border: 1px solid #e1e4e5 !important; /* csslint allow: important */
+    border: 1px solid #e1e4e5 !important;
     border-collapse: collapse;
 }
 
@@ -155,6 +155,12 @@ td, th {
     padding-bottom: 40px;
 }
 
+/* For section-index only */
+.wy-menu-vertical .current-section p {
+    background-color: #e3e3e3;
+    color: #404040;
+}
+
 /*
  * The second step of above amendment: Here we make sure the items are aligned
  * correctly within the .rst-current-version container. Using flexbox, we

index.html

@@ -41,7 +41,7 @@
 
       <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 class="toctree-l1 current"><a class="reference internal current" href="#">Home</a>
     <ul class="current">
     <li class="toctree-l2"><a class="reference internal" href="#getting-started">Getting Started</a>
     </li>
@@ -104,6 +104,8 @@
                   </li>
                   <li class="toctree-l1"><a class="reference internal" href="PowerSources/">Power sources</a>
                   </li>
+                  <li class="toctree-l1"><a class="reference internal" href="PortingToNewDevice/">New Hardware Requirements</a>
+                  </li>
               </ul>
               <ul>
                 <li class="toctree-l1"><a class="reference internal" href="Translation/">Translations</a>
@@ -344,6 +346,6 @@ When on the main screen and having the tip plugged in, the unit shows a pair of
 </html>
 
 <!--
-MkDocs version : 1.5.3
-Build Date UTC : 2023-11-16 10:33:19.900431+00:00
+MkDocs version : 1.6.1
+Build Date UTC : 2025-02-25 17:09:48.314755+00:00
 -->

search.html

@@ -85,6 +85,8 @@
                   </li>
                   <li class="toctree-l1"><a class="reference internal" href="./PowerSources/">Power sources</a>
                   </li>
+                  <li class="toctree-l1"><a class="reference internal" href="./PortingToNewDevice/">New Hardware Requirements</a>
+                  </li>
               </ul>
               <ul>
                 <li class="toctree-l1"><a class="reference internal" href="./Translation/">Translations</a>

sitemap.xml

@@ -2,112 +2,94 @@
 <urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">
     <url>
          <loc>https://ralim.github.io/IronOS/</loc>
-         <lastmod>2023-11-16</lastmod>
-         <changefreq>daily</changefreq>
+         <lastmod>2025-02-25</lastmod>
     </url>
     <url>
          <loc>https://ralim.github.io/IronOS/Bluetooth/</loc>
-         <lastmod>2023-11-16</lastmod>
-         <changefreq>daily</changefreq>
+         <lastmod>2025-02-25</lastmod>
     </url>
     <url>
          <loc>https://ralim.github.io/IronOS/DebugMenu/</loc>
-         <lastmod>2023-11-16</lastmod>
-         <changefreq>daily</changefreq>
+         <lastmod>2025-02-25</lastmod>
     </url>
     <url>
          <loc>https://ralim.github.io/IronOS/Development/</loc>
-         <lastmod>2023-11-16</lastmod>
-         <changefreq>daily</changefreq>
+         <lastmod>2025-02-25</lastmod>
     </url>
     <url>
          <loc>https://ralim.github.io/IronOS/GettingStarted/</loc>
-         <lastmod>2023-11-16</lastmod>
-         <changefreq>daily</changefreq>
+         <lastmod>2025-02-25</lastmod>
     </url>
     <url>
          <loc>https://ralim.github.io/IronOS/HallSensor/</loc>
-         <lastmod>2023-11-16</lastmod>
-         <changefreq>daily</changefreq>
+         <lastmod>2025-02-25</lastmod>
     </url>
     <url>
          <loc>https://ralim.github.io/IronOS/Hardware/</loc>
-         <lastmod>2023-11-16</lastmod>
-         <changefreq>daily</changefreq>
+         <lastmod>2025-02-25</lastmod>
     </url>
     <url>
          <loc>https://ralim.github.io/IronOS/HardwareIssues/</loc>
-         <lastmod>2023-11-16</lastmod>
-         <changefreq>daily</changefreq>
+         <lastmod>2025-02-25</lastmod>
     </url>
     <url>
          <loc>https://ralim.github.io/IronOS/History/</loc>
-         <lastmod>2023-11-16</lastmod>
-         <changefreq>daily</changefreq>
+         <lastmod>2025-02-25</lastmod>
     </url>
     <url>
          <loc>https://ralim.github.io/IronOS/Logo/</loc>
-         <lastmod>2023-11-16</lastmod>
-         <changefreq>daily</changefreq>
+         <lastmod>2025-02-25</lastmod>
     </url>
     <url>
          <loc>https://ralim.github.io/IronOS/Menu/</loc>
-         <lastmod>2023-11-16</lastmod>
-         <changefreq>daily</changefreq>
+         <lastmod>2025-02-25</lastmod>
+    </url>
+    <url>
+         <loc>https://ralim.github.io/IronOS/PortingToNewDevice/</loc>
+         <lastmod>2025-02-25</lastmod>
     </url>
     <url>
          <loc>https://ralim.github.io/IronOS/Power/</loc>
-         <lastmod>2023-11-16</lastmod>
-         <changefreq>daily</changefreq>
+         <lastmod>2025-02-25</lastmod>
     </url>
     <url>
          <loc>https://ralim.github.io/IronOS/PowerSources/</loc>
-         <lastmod>2023-11-16</lastmod>
-         <changefreq>daily</changefreq>
+         <lastmod>2025-02-25</lastmod>
     </url>
     <url>
          <loc>https://ralim.github.io/IronOS/Settings/</loc>
-         <lastmod>2023-11-16</lastmod>
-         <changefreq>daily</changefreq>
+         <lastmod>2025-02-25</lastmod>
     </url>
     <url>
          <loc>https://ralim.github.io/IronOS/Temperature/</loc>
-         <lastmod>2023-11-16</lastmod>
-         <changefreq>daily</changefreq>
+         <lastmod>2025-02-25</lastmod>
     </url>
     <url>
          <loc>https://ralim.github.io/IronOS/Translation/</loc>
-         <lastmod>2023-11-16</lastmod>
-         <changefreq>daily</changefreq>
+         <lastmod>2025-02-25</lastmod>
     </url>
     <url>
          <loc>https://ralim.github.io/IronOS/Troubleshooting/</loc>
-         <lastmod>2023-11-16</lastmod>
-         <changefreq>daily</changefreq>
+         <lastmod>2025-02-25</lastmod>
     </url>
     <url>
          <loc>https://ralim.github.io/IronOS/Flashing/MHP30/</loc>
-         <lastmod>2023-11-16</lastmod>
-         <changefreq>daily</changefreq>
+         <lastmod>2025-02-25</lastmod>
     </url>
     <url>
          <loc>https://ralim.github.io/IronOS/Flashing/Pinecil%20V1/</loc>
-         <lastmod>2023-11-16</lastmod>
-         <changefreq>daily</changefreq>
+         <lastmod>2025-02-25</lastmod>
     </url>
     <url>
          <loc>https://ralim.github.io/IronOS/Flashing/Pinecil%20V2/</loc>
-         <lastmod>2023-11-16</lastmod>
-         <changefreq>daily</changefreq>
+         <lastmod>2025-02-25</lastmod>
     </url>
     <url>
          <loc>https://ralim.github.io/IronOS/Flashing/TS100/</loc>
-         <lastmod>2023-11-16</lastmod>
-         <changefreq>daily</changefreq>
+         <lastmod>2025-02-25</lastmod>
     </url>
     <url>
          <loc>https://ralim.github.io/IronOS/Flashing/TS80%28P%29/</loc>
-         <lastmod>2023-11-16</lastmod>
-         <changefreq>daily</changefreq>
+         <lastmod>2025-02-25</lastmod>
     </url>
 </urlset>