Skip to content

Commit

Permalink
Deployed a9f960d with MkDocs version: 1.5.3
Browse files Browse the repository at this point in the history
  • Loading branch information
@github-actions
github-actions[bot] committed Apr 2, 2024
1 parent 5d8051d commit eb5d8a9
Show file tree
Hide file tree
Showing 28 changed files with 124 additions and 44 deletions.
2 changes: 2 additions & 0 deletions 404.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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>
Expand Down
2 changes: 2 additions & 0 deletions Bluetooth/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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>
Expand Down
2 changes: 2 additions & 0 deletions DebugMenu/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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>
Expand Down
2 changes: 2 additions & 0 deletions Development/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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>
Expand Down
2 changes: 2 additions & 0 deletions Flashing/MHP30/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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>
Expand Down
2 changes: 2 additions & 0 deletions Flashing/Pinecil V1/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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>
Expand Down
2 changes: 2 additions & 0 deletions Flashing/Pinecil V2/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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>
Expand Down
2 changes: 2 additions & 0 deletions Flashing/TS100/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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>
Expand Down
2 changes: 2 additions & 0 deletions Flashing/TS80(P)/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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>
Expand Down
4 changes: 3 additions & 1 deletion GettingStarted/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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>
Expand Down Expand Up @@ -163,7 +165,7 @@ <h1 id="getting-started">Getting Started</h1>
<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>
Expand Down
2 changes: 2 additions & 0 deletions HallSensor/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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>
Expand Down
2 changes: 2 additions & 0 deletions Hardware/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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>
Expand Down
2 changes: 2 additions & 0 deletions HardwareIssues/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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>
Expand Down
2 changes: 2 additions & 0 deletions History/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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>
Expand Down
2 changes: 2 additions & 0 deletions Logo/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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>
Expand Down
2 changes: 2 additions & 0 deletions Menu/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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>
Expand Down
60 changes: 46 additions & 14 deletions PortingToNewDevice/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,14 +5,14 @@
<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>Requesting support for a new device - IronOS</title>
<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 = "Requesting support for a new device";
var mkdocs_page_name = "New Hardware Requirements";
var mkdocs_page_input_path = "PortingToNewDevice.md";
var mkdocs_page_url = "/IronOS/PortingToNewDevice/";
</script>
Expand Down Expand Up @@ -79,7 +79,7 @@
</li>
</ul>
<p class="caption"><span class="caption-text">Hardware</span></p>
<ul>
<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>
Expand All @@ -92,6 +92,30 @@
</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>
Expand Down Expand Up @@ -119,7 +143,8 @@
<div class="rst-content"><div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
<li><a href=".." class="icon icon-home" aria-label="Docs"></a></li>
<li class="breadcrumb-item active">Requesting support for a new device</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>
Expand All @@ -132,7 +157,7 @@
<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>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>
Expand All @@ -141,7 +166,7 @@ <h2 id="hard-requirements">Hard requirements</h2>
<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 thermalcouple, a reference temperature sensor for cold junction compensation must exist and be close to the sensor contacts</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>
Expand All @@ -156,7 +181,6 @@ <h2 id="soft-requirements">Soft requirements</h2>
<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>OLED Screens larger than 96x16 pixels</li>
<li>Colour screens</li>
<li>More than 2 buttons for input, or encoder inputs</li>
<li>WiFi/Zigbee/ any other networking</li>
Expand All @@ -166,19 +190,19 @@ <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>.
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>
<h1 id="example-request-for-adding-a-new-device">Example request for adding a new device</h1>
<p>Device Name:
<h2 id="example-request-for-adding-a-new-device">Example request for adding a new device</h2>
<p>Device Name:
Device Type:
Approximate Price:
Approximate Price:
Example purchase locations:</p>
<h2 id="hardware-details">Hardware details:</h2>
<p>Microcontroller version:
Flash size (If external to the MCU):
<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 []
Expand All @@ -190,6 +214,10 @@ <h2 id="hardware-details">Hardware details:</h2>

</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/>

Expand All @@ -215,6 +243,10 @@ <h2 id="hardware-details">Hardware details:</h2>
</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>
Expand Down
2 changes: 2 additions & 0 deletions Power/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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>
Expand Down
6 changes: 4 additions & 2 deletions PowerSources/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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>
Expand Down Expand Up @@ -351,7 +353,7 @@ <h3 id="compatible-devices-powerdelivery-for-ts80p">Compatible Devices (PowerDel
</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/>
Expand Down Expand Up @@ -381,7 +383,7 @@ <h3 id="compatible-devices-powerdelivery-for-ts80p">Compatible Devices (PowerDel
<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>
Expand Down
2 changes: 2 additions & 0 deletions Settings/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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>
Expand Down
Loading

0 comments on commit eb5d8a9

Please sign in to comment.