Deployed 47907aa with MkDocs version: 1.4.2

This commit is contained in:
github-actions[bot]
2023-02-20 22:02:39 +00:00
parent eaf3f78b7b
commit f42cf155bd
4 changed files with 342 additions and 119 deletions

View File

@@ -108,6 +108,10 @@
<li class="toctree-l3"><a class="reference internal" href="#parameter-logfileretentionindays">Parameter LogfileRetentionInDays</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>
@@ -115,12 +119,16 @@
<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>
<li class="toctree-l3"><a class="reference internal" href="#parameter-intervall">Parameter Intervall</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>
<li class="toctree-l3"><a class="reference internal" href="#parameter-datalogretentionindays">Parameter DataLogRetentionInDays</a>
@@ -129,9 +137,13 @@
</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-logfile">Parameter Logfile</a>
</li>
<li class="toctree-l3"><a class="reference internal" href="#parameter-logfileretentionindays_1">Parameter LogfileRetentionInDays</a>
</li>
<li class="toctree-l3"><a class="reference internal" href="#parameter-logfilesretention">Parameter LogfilesRetention</a>
</li>
</ul>
</li>
@@ -144,6 +156,10 @@
<li class="toctree-l3"><a class="reference internal" href="#parameter-logfileretentionindays_2">Parameter LogfileRetentionInDays</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>
@@ -195,6 +211,8 @@
</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-setretainflag">Parameter SetRetainFlag</a>
</li>
<li class="toctree-l3"><a class="reference internal" href="#parameter-uri_1">Parameter Uri</a>
@@ -267,6 +285,8 @@
</li>
<li class="toctree-l3"><a class="reference internal" href="#parameter-rssithreashold">Parameter RSSIThreashold</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>
@@ -275,6 +295,32 @@
</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_1">Parameter Brightness</a>
</li>
<li class="toctree-l3"><a class="reference internal" href="#parameter-contrast_1">Parameter Contrast</a>
</li>
<li class="toctree-l3"><a class="reference internal" href="#parameter-demo_1">Parameter Demo</a>
</li>
<li class="toctree-l3"><a class="reference internal" href="#parameter-fixedexposure_1">Parameter FixedExposure</a>
</li>
<li class="toctree-l3"><a class="reference internal" href="#parameter-imagequality_1">Parameter ImageQuality</a>
</li>
<li class="toctree-l3"><a class="reference internal" href="#parameter-imagesize_1">Parameter ImageSize</a>
</li>
<li class="toctree-l3"><a class="reference internal" href="#parameter-ledintensity_1">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_1">Parameter Saturation</a>
</li>
<li class="toctree-l3"><a class="reference internal" href="#parameter-waitbeforetakingpicture_1">Parameter WaitBeforeTakingPicture</a>
</li>
</ul>
</li>
</ul>
</li>
</ul>
@@ -381,11 +427,6 @@ In such case the functionality gets disabled respectively the default values wil
<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>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>Due to a typo, one of the sections is called <code>MakeImage</code> instead of <code>TakeImage</code>!
For backwards compatibility, this did not get changed.</p>
</div>
<h2 id="list-of-all-parameters">List of all Parameters</h2>
<p><a href="#alignment">Alignment</a></p>
<ul>
@@ -403,21 +444,27 @@ For backwards compatibility, this did not get changed.</p>
<li><a href="#Analog-LogImageLocation"><code>LogImageLocation</code></a></li>
<li><a href="#Analog-LogfileRetentionInDays"><code>LogfileRetentionInDays</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>
<li><a href="#AutoTimer-Intervall"><code>Intervall</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>
<li><a href="#DataLogging-DataLogRetentionInDays"><code>DataLogRetentionInDays</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-Logfile"><code>Logfile</code></a></li>
<li><a href="#Debug-LogfileRetentionInDays"><code>LogfileRetentionInDays</code></a></li>
<li><a href="#Debug-LogfilesRetention"><code>LogfilesRetention</code></a></li>
</ul>
<p><a href="#digits">Digits</a></p>
<ul>
@@ -425,6 +472,8 @@ For backwards compatibility, this did not get changed.</p>
<li><a href="#Digits-LogImageLocation"><code>LogImageLocation</code></a></li>
<li><a href="#Digits-LogfileRetentionInDays"><code>LogfileRetentionInDays</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>
@@ -453,6 +502,7 @@ For backwards compatibility, this did not get changed.</p>
<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-SetRetainFlag"><code>SetRetainFlag</code></a></li>
<li><a href="#MQTT-Uri"><code>Uri</code></a></li>
<li><a href="#MQTT-password"><code>password</code></a></li>
@@ -492,10 +542,25 @@ For backwards compatibility, this did not get changed.</p>
<li><a href="#System-AutoAdjustSummertime"><code>AutoAdjustSummertime</code></a></li>
<li><a href="#System-Hostname"><code>Hostname</code></a></li>
<li><a href="#System-RSSIThreashold"><code>RSSIThreashold</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>
<p><a id=Alignment-AlignmentAlgo></a></p>
@@ -586,27 +651,23 @@ For backwards compatibility, this did not get changed.</p>
<p><a id=Analog-ExtendedResolution></a></p>
<h3 id="parameter-extendedresolution">Parameter <code>ExtendedResolution</code></h3>
<p>Default Value: <code>true</code></p>
<div class="admonition warning">
<p class="admonition-title">Warning</p>
<p>This parameter got replaced by <a href="../Parameters/#PostProcessing-NUMBER.ExtendedResolution"><code>NUMBER.ExtendedResolution</code></a>!</p>
<p>This parameter is unused!
Use <a href="../Parameters/#PostProcessing-NUMBER.ExtendedResolution"><code>NUMBER.ExtendedResolution</code></a> instead!</p>
</div>
<hr style="border:2px solid">
<p><a id=Analog-LogImageLocation></a></p>
<h3 id="parameter-logimagelocation">Parameter <code>LogImageLocation</code></h3>
<p>Default Value: <code>/log/analog</code></p>
<p>Location to store separated analog images on the SD-Card for logging.</p>
<div class="admonition warning">
<p class="admonition-title">Warning</p>
<p>A SD-Card has limited write cycles. Since the device does not support <a href="https://en.wikipedia.org/wiki/Wear_leveling">Wear Leveling</a>, this can wear out your SD-Card!</p>
</div>
<p>Please fill me with an explanation and useful links.</p>
<hr style="border:2px solid">
<p><a id=Analog-LogfileRetentionInDays></a></p>
<h3 id="parameter-logfileretentionindays">Parameter <code>LogfileRetentionInDays</code></h3>
<p>Default Value: <code>3</code></p>
<p>Days to keep the separated analog images (<code>0</code> = forever).</p>
<p>Please fill me with an explanation and useful links.</p>
<hr style="border:2px solid">
<p><a id=Analog-Model></a></p>
@@ -615,6 +676,22 @@ For backwards compatibility, this did not get changed.</p>
<p>Path to CNN model file for image recognition. See <a href="../Choosing-the-Model">here</a> for details. </p>
<hr style="border:2px solid">
<p><a id=Analog-ROIImagesLocation></a></p>
<h3 id="parameter-roiimageslocation">Parameter <code>ROIImagesLocation</code></h3>
<p>Default Value: <code>/log/analog</code></p>
<p>Location to store separated analog images on the SD-Card for logging.</p>
<div class="admonition warning">
<p class="admonition-title">Warning</p>
<p>A SD-Card has limited write cycles. Since the device does not do <a href="https://en.wikipedia.org/wiki/Wear_leveling">Wear Leveling</a>, this can wear out your SD-Card!</p>
</div>
<hr style="border:2px solid">
<p><a id=Analog-ROIImagesRetention></a></p>
<h3 id="parameter-roiimagesretention">Parameter <code>ROIImagesRetention</code></h3>
<p>Default Value: <code>3</code></p>
<p>Days to keep the separated analog images (<code>0</code> = forever).</p>
<hr style="border:2px solid">
<h2 id="section-autotimer">Section <code>AutoTimer</code></h2>
<p><a id=AutoTimer-AutoStart></a></p>
<h3 id="parameter-autostart">Parameter <code>AutoStart</code></h3>
@@ -631,38 +708,45 @@ The only reason to set it to <code>false</code> is debugging or if you want to t
</div>
<hr style="border:2px solid">
<p><a id=AutoTimer-Interval></a></p>
<h3 id="parameter-interval">Parameter <code>Interval</code></h3>
<p>Default Value: <code>5</code></p>
<p>Interval in minutes in which the Flow (Digitization Round) is run.
If a round takes longer than this interval, the next round gets postponed until the current round completes.</p>
<hr style="border:2px solid">
<p><a id=AutoTimer-Intervall></a></p>
<h3 id="parameter-intervall">Parameter <code>Intervall</code></h3>
<p>Default Value: <code>5</code></p>
<p>Interval in minutes in which the Flow (Digitization Round) is run.
If a rund takes longer than this interval, the next round gets postponed until the current round completes.</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>Due to a typo, it is called <code>Intervall</code> instead of <code>Interval</code>.
For backwards compatibility, this did not get changed.</p>
</div>
<p>Please fill me with an explanation and useful links.</p>
<hr style="border:2px solid">
<h2 id="section-datalogging">Section <code>DataLogging</code></h2>
<p><a id=DataLogging-DataFilesRetention></a></p>
<h3 id="parameter-datafilesretention">Parameter <code>DataFilesRetention</code></h3>
<p>Default Value: <code>3</code></p>
<p>Number of days to keep the data files (<code>0</code> = forever).</p>
<hr style="border:2px solid">
<p><a id=DataLogging-DataLogActive></a></p>
<h3 id="parameter-datalogactive">Parameter <code>DataLogActive</code></h3>
<p>Default Value: <code>true</code></p>
<p>Activate data logging to SD-Card.</p>
<div class="admonition warning">
<p class="admonition-title">Warning</p>
<p>A SD-Card has limited write cycles. Since the device does not support <a href="https://en.wikipedia.org/wiki/Wear_leveling">Wear Leveling</a>, this can wear out your SD-Card!</p>
<p>A SD-Card has limited write cycles. Since the device does not do <a href="https://en.wikipedia.org/wiki/Wear_leveling">Wear Leveling</a>, this can wear out your SD-Card!</p>
</div>
<hr style="border:2px solid">
<p><a id=DataLogging-DataLogRetentionInDays></a></p>
<h3 id="parameter-datalogretentionindays">Parameter <code>DataLogRetentionInDays</code></h3>
<p>Default Value: <code>3</code></p>
<p>Number of days to keep the data files (<code>0</code> = forever).</p>
<p>Please fill me with an explanation and useful links.</p>
<hr style="border:2px solid">
<h2 id="section-debug">Section <code>Debug</code></h2>
<p><a id=Debug-Logfile></a></p>
<h3 id="parameter-logfile">Parameter <code>Logfile</code></h3>
<p><a id=Debug-LogLevel></a></p>
<h3 id="parameter-loglevel">Parameter <code>LogLevel</code></h3>
<p>Default Value: <code>1</code> (<code>ERROR</code>)</p>
<p>Define the log level for the logging to the SD-Card.</p>
<p>Available options:</p>
@@ -676,13 +760,25 @@ For backwards compatibility, this did not get changed.</p>
<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!
A SD-Card has limited write cycles. Since the device does not support <a href="https://en.wikipedia.org/wiki/Wear_leveling">Wear Leveling</a>, this can wear out your SD-Card!</p>
A SD-Card has limited write cycles. Since the device does not do <a href="https://en.wikipedia.org/wiki/Wear_leveling">Wear Leveling</a>, this can wear out your SD-Card!</p>
</div>
<hr style="border:2px solid">
<p><a id=Debug-Logfile></a></p>
<h3 id="parameter-logfile">Parameter <code>Logfile</code></h3>
<p>Default Value: <code>1</code></p>
<p>Please fill me with an explanation and useful links.</p>
<hr style="border:2px solid">
<p><a id=Debug-LogfileRetentionInDays></a></p>
<h3 id="parameter-logfileretentionindays_1">Parameter <code>LogfileRetentionInDays</code></h3>
<p>Default Value: <code>3</code></p>
<p>Please fill me with an explanation and useful links.</p>
<hr style="border:2px solid">
<p><a id=Debug-LogfilesRetention></a></p>
<h3 id="parameter-logfilesretention">Parameter <code>LogfilesRetention</code></h3>
<p>Default Value: <code>3</code></p>
<p>Number of days to keep the log files (<code>0</code> = forever).</p>
<hr style="border:2px solid">
@@ -704,17 +800,13 @@ A SD-Card has limited write cycles. Since the device does not support <a href="h
<p><a id=Digits-LogImageLocation></a></p>
<h3 id="parameter-logimagelocation_1">Parameter <code>LogImageLocation</code></h3>
<p>Default Value: <code>/log/digit</code></p>
<p>Location to store separated digit images on the SD-Card for logging.</p>
<div class="admonition warning">
<p class="admonition-title">Warning</p>
<p>A SD-Card has limited write cycles. Since the device does not support <a href="https://en.wikipedia.org/wiki/Wear_leveling">Wear Leveling</a>, this can wear out your SD-Card!</p>
</div>
<p>Please fill me with an explanation and useful links.</p>
<hr style="border:2px solid">
<p><a id=Digits-LogfileRetentionInDays></a></p>
<h3 id="parameter-logfileretentionindays_2">Parameter <code>LogfileRetentionInDays</code></h3>
<p>Default Value: <code>3</code></p>
<p>Days to keep the separated digit images (<code>0</code> = forever).</p>
<p>Please fill me with an explanation and useful links.</p>
<hr style="border:2px solid">
<p><a id=Digits-Model></a></p>
@@ -723,6 +815,22 @@ A SD-Card has limited write cycles. Since the device does not support <a href="h
<p>Path to CNN model file for image recognition. See <a href="../Choosing-the-Model">here</a> for details. </p>
<hr style="border:2px solid">
<p><a id=Digits-ROIImagesLocation></a></p>
<h3 id="parameter-roiimageslocation_1">Parameter <code>ROIImagesLocation</code></h3>
<p>Default Value: <code>/log/digit</code></p>
<p>Location to store separated digit images on the SD-Card for logging.</p>
<div class="admonition warning">
<p class="admonition-title">Warning</p>
<p>A SD-Card has limited write cycles. Since the device does not do <a href="https://en.wikipedia.org/wiki/Wear_leveling">Wear Leveling</a>, this can wear out your SD-Card!</p>
</div>
<hr style="border:2px solid">
<p><a id=Digits-ROIImagesRetention></a></p>
<h3 id="parameter-roiimagesretention_1">Parameter <code>ROIImagesRetention</code></h3>
<p>Default Value: <code>3</code></p>
<p>Days to keep the separated digit images (<code>0</code> = forever).</p>
<hr style="border:2px solid">
<h2 id="section-gpio">Section <code>GPIO</code></h2>
<p><a id=GPIO-IO0></a></p>
<h3 id="parameter-io0">Parameter <code>IO0</code></h3>
@@ -979,10 +1087,16 @@ Eg. if your meter provides <code>m³</code>, you need to also set it to <code>m
Alternatively you can set the parameter <code>DecimalShift</code> to <code>3</code> so the value is converted to <code>liters</code>!</p>
<hr style="border:2px solid">
<p><a id=MQTT-RetainMessages></a></p>
<h3 id="parameter-retainmessages">Parameter <code>RetainMessages</code></h3>
<p>Default Value: <code>true</code></p>
<p>Enable or disable the <a href="https://www.hivemq.com/blog/mqtt-essentials-part-8-retained-messages/">Retain Flag</a> for all MQTT entries.</p>
<hr style="border:2px solid">
<p><a id=MQTT-SetRetainFlag></a></p>
<h3 id="parameter-setretainflag">Parameter <code>SetRetainFlag</code></h3>
<p>Default Value: <code>true</code></p>
<p>Enable or disable the retain flag for all MQTT entries.</p>
<p>Please fill me with an explanation and useful links.</p>
<hr style="border:2px solid">
<p><a id=MQTT-Uri></a></p>
@@ -1009,10 +1123,9 @@ Alternatively you can set the parameter <code>DecimalShift</code> to <code>3</co
<p>Default Value: <code>0</code></p>
<div class="admonition warning">
<p class="admonition-title">Warning</p>
<p>This is an <strong>Expert Parameter</strong>! Only change it if you understand what it does!
This parameter can also be set on the Reference Image configuration.</p>
<p>This is an <strong>Expert Parameter</strong>! Only change it if you understand what it does!</p>
</div>
<p>Image Brightness (<code>-2</code> .. <code>2</code>) </p>
<p>Please fill me with an explanation and useful links.</p>
<hr style="border:2px solid">
<p><a id=MakeImage-Contrast></a></p>
@@ -1020,22 +1133,15 @@ This parameter can also be set on the Reference Image configuration.</p>
<p>Default Value: <code>0</code></p>
<div class="admonition warning">
<p class="admonition-title">Warning</p>
<p>This is an <strong>Expert Parameter</strong>! Only change it if you understand what it does!
This parameter can also be set on the Reference Image configuration.</p>
</div>
<p>Image Contrast (<code>-2</code> .. <code>2</code>)</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>Camera driver is not fully supporting this setting yet (no impact on image) </p>
<p>This is an <strong>Expert Parameter</strong>! Only change it if you understand what it does!</p>
</div>
<p>Please fill me with an explanation and useful links.</p>
<hr style="border:2px solid">
<p><a id=MakeImage-Demo></a></p>
<h3 id="parameter-demo">Parameter <code>Demo</code></h3>
<p>Default Value: <code>false</code></p>
<p>Enable to use demo images instead of the real camera images.
Make sure to have a <code>/demo</code> folder on your SD-Card and it contains the expected files!
Check <a href="../Demo-Mode">here</a> for details. </p>
<p>Please fill me with an explanation and useful links.</p>
<hr style="border:2px solid">
<p><a id=MakeImage-FixedExposure></a></p>
@@ -1045,8 +1151,7 @@ Check <a href="../Demo-Mode">here</a> for details. </p>
<p class="admonition-title">Warning</p>
<p>This is an <strong>Expert Parameter</strong>! Only change it if you understand what it does!</p>
</div>
<p>Fixes the illumination setting of camera at the startup and uses this later --&gt;
individual round is faster.</p>
<p>Please fill me with an explanation and useful links.</p>
<hr style="border:2px solid">
<p><a id=MakeImage-ImageQuality></a></p>
@@ -1056,11 +1161,7 @@ individual round is faster.</p>
<p class="admonition-title">Warning</p>
<p>This is an <strong>Expert Parameter</strong>! Only change it if you understand what it does!</p>
</div>
<p>Quality index for pictures. <code>0</code> (high) .. <code>63</code> (low)</p>
<div class="admonition warning">
<p class="admonition-title">Warning</p>
<p>Values below <code>12</code> can result in reboots as the image gets larger and might no longer fit in the available RAM!</p>
</div>
<p>Please fill me with an explanation and useful links.</p>
<hr style="border:2px solid">
<p><a id=MakeImage-ImageSize></a></p>
@@ -1070,12 +1171,7 @@ individual round is faster.</p>
<p class="admonition-title">Warning</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:</p>
<ul>
<li><code>VGA</code> (640 x 480 pixel)</li>
<li><code>QVGA</code> (320 x 240 pixel)</li>
</ul>
<p>Please fill me with an explanation and useful links.</p>
<hr style="border:2px solid">
<p><a id=MakeImage-LEDIntensity></a></p>
@@ -1083,26 +1179,21 @@ Available options:</p>
<p>Default Value: <code>50</code></p>
<div class="admonition warning">
<p class="admonition-title">Warning</p>
<p>This is an <strong>Expert Parameter</strong>! Only change it if you understand what it does!
This parameter can also be set on the Reference Image configuration.</p>
<p>This is an <strong>Expert Parameter</strong>! Only change it if you understand what it does!</p>
</div>
<p>Set the Flash LED Intensity.</p>
<p>Please fill me with an explanation and useful links.</p>
<hr style="border:2px solid">
<p><a id=MakeImage-LogImageLocation></a></p>
<h3 id="parameter-logimagelocation_2">Parameter <code>LogImageLocation</code></h3>
<p>Default Value: <code>/log/source</code></p>
<p>Location on the SD-Card to store the raw images for logging.</p>
<div class="admonition warning">
<p class="admonition-title">Warning</p>
<p>A SD-Card has limited write cycles. Since the device does not support <a href="https://en.wikipedia.org/wiki/Wear_leveling">Wear Leveling</a>, this can wear out your SD-Card!</p>
</div>
<p>Please fill me with an explanation and useful links.</p>
<hr style="border:2px solid">
<p><a id=MakeImage-LogfileRetentionInDays></a></p>
<h3 id="parameter-logfileretentionindays_3">Parameter <code>LogfileRetentionInDays</code></h3>
<p>Default Value: <code>15</code></p>
<p>Number of days to keep the raw images (<code>0</code> = forever)</p>
<p>Please fill me with an explanation and useful links.</p>
<hr style="border:2px solid">
<p><a id=MakeImage-Saturation></a></p>
@@ -1110,14 +1201,9 @@ This parameter can also be set on the Reference Image configuration.</p>
<p>Default Value: <code>0</code></p>
<div class="admonition warning">
<p class="admonition-title">Warning</p>
<p>This is an <strong>Expert Parameter</strong>! Only change it if you understand what it does!
This parameter can also be set on the Reference Image configuration.</p>
</div>
<p>Image Saturation (<code>-2</code> .. <code>2</code>)</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>Camera driver is not fully supporting this setting yet (no impact on image)!</p>
<p>This is an <strong>Expert Parameter</strong>! Only change it if you understand what it does!</p>
</div>
<p>Please fill me with an explanation and useful links.</p>
<hr style="border:2px solid">
<p><a id=MakeImage-WaitBeforeTakingPicture></a></p>
@@ -1127,14 +1213,17 @@ This parameter can also be set on the Reference Image configuration.</p>
<p class="admonition-title">Warning</p>
<p>This is an <strong>Expert Parameter</strong>! Only change it if you understand what it does!</p>
</div>
<p>Waiting time between switching illumination on and taking the picture (in seconds)-</p>
<p>Please fill me with an explanation and useful links.</p>
<hr style="border:2px solid">
<h2 id="section-postprocessing">Section <code>PostProcessing</code></h2>
<p><a id=PostProcessing-AllowNegativeRates></a></p>
<h3 id="parameter-allownegativerates">Parameter <code>AllowNegativeRates</code></h3>
<p>Default Value: <code>false</code></p>
<p>Please fill me with an explanation and useful links</p>
<div class="admonition warning">
<p class="admonition-title">Warning</p>
<p>This parameter is unused!
Use <a href="../Parameters/#PostProcessing-NUMBER.AllowNegativeRates"><code>NUMBER.AllowNegativeRates</code></a> instead!</p>
</div>
<hr style="border:2px solid">
<p><a id=PostProcessing-CheckDigitIncreaseConsistency></a></p>
@@ -1242,6 +1331,7 @@ This also works through a reboot of the device!</p>
<p class="admonition-title">Note</p>
<p>This parameter is not accessible through the Web Interface Configuration Page!</p>
</div>
<p>Please fill me with an explanation and useful links.</p>
<hr style="border:2px solid">
<p><a id=System-Hostname></a></p>
@@ -1257,14 +1347,20 @@ It gets automatically transferred to <code>/wlan.ini</code> on the SD-Card at ne
<p><a id=System-RSSIThreashold></a></p>
<h3 id="parameter-rssithreashold">Parameter <code>RSSIThreashold</code></h3>
<p>Default Value: <code>0</code></p>
<div class="admonition warning">
<p class="admonition-title">Warning</p>
<p>This is an <strong>Expert Parameter</strong>! Only change it if you understand what it does!</p>
</div>
<p>Please fill me with an explanation and useful links.</p>
<hr style="border:2px solid">
<p><a id=System-RSSIThreshold></a></p>
<h3 id="parameter-rssithreshold">Parameter <code>RSSIThreshold</code></h3>
<p>Default Value: <code>''</code></p>
<p>WLAN Mesh Parameter: Threshold for the RSSI value to check for start switching access point in a mesh system.
Possible values: <code>-100</code> .. <code>0</code>, <code>0</code> = disabled.
It gets automatically transferred to <code>/wlan.ini</code> on the SD-Card at next startup.</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>Due to a typo, the parameter is wrongly named <code>RSSIThreashold</code>.</p>
</div>
<hr style="border:2px solid">
<p><a id=System-SetupMode></a></p>
@@ -1295,6 +1391,133 @@ In such case the time always starts at <code>01.01.1970</code> after each power
<p>Default Value: <code>CET-1CEST,M3.5.0,M10.5.0/3</code></p>
<p>Time zone in POSIX syntax (Europe/Berlin = <code>CET-1CEST,M3.5.0,M10.5.0/3</code> - incl. daylight saving)
Check the table on <code>http://&lt;DEVICE IP&gt;/timezones.html</code> to find the settings for your region.</p>
<hr style="border:2px solid">
<h2 id="section-takeimage">Section <code>TakeImage</code></h2>
<p><a id=TakeImage-Brightness></a></p>
<h3 id="parameter-brightness_1">Parameter <code>Brightness</code></h3>
<p>Default Value: <code>0</code></p>
<div class="admonition warning">
<p class="admonition-title">Warning</p>
<p>This is an <strong>Expert Parameter</strong>! Only change it if you understand what it does!
This parameter can also be set on the Reference Image configuration.</p>
</div>
<p>Image Brightness (<code>-2</code> .. <code>2</code>) </p>
<hr style="border:2px solid">
<p><a id=TakeImage-Contrast></a></p>
<h3 id="parameter-contrast_1">Parameter <code>Contrast</code></h3>
<p>Default Value: <code>0</code></p>
<div class="admonition warning">
<p class="admonition-title">Warning</p>
<p>This is an <strong>Expert Parameter</strong>! Only change it if you understand what it does!
This parameter can also be set on the Reference Image configuration.</p>
</div>
<p>Image Contrast (<code>-2</code> .. <code>2</code>)</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>Camera driver is not fully supporting this setting yet (no impact on image) </p>
</div>
<hr style="border:2px solid">
<p><a id=TakeImage-Demo></a></p>
<h3 id="parameter-demo_1">Parameter <code>Demo</code></h3>
<p>Default Value: <code>false</code></p>
<p>Enable to use demo images instead of the real camera images.
Make sure to have a <code>/demo</code> folder on your SD-Card and it contains the expected files!
Check <a href="../Demo-Mode">here</a> for details. </p>
<hr style="border:2px solid">
<p><a id=TakeImage-FixedExposure></a></p>
<h3 id="parameter-fixedexposure_1">Parameter <code>FixedExposure</code></h3>
<p>Default Value: <code>false</code></p>
<div class="admonition warning">
<p class="admonition-title">Warning</p>
<p>This is an <strong>Expert Parameter</strong>! Only change it if you understand what it does!</p>
</div>
<p>Fixes the illumination setting of camera at the startup and uses this later --&gt;
individual round is faster.</p>
<hr style="border:2px solid">
<p><a id=TakeImage-ImageQuality></a></p>
<h3 id="parameter-imagequality_1">Parameter <code>ImageQuality</code></h3>
<p>Default Value: <code>12</code></p>
<div class="admonition warning">
<p class="admonition-title">Warning</p>
<p>This is an <strong>Expert Parameter</strong>! Only change it if you understand what it does!</p>
</div>
<p>Quality index for pictures. <code>0</code> (high) .. <code>63</code> (low)</p>
<div class="admonition warning">
<p class="admonition-title">Warning</p>
<p>Values below <code>12</code> can result in reboots as the image gets larger and might no longer fit in the available RAM!</p>
</div>
<hr style="border:2px solid">
<p><a id=TakeImage-ImageSize></a></p>
<h3 id="parameter-imagesize_1">Parameter <code>ImageSize</code></h3>
<p>Default Value: <code>VGA</code></p>
<div class="admonition warning">
<p class="admonition-title">Warning</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:</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>
<h3 id="parameter-ledintensity_1">Parameter <code>LEDIntensity</code></h3>
<p>Default Value: <code>50</code></p>
<div class="admonition warning">
<p class="admonition-title">Warning</p>
<p>This is an <strong>Expert Parameter</strong>! Only change it if you understand what it does!
This parameter can also be set on the Reference Image configuration.</p>
</div>
<p>Set the Flash LED Intensity.</p>
<hr style="border:2px solid">
<p><a id=TakeImage-RawImagesLocation></a></p>
<h3 id="parameter-rawimageslocation">Parameter <code>RawImagesLocation</code></h3>
<p>Default Value: <code>/log/source</code></p>
<p>Location on the SD-Card to store the raw images for logging.</p>
<div class="admonition warning">
<p class="admonition-title">Warning</p>
<p>A SD-Card has limited write cycles. Since the device does not do <a href="https://en.wikipedia.org/wiki/Wear_leveling">Wear Leveling</a>, this can wear out your SD-Card!</p>
</div>
<hr style="border:2px solid">
<p><a id=TakeImage-RawImagesRetention></a></p>
<h3 id="parameter-rawimagesretention">Parameter <code>RawImagesRetention</code></h3>
<p>Default Value: <code>15</code></p>
<p>Number of days to keep the raw images (<code>0</code> = forever)</p>
<hr style="border:2px solid">
<p><a id=TakeImage-Saturation></a></p>
<h3 id="parameter-saturation_1">Parameter <code>Saturation</code></h3>
<p>Default Value: <code>0</code></p>
<div class="admonition warning">
<p class="admonition-title">Warning</p>
<p>This is an <strong>Expert Parameter</strong>! Only change it if you understand what it does!
This parameter can also be set on the Reference Image configuration.</p>
</div>
<p>Image Saturation (<code>-2</code> .. <code>2</code>)</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>Camera driver is not fully supporting this setting yet (no impact on image)!</p>
</div>
<hr style="border:2px solid">
<p><a id=TakeImage-WaitBeforeTakingPicture></a></p>
<h3 id="parameter-waitbeforetakingpicture_1">Parameter <code>WaitBeforeTakingPicture</code></h3>
<p>Default Value: <code>5</code></p>
<div class="admonition warning">
<p class="admonition-title">Warning</p>
<p>This is an <strong>Expert Parameter</strong>! Only change it if you understand what it does!</p>
</div>
<p>Waiting time between switching illumination on and taking the picture (in seconds)-</p>
<hr style="border:2px solid">
</div>

