mirror of
https://github.com/jomjol/AI-on-the-edge-device-docs.git
synced 2025-12-09 04:56:57 +03:00
Deployed 70ee5a4 with MkDocs version: 1.4.2
This commit is contained in:
github-actions[bot]
@@ -233,25 +233,23 @@
|
||||
</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 <NUMBERS>.AllowNegativeRates</a>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#parameter-numberallownegativerates">Parameter NUMBER.AllowNegativeRates</a>
|
||||
</li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#parameter-numberanalogdigitaltransitionstart">Parameter <NUMBER>.AnalogDigitalTransitionStart</a>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#parameter-numberanalogdigitaltransitionstart">Parameter NUMBER.AnalogDigitalTransitionStart</a>
|
||||
</li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#parameter-numberdecimalshift">Parameter <NUMBER>.DecimalShift</a>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#parameter-numberdecimalshift">Parameter NUMBER.DecimalShift</a>
|
||||
</li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#parameter-numberextendedresolution">Parameter <NUMBER>.ExtendedResolution</a>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#parameter-numberextendedresolution">Parameter NUMBER.ExtendedResolution</a>
|
||||
</li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#parameter-numberignoreleadingnan">Parameter <NUMBER>.IgnoreLeadingNaN</a>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#parameter-numberignoreleadingnan">Parameter NUMBER.IgnoreLeadingNaN</a>
|
||||
</li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#parameter-numbermaxratetype">Parameter <NUMBER>.MaxRateType</a>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#parameter-numbermaxratetype">Parameter NUMBER.MaxRateType</a>
|
||||
</li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#parameter-numbermaxratevalue">Parameter <NUMBER>.MaxRateValue</a>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#parameter-numbermaxratevalue">Parameter NUMBER.MaxRateValue</a>
|
||||
</li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#parameter-prevalueagestartup">Parameter PreValueAgeStartup</a>
|
||||
</li>
|
||||
@@ -474,7 +472,6 @@ For backwards compatibility, this did not get changed.</p>
|
||||
</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>
|
||||
@@ -505,13 +502,7 @@ For backwards compatibility, this did not get changed.</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>Algorithm used for the alignment step.</p>
|
||||
<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>
|
||||
<p>Please fill me with an explanation and useful links.</p>
|
||||
<hr style="border:2px solid">
|
||||
|
||||
<p><a id=Alignment-FlipImageSize></a></p>
|
||||
@@ -525,8 +516,7 @@ For backwards compatibility, this did not get changed.</p>
|
||||
<p class="admonition-title">Note</p>
|
||||
<p>This parameter is not accessible through the Web Interface Configuration Page!</p>
|
||||
</div>
|
||||
<p>This parameter can be used to rotate the viewport together with the alignment rotation:</p>
|
||||
<p><img alt="" src="../img/flipImageSize.png" /> </p>
|
||||
<p>Please fill me with an explanation and useful links.</p>
|
||||
<hr style="border:2px solid">
|
||||
|
||||
<p><a id=Alignment-InitialMirror></a></p>
|
||||
@@ -536,7 +526,7 @@ For backwards compatibility, this did not get changed.</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>
|
||||
<p>Please fill me with an explanation and useful links.</p>
|
||||
<hr style="border:2px solid">
|
||||
|
||||
<p><a id=Alignment-InitialRotate></a></p>
|
||||
@@ -546,7 +536,7 @@ For backwards compatibility, this did not get changed.</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>
|
||||
<p>Please fill me with an explanation and useful links.</p>
|
||||
<hr style="border:2px solid">
|
||||
|
||||
<p><a id=Alignment-SearchFieldX></a></p>
|
||||
@@ -556,7 +546,7 @@ For backwards compatibility, this did not get changed.</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><code>x</code> size (width) in which the reference is searched.</p>
|
||||
<p>Please fill me with an explanation and useful links.</p>
|
||||
<hr style="border:2px solid">
|
||||
|
||||
<p><a id=Alignment-SearchFieldY></a></p>
|
||||
@@ -566,7 +556,7 @@ For backwards compatibility, this did not get changed.</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><code>y</code> size (height) in which the reference is searched.</p>
|
||||
<p>Please fill me with an explanation and useful links.</p>
|
||||
<hr style="border:2px solid">
|
||||
|
||||
<h2 id="section-analog">Section <code>Analog</code></h2>
|
||||
@@ -577,11 +567,7 @@ For backwards compatibility, this did not get changed.</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>Threshold above which the classification should be to accept the value (only meaningful for digits).</p>
|
||||
<div class="admonition warning">
|
||||
<p class="admonition-title">Warning</p>
|
||||
<p>This is only supported for the <code>ana-class100</code> models!</p>
|
||||
</div>
|
||||
<p>Please fill me with an explanation and useful links.</p>
|
||||
<hr style="border:2px solid">
|
||||
|
||||
<p><a id=Analog-ExtendedResolution></a></p>
|
||||
@@ -593,23 +579,19 @@ For backwards compatibility, this did not get changed.</p>
|
||||
<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>
|
||||
<h3 id="parameter-model">Parameter <code>Model</code></h3>
|
||||
<p>Default Value: <code>/config/ana-cont_11.3.1_s2.tflite</code></p>
|
||||
<p>Path to CNN model file for image recognition. See <a href="../Choosing-the-Model">here</a> for details. </p>
|
||||
<p>Please fill me with an explanation and useful links.</p>
|
||||
<hr style="border:2px solid">
|
||||
|
||||
<h2 id="section-autotimer">Section <code>AutoTimer</code></h2>
|
||||
@@ -620,67 +602,39 @@ For backwards compatibility, this did not get changed.</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>Automatically start the Flow (Digitization Rounds) immediately after power up.</p>
|
||||
<div class="admonition note">
|
||||
<p class="admonition-title">Note</p>
|
||||
<p>Typically this is set to <code>true</code>.
|
||||
The only reason to set it to <code>false</code> is debugging or if you want to trigger it manually using the <a href="../REST-API">REST API</a> or <a href="../MQTT-API">MQTT-API</a>.</p>
|
||||
</div>
|
||||
<p>Please fill me with an explanation and useful links.</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-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>
|
||||
</div>
|
||||
<p>Please fill me with an explanation and useful links.</p>
|
||||
<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>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>
|
||||
<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></li>
|
||||
</ul>
|
||||
<p>As higher the level, as more log messages get written to the SD-Card.</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>
|
||||
</div>
|
||||
<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>Number of days to keep the log 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-digits">Section <code>Digits</code></h2>
|
||||
@@ -691,33 +645,25 @@ A SD-Card has limited write cycles. Since the device does not support <a href="h
|
||||
<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>Threshold above which the classification should be to accept the value (only meaningful for digits).</p>
|
||||
<div class="admonition warning">
|
||||
<p class="admonition-title">Warning</p>
|
||||
<p>This is only supported for the <code>dig-class100</code> models!</p>
|
||||
</div>
|
||||
<p>Please fill me with an explanation and useful links.</p>
|
||||
<hr style="border:2px solid">
|
||||
|
||||
<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>
|
||||
<h3 id="parameter-model_1">Parameter <code>Model</code></h3>
|
||||
<p>Default Value: <code>/config/dig-cont_0600_s3.tflite</code></p>
|
||||
<p>Path to CNN model file for image recognition. See <a href="../Choosing-the-Model">here</a> for details. </p>
|
||||
<p>Please fill me with an explanation and useful links.</p>
|
||||
<hr style="border:2px solid">
|
||||
|
||||
<h2 id="section-gpio">Section <code>GPIO</code></h2>
|
||||
@@ -728,22 +674,7 @@ A SD-Card has limited write cycles. Since the device does not support <a href="h
|
||||
<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>This parameter can be used to configure the GPIO <code>IO0</code> pin.</p>
|
||||
<div class="admonition warning">
|
||||
<p class="admonition-title">Warning</p>
|
||||
<p>This pin is only usable with restrictions!
|
||||
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:</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>
|
||||
<p>Please fill me with an explanation and useful links.</p>
|
||||
<hr style="border:2px solid">
|
||||
|
||||
<p><a id=GPIO-IO1></a></p>
|
||||
@@ -753,20 +684,7 @@ Additionally, it is used to activate Bootloader mode and must therefore be HIGH
|
||||
<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>This parameter can be used to configure the GPIO <code>IO1</code> pin.</p>
|
||||
<div class="admonition warning">
|
||||
<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:</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>
|
||||
<p>Please fill me with an explanation and useful links.</p>
|
||||
<hr style="border:2px solid">
|
||||
|
||||
<p><a id=GPIO-IO12></a></p>
|
||||
@@ -776,20 +694,7 @@ Additionally, it is used to activate Bootloader mode and must therefore be HIGH
|
||||
<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>This parameter can be used to configure the GPIO <code>IO12</code> pin.</p>
|
||||
<div class="admonition note">
|
||||
<p class="admonition-title">Note</p>
|
||||
<p>This pin is usable without known restrictions!</p>
|
||||
</div>
|
||||
<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>
|
||||
<p>Please fill me with an explanation and useful links.</p>
|
||||
<hr style="border:2px solid">
|
||||
|
||||
<p><a id=GPIO-IO13></a></p>
|
||||
@@ -799,20 +704,7 @@ Additionally, it is used to activate Bootloader mode and must therefore be HIGH
|
||||
<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>This parameter can be used to configure the GPIO <code>IO13</code> pin.</p>
|
||||
<div class="admonition note">
|
||||
<p class="admonition-title">Note</p>
|
||||
<p>This pin is usable without known restrictions!</p>
|
||||
</div>
|
||||
<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>
|
||||
<p>Please fill me with an explanation and useful links.</p>
|
||||
<hr style="border:2px solid">
|
||||
|
||||
<p><a id=GPIO-IO3></a></p>
|
||||
@@ -822,20 +714,7 @@ Additionally, it is used to activate Bootloader mode and must therefore be HIGH
|
||||
<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>This parameter can be used to configure the GPIO <code>IO3</code> pin.</p>
|
||||
<div class="admonition warning">
|
||||
<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:</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>
|
||||
<p>Please fill me with an explanation and useful links.</p>
|
||||
<hr style="border:2px solid">
|
||||
|
||||
<p><a id=GPIO-IO4></a></p>
|
||||
@@ -845,40 +724,25 @@ Additionally, it is used to activate Bootloader mode and must therefore be HIGH
|
||||
<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>This parameter can be used to configure the GPIO <code>IO4</code> pin.</p>
|
||||
<div class="admonition warning">
|
||||
<p class="admonition-title">Warning</p>
|
||||
<p>This pin is only usable with restrictions!
|
||||
By default, it is used for build-in flash light (onboard LED).</p>
|
||||
</div>
|
||||
<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>
|
||||
<p>Please fill me with an explanation and useful links.</p>
|
||||
<hr style="border:2px solid">
|
||||
|
||||
<p><a id=GPIO-LEDColor></a></p>
|
||||
<h3 id="parameter-ledcolor">Parameter <code>LEDColor</code></h3>
|
||||
<p>Default Value: <code>150 150 150</code></p>
|
||||
<p>Color of the attached LEDs to GPIO12 in (R)ed, (G)reen (B)lue from <code>0</code> (full off) .. <code>255</code> (full on).
|
||||
(See <code>IO12</code> parameter).</p>
|
||||
<p>Please fill me with an explanation and useful links.</p>
|
||||
<hr style="border:2px solid">
|
||||
|
||||
<p><a id=GPIO-LEDNumbers></a></p>
|
||||
<h3 id="parameter-lednumbers">Parameter <code>LEDNumbers</code></h3>
|
||||
<p>Default Value: <code>2</code></p>
|
||||
<p>Number of LEDs on the external LED-stripe attached to GPIO12 (See <code>IO12</code> parameter).</p>
|
||||
<p>Please fill me with an explanation and useful links.</p>
|
||||
<hr style="border:2px solid">
|
||||
|
||||
<p><a id=GPIO-LEDType></a></p>
|
||||
<h3 id="parameter-ledtype">Parameter <code>LEDType</code></h3>
|
||||
<p>Default Value: <code>WS2812</code></p>
|
||||
<p>Type of the <code>WS2812x</code> which is connected to GPIO12 (See <code>IO12</code> parameter).</p>
|
||||
<p>Please fill me with an explanation and useful links.</p>
|
||||
<hr style="border:2px solid">
|
||||
|
||||
<p><a id=GPIO-MainTopicMQTT></a></p>
|
||||
@@ -888,116 +752,87 @@ By default, it is used for build-in flash light (onboard LED).</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>
|
||||
<p>Please fill me with an explanation and useful links.</p>
|
||||
<hr style="border:2px solid">
|
||||
|
||||
<h2 id="section-influxdb">Section <code>InfluxDB</code></h2>
|
||||
<p><a id=InfluxDB-Database></a></p>
|
||||
<h3 id="parameter-database">Parameter <code>Database</code></h3>
|
||||
<p>Default Value: <code>''</code></p>
|
||||
<p>Name of the Database into which to publish the values.</p>
|
||||
<p>Default Value: ``</p>
|
||||
<p>Please fill me with an explanation and useful links.</p>
|
||||
<hr style="border:2px solid">
|
||||
|
||||
<p><a id=InfluxDB-Measurement></a></p>
|
||||
<h3 id="parameter-measurement">Parameter <code>Measurement</code></h3>
|
||||
<p>Default Value: <code>undefined</code></p>
|
||||
<p>Name of the Measurement to use to publish the value.</p>
|
||||
<p>Please fill me with an explanation and useful links.</p>
|
||||
<hr style="border:2px solid">
|
||||
|
||||
<p><a id=InfluxDB-Uri></a></p>
|
||||
<h3 id="parameter-uri">Parameter <code>Uri</code></h3>
|
||||
<p>Default Value: <code>undefined</code></p>
|
||||
<p>URI of the HTTP interface to InfluxDB v1, without trailing slash, e.g. <code>http://192.168.1.1:8086</code>.</p>
|
||||
<div class="admonition note">
|
||||
<p class="admonition-title">Note</p>
|
||||
<p>Currently only InfluxDB v1 is supported!</p>
|
||||
</div>
|
||||
<p>Please fill me with an explanation and useful links.</p>
|
||||
<hr style="border:2px solid">
|
||||
|
||||
<p><a id=InfluxDB-password></a></p>
|
||||
<h3 id="parameter-password">Parameter <code>password</code></h3>
|
||||
<p>Default Value: <code>undefined</code></p>
|
||||
<p>Password for the InfluxDB v1 authentication.</p>
|
||||
<div class="admonition note">
|
||||
<p class="admonition-title">Note</p>
|
||||
<p>Currently only InfluxDB v1 is supported!</p>
|
||||
</div>
|
||||
<p>Please fill me with an explanation and useful links.</p>
|
||||
<hr style="border:2px solid">
|
||||
|
||||
<p><a id=InfluxDB-user></a></p>
|
||||
<h3 id="parameter-user">Parameter <code>user</code></h3>
|
||||
<p>Default Value: <code>undefined</code></p>
|
||||
<p>Username for the InfluxDB v1 authentication.</p>
|
||||
<div class="admonition note">
|
||||
<p class="admonition-title">Note</p>
|
||||
<p>Currently only InfluxDB v1 is supported!</p>
|
||||
</div>
|
||||
<p>Please fill me with an explanation and useful links.</p>
|
||||
<hr style="border:2px solid">
|
||||
|
||||
<h2 id="section-mqtt">Section <code>MQTT</code></h2>
|
||||
<p><a id=MQTT-ClientID></a></p>
|
||||
<h3 id="parameter-clientid">Parameter <code>ClientID</code></h3>
|
||||
<p>Default Value: <code>watermeter</code></p>
|
||||
<p>ClientID to connect to the MQTT broker.</p>
|
||||
<p>If disabled, the <code>hostname</code> will be used.</p>
|
||||
<p>Please fill me with an explanation and useful links.</p>
|
||||
<hr style="border:2px solid">
|
||||
|
||||
<p><a id=MQTT-HomeassistantDiscovery></a></p>
|
||||
<h3 id="parameter-homeassistantdiscovery">Parameter <code>HomeassistantDiscovery</code></h3>
|
||||
<p>Default Value: <code>true</code></p>
|
||||
<p>Enable or disable the Homeassistant Discovery.</p>
|
||||
<p>See <a href="../Integration-Home-Assistant">here</a> for details about the discovery.</p>
|
||||
<p>Please fill me with an explanation and useful links.</p>
|
||||
<hr style="border:2px solid">
|
||||
|
||||
<p><a id=MQTT-MainTopic></a></p>
|
||||
<h3 id="parameter-maintopic">Parameter <code>MainTopic</code></h3>
|
||||
<p>Default Value: <code>watermeter</code></p>
|
||||
<p>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:</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>. </p>
|
||||
<p>See <a href="../MQTT-API#result">MQTT Result Topics</a> for a full list of topics.</p>
|
||||
<p>Please fill me with an explanation and useful links.</p>
|
||||
<hr style="border:2px solid">
|
||||
|
||||
<p><a id=MQTT-MeterType></a></p>
|
||||
<h3 id="parameter-metertype">Parameter <code>MeterType</code></h3>
|
||||
<p>Default Value: <code>other</code></p>
|
||||
<p>Select the Meter Type so the sensors have the right units in Homeassistant.</p>
|
||||
<div class="admonition note">
|
||||
<p class="admonition-title">Note</p>
|
||||
<p>For <code>Watermeter</code> you need to have Homeassistant 2022.11 or newer!</p>
|
||||
</div>
|
||||
<p>Please also make sure that the selected Meter Type matches the dimension of the value provided by the meter!
|
||||
Eg. if your meter provides <code>m³</code>, you need to also set it to <code>m³</code>.
|
||||
Alternatively you can set the parameter <code>DecimalShift</code> to <code>3</code> so the value is converted to <code>liters</code>!</p>
|
||||
<p>Please fill me with an explanation and useful links.</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>
|
||||
<h3 id="parameter-uri_1">Parameter <code>Uri</code></h3>
|
||||
<p>Default Value: <code>mqtt://IP-ADRESS:1883</code></p>
|
||||
<p>URI to the MQTT broker including the port. E.g. <code>mqtt://192.168.1.1:1883</code>.</p>
|
||||
<p>Please fill me with an explanation and useful links.</p>
|
||||
<hr style="border:2px solid">
|
||||
|
||||
<p><a id=MQTT-password></a></p>
|
||||
<h3 id="parameter-password_1">Parameter <code>password</code></h3>
|
||||
<p>Default Value: <code>PASSWORD</code></p>
|
||||
<p>Password for MQTT authentication.</p>
|
||||
<p>Please fill me with an explanation and useful links.</p>
|
||||
<hr style="border:2px solid">
|
||||
|
||||
<p><a id=MQTT-user></a></p>
|
||||
<h3 id="parameter-user_1">Parameter <code>user</code></h3>
|
||||
<p>Default Value: <code>USERNAME</code></p>
|
||||
<p>Username for MQTT authentication.</p>
|
||||
<p>Please fill me with an explanation and useful links.</p>
|
||||
<hr style="border:2px solid">
|
||||
|
||||
<h2 id="section-makeimage">Section <code>MakeImage</code></h2>
|
||||
@@ -1006,10 +841,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>
|
||||
@@ -1017,22 +851,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>
|
||||
@@ -1042,8 +869,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 -->
|
||||
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>
|
||||
@@ -1053,11 +879,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>
|
||||
@@ -1067,12 +889,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>
|
||||
@@ -1080,26 +897,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>
|
||||
@@ -1107,14 +919,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>
|
||||
@@ -1124,16 +931,10 @@ 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>
|
||||
<hr style="border:2px solid">
|
||||
|
||||
<p><a id=PostProcessing-CheckDigitIncreaseConsistency></a></p>
|
||||
<h3 id="parameter-checkdigitincreaseconsistency">Parameter <code>CheckDigitIncreaseConsistency</code></h3>
|
||||
<p>Default Value: <code>false</code></p>
|
||||
@@ -1141,8 +942,7 @@ 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>An additional consistency check.
|
||||
It especially improves the zero crossing check between digits.</p>
|
||||
<p>Please fill me with an explanation and useful links.</p>
|
||||
<hr style="border:2px solid">
|
||||
|
||||
<p><a id=PostProcessing-ErrorMessage></a></p>
|
||||
@@ -1152,62 +952,49 @@ It especially improves the zero crossing check between digits.</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>Do not show error message in return value.
|
||||
In an error case, the last valid number will be used for the various transmission protocols (MQTT, InfluxDB, REST, ...).</p>
|
||||
<p>Please fill me with an explanation and useful links.</p>
|
||||
<hr style="border:2px solid">
|
||||
|
||||
<p><a id=PostProcessing-NUMBER.AllowNegativeRates></a></p>
|
||||
<h3 id="parameter-numbersallownegativerates">Parameter <code><NUMBERS>.AllowNegativeRates</code></h3>
|
||||
<h3 id="parameter-numberallownegativerates">Parameter <code>NUMBER.AllowNegativeRates</code></h3>
|
||||
<p>Default Value: <code>false</code></p>
|
||||
<p>Allow a meter to count backwards (decreasing values).</p>
|
||||
<div class="admonition note">
|
||||
<p class="admonition-title">Note</p>
|
||||
<p>This is unusual (it means there is a negative rate) and not wanted in most cases!</p>
|
||||
</div>
|
||||
<p>Please fill me with an explanation and useful links.</p>
|
||||
<hr style="border:2px solid">
|
||||
|
||||
<p><a id=PostProcessing-NUMBER.AnalogDigitalTransitionStart></a></p>
|
||||
<h3 id="parameter-numberanalogdigitaltransitionstart">Parameter <code><NUMBER>.AnalogDigitalTransitionStart</code></h3>
|
||||
<h3 id="parameter-numberanalogdigitaltransitionstart">Parameter <code>NUMBER.AnalogDigitalTransitionStart</code></h3>
|
||||
<p>Default Value: <code>9.2</code></p>
|
||||
<p>This can be used if you have wrong values, but the recognition of the individual ROIs are correct.
|
||||
Look for the start of changing of the first digit and note the analog pointer value behind.
|
||||
Set it here. Only used on combination of digits and analog pointers.
|
||||
See <a href="../Watermeter-specific-analog---digital-transition">here</a> for details.</p>
|
||||
<p>Please fill me with an explanation and useful links.</p>
|
||||
<hr style="border:2px solid">
|
||||
|
||||
<p><a id=PostProcessing-NUMBER.DecimalShift></a></p>
|
||||
<h3 id="parameter-numberdecimalshift">Parameter <code><NUMBER>.DecimalShift</code></h3>
|
||||
<h3 id="parameter-numberdecimalshift">Parameter <code>NUMBER.DecimalShift</code></h3>
|
||||
<p>Default Value: <code>0</code></p>
|
||||
<p>Shift the decimal separator (positiv or negativ).
|
||||
Eg. to move from 'm³' to 'liter' (1 m³ equals 1000 liters), you need to set it to +3.</p>
|
||||
<p>Please fill me with an explanation and useful links.</p>
|
||||
<hr style="border:2px solid">
|
||||
|
||||
<p><a id=PostProcessing-NUMBER.ExtendedResolution></a></p>
|
||||
<h3 id="parameter-numberextendedresolution">Parameter <code><NUMBER>.ExtendedResolution</code></h3>
|
||||
<h3 id="parameter-numberextendedresolution">Parameter <code>NUMBER.ExtendedResolution</code></h3>
|
||||
<p>Default Value: <code>false</code></p>
|
||||
<p>Use the decimal place of the last analog counter for increased accuracy.</p>
|
||||
<p>Please fill me with an explanation and useful links.</p>
|
||||
<hr style="border:2px solid">
|
||||
|
||||
<p><a id=PostProcessing-NUMBER.IgnoreLeadingNaN></a></p>
|
||||
<h3 id="parameter-numberignoreleadingnan">Parameter <code><NUMBER>.IgnoreLeadingNaN</code></h3>
|
||||
<h3 id="parameter-numberignoreleadingnan">Parameter <code>NUMBER.IgnoreLeadingNaN</code></h3>
|
||||
<p>Default Value: <code>true</code></p>
|
||||
<p>Leading <code>N</code>'s will be deleted before further processing.</p>
|
||||
<p>This is only relevant for models which use <code>N</code>!</p>
|
||||
<p>See <a href="../Choosing-the-Model">here</a> for details.</p>
|
||||
<p>Please fill me with an explanation and useful links.</p>
|
||||
<hr style="border:2px solid">
|
||||
|
||||
<p><a id=PostProcessing-NUMBER.MaxRateType></a></p>
|
||||
<h3 id="parameter-numbermaxratetype">Parameter <code><NUMBER>.MaxRateType</code></h3>
|
||||
<h3 id="parameter-numbermaxratetype">Parameter <code>NUMBER.MaxRateType</code></h3>
|
||||
<p>Default Value: <code>AbsoluteChange</code></p>
|
||||
<p>Defines if the <strong>Change Rate</strong> compared to the previous value is calculated as absolute change (<code>AbsoluteChange</code>) or
|
||||
as rate normalized to the interval (<code>RateChange</code> = change/minute).</p>
|
||||
<p>Please fill me with an explanation and useful links.</p>
|
||||
<hr style="border:2px solid">
|
||||
|
||||
<p><a id=PostProcessing-NUMBER.MaxRateValue></a></p>
|
||||
<h3 id="parameter-numbermaxratevalue">Parameter <code><NUMBER>.MaxRateValue</code></h3>
|
||||
<h3 id="parameter-numbermaxratevalue">Parameter <code>NUMBER.MaxRateValue</code></h3>
|
||||
<p>Default Value: <code>0.05</code></p>
|
||||
<p>Maximum change of a reading.</p>
|
||||
<p>Depending on the settings of <code><NUMBER>.MaxRateType</code> it is either treated as <code>absolute</code> or <code>relative</code>!</p>
|
||||
<p>Please fill me with an explanation and useful links.</p>
|
||||
<hr style="border:2px solid">
|
||||
|
||||
<p><a id=PostProcessing-PreValueAgeStartup></a></p>
|
||||
@@ -1217,14 +1004,13 @@ as rate normalized to the interval (<code>RateChange</code> = change/minute).</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>Time in minutes, how long a previous read value is valid after reboot.</p>
|
||||
<p>Please fill me with an explanation and useful links.</p>
|
||||
<hr style="border:2px solid">
|
||||
|
||||
<p><a id=PostProcessing-PreValueUse></a></p>
|
||||
<h3 id="parameter-prevalueuse">Parameter <code>PreValueUse</code></h3>
|
||||
<p>Default Value: <code>true</code></p>
|
||||
<p>Use the previous value (value from previous round) for consistency checks.
|
||||
This also works through a reboot of the device!</p>
|
||||
<p>Please fill me with an explanation and useful links.</p>
|
||||
<hr style="border:2px solid">
|
||||
|
||||
<h2 id="section-system">Section <code>System</code></h2>
|
||||
@@ -1235,6 +1021,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>
|
||||
@@ -1244,20 +1031,17 @@ This also works through a reboot of the device!</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>Hostname for the device.
|
||||
It gets automatically transferred to <code>/wlan.ini</code> on the SD-Card at next startup.</p>
|
||||
<p>Please fill me with an explanation and useful links.</p>
|
||||
<hr style="border:2px solid">
|
||||
|
||||
<p><a id=System-RSSIThreashold></a></p>
|
||||
<h3 id="parameter-rssithreashold">Parameter <code>RSSIThreashold</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>
|
||||
<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-SetupMode></a></p>
|
||||
@@ -1267,7 +1051,7 @@ It gets automatically transferred to <code>/wlan.ini</code> on the SD-Card at ne
|
||||
<p class="admonition-title">Note</p>
|
||||
<p>This parameter is not accessible through the Web Interface Configuration Page!</p>
|
||||
</div>
|
||||
<p>Set this parameter to <code>true</code> to stay in the Setup Mode after the next start of the device.</p>
|
||||
<p>Please fill me with an explanation and useful links.</p>
|
||||
<hr style="border:2px solid">
|
||||
|
||||
<p><a id=System-TimeServer></a></p>
|
||||
@@ -1277,17 +1061,13 @@ It gets automatically transferred to <code>/wlan.ini</code> on the SD-Card at ne
|
||||
<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>Time server to synchronize system time. If it is disabled or <code>undefined</code>, <code>pool.ntp.org</code> will be used.
|
||||
You can also set it to the IP of your router. Many routers like Fritzboxes can act as a local NTP server.
|
||||
To disable NTP, you need to activate it but set the TimeServer config to be empty (<code>""</code>).
|
||||
In such case the time always starts at <code>01.01.1970</code> after each power cycle!</p>
|
||||
<p>Please fill me with an explanation and useful links.</p>
|
||||
<hr style="border:2px solid">
|
||||
|
||||
<p><a id=System-TimeZone></a></p>
|
||||
<h3 id="parameter-timezone">Parameter <code>TimeZone</code></h3>
|
||||
<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://<DEVICE IP>/timezones.html</code> to find the settings for your region.</p>
|
||||
<p>Please fill me with an explanation and useful links.</p>
|
||||
<hr style="border:2px solid">
|
||||
|
||||
</div>
|
||||
|
||||
Reference in New Issue
Block a user