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-08 12:36:54 +03:00
Code Issues Packages Projects Releases Wiki Activity

Deployed 9d5db6c with MkDocs version: 1.4.2

Browse Source
This commit is contained in:
github-actions[bot]
2023-02-22 08:34:56 +00:00
parent 2fcb11194a
commit 487fd4583e
5 changed files with 124 additions and 403 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -336,6 +336,7 @@ This would return:</p>
</code></pre>
<p>To do such a REST call, you need to create a REST sensor:</p>
<pre><code class="language-yaml">sensor:
- platform: rest
name: &quot;Gasmeter JSON&quot;
resource: http://&lt;IP&gt;/json

454
Parameters/index.html
View File

@@ -86,199 +86,17 @@
<ul class="current">
<li class="toctree-l1 current"><a class="reference internal current" href="./">Parameters</a>
<ul class="current">
<li class="toctree-l2"><a class="reference internal" href="#list-of-all-parameters">List of all Parameters</a>
<li class="toctree-l2"><a class="reference internal" href="#parameter-alignmentalgo">Parameter AlignmentAlgo</a>
</li>
<li class="toctree-l2"><a class="reference internal" href="#section-alignment">Section Alignment</a>
<ul>
<li class="toctree-l3"><a class="reference internal" href="#parameter-alignmentalgo">Parameter AlignmentAlgo</a>
<li class="toctree-l2"><a class="reference internal" href="#parameter-flipimagesize">Parameter FlipImageSize</a>
</li>
<li class="toctree-l3"><a class="reference internal" href="#parameter-flipimagesize">Parameter FlipImageSize</a>
<li class="toctree-l2"><a class="reference internal" href="#parameter-initialmirror">Parameter InitialMirror</a>
</li>
<li class="toctree-l3"><a class="reference internal" href="#parameter-initialmirror">Parameter InitialMirror</a>
<li class="toctree-l2"><a class="reference internal" href="#parameter-initialrotate">Parameter InitialRotate</a>
</li>
<li class="toctree-l3"><a class="reference internal" href="#parameter-initialrotate">Parameter InitialRotate</a>
<li class="toctree-l2"><a class="reference internal" href="#parameter-searchfieldx">Parameter SearchFieldX</a>
</li>
<li class="toctree-l3"><a class="reference internal" href="#parameter-searchfieldx">Parameter SearchFieldX</a>
</li>
<li class="toctree-l3"><a class="reference internal" href="#parameter-searchfieldy">Parameter SearchFieldY</a>
</li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="#section-analog">Section Analog</a>
<ul>
<li class="toctree-l3"><a class="reference internal" href="#parameter-cnngoodthreshold">Parameter CNNGoodThreshold</a>
</li>
<li class="toctree-l3"><a class="reference internal" href="#parameter-extendedresolution">Parameter ExtendedResolution</a>
</li>
<li class="toctree-l3"><a class="reference internal" href="#parameter-model">Parameter Model</a>
</li>
<li class="toctree-l3"><a class="reference internal" href="#parameter-roiimageslocation">Parameter ROIImagesLocation</a>
</li>
<li class="toctree-l3"><a class="reference internal" href="#parameter-roiimagesretention">Parameter ROIImagesRetention</a>
</li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="#section-autotimer">Section AutoTimer</a>
<ul>
<li class="toctree-l3"><a class="reference internal" href="#parameter-autostart">Parameter AutoStart</a>
</li>
<li class="toctree-l3"><a class="reference internal" href="#parameter-interval">Parameter Interval</a>
</li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="#section-datalogging">Section DataLogging</a>
<ul>
<li class="toctree-l3"><a class="reference internal" href="#parameter-datafilesretention">Parameter DataFilesRetention</a>
</li>
<li class="toctree-l3"><a class="reference internal" href="#parameter-datalogactive">Parameter DataLogActive</a>
</li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="#section-debug">Section Debug</a>
<ul>
<li class="toctree-l3"><a class="reference internal" href="#parameter-loglevel">Parameter LogLevel</a>
</li>
<li class="toctree-l3"><a class="reference internal" href="#parameter-logfilesretention">Parameter LogfilesRetention</a>
</li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="#section-digits">Section Digits</a>
<ul>
<li class="toctree-l3"><a class="reference internal" href="#parameter-cnngoodthreshold_1">Parameter CNNGoodThreshold</a>
</li>
<li class="toctree-l3"><a class="reference internal" href="#parameter-model_1">Parameter Model</a>
</li>
<li class="toctree-l3"><a class="reference internal" href="#parameter-roiimageslocation_1">Parameter ROIImagesLocation</a>
</li>
<li class="toctree-l3"><a class="reference internal" href="#parameter-roiimagesretention_1">Parameter ROIImagesRetention</a>
</li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="#section-gpio">Section GPIO</a>
<ul>
<li class="toctree-l3"><a class="reference internal" href="#parameter-io0">Parameter IO0</a>
</li>
<li class="toctree-l3"><a class="reference internal" href="#parameter-io1">Parameter IO1</a>
</li>
<li class="toctree-l3"><a class="reference internal" href="#parameter-io12">Parameter IO12</a>
</li>
<li class="toctree-l3"><a class="reference internal" href="#parameter-io13">Parameter IO13</a>
</li>
<li class="toctree-l3"><a class="reference internal" href="#parameter-io3">Parameter IO3</a>
</li>
<li class="toctree-l3"><a class="reference internal" href="#parameter-io4">Parameter IO4</a>
</li>
<li class="toctree-l3"><a class="reference internal" href="#parameter-ledcolor">Parameter LEDColor</a>
</li>
<li class="toctree-l3"><a class="reference internal" href="#parameter-lednumbers">Parameter LEDNumbers</a>
</li>
<li class="toctree-l3"><a class="reference internal" href="#parameter-ledtype">Parameter LEDType</a>
</li>
<li class="toctree-l3"><a class="reference internal" href="#parameter-maintopicmqtt">Parameter MainTopicMQTT</a>
</li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="#section-influxdb">Section InfluxDB</a>
<ul>
<li class="toctree-l3"><a class="reference internal" href="#parameter-database">Parameter Database</a>
</li>
<li class="toctree-l3"><a class="reference internal" href="#parameter-measurement">Parameter Measurement</a>
</li>
<li class="toctree-l3"><a class="reference internal" href="#parameter-uri">Parameter Uri</a>
</li>
<li class="toctree-l3"><a class="reference internal" href="#parameter-password">Parameter password</a>
</li>
<li class="toctree-l3"><a class="reference internal" href="#parameter-user">Parameter user</a>
</li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="#section-mqtt">Section MQTT</a>
<ul>
<li class="toctree-l3"><a class="reference internal" href="#parameter-clientid">Parameter ClientID</a>
</li>
<li class="toctree-l3"><a class="reference internal" href="#parameter-homeassistantdiscovery">Parameter HomeassistantDiscovery</a>
</li>
<li class="toctree-l3"><a class="reference internal" href="#parameter-maintopic">Parameter MainTopic</a>
</li>
<li class="toctree-l3"><a class="reference internal" href="#parameter-metertype">Parameter MeterType</a>
</li>
<li class="toctree-l3"><a class="reference internal" href="#parameter-retainmessages">Parameter RetainMessages</a>
</li>
<li class="toctree-l3"><a class="reference internal" href="#parameter-uri_1">Parameter Uri</a>
</li>
<li class="toctree-l3"><a class="reference internal" href="#parameter-password_1">Parameter password</a>
</li>
<li class="toctree-l3"><a class="reference internal" href="#parameter-user_1">Parameter user</a>
</li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="#section-postprocessing">Section PostProcessing</a>
<ul>
<li class="toctree-l3"><a class="reference internal" href="#parameter-allownegativerates">Parameter AllowNegativeRates</a>
</li>
<li class="toctree-l3"><a class="reference internal" href="#parameter-checkdigitincreaseconsistency">Parameter CheckDigitIncreaseConsistency</a>
</li>
<li class="toctree-l3"><a class="reference internal" href="#parameter-errormessage">Parameter ErrorMessage</a>
</li>
<li class="toctree-l3"><a class="reference internal" href="#parameter-numbersallownegativerates">Parameter &lt;NUMBERS&gt;.AllowNegativeRates</a>
</li>
<li class="toctree-l3"><a class="reference internal" href="#parameter-numberanalogdigitaltransitionstart">Parameter &lt;NUMBER&gt;.AnalogDigitalTransitionStart</a>
</li>
<li class="toctree-l3"><a class="reference internal" href="#parameter-numberdecimalshift">Parameter &lt;NUMBER&gt;.DecimalShift</a>
</li>
<li class="toctree-l3"><a class="reference internal" href="#parameter-numberextendedresolution">Parameter &lt;NUMBER&gt;.ExtendedResolution</a>
</li>
<li class="toctree-l3"><a class="reference internal" href="#parameter-numberignoreleadingnan">Parameter &lt;NUMBER&gt;.IgnoreLeadingNaN</a>
</li>
<li class="toctree-l3"><a class="reference internal" href="#parameter-numbermaxratetype">Parameter &lt;NUMBER&gt;.MaxRateType</a>
</li>
<li class="toctree-l3"><a class="reference internal" href="#parameter-numbermaxratevalue">Parameter &lt;NUMBER&gt;.MaxRateValue</a>
</li>
<li class="toctree-l3"><a class="reference internal" href="#parameter-prevalueagestartup">Parameter PreValueAgeStartup</a>
</li>
<li class="toctree-l3"><a class="reference internal" href="#parameter-prevalueuse">Parameter PreValueUse</a>
</li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="#section-system">Section System</a>
<ul>
<li class="toctree-l3"><a class="reference internal" href="#parameter-hostname">Parameter Hostname</a>
</li>
<li class="toctree-l3"><a class="reference internal" href="#parameter-rssithreshold">Parameter RSSIThreshold</a>
</li>
<li class="toctree-l3"><a class="reference internal" href="#parameter-setupmode">Parameter SetupMode</a>
</li>
<li class="toctree-l3"><a class="reference internal" href="#parameter-timeserver">Parameter TimeServer</a>
</li>
<li class="toctree-l3"><a class="reference internal" href="#parameter-timezone">Parameter TimeZone</a>
</li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="#section-takeimage">Section TakeImage</a>
<ul>
<li class="toctree-l3"><a class="reference internal" href="#parameter-brightness">Parameter Brightness</a>
</li>
<li class="toctree-l3"><a class="reference internal" href="#parameter-contrast">Parameter Contrast</a>
</li>
<li class="toctree-l3"><a class="reference internal" href="#parameter-demo">Parameter Demo</a>
</li>
<li class="toctree-l3"><a class="reference internal" href="#parameter-fixedexposure">Parameter FixedExposure</a>
</li>
<li class="toctree-l3"><a class="reference internal" href="#parameter-imagequality">Parameter ImageQuality</a>
</li>
<li class="toctree-l3"><a class="reference internal" href="#parameter-imagesize">Parameter ImageSize</a>
</li>
<li class="toctree-l3"><a class="reference internal" href="#parameter-ledintensity">Parameter LEDIntensity</a>
</li>
<li class="toctree-l3"><a class="reference internal" href="#parameter-rawimageslocation">Parameter RawImagesLocation</a>
</li>
<li class="toctree-l3"><a class="reference internal" href="#parameter-rawimagesretention">Parameter RawImagesRetention</a>
</li>
<li class="toctree-l3"><a class="reference internal" href="#parameter-saturation">Parameter Saturation</a>
</li>
<li class="toctree-l3"><a class="reference internal" href="#parameter-waitbeforetakingpicture">Parameter WaitBeforeTakingPicture</a>
</li>
</ul>
<li class="toctree-l2"><a class="reference internal" href="#parameter-searchfieldy">Parameter SearchFieldY</a>
</li>
</ul>
</li>
@@ -367,125 +185,7 @@
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div class="section" itemprop="articleBody">
<h1 id="parameters">Parameters</h1>
<p>This page lists all available <a href="../Configuration">Configuration</a> Parameters.
If a parameter or section 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">
<p class="admonition-title">Note</p>
<p>This is an auto-generated page! See the <a href="https://github.com/jomjol/AI-on-the-edge-device-docs/blob/main/README.md">README</a> for details!</p>
</div>
<h2 id="list-of-all-parameters">List of all Parameters</h2>
<p><a href="#alignment">Alignment</a></p>
<ul>
<li><a href="#Alignment-AlignmentAlgo"><code>AlignmentAlgo</code></a></li>
<li><a href="#Alignment-FlipImageSize"><code>FlipImageSize</code></a></li>
<li><a href="#Alignment-InitialMirror"><code>InitialMirror</code></a></li>
<li><a href="#Alignment-InitialRotate"><code>InitialRotate</code></a></li>
<li><a href="#Alignment-SearchFieldX"><code>SearchFieldX</code></a></li>
<li><a href="#Alignment-SearchFieldY"><code>SearchFieldY</code></a></li>
</ul>
<p><a href="#analog">Analog</a></p>
<ul>
<li><a href="#Analog-CNNGoodThreshold"><code>CNNGoodThreshold</code></a></li>
<li><a href="#Analog-ExtendedResolution"><code>ExtendedResolution</code></a></li>
<li><a href="#Analog-Model"><code>Model</code></a></li>
<li><a href="#Analog-ROIImagesLocation"><code>ROIImagesLocation</code></a></li>
<li><a href="#Analog-ROIImagesRetention"><code>ROIImagesRetention</code></a></li>
</ul>
<p><a href="#autotimer">AutoTimer</a></p>
<ul>
<li><a href="#AutoTimer-AutoStart"><code>AutoStart</code></a></li>
<li><a href="#AutoTimer-Interval"><code>Interval</code></a></li>
</ul>
<p><a href="#datalogging">DataLogging</a></p>
<ul>
<li><a href="#DataLogging-DataFilesRetention"><code>DataFilesRetention</code></a></li>
<li><a href="#DataLogging-DataLogActive"><code>DataLogActive</code></a></li>
</ul>
<p><a href="#debug">Debug</a></p>
<ul>
<li><a href="#Debug-LogLevel"><code>LogLevel</code></a></li>
<li><a href="#Debug-LogfilesRetention"><code>LogfilesRetention</code></a></li>
</ul>
<p><a href="#digits">Digits</a></p>
<ul>
<li><a href="#Digits-CNNGoodThreshold"><code>CNNGoodThreshold</code></a></li>
<li><a href="#Digits-Model"><code>Model</code></a></li>
<li><a href="#Digits-ROIImagesLocation"><code>ROIImagesLocation</code></a></li>
<li><a href="#Digits-ROIImagesRetention"><code>ROIImagesRetention</code></a></li>
</ul>
<p><a href="#gpio">GPIO</a></p>
<ul>
<li><a href="#GPIO-IO0"><code>IO0</code></a></li>
<li><a href="#GPIO-IO1"><code>IO1</code></a></li>
<li><a href="#GPIO-IO12"><code>IO12</code></a></li>
<li><a href="#GPIO-IO13"><code>IO13</code></a></li>
<li><a href="#GPIO-IO3"><code>IO3</code></a></li>
<li><a href="#GPIO-IO4"><code>IO4</code></a></li>
<li><a href="#GPIO-LEDColor"><code>LEDColor</code></a></li>
<li><a href="#GPIO-LEDNumbers"><code>LEDNumbers</code></a></li>
<li><a href="#GPIO-LEDType"><code>LEDType</code></a></li>
<li><a href="#GPIO-MainTopicMQTT"><code>MainTopicMQTT</code></a></li>
</ul>
<p><a href="#influxdb">InfluxDB</a></p>
<ul>
<li><a href="#InfluxDB-Database"><code>Database</code></a></li>
<li><a href="#InfluxDB-Measurement"><code>Measurement</code></a></li>
<li><a href="#InfluxDB-Uri"><code>Uri</code></a></li>
<li><a href="#InfluxDB-password"><code>password</code></a></li>
<li><a href="#InfluxDB-user"><code>user</code></a></li>
</ul>
<p><a href="#mqtt">MQTT</a></p>
<ul>
<li><a href="#MQTT-ClientID"><code>ClientID</code></a></li>
<li><a href="#MQTT-HomeassistantDiscovery"><code>HomeassistantDiscovery</code></a></li>
<li><a href="#MQTT-MainTopic"><code>MainTopic</code></a></li>
<li><a href="#MQTT-MeterType"><code>MeterType</code></a></li>
<li><a href="#MQTT-RetainMessages"><code>RetainMessages</code></a></li>
<li><a href="#MQTT-Uri"><code>Uri</code></a></li>
<li><a href="#MQTT-password"><code>password</code></a></li>
<li><a href="#MQTT-user"><code>user</code></a></li>
</ul>
<p><a href="#postprocessing">PostProcessing</a></p>
<ul>
<li><a href="#PostProcessing-AllowNegativeRates"><code>AllowNegativeRates</code></a></li>
<li><a href="#PostProcessing-CheckDigitIncreaseConsistency"><code>CheckDigitIncreaseConsistency</code></a></li>
<li><a href="#PostProcessing-ErrorMessage"><code>ErrorMessage</code></a></li>
<li><a href="#PostProcessing-NUMBER.AllowNegativeRates"><code>NUMBER.AllowNegativeRates</code></a></li>
<li><a href="#PostProcessing-NUMBER.AnalogDigitalTransitionStart"><code>NUMBER.AnalogDigitalTransitionStart</code></a></li>
<li><a href="#PostProcessing-NUMBER.DecimalShift"><code>NUMBER.DecimalShift</code></a></li>
<li><a href="#PostProcessing-NUMBER.ExtendedResolution"><code>NUMBER.ExtendedResolution</code></a></li>
<li><a href="#PostProcessing-NUMBER.IgnoreLeadingNaN"><code>NUMBER.IgnoreLeadingNaN</code></a></li>
<li><a href="#PostProcessing-NUMBER.MaxRateType"><code>NUMBER.MaxRateType</code></a></li>
<li><a href="#PostProcessing-NUMBER.MaxRateValue"><code>NUMBER.MaxRateValue</code></a></li>
<li><a href="#PostProcessing-PreValueAgeStartup"><code>PreValueAgeStartup</code></a></li>
<li><a href="#PostProcessing-PreValueUse"><code>PreValueUse</code></a></li>
</ul>
<p><a href="#system">System</a></p>
<ul>
<li><a href="#System-Hostname"><code>Hostname</code></a></li>
<li><a href="#System-RSSIThreshold"><code>RSSIThreshold</code></a></li>
<li><a href="#System-SetupMode"><code>SetupMode</code></a></li>
<li><a href="#System-TimeServer"><code>TimeServer</code></a></li>
<li><a href="#System-TimeZone"><code>TimeZone</code></a></li>
</ul>
<p><a href="#takeimage">TakeImage</a></p>
<ul>
<li><a href="#TakeImage-Brightness"><code>Brightness</code></a></li>
<li><a href="#TakeImage-Contrast"><code>Contrast</code></a></li>
<li><a href="#TakeImage-Demo"><code>Demo</code></a></li>
<li><a href="#TakeImage-FixedExposure"><code>FixedExposure</code></a></li>
<li><a href="#TakeImage-ImageQuality"><code>ImageQuality</code></a></li>
<li><a href="#TakeImage-ImageSize"><code>ImageSize</code></a></li>
<li><a href="#TakeImage-LEDIntensity"><code>LEDIntensity</code></a></li>
<li><a href="#TakeImage-RawImagesLocation"><code>RawImagesLocation</code></a></li>
<li><a href="#TakeImage-RawImagesRetention"><code>RawImagesRetention</code></a></li>
<li><a href="#TakeImage-Saturation"><code>Saturation</code></a></li>
<li><a href="#TakeImage-WaitBeforeTakingPicture"><code>WaitBeforeTakingPicture</code></a></li>
</ul>
<hr style="border:2px solid">
<h2 id="section-alignment">Section <code>Alignment</code></h2>
<h2 id="section-alignment">Section <code>Alignment</code></h2>
<p><a id=Alignment-AlignmentAlgo></a></p>
<h3 id="parameter-alignmentalgo">Parameter <code>AlignmentAlgo</code></h3>
<p>Default Value: <code>Default</code></p>
@@ -494,10 +194,12 @@ In such case the functionality gets disabled respectively the default values wil
<p>This is an <strong>Expert Parameter</strong>! Only change it if you understand what it does!</p>
</div>
<p>Algorithm used for the alignment step.
Available options:
- <code>Default</code>: Use only red color channel
- <code>HighAccuracy</code>: Use all 3 color Channels (3x slower)
- <code>Fast</code>: First time use <code>HighAccuracy</code>, then only check if the image is shifted</p>
Available options:</p>
<ul>
<li><code>Default</code>: Use only red color channel</li>
<li><code>HighAccuracy</code>: Use all 3 color Channels (3x slower)</li>
<li><code>Fast</code>: First time use <code>HighAccuracy</code>, then only check if the image is shifted</li>
</ul>
<hr style="border:2px solid">
<p><a id=Alignment-FlipImageSize></a></p>
@@ -665,12 +367,14 @@ Activate data logging to the SD-Card.</p>
<h3 id="parameter-loglevel">Parameter <code>LogLevel</code></h3>
<p>Default Value: <code>1</code> (<code>ERROR</code>)
Define the log level for the logging to the SD-Card.
Available options:
- <code>1</code>: <code>ERROR</code>
- <code>2</code>: <code>WARNING</code>
- <code>3</code>: <code>INFO</code>
- <code>4</code>: <code>DEBUG</code>
As higher the level, as more log messages get written to the SD-Card.</p>
Available options:</p>
<ul>
<li><code>1</code>: <code>ERROR</code></li>
<li><code>2</code>: <code>WARNING</code></li>
<li><code>3</code>: <code>INFO</code></li>
<li><code>4</code>: <code>DEBUG</code>
As higher the level, as more log messages get written to the SD-Card.</li>
</ul>
<div class="admonition warning">
<p class="admonition-title">Warning</p>
<p><code>DEBUG</code> or <code>INFO</code> might damage the SD-Card if enabled long term due to excessive writes to the SD-Card!
@@ -738,13 +442,15 @@ Location to store separated digit images on the SD-Card for logging.</p>
It must be disabled when the camera is used.
Additionally, it is used to activate Bootloader mode and must therefore be HIGH after a reset!</p>
</div>
<p>Parameters:
- <code>GPIO 0 state</code>: One of <code>input</code>, <code>input pullup</code>, <code>input pulldown</code> or <code>output</code>.
- <code>GPIO 0 use interrupt</code>: Enable interrupt trigger
- <code>GPIO 0 PWM duty resolution</code>: LEDC PWM duty resolution in bit
- <code>GPIO 0 enable MQTT</code>: Enable MQTT publishing/subscribing
- <code>GPIO 0 enable HTTP</code>: Enable HTTP write/read
- <code>GPIO 0 name</code>: MQTT topic name (empty = <code>GPIO0</code>). Allowed characters: <code>a-z, A-Z, 0-9, _, -</code>.</p>
<p>Parameters:</p>
<ul>
<li><code>GPIO 0 state</code>: One of <code>input</code>, <code>input pullup</code>, <code>input pulldown</code> or <code>output</code>.</li>
<li><code>GPIO 0 use interrupt</code>: Enable interrupt trigger</li>
<li><code>GPIO 0 PWM duty resolution</code>: LEDC PWM duty resolution in bit</li>
<li><code>GPIO 0 enable MQTT</code>: Enable MQTT publishing/subscribing</li>
<li><code>GPIO 0 enable HTTP</code>: Enable HTTP write/read</li>
<li><code>GPIO 0 name</code>: MQTT topic name (empty = <code>GPIO0</code>). Allowed characters: <code>a-z, A-Z, 0-9, _, -</code>.</li>
</ul>
<hr style="border:2px solid">
<p><a id=GPIO-IO1></a></p>
@@ -759,13 +465,15 @@ Additionally, it is used to activate Bootloader mode and must therefore be HIGH
<p class="admonition-title">Warning</p>
<p>This pin is by default used for the serial communication as TX pin (USB logging)!</p>
</div>
<p>Parameters:
- <code>GPIO 1 state</code>: One of <code>input</code>, <code>input pullup</code>, <code>input pulldown</code> or <code>output</code>.
- <code>GPIO 1 use interrupt</code>: Enable interrupt trigger
- <code>GPIO 1 PWM duty resolution</code>: LEDC PWM duty resolution in bit
- <code>GPIO 1 enable MQTT</code>: Enable MQTT publishing/subscribing
- <code>GPIO 1 enable HTTP</code>: Enable HTTP write/read
- <code>GPIO 1 name</code>: MQTT topic name (empty = <code>GPIO1</code>). Allowed characters: <code>a-z, A-Z, 0-9, _, -</code>.</p>
<p>Parameters:</p>
<ul>
<li><code>GPIO 1 state</code>: One of <code>input</code>, <code>input pullup</code>, <code>input pulldown</code> or <code>output</code>.</li>
<li><code>GPIO 1 use interrupt</code>: Enable interrupt trigger</li>
<li><code>GPIO 1 PWM duty resolution</code>: LEDC PWM duty resolution in bit</li>
<li><code>GPIO 1 enable MQTT</code>: Enable MQTT publishing/subscribing</li>
<li><code>GPIO 1 enable HTTP</code>: Enable HTTP write/read</li>
<li><code>GPIO 1 name</code>: MQTT topic name (empty = <code>GPIO1</code>). Allowed characters: <code>a-z, A-Z, 0-9, _, -</code>.</li>
</ul>
<hr style="border:2px solid">
<p><a id=GPIO-IO12></a></p>
@@ -780,13 +488,15 @@ Additionally, it is used to activate Bootloader mode and must therefore be HIGH
<p class="admonition-title">Note</p>
<p>This pin is usable without known restrictions!</p>
</div>
<p>Parameters:
- <code>GPIO 12 state</code>: One of <code>external-flash-ws281x</code>, <code>input</code>, <code>input pullup</code>, <code>input pulldown</code> or <code>output</code>.
- <code>GPIO 12 use interrupt</code>: Enable interrupt trigger
- <code>GPIO 12 PWM duty resolution</code>: LEDC PWM duty resolution in bit
- <code>GPIO 12 enable MQTT</code>: Enable MQTT publishing/subscribing
- <code>GPIO 12 enable HTTP</code>: Enable HTTP write/read
- <code>GPIO 12 name</code>: MQTT topic name (empty = <code>GPIO12</code>). Allowed characters: <code>a-z, A-Z, 0-9, _, -</code>.</p>
<p>Parameters:</p>
<ul>
<li><code>GPIO 12 state</code>: One of <code>external-flash-ws281x</code>, <code>input</code>, <code>input pullup</code>, <code>input pulldown</code> or <code>output</code>.</li>
<li><code>GPIO 12 use interrupt</code>: Enable interrupt trigger</li>
<li><code>GPIO 12 PWM duty resolution</code>: LEDC PWM duty resolution in bit</li>
<li><code>GPIO 12 enable MQTT</code>: Enable MQTT publishing/subscribing</li>
<li><code>GPIO 12 enable HTTP</code>: Enable HTTP write/read</li>
<li><code>GPIO 12 name</code>: MQTT topic name (empty = <code>GPIO12</code>). Allowed characters: <code>a-z, A-Z, 0-9, _, -</code>.</li>
</ul>
<hr style="border:2px solid">
<p><a id=GPIO-IO13></a></p>
@@ -801,13 +511,15 @@ Additionally, it is used to activate Bootloader mode and must therefore be HIGH
<p class="admonition-title">Note</p>
<p>This pin is usable without known restrictions!</p>
</div>
<p>Parameters:
- <code>GPIO 13 state</code>: One of <code>input</code>, <code>input pullup</code>, <code>input pulldown</code> or <code>output</code>.
- <code>GPIO 13 use interrupt</code>: Enable interrupt trigger
- <code>GPIO 13 PWM duty resolution</code>: LEDC PWM duty resolution in bit
- <code>GPIO 13 enable MQTT</code>: Enable MQTT publishing/subscribing
- <code>GPIO 13 enable HTTP</code>: Enable HTTP write/read
- <code>GPIO 13 name</code>: MQTT topic name (empty = <code>GPIO13</code>). Allowed characters: <code>a-z, A-Z, 0-9, _, -</code>.</p>
<p>Parameters:</p>
<ul>
<li><code>GPIO 13 state</code>: One of <code>input</code>, <code>input pullup</code>, <code>input pulldown</code> or <code>output</code>.</li>
<li><code>GPIO 13 use interrupt</code>: Enable interrupt trigger</li>
<li><code>GPIO 13 PWM duty resolution</code>: LEDC PWM duty resolution in bit</li>
<li><code>GPIO 13 enable MQTT</code>: Enable MQTT publishing/subscribing</li>
<li><code>GPIO 13 enable HTTP</code>: Enable HTTP write/read</li>
<li><code>GPIO 13 name</code>: MQTT topic name (empty = <code>GPIO13</code>). Allowed characters: <code>a-z, A-Z, 0-9, _, -</code>.</li>
</ul>
<hr style="border:2px solid">
<p><a id=GPIO-IO3></a></p>
@@ -822,13 +534,15 @@ Additionally, it is used to activate Bootloader mode and must therefore be HIGH
<p class="admonition-title">Warning</p>
<p>This pin is by default used for the serial communication as RX pin (USB logging)!</p>
</div>
<p>Parameters:
- <code>GPIO 3 state</code>: One of <code>input</code>, <code>input pullup</code>, <code>input pulldown</code> or <code>output</code>.
- <code>GPIO 3 use interrupt</code>: Enable interrupt trigger
- <code>GPIO 3 PWM duty resolution</code>: LEDC PWM duty resolution in bit
- <code>GPIO 3 enable MQTT</code>: Enable MQTT publishing/subscribing
- <code>GPIO 3 enable HTTP</code>: Enable HTTP write/read
- <code>GPIO 3 name</code>: MQTT topic name (empty = <code>GPIO3</code>). Allowed characters: <code>a-z, A-Z, 0-9, _, -</code>.</p>
<p>Parameters:</p>
<ul>
<li><code>GPIO 3 state</code>: One of <code>input</code>, <code>input pullup</code>, <code>input pulldown</code> or <code>output</code>.</li>
<li><code>GPIO 3 use interrupt</code>: Enable interrupt trigger</li>
<li><code>GPIO 3 PWM duty resolution</code>: LEDC PWM duty resolution in bit</li>
<li><code>GPIO 3 enable MQTT</code>: Enable MQTT publishing/subscribing</li>
<li><code>GPIO 3 enable HTTP</code>: Enable HTTP write/read</li>
<li><code>GPIO 3 name</code>: MQTT topic name (empty = <code>GPIO3</code>). Allowed characters: <code>a-z, A-Z, 0-9, _, -</code>.</li>
</ul>
<hr style="border:2px solid">
<p><a id=GPIO-IO4></a></p>
@@ -844,13 +558,15 @@ Additionally, it is used to activate Bootloader mode and must therefore be HIGH
<p>This pin is only usable with restrictions!
By default, it is used for build-in flash light (onboard LED).</p>
</div>
<p>Parameters:
- <code>GPIO 4 state</code>: One of <code>built-in-led</code>, <code>input</code>, <code>input pullup</code>, <code>input pulldown</code> or <code>output</code>.
- <code>GPIO 4 use interrupt</code>: Enable interrupt trigger
- <code>GPIO 4 PWM duty resolution</code>: LEDC PWM duty resolution in bit
- <code>GPIO 4 enable MQTT</code>: Enable MQTT publishing/subscribing
- <code>GPIO 4 enable HTTP</code>: Enable HTTP write/read
- <code>GPIO 4 name</code>: MQTT topic name (empty = <code>GPIO4</code>). Allowed characters: <code>a-z, A-Z, 0-9, _, -</code>.</p>
<p>Parameters:</p>
<ul>
<li><code>GPIO 4 state</code>: One of <code>built-in-led</code>, <code>input</code>, <code>input pullup</code>, <code>input pulldown</code> or <code>output</code>.</li>
<li><code>GPIO 4 use interrupt</code>: Enable interrupt trigger</li>
<li><code>GPIO 4 PWM duty resolution</code>: LEDC PWM duty resolution in bit</li>
<li><code>GPIO 4 enable MQTT</code>: Enable MQTT publishing/subscribing</li>
<li><code>GPIO 4 enable HTTP</code>: Enable HTTP write/read</li>
<li><code>GPIO 4 name</code>: MQTT topic name (empty = <code>GPIO4</code>). Allowed characters: <code>a-z, A-Z, 0-9, _, -</code>.</li>
</ul>
<hr style="border:2px solid">
<p><a id=GPIO-LEDColor></a></p>
@@ -944,11 +660,13 @@ See <a href="../Integration-Home-Assistant">here</a> for details about the disco
<h3 id="parameter-maintopic">Parameter <code>MainTopic</code></h3>
<p>Default Value: <code>watermeter</code>
MQTT main topic, under which the counters are published.
The single value will be published with the following key: <code>MAINTOPIC/NUMBER/RESULT_TOPIC</code> where:
- <code>NUMBER</code> is the name of the value (a meter might have more than one value).
The names get defined in the analog and digital ROI configuration (defaults to <code>main</code>).
- <code>RESULT_TOPIC</code> can be one of <code>value</code>, <code>rate</code>, <code>timestamp</code>, <code>error</code>, ....
The general connection status can be found in <code>MAINTOPIC/CONNECTION</code>.
The single value will be published with the following key: <code>MAINTOPIC/NUMBER/RESULT_TOPIC</code> where:</p>
<ul>
<li><code>NUMBER</code> is the name of the value (a meter might have more than one value).
The names get defined in the analog and digital ROI configuration (defaults to <code>main</code>).</li>
<li><code>RESULT_TOPIC</code> can be one of <code>value</code>, <code>rate</code>, <code>timestamp</code>, <code>error</code>, ....</li>
</ul>
<p>The general connection status can be found in <code>MAINTOPIC/CONNECTION</code>.
See <a href="../MQTT-API#result">MQTT Result Topics</a> for a full list of topics.</p>
<hr style="border:2px solid">
@@ -1213,9 +931,11 @@ Check <a href="../Demo-Mode">here</a> for details. </p>
<p>This is an <strong>Expert Parameter</strong>! Only change it if you understand what it does!</p>
</div>
<p>Size of the camera picture.
Available options:
- <code>VGA</code> (640 x 480 pixel)
- <code>QVGA</code> (320 x 240 pixel)</p>
Available options:</p>
<ul>
<li><code>VGA</code> (640 x 480 pixel)</li>
<li><code>QVGA</code> (320 x 240 pixel)</li>
</ul>
<hr style="border:2px solid">
<p><a id=TakeImage-LEDIntensity></a></p>

