Mirror/AI-on-the-edge-device-docs
1
0
Fork 0
mirror of https://github.com/jomjol/AI-on-the-edge-device-docs.git synced 2025-12-06 19:46:56 +03:00
Code Issues Packages Projects Releases Wiki Activity

Deployed 05c13b7 with MkDocs version: 1.6.0

Browse Source
This commit is contained in:
github-actions[bot]
2024-08-23 22:31:39 +00:00
parent 02164f98e0
commit 9fdb5a3f7b
14 changed files with 26 additions and 26 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
Alignment/index.html
View File

@@ -644,7 +644,7 @@ with the target to be in exactly the same position as the reference image.</p>
It is advised to have them as far apart as possible.</p>
</div>
<h2 id="precondition"><span class="enumerate-headings-plugin enumerate-heading-plugin">1.1</span> Precondition</h2>
<p>Please make sure to have setup your camera properly and taken a good <a href="../Reference-Image">Reference Image</a>.</p>
<p>Please make sure to have setup your camera properly and taken a good <a href="../Reference-Image/">Reference Image</a>.</p>
<h2 id="define-two-reference-images"><span class="enumerate-headings-plugin enumerate-heading-plugin">1.2</span> Define two Reference Images</h2>
<p><img alt="" src="../img/initial_setup_2_alignment_marks.jpg" style="width:500px"/></p>
<p>You can switch between this two marks with <code>(1)</code>.</p>

6
Choosing-the-Model/index.html
View File

@@ -825,11 +825,11 @@
<h1 id="model-selection"><span class="enumerate-headings-plugin enumerate-heading-plugin">1.</span> Model Selection</h1>
<div class="admonition notes">
<p class="admonition-title">Notes</p>
<p>See <a href="../Neural-Network-Types">Neural Network Types</a> for additional details.</p>
<p>See <a href="../Neural-Network-Types/">Neural Network Types</a> for additional details.</p>
</div>
<p>In the <a href="../Graphical-configuration">Graphical Configuration Page</a>, you can choose different models depending on your needs.</p>
<p>In the <a href="../Configuration/">Graphical Configuration Page</a>, you can choose different models depending on your needs.</p>
<p>This page tries to help you on which model to select.
For more technical/deeper explanations have a look on <a href="../Neural-Network-Types">Neural-Network-Types</a>.</p>
For more technical/deeper explanations have a look on <a href="../Neural-Network-Types/">Neural-Network-Types</a>.</p>
<h2 id="digit-models"><span class="enumerate-headings-plugin enumerate-heading-plugin">1.1</span> Digit Models</h2>
<p>For digits on water meters, gas-meters or power meters you can select between two main types of models.</p>
<h3 id="dig-class11"><span class="enumerate-headings-plugin enumerate-heading-plugin">1.1.1</span> dig-class11</h3>

2
Configuration/index.html
View File

@@ -801,7 +801,7 @@
<li>Most of the commands need processing on the ESP32 device. This is not very fast - so please be patient.</li>
</ul>
</div>
<p>All parameters are documented on the <a href="../Parameters">Parameters</a> page and as tooltips on the config page.</p>
<p>All parameters are documented on the <a href="../Parameters/">Parameters</a> page and as tooltips on the config page.</p>
<h2 id="expert-parameters"><span class="enumerate-headings-plugin enumerate-heading-plugin">1.1</span> Expert Parameters</h2>
<p>Some parameters are treated as <strong>Expert Parameters</strong> and are hidden by default.
Tick the checkbox in the top left corner to enable them:</p>

4
Error-Codes/index.html
View File

