Deployed 030dc27 with MkDocs version: 1.4.2

This commit is contained in:
github-actions[bot]
2023-01-06 22:21:58 +00:00
parent be4cdd213b
commit 0c0534bd1d
39 changed files with 2707 additions and 1980 deletions

View File

@@ -54,26 +54,7 @@
<li class="toctree-l1"><a class="reference internal" href="../FAQs/">Frequently Asked Questions</a>
</li>
</ul>
<p class="caption"><span class="caption-text">Configuration</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../Choosing-the-Model/">Model Selection</a>
</li>
</ul>
<p class="caption"><span class="caption-text">Advanced</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../Build-Instructions/">Build the project yourself</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../Upload-files-by-script/">Scripted File Upload</a>
</li>
</ul>
<p class="caption"><span class="caption-text">API's</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../REST-API/">REST API</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../MQTT-API/">MQTT API</a>
</li>
</ul>
<p class="caption"><span class="caption-text">Links</span></p>
<p class="caption"><span class="caption-text">External Links</span></p>
<ul>
<li class="toctree-l1"><a class="" href="https://github.com/jomjol/AI-on-the-edge-device/releases">Releases</a>
</li>
@@ -84,77 +65,119 @@
<li class="toctree-l1"><a class="" href="https://github.com/jomjol/AI-on-the-edge-device/discussions">Join a Discussions</a>
</li>
</ul>
<p class="caption"><span class="caption-text">Asorted Pages</span></p>
<p class="caption"><span class="caption-text">Configuration</span></p>
<ul>
<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="../Graphical-Configuration/">Graphical Configuration</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>
</ul>
<p class="caption"><span class="caption-text">Advanced</span></p>
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="../Addditional-Information/">Addditional Information</a>
<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="../Configuration-Parameter-Details/">Configuration Parameter Details</a>
</li>
<li class="toctree-l1 current"><a class="reference internal current" href="./">Configuration</a>
<ul class="current">
<li class="toctree-l2"><a class="reference internal" href="#processing-steps-overview">Processing steps - Overview</a>
<li class="toctree-l2"><a class="reference internal" href="#processing-configini-principle">Processing / Config.ini principle</a>
<ul>
<li class="toctree-l3"><a class="reference internal" href="#1-makeimage">1. [MakeImage]</a>
<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>
<li class="toctree-l3"><a class="reference internal" href="#2-alignment">2. [Alignment]</a>
<li class="toctree-l4"><a class="reference internal" href="#2-alignment">2. [Alignment]</a>
</li>
<li class="toctree-l3"><a class="reference internal" href="#3-digits">3. [Digits]</a>
<li class="toctree-l4"><a class="reference internal" href="#3-digits">3. [Digits]</a>
</li>
<li class="toctree-l3"><a class="reference internal" href="#4-analog">4. [Analog]</a>
<li class="toctree-l4"><a class="reference internal" href="#4-analog">4. [Analog]</a>
</li>
<li class="toctree-l3"><a class="reference internal" href="#5-postprocessing">5. [PostProcessing]</a>
<li class="toctree-l4"><a class="reference internal" href="#5-postprocessing">5. [PostProcessing]</a>
</li>
<li class="toctree-l3"><a class="reference internal" href="#6-mqtt">6. [MQTT]</a>
<li class="toctree-l4"><a class="reference internal" href="#6-mqtt">6. [MQTT]</a>
</li>
<li class="toctree-l3"><a class="reference internal" href="#7-autotimer">7. [AutoTimer]</a>
<li class="toctree-l4"><a class="reference internal" href="#7-autotimer">7. [AutoTimer]</a>
</li>
<li class="toctree-l3"><a class="reference internal" href="#8-debug">8. [Debug]</a>
<li class="toctree-l4"><a class="reference internal" href="#8-debug">8. [Debug]</a>
</li>
<li class="toctree-l3"><a class="reference internal" href="#9-ende">9. [Ende]</a>
<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>
<ul>
<li class="toctree-l3"><a class="reference internal" href="#integration-into-home-assistant">Integration into Home Assistant</a>
</li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../Watermeter-specific-analog---digital-transition/">Analog/Digital Transition on Watermeters</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../Learn-models-with-your-own-images/">Learn a model with your own images</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../Correction%20Algorithm/">Correction Algorithm</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../Demo-Mode/">Demo Mode</a>
<li class="toctree-l1"><a class="reference internal" href="../Additional-Information/">Additional Information</a>
</li>
</ul>
<p class="caption"><span class="caption-text">Troubleshooting</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../Error-Codes/">Error Codes</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../Error-Debugging/">Error Debugging</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../External-LED/">External LED</a>
<li class="toctree-l1"><a class="reference internal" href="../Frequent-Reboots/">Frequent Reboots</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../Frequent%20Reboots/">Frequent reboots</a>
</ul>
<p class="caption"><span class="caption-text">API's</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../REST-API/">REST API</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../Gasmeter-Log-Downloader/">Gasmeter Log Downloader</a>
<li class="toctree-l1"><a class="reference internal" href="../MQTT-API/">MQTT API</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../Graphical-configuration/">Graphical configuration</a>
<li class="toctree-l1"><a class="reference internal" href="../Influx-DB/">Influx DB</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../Install-a-rolling-%28unstable%29-release/">:bangbang: Living on the edge :bangbang:</a>
</ul>
<p class="caption"><span class="caption-text">Development</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../Build-Instructions/">Build the Project</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../Integrated%20Functions/">Integrated Functions</a>
<li class="toctree-l1"><a class="reference internal" href="../Demo-Mode/">Demo Mode</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="../Learn-models-with-your-own-images/">Learn models with your own images</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../Migrate-Old-Config-To-New-Config/">Migration from water-meter „old“ to water-meter “AI-on-the-edge-device”</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---Update-Firmware-and-Web-Interface/">Over-The-Air (OTA) Update</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../ROI-Configuration/">ROI (Region of Interest) Configuration</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../Release-creation/">Release creation</a>
<li class="toctree-l1"><a class="reference internal" href="../Upload-files-by-script/">Scripted File Upload</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../Testing/">Testing</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../Watermeter-specific-analog---digital-transition/">Understanding the problem</a>
<li class="toctree-l1"><a class="reference internal" href="../Release-creation/">Preparing for Release</a>
</li>
</ul>
<p class="caption"><span class="caption-text">Old Pages (no longer maintained)</span></p>
<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/">Gasmeter 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">Asorted Pages</span></p>
<ul>
</ul>
</div>
</div>
</nav>
@@ -169,7 +192,7 @@
<div class="rst-content"><div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
<li><a href=".." class="icon icon-home" alt="Docs"></a> &raquo;</li>
<li>Asorted Pages &raquo;</li>
<li>Advanced &raquo;</li>
<li>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>
@@ -180,7 +203,12 @@
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div class="section" itemprop="articleBody">
<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>
<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>
</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 watermeter you can easily transfer the configuration to the new system by following the steps in this <a href="MigrateOldConfigToNew.md">migration description</a></p>
<h2 id="processing-configini-principle">Processing / Config.ini principle</h2>
@@ -236,7 +264,7 @@
</div><footer>
<div class="rst-footer-buttons" role="navigation" aria-label="Footer Navigation">
<a href="../Configuration-Parameter-Details/" class="btn btn-neutral float-left" title="Configuration Parameter Details"><span class="icon icon-circle-arrow-left"></span> Previous</a>
<a href="../Correction%20Algorithm/" class="btn btn-neutral float-right" title="Correction Algorithm">Next <span class="icon icon-circle-arrow-right"></span></a>
<a href="../Watermeter-specific-analog---digital-transition/" class="btn btn-neutral float-right" title="Analog/Digital Transition on Watermeters">Next <span class="icon icon-circle-arrow-right"></span></a>
</div>
<hr/>
@@ -266,7 +294,7 @@
<span><a href="../Configuration-Parameter-Details/" style="color: #fcfcfc">&laquo; Previous</a></span>
<span><a href="../Correction%20Algorithm/" style="color: #fcfcfc">Next &raquo;</a></span>
<span><a href="../Watermeter-specific-analog---digital-transition/" style="color: #fcfcfc">Next &raquo;</a></span>
</span>
</div>