mirror of
https://github.com/jomjol/AI-on-the-edge-device-docs.git
synced 2025-12-08 20:46:54 +03:00
Deployed be7cd69 with MkDocs version: 1.4.2
This commit is contained in:
github-actions[bot]
@@ -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://jomjol.github.io/AI-on-the-edge-device-docs/Configuration/" />
|
||||
<link rel="shortcut icon" href="../img/favicon.ico" />
|
||||
<title>Configuration - AI on the Edge Device</title>
|
||||
<title>Graphical Configuration - AI on the Edge Device</title>
|
||||
<link rel="stylesheet" href="../css/theme.css" />
|
||||
<link rel="stylesheet" href="../css/theme_extra.css" />
|
||||
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.5.0/styles/github.min.css" />
|
||||
|
||||
<script>
|
||||
// Current page data
|
||||
var mkdocs_page_name = "Configuration";
|
||||
var mkdocs_page_name = "Graphical Configuration";
|
||||
var mkdocs_page_input_path = "Configuration.md";
|
||||
var mkdocs_page_url = "/AI-on-the-edge-device-docs/Configuration/";
|
||||
</script>
|
||||
@@ -68,33 +68,24 @@
|
||||
</li>
|
||||
</ul>
|
||||
<p class="caption"><span class="caption-text">Configuration</span></p>
|
||||
<ul>
|
||||
<ul class="current">
|
||||
<li class="toctree-l1"><a class="reference internal" href="../Reference-Image/">Reference Image</a>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../Alignment/">Alignment References</a>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../ROI-Configuration/">ROI (Region of Interest)</a>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../Choosing-the-Model/">Model Selection</a>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../Neural-Network-Types/">Neural Network Types</a>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../ota/">Over-The-Air (OTA) Update</a>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../Parameters/">Parameters</a>
|
||||
</li>
|
||||
</ul>
|
||||
<p class="caption"><span class="caption-text">Advanced</span></p>
|
||||
<ul class="current">
|
||||
<li class="toctree-l1"><a class="reference internal" href="../Integration-Home-Assistant/">Integration into Home Assistant</a>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../External-LED/">External LED</a>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../rolling-installation/">Living on the Edge</a>
|
||||
</li>
|
||||
<li class="toctree-l1 current"><a class="reference internal current" href="./">Configuration</a>
|
||||
<li class="toctree-l1 current"><a class="reference internal current" href="./">Graphical Configuration</a>
|
||||
<ul class="current">
|
||||
<li class="toctree-l2"><a class="reference internal" href="#processing-configini-principle">Processing / Config.ini principle</a>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#expert-parameters">Expert Parameters</a>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#manual-editing-of-the-config-file">Manual Editing of the Config File</a>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#background-information">Background Information</a>
|
||||
<ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#processing-steps-overview">Processing steps - Overview</a>
|
||||
<ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#1-makeimage">1. [MakeImage]</a>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#1-takeimage">1. [TakeImage]</a>
|
||||
</li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#2-alignment">2. [Alignment]</a>
|
||||
</li>
|
||||
@@ -109,18 +100,29 @@
|
||||
<li class="toctree-l4"><a class="reference internal" href="#7-autotimer">7. [AutoTimer]</a>
|
||||
</li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#8-debug">8. [Debug]</a>
|
||||
</li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#9-ende">9. [Ende]</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#graphical-configuration-interface">Graphical configuration interface</a>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#background-for-image-alignment">Background for Image Alignment</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../Choosing-the-Model/">Model Selection</a>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../Neural-Network-Types/">Neural Network Types</a>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../ota/">Over-The-Air (OTA) Update</a>
|
||||
</li>
|
||||
</ul>
|
||||
<p class="caption"><span class="caption-text">Advanced</span></p>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../Parameters/">Parameters</a>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../Integration-Home-Assistant/">Integration into Home Assistant</a>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../External-LED/">External LED</a>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../rolling-installation/">Living on the Edge</a>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../Watermeter-specific-analog---digital-transition/">Analog/Digital Transition on Water Meters</a>
|
||||
</li>
|
||||
@@ -170,10 +172,6 @@
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../outdated--Integrated-Functions/">Integrated Functions</a>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../outdated--Gasmeter-Log-Downloader/">Gas Meter Log Downloader</a>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../outdated--Migrate-Old-Config-To-New-Config/">Migration from water-meter „old“ to water-meter “AI-on-the-edge-device”</a>
|
||||
</li>
|
||||
</ul>
|
||||
<p class="caption"><span class="caption-text">Assorted Pages</span></p>
|
||||
<ul>
|
||||
@@ -194,8 +192,8 @@
|
||||
<div class="rst-content"><div role="navigation" aria-label="breadcrumbs navigation">
|
||||
<ul class="wy-breadcrumbs">
|
||||
<li><a href=".." class="icon icon-home" alt="Docs"></a> »</li>
|
||||
<li>Advanced »</li>
|
||||
<li>Configuration</li>
|
||||
<li>Configuration »</li>
|
||||
<li>Graphical Configuration</li>
|
||||
<li class="wy-breadcrumbs-aside">
|
||||
<a href="https://github.com/jomjol/AI-on-the-edge-device-docs/edit/main/docs/Configuration.md" class="icon icon-github"> Edit on GitHub</a>
|
||||
</li>
|
||||
@@ -205,66 +203,59 @@
|
||||
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
|
||||
<div class="section" itemprop="articleBody">
|
||||
|
||||
<h1 id="configuration">Configuration</h1>
|
||||
<div class="admonition warning">
|
||||
<p class="admonition-title">Warning</p>
|
||||
<p>This page overlaps <a href="../Graphical-Configuration">Graphical-Configuration</a>. They should be merged to one page!</p>
|
||||
<h1 id="graphical-configuration">Graphical Configuration</h1>
|
||||
<p>Most of the settings can be modified on the Settings page:</p>
|
||||
<p><img src="../img/config_s1_access.jpg" width="600" align="middle"></p>
|
||||
<p>It can be reached via the menu <code>Settings > Configuration</code>.</p>
|
||||
<div class="admonition note">
|
||||
<p class="admonition-title">Note</p>
|
||||
<ul>
|
||||
<li>To activate the changes, the device needs to be restarted after saving the changes.</li>
|
||||
<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>
|
||||
<h2 id="expert-parameters">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>
|
||||
<p><img alt="" src="../img/expert-parameters.png" /> </p>
|
||||
<p>The <strong>Expert Parameters</strong> then will be shown with a red background:
|
||||
<img alt="" src="../img/expert-parameters2.png" /> </p>
|
||||
<h2 id="manual-editing-of-the-config-file">Manual Editing of the Config File</h2>
|
||||
<p>Even more configuration parameters can be edited manually in the <code>config.ini</code>:</p>
|
||||
<p><img alt="" src="../img/manual-config-editing.png" /> </p>
|
||||
<p>To edit the <code>config.ini</code> file directly, click on the <code>Edit Config.ini directly</code> button.</p>
|
||||
<h2 id="background-information">Background Information</h2>
|
||||
<div class="admonition note">
|
||||
<p class="admonition-title">Note</p>
|
||||
<p>You do not need to understand this!
|
||||
But you might be interested in it.</p>
|
||||
</div>
|
||||
<p>Most of the settings can be modified with the help of a web based <a href="Graphical-configuration">graphical user interface</a>. This is hosted through the web server on the ESP32.</p>
|
||||
<p>More configuration parameters can be edited by hand in the <code>config.ini</code> and corresponding files in the <code>/config</code> directory on the SD-card. </p>
|
||||
<p>If you where using the Version 1 of the water meter you can easily transfer the configuration to the new system by following the steps in this <a href="../outdated--Migrate-Old-Config-To-New-Config/">migration description</a></p>
|
||||
<h2 id="processing-configini-principle">Processing / Config.ini principle</h2>
|
||||
<p>The principle is very simple and can most easily be described as a flow of processing steps. Each step has a dedicated parameter description in the <code>config.ini</code>, which is indicated by brackets <code>[name_of_step]</code>. The steps are processed in the order written in the config file. That means, that you first have to describe the image taking, then the aligning and cutting and only after that you can start to config a neural network. The last step is the post processing.</p>
|
||||
<h3 id="processing-steps-overview">Processing steps - Overview</h3>
|
||||
<p>In the following you get a short overview over the available steps. This order is also the suggested order for the processing flow. Single steps can be left out, if not needed (e.g. omit the analog part, if only digits are present)</p>
|
||||
<h4 id="1-makeimage">1. <code>[MakeImage]</code></h4>
|
||||
<ul>
|
||||
<li>This steps parametrises the taking of the image by the ESP32-CAM. Size, quality and storage for logging and debugging can be set.</li>
|
||||
</ul>
|
||||
<h4 id="1-takeimage">1. <code>[TakeImage]</code></h4>
|
||||
<p>This steps parametrises the taking of the image by the ESP32-CAM. Size, quality and storage for logging and debugging can be set.</p>
|
||||
<h4 id="2-alignment">2. <code>[Alignment]</code></h4>
|
||||
<ul>
|
||||
<li>Image preprocessing, including image alignment with reference images</li>
|
||||
</ul>
|
||||
<p>Image preprocessing, including image alignment with reference images</p>
|
||||
<h4 id="3-digits">3. <code>[Digits]</code></h4>
|
||||
<ul>
|
||||
<li>Neural network evaluation of an image for digits. The neural network is defined by a tflite formatted file and the output is a number between 0 .. 9 or NaN (if image is not unique enough)</li>
|
||||
</ul>
|
||||
<p>Neural network evaluation of an image for digits. The neural network is defined by a tflite formatted file and the output is a number between 0 .. 9 or NaN (if image is not unique enough)</p>
|
||||
<h4 id="4-analog">4. <code>[Analog]</code></h4>
|
||||
<ul>
|
||||
<li>Neural network evaluation of analog counter. The neural network is defined by a tflite formatted file and the output is a number between 0.0 .. 9.9, representing the position of the pointer.</li>
|
||||
</ul>
|
||||
<p>Neural network evaluation of analog counter. The neural network is defined by a tflite formatted file and the output is a number between 0.0 .. 9.9, representing the position of the pointer.</p>
|
||||
<h4 id="5-postprocessing">5. <code>[PostProcessing]</code></h4>
|
||||
<ul>
|
||||
<li>Summarized the individually converted pictures to the overall result. It also implements some error corrections and consistency checks to filter wrong reading.</li>
|
||||
</ul>
|
||||
<p>Summarized the individually converted pictures to the overall result. It also implements some error corrections and consistency checks to filter wrong reading.</p>
|
||||
<h4 id="6-mqtt">6. <code>[MQTT]</code></h4>
|
||||
<ul>
|
||||
<li>Transfer of the readings to a MQTT server.</li>
|
||||
</ul>
|
||||
<p>Transfer of the readings to a MQTT server.</p>
|
||||
<h4 id="7-autotimer">7. <code>[AutoTimer]</code></h4>
|
||||
<ul>
|
||||
<li>Configuration of the automated flow start at the start up of the ESP32. </li>
|
||||
</ul>
|
||||
<p>Configuration of the automated flow start at the start up of the ESP32. </p>
|
||||
<h4 id="8-debug">8. <code>[Debug]</code></h4>
|
||||
<ul>
|
||||
<li>Configuration for debugging details</li>
|
||||
</ul>
|
||||
<h4 id="9-ende">9. <code>[Ende]</code></h4>
|
||||
<ul>
|
||||
<li>No meaning, just an additional indication, that the configuration is finished.</li>
|
||||
</ul>
|
||||
<p><strong>A detailed parameter description can be found here: [[Configuration Parameter Details]].</strong></p>
|
||||
<h2 id="graphical-configuration-interface">Graphical configuration interface</h2>
|
||||
<p>It is recommended to do the configuration of the alignment structures and ROIs through the graphical user interface. A step by step instruction can be found here: [[Graphical Configuration]]</p>
|
||||
<h2 id="background-for-image-alignment">Background for Image Alignment</h2>
|
||||
<p>Details on the image recognition flow can be found in the other project here: https://github.com/jomjol/water-meter-system-complete/blob/master/images/Alignment_procedure_draft.pdf</p>
|
||||
<p>The <code>config.ini</code> here has the same functionality and options, but a slightly different syntax due to a own written ini-parser is used. Migration see <a href="../outdated--Migrate-Old-Config-To-New-Config/">here</a>.</p>
|
||||
<p>Configuration for debugging details</p>
|
||||
|
||||
</div>
|
||||
</div><footer>
|
||||
<div class="rst-footer-buttons" role="navigation" aria-label="Footer Navigation">
|
||||
<a href="../rolling-installation/" class="btn btn-neutral float-left" title="Living on the Edge"><span class="icon icon-circle-arrow-left"></span> Previous</a>
|
||||
<a href="../Watermeter-specific-analog---digital-transition/" class="btn btn-neutral float-right" title="Analog/Digital Transition on Water Meters">Next <span class="icon icon-circle-arrow-right"></span></a>
|
||||
<a href="../ROI-Configuration/" class="btn btn-neutral float-left" title="ROI (Region of Interest)"><span class="icon icon-circle-arrow-left"></span> Previous</a>
|
||||
<a href="../Choosing-the-Model/" class="btn btn-neutral float-right" title="Model Selection">Next <span class="icon icon-circle-arrow-right"></span></a>
|
||||
</div>
|
||||
|
||||
<hr/>
|
||||
@@ -291,10 +282,10 @@
|
||||
</span>
|
||||
|
||||
|
||||
<span><a href="../rolling-installation/" style="color: #fcfcfc">« Previous</a></span>
|
||||
<span><a href="../ROI-Configuration/" style="color: #fcfcfc">« Previous</a></span>
|
||||
|
||||
|
||||
<span><a href="../Watermeter-specific-analog---digital-transition/" style="color: #fcfcfc">Next »</a></span>
|
||||
<span><a href="../Choosing-the-Model/" style="color: #fcfcfc">Next »</a></span>
|
||||
|
||||
</span>
|
||||
</div>
|
||||
|
||||
Reference in New Issue
Block a user