@@ -757,7 +757,7 @@
Most likely they are caused by a hardware issue!</p>
<h3 id="0x00000001-psram-bad"><span class="enumerate-headings-plugin enumerate-heading-plugin">1.1.1</span> <code>0x00000001</code> PSRAM bad</h3>
<p>Your device most likely has no PSRAM at all or it is too small (needs to have at least 4 MBytes)!
See <a href="../Hardware-Compatibility">Hardware Compatibility</a>.</p>
See <a href="../Hardware-Compatibility/">Hardware Compatibility</a>.</p>
<p>Usually the log shows something like this:
<div class="language-text highlight"><pre><span></span><code><span id="__span-0-1"><a href="#__codelineno-0-1" id="__codelineno-0-1" name="__codelineno-0-1"></a>psram: PSRAM ID read error: 0xffffffff
</span><span id="__span-0-2"><a href="#__codelineno-0-2" id="__codelineno-0-2" name="__codelineno-0-2"></a>cpu_start: Failed to init external RAM!
@@ -768,7 +768,7 @@ See <a href="../Hardware-Compatibility">Hardware Compatibility</a>.</p>
<p>The attached camera can not be initialized.
This usually is because on of the following reasons:</p>
<ul>
<li>The camera is not supported, see <a href="../Hardware-Compatibility">Hardware Compatibility</a></li>
<li>The camera is not supported, see <a href="../Hardware-Compatibility/">Hardware Compatibility</a></li>
<li>The camera is not attached properly -&gt; Try to remove and attach it again. Make sure you move the black part enough into the socket!</li>
<li>The camera or the camera cable is damaged</li>
</ul>

2
FAQs/index.html
View File

@@ -724,7 +724,7 @@
<ul>
<li>Frequent HTML requests</li>
<li>Wrong configuration, missing configuration files</li>
<li>Unstable hardware - see <a href="../Hardware-Compatibility">Hardware Compatibility</a>.</li>
<li>Unstable hardware - see <a href="../Hardware-Compatibility/">Hardware Compatibility</a>.</li>
</ul>
<p>There is a dedicated page about this: <a href="../Frequent-Reboots/">Frequent Reboots</a>.</p>
<h2 id="bad-webui-responsiveness-what-can-i-do"><span class="enumerate-headings-plugin enumerate-heading-plugin">1.2</span> Bad WebUI responsiveness. What can I do?</h2>

2
Influx-DB/index.html
View File

@@ -588,7 +588,7 @@
<article class="md-content__inner md-typeset">
<h1 id="influx-db"><span class="enumerate-headings-plugin enumerate-heading-plugin">1.</span> Influx DB</h1>
<p>The device also supports direct sending of data to an Influx DB.</p>
<p>See also <a href="../Integration-Home-Assistant#influxdb-graphs">Influx Graph in Home Assistant</a>.</p>
<p>See also <a href="../Integration-Home-Assistant/#influxdb-graphs">Influx Graph in Home Assistant</a>.</p>
</article>
</div>
<script>var target=document.getElementById(location.hash.slice(1));target&&target.name&&(target.checked=target.name.startsWith("__tabbed_"))</script>

6
Installation/index.html
View File

@@ -893,7 +893,7 @@
<li>4 or 8 MB PSRAM. </li>
</ul>
<p>It can be easily found on the typical internet stores, searching for ESP32-CAM for less than 10 EUR.
How ever since the hardware is cheap and coming from China, you unluckily could pick a malfunctioning device. See <a href="../Hardware-Compatibility">Hardware Compatibility</a> for further advice! </p>
How ever since the hardware is cheap and coming from China, you unluckily could pick a malfunctioning device. See <a href="../Hardware-Compatibility/">Hardware Compatibility</a> for further advice! </p>
<h3 id="usb-uart-interface"><span class="enumerate-headings-plugin enumerate-heading-plugin">1.1.2</span> USB-&gt;UART interface</h3>
<p>For first time flashing the firmware a USB -&gt; UART connector is needed. Later firmware upgrades than can be flashed via OTA.</p>
<h3 id="power-supply"><span class="enumerate-headings-plugin enumerate-heading-plugin">1.1.3</span> Power supply</h3>
@@ -916,7 +916,7 @@ How ever since the hardware is cheap and coming from China, you unluckily could
<p>A example for wiring can be found here:</p>
<p><img alt="" src="../img/wiring.png"/></p>
<p><img alt="" src="../img/progammer_manual.jpg"/></p>
<p>It is also possible to use external LEDs for the illumination instead of the internal flash LED. This is described <a href="../External-LED">here</a></p>
<p>It is also possible to use external LEDs for the illumination instead of the internal flash LED. This is described <a href="../External-LED/">here</a></p>
<h2 id="2-firmware"><span class="enumerate-headings-plugin enumerate-heading-plugin">1.2</span> 2. Firmware</h2>
<h3 id="web-installer"><span class="enumerate-headings-plugin enumerate-heading-plugin">1.2.1</span> Web Installer</h3>
<p>There is a Web Installer available which will work right out of the web browser Edge and Chrome.
@@ -928,7 +928,7 @@ You can access it with the following link: <a href="https://jomjol.github.io/AI-
<p>Grab the firmware from the</p>
<ul>
<li><a href="https://github.com/jomjol/AI-on-the-edge-device/releases">Releases page</a> (Stable, tested versions), or the</li>
<li><a href="https://github.com/jomjol/AI-on-the-edge-device/actions?query=branch%3Arolling">Automatically build development branch</a> (experimental, untested versions). Please have a look on <a href="../rolling-installation">Living on the Edge</a> first!</li>
<li><a href="https://github.com/jomjol/AI-on-the-edge-device/actions?query=branch%3Arolling">Automatically build development branch</a> (experimental, untested versions). Please have a look on <a href="../rolling-installation/">Living on the Edge</a> first!</li>
</ul>
<p>You need:</p>
<ul>

