Mirror/AI-on-the-edge-device-docs
1
0
Fork 0
mirror of https://github.com/jomjol/AI-on-the-edge-device-docs.git synced 2025-12-10 13:36:56 +03:00
Code Issues Packages Projects Releases Wiki Activity

Deployed d6af725 with MkDocs version: 1.4.2

Browse Source
This commit is contained in:
github-actions[bot]
2023-02-22 09:46:00 +00:00
parent 56530ea619
commit dcc72ebee0
3 changed files with 81 additions and 191 deletions
Download Patch File Download Diff File Expand all files Collapse all files

270
Parameters/index.html
View File

@@ -86,8 +86,6 @@
<ul class="current"> <ul class="current">
<li class="toctree-l1 current"><a class="reference internal current" href="./">Parameters</a> <li class="toctree-l1 current"><a class="reference internal current" href="./">Parameters</a>
<ul class="current"> <ul class="current">
<li class="toctree-l2"><a class="reference internal" href="#list-of-all-parameters">List of all Parameters</a>
</li>
<li class="toctree-l2"><a class="reference internal" href="#section-alignment">Section Alignment</a> <li class="toctree-l2"><a class="reference internal" href="#section-alignment">Section Alignment</a>
<ul> <ul>
<li class="toctree-l3"><a class="reference internal" href="#parameter-alignmentalgo">Parameter AlignmentAlgo</a> <li class="toctree-l3"><a class="reference internal" href="#parameter-alignmentalgo">Parameter AlignmentAlgo</a>
@@ -198,7 +196,7 @@
</li> </li>
<li class="toctree-l3"><a class="reference internal" href="#parameter-measurement_1">Parameter Measurement</a> <li class="toctree-l3"><a class="reference internal" href="#parameter-measurement_1">Parameter Measurement</a>
</li> </li>
<li class="toctree-l3"><a class="reference internal" href="#parameter-numberfieldname">Parameter NUMBER.fieldname</a> <li class="toctree-l3"><a class="reference internal" href="#parameter-numberfieldname">Parameter &lt;NUMBER&gt;.fieldname</a>
</li> </li>
<li class="toctree-l3"><a class="reference internal" href="#parameter-org">Parameter Org</a> <li class="toctree-l3"><a class="reference internal" href="#parameter-org">Parameter Org</a>
</li> </li>
@@ -385,130 +383,12 @@
<h1 id="parameters">Parameters</h1> <h1 id="parameters">Parameters</h1>
<p>This page lists all available <a href="../Configuration">Configuration</a> Parameters. <p>This page lists all available <a href="../Configuration">Configuration</a> Parameters.
If a parameter or section has a tick box on its left side, you can disable it. If a <strong>parameter</strong> or <strong>section</strong> has a tick box on its left side, you can disable it.
In such case the functionality gets disabled respectively the default values will be used.</p> In such case the functionality gets disabled respectively the default values will be used.</p>
<div class="admonition note"> <div class="admonition note">
<p class="admonition-title">Note</p> <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> <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>
<h2 id="list-of-all-parameters">List of all Parameters</h2>
<p><a href="#alignment">Alignment</a></p>
<ul>
<li><a href="#Alignment-AlignmentAlgo"><code>AlignmentAlgo</code></a></li>
<li><a href="#Alignment-FlipImageSize"><code>FlipImageSize</code></a></li>
<li><a href="#Alignment-InitialMirror"><code>InitialMirror</code></a></li>
<li><a href="#Alignment-InitialRotate"><code>InitialRotate</code></a></li>
<li><a href="#Alignment-SearchFieldX"><code>SearchFieldX</code></a></li>
<li><a href="#Alignment-SearchFieldY"><code>SearchFieldY</code></a></li>
</ul>
<p><a href="#analog">Analog</a></p>
<ul>
<li><a href="#Analog-CNNGoodThreshold"><code>CNNGoodThreshold</code></a></li>
<li><a href="#Analog-ExtendedResolution"><code>ExtendedResolution</code></a></li>
<li><a href="#Analog-Model"><code>Model</code></a></li>
<li><a href="#Analog-ROIImagesLocation"><code>ROIImagesLocation</code></a></li>
<li><a href="#Analog-ROIImagesRetention"><code>ROIImagesRetention</code></a></li>
</ul>
<p><a href="#autotimer">AutoTimer</a></p>
<ul>
<li><a href="#AutoTimer-AutoStart"><code>AutoStart</code></a></li>
<li><a href="#AutoTimer-Interval"><code>Interval</code></a></li>
</ul>
<p><a href="#datalogging">DataLogging</a></p>
<ul>
<li><a href="#DataLogging-DataFilesRetention"><code>DataFilesRetention</code></a></li>
<li><a href="#DataLogging-DataLogActive"><code>DataLogActive</code></a></li>
</ul>
<p><a href="#debug">Debug</a></p>
<ul>
<li><a href="#Debug-LogLevel"><code>LogLevel</code></a></li>
<li><a href="#Debug-LogfilesRetention"><code>LogfilesRetention</code></a></li>
</ul>
<p><a href="#digits">Digits</a></p>
<ul>
<li><a href="#Digits-CNNGoodThreshold"><code>CNNGoodThreshold</code></a></li>
<li><a href="#Digits-Model"><code>Model</code></a></li>
<li><a href="#Digits-ROIImagesLocation"><code>ROIImagesLocation</code></a></li>
<li><a href="#Digits-ROIImagesRetention"><code>ROIImagesRetention</code></a></li>
</ul>
<p><a href="#gpio">GPIO</a></p>
<ul>
<li><a href="#GPIO-IO0"><code>IO0</code></a></li>
<li><a href="#GPIO-IO1"><code>IO1</code></a></li>
<li><a href="#GPIO-IO12"><code>IO12</code></a></li>
<li><a href="#GPIO-IO13"><code>IO13</code></a></li>
<li><a href="#GPIO-IO3"><code>IO3</code></a></li>
<li><a href="#GPIO-IO4"><code>IO4</code></a></li>
<li><a href="#GPIO-LEDColor"><code>LEDColor</code></a></li>
<li><a href="#GPIO-LEDNumbers"><code>LEDNumbers</code></a></li>
<li><a href="#GPIO-LEDType"><code>LEDType</code></a></li>
<li><a href="#GPIO-MainTopicMQTT"><code>MainTopicMQTT</code></a></li>
</ul>
<p><a href="#influxdb">InfluxDB</a></p>
<ul>
<li><a href="#InfluxDB-Database"><code>Database</code></a></li>
<li><a href="#InfluxDB-Measurement"><code>Measurement</code></a></li>
<li><a href="#InfluxDB-Uri"><code>Uri</code></a></li>
<li><a href="#InfluxDB-password"><code>password</code></a></li>
<li><a href="#InfluxDB-user"><code>user</code></a></li>
</ul>
<p><a href="#influxdbv2">InfluxDBv2</a></p>
<ul>
<li><a href="#InfluxDBv2-Database"><code>Database</code></a></li>
<li><a href="#InfluxDBv2-Measurement"><code>Measurement</code></a></li>
<li><a href="#InfluxDBv2-NUMBER.fieldname"><code>NUMBER.fieldname</code></a></li>
<li><a href="#InfluxDBv2-Org"><code>Org</code></a></li>
<li><a href="#InfluxDBv2-Uri"><code>Uri</code></a></li>
<li><a href="#InfluxDBv2-token"><code>token</code></a></li>
</ul>
<p><a href="#mqtt">MQTT</a></p>
<ul>
<li><a href="#MQTT-ClientID"><code>ClientID</code></a></li>
<li><a href="#MQTT-HomeassistantDiscovery"><code>HomeassistantDiscovery</code></a></li>
<li><a href="#MQTT-MainTopic"><code>MainTopic</code></a></li>
<li><a href="#MQTT-MeterType"><code>MeterType</code></a></li>
<li><a href="#MQTT-RetainMessages"><code>RetainMessages</code></a></li>
<li><a href="#MQTT-Uri"><code>Uri</code></a></li>
<li><a href="#MQTT-password"><code>password</code></a></li>
<li><a href="#MQTT-user"><code>user</code></a></li>
</ul>
<p><a href="#postprocessing">PostProcessing</a></p>
<ul>
<li><a href="#PostProcessing-AllowNegativeRates"><code>AllowNegativeRates</code></a></li>
<li><a href="#PostProcessing-CheckDigitIncreaseConsistency"><code>CheckDigitIncreaseConsistency</code></a></li>
<li><a href="#PostProcessing-ErrorMessage"><code>ErrorMessage</code></a></li>
<li><a href="#PostProcessing-NUMBER.AllowNegativeRates"><code>NUMBER.AllowNegativeRates</code></a></li>
<li><a href="#PostProcessing-NUMBER.AnalogDigitalTransitionStart"><code>NUMBER.AnalogDigitalTransitionStart</code></a></li>
<li><a href="#PostProcessing-NUMBER.DecimalShift"><code>NUMBER.DecimalShift</code></a></li>
<li><a href="#PostProcessing-NUMBER.ExtendedResolution"><code>NUMBER.ExtendedResolution</code></a></li>
<li><a href="#PostProcessing-NUMBER.IgnoreLeadingNaN"><code>NUMBER.IgnoreLeadingNaN</code></a></li>
<li><a href="#PostProcessing-NUMBER.MaxRateType"><code>NUMBER.MaxRateType</code></a></li>
<li><a href="#PostProcessing-NUMBER.MaxRateValue"><code>NUMBER.MaxRateValue</code></a></li>
<li><a href="#PostProcessing-PreValueAgeStartup"><code>PreValueAgeStartup</code></a></li>
<li><a href="#PostProcessing-PreValueUse"><code>PreValueUse</code></a></li>
</ul>
<p><a href="#system">System</a></p>
<ul>
<li><a href="#System-Hostname"><code>Hostname</code></a></li>
<li><a href="#System-RSSIThreshold"><code>RSSIThreshold</code></a></li>
<li><a href="#System-SetupMode"><code>SetupMode</code></a></li>
<li><a href="#System-TimeServer"><code>TimeServer</code></a></li>
<li><a href="#System-TimeZone"><code>TimeZone</code></a></li>
</ul>
<p><a href="#takeimage">TakeImage</a></p>
<ul>
<li><a href="#TakeImage-Brightness"><code>Brightness</code></a></li>
<li><a href="#TakeImage-Contrast"><code>Contrast</code></a></li>
<li><a href="#TakeImage-Demo"><code>Demo</code></a></li>
<li><a href="#TakeImage-FixedExposure"><code>FixedExposure</code></a></li>
<li><a href="#TakeImage-ImageQuality"><code>ImageQuality</code></a></li>
<li><a href="#TakeImage-ImageSize"><code>ImageSize</code></a></li>
<li><a href="#TakeImage-LEDIntensity"><code>LEDIntensity</code></a></li>
<li><a href="#TakeImage-RawImagesLocation"><code>RawImagesLocation</code></a></li>
<li><a href="#TakeImage-RawImagesRetention"><code>RawImagesRetention</code></a></li>
<li><a href="#TakeImage-Saturation"><code>Saturation</code></a></li>
<li><a href="#TakeImage-WaitBeforeTakingPicture"><code>WaitBeforeTakingPicture</code></a></li>
</ul>
<hr style="border:2px solid"> <hr style="border:2px solid">
<h2 id="section-alignment">Section <code>Alignment</code></h2> <h2 id="section-alignment">Section <code>Alignment</code></h2>
<p><a id=Alignment-AlignmentAlgo></a></p> <p><a id=Alignment-AlignmentAlgo></a></p>
@@ -656,7 +536,8 @@ Use <a href="../Parameters/#PostProcessing-NUMBER.ExtendedResolution"><code>NUMB
<div class="admonition note"> <div class="admonition note">
<p class="admonition-title">Note</p> <p class="admonition-title">Note</p>
<p>Typically this is set to <code>true</code>. <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> The main reasons to set it to <code>false</code> is when you want to trigger it manually using the
<a href="../REST-API">REST API</a> or <a href="../MQTT-API">MQTT-API</a> or for debugging.</p>
</div> </div>
<hr style="border:2px solid"> <hr style="border:2px solid">
@@ -896,15 +777,15 @@ By default, it is used for build-in flash light (onboard LED).</p>
<p><a id=GPIO-LEDColor></a></p> <p><a id=GPIO-LEDColor></a></p>
<h3 id="parameter-ledcolor">Parameter <code>LEDColor</code></h3> <h3 id="parameter-ledcolor">Parameter <code>LEDColor</code></h3>
<p>Default Value: <code>150 150 150</code> <p>Default Value: <code>150 150 150</code></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). <p>Color of the attached LEDs to GPIO12 in <strong>R</strong>ed, <strong>G</strong>reen <strong>B</strong>lue from <code>0</code> (full off) .. <code>255</code> (full on)
(See <code>IO12</code> parameter).</p> (See <code>IO12</code> parameter).</p>
<hr style="border:2px solid"> <hr style="border:2px solid">
<p><a id=GPIO-LEDNumbers></a></p> <p><a id=GPIO-LEDNumbers></a></p>
<h3 id="parameter-lednumbers">Parameter <code>LEDNumbers</code></h3> <h3 id="parameter-lednumbers">Parameter <code>LEDNumbers</code></h3>
<p>Default Value: <code>2</code> <p>Default Value: <code>2</code></p>
Number of LEDs on the external LED-stripe attached to GPIO12 (See <code>IO12</code> parameter).</p> <p>Number of LEDs on the external LED-stripe attached to GPIO12 (See <code>IO12</code> parameter).</p>
<hr style="border:2px solid"> <hr style="border:2px solid">
<p><a id=GPIO-LEDType></a></p> <p><a id=GPIO-LEDType></a></p>
@@ -926,107 +807,116 @@ Type of the <code>WS2812x</code> which is connected to GPIO12 (See <code>IO12</c
<h2 id="section-influxdb">Section <code>InfluxDB</code></h2> <h2 id="section-influxdb">Section <code>InfluxDB</code></h2>
<p><a id=InfluxDB-Database></a></p> <p><a id=InfluxDB-Database></a></p>
<h3 id="parameter-database">Parameter <code>Database</code></h3> <h3 id="parameter-database">Parameter <code>Database</code></h3>
<p>Default Value: <code>''</code> <p>Default Value: <code>''</code></p>
Name of the Database into which to publish the values.</p> <p>Name of the InfluxDB v1 Database into which to publish the values.</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>See section <code>InfluxDBv2</code> for InfluxDB v2 support! </p>
</div>
<hr style="border:2px solid"> <hr style="border:2px solid">
<p><a id=InfluxDB-Measurement></a></p> <p><a id=InfluxDB-Measurement></a></p>
<h3 id="parameter-measurement">Parameter <code>Measurement</code></h3> <h3 id="parameter-measurement">Parameter <code>Measurement</code></h3>
<p>Default Value: <code>undefined</code> <p>Default Value: <code>undefined</code></p>
Name of the Measurement to use to publish the value.</p> <p>Name of the InfluxDB v1 Measurement to use to publish the value.</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>See section <code>InfluxDBv2</code> for InfluxDB v2 support! </p>
</div>
<hr style="border:2px solid"> <hr style="border:2px solid">
<p><a id=InfluxDB-Uri></a></p> <p><a id=InfluxDB-Uri></a></p>
<h3 id="parameter-uri">Parameter <code>Uri</code></h3> <h3 id="parameter-uri">Parameter <code>Uri</code></h3>
<p>Default Value: <code>undefined</code> <p>Default Value: <code>undefined</code></p>
URI of the HTTP interface to InfluxDB v1, without trailing slash, e.g. <code>http://192.168.1.1:8086</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"> <div class="admonition note">
<p class="admonition-title">Note</p> <p class="admonition-title">Note</p>
<p>Currently only InfluxDB v1 is supported!</p> <p>See section <code>InfluxDBv2</code> for InfluxDB v2 support! </p>
</div> </div>
<hr style="border:2px solid"> <hr style="border:2px solid">
<p><a id=InfluxDB-password></a></p> <p><a id=InfluxDB-password></a></p>
<h3 id="parameter-password">Parameter <code>password</code></h3> <h3 id="parameter-password">Parameter <code>password</code></h3>
<p>Default Value: <code>undefined</code> <p>Default Value: <code>undefined</code></p>
Password for the InfluxDB v1 authentication.</p> <p>Password for the InfluxDB v1 authentication.</p>
<div class="admonition note"> <div class="admonition note">
<p class="admonition-title">Note</p> <p class="admonition-title">Note</p>
<p>Currently only InfluxDB v1 is supported!</p> <p>See section <code>InfluxDBv2</code> for InfluxDB v2 support! </p>
</div> </div>
<hr style="border:2px solid"> <hr style="border:2px solid">
<p><a id=InfluxDB-user></a></p> <p><a id=InfluxDB-user></a></p>
<h3 id="parameter-user">Parameter <code>user</code></h3> <h3 id="parameter-user">Parameter <code>user</code></h3>
<p>Default Value: <code>undefined</code> <p>Default Value: <code>undefined</code></p>
Username for the InfluxDB v1 authentication.</p> <p>Username for the InfluxDB v1 authentication.</p>
<div class="admonition note"> <div class="admonition note">
<p class="admonition-title">Note</p> <p class="admonition-title">Note</p>
<p>Currently only InfluxDB v1 is supported!</p> <p>See section <code>InfluxDBv2</code> for InfluxDB v2 support! </p>
</div> </div>
<hr style="border:2px solid"> <hr style="border:2px solid">
<h2 id="section-influxdbv2">Section <code>InfluxDBv2</code></h2> <h2 id="section-influxdbv2">Section <code>InfluxDBv2</code></h2>
<p><a id=InfluxDBv2-Database></a></p> <p><a id=InfluxDBv2-Database></a></p>
<h3 id="parameter-database_1">Parameter <code>Database</code></h3> <h3 id="parameter-database_1">Parameter <code>Database</code></h3>
<p>Default Value: ``</p> <p>Default Value: <code>''</code></p>
<p>Please fill me with an explanation and useful links.</p> <p>Name of the InfluxDB v2 Database into which to publish the values.</p>
<hr style="border:2px solid"> <hr style="border:2px solid">
<p><a id=InfluxDBv2-Measurement></a></p> <p><a id=InfluxDBv2-Measurement></a></p>
<h3 id="parameter-measurement_1">Parameter <code>Measurement</code></h3> <h3 id="parameter-measurement_1">Parameter <code>Measurement</code></h3>
<p>Default Value: <code>undefined</code></p> <p>Default Value: <code>undefined</code></p>
<p>Please fill me with an explanation and useful links.</p> <p>Name of the InfluxDB v2 Measurement to use to publish the value.</p>
<hr style="border:2px solid"> <hr style="border:2px solid">
<p><a id=InfluxDBv2-NUMBER.fieldname></a></p> <p><a id=InfluxDBv2-NUMBER.fieldname></a></p>
<h3 id="parameter-numberfieldname">Parameter <code>NUMBER.fieldname</code></h3> <h3 id="parameter-numberfieldname">Parameter <code>&lt;NUMBER&gt;.fieldname</code></h3>
<p>Default Value: <code>undefined</code></p> <p>Default Value: <code>undefined</code></p>
<p>Please fill me with an explanation and useful links.</p> <p>Fieldname for InfluxDB v2 to use for saving.</p>
<hr style="border:2px solid"> <hr style="border:2px solid">
<p><a id=InfluxDBv2-Org></a></p> <p><a id=InfluxDBv2-Org></a></p>
<h3 id="parameter-org">Parameter <code>Org</code></h3> <h3 id="parameter-org">Parameter <code>Org</code></h3>
<p>Default Value: <code>undefined</code></p> <p>Default Value: <code>undefined</code></p>
<p>Please fill me with an explanation and useful links.</p> <p>Organisation (Org) for InfluxDB v2 authentication</p>
<hr style="border:2px solid"> <hr style="border:2px solid">
<p><a id=InfluxDBv2-Uri></a></p> <p><a id=InfluxDBv2-Uri></a></p>
<h3 id="parameter-uri_1">Parameter <code>Uri</code></h3> <h3 id="parameter-uri_1">Parameter <code>Uri</code></h3>
<p>Default Value: <code>undefined</code></p> <p>Default Value: <code>undefined</code></p>
<p>Please fill me with an explanation and useful links.</p> <p>URI of the HTTP interface to InfluxDB v2, without trailing slash, e.g. <code>http://192.168.1.1:8086</code>.</p>
<hr style="border:2px solid"> <hr style="border:2px solid">
<p><a id=InfluxDBv2-token></a></p> <p><a id=InfluxDBv2-token></a></p>
<h3 id="parameter-token">Parameter <code>token</code></h3> <h3 id="parameter-token">Parameter <code>token</code></h3>
<p>Default Value: <code>undefined</code></p> <p>Default Value: <code>undefined</code></p>
<p>Please fill me with an explanation and useful links.</p> <p>Token for InfluxDB v2 authentication</p>
<hr style="border:2px solid"> <hr style="border:2px solid">
<h2 id="section-mqtt">Section <code>MQTT</code></h2> <h2 id="section-mqtt">Section <code>MQTT</code></h2>
<p><a id=MQTT-ClientID></a></p> <p><a id=MQTT-ClientID></a></p>
<h3 id="parameter-clientid">Parameter <code>ClientID</code></h3> <h3 id="parameter-clientid">Parameter <code>ClientID</code></h3>
<p>Default Value: <code>watermeter</code> <p>Default Value: <code>watermeter</code></p>
ClientID to connect to the MQTT broker. <p>Client ID used to connect to the MQTT broker.
If disabled, the <code>hostname</code> will be used.</p> If disabled, the <code>hostname</code> will be used.</p>
<hr style="border:2px solid"> <hr style="border:2px solid">
<p><a id=MQTT-HomeassistantDiscovery></a></p> <p><a id=MQTT-HomeassistantDiscovery></a></p>
<h3 id="parameter-homeassistantdiscovery">Parameter <code>HomeassistantDiscovery</code></h3> <h3 id="parameter-homeassistantdiscovery">Parameter <code>HomeassistantDiscovery</code></h3>
<p>Default Value: <code>true</code> <p>Default Value: <code>true</code></p>
Enable or disable the Homeassistant Discovery. <p>Enable or disable the Homeassistant Discovery.
See <a href="../Integration-Home-Assistant">here</a> for details about the discovery.</p> See <a href="../Integration-Home-Assistant">here</a> for details about the discovery.</p>
<hr style="border:2px solid"> <hr style="border:2px solid">
<p><a id=MQTT-MainTopic></a></p> <p><a id=MQTT-MainTopic></a></p>
<h3 id="parameter-maintopic">Parameter <code>MainTopic</code></h3> <h3 id="parameter-maintopic">Parameter <code>MainTopic</code></h3>
<p>Default Value: <code>watermeter</code> <p>Default Value: <code>watermeter</code></p>
MQTT main topic, under which the counters are published.</p> <p>MQTT main topic, under which the counters are published.</p>
<p>The single value will be published with the following key: <code>MAINTOPIC/NUMBER/RESULT_TOPIC</code> where:</p> <p>The single value will be published with the following key: <code>MAINTOPIC/NUMBER/RESULT_TOPIC</code></p>
<p>With:</p>
<ul> <ul>
<li><code>NUMBER</code> is the name of the value (a meter might have more than one value). <li><code>NUMBER</code>: 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> 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> <li><code>RESULT_TOPIC</code>: Automatically filled with the right name, eg. <code>value</code>, <code>rate</code>, <code>timestamp</code>, <code>error</code>, ....</li>
</ul> </ul>
<p>The general connection status can be found in <code>MAINTOPIC/CONNECTION</code>. <p>The general connection status can be found in <code>MAINTOPIC/CONNECTION</code>.
See <a href="../MQTT-API#result">MQTT Result Topics</a> for a full list of topics.</p> See <a href="../MQTT-API#result">MQTT Result Topics</a> for a full list of topics.</p>
@@ -1034,8 +924,8 @@ See <a href="../MQTT-API#result">MQTT Result Topics</a> for a full list of topic
<p><a id=MQTT-MeterType></a></p> <p><a id=MQTT-MeterType></a></p>
<h3 id="parameter-metertype">Parameter <code>MeterType</code></h3> <h3 id="parameter-metertype">Parameter <code>MeterType</code></h3>
<p>Default Value: <code>other</code> <p>Default Value: <code>other</code></p>
Select the Meter Type so the sensors have the right units in Homeassistant.</p> <p>Select the Meter Type so the sensors have the right units in Homeassistant.</p>
<div class="admonition note"> <div class="admonition note">
<p class="admonition-title">Note</p> <p class="admonition-title">Note</p>
<p>For <code>Watermeter</code> you need to have Homeassistant 2022.11 or newer!</p> <p>For <code>Watermeter</code> you need to have Homeassistant 2022.11 or newer!</p>
@@ -1047,26 +937,26 @@ Alternatively you can set the parameter <code>DecimalShift</code> to <code>3</co
<p><a id=MQTT-RetainMessages></a></p> <p><a id=MQTT-RetainMessages></a></p>
<h3 id="parameter-retainmessages">Parameter <code>RetainMessages</code></h3> <h3 id="parameter-retainmessages">Parameter <code>RetainMessages</code></h3>
<p>Default Value: <code>true</code> <p>Default Value: <code>true</code></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> <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"> <hr style="border:2px solid">
<p><a id=MQTT-Uri></a></p> <p><a id=MQTT-Uri></a></p>
<h3 id="parameter-uri_2">Parameter <code>Uri</code></h3> <h3 id="parameter-uri_2">Parameter <code>Uri</code></h3>
<p>Default Value: <code>mqtt://IP-ADRESS:1883</code> <p>Default Value: <code>mqtt://IP-ADRESS:1883</code></p>
URI to the MQTT broker including the port. E.g. <code>mqtt://192.168.1.1:1883</code>.</p> <p>URI to the MQTT broker including the port. E.g. <code>mqtt://192.168.1.1:1883</code>.</p>
<hr style="border:2px solid"> <hr style="border:2px solid">
<p><a id=MQTT-password></a></p> <p><a id=MQTT-password></a></p>
<h3 id="parameter-password_1">Parameter <code>password</code></h3> <h3 id="parameter-password_1">Parameter <code>password</code></h3>
<p>Default Value: <code>PASSWORD</code> <p>Default Value: <code>PASSWORD</code></p>
Password for MQTT authentication.</p> <p>Password for MQTT authentication.</p>
<hr style="border:2px solid"> <hr style="border:2px solid">
<p><a id=MQTT-user></a></p> <p><a id=MQTT-user></a></p>
<h3 id="parameter-user_1">Parameter <code>user</code></h3> <h3 id="parameter-user_1">Parameter <code>user</code></h3>
<p>Default Value: <code>USERNAME</code> <p>Default Value: <code>USERNAME</code></p>
Username for MQTT authentication.</p> <p>Username for MQTT authentication.</p>
<hr style="border:2px solid"> <hr style="border:2px solid">
<h2 id="section-postprocessing">Section <code>PostProcessing</code></h2> <h2 id="section-postprocessing">Section <code>PostProcessing</code></h2>
@@ -1103,8 +993,8 @@ In an error case, the last valid number will be used for the various transmissio
<p><a id=PostProcessing-NUMBER.AllowNegativeRates></a></p> <p><a id=PostProcessing-NUMBER.AllowNegativeRates></a></p>
<h3 id="parameter-numbersallownegativerates">Parameter <code>&lt;NUMBERS&gt;.AllowNegativeRates</code></h3> <h3 id="parameter-numbersallownegativerates">Parameter <code>&lt;NUMBERS&gt;.AllowNegativeRates</code></h3>
<p>Default Value: <code>false</code> <p>Default Value: <code>false</code></p>
Allow a meter to count backwards (decreasing values).</p> <p>Allow a meter to count backwards (decreasing values).</p>
<div class="admonition note"> <div class="admonition note">
<p class="admonition-title">Note</p> <p class="admonition-title">Note</p>
<p>This is unusual (it means there is a negative rate) and not wanted in most cases!</p> <p>This is unusual (it means there is a negative rate) and not wanted in most cases!</p>
@@ -1113,8 +1003,8 @@ Allow a meter to count backwards (decreasing values).</p>
<p><a id=PostProcessing-NUMBER.AnalogDigitalTransitionStart></a></p> <p><a id=PostProcessing-NUMBER.AnalogDigitalTransitionStart></a></p>
<h3 id="parameter-numberanalogdigitaltransitionstart">Parameter <code>&lt;NUMBER&gt;.AnalogDigitalTransitionStart</code></h3> <h3 id="parameter-numberanalogdigitaltransitionstart">Parameter <code>&lt;NUMBER&gt;.AnalogDigitalTransitionStart</code></h3>
<p>Default Value: <code>9.2</code> <p>Default Value: <code>9.2</code></p>
This can be used if you have wrong values, but the recognition of the individual ROIs are correct. <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. 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. 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> See <a href="../Watermeter-specific-analog---digital-transition">here</a> for details.</p>
@@ -1122,15 +1012,15 @@ See <a href="../Watermeter-specific-analog---digital-transition">here</a> for de
<p><a id=PostProcessing-NUMBER.DecimalShift></a></p> <p><a id=PostProcessing-NUMBER.DecimalShift></a></p>
<h3 id="parameter-numberdecimalshift">Parameter <code>&lt;NUMBER&gt;.DecimalShift</code></h3> <h3 id="parameter-numberdecimalshift">Parameter <code>&lt;NUMBER&gt;.DecimalShift</code></h3>
<p>Default Value: <code>0</code> <p>Default Value: <code>0</code></p>
Shift the decimal separator (positiv or negativ). <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> Eg. to move from <code>m³</code> to <code>liter</code> (<code>1 m³</code> equals <code>1000 liters</code>), you need to set it to <code>+3</code>.</p>
<hr style="border:2px solid"> <hr style="border:2px solid">
<p><a id=PostProcessing-NUMBER.ExtendedResolution></a></p> <p><a id=PostProcessing-NUMBER.ExtendedResolution></a></p>
<h3 id="parameter-numberextendedresolution">Parameter <code>&lt;NUMBER&gt;.ExtendedResolution</code></h3> <h3 id="parameter-numberextendedresolution">Parameter <code>&lt;NUMBER&gt;.ExtendedResolution</code></h3>
<p>Default Value: <code>false</code> <p>Default Value: <code>false</code></p>
Use the decimal place of the last analog counter for increased accuracy.</p> <p>Use the decimal place of the last analog counter for increased accuracy.</p>
<div class="admonition note"> <div class="admonition note">
<p class="admonition-title">Note</p> <p class="admonition-title">Note</p>
<p>This parameter is only supported on the <code>*-class*</code> and <code>*-const</code> models! See <a href="../Choosing-the-Model">Choosing-the-Model</a> for details.</p> <p>This parameter is only supported on the <code>*-class*</code> and <code>*-const</code> models! See <a href="../Choosing-the-Model">Choosing-the-Model</a> for details.</p>
@@ -1139,23 +1029,23 @@ Use the decimal place of the last analog counter for increased accuracy.</p>
<p><a id=PostProcessing-NUMBER.IgnoreLeadingNaN></a></p> <p><a id=PostProcessing-NUMBER.IgnoreLeadingNaN></a></p>
<h3 id="parameter-numberignoreleadingnan">Parameter <code>&lt;NUMBER&gt;.IgnoreLeadingNaN</code></h3> <h3 id="parameter-numberignoreleadingnan">Parameter <code>&lt;NUMBER&gt;.IgnoreLeadingNaN</code></h3>
<p>Default Value: <code>true</code> <p>Default Value: <code>true</code></p>
Leading <code>N</code>'s will be deleted before further processing. <p>Leading <code>N</code>'s will be deleted before further processing.
This is only relevant for models which use <code>N</code>! This is only relevant for models which use <code>N</code>!
See <a href="../Choosing-the-Model">here</a> for details.</p> See <a href="../Choosing-the-Model">here</a> for details.</p>
<hr style="border:2px solid"> <hr style="border:2px solid">
<p><a id=PostProcessing-NUMBER.MaxRateType></a></p> <p><a id=PostProcessing-NUMBER.MaxRateType></a></p>
<h3 id="parameter-numbermaxratetype">Parameter <code>&lt;NUMBER&gt;.MaxRateType</code></h3> <h3 id="parameter-numbermaxratetype">Parameter <code>&lt;NUMBER&gt;.MaxRateType</code></h3>
<p>Default Value: <code>AbsoluteChange</code> <p>Default Value: <code>AbsoluteChange</code></p>
Defines if the <strong>Change Rate</strong> compared to the previous value is calculated as absolute change (<code>AbsoluteChange</code>) or <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> as rate normalized to the interval (<code>RateChange</code> = change/minute).</p>
<hr style="border:2px solid"> <hr style="border:2px solid">
<p><a id=PostProcessing-NUMBER.MaxRateValue></a></p> <p><a id=PostProcessing-NUMBER.MaxRateValue></a></p>
<h3 id="parameter-numbermaxratevalue">Parameter <code>&lt;NUMBER&gt;.MaxRateValue</code></h3> <h3 id="parameter-numbermaxratevalue">Parameter <code>&lt;NUMBER&gt;.MaxRateValue</code></h3>
<p>Default Value: <code>0.05</code> <p>Default Value: <code>0.05</code></p>
Maximum change of a reading. <p>Maximum change of a reading.
Depending on the settings of <code>&lt;NUMBER&gt;.MaxRateType</code> it is either treated as <code>absolute</code> or <code>relative</code>!</p> Depending on the settings of <code>&lt;NUMBER&gt;.MaxRateType</code> it is either treated as <code>absolute</code> or <code>relative</code>!</p>
<hr style="border:2px solid"> <hr style="border:2px solid">
@@ -1171,8 +1061,8 @@ Depending on the settings of <code>&lt;NUMBER&gt;.MaxRateType</code> it is eithe
<p><a id=PostProcessing-PreValueUse></a></p> <p><a id=PostProcessing-PreValueUse></a></p>
<h3 id="parameter-prevalueuse">Parameter <code>PreValueUse</code></h3> <h3 id="parameter-prevalueuse">Parameter <code>PreValueUse</code></h3>
<p>Default Value: <code>true</code> <p>Default Value: <code>true</code></p>
Use the previous value (value from previous round) for consistency checks. <p>Use the previous value (value from previous round) for consistency checks.
This also works through a reboot of the device!</p> This also works through a reboot of the device!</p>
<hr style="border:2px solid"> <hr style="border:2px solid">
@@ -1190,10 +1080,10 @@ It gets automatically transferred to <code>/wlan.ini</code> on the SD-Card at th
<p><a id=System-RSSIThreshold></a></p> <p><a id=System-RSSIThreshold></a></p>
<h3 id="parameter-rssithreshold">Parameter <code>RSSIThreshold</code></h3> <h3 id="parameter-rssithreshold">Parameter <code>RSSIThreshold</code></h3>
<p>Default Value: <code>''</code> <p>Default Value: <code>''</code></p>
WLAN Mesh Parameter: Threshold for the RSSI value to check for start switching access point in a mesh system. <p>WLAN Mesh Parameter: Threshold for the RSSI value to check for start switching access point in a mesh system.</p>
Possible values: <code>-100</code> .. <code>0</code>, <code>0</code> = disabled. <p>Possible values: <code>-100</code> .. <code>0</code> (<code>0</code> = disabled).</p>
It gets automatically transferred to <code>/wlan.ini</code> on the SD-Card at next startup.</p> <p>It gets automatically transferred to <code>/wlan.ini</code> on the SD-Card at next startup.</p>
<hr style="border:2px solid"> <hr style="border:2px solid">
<p><a id=System-SetupMode></a></p> <p><a id=System-SetupMode></a></p>
@@ -1221,8 +1111,8 @@ In such case the time always starts at <code>01.01.1970</code> after each power
<p><a id=System-TimeZone></a></p> <p><a id=System-TimeZone></a></p>
<h3 id="parameter-timezone">Parameter <code>TimeZone</code></h3> <h3 id="parameter-timezone">Parameter <code>TimeZone</code></h3>
<p>Default Value: <code>CET-1CEST,M3.5.0,M10.5.0/3</code> <p>Default Value: <code>CET-1CEST,M3.5.0,M10.5.0/3</code></p>
Time zone in POSIX syntax (Europe/Berlin = <code>CET-1CEST,M3.5.0,M10.5.0/3</code> - incl. daylight saving) <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> 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"> <hr style="border:2px solid">

2
search/search_index.json
View File

File diff suppressed because one or more lines are too long

BIN
sitemap.xml.gz
View File

Binary file not shown.