File diff suppressed because one or more lines are too long

View File

@@ -2,187 +2,187 @@
<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-14</lastmod>
<lastmod>2023-02-20</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://jomjol.github.io/AI-on-the-edge-device-docs/Additional-Information/</loc>
<lastmod>2023-02-14</lastmod>
<lastmod>2023-02-20</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://jomjol.github.io/AI-on-the-edge-device-docs/Best-Practice/</loc>
<lastmod>2023-02-14</lastmod>
<lastmod>2023-02-20</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://jomjol.github.io/AI-on-the-edge-device-docs/Build-Instructions/</loc>
<lastmod>2023-02-14</lastmod>
<lastmod>2023-02-20</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://jomjol.github.io/AI-on-the-edge-device-docs/Choosing-the-Model/</loc>
<lastmod>2023-02-14</lastmod>
<lastmod>2023-02-20</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://jomjol.github.io/AI-on-the-edge-device-docs/Configuration-Parameter-Details/</loc>
<lastmod>2023-02-14</lastmod>
<lastmod>2023-02-20</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://jomjol.github.io/AI-on-the-edge-device-docs/Configuration/</loc>
<lastmod>2023-02-14</lastmod>
<lastmod>2023-02-20</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://jomjol.github.io/AI-on-the-edge-device-docs/Correction%20Algorithm/</loc>
<lastmod>2023-02-14</lastmod>
<lastmod>2023-02-20</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://jomjol.github.io/AI-on-the-edge-device-docs/Demo-Mode/</loc>
<lastmod>2023-02-14</lastmod>
<lastmod>2023-02-20</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://jomjol.github.io/AI-on-the-edge-device-docs/Error-Codes/</loc>
<lastmod>2023-02-14</lastmod>
<lastmod>2023-02-20</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://jomjol.github.io/AI-on-the-edge-device-docs/Error-Debugging/</loc>
<lastmod>2023-02-14</lastmod>
<lastmod>2023-02-20</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://jomjol.github.io/AI-on-the-edge-device-docs/External-LED/</loc>
<lastmod>2023-02-14</lastmod>
<lastmod>2023-02-20</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://jomjol.github.io/AI-on-the-edge-device-docs/FAQs/</loc>
<lastmod>2023-02-14</lastmod>
<lastmod>2023-02-20</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://jomjol.github.io/AI-on-the-edge-device-docs/Frequent-Reboots/</loc>
<lastmod>2023-02-14</lastmod>
<lastmod>2023-02-20</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://jomjol.github.io/AI-on-the-edge-device-docs/Graphical-Configuration/</loc>
<lastmod>2023-02-14</lastmod>
<lastmod>2023-02-20</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://jomjol.github.io/AI-on-the-edge-device-docs/Hardware-Compatibility/</loc>
<lastmod>2023-02-14</lastmod>
<lastmod>2023-02-20</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://jomjol.github.io/AI-on-the-edge-device-docs/Influx-DB/</loc>
<lastmod>2023-02-14</lastmod>
<lastmod>2023-02-20</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://jomjol.github.io/AI-on-the-edge-device-docs/Installation/</loc>
<lastmod>2023-02-14</lastmod>
<lastmod>2023-02-20</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://jomjol.github.io/AI-on-the-edge-device-docs/Integration-Home-Assistant/</loc>
<lastmod>2023-02-14</lastmod>
<lastmod>2023-02-20</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-14</lastmod>
<lastmod>2023-02-20</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://jomjol.github.io/AI-on-the-edge-device-docs/MQTT-API/</loc>
<lastmod>2023-02-14</lastmod>
<lastmod>2023-02-20</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://jomjol.github.io/AI-on-the-edge-device-docs/Neural-Network-Types/</loc>
<lastmod>2023-02-14</lastmod>
<lastmod>2023-02-20</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://jomjol.github.io/AI-on-the-edge-device-docs/New-Releases-Notification/</loc>
<lastmod>2023-02-14</lastmod>
<lastmod>2023-02-20</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://jomjol.github.io/AI-on-the-edge-device-docs/Parameters/</loc>
<lastmod>2023-02-14</lastmod>
<lastmod>2023-02-20</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://jomjol.github.io/AI-on-the-edge-device-docs/REST-API/</loc>
<lastmod>2023-02-14</lastmod>
<lastmod>2023-02-20</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://jomjol.github.io/AI-on-the-edge-device-docs/ROI-Configuration/</loc>
<lastmod>2023-02-14</lastmod>
<lastmod>2023-02-20</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://jomjol.github.io/AI-on-the-edge-device-docs/Release-creation/</loc>
<lastmod>2023-02-14</lastmod>
<lastmod>2023-02-20</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://jomjol.github.io/AI-on-the-edge-device-docs/Testing/</loc>
<lastmod>2023-02-14</lastmod>
<lastmod>2023-02-20</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-14</lastmod>
<lastmod>2023-02-20</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-14</lastmod>
<lastmod>2023-02-20</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://jomjol.github.io/AI-on-the-edge-device-docs/collect-new-images/</loc>
<lastmod>2023-02-14</lastmod>
<lastmod>2023-02-20</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://jomjol.github.io/AI-on-the-edge-device-docs/initial-setup/</loc>
<lastmod>2023-02-14</lastmod>
<lastmod>2023-02-20</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://jomjol.github.io/AI-on-the-edge-device-docs/ota/</loc>
<lastmod>2023-02-14</lastmod>
<lastmod>2023-02-20</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://jomjol.github.io/AI-on-the-edge-device-docs/outdated--Gasmeter-Log-Downloader/</loc>
<lastmod>2023-02-14</lastmod>
<lastmod>2023-02-20</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://jomjol.github.io/AI-on-the-edge-device-docs/outdated--Integrated-Functions/</loc>
<lastmod>2023-02-14</lastmod>
<lastmod>2023-02-20</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://jomjol.github.io/AI-on-the-edge-device-docs/outdated--Migrate-Old-Config-To-New-Config/</loc>
<lastmod>2023-02-14</lastmod>
<lastmod>2023-02-20</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://jomjol.github.io/AI-on-the-edge-device-docs/rolling-installation/</loc>
<lastmod>2023-02-14</lastmod>
<lastmod>2023-02-20</lastmod>
<changefreq>daily</changefreq>
</url>
</urlset>

Binary file not shown.