4
Integration-Home-Assistant/index.html
View File

@@ -833,7 +833,7 @@ it is a helper and can be used to reset the total increasing values once a day</
<img alt="grafik" src="https://user-images.githubusercontent.com/1783586/193471893-d8ab8f5f-0906-4076-8926-8b5a69a24bce.png"/></p>
<p>Note that there seems to be a bug in the graph, see <a href="https://github.com/home-assistant/frontend/issues/13995">https://github.com/home-assistant/frontend/issues/13995</a>!</p>
<h3 id="influxdb-graphs"><span class="enumerate-headings-plugin enumerate-heading-plugin">1.1.4</span> InfluxDb Graphs</h3>
<p>See also <a href="../Influx-DB">Influx-DB</a>.</p>
<p>See also <a href="../Influx-DB/">Influx-DB</a>.</p>
<p>If you have setup InfluxDB already, it is also possible to fetch statistics from there, e.g. daily usage:
<div class="language-text highlight"><pre><span></span><code><span id="__span-4-1"><a href="#__codelineno-4-1" id="__codelineno-4-1" name="__codelineno-4-1"></a>from(bucket: "HomeAssistant")
</span><span id="__span-4-2"><a href="#__codelineno-4-2" id="__codelineno-4-2" name="__codelineno-4-2"></a>|&gt; range(start: v.timeRangeStart, stop: v.timeRangeStop)
@@ -846,7 +846,7 @@ it is a helper and can be used to reset the total increasing values once a day</
<p><img alt="grafik" src="https://user-images.githubusercontent.com/1783586/193473347-c81fc301-c52f-4af0-9fcb-56fab12cacac.png"/></p>
<h2 id="using-rest"><span class="enumerate-headings-plugin enumerate-heading-plugin">1.2</span> Using REST</h2>
<p>When using REST, Home Assistant has to periodically call an URL on the ESP32 which in return provides the requested data.</p>
<p>See <a href="../REST-API">REST API</a> for a list of available URLs.</p>
<p>See <a href="../REST-API/">REST API</a> for a list of available URLs.</p>
<p>The most practical one is the <code>json</code> entrypoint which provides the most relevant data JSON formatted:
<code>http://&lt;IP&gt;/json</code>
This would return:

2
Neural-Network-Types/index.html
View File

@@ -959,7 +959,7 @@
<h1 id="neural-network-types"><span class="enumerate-headings-plugin enumerate-heading-plugin">1.</span> Neural Network Types</h1>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>For an overview, see <a href="../Choosing-the-Model">Choosing the Model</a>.</p>
<p>For an overview, see <a href="../Choosing-the-Model/">Choosing the Model</a>.</p>
</div>
<p>This section is describing the different types of neural networks, that are used with the AI-on-the-edge approach and gives an introduction on how and where to use them. </p>
<h2 id="overview-neural-network-type"><span class="enumerate-headings-plugin enumerate-heading-plugin">1.1</span> Overview neural network type</h2>

2
Parameters/index.html
View File

@@ -2427,7 +2427,7 @@
<div class="md-content" data-md-component="content">
<article class="md-content__inner md-typeset">
<h1 id="parameters"><span class="enumerate-headings-plugin enumerate-heading-plugin">1.</span> Parameters</h1>
<p>This page lists all available <a href="../Configuration">Configuration</a> Parameters.
<p>This page lists all available <a href="../Configuration/">Configuration</a> Parameters.
If a <strong>parameter</strong> or <strong>section</strong> has a tick box on its left side, you can disable it.
In such case the functionality gets disabled respectively the default values will be used.</p>
<div class="admonition note">

