Deployed bfdfc1d with MkDocs version: 1.6.0

This commit is contained in:
github-actions[bot]
2024-08-17 22:15:23 +00:00
parent f90d408c97
commit cc10d152b4
2 changed files with 121 additions and 1 deletions

View File

@@ -2619,6 +2619,7 @@ In such case the functionality gets disabled respectively the default values wil
<h2 id="section-takeimage"><span class="enumerate-headings-plugin enumerate-heading-plugin">1.1</span> Section <code>TakeImage</code></h2>
<p><a id="TakeImage-Aec2"></a></p>
<h3 id="parameter-aec2"><span class="enumerate-headings-plugin enumerate-heading-plugin">1.1.1</span> Parameter <code>Aec2</code></h3>
<p>Section: <a href="#section-takeimage">1.1 TakeImage</a></p>
<p>Default Value: <code>false</code></p>
<div class="admonition warning">
<p class="admonition-title">Warning</p>
@@ -2636,6 +2637,7 @@ In such case the functionality gets disabled respectively the default values wil
<hr style="border:2px solid"/>
<p><a id="TakeImage-AutoExposureLevel"></a></p>
<h3 id="parameter-autoexposurelevel"><span class="enumerate-headings-plugin enumerate-heading-plugin">1.1.2</span> Parameter <code>AutoExposureLevel</code></h3>
<p>Section: <a href="#section-takeimage">1.1 TakeImage</a></p>
<p>Default Value: <code>0</code></p>
<div class="admonition warning">
<p class="admonition-title">Warning</p>
@@ -2654,6 +2656,7 @@ In such case the functionality gets disabled respectively the default values wil
<hr style="border:2px solid"/>
<p><a id="TakeImage-Brightness"></a></p>
<h3 id="parameter-brightness"><span class="enumerate-headings-plugin enumerate-heading-plugin">1.1.3</span> Parameter <code>Brightness</code></h3>
<p>Section: <a href="#section-takeimage">1.1 TakeImage</a></p>
<p>Default Value: <code>0</code></p>
<div class="admonition note">
<p class="admonition-title">Note</p>
@@ -2667,6 +2670,7 @@ In such case the functionality gets disabled respectively the default values wil
<hr style="border:2px solid"/>
<p><a id="TakeImage-CamAeLevel"></a></p>
<h3 id="parameter-camaelevel"><span class="enumerate-headings-plugin enumerate-heading-plugin">1.1.4</span> Parameter <code>CamAeLevel</code></h3>
<p>Section: <a href="#section-takeimage">1.1 TakeImage</a></p>
<p>Default Value: <code>0</code></p>
<div class="admonition warning">
<p class="admonition-title">Warning</p>
@@ -2685,6 +2689,7 @@ In such case the functionality gets disabled respectively the default values wil
<hr style="border:2px solid"/>
<p><a id="TakeImage-CamAec"></a></p>
<h3 id="parameter-camaec"><span class="enumerate-headings-plugin enumerate-heading-plugin">1.1.5</span> Parameter <code>CamAec</code></h3>
<p>Section: <a href="#section-takeimage">1.1 TakeImage</a></p>
<p>Default Value: <code>true</code></p>
<div class="admonition warning">
<p class="admonition-title">Warning</p>
@@ -2702,6 +2707,7 @@ In such case the functionality gets disabled respectively the default values wil
<hr style="border:2px solid"/>
<p><a id="TakeImage-CamAec2"></a></p>
<h3 id="parameter-camaec2"><span class="enumerate-headings-plugin enumerate-heading-plugin">1.1.6</span> Parameter <code>CamAec2</code></h3>
<p>Section: <a href="#section-takeimage">1.1 TakeImage</a></p>
<p>Default Value: <code>false</code></p>
<div class="admonition warning">
<p class="admonition-title">Warning</p>
@@ -2719,6 +2725,7 @@ In such case the functionality gets disabled respectively the default values wil
<hr style="border:2px solid"/>
<p><a id="TakeImage-CamAecValue"></a></p>
<h3 id="parameter-camaecvalue"><span class="enumerate-headings-plugin enumerate-heading-plugin">1.1.7</span> Parameter <code>CamAecValue</code></h3>
<p>Section: <a href="#section-takeimage">1.1 TakeImage</a></p>
<p>Default Value: <code>0</code></p>
<div class="admonition warning">
<p class="admonition-title">Warning</p>
@@ -2737,6 +2744,7 @@ In such case the functionality gets disabled respectively the default values wil
<hr style="border:2px solid"/>
<p><a id="TakeImage-CamAgc"></a></p>
<h3 id="parameter-camagc"><span class="enumerate-headings-plugin enumerate-heading-plugin">1.1.8</span> Parameter <code>CamAgc</code></h3>
<p>Section: <a href="#section-takeimage">1.1 TakeImage</a></p>
<p>Default Value: <code>true</code></p>
<div class="admonition warning">
<p class="admonition-title">Warning</p>
@@ -2750,6 +2758,7 @@ In such case the functionality gets disabled respectively the default values wil
<hr style="border:2px solid"/>
<p><a id="TakeImage-CamAgcGain"></a></p>
<h3 id="parameter-camagcgain"><span class="enumerate-headings-plugin enumerate-heading-plugin">1.1.9</span> Parameter <code>CamAgcGain</code></h3>
<p>Section: <a href="#section-takeimage">1.1 TakeImage</a></p>
<p>Default Value: <code></code></p>
<div class="admonition warning">
<p class="admonition-title">Warning</p>
@@ -2767,6 +2776,7 @@ In such case the functionality gets disabled respectively the default values wil
<hr style="border:2px solid"/>
<p><a id="TakeImage-CamAutoSharpness"></a></p>
<h3 id="parameter-camautosharpness"><span class="enumerate-headings-plugin enumerate-heading-plugin">1.1.10</span> Parameter <code>CamAutoSharpness</code></h3>
<p>Section: <a href="#section-takeimage">1.1 TakeImage</a></p>
<p>Default Value: <code>false</code></p>
<div class="admonition warning">
<p class="admonition-title">Warning</p>
@@ -2784,6 +2794,7 @@ In such case the functionality gets disabled respectively the default values wil
<hr style="border:2px solid"/>
<p><a id="TakeImage-CamAwb"></a></p>
<h3 id="parameter-camawb"><span class="enumerate-headings-plugin enumerate-heading-plugin">1.1.11</span> Parameter <code>CamAwb</code></h3>
<p>Section: <a href="#section-takeimage">1.1 TakeImage</a></p>
<p>Default Value: <code></code></p>
<div class="admonition warning">
<p class="admonition-title">Warning</p>
@@ -2797,6 +2808,7 @@ In such case the functionality gets disabled respectively the default values wil
<hr style="border:2px solid"/>
<p><a id="TakeImage-CamAwbGain"></a></p>
<h3 id="parameter-camawbgain"><span class="enumerate-headings-plugin enumerate-heading-plugin">1.1.12</span> Parameter <code>CamAwbGain</code></h3>
<p>Section: <a href="#section-takeimage">1.1 TakeImage</a></p>
<p>Default Value: <code></code></p>
<div class="admonition warning">
<p class="admonition-title">Warning</p>
@@ -2810,6 +2822,7 @@ In such case the functionality gets disabled respectively the default values wil
<hr style="border:2px solid"/>
<p><a id="TakeImage-CamBpc"></a></p>
<h3 id="parameter-cambpc"><span class="enumerate-headings-plugin enumerate-heading-plugin">1.1.13</span> Parameter <code>CamBpc</code></h3>
<p>Section: <a href="#section-takeimage">1.1 TakeImage</a></p>
<p>Default Value: <code>true</code></p>
<div class="admonition warning">
<p class="admonition-title">Warning</p>
@@ -2823,6 +2836,7 @@ In such case the functionality gets disabled respectively the default values wil
<hr style="border:2px solid"/>
<p><a id="TakeImage-CamBrightness"></a></p>
<h3 id="parameter-cambrightness"><span class="enumerate-headings-plugin enumerate-heading-plugin">1.1.14</span> Parameter <code>CamBrightness</code></h3>
<p>Section: <a href="#section-takeimage">1.1 TakeImage</a></p>
<p>Default Value: <code>0</code></p>
<div class="admonition note">
<p class="admonition-title">Note</p>
@@ -2836,6 +2850,7 @@ In such case the functionality gets disabled respectively the default values wil
<hr style="border:2px solid"/>
<p><a id="TakeImage-CamColorbar"></a></p>
<h3 id="parameter-camcolorbar"><span class="enumerate-headings-plugin enumerate-heading-plugin">1.1.15</span> Parameter <code>CamColorbar</code></h3>
<p>Section: <a href="#section-takeimage">1.1 TakeImage</a></p>
<p>Default Value: <code>false</code></p>
<div class="admonition note">
<p class="admonition-title">Note</p>
@@ -2844,6 +2859,7 @@ In such case the functionality gets disabled respectively the default values wil
<hr style="border:2px solid"/>
<p><a id="TakeImage-CamContrast"></a></p>
<h3 id="parameter-camcontrast"><span class="enumerate-headings-plugin enumerate-heading-plugin">1.1.16</span> Parameter <code>CamContrast</code></h3>
<p>Section: <a href="#section-takeimage">1.1 TakeImage</a></p>
<p>Default Value: <code>0</code></p>
<div class="admonition note">
<p class="admonition-title">Note</p>
@@ -2857,6 +2873,7 @@ In such case the functionality gets disabled respectively the default values wil
<hr style="border:2px solid"/>
<p><a id="TakeImage-CamDcw"></a></p>
<h3 id="parameter-camdcw"><span class="enumerate-headings-plugin enumerate-heading-plugin">1.1.17</span> Parameter <code>CamDcw</code></h3>
<p>Section: <a href="#section-takeimage">1.1 TakeImage</a></p>
<p>Default Value: <code>true</code></p>
<div class="admonition warning">
<p class="admonition-title">Warning</p>
@@ -2875,6 +2892,7 @@ Note that if DCW is off, and you pick a different image size, this implicitly tu
<hr style="border:2px solid"/>
<p><a id="TakeImage-CamDenoise"></a></p>
<h3 id="parameter-camdenoise"><span class="enumerate-headings-plugin enumerate-heading-plugin">1.1.18</span> Parameter <code>CamDenoise</code></h3>
<p>Section: <a href="#section-takeimage">1.1 TakeImage</a></p>
<p>Default Value: <code></code></p>
<div class="admonition warning">
<p class="admonition-title">Warning</p>
@@ -2888,6 +2906,7 @@ Note that if DCW is off, and you pick a different image size, this implicitly tu
<hr style="border:2px solid"/>
<p><a id="TakeImage-CamGainceiling"></a></p>
<h3 id="parameter-camgainceiling"><span class="enumerate-headings-plugin enumerate-heading-plugin">1.1.19</span> Parameter <code>CamGainceiling</code></h3>
<p>Section: <a href="#section-takeimage">1.1 TakeImage</a></p>
<p>Default Value: <code>x2</code></p>
<div class="admonition warning">
<p class="admonition-title">Warning</p>
@@ -2914,6 +2933,7 @@ Note that if DCW is off, and you pick a different image size, this implicitly tu
<hr style="border:2px solid"/>
<p><a id="TakeImage-CamHmirror"></a></p>
<h3 id="parameter-camhmirror"><span class="enumerate-headings-plugin enumerate-heading-plugin">1.1.20</span> Parameter <code>CamHmirror</code></h3>
<p>Section: <a href="#section-takeimage">1.1 TakeImage</a></p>
<p>Default Value: <code>false</code></p>
<div class="admonition note">
<p class="admonition-title">Note</p>
@@ -2927,6 +2947,7 @@ Note that if DCW is off, and you pick a different image size, this implicitly tu
<hr style="border:2px solid"/>
<p><a id="TakeImage-CamLenc"></a></p>
<h3 id="parameter-camlenc"><span class="enumerate-headings-plugin enumerate-heading-plugin">1.1.21</span> Parameter <code>CamLenc</code></h3>
<p>Section: <a href="#section-takeimage">1.1 TakeImage</a></p>
<p>Default Value: <code>true</code></p>
<div class="admonition warning">
<p class="admonition-title">Warning</p>
@@ -2940,6 +2961,7 @@ Note that if DCW is off, and you pick a different image size, this implicitly tu
<hr style="border:2px solid"/>
<p><a id="TakeImage-CamQuality"></a></p>
<h3 id="parameter-camquality"><span class="enumerate-headings-plugin enumerate-heading-plugin">1.1.22</span> Parameter <code>CamQuality</code></h3>
<p>Section: <a href="#section-takeimage">1.1 TakeImage</a></p>
<p>Default Value: <code>12</code></p>
<div class="admonition warning">
<p class="admonition-title">Warning</p>
@@ -2953,6 +2975,7 @@ Note that if DCW is off, and you pick a different image size, this implicitly tu
<hr style="border:2px solid"/>
<p><a id="TakeImage-CamRawGma"></a></p>
<h3 id="parameter-camrawgma"><span class="enumerate-headings-plugin enumerate-heading-plugin">1.1.23</span> Parameter <code>CamRawGma</code></h3>
<p>Section: <a href="#section-takeimage">1.1 TakeImage</a></p>
<p>Default Value: <code></code></p>
<div class="admonition warning">
<p class="admonition-title">Warning</p>
@@ -2966,6 +2989,7 @@ Note that if DCW is off, and you pick a different image size, this implicitly tu
<hr style="border:2px solid"/>
<p><a id="TakeImage-CamSaturation"></a></p>
<h3 id="parameter-camsaturation"><span class="enumerate-headings-plugin enumerate-heading-plugin">1.1.24</span> Parameter <code>CamSaturation</code></h3>
<p>Section: <a href="#section-takeimage">1.1 TakeImage</a></p>
<p>Default Value: <code>0</code></p>
<div class="admonition note">
<p class="admonition-title">Note</p>
@@ -2979,6 +3003,7 @@ Note that if DCW is off, and you pick a different image size, this implicitly tu
<hr style="border:2px solid"/>
<p><a id="TakeImage-CamSharpness"></a></p>
<h3 id="parameter-camsharpness"><span class="enumerate-headings-plugin enumerate-heading-plugin">1.1.25</span> Parameter <code>CamSharpness</code></h3>
<p>Section: <a href="#section-takeimage">1.1 TakeImage</a></p>
<p>Default Value: <code>0</code></p>
<div class="admonition warning">
<p class="admonition-title">Warning</p>
@@ -2996,6 +3021,7 @@ Note that if DCW is off, and you pick a different image size, this implicitly tu
<hr style="border:2px solid"/>
<p><a id="TakeImage-CamSpecialEffect"></a></p>
<h3 id="parameter-camspecialeffect"><span class="enumerate-headings-plugin enumerate-heading-plugin">1.1.26</span> Parameter <code>CamSpecialEffect</code></h3>
<p>Section: <a href="#section-takeimage">1.1 TakeImage</a></p>
<p>Default Value: <code>no_effect</code></p>
<div class="admonition warning">
<p class="admonition-title">Warning</p>
@@ -3022,6 +3048,7 @@ Note that if DCW is off, and you pick a different image size, this implicitly tu
<hr style="border:2px solid"/>
<p><a id="TakeImage-CamVflip"></a></p>
<h3 id="parameter-camvflip"><span class="enumerate-headings-plugin enumerate-heading-plugin">1.1.27</span> Parameter <code>CamVflip</code></h3>
<p>Section: <a href="#section-takeimage">1.1 TakeImage</a></p>
<p>Default Value: <code>false</code></p>
<div class="admonition note">
<p class="admonition-title">Note</p>
@@ -3035,6 +3062,7 @@ Note that if DCW is off, and you pick a different image size, this implicitly tu
<hr style="border:2px solid"/>
<p><a id="TakeImage-CamWbMode"></a></p>
<h3 id="parameter-camwbmode"><span class="enumerate-headings-plugin enumerate-heading-plugin">1.1.28</span> Parameter <code>CamWbMode</code></h3>
<p>Section: <a href="#section-takeimage">1.1 TakeImage</a></p>
<p>Default Value: <code>auto</code></p>
<div class="admonition note">
<p class="admonition-title">Note</p>
@@ -3056,6 +3084,7 @@ Note that if DCW is off, and you pick a different image size, this implicitly tu
<hr style="border:2px solid"/>
<p><a id="TakeImage-CamWpc"></a></p>
<h3 id="parameter-camwpc"><span class="enumerate-headings-plugin enumerate-heading-plugin">1.1.29</span> Parameter <code>CamWpc</code></h3>
<p>Section: <a href="#section-takeimage">1.1 TakeImage</a></p>
<p>Default Value: <code>true</code></p>
<div class="admonition note">
<p class="admonition-title">Note</p>
@@ -3069,6 +3098,7 @@ Note that if DCW is off, and you pick a different image size, this implicitly tu
<hr style="border:2px solid"/>
<p><a id="TakeImage-CamZoom"></a></p>
<h3 id="parameter-camzoom"><span class="enumerate-headings-plugin enumerate-heading-plugin">1.1.30</span> Parameter <code>CamZoom</code></h3>
<p>Section: <a href="#section-takeimage">1.1 TakeImage</a></p>
<p>Default Value: <code>false</code></p>
<div class="admonition warning">
<p class="admonition-title">Warning</p>
@@ -3086,6 +3116,7 @@ Note that if DCW is off, and you pick a different image size, this implicitly tu
<hr style="border:2px solid"/>
<p><a id="TakeImage-CamZoomOffsetX"></a></p>
<h3 id="parameter-camzoomoffsetx"><span class="enumerate-headings-plugin enumerate-heading-plugin">1.1.31</span> Parameter <code>CamZoomOffsetX</code></h3>
<p>Section: <a href="#section-takeimage">1.1 TakeImage</a></p>
<p>Default Value: <code>0</code></p>
<div class="admonition warning">
<p class="admonition-title">Warning</p>
@@ -3104,6 +3135,7 @@ X coordinate of the crop location within the camera sensor frame.</p>
<hr style="border:2px solid"/>
<p><a id="TakeImage-CamZoomOffsetY"></a></p>
<h3 id="parameter-camzoomoffsety"><span class="enumerate-headings-plugin enumerate-heading-plugin">1.1.32</span> Parameter <code>CamZoomOffsetY</code></h3>
<p>Section: <a href="#section-takeimage">1.1 TakeImage</a></p>
<p>Default Value: <code>0</code></p>
<div class="admonition warning">
<p class="admonition-title">Warning</p>
@@ -3122,6 +3154,7 @@ Y coordinate of the crop location within the camera sensor frame.</p>
<hr style="border:2px solid"/>
<p><a id="TakeImage-CamZoomSize"></a></p>
<h3 id="parameter-camzoomsize"><span class="enumerate-headings-plugin enumerate-heading-plugin">1.1.33</span> Parameter <code>CamZoomSize</code></h3>
<p>Section: <a href="#section-takeimage">1.1 TakeImage</a></p>
<p>Default Value: <code>0</code></p>
<div class="admonition warning">
<p class="admonition-title">Warning</p>
@@ -3139,6 +3172,7 @@ Y coordinate of the crop location within the camera sensor frame.</p>
<hr style="border:2px solid"/>
<p><a id="TakeImage-Contrast"></a></p>
<h3 id="parameter-contrast"><span class="enumerate-headings-plugin enumerate-heading-plugin">1.1.34</span> Parameter <code>Contrast</code></h3>
<p>Section: <a href="#section-takeimage">1.1 TakeImage</a></p>
<p>Default Value: <code>0</code></p>
<div class="admonition note">
<p class="admonition-title">Note</p>
@@ -3152,6 +3186,7 @@ Y coordinate of the crop location within the camera sensor frame.</p>
<hr style="border:2px solid"/>
<p><a id="TakeImage-Demo"></a></p>
<h3 id="parameter-demo"><span class="enumerate-headings-plugin enumerate-heading-plugin">1.1.35</span> Parameter <code>Demo</code></h3>
<p>Section: <a href="#section-takeimage">1.1 TakeImage</a></p>
<p>Default Value: <code>false</code></p>
<div class="admonition warning">
<p class="admonition-title">Warning</p>
@@ -3163,6 +3198,7 @@ Check <a href="../Demo-Mode">here</a> for details. </p>
<hr style="border:2px solid"/>
<p><a id="TakeImage-FixedExposure"></a></p>
<h3 id="parameter-fixedexposure"><span class="enumerate-headings-plugin enumerate-heading-plugin">1.1.36</span> Parameter <code>FixedExposure</code></h3>
<p>Section: <a href="#section-takeimage">1.1 TakeImage</a></p>
<p>Default Value: <code>false</code></p>
<div class="admonition warning">
<p class="admonition-title">Warning</p>
@@ -3180,6 +3216,7 @@ Check <a href="../Demo-Mode">here</a> for details. </p>
<hr style="border:2px solid"/>
<p><a id="TakeImage-Grayscale"></a></p>
<h3 id="parameter-grayscale"><span class="enumerate-headings-plugin enumerate-heading-plugin">1.1.37</span> Parameter <code>Grayscale</code></h3>
<p>Section: <a href="#section-takeimage">1.1 TakeImage</a></p>
<p>Default Value: <code>false</code></p>
<div class="admonition warning">
<p class="admonition-title">Warning</p>
@@ -3197,6 +3234,7 @@ Check <a href="../Demo-Mode">here</a> for details. </p>
<hr style="border:2px solid"/>
<p><a id="TakeImage-ImageQuality"></a></p>
<h3 id="parameter-imagequality"><span class="enumerate-headings-plugin enumerate-heading-plugin">1.1.38</span> Parameter <code>ImageQuality</code></h3>
<p>Section: <a href="#section-takeimage">1.1 TakeImage</a></p>
<p>Default Value: <code>12</code></p>
<div class="admonition warning">
<p class="admonition-title">Warning</p>
@@ -3210,6 +3248,7 @@ Check <a href="../Demo-Mode">here</a> for details. </p>
<hr style="border:2px solid"/>
<p><a id="TakeImage-ImageSize"></a></p>
<h3 id="parameter-imagesize"><span class="enumerate-headings-plugin enumerate-heading-plugin">1.1.39</span> Parameter <code>ImageSize</code></h3>
<p>Section: <a href="#section-takeimage">1.1 TakeImage</a></p>
<p>Default Value: <code>VGA</code></p>
<div class="admonition warning">
<p class="admonition-title">Warning</p>
@@ -3224,6 +3263,7 @@ Check <a href="../Demo-Mode">here</a> for details. </p>
<hr style="border:2px solid"/>
<p><a id="TakeImage-LEDIntensity"></a></p>
<h3 id="parameter-ledintensity"><span class="enumerate-headings-plugin enumerate-heading-plugin">1.1.40</span> Parameter <code>LEDIntensity</code></h3>
<p>Section: <a href="#section-takeimage">1.1 TakeImage</a></p>
<p>Default Value: <code>50</code></p>
<div class="admonition note">
<p class="admonition-title">Note</p>
@@ -3237,6 +3277,7 @@ Check <a href="../Demo-Mode">here</a> for details. </p>
<hr style="border:2px solid"/>
<p><a id="TakeImage-Negative"></a></p>
<h3 id="parameter-negative"><span class="enumerate-headings-plugin enumerate-heading-plugin">1.1.41</span> Parameter <code>Negative</code></h3>
<p>Section: <a href="#section-takeimage">1.1 TakeImage</a></p>
<p>Default Value: <code>false</code></p>
<div class="admonition warning">
<p class="admonition-title">Warning</p>
@@ -3254,6 +3295,7 @@ Check <a href="../Demo-Mode">here</a> for details. </p>
<hr style="border:2px solid"/>
<p><a id="TakeImage-RawImagesLocation"></a></p>
<h3 id="parameter-rawimageslocation"><span class="enumerate-headings-plugin enumerate-heading-plugin">1.1.42</span> Parameter <code>RawImagesLocation</code></h3>
<p>Section: <a href="#section-takeimage">1.1 TakeImage</a></p>
<p>Default Value: <code>/log/source</code></p>
<p>Location on the SD-Card to store the raw images.</p>
<div class="admonition warning">
@@ -3263,12 +3305,14 @@ Check <a href="../Demo-Mode">here</a> for details. </p>
<hr style="border:2px solid"/>
<p><a id="TakeImage-RawImagesRetention"></a></p>
<h3 id="parameter-rawimagesretention"><span class="enumerate-headings-plugin enumerate-heading-plugin">1.1.43</span> Parameter <code>RawImagesRetention</code></h3>
<p>Section: <a href="#section-takeimage">1.1 TakeImage</a></p>
<p>Default Value: <code>15</code></p>
<p>Unit: Days</p>
<p>Number of days to keep the raw images (<code>0</code> = forever)</p>
<hr style="border:2px solid"/>
<p><a id="TakeImage-Saturation"></a></p>
<h3 id="parameter-saturation"><span class="enumerate-headings-plugin enumerate-heading-plugin">1.1.44</span> Parameter <code>Saturation</code></h3>
<p>Section: <a href="#section-takeimage">1.1 TakeImage</a></p>
<p>Default Value: <code>0</code></p>
<div class="admonition note">
<p class="admonition-title">Note</p>
@@ -3282,6 +3326,7 @@ Check <a href="../Demo-Mode">here</a> for details. </p>
<hr style="border:2px solid"/>
<p><a id="TakeImage-Sharpness"></a></p>
<h3 id="parameter-sharpness"><span class="enumerate-headings-plugin enumerate-heading-plugin">1.1.45</span> Parameter <code>Sharpness</code></h3>
<p>Section: <a href="#section-takeimage">1.1 TakeImage</a></p>
<p>Default Value: <code>0</code></p>
<div class="admonition warning">
<p class="admonition-title">Warning</p>
@@ -3300,6 +3345,7 @@ Check <a href="../Demo-Mode">here</a> for details. </p>
<hr style="border:2px solid"/>
<p><a id="TakeImage-WaitBeforeTakingPicture"></a></p>
<h3 id="parameter-waitbeforetakingpicture"><span class="enumerate-headings-plugin enumerate-heading-plugin">1.1.46</span> Parameter <code>WaitBeforeTakingPicture</code></h3>
<p>Section: <a href="#section-takeimage">1.1 TakeImage</a></p>
<p>Default Value: <code>5</code></p>
<p>Unit: seconds</p>
<div class="admonition warning">
@@ -3310,6 +3356,7 @@ Check <a href="../Demo-Mode">here</a> for details. </p>
<hr style="border:2px solid"/>
<p><a id="TakeImage-Zoom"></a></p>
<h3 id="parameter-zoom"><span class="enumerate-headings-plugin enumerate-heading-plugin">1.1.47</span> Parameter <code>Zoom</code></h3>
<p>Section: <a href="#section-takeimage">1.1 TakeImage</a></p>
<p>Default Value: <code>false</code></p>
<div class="admonition warning">
<p class="admonition-title">Warning</p>
@@ -3327,6 +3374,7 @@ Check <a href="../Demo-Mode">here</a> for details. </p>
<hr style="border:2px solid"/>
<p><a id="TakeImage-ZoomMode"></a></p>
<h3 id="parameter-zoommode"><span class="enumerate-headings-plugin enumerate-heading-plugin">1.1.48</span> Parameter <code>ZoomMode</code></h3>
<p>Section: <a href="#section-takeimage">1.1 TakeImage</a></p>
<p>Default Value: <code>0</code></p>
<div class="admonition warning">
<p class="admonition-title">Warning</p>
@@ -3346,6 +3394,7 @@ Value 1: Scale the camera sensor frame to 800 x 600 pixels then crop it to <code
<hr style="border:2px solid"/>
<p><a id="TakeImage-ZoomOffsetX"></a></p>
<h3 id="parameter-zoomoffsetx"><span class="enumerate-headings-plugin enumerate-heading-plugin">1.1.49</span> Parameter <code>ZoomOffsetX</code></h3>
<p>Section: <a href="#section-takeimage">1.1 TakeImage</a></p>
<p>Default Value: <code>0</code></p>
<div class="admonition warning">
<p class="admonition-title">Warning</p>
@@ -3364,6 +3413,7 @@ X coordinate of the crop location within the camera sensor frame.</p>
<hr style="border:2px solid"/>
<p><a id="TakeImage-ZoomOffsetY"></a></p>
<h3 id="parameter-zoomoffsety"><span class="enumerate-headings-plugin enumerate-heading-plugin">1.1.50</span> Parameter <code>ZoomOffsetY</code></h3>
<p>Section: <a href="#section-takeimage">1.1 TakeImage</a></p>
<p>Default Value: <code>0</code></p>
<div class="admonition warning">
<p class="admonition-title">Warning</p>
@@ -3383,6 +3433,7 @@ Y coordinate of the crop location within the camera sensor frame.</p>
<h2 id="section-alignment"><span class="enumerate-headings-plugin enumerate-heading-plugin">1.2</span> Section <code>Alignment</code></h2>
<p><a id="Alignment-AlignmentAlgo"></a></p>
<h3 id="parameter-alignmentalgo"><span class="enumerate-headings-plugin enumerate-heading-plugin">1.2.1</span> Parameter <code>AlignmentAlgo</code></h3>
<p>Section: <a href="#section-alignment">1.2 Alignment</a></p>
<p>Default Value: <code>Default</code></p>
<div class="admonition warning">
<p class="admonition-title">Warning</p>
@@ -3399,6 +3450,7 @@ Y coordinate of the crop location within the camera sensor frame.</p>
<hr style="border:2px solid"/>
<p><a id="Alignment-FlipImageSize"></a></p>
<h3 id="parameter-flipimagesize"><span class="enumerate-headings-plugin enumerate-heading-plugin">1.2.2</span> Parameter <code>FlipImageSize</code></h3>
<p>Section: <a href="#section-alignment">1.2 Alignment</a></p>
<p>Default Value: <code>false</code></p>
<div class="admonition note">
<p class="admonition-title">Note</p>
@@ -3413,6 +3465,7 @@ Y coordinate of the crop location within the camera sensor frame.</p>
<hr style="border:2px solid"/>
<p><a id="Alignment-InitialMirror"></a></p>
<h3 id="parameter-initialmirror"><span class="enumerate-headings-plugin enumerate-heading-plugin">1.2.3</span> Parameter <code>InitialMirror</code></h3>
<p>Section: <a href="#section-alignment">1.2 Alignment</a></p>
<p>Default Value: <code>false</code></p>
<div class="admonition note">
<p class="admonition-title">Note</p>
@@ -3426,6 +3479,7 @@ Y coordinate of the crop location within the camera sensor frame.</p>
<hr style="border:2px solid"/>
<p><a id="Alignment-InitialRotate"></a></p>
<h3 id="parameter-initialrotate"><span class="enumerate-headings-plugin enumerate-heading-plugin">1.2.4</span> Parameter <code>InitialRotate</code></h3>
<p>Section: <a href="#section-alignment">1.2 Alignment</a></p>
<p>Default Value: <code>0</code></p>
<p>Unit: Degrees</p>
<div class="admonition note">
@@ -3440,6 +3494,7 @@ Y coordinate of the crop location within the camera sensor frame.</p>
<hr style="border:2px solid"/>
<p><a id="Alignment-SearchFieldX"></a></p>
<h3 id="parameter-searchfieldx"><span class="enumerate-headings-plugin enumerate-heading-plugin">1.2.5</span> Parameter <code>SearchFieldX</code></h3>
<p>Section: <a href="#section-alignment">1.2 Alignment</a></p>
<p>Default Value: <code>20</code></p>
<p>Unit: Pixels</p>
<div class="admonition warning">
@@ -3456,6 +3511,7 @@ Y coordinate of the crop location within the camera sensor frame.</p>
<hr style="border:2px solid"/>
<p><a id="Alignment-SearchFieldY"></a></p>
<h3 id="parameter-searchfieldy"><span class="enumerate-headings-plugin enumerate-heading-plugin">1.2.6</span> Parameter <code>SearchFieldY</code></h3>
<p>Section: <a href="#section-alignment">1.2 Alignment</a></p>
<p>Default Value: <code>20</code></p>
<p>Unit: Pixels</p>
<div class="admonition warning">
@@ -3473,6 +3529,7 @@ Y coordinate of the crop location within the camera sensor frame.</p>
<h2 id="section-digits"><span class="enumerate-headings-plugin enumerate-heading-plugin">1.3</span> Section <code>Digits</code></h2>
<p><a id="Digits-CNNGoodThreshold"></a></p>
<h3 id="parameter-cnngoodthreshold"><span class="enumerate-headings-plugin enumerate-heading-plugin">1.3.1</span> Parameter <code>CNNGoodThreshold</code></h3>
<p>Section: <a href="#section-digits">1.3 Digits</a></p>
<p>Default Value: <code>0.5</code></p>
<div class="admonition warning">
<p class="admonition-title">Warning</p>
@@ -3486,11 +3543,13 @@ Y coordinate of the crop location within the camera sensor frame.</p>
<hr style="border:2px solid"/>
<p><a id="Digits-Model"></a></p>
<h3 id="parameter-model"><span class="enumerate-headings-plugin enumerate-heading-plugin">1.3.2</span> Parameter <code>Model</code></h3>
<p>Section: <a href="#section-digits">1.3 Digits</a></p>
<p>Default Value: <code>/config/dig-cont_*.tflite</code> (See <a href="https://github.com/jomjol/AI-on-the-edge-device/blob/master/sd-card/config/config.ini">/config/config.ini</a>)</p>
<p>Path to CNN model file for image recognition. See <a href="../Choosing-the-Model">here</a> for details. </p>
<hr style="border:2px solid"/>
<p><a id="Digits-ROIImagesLocation"></a></p>
<h3 id="parameter-roiimageslocation"><span class="enumerate-headings-plugin enumerate-heading-plugin">1.3.3</span> Parameter <code>ROIImagesLocation</code></h3>
<p>Section: <a href="#section-digits">1.3 Digits</a></p>
<p>Default Value: <code>/log/digit</code></p>
<p>Location to store separated digit images on the SD-Card.</p>
<div class="admonition warning">
@@ -3500,6 +3559,7 @@ Y coordinate of the crop location within the camera sensor frame.</p>
<hr style="border:2px solid"/>
<p><a id="Digits-ROIImagesRetention"></a></p>
<h3 id="parameter-roiimagesretention"><span class="enumerate-headings-plugin enumerate-heading-plugin">1.3.4</span> Parameter <code>ROIImagesRetention</code></h3>
<p>Section: <a href="#section-digits">1.3 Digits</a></p>
<p>Default Value: <code>3</code></p>
<p>Unit: Days</p>
<p>Days to keep the separated digit images (<code>0</code> = forever).</p>
@@ -3507,6 +3567,7 @@ Y coordinate of the crop location within the camera sensor frame.</p>
<h2 id="section-analog"><span class="enumerate-headings-plugin enumerate-heading-plugin">1.4</span> Section <code>Analog</code></h2>
<p><a id="Analog-CNNGoodThreshold"></a></p>
<h3 id="parameter-cnngoodthreshold_1"><span class="enumerate-headings-plugin enumerate-heading-plugin">1.4.1</span> Parameter <code>CNNGoodThreshold</code></h3>
<p>Section: <a href="#section-analog">1.4 Analog</a></p>
<p>Default Value: <code>0.5</code></p>
<div class="admonition warning">
<p class="admonition-title">Warning</p>
@@ -3528,11 +3589,13 @@ Use <a href="../Parameters/#PostProcessing-NUMBER.ExtendedResolution"><code>NUMB
<hr style="border:2px solid"/>
<p><a id="Analog-Model"></a></p>
<h3 id="parameter-model_1"><span class="enumerate-headings-plugin enumerate-heading-plugin">1.4.3</span> Parameter <code>Model</code></h3>
<p>Section: <a href="#section-analog">1.4 Analog</a></p>
<p>Default Value: <code>/config/ana-cont_*.tflite</code> (See <a href="https://github.com/jomjol/AI-on-the-edge-device/blob/master/sd-card/config/config.ini">/config/config.ini</a>)</p>
<p>Path to CNN model file for image recognition. See <a href="../Choosing-the-Model">here</a> for details. </p>
<hr style="border:2px solid"/>
<p><a id="Analog-ROIImagesLocation"></a></p>
<h3 id="parameter-roiimageslocation_1"><span class="enumerate-headings-plugin enumerate-heading-plugin">1.4.4</span> Parameter <code>ROIImagesLocation</code></h3>
<p>Section: <a href="#section-analog">1.4 Analog</a></p>
<p>Default Value: <code>/log/analog</code></p>
<p>Location to store separated analog images on the SD-Card.</p>
<div class="admonition warning">
@@ -3542,6 +3605,7 @@ Use <a href="../Parameters/#PostProcessing-NUMBER.ExtendedResolution"><code>NUMB
<hr style="border:2px solid"/>
<p><a id="Analog-ROIImagesRetention"></a></p>
<h3 id="parameter-roiimagesretention_1"><span class="enumerate-headings-plugin enumerate-heading-plugin">1.4.5</span> Parameter <code>ROIImagesRetention</code></h3>
<p>Section: <a href="#section-analog">1.4 Analog</a></p>
<p>Default Value: <code>3</code></p>
<p>Unit: Days</p>
<p>Days to keep the separated analog images (<code>0</code> = forever).</p>
@@ -3557,6 +3621,7 @@ Use <a href="../Parameters/#PostProcessing-NUMBER.AllowNegativeRates"><code>NUMB
<hr style="border:2px solid"/>
<p><a id="PostProcessing-CheckDigitIncreaseConsistency"></a></p>
<h3 id="parameter-checkdigitincreaseconsistency"><span class="enumerate-headings-plugin enumerate-heading-plugin">1.5.2</span> Parameter <code>CheckDigitIncreaseConsistency</code></h3>
<p>Section: <a href="#section-postprocessing">1.5 PostProcessing</a></p>
<p>Default Value: <code>false</code></p>
<div class="admonition warning">
<p class="admonition-title">Warning</p>
@@ -3567,6 +3632,7 @@ It especially improves the zero crossing check between digits.</p>
<hr style="border:2px solid"/>
<p><a id="PostProcessing-ErrorMessage"></a></p>
<h3 id="parameter-errormessage"><span class="enumerate-headings-plugin enumerate-heading-plugin">1.5.3</span> Parameter <code>ErrorMessage</code></h3>
<p>Section: <a href="#section-postprocessing">1.5 PostProcessing</a></p>
<p>Default Value: <code>true</code></p>
<div class="admonition warning">
<p class="admonition-title">Warning</p>
@@ -3577,6 +3643,7 @@ In an error case, the last valid number will be used for the various transmissio
<hr style="border:2px solid"/>
<p><a id="PostProcessing-NUMBER.AllowNegativeRates"></a></p>
<h3 id="parameter-numbersallownegativerates"><span class="enumerate-headings-plugin enumerate-heading-plugin">1.5.4</span> Parameter <code>&lt;NUMBERS&gt;.AllowNegativeRates</code></h3>
<p>Section: <a href="#section-postprocessing">1.5 PostProcessing</a></p>
<p>Default Value: <code>false</code></p>
<p>Allow a meter to count backwards (decreasing values).</p>
<div class="admonition note">
@@ -3586,6 +3653,7 @@ In an error case, the last valid number will be used for the various transmissio
<hr style="border:2px solid"/>
<p><a id="PostProcessing-NUMBER.AnalogDigitalTransitionStart"></a></p>
<h3 id="parameter-numberanalogdigitaltransitionstart"><span class="enumerate-headings-plugin enumerate-heading-plugin">1.5.5</span> Parameter <code>&lt;NUMBER&gt;.AnalogDigitalTransitionStart</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.
Look for the start of changing of the first digit and note the analog pointer value behind.
@@ -3595,12 +3663,14 @@ See <a href="../Watermeter-specific-analog---digital-transition">here</a> for de
<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.6</span> Parameter <code>&lt;NUMBER&gt;.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>
<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.7</span> Parameter <code>&lt;NUMBER&gt;.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>
<div class="admonition note">
@@ -3610,6 +3680,7 @@ Eg. to move from <code>m³</code> to <code>liter</code> (<code>1 m³</code> equa
<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.8</span> Parameter <code>&lt;NUMBER&gt;.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>!
@@ -3617,18 +3688,21 @@ See <a href="../Choosing-the-Model">here</a> for details.</p>
<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.9</span> Parameter <code>&lt;NUMBER&gt;.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>
<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.10</span> Parameter <code>&lt;NUMBER&gt;.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>
<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.11</span> Parameter <code>PreValueAgeStartup</code></h3>
<p>Section: <a href="#section-postprocessing">1.5 PostProcessing</a></p>
<p>Default Value: <code>720</code></p>
<div class="admonition warning">
<p class="admonition-title">Warning</p>
@@ -3638,6 +3712,7 @@ as the difference normalized to the interval (<code>RateChange</code> = differen
<hr style="border:2px solid"/>
<p><a id="PostProcessing-PreValueUse"></a></p>
<h3 id="parameter-prevalueuse"><span class="enumerate-headings-plugin enumerate-heading-plugin">1.5.12</span> Parameter <code>PreValueUse</code></h3>
<p>Section: <a href="#section-postprocessing">1.5 PostProcessing</a></p>
<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>
@@ -3645,6 +3720,7 @@ This also works through a reboot of the device!</p>
<h2 id="section-mqtt"><span class="enumerate-headings-plugin enumerate-heading-plugin">1.6</span> Section <code>MQTT</code></h2>
<p><a id="MQTT-CACert"></a></p>
<h3 id="parameter-cacert"><span class="enumerate-headings-plugin enumerate-heading-plugin">1.6.1</span> Parameter <code>CACert</code></h3>
<p>Section: <a href="#section-mqtt">1.6 MQTT</a></p>
<p>Default Value: <code>""</code></p>
<p>Example: <code>/config/certs/RootCA.pem</code>.</p>
<div class="admonition warning">
@@ -3663,6 +3739,7 @@ It allows the client to authenticate the server, which is the first part of the
<hr style="border:2px solid"/>
<p><a id="MQTT-ClientCert"></a></p>
<h3 id="parameter-clientcert"><span class="enumerate-headings-plugin enumerate-heading-plugin">1.6.2</span> Parameter <code>ClientCert</code></h3>
<p>Section: <a href="#section-mqtt">1.6 MQTT</a></p>
<p>Default Value: <code>""</code></p>
<p>Example: <code>/config/certs/client.pem.crt</code>.</p>
<div class="admonition warning">
@@ -3682,12 +3759,14 @@ This also means that you might have to change the protocol and port in <a href="
<hr style="border:2px solid"/>
<p><a id="MQTT-ClientID"></a></p>
<h3 id="parameter-clientid"><span class="enumerate-headings-plugin enumerate-heading-plugin">1.6.3</span> Parameter <code>ClientID</code></h3>
<p>Section: <a href="#section-mqtt">1.6 MQTT</a></p>
<p>Default Value: <code>watermeter</code></p>
<p>Client ID used to connect to the MQTT broker.
If disabled, the <code>hostname</code> will be used.</p>
<hr style="border:2px solid"/>
<p><a id="MQTT-ClientKey"></a></p>
<h3 id="parameter-clientkey"><span class="enumerate-headings-plugin enumerate-heading-plugin">1.6.4</span> Parameter <code>ClientKey</code></h3>
<p>Section: <a href="#section-mqtt">1.6 MQTT</a></p>
<p>Default Value: <code>""</code></p>
<p>Example: <code>/config/certs/client.pem.key</code>.</p>
<div class="admonition warning">
@@ -3707,12 +3786,14 @@ This also means that you might have to change the protocol and port in <a href="
<hr style="border:2px solid"/>
<p><a id="MQTT-HomeassistantDiscovery"></a></p>
<h3 id="parameter-homeassistantdiscovery"><span class="enumerate-headings-plugin enumerate-heading-plugin">1.6.5</span> Parameter <code>HomeassistantDiscovery</code></h3>
<p>Section: <a href="#section-mqtt">1.6 MQTT</a></p>
<p>Default Value: <code>true</code></p>
<p>Enable or disable the Homeassistant Discovery.
See <a href="../Integration-Home-Assistant">here</a> for details about the discovery.</p>
<hr style="border:2px solid"/>
<p><a id="MQTT-MainTopic"></a></p>
<h3 id="parameter-maintopic"><span class="enumerate-headings-plugin enumerate-heading-plugin">1.6.6</span> Parameter <code>MainTopic</code></h3>
<p>Section: <a href="#section-mqtt">1.6 MQTT</a></p>
<p>Default Value: <code>watermeter</code></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></p>
@@ -3732,6 +3813,7 @@ See <a href="../MQTT-API#result">MQTT Result Topics</a> for a full list of topic
<hr style="border:2px solid"/>
<p><a id="MQTT-MeterType"></a></p>
<h3 id="parameter-metertype"><span class="enumerate-headings-plugin enumerate-heading-plugin">1.6.7</span> Parameter <code>MeterType</code></h3>
<p>Section: <a href="#section-mqtt">1.6 MQTT</a></p>
<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">
@@ -3744,27 +3826,32 @@ Alternatively you can set the parameter <code>DecimalShift</code> to <code>3</co
<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.8</span> Parameter <code>RetainMessages</code></h3>
<p>Section: <a href="#section-mqtt">1.6 MQTT</a></p>
<p>Default Value: <code>true</code></p>
<p>Enable or disable the <a href="https://www.hivemq.com/blog/mqtt-essentials-part-8-retained-messages/">Retain Flag</a> for all MQTT entries.</p>
<hr style="border:2px solid"/>
<p><a id="MQTT-Uri"></a></p>
<h3 id="parameter-uri"><span class="enumerate-headings-plugin enumerate-heading-plugin">1.6.9</span> Parameter <code>Uri</code></h3>
<p>Section: <a href="#section-mqtt">1.6 MQTT</a></p>
<p>Default Value: <code>mqtt://example.com: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"/>
<p><a id="MQTT-password"></a></p>
<h3 id="parameter-password"><span class="enumerate-headings-plugin enumerate-heading-plugin">1.6.10</span> Parameter <code>password</code></h3>
<p>Section: <a href="#section-mqtt">1.6 MQTT</a></p>
<p>Default Value: <code>PASSWORD</code></p>
<p>Password for MQTT authentication.</p>
<hr style="border:2px solid"/>
<p><a id="MQTT-user"></a></p>
<h3 id="parameter-user"><span class="enumerate-headings-plugin enumerate-heading-plugin">1.6.11</span> Parameter <code>user</code></h3>
<p>Section: <a href="#section-mqtt">1.6 MQTT</a></p>
<p>Default Value: <code>USERNAME</code></p>
<p>Username for MQTT authentication.</p>
<hr style="border:2px solid"/>
<h2 id="section-influxdb"><span class="enumerate-headings-plugin enumerate-heading-plugin">1.7</span> Section <code>InfluxDB</code></h2>
<p><a id="InfluxDB-Database"></a></p>
<h3 id="parameter-database"><span class="enumerate-headings-plugin enumerate-heading-plugin">1.7.1</span> Parameter <code>Database</code></h3>
<p>Section: <a href="#section-influxdb">1.7 InfluxDB</a></p>
<p>Default Value: <code>''</code></p>
<p>Name of the InfluxDB v1 Database into which to publish the values.</p>
<div class="admonition note">
@@ -3774,11 +3861,13 @@ Alternatively you can set the parameter <code>DecimalShift</code> to <code>3</co
<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>
<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>
<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>
<p>Section: <a href="#section-influxdb">1.7 InfluxDB</a></p>
<p>Default Value: <code>undefined</code></p>
<p>Name of the InfluxDB v1 Measurement to use to publish the value.</p>
<div class="admonition note">
@@ -3788,6 +3877,7 @@ Alternatively you can set the parameter <code>DecimalShift</code> to <code>3</co
<hr style="border:2px solid"/>
<p><a id="InfluxDB-Uri"></a></p>
<h3 id="parameter-uri_1"><span class="enumerate-headings-plugin enumerate-heading-plugin">1.7.4</span> Parameter <code>Uri</code></h3>
<p>Section: <a href="#section-influxdb">1.7 InfluxDB</a></p>
<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">
@@ -3797,6 +3887,7 @@ Alternatively you can set the parameter <code>DecimalShift</code> to <code>3</co
<hr style="border:2px solid"/>
<p><a id="InfluxDB-password"></a></p>
<h3 id="parameter-password_1"><span class="enumerate-headings-plugin enumerate-heading-plugin">1.7.5</span> Parameter <code>password</code></h3>
<p>Section: <a href="#section-influxdb">1.7 InfluxDB</a></p>
<p>Default Value: <code>undefined</code></p>
<p>Password for the InfluxDB v1 authentication.</p>
<div class="admonition note">
@@ -3806,6 +3897,7 @@ Alternatively you can set the parameter <code>DecimalShift</code> to <code>3</co
<hr style="border:2px solid"/>
<p><a id="InfluxDB-user"></a></p>
<h3 id="parameter-user_1"><span class="enumerate-headings-plugin enumerate-heading-plugin">1.7.6</span> Parameter <code>user</code></h3>
<p>Section: <a href="#section-influxdb">1.7 InfluxDB</a></p>
<p>Default Value: <code>undefined</code></p>
<p>Username for the InfluxDB v1 authentication.</p>
<div class="admonition note">
@@ -3816,6 +3908,7 @@ Alternatively you can set the parameter <code>DecimalShift</code> to <code>3</co
<h2 id="section-influxdbv2"><span class="enumerate-headings-plugin enumerate-heading-plugin">1.8</span> Section <code>InfluxDBv2</code></h2>
<p><a id="InfluxDBv2-Bucket"></a></p>
<h3 id="parameter-bucket"><span class="enumerate-headings-plugin enumerate-heading-plugin">1.8.1</span> Parameter <code>Bucket</code></h3>
<p>Section: <a href="#section-influxdbv2">1.8 InfluxDBv2</a></p>
<p>Default Value: <code>''</code></p>
<p>Name of the InfluxDB v2 Bucket into which to publish the values.</p>
<hr style="border:2px solid"/>
@@ -3829,32 +3922,38 @@ Use <a href="../Parameters/#InfluxDBv2-Basket"><code>Basket</code></a> instead!<
<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>
<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>
<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>
<p>Section: <a href="#section-influxdbv2">1.8 InfluxDBv2</a></p>
<p>Default Value: <code>undefined</code></p>
<p>Name of the InfluxDB v2 Measurement to use to publish the value.</p>
<hr style="border:2px solid"/>
<p><a id="InfluxDBv2-Org"></a></p>
<h3 id="parameter-org"><span class="enumerate-headings-plugin enumerate-heading-plugin">1.8.5</span> Parameter <code>Org</code></h3>
<p>Section: <a href="#section-influxdbv2">1.8 InfluxDBv2</a></p>
<p>Default Value: <code>undefined</code></p>
<p>Organisation (Org) for InfluxDB v2 authentication</p>
<hr style="border:2px solid"/>
<p><a id="InfluxDBv2-Token"></a></p>
<h3 id="parameter-token"><span class="enumerate-headings-plugin enumerate-heading-plugin">1.8.6</span> Parameter <code>Token</code></h3>
<p>Section: <a href="#section-influxdbv2">1.8 InfluxDBv2</a></p>
<p>Default Value: <code>undefined</code></p>
<p>Token for InfluxDB v2 authentication</p>
<hr style="border:2px solid"/>
<p><a id="InfluxDBv2-Uri"></a></p>
<h3 id="parameter-uri_2"><span class="enumerate-headings-plugin enumerate-heading-plugin">1.8.7</span> Parameter <code>Uri</code></h3>
<p>Section: <a href="#section-influxdbv2">1.8 InfluxDBv2</a></p>
<p>Default Value: <code>undefined</code></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"/>
<h2 id="section-gpio"><span class="enumerate-headings-plugin enumerate-heading-plugin">1.9</span> Section <code>GPIO</code></h2>
<p><a id="GPIO-IO0"></a></p>
<h3 id="parameter-io0"><span class="enumerate-headings-plugin enumerate-heading-plugin">1.9.1</span> Parameter <code>IO0</code></h3>
<p>Section: <a href="#section-gpio">1.9 GPIO</a></p>
<p>Default Value: <code>input disabled 10 false false</code></p>
<div class="admonition warning">
<p class="admonition-title">Warning</p>
@@ -3879,6 +3978,7 @@ Additionally, it is used to activate Bootloader mode and must therefore be HIGH
<hr style="border:2px solid"/>
<p><a id="GPIO-IO1"></a></p>
<h3 id="parameter-io1"><span class="enumerate-headings-plugin enumerate-heading-plugin">1.9.2</span> Parameter <code>IO1</code></h3>
<p>Section: <a href="#section-gpio">1.9 GPIO</a></p>
<p>Default Value: <code>input disabled 10 false false</code></p>
<div class="admonition warning">
<p class="admonition-title">Warning</p>
@@ -3901,6 +4001,7 @@ Additionally, it is used to activate Bootloader mode and must therefore be HIGH
<hr style="border:2px solid"/>
<p><a id="GPIO-IO12"></a></p>
<h3 id="parameter-io12"><span class="enumerate-headings-plugin enumerate-heading-plugin">1.9.3</span> Parameter <code>IO12</code></h3>
<p>Section: <a href="#section-gpio">1.9 GPIO</a></p>
<p>Default Value: <code>input-pullup disabled 10 false false</code></p>
<div class="admonition warning">
<p class="admonition-title">Warning</p>
@@ -3923,6 +4024,7 @@ Additionally, it is used to activate Bootloader mode and must therefore be HIGH
<hr style="border:2px solid"/>
<p><a id="GPIO-IO13"></a></p>
<h3 id="parameter-io13"><span class="enumerate-headings-plugin enumerate-heading-plugin">1.9.4</span> Parameter <code>IO13</code></h3>
<p>Section: <a href="#section-gpio">1.9 GPIO</a></p>
<p>Default Value: <code>input-pullup disabled 10 false false</code></p>
<div class="admonition warning">
<p class="admonition-title">Warning</p>
@@ -3945,6 +4047,7 @@ Additionally, it is used to activate Bootloader mode and must therefore be HIGH
<hr style="border:2px solid"/>
<p><a id="GPIO-IO3"></a></p>
<h3 id="parameter-io3"><span class="enumerate-headings-plugin enumerate-heading-plugin">1.9.5</span> Parameter <code>IO3</code></h3>
<p>Section: <a href="#section-gpio">1.9 GPIO</a></p>
<p>Default Value: <code>input disabled 10 false false</code></p>
<div class="admonition warning">
<p class="admonition-title">Warning</p>
@@ -3967,6 +4070,7 @@ Additionally, it is used to activate Bootloader mode and must therefore be HIGH
<hr style="border:2px solid"/>
<p><a id="GPIO-IO4"></a></p>
<h3 id="parameter-io4"><span class="enumerate-headings-plugin enumerate-heading-plugin">1.9.6</span> Parameter <code>IO4</code></h3>
<p>Section: <a href="#section-gpio">1.9 GPIO</a></p>
<p>Default Value: <code>built-in-led disabled 10 false false</code></p>
<div class="admonition warning">
<p class="admonition-title">Warning</p>
@@ -3990,22 +4094,26 @@ By default, it is used for build-in flash light (onboard LED).</p>
<hr style="border:2px solid"/>
<p><a id="GPIO-LEDColor"></a></p>
<h3 id="parameter-ledcolor"><span class="enumerate-headings-plugin enumerate-heading-plugin">1.9.7</span> Parameter <code>LEDColor</code></h3>
<p>Section: <a href="#section-gpio">1.9 GPIO</a></p>
<p>Default Value: <code>150 150 150</code></p>
<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>
<hr style="border:2px solid"/>
<p><a id="GPIO-LEDNumbers"></a></p>
<h3 id="parameter-lednumbers"><span class="enumerate-headings-plugin enumerate-heading-plugin">1.9.8</span> Parameter <code>LEDNumbers</code></h3>
<p>Section: <a href="#section-gpio">1.9 GPIO</a></p>
<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>
<hr style="border:2px solid"/>
<p><a id="GPIO-LEDType"></a></p>
<h3 id="parameter-ledtype"><span class="enumerate-headings-plugin enumerate-heading-plugin">1.9.9</span> Parameter <code>LEDType</code></h3>
<p>Section: <a href="#section-gpio">1.9 GPIO</a></p>
<p>Default Value: <code>WS2812</code>
Type of the <code>WS2812x</code> which is connected to GPIO12 (See <code>IO12</code> parameter).</p>
<hr style="border:2px solid"/>
<p><a id="GPIO-MainTopicMQTT"></a></p>
<h3 id="parameter-maintopicmqtt"><span class="enumerate-headings-plugin enumerate-heading-plugin">1.9.10</span> Parameter <code>MainTopicMQTT</code></h3>
<p>Section: <a href="#section-gpio">1.9 GPIO</a></p>
<p>Default Value: <code>wasserzaehler/GPIO</code></p>
<div class="admonition note">
<p class="admonition-title">Note</p>
@@ -4017,6 +4125,7 @@ As this parameter is still experimental it can only be set manually in the <code
<h2 id="section-autotimer"><span class="enumerate-headings-plugin enumerate-heading-plugin">1.10</span> Section <code>AutoTimer</code></h2>
<p><a id="AutoTimer-AutoStart"></a></p>
<h3 id="parameter-autostart"><span class="enumerate-headings-plugin enumerate-heading-plugin">1.10.1</span> Parameter <code>AutoStart</code></h3>
<p>Section: <a href="#section-autotimer">1.10 AutoTimer</a></p>
<p>Default Value: <code>true</code></p>
<div class="admonition warning">
<p class="admonition-title">Warning</p>
@@ -4032,6 +4141,7 @@ The main reasons to set it to <code>false</code> is when you want to trigger it
<hr style="border:2px solid"/>
<p><a id="AutoTimer-Interval"></a></p>
<h3 id="parameter-interval"><span class="enumerate-headings-plugin enumerate-heading-plugin">1.10.2</span> Parameter <code>Interval</code></h3>
<p>Section: <a href="#section-autotimer">1.10 AutoTimer</a></p>
<p>Default Value: <code>5</code></p>
<p>Unit: Minutes</p>
<p>Interval in which the Flow (Digitization Round) is run.
@@ -4040,12 +4150,14 @@ If a round takes longer than this interval, the next round gets postponed until
<h2 id="section-datalogging"><span class="enumerate-headings-plugin enumerate-heading-plugin">1.11</span> Section <code>DataLogging</code></h2>
<p><a id="DataLogging-DataFilesRetention"></a></p>
<h3 id="parameter-datafilesretention"><span class="enumerate-headings-plugin enumerate-heading-plugin">1.11.1</span> Parameter <code>DataFilesRetention</code></h3>
<p>Section: <a href="#section-datalogging">1.11 DataLogging</a></p>
<p>Default Value: <code>3</code></p>
<p>Unit: Days</p>
<p>Number of days to keep the data files (<code>0</code> = forever).</p>
<hr style="border:2px solid"/>
<p><a id="DataLogging-DataLogActive"></a></p>
<h3 id="parameter-datalogactive"><span class="enumerate-headings-plugin enumerate-heading-plugin">1.11.2</span> Parameter <code>DataLogActive</code></h3>
<p>Section: <a href="#section-datalogging">1.11 DataLogging</a></p>
<p>Default Value: <code>true</code>
Activate data logging to the SD-Card.</p>
<p>The files will be stored in <code>/log/data/data_YYYY-MM-DD.csv</code>. See <a href="../data-logging"><code>Data Logging</code></a> for details.</p>
@@ -4057,6 +4169,7 @@ Activate data logging to the SD-Card.</p>
<h2 id="section-debug"><span class="enumerate-headings-plugin enumerate-heading-plugin">1.12</span> Section <code>Debug</code></h2>
<p><a id="Debug-LogLevel"></a></p>
<h3 id="parameter-loglevel"><span class="enumerate-headings-plugin enumerate-heading-plugin">1.12.1</span> Parameter <code>LogLevel</code></h3>
<p>Section: <a href="#section-debug">1.12 Debug</a></p>
<p>Default Value: <code>1</code> (<code>ERROR</code>)
Define the log level for the logging to the SD-Card.</p>
<p>Available options:</p>
@@ -4075,6 +4188,7 @@ A SD-Card has limited write cycles. Since the device does not do <a href="https:
<hr style="border:2px solid"/>
<p><a id="Debug-LogfilesRetention"></a></p>
<h3 id="parameter-logfilesretention"><span class="enumerate-headings-plugin enumerate-heading-plugin">1.12.2</span> Parameter <code>LogfilesRetention</code></h3>
<p>Section: <a href="#section-debug">1.12 Debug</a></p>
<p>Default Value: <code>3</code></p>
<p>Unit: Days</p>
<p>Number of days to keep the log files (<code>0</code> = forever).</p>
@@ -4082,6 +4196,7 @@ A SD-Card has limited write cycles. Since the device does not do <a href="https:
<h2 id="section-system"><span class="enumerate-headings-plugin enumerate-heading-plugin">1.13</span> Section <code>System</code></h2>
<p><a id="System-CPUFrequency"></a></p>
<h3 id="parameter-cpufrequency"><span class="enumerate-headings-plugin enumerate-heading-plugin">1.13.1</span> Parameter <code>CPUFrequency</code></h3>
<p>Section: <a href="#section-system">1.13 System</a></p>
<p>Default Value: <code>160</code></p>
<p>Set the CPU Frequency.</p>
<div class="admonition warning">
@@ -4097,6 +4212,7 @@ Additionally, depending on the quality of your ESP32-CAM, it might run unstable!
<hr style="border:2px solid"/>
<p><a id="System-Hostname"></a></p>
<h3 id="parameter-hostname"><span class="enumerate-headings-plugin enumerate-heading-plugin">1.13.2</span> Parameter <code>Hostname</code></h3>
<p>Section: <a href="#section-system">1.13 System</a></p>
<p>Default Value: <code>undefined</code></p>
<div class="admonition warning">
<p class="admonition-title">Warning</p>
@@ -4107,6 +4223,7 @@ It gets automatically transferred to <code>/wlan.ini</code> on the SD-Card at th
<hr style="border:2px solid"/>
<p><a id="System-RSSIThreshold"></a></p>
<h3 id="parameter-rssithreshold"><span class="enumerate-headings-plugin enumerate-heading-plugin">1.13.3</span> Parameter <code>RSSIThreshold</code></h3>
<p>Section: <a href="#section-system">1.13 System</a></p>
<p>Default Value: <code>0</code></p>
<p>Possible values: <code>-100</code> .. <code>0</code> (<code>0</code> = disabled).</p>
<div class="admonition warning">
@@ -4126,6 +4243,7 @@ If actual RSSI value is lower (more negative) than <code>RSSIThreshold</code>, a
<hr style="border:2px solid"/>
<p><a id="System-SetupMode"></a></p>
<h3 id="parameter-setupmode"><span class="enumerate-headings-plugin enumerate-heading-plugin">1.13.4</span> Parameter <code>SetupMode</code></h3>
<p>Section: <a href="#section-system">1.13 System</a></p>
<p>Default Value: <code>true</code></p>
<div class="admonition note">
<p class="admonition-title">Note</p>
@@ -4135,6 +4253,7 @@ If actual RSSI value is lower (more negative) than <code>RSSIThreshold</code>, a
<hr style="border:2px solid"/>
<p><a id="System-TimeServer"></a></p>
<h3 id="parameter-timeserver"><span class="enumerate-headings-plugin enumerate-heading-plugin">1.13.5</span> Parameter <code>TimeServer</code></h3>
<p>Section: <a href="#section-system">1.13 System</a></p>
<p>Default Value: <code>pool.ntp.org</code></p>
<div class="admonition warning">
<p class="admonition-title">Warning</p>
@@ -4147,6 +4266,7 @@ In such case the time always starts at <code>01.01.1970</code> after each power
<hr style="border:2px solid"/>
<p><a id="System-TimeZone"></a></p>
<h3 id="parameter-timezone"><span class="enumerate-headings-plugin enumerate-heading-plugin">1.13.6</span> Parameter <code>TimeZone</code></h3>
<p>Section: <a href="#section-system">1.13 System</a></p>
<p>Default Value: <code>CET-1CEST,M3.5.0,M10.5.0/3</code></p>
<p>Time zone in POSIX syntax (Europe/Berlin = <code>CET-1CEST,M3.5.0,M10.5.0/3</code> - incl. daylight saving)
Check the table on <code>http://&lt;DEVICE IP&gt;/timezones.html</code> to find the settings for your region.</p>