Deployed f994105 with MkDocs version: 1.6.1

This commit is contained in:
github-actions[bot]
2025-02-15 20:58:44 +00:00
parent 239381ffd6
commit 478ca7b616
3 changed files with 95 additions and 54 deletions

View File

@@ -704,19 +704,19 @@
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="#parameter-numberanalogtodigittransitionstart">1.5.5
<a class="md-nav__link" href="#parameter-analogtodigittransitionstart">1.5.5
<span class="md-ellipsis">
Parameter &lt;NUMBER&gt;.AnalogToDigitTransitionStart
Parameter AnalogToDigitTransitionStart
</span>
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="#parameter-numberchangeratethreshold">1.5.6
<a class="md-nav__link" href="#parameter-changeratethreshold">1.5.6
<span class="md-ellipsis">
Parameter &lt;NUMBER&gt;.ChangeRateThreshold
Parameter ChangeRateThreshold
</span>
</a>
<nav aria-label="Parameter &lt;NUMBER&gt;.ChangeRateThreshold" class="md-nav">
<nav aria-label="Parameter ChangeRateThreshold" class="md-nav">
<ul class="md-nav__list">
<li class="md-nav__item">
<a class="md-nav__link" href="#example">1.5.6.1
@@ -747,37 +747,37 @@
</nav>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="#parameter-numberdecimalshift">1.5.7
<a class="md-nav__link" href="#parameter-decimalshift">1.5.7
<span class="md-ellipsis">
Parameter &lt;NUMBER&gt;.DecimalShift
Parameter DecimalShift
</span>
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="#parameter-numberextendedresolution">1.5.8
<a class="md-nav__link" href="#parameter-extendedresolution_1">1.5.8
<span class="md-ellipsis">
Parameter &lt;NUMBER&gt;.ExtendedResolution
Parameter ExtendedResolution
</span>
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="#parameter-numberignoreleadingnan">1.5.9
<a class="md-nav__link" href="#parameter-ignoreleadingnan">1.5.9
<span class="md-ellipsis">
Parameter &lt;NUMBER&gt;.IgnoreLeadingNaN
Parameter IgnoreLeadingNaN
</span>
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="#parameter-numbermaxratetype">1.5.10
<a class="md-nav__link" href="#parameter-maxratetype">1.5.10
<span class="md-ellipsis">
Parameter &lt;NUMBER&gt;.MaxRateType
Parameter MaxRateType
</span>
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="#parameter-numbermaxratevalue">1.5.11
<a class="md-nav__link" href="#parameter-maxratevalue">1.5.11
<span class="md-ellipsis">
Parameter &lt;NUMBER&gt;.MaxRateValue
Parameter MaxRateValue
</span>
</a>
</li>
@@ -863,9 +863,9 @@
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="#parameter-numberdomoticzidx">1.6.9
<a class="md-nav__link" href="#parameter-domoticzidx">1.6.9
<span class="md-ellipsis">
Parameter &lt;NUMBER&gt;.DomoticzIDX
Parameter DomoticzIDX
</span>
</a>
</li>
@@ -923,9 +923,9 @@
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="#parameter-numberfield">1.7.2
<a class="md-nav__link" href="#parameter-field">1.7.2
<span class="md-ellipsis">
Parameter &lt;NUMBER&gt;.Field
Parameter Field
</span>
</a>
</li>
@@ -983,9 +983,9 @@
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="#parameter-numberfield_1">1.8.3
<a class="md-nav__link" href="#parameter-field_1">1.8.3
<span class="md-ellipsis">
Parameter &lt;NUMBER&gt;.Field
Parameter Field
</span>
</a>
</li>
@@ -2052,19 +2052,19 @@
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="#parameter-numberanalogtodigittransitionstart">1.5.5
<a class="md-nav__link" href="#parameter-analogtodigittransitionstart">1.5.5
<span class="md-ellipsis">
Parameter &lt;NUMBER&gt;.AnalogToDigitTransitionStart
Parameter AnalogToDigitTransitionStart
</span>
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="#parameter-numberchangeratethreshold">1.5.6
<a class="md-nav__link" href="#parameter-changeratethreshold">1.5.6
<span class="md-ellipsis">
Parameter &lt;NUMBER&gt;.ChangeRateThreshold
Parameter ChangeRateThreshold
</span>
</a>
<nav aria-label="Parameter &lt;NUMBER&gt;.ChangeRateThreshold" class="md-nav">
<nav aria-label="Parameter ChangeRateThreshold" class="md-nav">
<ul class="md-nav__list">
<li class="md-nav__item">
<a class="md-nav__link" href="#example">1.5.6.1
@@ -2095,37 +2095,37 @@
</nav>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="#parameter-numberdecimalshift">1.5.7
<a class="md-nav__link" href="#parameter-decimalshift">1.5.7
<span class="md-ellipsis">
Parameter &lt;NUMBER&gt;.DecimalShift
Parameter DecimalShift
</span>
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="#parameter-numberextendedresolution">1.5.8
<a class="md-nav__link" href="#parameter-extendedresolution_1">1.5.8
<span class="md-ellipsis">
Parameter &lt;NUMBER&gt;.ExtendedResolution
Parameter ExtendedResolution
</span>
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="#parameter-numberignoreleadingnan">1.5.9
<a class="md-nav__link" href="#parameter-ignoreleadingnan">1.5.9
<span class="md-ellipsis">
Parameter &lt;NUMBER&gt;.IgnoreLeadingNaN
Parameter IgnoreLeadingNaN
</span>
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="#parameter-numbermaxratetype">1.5.10
<a class="md-nav__link" href="#parameter-maxratetype">1.5.10
<span class="md-ellipsis">
Parameter &lt;NUMBER&gt;.MaxRateType
Parameter MaxRateType
</span>
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="#parameter-numbermaxratevalue">1.5.11
<a class="md-nav__link" href="#parameter-maxratevalue">1.5.11
<span class="md-ellipsis">
Parameter &lt;NUMBER&gt;.MaxRateValue
Parameter MaxRateValue
</span>
</a>
</li>
@@ -2211,9 +2211,9 @@
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="#parameter-numberdomoticzidx">1.6.9
<a class="md-nav__link" href="#parameter-domoticzidx">1.6.9
<span class="md-ellipsis">
Parameter &lt;NUMBER&gt;.DomoticzIDX
Parameter DomoticzIDX
</span>
</a>
</li>
@@ -2271,9 +2271,9 @@
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="#parameter-numberfield">1.7.2
<a class="md-nav__link" href="#parameter-field">1.7.2
<span class="md-ellipsis">
Parameter &lt;NUMBER&gt;.Field
Parameter Field
</span>
</a>
</li>
@@ -2331,9 +2331,9 @@
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="#parameter-numberfield_1">1.8.3
<a class="md-nav__link" href="#parameter-field_1">1.8.3
<span class="md-ellipsis">
Parameter &lt;NUMBER&gt;.Field
Parameter Field
</span>
</a>
</li>
@@ -3522,7 +3522,7 @@ In an error case, the last valid number will be used for the various transmissio
</div>
<hr style="border:2px solid"/>
<p><a id="PostProcessing-NUMBER.AnalogToDigitTransitionStart"></a></p>
<h3 id="parameter-numberanalogtodigittransitionstart"><span class="enumerate-headings-plugin enumerate-heading-plugin">1.5.5</span> Parameter <code>&lt;NUMBER&gt;.AnalogToDigitTransitionStart</code></h3>
<h3 id="parameter-analogtodigittransitionstart"><span class="enumerate-headings-plugin enumerate-heading-plugin">1.5.5</span> Parameter <code>AnalogToDigitTransitionStart</code></h3>
<p>Section: <a href="#section-postprocessing">1.5 PostProcessing</a></p>
<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.
@@ -3530,9 +3530,13 @@ Look for the start of changing of the first digit and note the analog pointer va
Set it here. Only used on combination of digits and analog pointers.
See <a href="../Watermeter-specific-analog---digit-transition">here</a> for details.</p>
<p>Range: <code>6.0</code> .. <code>9.9</code>.</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>This parameter must be prefixed with <code>&lt;NUMBER&gt;</code> followed by a dot (eg. <code>main.AnalogToDigitTransitionStart</code>). <code>&lt;NUMBER&gt;</code> is the name of the number sequence defined in the ROI's.</p>
</div>
<hr style="border:2px solid"/>
<p><a id="PostProcessing-NUMBER.ChangeRateThreshold"></a></p>
<h3 id="parameter-numberchangeratethreshold"><span class="enumerate-headings-plugin enumerate-heading-plugin">1.5.6</span> Parameter <code>&lt;NUMBER&gt;.ChangeRateThreshold</code></h3>
<h3 id="parameter-changeratethreshold"><span class="enumerate-headings-plugin enumerate-heading-plugin">1.5.6</span> Parameter <code>ChangeRateThreshold</code></h3>
<p>Section: <a href="#section-postprocessing">1.5 PostProcessing</a></p>
<p>Default Value: <code>2</code></p>
<p>Range: <code>1</code> .. <code>9</code>.</p>
@@ -3540,6 +3544,10 @@ See <a href="../Watermeter-specific-analog---digit-transition">here</a> for deta
This parameter is intended to compensate for small reading fluctuations that occur when the meter does not change its value for a long time (e.g. at night) or slightly turns backwards. This can eg. happen on watermeters.</p>
<p>It is only applied to the last digit of the read value (See example below).
If the read value is within PreValue +/- Threshold, no further calculation is carried out and the Value/Prevalue remains at the old value.</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>This parameter must be prefixed with <code>&lt;NUMBER&gt;</code> followed by a dot (eg. <code>main.ChangeRateThreshold</code>). <code>&lt;NUMBER&gt;</code> is the name of the number sequence defined in the ROI's.</p>
</div>
<h4 id="example"><span class="enumerate-headings-plugin enumerate-heading-plugin">1.5.6.1</span> Example</h4>
<ul>
<li>Smallest ROI provides value for <code>0.000'x</code> (Eg. a water meter with 4 pointers behind the decimal point)</li>
@@ -3554,14 +3562,18 @@ All changes between <code>123.456'76</code> and <code>123.456'80</code> get igno
<p><img alt="" src="../img/ChangeRateThreshold.png"/></p>
<hr style="border:2px solid"/>
<p><a id="PostProcessing-NUMBER.DecimalShift"></a></p>
<h3 id="parameter-numberdecimalshift"><span class="enumerate-headings-plugin enumerate-heading-plugin">1.5.7</span> Parameter <code>&lt;NUMBER&gt;.DecimalShift</code></h3>
<h3 id="parameter-decimalshift"><span class="enumerate-headings-plugin enumerate-heading-plugin">1.5.7</span> Parameter <code>DecimalShift</code></h3>
<p>Section: <a href="#section-postprocessing">1.5 PostProcessing</a></p>
<p>Default Value: <code>0</code></p>
<p>Shift the decimal separator (positiv or negativ).
Eg. to move from <code></code> to <code>liter</code> (<code>1 m³</code> equals <code>1000 liters</code>), you need to set it to <code>+3</code>.</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>This parameter must be prefixed with <code>&lt;NUMBER&gt;</code> followed by a dot (eg. <code>main.DecimalShift</code>). <code>&lt;NUMBER&gt;</code> is the name of the number sequence defined in the ROI's.</p>
</div>
<hr style="border:2px solid"/>
<p><a id="PostProcessing-NUMBER.ExtendedResolution"></a></p>
<h3 id="parameter-numberextendedresolution"><span class="enumerate-headings-plugin enumerate-heading-plugin">1.5.8</span> Parameter <code>&lt;NUMBER&gt;.ExtendedResolution</code></h3>
<h3 id="parameter-extendedresolution_1"><span class="enumerate-headings-plugin enumerate-heading-plugin">1.5.8</span> Parameter <code>ExtendedResolution</code></h3>
<p>Section: <a href="#section-postprocessing">1.5 PostProcessing</a></p>
<p>Default Value: <code>false</code></p>
<p>Use the decimal place of the last analog counter for increased accuracy.</p>
@@ -3569,28 +3581,44 @@ Eg. to move from <code>m³</code> to <code>liter</code> (<code>1 m³</code> equa
<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>
</div>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>This parameter must be prefixed with <code>&lt;NUMBER&gt;</code> followed by a dot (eg. <code>main.ExtendedResolution</code>). <code>&lt;NUMBER&gt;</code> is the name of the number sequence defined in the ROI's.</p>
</div>
<hr style="border:2px solid"/>
<p><a id="PostProcessing-NUMBER.IgnoreLeadingNaN"></a></p>
<h3 id="parameter-numberignoreleadingnan"><span class="enumerate-headings-plugin enumerate-heading-plugin">1.5.9</span> Parameter <code>&lt;NUMBER&gt;.IgnoreLeadingNaN</code></h3>
<h3 id="parameter-ignoreleadingnan"><span class="enumerate-headings-plugin enumerate-heading-plugin">1.5.9</span> Parameter <code>IgnoreLeadingNaN</code></h3>
<p>Section: <a href="#section-postprocessing">1.5 PostProcessing</a></p>
<p>Default Value: <code>true</code></p>
<p>Leading <code>N</code>'s will be deleted before further processing.
This is only relevant for models which use <code>N</code>!
See <a href="../Choosing-the-Model">here</a> for details.</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>This parameter must be prefixed with <code>&lt;NUMBER&gt;</code> followed by a dot (eg. <code>main.IgnoreLeadingNaN</code>). <code>&lt;NUMBER&gt;</code> is the name of the number sequence defined in the ROI's.</p>
</div>
<hr style="border:2px solid"/>
<p><a id="PostProcessing-NUMBER.MaxRateType"></a></p>
<h3 id="parameter-numbermaxratetype"><span class="enumerate-headings-plugin enumerate-heading-plugin">1.5.10</span> Parameter <code>&lt;NUMBER&gt;.MaxRateType</code></h3>
<h3 id="parameter-maxratetype"><span class="enumerate-headings-plugin enumerate-heading-plugin">1.5.10</span> Parameter <code>MaxRateType</code></h3>
<p>Section: <a href="#section-postprocessing">1.5 PostProcessing</a></p>
<p>Default Value: <code>AbsoluteChange</code></p>
<p>Defines if the <strong>Change Rate</strong> is calculated as the difference between the last two readings (<code>AbsoluteChange</code> = difference) or
as the difference normalized to the interval (<code>RateChange</code> = difference per minute).</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>This parameter must be prefixed with <code>&lt;NUMBER&gt;</code> followed by a dot (eg. <code>main.MaxRateType</code>). <code>&lt;NUMBER&gt;</code> is the name of the number sequence defined in the ROI's.</p>
</div>
<hr style="border:2px solid"/>
<p><a id="PostProcessing-NUMBER.MaxRateValue"></a></p>
<h3 id="parameter-numbermaxratevalue"><span class="enumerate-headings-plugin enumerate-heading-plugin">1.5.11</span> Parameter <code>&lt;NUMBER&gt;.MaxRateValue</code></h3>
<h3 id="parameter-maxratevalue"><span class="enumerate-headings-plugin enumerate-heading-plugin">1.5.11</span> Parameter <code>MaxRateValue</code></h3>
<p>Section: <a href="#section-postprocessing">1.5 PostProcessing</a></p>
<p>Default Value: <code>0,05</code></p>
<p>Maximum allowed change between two readings, if exceeded the last reading will be rejected. Depending on the settings of <code>&lt;NUMBER&gt;.MaxRateType</code> the <code>MaxRateValue</code> is either treated as the difference between the two measurements (<code>AbsoluteChange</code> = difference) not taking the set time interval into account or as the difference normalized to the interval (<code>RateChange</code> = difference per minute).</p>
<p>If negative rate is disallowed and no maximum rate value is set, one false high reading will lead to a period of missing measurements until the measurement reaches the previous false high reading. E.g. if the counter is at <code>600,00</code> and it's read incorrectly as<code>610,00</code>, all measurements will be skipped until the counter reaches <code>610,00</code>. Setting the MaxRateValue to <code>0,05</code> leads to a rejection of all readings with a difference <code>&gt; 0,05</code>, in this case <code>610,00</code>. The rejection also applies to correct readings with a difference <code>&gt; 0,05</code>!</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>This parameter must be prefixed with <code>&lt;NUMBER&gt;</code> followed by a dot (eg. <code>main.MaxRateValue</code>). <code>&lt;NUMBER&gt;</code> is the name of the number sequence defined in the ROI's.</p>
</div>
<hr style="border:2px solid"/>
<p><a id="PostProcessing-PreValueAgeStartup"></a></p>
<h3 id="parameter-prevalueagestartup"><span class="enumerate-headings-plugin enumerate-heading-plugin">1.5.12</span> Parameter <code>PreValueAgeStartup</code></h3>
@@ -3730,10 +3758,14 @@ 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-NUMBER.DomoticzIDX"></a></p>
<h3 id="parameter-numberdomoticzidx"><span class="enumerate-headings-plugin enumerate-heading-plugin">1.6.9</span> Parameter <code>&lt;NUMBER&gt;.DomoticzIDX</code></h3>
<h3 id="parameter-domoticzidx"><span class="enumerate-headings-plugin enumerate-heading-plugin">1.6.9</span> Parameter <code>DomoticzIDX</code></h3>
<p>Section: <a href="#section-mqtt">1.6 MQTT</a></p>
<p>Default Value: <code>0</code></p>
<p>The Idx number for the counter device. Can be obtained from the devices setup page on the Domoticz system.</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>This parameter must be prefixed with <code>&lt;NUMBER&gt;</code> followed by a dot (eg. <code>main.DomoticzIDX</code>). <code>&lt;NUMBER&gt;</code> is the name of the number sequence defined in the ROI's.</p>
</div>
<hr style="border:2px solid"/>
<p><a id="MQTT-RetainMessages"></a></p>
<h3 id="parameter-retainmessages"><span class="enumerate-headings-plugin enumerate-heading-plugin">1.6.10</span> Parameter <code>RetainMessages</code></h3>
@@ -3791,10 +3823,14 @@ This reduces the security of TLS and makes the <em>MQTT</em> client susceptible
</div>
<hr style="border:2px solid"/>
<p><a id="InfluxDB-NUMBER.Field"></a></p>
<h3 id="parameter-numberfield"><span class="enumerate-headings-plugin enumerate-heading-plugin">1.7.2</span> Parameter <code>&lt;NUMBER&gt;.Field</code></h3>
<h3 id="parameter-field"><span class="enumerate-headings-plugin enumerate-heading-plugin">1.7.2</span> Parameter <code>Field</code></h3>
<p>Section: <a href="#section-influxdb">1.7 InfluxDB</a></p>
<p>Default Value: <code>undefined</code></p>
<p>Dedicated definition of the field for InfluxDB use for saving in the Influx database (e.g.: "watermeter/value").</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>This parameter must be prefixed with <code>&lt;NUMBER&gt;</code> followed by a dot (eg. <code>main.Field</code>). <code>&lt;NUMBER&gt;</code> is the name of the number sequence defined in the ROI's.</p>
</div>
<hr style="border:2px solid"/>
<p><a id="InfluxDB-NUMBER.Measurement"></a></p>
<h3 id="parameter-measurement"><span class="enumerate-headings-plugin enumerate-heading-plugin">1.7.3</span> Parameter <code>Measurement</code></h3>
@@ -3852,10 +3888,14 @@ Use <a href="../Parameters/#InfluxDBv2-Basket"><code>Basket</code></a> instead!<
</div>
<hr style="border:2px solid"/>
<p><a id="InfluxDBv2-NUMBER.Field"></a></p>
<h3 id="parameter-numberfield_1"><span class="enumerate-headings-plugin enumerate-heading-plugin">1.8.3</span> Parameter <code>&lt;NUMBER&gt;.Field</code></h3>
<h3 id="parameter-field_1"><span class="enumerate-headings-plugin enumerate-heading-plugin">1.8.3</span> Parameter <code>Field</code></h3>
<p>Section: <a href="#section-influxdbv2">1.8 InfluxDBv2</a></p>
<p>Default Value: <code>undefined</code></p>
<p>Field for InfluxDB v2 to use for saving.</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>This parameter must be prefixed with <code>&lt;NUMBER&gt;</code> followed by a dot (eg. <code>main.Field</code>). <code>&lt;NUMBER&gt;</code> is the name of the number sequence defined in the ROI's.</p>
</div>
<hr style="border:2px solid"/>
<p><a id="InfluxDBv2-NUMBER.Measurement"></a></p>
<h3 id="parameter-measurement_1"><span class="enumerate-headings-plugin enumerate-heading-plugin">1.8.4</span> Parameter <code>Measurement</code></h3>

View File

@@ -739,7 +739,8 @@
<h2 id="inaccuracies-in-image-recognition"><span class="enumerate-headings-plugin enumerate-heading-plugin">1.3</span> Inaccuracies in image recognition</h2>
<p>The models for image recognition are good, but have inaccuracies in the range +/- 0.2. In order to obtain as many correct results as possible, a treatment is carried out in the post process in the range of 9.8-0.2 for the analogue pointer, which must start differently depending on the type of counter.</p>
<h2 id="how-to-configure-for-my-meter-type"><span class="enumerate-headings-plugin enumerate-heading-plugin">1.4</span> How to configure for my meter type</h2>
<p>If you have a devices with "normal" transition you should not have any issues. On devices with "early" transition, you can set the option <code>AnalogDigitTransitionStart</code> to a value between 6 and 8.</p>
<p>If you have a devices with "normal" transition you should not have any issues. On devices with "early" transition, you can set the option <code>AnalogToDigitTransitionStart</code> to a value between 6 and 8.
See the <a href="/Parameters/#parameter-numberanalogtodigittransitionstart">parameter documentation</a> for details.</p>
</article>
</div>
<script>var target=document.getElementById(location.hash.slice(1));target&&target.name&&(target.checked=target.name.startsWith("__tabbed_"))</script>

File diff suppressed because one or more lines are too long