2
REST-API/index.html
View File

@@ -1260,7 +1260,7 @@
- Example: <code>Heap info: Heap Total: 1888926 | SPI Free: 1827431 | SPI Larg Block: 1802240 | SPI Min Free: 758155 | Int Free: 61495 | Int Larg Block: 55296 | Int Min Free: 36427</code></p>
<h2 id="prometheusopenmetrics"><span class="enumerate-headings-plugin enumerate-heading-plugin">1.7</span> Prometheus/OpenMetrics</h2>
<h3 id="metrics"><span class="enumerate-headings-plugin enumerate-heading-plugin">1.7.1</span> metrics</h3>
<p>Provides a set of metrics that can be scraped by prometheus. See <a href="../prometheus-openmetrics">Prometheus/OpenMetrics</a> for details.</p>
<p>Provides a set of metrics that can be scraped by prometheus. See <a href="../prometheus-openmetrics/">Prometheus/OpenMetrics</a> for details.</p>
</article>
</div>
<script>var target=document.getElementById(location.hash.slice(1));target&&target.name&&(target.checked=target.name.startsWith("__tabbed_"))</script>

12
ROI-Configuration/index.html
View File

@@ -771,14 +771,14 @@ There are several precautions to detect this. For details see the section <code>
</li>
<li>
<p>Using a well trained Model.</p>
<p>Have a look on the <a href="https://jomjol.github.io/neural-network-digital-counter-readout/">Digital Counters</a> resp. <a href="https://jomjol.github.io/neural-network-analog-needle-readout">Analog Needles</a> to check if your types are contained. If your number types are <strong>not</strong> contained, you should take the effort to record them so we can add them to the training data. See <a href="../Learn-models-with-your-own-images">Collect images to improve the models</a> on how to collect new training data.</p>
<p>Have a look on the <a href="https://jomjol.github.io/neural-network-digital-counter-readout/">Digital Counters</a> resp. <a href="https://jomjol.github.io/neural-network-analog-needle-readout">Analog Needles</a> to check if your types are contained. If your number types are <strong>not</strong> contained, you should take the effort to record them so we can add them to the training data. See <a href="../Learn-models-with-your-own-images/">Collect images to improve the models</a> on how to collect new training data.</p>
</li>
</ol>
<h2 id="precondition"><span class="enumerate-headings-plugin enumerate-heading-plugin">1.1</span> Precondition</h2>
<p>Please make sure to have:</p>
<ol>
<li>Setup your camera properly and taken a good <a href="../Reference-Image">Reference Image</a>.</li>
<li>Selected good <a href="../Alignment">Alignment References</a>.</li>
<li>Setup your camera properly and taken a good <a href="../Reference-Image/">Reference Image</a>.</li>
<li>Selected good <a href="../Alignment/">Alignment References</a>.</li>
</ol>
<h2 id="define-the-rois"><span class="enumerate-headings-plugin enumerate-heading-plugin">1.2</span> Define the ROIs</h2>
<p>For each digit or analog pointer, a ROI must be defined.</p>
@@ -787,7 +787,7 @@ There are several precautions to detect this. For details see the section <code>
<p><img alt="" src="../img/initial_setup_3_rois.jpg" style="width:500px"/></p>
<p>You can switch between the individual ROIs with the Drop down box <code>(2)</code>.
If you need additional ROIs or delete them you can do this with the control at <code>(3)</code>.
Like for the <a href="../Alignment">Alignment References</a>, you can change the position, size and name of a ROI in the text fields or define them via drag and drop through the mouse button.
Like for the <a href="../Alignment/">Alignment References</a>, you can change the position, size and name of a ROI in the text fields or define them via drag and drop through the mouse button.
Make sure the ROIs are in the right order, matching the significance of a digit/analog counter!</p>
<div class="admonition warning">
<p class="admonition-title">Warning</p>
@@ -814,7 +814,7 @@ The circle should exactly fit to the outer size of the meter and the cross shoul
<p>First of all, choose the right size of the ROI.
The configuration of ROIs differs a bit on the selected model (see below). </p>
<p>If you are in the initial setup, the model will be selectable in the next step. By default it is a <code>dig-cont</code> resp. <code>ana-cont</code> model.</p>
<p>In <a href="../Choosing-the-Model">Model Selection</a> you find the differences between the different available models. Pick the one you think fits best your purpose. If you don't get to good result, try another model.</p>
<p>In <a href="../Choosing-the-Model/">Model Selection</a> you find the differences between the different available models. Pick the one you think fits best your purpose. If you don't get to good result, try another model.</p>
<p>Here we only show the different configuration of the ROIs.</p>
<ol>
<li>
@@ -893,7 +893,7 @@ For a first run you can choose the following general settings: </p>
</tr>
</tbody>
</table>
<p>If you have perfect alignment and still are not getting satisfying results, most probably your numbers are not part of the training data yet. See <a href="../Learn-models-with-your-own-images">Collect images to improve the models</a> on how to collect new training data.</p>
<p>If you have perfect alignment and still are not getting satisfying results, most probably your numbers are not part of the training data yet. See <a href="../Learn-models-with-your-own-images/">Collect images to improve the models</a> on how to collect new training data.</p>
<h5 id="setup-using-dig-class100-or-dig-cont-models"><span class="enumerate-headings-plugin enumerate-heading-plugin">1.2.2.2.2</span> Setup using <code>dig-class100</code> or <code>dig-cont</code> Models</h5>
<p>These models recognize the <strong>tenths</strong> (fractions) between the numbers.
Those models require a different ROI setup; <strong>the height must be set differently and more accurately</strong>.</p>