2
search/search_index.json
View File

File diff suppressed because one or more lines are too long

70
sitemap.xml
View File

@@ -2,177 +2,177 @@
<urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">
<url>
<loc>https://jomjol.github.io/AI-on-the-edge-device-docs/</loc>
<lastmod>2023-02-21</lastmod>
<lastmod>2023-02-22</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://jomjol.github.io/AI-on-the-edge-device-docs/Additional-Information/</loc>
<lastmod>2023-02-21</lastmod>
<lastmod>2023-02-22</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://jomjol.github.io/AI-on-the-edge-device-docs/Alignment/</loc>
<lastmod>2023-02-21</lastmod>
<lastmod>2023-02-22</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://jomjol.github.io/AI-on-the-edge-device-docs/Best-Practice/</loc>
<lastmod>2023-02-21</lastmod>
<lastmod>2023-02-22</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://jomjol.github.io/AI-on-the-edge-device-docs/Build-Instructions/</loc>
<lastmod>2023-02-21</lastmod>
<lastmod>2023-02-22</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://jomjol.github.io/AI-on-the-edge-device-docs/Choosing-the-Model/</loc>
<lastmod>2023-02-21</lastmod>
<lastmod>2023-02-22</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://jomjol.github.io/AI-on-the-edge-device-docs/Configuration/</loc>
<lastmod>2023-02-21</lastmod>
<lastmod>2023-02-22</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://jomjol.github.io/AI-on-the-edge-device-docs/Correction%20Algorithm/</loc>
<lastmod>2023-02-21</lastmod>
<lastmod>2023-02-22</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://jomjol.github.io/AI-on-the-edge-device-docs/Demo-Mode/</loc>
<lastmod>2023-02-21</lastmod>
<lastmod>2023-02-22</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://jomjol.github.io/AI-on-the-edge-device-docs/Error-Codes/</loc>
<lastmod>2023-02-21</lastmod>
<lastmod>2023-02-22</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://jomjol.github.io/AI-on-the-edge-device-docs/Error-Debugging/</loc>
<lastmod>2023-02-21</lastmod>
<lastmod>2023-02-22</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://jomjol.github.io/AI-on-the-edge-device-docs/External-LED/</loc>
<lastmod>2023-02-21</lastmod>
<lastmod>2023-02-22</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://jomjol.github.io/AI-on-the-edge-device-docs/FAQs/</loc>
<lastmod>2023-02-21</lastmod>
<lastmod>2023-02-22</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://jomjol.github.io/AI-on-the-edge-device-docs/Frequent-Reboots/</loc>
<lastmod>2023-02-21</lastmod>
<lastmod>2023-02-22</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://jomjol.github.io/AI-on-the-edge-device-docs/Hardware-Compatibility/</loc>
<lastmod>2023-02-21</lastmod>
<lastmod>2023-02-22</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://jomjol.github.io/AI-on-the-edge-device-docs/Influx-DB/</loc>
<lastmod>2023-02-21</lastmod>
<lastmod>2023-02-22</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://jomjol.github.io/AI-on-the-edge-device-docs/Installation/</loc>
<lastmod>2023-02-21</lastmod>
<lastmod>2023-02-22</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://jomjol.github.io/AI-on-the-edge-device-docs/Integration-Home-Assistant/</loc>
<lastmod>2023-02-21</lastmod>
<lastmod>2023-02-22</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://jomjol.github.io/AI-on-the-edge-device-docs/Learn-models-with-your-own-images/</loc>
<lastmod>2023-02-21</lastmod>
<lastmod>2023-02-22</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://jomjol.github.io/AI-on-the-edge-device-docs/MQTT-API/</loc>
<lastmod>2023-02-21</lastmod>
<lastmod>2023-02-22</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://jomjol.github.io/AI-on-the-edge-device-docs/Neural-Network-Types/</loc>
<lastmod>2023-02-21</lastmod>
<lastmod>2023-02-22</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://jomjol.github.io/AI-on-the-edge-device-docs/New-Releases-Notification/</loc>
<lastmod>2023-02-21</lastmod>
<lastmod>2023-02-22</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://jomjol.github.io/AI-on-the-edge-device-docs/Parameters/</loc>
<lastmod>2023-02-21</lastmod>
<lastmod>2023-02-22</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://jomjol.github.io/AI-on-the-edge-device-docs/REST-API/</loc>
<lastmod>2023-02-21</lastmod>
<lastmod>2023-02-22</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://jomjol.github.io/AI-on-the-edge-device-docs/ROI-Configuration/</loc>
<lastmod>2023-02-21</lastmod>
<lastmod>2023-02-22</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://jomjol.github.io/AI-on-the-edge-device-docs/Reference-Image/</loc>
<lastmod>2023-02-21</lastmod>
<lastmod>2023-02-22</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://jomjol.github.io/AI-on-the-edge-device-docs/Release-creation/</loc>
<lastmod>2023-02-21</lastmod>
<lastmod>2023-02-22</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://jomjol.github.io/AI-on-the-edge-device-docs/Testing/</loc>
<lastmod>2023-02-21</lastmod>
<lastmod>2023-02-22</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://jomjol.github.io/AI-on-the-edge-device-docs/Upload-files-by-script/</loc>
<lastmod>2023-02-21</lastmod>
<lastmod>2023-02-22</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://jomjol.github.io/AI-on-the-edge-device-docs/Watermeter-specific-analog---digital-transition/</loc>
<lastmod>2023-02-21</lastmod>
<lastmod>2023-02-22</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://jomjol.github.io/AI-on-the-edge-device-docs/collect-new-images/</loc>
<lastmod>2023-02-21</lastmod>
<lastmod>2023-02-22</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://jomjol.github.io/AI-on-the-edge-device-docs/initial-setup/</loc>
<lastmod>2023-02-21</lastmod>
<lastmod>2023-02-22</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://jomjol.github.io/AI-on-the-edge-device-docs/ota/</loc>
<lastmod>2023-02-21</lastmod>
<lastmod>2023-02-22</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://jomjol.github.io/AI-on-the-edge-device-docs/outdated--Integrated-Functions/</loc>
<lastmod>2023-02-21</lastmod>
<lastmod>2023-02-22</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://jomjol.github.io/AI-on-the-edge-device-docs/rolling-installation/</loc>
<lastmod>2023-02-21</lastmod>
<lastmod>2023-02-22</lastmod>
<changefreq>daily</changefreq>
</url>
</urlset>

BIN
sitemap.xml.gz
View File

Binary file not shown.