Deployed bf5f821 with MkDocs version: 1.4.2

This commit is contained in:
github-actions[bot]
2023-01-03 07:12:06 +00:00
parent 2e0951bb11
commit bb134ac352
38 changed files with 910 additions and 628 deletions

View File

@@ -40,12 +40,40 @@
</div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
<p class="caption"><span class="caption-text">Getting Started</span></p>
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="..">Welcome</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../Installation/">Installation</a>
</li>
<li class="toctree-l1 current"><a class="reference internal current" href="./">Frequently Asked Questions</a>
<ul class="current">
<li class="toctree-l2"><a class="reference internal" href="#my-device-is-reboot-frequently-what-can-i-do">My device is reboot frequently. What can I do?</a>
<ul>
<li class="toctree-l3"><a class="reference internal" href="#how-accurate-are-the-detections">How accurate are the detections?</a>
</li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="#my-numbers-are-not-corrected-detected-what-can-i-do">My numbers are not corrected detected. What can I do?</a>
</li>
<li class="toctree-l2"><a class="reference internal" href="#how-can-i-ensure-invalid-numbers-are-never-reported">How can I ensure invalid numbers are never reported?</a>
</li>
<li class="toctree-l2"><a class="reference internal" href="#even-after-i-have-setup-everything-perfect-there-is-a-false-reading-especially-around-the-zero-crossing-roll-over-to-next-number">Even after I have setup everything perfect there is a false reading - especially around the zero crossing (roll over to next number)</a>
</li>
</ul>
</li>
</ul>
<p class="caption"><span class="caption-text">API's</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="..">Welcome to the AI-on-the-edge-device!</a>
</li>
<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>
<ul>
<li class="toctree-l1"><a class="" href="https://github.com/jomjol/AI-on-the-edge-device/releases">Releases</a>
</li>
<li class="toctree-l1"><a class="" href="https://jomjol.github.io/AI-on-the-edge-device/index.html">Web Installer/Console</a>
</li>
<li class="toctree-l1"><a class="" href="https://github.com/jomjol/AI-on-the-edge-device/issues">Place an Issues</a>
@@ -54,9 +82,7 @@
</li>
</ul>
<p class="caption"><span class="caption-text">Asorted Pages</span></p>
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="../AI-on-the-edge/">Welcome to the AI-on-the-edge-device wiki!</a>
</li>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../Addditional-Information/">Addditional Information</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../Best-Practice/">Best Practice</a>
@@ -78,20 +104,6 @@
<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>
<li class="toctree-l1 current"><a class="reference internal current" href="./">Frequently Asked Questions</a>
<ul class="current">
<li class="toctree-l2"><a class="reference internal" href="#my-device-is-reboot-frequently-what-can-i-do">My device is reboot frequently. What can I do?</a>
</li>
<li class="toctree-l2"><a class="reference internal" href="#how-accurate-are-the-detections">How accurate are the detections?</a>
</li>
<li class="toctree-l2"><a class="reference internal" href="#my-numbers-are-not-corrected-detected-what-can-i-do">My numbers are not corrected detected. What can I do?</a>
</li>
<li class="toctree-l2"><a class="reference internal" href="#how-can-i-ensure-invalid-numbers-are-never-reported">How can I ensure invalid numbers are never reported?</a>
</li>
<li class="toctree-l2"><a class="reference internal" href="#even-after-i-have-setup-everything-perfect-there-is-a-false-reading-especially-around-the-zero-crossing-roll-over-to-next-number">Even after I have setup everything perfect there is a false reading - especially around the zero crossing (roll over to next number)</a>
</li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../Frequent%20Reboots/">Frequent reboots</a>
</li>
@@ -103,24 +115,18 @@
</li>
<li class="toctree-l1"><a class="reference internal" href="../Install-a-rolling-%28unstable%29-release/">:bangbang: Living on the edge :bangbang:</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../Installation/">Installation</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../Integrated%20Functions/">Integrated Functions</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="../MQTT-API/">General Information</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="../REST-API/">REST API</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>
@@ -129,6 +135,8 @@
</li>
<li class="toctree-l1"><a class="reference internal" href="../Watermeter-specific-analog---digital-transition/">Understanding the problem</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../xxx%20old%20AI-on-the-edge/">(old) Welcome to the AI-on-the-edge-device wiki!</a>
</li>
</ul>
</div>
</div>
@@ -144,7 +152,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>Getting Started &raquo;</li>
<li>Frequently Asked Questions</li>
<li class="wy-breadcrumbs-aside">
<a href="https://github.com/jomjol/AI-on-the-edge-device-docs/edit/main/doc/FAQs.md" class="icon icon-github"> Edit on GitHub</a>
@@ -156,7 +164,7 @@
<div class="section" itemprop="articleBody">
<h1 id="frequently-asked-questions">Frequently Asked Questions</h1>
<h4 id="my-device-is-reboot-frequently-what-can-i-do">My device is reboot frequently. What can I do?</h4>
<h2 id="my-device-is-reboot-frequently-what-can-i-do">My device is reboot frequently. What can I do?</h2>
<p>There are several reasons for the reboot:</p>
<ul>
<li>Frequent HTML requests</li>
@@ -164,7 +172,7 @@
<li>Unstable hardware - see [[Hardware Compatibility]]</li>
</ul>
<p>There is a dedicated Wiki page about this: [[Frequent Reboots]]</p>
<h4 id="how-accurate-are-the-detections">How accurate are the detections?</h4>
<h3 id="how-accurate-are-the-detections">How accurate are the detections?</h3>
<p>It is hard to give a specific accuracy number. It depends on many factors, e.g.</p>
<ul>
<li>How in-focus is your camera?</li>
@@ -175,19 +183,19 @@
</ul>
<p>Anecdotally, the authors of this wiki have great success with the meter. While the AI algorithm itself is not perfect and sometimes returns <code>NaN</code> or incorrect values, other post-processing / prevalue / sanity checks help ensure such invalid values are filtered out. With the correct settings, one author has been running this device for 1 month without any incorrect values reported. </p>
<p>See the FAQs below for more details and configuration hints.</p>
<h4 id="my-numbers-are-not-corrected-detected-what-can-i-do">My numbers are not corrected detected. What can I do?</h4>
<h2 id="my-numbers-are-not-corrected-detected-what-can-i-do">My numbers are not corrected detected. What can I do?</h2>
<ul>
<li>There is a dedicated Wiki page about the correct setting [[ROI Configuration]]</li>
<li>This page also includes the instructions for gathering new images for the training.</li>
</ul>
<h4 id="how-can-i-ensure-invalid-numbers-are-never-reported">How can I ensure invalid numbers are never reported?</h4>
<h2 id="how-can-i-ensure-invalid-numbers-are-never-reported">How can I ensure invalid numbers are never reported?</h2>
<p>As mentioned above, the AI algorithm is not perfect. Sometimes it may read an incorrect value.</p>
<p>We can tune the software to <em>almost</em> never report an incorrect value. There is a tradeoff though: the software may report <em>stale</em> values - i.e. it will drop incorrect values for a potentially long period of time, resulting in the meter reading being outdated by hours. If never receiving an incorrect value is important to you, consider tolerating this tradeoff.</p>
<p>You can change the following settings to reduce incorrect readings (but potentially increase staleness of data):
* Set a prevalue via the UI, then change <code>PostProcessing</code> configuration option <code>PreValueAgeStartup</code> to a much larger number (e.g. <code>43200</code> = 30 days).
* Change <code>PostProcessing</code> configuration option <code>MaxRateType</code> to be time based instead of absolute. Set <code>MaxRateValue</code> to something realistic (e.g. <code>5</code> gal/min). You can often find the max flow rate your meter supports directly on the cover.
* Reduce <code>AutoTimer</code> configuration option <code>Intervall</code> to the lowest it can be (e.g. <code>3</code> min). The more often you take readings, the less likely for data staleness to occur.</p>
<h4 id="even-after-i-have-setup-everything-perfect-there-is-a-false-reading-especially-around-the-zero-crossing-roll-over-to-next-number">Even after I have setup everything perfect there is a false reading - especially around the zero crossing (roll over to next number)</h4>
<h2 id="even-after-i-have-setup-everything-perfect-there-is-a-false-reading-especially-around-the-zero-crossing-roll-over-to-next-number">Even after I have setup everything perfect there is a false reading - especially around the zero crossing (roll over to next number)</h2>
<ul>
<li>The roll over behavior is different for the different meters. E.g.:</li>
<li>Rolling over start with different previous position (e.g. at 7, 8 or 9)</li>
@@ -213,8 +221,8 @@
</div>
</div><footer>
<div class="rst-footer-buttons" role="navigation" aria-label="Footer Navigation">
<a href="../External-LED/" class="btn btn-neutral float-left" title="External LED"><span class="icon icon-circle-arrow-left"></span> Previous</a>
<a href="../Frequent%20Reboots/" class="btn btn-neutral float-right" title="Frequent reboots">Next <span class="icon icon-circle-arrow-right"></span></a>
<a href="../Installation/" class="btn btn-neutral float-left" title="Installation"><span class="icon icon-circle-arrow-left"></span> Previous</a>
<a href="../REST-API/" class="btn btn-neutral float-right" title="REST API">Next <span class="icon icon-circle-arrow-right"></span></a>
</div>
<hr/>
@@ -241,10 +249,10 @@
</span>
<span><a href="../External-LED/" style="color: #fcfcfc">&laquo; Previous</a></span>
<span><a href="../Installation/" style="color: #fcfcfc">&laquo; Previous</a></span>
<span><a href="../Frequent%20Reboots/" style="color: #fcfcfc">Next &raquo;</a></span>
<span><a href="../REST-API/" style="color: #fcfcfc">Next &raquo;</a></span>
</span>
</div>