2
ota/index.html
View File

@@ -661,7 +661,7 @@
Grab the firmware from the</p>
<ul>
<li><a href="https://github.com/jomjol/AI-on-the-edge-device/releases">Releases page</a> (Stable, tested versions), or the</li>
<li><a href="https://github.com/jomjol/AI-on-the-edge-device/actions?query=branch%3Arolling">Automatically build development branch</a> (experimental, untested versions). Please inform yourself on <a href="../rolling-installation">Living on the Edge</a> first!</li>
<li><a href="https://github.com/jomjol/AI-on-the-edge-device/actions?query=branch%3Arolling">Automatically build development branch</a> (experimental, untested versions). Please inform yourself on <a href="../rolling-installation/">Living on the Edge</a> first!</li>
</ul>
<h2 id="update-procedure"><span class="enumerate-headings-plugin enumerate-heading-plugin">1.1</span> Update Procedure</h2>
<ol>

4
rolling-installation/index.html
View File

@@ -624,7 +624,7 @@
<p>The <a href="https://github.com/jomjol/AI-on-the-edge-device">Github repository</a> contains multiple branches:</p>
<ul>
<li>The <a href="https://github.com/jomjol/AI-on-the-edge-device/tree/master">master</a> branch contains the same firmware version as provided on the <a href="https://github.com/jomjol/AI-on-the-edge-device/releases">release page</a>.</li>
<li>The <a href="https://github.com/jomjol/AI-on-the-edge-device/tree/rolling">rolling</a> branch contains the <strong>latest</strong> version of the Firmware and the Web Interface. It might already contain a fix for your issue. But it is work in progress, don't expect it to work stable or be an improvement for your AI-on-the-edge-device! Also it might break the <a href="../ota">OTA Update</a> and thus require manual flashing over USB!</li>
<li>The <a href="https://github.com/jomjol/AI-on-the-edge-device/tree/rolling">rolling</a> branch contains the <strong>latest</strong> version of the Firmware and the Web Interface. It might already contain a fix for your issue. But it is work in progress, don't expect it to work stable or be an improvement for your AI-on-the-edge-device! Also it might break the <a href="../ota/">OTA Update</a> and thus require manual flashing over USB!</li>
<li>Any other branch is used to develop a feature or fix, only use them when you know what it is about!</li>
</ul>
<h2 id="i-still-want-to-try-it"><span class="enumerate-headings-plugin enumerate-heading-plugin">1.1</span> I still want to try it</h2>
@@ -634,7 +634,7 @@
<img alt="" src="../actions.png"> </img></li>
<li>Scroll down and download the <code>AI-on-the-edge-device__update__*.zip</code>:
<img alt="" src="../update-artifact.png"> </img></li>
<li>Flash the zip file using the <a href="../ota">OTA Update</a> page of your device.</li>
<li>Flash the zip file using the <a href="../ota/">OTA Update</a> page of your device.</li>
</ol>
</article>
</div>