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-07 20:16:57 +03:00
Code Issues Packages Projects Releases Wiki Activity
Files
fc012c642f281b23f1c36042c9bbb3c60f325670
AI-on-the-edge-device-docs/Parameters/index.html
github-actions[bot] fc012c642f Deployed 7ff7560 with MkDocs version: 1.6.1
2024-09-01 01:47:56 +00:00

3902 lines
148 KiB
HTML
Raw Blame History

This file contains invisible Unicode characters

This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!DOCTYPE html>
<html class="no-js" lang="en">
<head>
<meta charset="utf-8"/>
<meta content="width=device-width,initial-scale=1" name="viewport"/>
<link href="https://jomjol.github.io/AI-on-the-edge-device-docs/Parameters/" rel="canonical"/>
<link href="../ota/" rel="prev"/>
<link href="../Integration-Home-Assistant/" rel="next"/>
<link href="../img/favicon.ico" rel="icon"/>
<meta content="mkdocs-1.6.1, mkdocs-material-9.5.34" name="generator"/>
<title>Parameters - AI on the Edge Device</title>
<link href="../assets/stylesheets/main.35f28582.min.css" rel="stylesheet"/>
<link href="../assets/stylesheets/palette.06af60db.min.css" rel="stylesheet"/>
<link crossorigin="" href="https://fonts.gstatic.com" rel="preconnect"/>
<link href="https://fonts.googleapis.com/css?family=Roboto:300,300i,400,400i,700,700i%7CRoboto+Mono:400,400i,700,700i&amp;display=fallback" rel="stylesheet"/>
<style>:root{--md-text-font:"Roboto";--md-code-font:"Roboto Mono"}</style>
<script>__md_scope=new URL("..",location),__md_hash=e=>[...e].reduce(((e,_)=>(e<<5)-e+_.charCodeAt(0)),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
</head>
<body data-md-color-accent="indigo" data-md-color-primary="blue" data-md-color-scheme="default" dir="ltr">
<input autocomplete="off" class="md-toggle" data-md-toggle="drawer" id="__drawer" type="checkbox"/>
<input autocomplete="off" class="md-toggle" data-md-toggle="search" id="__search" type="checkbox"/>
<label class="md-overlay" for="__drawer"></label>
<div data-md-component="skip">
<a class="md-skip" href="#parameters">1.
Skip to content
</a>
</div>
<div data-md-component="announce">
</div>
<header class="md-header md-header--shadow" data-md-component="header">
<nav aria-label="Header" class="md-header__inner md-grid">
<a aria-label="AI on the Edge Device" class="md-header__button md-logo" data-md-component="logo" href=".." title="AI on the Edge Device">
<img alt="logo" src="../img/logo.svg"/>
</a>
<label class="md-header__button md-icon" for="__drawer">
<svg viewbox="0 0 24 24" xmlns="http://www.w3.org/2000/svg"><path d="M3 6h18v2H3zm0 5h18v2H3zm0 5h18v2H3z"></path></svg>
</label>
<div class="md-header__title" data-md-component="header-title">
<div class="md-header__ellipsis">
<div class="md-header__topic">
<span class="md-ellipsis">
AI on the Edge Device
</span>
</div>
<div class="md-header__topic" data-md-component="header-topic">
<span class="md-ellipsis">
Parameters
</span>
</div>
</div>
</div>
<label class="md-header__button md-icon" for="__search">
<svg viewbox="0 0 24 24" xmlns="http://www.w3.org/2000/svg"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.52 6.52 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5"></path></svg>
</label>
<div class="md-search" data-md-component="search" role="dialog">
<label class="md-search__overlay" for="__search"></label>
<div class="md-search__inner" role="search">
<form class="md-search__form" name="search">
<input aria-label="Search" autocapitalize="off" autocomplete="off" autocorrect="off" class="md-search__input" data-md-component="search-query" name="query" placeholder="Search" required="" spellcheck="false" type="text"/>
<label class="md-search__icon md-icon" for="__search">
<svg viewbox="0 0 24 24" xmlns="http://www.w3.org/2000/svg"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.52 6.52 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5"></path></svg>
<svg viewbox="0 0 24 24" xmlns="http://www.w3.org/2000/svg"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11z"></path></svg>
</label>
<nav aria-label="Search" class="md-search__options">
<button aria-label="Clear" class="md-search__icon md-icon" tabindex="-1" title="Clear" type="reset">
<svg viewbox="0 0 24 24" xmlns="http://www.w3.org/2000/svg"><path d="M19 6.41 17.59 5 12 10.59 6.41 5 5 6.41 10.59 12 5 17.59 6.41 19 12 13.41 17.59 19 19 17.59 13.41 12z"></path></svg>
</button>
</nav>
</form>
<div class="md-search__output">
<div class="md-search__scrollwrap" data-md-scrollfix="" tabindex="0">
<div class="md-search-result" data-md-component="search-result">
<div class="md-search-result__meta">
Initializing search
</div>
<ol class="md-search-result__list" role="presentation"></ol>
</div>
</div>
</div>
</div>
</div>
<div class="md-header__source">
<a class="md-source" data-md-component="source" href="https://github.com/jomjol/AI-on-the-edge-device-docs" title="Go to repository">
<div class="md-source__icon md-icon">
<svg viewbox="0 0 448 512" xmlns="http://www.w3.org/2000/svg"><!--! Font Awesome Free 6.6.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2024 Fonticons, Inc.--><path d="M439.55 236.05 244 40.45a28.87 28.87 0 0 0-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25.3 12.54 22.26 41.85 9.08 55a34.34 34.34 0 0 1-48.55 0c-17.57-17.6-11.07-46.91 11.25-56v-123c-20.8-8.51-24.6-30.74-18.64-45L142.57 101 8.45 235.14a28.86 28.86 0 0 0 0 40.81l195.61 195.6a28.86 28.86 0 0 0 40.8 0l194.69-194.69a28.86 28.86 0 0 0 0-40.81"></path></svg>
</div>
<div class="md-source__repository">
GitHub
</div>
</a>
</div>
</nav>
</header>
<div class="md-container" data-md-component="container">
<main class="md-main" data-md-component="main">
<div class="md-main__inner md-grid">
<div class="md-sidebar md-sidebar--primary" data-md-component="sidebar" data-md-type="navigation">
<div class="md-sidebar__scrollwrap">
<div class="md-sidebar__inner">
<nav aria-label="Navigation" class="md-nav md-nav--primary" data-md-level="0">
<label class="md-nav__title" for="__drawer">
<a aria-label="AI on the Edge Device" class="md-nav__button md-logo" data-md-component="logo" href=".." title="AI on the Edge Device">
<img alt="logo" src="../img/logo.svg"/>
</a>
AI on the Edge Device
</label>
<div class="md-nav__source">
<a class="md-source" data-md-component="source" href="https://github.com/jomjol/AI-on-the-edge-device-docs" title="Go to repository">
<div class="md-source__icon md-icon">
<svg viewbox="0 0 448 512" xmlns="http://www.w3.org/2000/svg"><!--! Font Awesome Free 6.6.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2024 Fonticons, Inc.--><path d="M439.55 236.05 244 40.45a28.87 28.87 0 0 0-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25.3 12.54 22.26 41.85 9.08 55a34.34 34.34 0 0 1-48.55 0c-17.57-17.6-11.07-46.91 11.25-56v-123c-20.8-8.51-24.6-30.74-18.64-45L142.57 101 8.45 235.14a28.86 28.86 0 0 0 0 40.81l195.61 195.6a28.86 28.86 0 0 0 40.8 0l194.69-194.69a28.86 28.86 0 0 0 0-40.81"></path></svg>
</div>
<div class="md-source__repository">
GitHub
</div>
</a>
</div>
<ul class="md-nav__list" data-md-scrollfix="">
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle" id="__nav_1" type="checkbox"/>
<label class="md-nav__link" for="__nav_1" id="__nav_1_label" tabindex="0">
<span class="md-ellipsis">
Getting Started
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<nav aria-expanded="false" aria-labelledby="__nav_1_label" class="md-nav" data-md-level="1">
<label class="md-nav__title" for="__nav_1">
<span class="md-nav__icon md-icon"></span>
Getting Started
</label>
<ul class="md-nav__list" data-md-scrollfix="">
<li class="md-nav__item">
<a class="md-nav__link" href="..">
<span class="md-ellipsis">
Welcome
</span>
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="../Installation/">
<span class="md-ellipsis">
Installation
</span>
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="../initial-setup/">
<span class="md-ellipsis">
Initial Setup
</span>
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="../Hardware-Compatibility/">
<span class="md-ellipsis">
Hardware Compatibility
</span>
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="../Best-Practice/">
<span class="md-ellipsis">
Best Practice
</span>
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="../FAQs/">
<span class="md-ellipsis">
Frequently Asked Questions
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle" id="__nav_2" type="checkbox"/>
<label class="md-nav__link" for="__nav_2" id="__nav_2_label" tabindex="0">
<span class="md-ellipsis">
Configuration
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<nav aria-expanded="false" aria-labelledby="__nav_2_label" class="md-nav" data-md-level="1">
<label class="md-nav__title" for="__nav_2">
<span class="md-nav__icon md-icon"></span>
Configuration
</label>
<ul class="md-nav__list" data-md-scrollfix="">
<li class="md-nav__item">
<a class="md-nav__link" href="../Reference-Image/">
<span class="md-ellipsis">
Reference Image
</span>
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="../Alignment/">
<span class="md-ellipsis">
Alignment References
</span>
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="../ROI-Configuration/">
<span class="md-ellipsis">
ROIs (Regions of Interest)
</span>
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="../Configuration/">
<span class="md-ellipsis">
Graphical Configuration
</span>
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="../Choosing-the-Model/">
<span class="md-ellipsis">
Model Selection
</span>
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="../ota/">
<span class="md-ellipsis">
Over-The-Air (OTA) Update
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item md-nav__item--active md-nav__item--nested">
<input checked="" class="md-nav__toggle md-toggle" id="__nav_3" type="checkbox"/>
<label class="md-nav__link" for="__nav_3" id="__nav_3_label" tabindex="0">
<span class="md-ellipsis">
Advanced
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<nav aria-expanded="true" aria-labelledby="__nav_3_label" class="md-nav" data-md-level="1">
<label class="md-nav__title" for="__nav_3">
<span class="md-nav__icon md-icon"></span>
Advanced
</label>
<ul class="md-nav__list" data-md-scrollfix="">
<li class="md-nav__item md-nav__item--active">
<input class="md-nav__toggle md-toggle" id="__toc" type="checkbox"/>
<label class="md-nav__link md-nav__link--active" for="__toc">
<span class="md-ellipsis">
Parameters
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<a class="md-nav__link md-nav__link--active" href="./">
<span class="md-ellipsis">
Parameters
</span>
</a>
<nav aria-label="Table of contents" class="md-nav md-nav--secondary">
<label class="md-nav__title" for="__toc">
<span class="md-nav__icon md-icon"></span>
Table of contents
</label>
<ul class="md-nav__list" data-md-component="toc" data-md-scrollfix="">
<li class="md-nav__item">
<a class="md-nav__link" href="#section-takeimage">1.1
<span class="md-ellipsis">
Section TakeImage
</span>
</a>
<nav aria-label="Section TakeImage" class="md-nav">
<ul class="md-nav__list">
<li class="md-nav__item">
<a class="md-nav__link" href="#parameter-camaelevel">1.1.1
<span class="md-ellipsis">
Parameter CamAeLevel
</span>
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="#parameter-camaec">1.1.2
<span class="md-ellipsis">
Parameter CamAec
</span>
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="#parameter-camaec2">1.1.3
<span class="md-ellipsis">
Parameter CamAec2
</span>
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="#parameter-camaecvalue">1.1.4
<span class="md-ellipsis">
Parameter CamAecValue
</span>
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="#parameter-camagc">1.1.5
<span class="md-ellipsis">
Parameter CamAgc
</span>
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="#parameter-camagcgain">1.1.6
<span class="md-ellipsis">
Parameter CamAgcGain
</span>
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="#parameter-camautosharpness">1.1.7
<span class="md-ellipsis">
Parameter CamAutoSharpness
</span>
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="#parameter-camawb">1.1.8
<span class="md-ellipsis">
Parameter CamAwb
</span>
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="#parameter-camawbgain">1.1.9
<span class="md-ellipsis">
Parameter CamAwbGain
</span>
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="#parameter-cambpc">1.1.10
<span class="md-ellipsis">
Parameter CamBpc
</span>
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="#parameter-cambrightness">1.1.11
<span class="md-ellipsis">
Parameter CamBrightness
</span>
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="#parameter-camcolorbar">1.1.12
<span class="md-ellipsis">
Parameter CamColorbar
</span>
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="#parameter-camcontrast">1.1.13
<span class="md-ellipsis">
Parameter CamContrast
</span>
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="#parameter-camdcw">1.1.14
<span class="md-ellipsis">
Parameter CamDcw
</span>
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="#parameter-camdenoise">1.1.15
<span class="md-ellipsis">
Parameter CamDenoise
</span>
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="#parameter-camgainceiling">1.1.16
<span class="md-ellipsis">
Parameter CamGainceiling
</span>
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="#parameter-camhmirror">1.1.17
<span class="md-ellipsis">
Parameter CamHmirror
</span>
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="#parameter-camlenc">1.1.18
<span class="md-ellipsis">
Parameter CamLenc
</span>
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="#parameter-camquality">1.1.19
<span class="md-ellipsis">
Parameter CamQuality
</span>
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="#parameter-camrawgma">1.1.20
<span class="md-ellipsis">
Parameter CamRawGma
</span>
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="#parameter-camsaturation">1.1.21
<span class="md-ellipsis">
Parameter CamSaturation
</span>
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="#parameter-camsharpness">1.1.22
<span class="md-ellipsis">
Parameter CamSharpness
</span>
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="#parameter-camspecialeffect">1.1.23
<span class="md-ellipsis">
Parameter CamSpecialEffect
</span>
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="#parameter-camvflip">1.1.24
<span class="md-ellipsis">
Parameter CamVflip
</span>
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="#parameter-camwbmode">1.1.25
<span class="md-ellipsis">
Parameter CamWbMode
</span>
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="#parameter-camwpc">1.1.26
<span class="md-ellipsis">
Parameter CamWpc
</span>
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="#parameter-camzoom">1.1.27
<span class="md-ellipsis">
Parameter CamZoom
</span>
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="#parameter-camzoomoffsetx">1.1.28
<span class="md-ellipsis">
Parameter CamZoomOffsetX
</span>
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="#parameter-camzoomoffsety">1.1.29
<span class="md-ellipsis">
Parameter CamZoomOffsetY
</span>
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="#parameter-camzoomsize">1.1.30
<span class="md-ellipsis">
Parameter CamZoomSize
</span>
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="#parameter-demo">1.1.31
<span class="md-ellipsis">
Parameter Demo
</span>
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="#parameter-ledintensity">1.1.32
<span class="md-ellipsis">
Parameter LEDIntensity
</span>
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="#parameter-rawimageslocation">1.1.33
<span class="md-ellipsis">
Parameter RawImagesLocation
</span>
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="#parameter-rawimagesretention">1.1.34
<span class="md-ellipsis">
Parameter RawImagesRetention
</span>
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="#parameter-waitbeforetakingpicture">1.1.35
<span class="md-ellipsis">
Parameter WaitBeforeTakingPicture
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="#section-alignment">1.2
<span class="md-ellipsis">
Section Alignment
</span>
</a>
<nav aria-label="Section Alignment" class="md-nav">
<ul class="md-nav__list">
<li class="md-nav__item">
<a class="md-nav__link" href="#parameter-alignmentalgo">1.2.1
<span class="md-ellipsis">
Parameter AlignmentAlgo
</span>
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="#parameter-initialrotate">1.2.2
<span class="md-ellipsis">
Parameter InitialRotate
</span>
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="#parameter-searchfieldx">1.2.3
<span class="md-ellipsis">
Parameter SearchFieldX
</span>
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="#parameter-searchfieldy">1.2.4
<span class="md-ellipsis">
Parameter SearchFieldY
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="#section-digits">1.3
<span class="md-ellipsis">
Section Digits
</span>
</a>
<nav aria-label="Section Digits" class="md-nav">
<ul class="md-nav__list">
<li class="md-nav__item">
<a class="md-nav__link" href="#parameter-cnngoodthreshold">1.3.1
<span class="md-ellipsis">
Parameter CNNGoodThreshold
</span>
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="#parameter-model">1.3.2
<span class="md-ellipsis">
Parameter Model
</span>
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="#parameter-roiimageslocation">1.3.3
<span class="md-ellipsis">
Parameter ROIImagesLocation
</span>
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="#parameter-roiimagesretention">1.3.4
<span class="md-ellipsis">
Parameter ROIImagesRetention
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="#section-analog">1.4
<span class="md-ellipsis">
Section Analog
</span>
</a>
<nav aria-label="Section Analog" class="md-nav">
<ul class="md-nav__list">
<li class="md-nav__item">
<a class="md-nav__link" href="#parameter-cnngoodthreshold_1">1.4.1
<span class="md-ellipsis">
Parameter CNNGoodThreshold
</span>
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="#parameter-extendedresolution">1.4.2
<span class="md-ellipsis">
Parameter ExtendedResolution
</span>
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="#parameter-model_1">1.4.3
<span class="md-ellipsis">
Parameter Model
</span>
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="#parameter-roiimageslocation_1">1.4.4
<span class="md-ellipsis">
Parameter ROIImagesLocation
</span>
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="#parameter-roiimagesretention_1">1.4.5
<span class="md-ellipsis">
Parameter ROIImagesRetention
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="#section-postprocessing">1.5
<span class="md-ellipsis">
Section PostProcessing
</span>
</a>
<nav aria-label="Section PostProcessing" class="md-nav">
<ul class="md-nav__list">
<li class="md-nav__item">
<a class="md-nav__link" href="#parameter-allownegativerates">1.5.1
<span class="md-ellipsis">
Parameter AllowNegativeRates
</span>
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="#parameter-checkdigitincreaseconsistency">1.5.2
<span class="md-ellipsis">
Parameter CheckDigitIncreaseConsistency
</span>
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="#parameter-errormessage">1.5.3
<span class="md-ellipsis">
Parameter ErrorMessage
</span>
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="#parameter-numbersallownegativerates">1.5.4
<span class="md-ellipsis">
Parameter &lt;NUMBERS&gt;.AllowNegativeRates
</span>
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="#parameter-numberanalogdigitaltransitionstart">1.5.5
<span class="md-ellipsis">
Parameter &lt;NUMBER&gt;.AnalogDigitalTransitionStart
</span>
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="#parameter-numberchangeratethreshold">1.5.6
<span class="md-ellipsis">
Parameter &lt;NUMBER&gt;.ChangeRateThreshold
</span>
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="#parameter-numberdecimalshift">1.5.7
<span class="md-ellipsis">
Parameter &lt;NUMBER&gt;.DecimalShift
</span>
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="#parameter-numberextendedresolution">1.5.8
<span class="md-ellipsis">
Parameter &lt;NUMBER&gt;.ExtendedResolution
</span>
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="#parameter-numberignoreleadingnan">1.5.9
<span class="md-ellipsis">
Parameter &lt;NUMBER&gt;.IgnoreLeadingNaN
</span>
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="#parameter-numbermaxratetype">1.5.10
<span class="md-ellipsis">
Parameter &lt;NUMBER&gt;.MaxRateType
</span>
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="#parameter-numbermaxratevalue">1.5.11
<span class="md-ellipsis">
Parameter &lt;NUMBER&gt;.MaxRateValue
</span>
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="#parameter-prevalueagestartup">1.5.12
<span class="md-ellipsis">
Parameter PreValueAgeStartup
</span>
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="#parameter-prevalueuse">1.5.13
<span class="md-ellipsis">
Parameter PreValueUse
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="#section-mqtt">1.6
<span class="md-ellipsis">
Section MQTT
</span>
</a>
<nav aria-label="Section MQTT" class="md-nav">
<ul class="md-nav__list">
<li class="md-nav__item">
<a class="md-nav__link" href="#parameter-cacert">1.6.1
<span class="md-ellipsis">
Parameter CACert
</span>
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="#parameter-clientcert">1.6.2
<span class="md-ellipsis">
Parameter ClientCert
</span>
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="#parameter-clientid">1.6.3
<span class="md-ellipsis">
Parameter ClientID
</span>
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="#parameter-clientkey">1.6.4
<span class="md-ellipsis">
Parameter ClientKey
</span>
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="#parameter-homeassistantdiscovery">1.6.5
<span class="md-ellipsis">
Parameter HomeassistantDiscovery
</span>
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="#parameter-maintopic">1.6.6
<span class="md-ellipsis">
Parameter MainTopic
</span>
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="#parameter-metertype">1.6.7
<span class="md-ellipsis">
Parameter MeterType
</span>
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="#parameter-retainmessages">1.6.8
<span class="md-ellipsis">
Parameter RetainMessages
</span>
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="#parameter-uri">1.6.9
<span class="md-ellipsis">
Parameter Uri
</span>
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="#parameter-password">1.6.10
<span class="md-ellipsis">
Parameter password
</span>
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="#parameter-user">1.6.11
<span class="md-ellipsis">
Parameter user
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="#section-influxdb">1.7
<span class="md-ellipsis">
Section InfluxDB
</span>
</a>
<nav aria-label="Section InfluxDB" class="md-nav">
<ul class="md-nav__list">
<li class="md-nav__item">
<a class="md-nav__link" href="#parameter-database">1.7.1
<span class="md-ellipsis">
Parameter Database
</span>
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="#parameter-numberfield">1.7.2
<span class="md-ellipsis">
Parameter &lt;NUMBER&gt;.Field
</span>
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="#parameter-measurement">1.7.3
<span class="md-ellipsis">
Parameter Measurement
</span>
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="#parameter-uri_1">1.7.4
<span class="md-ellipsis">
Parameter Uri
</span>
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="#parameter-password_1">1.7.5
<span class="md-ellipsis">
Parameter password
</span>
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="#parameter-user_1">1.7.6
<span class="md-ellipsis">
Parameter user
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="#section-influxdbv2">1.8
<span class="md-ellipsis">
Section InfluxDBv2
</span>
</a>
<nav aria-label="Section InfluxDBv2" class="md-nav">
<ul class="md-nav__list">
<li class="md-nav__item">
<a class="md-nav__link" href="#parameter-bucket">1.8.1
<span class="md-ellipsis">
Parameter Bucket
</span>
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="#parameter-database_1">1.8.2
<span class="md-ellipsis">
Parameter Database
</span>
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="#parameter-numberfield_1">1.8.3
<span class="md-ellipsis">
Parameter &lt;NUMBER&gt;.Field
</span>
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="#parameter-measurement_1">1.8.4
<span class="md-ellipsis">
Parameter Measurement
</span>
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="#parameter-org">1.8.5
<span class="md-ellipsis">
Parameter Org
</span>
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="#parameter-token">1.8.6
<span class="md-ellipsis">
Parameter Token
</span>
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="#parameter-uri_2">1.8.7
<span class="md-ellipsis">
Parameter Uri
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="#section-gpio">1.9
<span class="md-ellipsis">
Section GPIO
</span>
</a>
<nav aria-label="Section GPIO" class="md-nav">
<ul class="md-nav__list">
<li class="md-nav__item">
<a class="md-nav__link" href="#parameter-io0">1.9.1
<span class="md-ellipsis">
Parameter IO0
</span>
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="#parameter-io1">1.9.2
<span class="md-ellipsis">
Parameter IO1
</span>
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="#parameter-io12">1.9.3
<span class="md-ellipsis">
Parameter IO12
</span>
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="#parameter-io13">1.9.4
<span class="md-ellipsis">
Parameter IO13
</span>
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="#parameter-io3">1.9.5
<span class="md-ellipsis">
Parameter IO3
</span>
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="#parameter-io4">1.9.6
<span class="md-ellipsis">
Parameter IO4
</span>
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="#parameter-ledcolor">1.9.7
<span class="md-ellipsis">
Parameter LEDColor
</span>
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="#parameter-lednumbers">1.9.8
<span class="md-ellipsis">
Parameter LEDNumbers
</span>
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="#parameter-ledtype">1.9.9
<span class="md-ellipsis">
Parameter LEDType
</span>
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="#parameter-maintopicmqtt">1.9.10
<span class="md-ellipsis">
Parameter MainTopicMQTT
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="#section-autotimer">1.10
<span class="md-ellipsis">
Section AutoTimer
</span>
</a>
<nav aria-label="Section AutoTimer" class="md-nav">
<ul class="md-nav__list">
<li class="md-nav__item">
<a class="md-nav__link" href="#parameter-autostart">1.10.1
<span class="md-ellipsis">
Parameter AutoStart
</span>
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="#parameter-interval">1.10.2
<span class="md-ellipsis">
Parameter Interval
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="#section-datalogging">1.11
<span class="md-ellipsis">
Section DataLogging
</span>
</a>
<nav aria-label="Section DataLogging" class="md-nav">
<ul class="md-nav__list">
<li class="md-nav__item">
<a class="md-nav__link" href="#parameter-datafilesretention">1.11.1
<span class="md-ellipsis">
Parameter DataFilesRetention
</span>
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="#parameter-datalogactive">1.11.2
<span class="md-ellipsis">
Parameter DataLogActive
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="#section-debug">1.12
<span class="md-ellipsis">
Section Debug
</span>
</a>
<nav aria-label="Section Debug" class="md-nav">
<ul class="md-nav__list">
<li class="md-nav__item">
<a class="md-nav__link" href="#parameter-loglevel">1.12.1
<span class="md-ellipsis">
Parameter LogLevel
</span>
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="#parameter-logfilesretention">1.12.2
<span class="md-ellipsis">
Parameter LogfilesRetention
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="#section-system">1.13
<span class="md-ellipsis">
Section System
</span>
</a>
<nav aria-label="Section System" class="md-nav">
<ul class="md-nav__list">
<li class="md-nav__item">
<a class="md-nav__link" href="#parameter-cpufrequency">1.13.1
<span class="md-ellipsis">
Parameter CPUFrequency
</span>
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="#parameter-hostname">1.13.2
<span class="md-ellipsis">
Parameter Hostname
</span>
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="#parameter-rssithreshold">1.13.3
<span class="md-ellipsis">
Parameter RSSIThreshold
</span>
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="#parameter-setupmode">1.13.4
<span class="md-ellipsis">
Parameter SetupMode
</span>
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="#parameter-timeserver">1.13.5
<span class="md-ellipsis">
Parameter TimeServer
</span>
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="#parameter-timezone">1.13.6
<span class="md-ellipsis">
Parameter TimeZone
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="#section-webhook">1.14
<span class="md-ellipsis">
Section Webhook
</span>
</a>
<nav aria-label="Section Webhook" class="md-nav">
<ul class="md-nav__list">
<li class="md-nav__item">
<a class="md-nav__link" href="#parameter-apikey">1.14.1
<span class="md-ellipsis">
Parameter ApiKey
</span>
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="#parameter-uri_3">1.14.2
<span class="md-ellipsis">
Parameter Uri
</span>
</a>
</li>
</ul>
</nav>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="../Integration-Home-Assistant/">
<span class="md-ellipsis">
Integration into Home Assistant
</span>
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="../External-LED/">
<span class="md-ellipsis">
External LED
</span>
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="../data-logging/">
<span class="md-ellipsis">
Data Logging
</span>
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="../rolling-installation/">
<span class="md-ellipsis">
Living on the Edge
</span>
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="../Watermeter-specific-analog---digital-transition/">
<span class="md-ellipsis">
Analog/Digital Transition on Water Meters
</span>
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="../collect-new-images/">
<span class="md-ellipsis">
Collect images to improve the models
</span>
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="../Learn-models-with-your-own-images/">
<span class="md-ellipsis">
Learn a model with your own images
</span>
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="../Correction%20Algorithm/">
<span class="md-ellipsis">
Correction Algorithm
</span>
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="../Neural-Network-Types/">
<span class="md-ellipsis">
Neural Network Types
</span>
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="../Additional-Information/">
<span class="md-ellipsis">
Additional Information
</span>
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="../New-Releases-Notification/">
<span class="md-ellipsis">
Notification about new Releases
</span>
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="../prometheus-openmetrics/">
<span class="md-ellipsis">
Prometheus/OpenMetrics
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle" id="__nav_4" type="checkbox"/>
<label class="md-nav__link" for="__nav_4" id="__nav_4_label" tabindex="0">
<span class="md-ellipsis">
Troubleshooting
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<nav aria-expanded="false" aria-labelledby="__nav_4_label" class="md-nav" data-md-level="1">
<label class="md-nav__title" for="__nav_4">
<span class="md-nav__icon md-icon"></span>
Troubleshooting
</label>
<ul class="md-nav__list" data-md-scrollfix="">
<li class="md-nav__item">
<a class="md-nav__link" href="../Error-Codes/">
<span class="md-ellipsis">
Reduced webinterface (error codes)
</span>
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="../StatusLED-BlinkCodes/">
<span class="md-ellipsis">
Board status LED (blink codes)
</span>
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="../WLAN-disconnect-reason/">
<span class="md-ellipsis">
WLAN disconnect reasons
</span>
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="../Error-Debugging/">
<span class="md-ellipsis">
Often observed issues
</span>
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="../Frequent-Reboots/">
<span class="md-ellipsis">
Basic hardware/config issues
</span>
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="../Demo-Mode/">
<span class="md-ellipsis">
Demo mode
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle" id="__nav_5" type="checkbox"/>
<label class="md-nav__link" for="__nav_5" id="__nav_5_label" tabindex="0">
<span class="md-ellipsis">
Quick Links
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<nav aria-expanded="false" aria-labelledby="__nav_5_label" class="md-nav" data-md-level="1">
<label class="md-nav__title" for="__nav_5">
<span class="md-nav__icon md-icon"></span>
Quick Links
</label>
<ul class="md-nav__list" data-md-scrollfix="">
<li class="md-nav__item">
<a class="md-nav__link" href="https://github.com/jomjol/AI-on-the-edge-device/releases">
<span class="md-ellipsis">
Releases
</span>
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="https://jomjol.github.io/AI-on-the-edge-device/index.html">
<span class="md-ellipsis">
Web Installer/Console
</span>
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="https://github.com/jomjol/AI-on-the-edge-device/issues">
<span class="md-ellipsis">
Create an Issue
</span>
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="https://github.com/jomjol/AI-on-the-edge-device/discussions">
<span class="md-ellipsis">
Join a Discussion
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle" id="__nav_6" type="checkbox"/>
<label class="md-nav__link" for="__nav_6" id="__nav_6_label" tabindex="0">
<span class="md-ellipsis">
API's
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<nav aria-expanded="false" aria-labelledby="__nav_6_label" class="md-nav" data-md-level="1">
<label class="md-nav__title" for="__nav_6">
<span class="md-nav__icon md-icon"></span>
API's
</label>
<ul class="md-nav__list" data-md-scrollfix="">
<li class="md-nav__item">
<a class="md-nav__link" href="../REST-API/">
<span class="md-ellipsis">
REST API
</span>
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="../MQTT-API/">
<span class="md-ellipsis">
MQTT API
</span>
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="../Influx-DB/">
<span class="md-ellipsis">
Influx DB
</span>
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="../Webhook/">
<span class="md-ellipsis">
Webhook
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle" id="__nav_7" type="checkbox"/>
<label class="md-nav__link" for="__nav_7" id="__nav_7_label" tabindex="0">
<span class="md-ellipsis">
Development
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<nav aria-expanded="false" aria-labelledby="__nav_7_label" class="md-nav" data-md-level="1">
<label class="md-nav__title" for="__nav_7">
<span class="md-nav__icon md-icon"></span>
Development
</label>
<ul class="md-nav__list" data-md-scrollfix="">
<li class="md-nav__item">
<a class="md-nav__link" href="../Build-Instructions/">
<span class="md-ellipsis">
Build the Project
</span>
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="../Upload-files-by-script/">
<span class="md-ellipsis">
Scripted File Upload
</span>
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="../Testing/">
<span class="md-ellipsis">
Testing Option for VSCode
</span>
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="../Release-creation/">
<span class="md-ellipsis">
Preparing for Release
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle" id="__nav_8" type="checkbox"/>
<label class="md-nav__link" for="__nav_8" id="__nav_8_label" tabindex="0">
<span class="md-ellipsis">
Old Pages (no longer maintained)
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<nav aria-expanded="false" aria-labelledby="__nav_8_label" class="md-nav" data-md-level="1">
<label class="md-nav__title" for="__nav_8">
<span class="md-nav__icon md-icon"></span>
Old Pages (no longer maintained)
</label>
<ul class="md-nav__list" data-md-scrollfix="">
<li class="md-nav__item">
<a class="md-nav__link" href="../outdated--Integrated-Functions/">
<span class="md-ellipsis">
Integrated Functions
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="..">
<span class="md-ellipsis">
Assorted Pages
</span>
</a>
</li>
</ul>
</nav>
</div>
</div>
</div>
<div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc">
<div class="md-sidebar__scrollwrap">
<div class="md-sidebar__inner">
<nav aria-label="Table of contents" class="md-nav md-nav--secondary">
<label class="md-nav__title" for="__toc">
<span class="md-nav__icon md-icon"></span>
Table of contents
</label>
<ul class="md-nav__list" data-md-component="toc" data-md-scrollfix="">
<li class="md-nav__item">
<a class="md-nav__link" href="#section-takeimage">1.1
<span class="md-ellipsis">
Section TakeImage
</span>
</a>
<nav aria-label="Section TakeImage" class="md-nav">
<ul class="md-nav__list">
<li class="md-nav__item">
<a class="md-nav__link" href="#parameter-camaelevel">1.1.1
<span class="md-ellipsis">
Parameter CamAeLevel
</span>
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="#parameter-camaec">1.1.2
<span class="md-ellipsis">
Parameter CamAec
</span>
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="#parameter-camaec2">1.1.3
<span class="md-ellipsis">
Parameter CamAec2
</span>
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="#parameter-camaecvalue">1.1.4
<span class="md-ellipsis">
Parameter CamAecValue
</span>
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="#parameter-camagc">1.1.5
<span class="md-ellipsis">
Parameter CamAgc
</span>
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="#parameter-camagcgain">1.1.6
<span class="md-ellipsis">
Parameter CamAgcGain
</span>
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="#parameter-camautosharpness">1.1.7
<span class="md-ellipsis">
Parameter CamAutoSharpness
</span>
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="#parameter-camawb">1.1.8
<span class="md-ellipsis">
Parameter CamAwb
</span>
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="#parameter-camawbgain">1.1.9
<span class="md-ellipsis">
Parameter CamAwbGain
</span>
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="#parameter-cambpc">1.1.10
<span class="md-ellipsis">
Parameter CamBpc
</span>
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="#parameter-cambrightness">1.1.11
<span class="md-ellipsis">
Parameter CamBrightness
</span>
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="#parameter-camcolorbar">1.1.12
<span class="md-ellipsis">
Parameter CamColorbar
</span>
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="#parameter-camcontrast">1.1.13
<span class="md-ellipsis">
Parameter CamContrast
</span>
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="#parameter-camdcw">1.1.14
<span class="md-ellipsis">
Parameter CamDcw
</span>
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="#parameter-camdenoise">1.1.15
<span class="md-ellipsis">
Parameter CamDenoise
</span>
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="#parameter-camgainceiling">1.1.16
<span class="md-ellipsis">
Parameter CamGainceiling
</span>
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="#parameter-camhmirror">1.1.17
<span class="md-ellipsis">
Parameter CamHmirror
</span>
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="#parameter-camlenc">1.1.18
<span class="md-ellipsis">
Parameter CamLenc
</span>
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="#parameter-camquality">1.1.19
<span class="md-ellipsis">
Parameter CamQuality
</span>
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="#parameter-camrawgma">1.1.20
<span class="md-ellipsis">
Parameter CamRawGma
</span>
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="#parameter-camsaturation">1.1.21
<span class="md-ellipsis">
Parameter CamSaturation
</span>
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="#parameter-camsharpness">1.1.22
<span class="md-ellipsis">
Parameter CamSharpness
</span>
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="#parameter-camspecialeffect">1.1.23
<span class="md-ellipsis">
Parameter CamSpecialEffect
</span>
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="#parameter-camvflip">1.1.24
<span class="md-ellipsis">
Parameter CamVflip
</span>
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="#parameter-camwbmode">1.1.25
<span class="md-ellipsis">
Parameter CamWbMode
</span>
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="#parameter-camwpc">1.1.26
<span class="md-ellipsis">
Parameter CamWpc
</span>
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="#parameter-camzoom">1.1.27
<span class="md-ellipsis">
Parameter CamZoom
</span>
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="#parameter-camzoomoffsetx">1.1.28
<span class="md-ellipsis">
Parameter CamZoomOffsetX
</span>
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="#parameter-camzoomoffsety">1.1.29
<span class="md-ellipsis">
Parameter CamZoomOffsetY
</span>
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="#parameter-camzoomsize">1.1.30
<span class="md-ellipsis">
Parameter CamZoomSize
</span>
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="#parameter-demo">1.1.31
<span class="md-ellipsis">
Parameter Demo
</span>
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="#parameter-ledintensity">1.1.32
<span class="md-ellipsis">
Parameter LEDIntensity
</span>
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="#parameter-rawimageslocation">1.1.33
<span class="md-ellipsis">
Parameter RawImagesLocation
</span>
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="#parameter-rawimagesretention">1.1.34
<span class="md-ellipsis">
Parameter RawImagesRetention
</span>
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="#parameter-waitbeforetakingpicture">1.1.35
<span class="md-ellipsis">
Parameter WaitBeforeTakingPicture
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="#section-alignment">1.2
<span class="md-ellipsis">
Section Alignment
</span>
</a>
<nav aria-label="Section Alignment" class="md-nav">
<ul class="md-nav__list">
<li class="md-nav__item">
<a class="md-nav__link" href="#parameter-alignmentalgo">1.2.1
<span class="md-ellipsis">
Parameter AlignmentAlgo
</span>
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="#parameter-initialrotate">1.2.2
<span class="md-ellipsis">
Parameter InitialRotate
</span>
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="#parameter-searchfieldx">1.2.3
<span class="md-ellipsis">
Parameter SearchFieldX
</span>
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="#parameter-searchfieldy">1.2.4
<span class="md-ellipsis">
Parameter SearchFieldY
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="#section-digits">1.3
<span class="md-ellipsis">
Section Digits
</span>
</a>
<nav aria-label="Section Digits" class="md-nav">
<ul class="md-nav__list">
<li class="md-nav__item">
<a class="md-nav__link" href="#parameter-cnngoodthreshold">1.3.1
<span class="md-ellipsis">
Parameter CNNGoodThreshold
</span>
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="#parameter-model">1.3.2
<span class="md-ellipsis">
Parameter Model
</span>
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="#parameter-roiimageslocation">1.3.3
<span class="md-ellipsis">
Parameter ROIImagesLocation
</span>
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="#parameter-roiimagesretention">1.3.4
<span class="md-ellipsis">
Parameter ROIImagesRetention
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="#section-analog">1.4
<span class="md-ellipsis">
Section Analog
</span>
</a>
<nav aria-label="Section Analog" class="md-nav">
<ul class="md-nav__list">
<li class="md-nav__item">
<a class="md-nav__link" href="#parameter-cnngoodthreshold_1">1.4.1
<span class="md-ellipsis">
Parameter CNNGoodThreshold
</span>
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="#parameter-extendedresolution">1.4.2
<span class="md-ellipsis">
Parameter ExtendedResolution
</span>
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="#parameter-model_1">1.4.3
<span class="md-ellipsis">
Parameter Model
</span>
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="#parameter-roiimageslocation_1">1.4.4
<span class="md-ellipsis">
Parameter ROIImagesLocation
</span>
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="#parameter-roiimagesretention_1">1.4.5
<span class="md-ellipsis">
Parameter ROIImagesRetention
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="#section-postprocessing">1.5
<span class="md-ellipsis">
Section PostProcessing
</span>
</a>
<nav aria-label="Section PostProcessing" class="md-nav">
<ul class="md-nav__list">
<li class="md-nav__item">
<a class="md-nav__link" href="#parameter-allownegativerates">1.5.1
<span class="md-ellipsis">
Parameter AllowNegativeRates
</span>
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="#parameter-checkdigitincreaseconsistency">1.5.2
<span class="md-ellipsis">
Parameter CheckDigitIncreaseConsistency
</span>
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="#parameter-errormessage">1.5.3
<span class="md-ellipsis">
Parameter ErrorMessage
</span>
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="#parameter-numbersallownegativerates">1.5.4
<span class="md-ellipsis">
Parameter &lt;NUMBERS&gt;.AllowNegativeRates
</span>
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="#parameter-numberanalogdigitaltransitionstart">1.5.5
<span class="md-ellipsis">
Parameter &lt;NUMBER&gt;.AnalogDigitalTransitionStart
</span>
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="#parameter-numberchangeratethreshold">1.5.6
<span class="md-ellipsis">
Parameter &lt;NUMBER&gt;.ChangeRateThreshold
</span>
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="#parameter-numberdecimalshift">1.5.7
<span class="md-ellipsis">
Parameter &lt;NUMBER&gt;.DecimalShift
</span>
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="#parameter-numberextendedresolution">1.5.8
<span class="md-ellipsis">
Parameter &lt;NUMBER&gt;.ExtendedResolution
</span>
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="#parameter-numberignoreleadingnan">1.5.9
<span class="md-ellipsis">
Parameter &lt;NUMBER&gt;.IgnoreLeadingNaN
</span>
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="#parameter-numbermaxratetype">1.5.10
<span class="md-ellipsis">
Parameter &lt;NUMBER&gt;.MaxRateType
</span>
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="#parameter-numbermaxratevalue">1.5.11
<span class="md-ellipsis">
Parameter &lt;NUMBER&gt;.MaxRateValue
</span>
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="#parameter-prevalueagestartup">1.5.12
<span class="md-ellipsis">
Parameter PreValueAgeStartup
</span>
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="#parameter-prevalueuse">1.5.13
<span class="md-ellipsis">
Parameter PreValueUse
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="#section-mqtt">1.6
<span class="md-ellipsis">
Section MQTT
</span>
</a>
<nav aria-label="Section MQTT" class="md-nav">
<ul class="md-nav__list">
<li class="md-nav__item">
<a class="md-nav__link" href="#parameter-cacert">1.6.1
<span class="md-ellipsis">
Parameter CACert
</span>
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="#parameter-clientcert">1.6.2
<span class="md-ellipsis">
Parameter ClientCert
</span>
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="#parameter-clientid">1.6.3
<span class="md-ellipsis">
Parameter ClientID
</span>
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="#parameter-clientkey">1.6.4
<span class="md-ellipsis">
Parameter ClientKey
</span>
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="#parameter-homeassistantdiscovery">1.6.5
<span class="md-ellipsis">
Parameter HomeassistantDiscovery
</span>
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="#parameter-maintopic">1.6.6
<span class="md-ellipsis">
Parameter MainTopic
</span>
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="#parameter-metertype">1.6.7
<span class="md-ellipsis">
Parameter MeterType
</span>
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="#parameter-retainmessages">1.6.8
<span class="md-ellipsis">
Parameter RetainMessages
</span>
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="#parameter-uri">1.6.9
<span class="md-ellipsis">
Parameter Uri
</span>
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="#parameter-password">1.6.10
<span class="md-ellipsis">
Parameter password
</span>
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="#parameter-user">1.6.11
<span class="md-ellipsis">
Parameter user
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="#section-influxdb">1.7
<span class="md-ellipsis">
Section InfluxDB
</span>
</a>
<nav aria-label="Section InfluxDB" class="md-nav">
<ul class="md-nav__list">
<li class="md-nav__item">
<a class="md-nav__link" href="#parameter-database">1.7.1
<span class="md-ellipsis">
Parameter Database
</span>
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="#parameter-numberfield">1.7.2
<span class="md-ellipsis">
Parameter &lt;NUMBER&gt;.Field
</span>
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="#parameter-measurement">1.7.3
<span class="md-ellipsis">
Parameter Measurement
</span>
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="#parameter-uri_1">1.7.4
<span class="md-ellipsis">
Parameter Uri
</span>
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="#parameter-password_1">1.7.5
<span class="md-ellipsis">
Parameter password
</span>
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="#parameter-user_1">1.7.6
<span class="md-ellipsis">
Parameter user
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="#section-influxdbv2">1.8
<span class="md-ellipsis">
Section InfluxDBv2
</span>
</a>
<nav aria-label="Section InfluxDBv2" class="md-nav">
<ul class="md-nav__list">
<li class="md-nav__item">
<a class="md-nav__link" href="#parameter-bucket">1.8.1
<span class="md-ellipsis">
Parameter Bucket
</span>
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="#parameter-database_1">1.8.2
<span class="md-ellipsis">
Parameter Database
</span>
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="#parameter-numberfield_1">1.8.3
<span class="md-ellipsis">
Parameter &lt;NUMBER&gt;.Field
</span>
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="#parameter-measurement_1">1.8.4
<span class="md-ellipsis">
Parameter Measurement
</span>
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="#parameter-org">1.8.5
<span class="md-ellipsis">
Parameter Org
</span>
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="#parameter-token">1.8.6
<span class="md-ellipsis">
Parameter Token
</span>
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="#parameter-uri_2">1.8.7
<span class="md-ellipsis">
Parameter Uri
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="#section-gpio">1.9
<span class="md-ellipsis">
Section GPIO
</span>
</a>
<nav aria-label="Section GPIO" class="md-nav">
<ul class="md-nav__list">
<li class="md-nav__item">
<a class="md-nav__link" href="#parameter-io0">1.9.1
<span class="md-ellipsis">
Parameter IO0
</span>
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="#parameter-io1">1.9.2
<span class="md-ellipsis">
Parameter IO1
</span>
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="#parameter-io12">1.9.3
<span class="md-ellipsis">
Parameter IO12
</span>
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="#parameter-io13">1.9.4
<span class="md-ellipsis">
Parameter IO13
</span>
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="#parameter-io3">1.9.5
<span class="md-ellipsis">
Parameter IO3
</span>
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="#parameter-io4">1.9.6
<span class="md-ellipsis">
Parameter IO4
</span>
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="#parameter-ledcolor">1.9.7
<span class="md-ellipsis">
Parameter LEDColor
</span>
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="#parameter-lednumbers">1.9.8
<span class="md-ellipsis">
Parameter LEDNumbers
</span>
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="#parameter-ledtype">1.9.9
<span class="md-ellipsis">
Parameter LEDType
</span>
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="#parameter-maintopicmqtt">1.9.10
<span class="md-ellipsis">
Parameter MainTopicMQTT
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="#section-autotimer">1.10
<span class="md-ellipsis">
Section AutoTimer
</span>
</a>
<nav aria-label="Section AutoTimer" class="md-nav">
<ul class="md-nav__list">
<li class="md-nav__item">
<a class="md-nav__link" href="#parameter-autostart">1.10.1
<span class="md-ellipsis">
Parameter AutoStart
</span>
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="#parameter-interval">1.10.2
<span class="md-ellipsis">
Parameter Interval
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="#section-datalogging">1.11
<span class="md-ellipsis">
Section DataLogging
</span>
</a>
<nav aria-label="Section DataLogging" class="md-nav">
<ul class="md-nav__list">
<li class="md-nav__item">
<a class="md-nav__link" href="#parameter-datafilesretention">1.11.1
<span class="md-ellipsis">
Parameter DataFilesRetention
</span>
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="#parameter-datalogactive">1.11.2
<span class="md-ellipsis">
Parameter DataLogActive
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="#section-debug">1.12
<span class="md-ellipsis">
Section Debug
</span>
</a>
<nav aria-label="Section Debug" class="md-nav">
<ul class="md-nav__list">
<li class="md-nav__item">
<a class="md-nav__link" href="#parameter-loglevel">1.12.1
<span class="md-ellipsis">
Parameter LogLevel
</span>
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="#parameter-logfilesretention">1.12.2
<span class="md-ellipsis">
Parameter LogfilesRetention
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="#section-system">1.13
<span class="md-ellipsis">
Section System
</span>
</a>
<nav aria-label="Section System" class="md-nav">
<ul class="md-nav__list">
<li class="md-nav__item">
<a class="md-nav__link" href="#parameter-cpufrequency">1.13.1
<span class="md-ellipsis">
Parameter CPUFrequency
</span>
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="#parameter-hostname">1.13.2
<span class="md-ellipsis">
Parameter Hostname
</span>
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="#parameter-rssithreshold">1.13.3
<span class="md-ellipsis">
Parameter RSSIThreshold
</span>
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="#parameter-setupmode">1.13.4
<span class="md-ellipsis">
Parameter SetupMode
</span>
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="#parameter-timeserver">1.13.5
<span class="md-ellipsis">
Parameter TimeServer
</span>
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="#parameter-timezone">1.13.6
<span class="md-ellipsis">
Parameter TimeZone
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="#section-webhook">1.14
<span class="md-ellipsis">
Section Webhook
</span>
</a>
<nav aria-label="Section Webhook" class="md-nav">
<ul class="md-nav__list">
<li class="md-nav__item">
<a class="md-nav__link" href="#parameter-apikey">1.14.1
<span class="md-ellipsis">
Parameter ApiKey
</span>
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="#parameter-uri_3">1.14.2
<span class="md-ellipsis">
Parameter Uri
</span>
</a>
</li>
</ul>
</nav>
</li>
</ul>
</nav>
</div>
</div>
</div>
<div class="md-content" data-md-component="content">
<article class="md-content__inner md-typeset">
<h1 id="parameters"><span class="enumerate-headings-plugin enumerate-heading-plugin">1.</span> Parameters</h1>
<p>This page lists all available <a href="../Configuration/">Configuration</a> Parameters.
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>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>This is an auto-generated page! See the <a href="https://github.com/jomjol/AI-on-the-edge-device-docs/blob/main/README.md">README</a> for details!</p>
</div>
<hr style="border:2px solid"/>
<h2 id="section-takeimage"><span class="enumerate-headings-plugin enumerate-heading-plugin">1.1</span> Section <code>TakeImage</code></h2>
<p><a id="TakeImage-CamAeLevel"></a></p>
<h3 id="parameter-camaelevel"><span class="enumerate-headings-plugin enumerate-heading-plugin">1.1.1</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>
<p>This is an <strong>Expert Parameter</strong>! Only change it if you understand what it does!</p>
<p>After changing this parameter you need to update your reference image and alignment markers!</p>
</div>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>This parameter can also be set on the Reference Image configuration page!</p>
</div>
<p><strong>Auto Exposure Level</strong></p>
<p>The exposure offset for automatic exposure, lower values produce darker image.</p>
<p>available range on OV2640 (<code>-2</code> .. <code>2</code>)
available range on OV3660 and OV5640 (<code>-5</code> .. <code>5</code>)</p>
<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.2</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>
<p>This is an <strong>Expert Parameter</strong>! Only change it if you understand what it does!</p>
<p>After changing this parameter you need to update your reference image and alignment markers!</p>
</div>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>This parameter can also be set on the Reference Image configuration page!</p>
</div>
<p><strong>Auto-Exposure Control</strong></p>
<p>When <strong>true</strong>, the camera attempts to automatically control the exposure.</p>
<p>When <strong>false</strong>, the <strong>CamAecValue</strong> setting is used instead.</p>
<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.3</span> Parameter <code>CamAec2</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>
<p>This is an <strong>Expert Parameter</strong>! Only change it if you understand what it does!</p>
<p>After changing this parameter you need to update your reference image and alignment markers!</p>
</div>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>This parameter can also be set on the Reference Image configuration page!</p>
</div>
<p><strong>Auto-Exposure Control 2</strong></p>
<p>When <strong>true</strong>, the sensor’s "night mode" is enabled, extending the range of automatic gain control.</p>
<p>This may resolve some over-exposure and under-exposure issues.</p>
<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.4</span> Parameter <code>CamAecValue</code></h3>
<p>Section: <a href="#section-takeimage">1.1 TakeImage</a></p>
<p>Default Value: <code>160</code></p>
<div class="admonition warning">
<p class="admonition-title">Warning</p>
<p>This is an <strong>Expert Parameter</strong>! Only change it if you understand what it does!</p>
<p>After changing this parameter you need to update your reference image and alignment markers!</p>
</div>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>This parameter can also be set on the Reference Image configuration page!</p>
</div>
<p><strong>Auto Exposure Value</strong></p>
<p>Access the exposure value of the camera, higher values produce brighter images.</p>
<p>Range (<code>0</code> .. <code>1200</code>)</p>
<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.5</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>
<p>This is an <strong>Expert Parameter</strong>! Only change it if you understand what it does!</p>
<p>After changing this parameter you need to update your reference image and alignment markers!</p>
</div>
<p><strong>Auto Gain</strong></p>
<p>When <strong>true</strong>, the camera attempts to automatically control the sensor gain, up to the value in the <strong>CamGainceiling</strong> property.</p>
<p>When <strong>false</strong>, the <strong>CamAgcGain</strong> setting is used instead.</p>
<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.6</span> Parameter <code>CamAgcGain</code></h3>
<p>Section: <a href="#section-takeimage">1.1 TakeImage</a></p>
<p>Default Value: <code>15</code></p>
<div class="admonition warning">
<p class="admonition-title">Warning</p>
<p>This is an <strong>Expert Parameter</strong>! Only change it if you understand what it does!</p>
<p>After changing this parameter you need to update your reference image and alignment markers!</p>
</div>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>This is used when <strong>CamAgc</strong> is off.</p>
</div>
<p><strong>Gain Manual Value</strong></p>
<p>Access the gain level of the sensor, higher values produce brighter images.</p>
<p>Range (<code>0</code> .. <code>30</code>)</p>
<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.7</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>
<p>This is an <strong>Expert Parameter</strong>! Only change it if you understand what it does!</p>
<p>After changing this parameter you need to update your reference image and alignment markers!</p>
</div>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>This parameter can also be set on the Reference Image configuration page!</p>
</div>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>The OV2640 does not officially support auto sharpness, this is an experimental parameter!</p>
</div>
<p><strong>AutoSharpness</strong></p>
<p>When <strong>true</strong>, the camera attempts to automatically adjusts the sharpness.</p>
<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.8</span> Parameter <code>CamAwb</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>
<p>This is an <strong>Expert Parameter</strong>! Only change it if you understand what it does!</p>
<p>After changing this parameter you need to update your reference image and alignment markers!</p>
</div>
<p><strong>Auto White Balance</strong></p>
<p>When <strong>true</strong>, the camera attempts to automatically control white balance.</p>
<p>When <strong>false</strong>, the <strong>CamWbMode</strong> setting is used instead.</p>
<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.9</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>
<p>This is an <strong>Expert Parameter</strong>! Only change it if you understand what it does!</p>
<p>After changing this parameter you need to update your reference image and alignment markers!</p>
</div>
<p><strong>Auto White Balance Gain</strong></p>
<p>Access the <strong>CamAwbGain</strong> property of the camera sensor.</p>
<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.10</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>
<p>This is an <strong>Expert Parameter</strong>! Only change it if you understand what it does!</p>
<p>After changing this parameter you need to update your reference image and alignment markers!</p>
</div>
<p><strong>Black Pixel Correction</strong></p>
<p>Enable/Disable <strong>black point compensation</strong>, this can make black parts of the image darker.</p>
<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.11</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 warning">
<p class="admonition-title">Warning</p>
<p>After changing this parameter you need to update your reference image and alignment markers!</p>
</div>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>This parameter can also be set on the Reference Image configuration page!</p>
</div>
<p><strong>Brightness</strong></p>
<p>Positive values increase brightness, negative values lower it.</p>
<p>Range (<code>-2</code> .. <code>2</code>) </p>
<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.12</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 warning">
<p class="admonition-title">Warning</p>
<p>This is an <strong>Expert Parameter</strong>! Only change it if you understand what it does!</p>
</div>
<p><strong>Colorbar</strong></p>
<p>currently not implemented.</p>
<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.13</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 warning">
<p class="admonition-title">Warning</p>
<p>After changing this parameter you need to update your reference image and alignment markers!</p>
</div>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>This parameter can also be set on the Reference Image configuration page!</p>
</div>
<p><strong>Contrast</strong></p>
<p>Positive values increase contrast, negative values lower it.</p>
<p>Range (<code>-2</code> .. <code>2</code>)</p>
<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.14</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>
<p>This is an <strong>Expert Parameter</strong>! Only change it if you understand what it does!</p>
<p>After changing this parameter you need to update your reference image and alignment markers!</p>
<p>If <strong>CamZoom</strong> is used, this must be activated.</p>
</div>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>When <strong>CamDcw</strong> is on, the image that you receive will be the size that you requested (VGA, QQVGA, etc).
When <strong>CamDcw</strong> is off, the image that you receive will be one of UXGA, SVGA, or CIF. In other words, literally the actual image size as read from the sensor without any scaling.
Note that if <strong>CamDcw</strong> is off, and you pick a different image size, this implicitly turns <strong>CamDcw</strong> back on again (although this isn't reflected in the options). </p>
</div>
<p><strong>Downsize</strong></p>
<p>Enable/Disable camera image scaling.</p>
<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.15</span> Parameter <code>CamDenoise</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>
<p>This is an <strong>Expert Parameter</strong>! Only change it if you understand what it does!</p>
</div>
<p><strong>Denoise</strong></p>
<p>Denoise Image, is only supported by OV3660 and OV5640</p>
<p>Range (<code>0</code> .. <code>8</code>)</p>
<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.16</span> Parameter <code>CamGainceiling</code></h3>
<p>Section: <a href="#section-takeimage">1.1 TakeImage</a></p>
<p>Default Value: <code>x4</code></p>
<div class="admonition warning">
<p class="admonition-title">Warning</p>
<p>This is an <strong>Expert Parameter</strong>! Only change it if you understand what it does!</p>
<p>After changing this parameter you need to update your reference image and alignment markers!</p>
</div>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>This is used when <strong>CamAgc</strong> is on.</p>
</div>
<p><strong>CamGainceiling</strong></p>
<p>The <strong>Gain</strong> is an analog multiplier applied to the raw sensor data.</p>
<p>The <strong>Ceiling</strong> is the maximum gain value that the sensor will use.</p>
<p>A higher gain means that the sensor has a greater response to light, but also makes sensor noise more visible.</p>
<p>Available options:</p>
<ul>
<li><code>x2</code></li>
<li><code>x4</code></li>
<li><code>x8</code></li>
<li><code>x16</code></li>
<li><code>x32</code></li>
<li><code>x64</code></li>
<li><code>x128</code></li>
</ul>
<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.17</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 warning">
<p class="admonition-title">Warning</p>
<p>After changing this parameter you need to update your reference image and alignment markers!</p>
</div>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>This parameter can also be set on the Reference Image configuration page!</p>
</div>
<p><strong>Mirror Image</strong></p>
<p>When <strong>true</strong>, the camera image is mirrored left-to-right.</p>
<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.18</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>
<p>This is an <strong>Expert Parameter</strong>! Only change it if you understand what it does!</p>
<p>After changing this parameter you need to update your reference image and alignment markers!</p>
</div>
<p><strong>Lens Correction</strong></p>
<p>Enable/Disable lens correction.</p>
<p>This can help compensate for light fall-off at the edge of the sensor area.</p>
<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.19</span> Parameter <code>CamQuality</code></h3>
<p>Section: <a href="#section-takeimage">1.1 TakeImage</a></p>
<p>Default Value: <code>10</code></p>
<div class="admonition warning">
<p class="admonition-title">Warning</p>
<p>This is an <strong>Expert Parameter</strong>! Only change it if you understand what it does!</p>
<p>After changing this parameter you need to update your reference image and alignment markers!</p>
</div>
<div class="admonition warning">
<p class="admonition-title">Warning</p>
<p>Value below 10 could result in system instabilities!</p>
</div>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>Quality index for pictures: <code>8</code> (highest quality) ... <code>63</code> (lowest quality)</p>
</div>
<p><strong>Image Quality</strong></p>
<p>The <strong>CamQuality</strong> setting when capturing JPEG images.</p>
<p>This is similar to the quality setting when exporting a jpeg image from photo editing software.</p>
<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.20</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>
<p>This is an <strong>Expert Parameter</strong>! Only change it if you understand what it does!</p>
<p>After changing this parameter you need to update your reference image and alignment markers!</p>
</div>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>The main purpose of the Gamma (GMA) function is to compensate for the non-linear characteristics of the sensor. GMA
converts the pixel values according to the Gamma curve to compensate the sensor output under different light strengths.
The non-linear gamma curve is approximately constructed with different linear functions. Raw gamma compensates the
image in the RAW domain.</p>
</div>
<p><strong>Raw Gamma</strong></p>
<p>Enable/Disable raw gamma mode.</p>
<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.21</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 warning">
<p class="admonition-title">Warning</p>
<p>After changing this parameter you need to update your reference image and alignment markers!</p>
</div>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>This parameter can also be set on the Reference Image configuration page!</p>
</div>
<p><strong>Saturation</strong></p>
<p>Positive values increase saturation (more vibrant colors), negative values lower it (more muted colors). </p>
<p>Range (<code>-2</code> .. <code>2</code>)</p>
<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.22</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>
<p>This is an <strong>Expert Parameter</strong>! Only change it if you understand what it does!</p>
<p>After changing this parameter you need to update your reference image and alignment markers!</p>
</div>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>This parameter can also be set on the Reference Image configuration page!</p>
</div>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>The OV2640 does not officially support sharpness, this is an experimental parameter!</p>
</div>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>This is used when <strong>CamAutoSharpness</strong> is off.</p>
</div>
<p><strong>Sharpness</strong></p>
<p>Positive values increase sharpness (more defined edges), negative values lower it (softer edges). </p>
<p>Range (<code>-2</code> .. <code>2</code>)</p>
<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.23</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>
<p>This is an <strong>Expert Parameter</strong>! Only change it if you understand what it does!</p>
<p>After changing this parameter you need to update your reference image and alignment markers!</p>
</div>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>This parameter can also be set on the Reference Image configuration page!</p>
</div>
<p><strong>SpecialEffect</strong></p>
<p>Available options:</p>
<ul>
<li><code>no_effect</code></li>
<li><code>negative</code></li>
<li><code>grayscale</code></li>
<li><code>red</code></li>
<li><code>green</code></li>
<li><code>blue</code></li>
<li><code>retro</code></li>
</ul>
<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.24</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 warning">
<p class="admonition-title">Warning</p>
<p>After changing this parameter you need to update your reference image and alignment markers!</p>
</div>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>This parameter can also be set on the Reference Image configuration page!</p>
</div>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>On some OV5640 Cameras, the image becomes reddish when Vflip is used in conjunction with the zoom function!</p>
</div>
<p><strong>Flip Image</strong></p>
<p>When <strong>true</strong>, the camera image is flipped top-to-bottom.</p>
<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.25</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 warning">
<p class="admonition-title">Warning</p>
<p>After changing this parameter you need to update your reference image and alignment markers!</p>
</div>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>This parameter can also be set on the Reference Image configuration page!</p>
</div>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>This is used when <strong>CamAwb</strong> is off.</p>
</div>
<p><strong>White Balance Mode</strong></p>
<p>Available options:</p>
<ul>
<li><code>auto</code></li>
<li><code>sunny</code></li>
<li><code>cloudy</code></li>
<li><code>office</code></li>
<li><code>home</code></li>
</ul>
<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.26</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 warning">
<p class="admonition-title">Warning</p>
<p>After changing this parameter you need to update your reference image and alignment markers!</p>
</div>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>This parameter can also be set on the Reference Image configuration page!</p>
</div>
<p><strong>White Pixel Correction</strong></p>
<p>Enable/Disable <strong>white point compensation</strong>, his can make white parts of the image whiter.</p>
<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.27</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>
<p>This is an <strong>Expert Parameter</strong>! Only change it if you understand what it does!</p>
<p>After changing this parameter you need to update your reference image and alignment markers!</p>
</div>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>This parameter can also be set on the Reference Image configuration page!</p>
</div>
<p><strong>Zoom</strong></p>
<p>Enable/Disable digital zoom.</p>
<p>It is always zoomed into the center of the image, if <strong>CamZoomOffsetX</strong> and <strong>CamZoomOffsetY</strong> are zero.</p>
<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.28</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>
<p>This is an <strong>Expert Parameter</strong>! Only change it if you understand what it does!</p>
<p>After changing this parameter you need to update your reference image and alignment markers!</p>
</div>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>This parameter can also be set on the Reference Image configuration page!</p>
</div>
<p><strong>Zoom Offset X</strong></p>
<p>X displacement of the image from the center.</p>
<p>Positive values ​​shift the image to the right, negative values ​​to the left.</p>
<p>The maximum possible offset depends on the value of the <strong>CamZoomSize</strong>.</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.29</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>
<p>This is an <strong>Expert Parameter</strong>! Only change it if you understand what it does!</p>
<p>After changing this parameter you need to update your reference image and alignment markers!</p>
</div>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>This parameter can also be set on the Reference Image configuration page!</p>
</div>
<p><strong>Zoom Offset Y</strong></p>
<p>Y displacement of the image from the center.</p>
<p>Positive values ​​move the image up, negative values ​​move the image down.</p>
<p>The maximum possible offset depends on the value of the <strong>CamZoomSize</strong>.</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.30</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>
<p>This is an <strong>Expert Parameter</strong>! Only change it if you understand what it does!</p>
<p>After changing this parameter you need to update your reference image and alignment markers!</p>
</div>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>This parameter can also be set on the Reference Image configuration page!</p>
</div>
<p><strong>Zoom Size</strong></p>
<p>Zoom factor/level of the digital zoom, the larger the value, the more it zooms in.</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.31</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>
<p>This is an <strong>Expert Parameter</strong>! Only change it if you understand what it does!</p>
</div>
<p>Enable to use demo images instead of the real camera images.
Make sure to have a <code>/demo</code> folder on your SD-Card and make sure it contains the expected files!
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.32</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>
<p>This parameter can also be set on the Reference Image configuration page!</p>
</div>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>After changing this parameter you need to update your reference image and alignment markers!</p>
</div>
<p>Set the Flash LED Intensity: (<code>0</code> .. <code>100</code>)</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.33</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">
<p class="admonition-title">Warning</p>
<p>A SD-Card has limited write cycles. Since the device does not do <a href="https://en.wikipedia.org/wiki/Wear_leveling">Wear Leveling</a>, this can wear out your SD-Card!</p>
</div>
<hr style="border:2px solid"/>
<p><a id="TakeImage-RawImagesRetention"></a></p>
<h3 id="parameter-rawimagesretention"><span class="enumerate-headings-plugin enumerate-heading-plugin">1.1.34</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-WaitBeforeTakingPicture"></a></p>
<h3 id="parameter-waitbeforetakingpicture"><span class="enumerate-headings-plugin enumerate-heading-plugin">1.1.35</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">
<p class="admonition-title">Warning</p>
<p>This is an <strong>Expert Parameter</strong>! Only change it if you understand what it does!</p>
</div>
<p>Waiting time between switching the flash light (onboard LED) on and taking the picture.</p>
<hr style="border:2px solid"/>
<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>
<p>This is an <strong>Expert Parameter</strong>! Only change it if you understand what it does!</p>
</div>
<p>Algorithm used for the alignment step.</p>
<p>Available options:</p>
<ul>
<li><code>Default</code>: Use only red color channel</li>
<li><code>HighAccuracy</code>: Use all 3 color channels (3x slower)</li>
<li><code>Fast</code>: First time use <code>HighAccuracy</code>, then only check if the image is shifted</li>
<li><code>Off</code>: Disable alignment algorithm</li>
</ul>
<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.2</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">
<p class="admonition-title">Note</p>
<p>This parameter can also be set on the Reference Image configuration page!</p>
</div>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>After changing this parameter you need to update your reference image and alignment markers!</p>
</div>
<p>Initial rotation of image before alignment in degree (<code>-360</code> .. <code>+360</code>)</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.3</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">
<p class="admonition-title">Warning</p>
<p>This is an <strong>Expert Parameter</strong>! Only change it if you understand what it does!</p>
</div>
<p>X-size (width) in which the reference is searched.</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>Since the alignment is one of the steps using a lot of computation time,
the search field should be as small as possible.
The calculation time goes quadratic with the search field size.</p>
</div>
<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.4</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">
<p class="admonition-title">Warning</p>
<p>This is an <strong>Expert Parameter</strong>! Only change it if you understand what it does!</p>
</div>
<p>Y-size (height) in which the reference is searched.</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>Since the alignment is one of the steps using a lot of computation time,
the search field should be as small as possible.
The calculation time goes quadratic with the search field size.</p>
</div>
<hr style="border:2px solid"/>
<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>
<p>This is an <strong>Expert Parameter</strong>! Only change it if you understand what it does!</p>
</div>
<p>Threshold above which the classification should be to accept the value (only meaningful for digits).</p>
<div class="admonition warning">
<p class="admonition-title">Warning</p>
<p>This is only supported for the <code>dig-class100</code> models!</p>
</div>
<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">
<p class="admonition-title">Warning</p>
<p>A SD-Card has limited write cycles. Since the device does not do <a href="https://en.wikipedia.org/wiki/Wear_leveling">Wear Leveling</a>, this can wear out your SD-Card!</p>
</div>
<hr style="border:2px solid"/>
<p><a id="Digits-ROIImagesRetention"></a></p>
<h3 id="parameter-roiimagesretention"><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>
<hr style="border:2px solid"/>
<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>
<p>This is an <strong>Expert Parameter</strong>! Only change it if you understand what it does!</p>
</div>
<p>Threshold above which the classification should be to accept the value (only meaningful for digits).</p>
<div class="admonition warning">
<p class="admonition-title">Warning</p>
<p>This is only supported for the <code>ana-class100</code> models!</p>
</div>
<hr style="border:2px solid"/>
<p><a id="Analog-ExtendedResolution"></a></p>
<h3 id="parameter-extendedresolution"><span class="enumerate-headings-plugin enumerate-heading-plugin">1.4.2</span> Parameter <code>ExtendedResolution</code></h3>
<div class="admonition warning">
<p class="admonition-title">Warning</p>
<p>This parameter is unused!
Use <a href="../Parameters/#PostProcessing-NUMBER.ExtendedResolution"><code>NUMBER.ExtendedResolution</code></a> instead!</p>
</div>
<hr style="border:2px solid"/>
<p><a id="Analog-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">
<p class="admonition-title">Warning</p>
<p>A SD-Card has limited write cycles. Since the device does not do <a href="https://en.wikipedia.org/wiki/Wear_leveling">Wear Leveling</a>, this can wear out your SD-Card!</p>
</div>
<hr style="border:2px solid"/>
<p><a id="Analog-ROIImagesRetention"></a></p>
<h3 id="parameter-roiimagesretention_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>
<hr style="border:2px solid"/>
<h2 id="section-postprocessing"><span class="enumerate-headings-plugin enumerate-heading-plugin">1.5</span> Section <code>PostProcessing</code></h2>
<p><a id="PostProcessing-AllowNegativeRates"></a></p>
<h3 id="parameter-allownegativerates"><span class="enumerate-headings-plugin enumerate-heading-plugin">1.5.1</span> Parameter <code>AllowNegativeRates</code></h3>
<div class="admonition warning">
<p class="admonition-title">Warning</p>
<p>This parameter is unused!
Use <a href="../Parameters/#PostProcessing-NUMBER.AllowNegativeRates"><code>NUMBER.AllowNegativeRates</code></a> instead!</p>
</div>
<hr style="border:2px solid"/>
<p><a id="PostProcessing-CheckDigitIncreaseConsistency"></a></p>
<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>
<p>This is an <strong>Expert Parameter</strong>! Only change it if you understand what it does!</p>
</div>
<p>An additional consistency check.
It especially improves the zero crossing check between digits.</p>
<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>
<p>This is an <strong>Expert Parameter</strong>! Only change it if you understand what it does!</p>
</div>
<p>Do not show error message in return value.
In an error case, the last valid number will be used for the various transmission protocols (MQTT, InfluxDB, REST, ...).</p>
<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">
<p class="admonition-title">Note</p>
<p>This is unusual (it means there is a negative rate) and not wanted in most cases!</p>
</div>
<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.
Set it here. Only used on combination of digits and analog pointers.
See <a href="../Watermeter-specific-analog---digital-transition">here</a> for details.</p>
<p>Range: <code>6.0</code> .. <code>9.9</code>.</p>
<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>
<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>
<p>Threshold parameter for change rate detection.<br/>
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>
<p>Example:</p>
<div class="language-text highlight"><pre><span></span><code>Smallest ROI provides value for 0.000x
ChangeRateThreshold = 2
Extended Resolution disabled:
PreValue: 123.456'7 &gt;&gt;&gt; Threshold = +/- 0.000'2
Comparative value &gt;&gt;&gt; max = 123.456'9 and min = 123.456'5
Extended Resolution enabled:
PreValue: 123.456'78 &gt;&gt;&gt; Threshold = +/- 0.000'02
Comparative value &gt;&gt;&gt; max = 123.456'80 and min = 123.456'76
</code></pre></div>
<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>
<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>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"/>
<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>
<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">
<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>
<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>
<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>
<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>
<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.11</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.12</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>
<p>This is an <strong>Expert Parameter</strong>! Only change it if you understand what it does!</p>
</div>
<p>Time in minutes, how long a previous read value is valid after reboot.</p>
<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.13</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>
<hr style="border:2px solid"/>
<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">
<p class="admonition-title">Warning</p>
<p>This is an <strong>Expert Parameter</strong>! Only change it if you understand what it does!</p>
</div>
<p>Path to the CA certificate file.</p>
<p>This is part of the configuration to enable TLS for MQTT.
The CA Certificate is used by the client to validate the broker is who it claims to be.
It allows the client to authenticate the server, which is the first part of the MTLS handshake.</p>
<p>Usually there is a common RootCA certificate for the MQTT broker</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>This also means that you might have to change the protocol and port in <a href="https://jomjol.github.io/AI-on-the-edge-device-docs/Parameters/#parameter-uri">uri</a> to <code>mqtts://example.com:8883</code>!</p>
</div>
<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">
<p class="admonition-title">Warning</p>
<p>This is an <strong>Expert Parameter</strong>! Only change it if you understand what it does!</p>
</div>
<p>Path to the Client Certificate file.</p>
<p>This is part of the configuration to enable TLS for MQTT.
The Client Certificate is used by the client to prove its identity to the server, in conjunction with the Client Key.
It is the second part of the MTLS handshake.</p>
<p>Usually there is a one pair of Client Certificate/Key for each client that connects to the MQTT broker</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>If set, <code>ClientKey</code> must be set too
This also means that you might have to change the protocol and port in <a href="https://jomjol.github.io/AI-on-the-edge-device-docs/Parameters/#parameter-uri">uri</a> to <code>mqtts://example.com:8883</code>!</p>
</div>
<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">
<p class="admonition-title">Warning</p>
<p>This is an <strong>Expert Parameter</strong>! Only change it if you understand what it does!</p>
</div>
<p>Path to the Client Key file.</p>
<p>This is part of the configuration to enable TLS for MQTT.
The Client Key is used by the client to prove its identity to the server, in conjunction with the Client Certificate.
It is the second part of the MTLS handshake.</p>
<p>Usually there is a one pair of Client Certificate/Key for each client that connects to the MQTT broker</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>If set, <code>ClientCert</code> must be set too
This also means that you might have to change the protocol and port in <a href="https://jomjol.github.io/AI-on-the-edge-device-docs/Parameters/#parameter-uri">uri</a> to <code>mqtts://example.com:8883</code>!</p>
</div>
<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>
<p>With:</p>
<ul>
<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>
<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>
<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>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>The main topic is allowed to contain <code>/</code> which can be used to split it into multiple levels, eg. <code>/basement/meters/watermeter/1/</code> if you have multiple water meters in your basement.</p>
</div>
<p>The nodeId for the Home Assistant MQTT Service Discovery must follow the schema <code>&lt;discovery_prefix&gt;/&lt;component&gt;/[&lt;node_id&gt;/]&lt;object_id&gt;/config</code>. The node_id is not configurable but derived from the <code>MainTopic</code> by stripping any but the last topic level. A <code>MainTopic</code> with the value <code>home/basement/watermeter</code> is transformed into the node_id <code>watermeter</code>, resulting in the discovery topic <code>homeassistant/sensor/watermeter/value/config</code> for the current value.</p>
<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">
<p class="admonition-title">Note</p>
<p>For <code>Watermeter</code> you need to have Homeassistant 2022.11 or newer!</p>
</div>
<p>Please also make sure that the selected Meter Type matches the dimension of the value provided by the meter!
Eg. if your meter provides <code>m³</code>, you need to also set it to <code>m³</code>.
Alternatively you can set the parameter <code>DecimalShift</code> to <code>3</code> so the value is converted to <code>liters</code>!</p>
<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">
<p class="admonition-title">Note</p>
<p>See section <code>InfluxDBv2</code> for InfluxDB v2 support! </p>
</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>
<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">
<p class="admonition-title">Note</p>
<p>See section <code>InfluxDBv2</code> for InfluxDB v2 support! </p>
</div>
<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">
<p class="admonition-title">Note</p>
<p>See section <code>InfluxDBv2</code> for InfluxDB v2 support! </p>
</div>
<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">
<p class="admonition-title">Note</p>
<p>See section <code>InfluxDBv2</code> for InfluxDB v2 support! </p>
</div>
<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">
<p class="admonition-title">Note</p>
<p>See section <code>InfluxDBv2</code> for InfluxDB v2 support! </p>
</div>
<hr style="border:2px solid"/>
<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"/>
<p><a id="InfluxDBv2-Database"></a></p>
<h3 id="parameter-database_1"><span class="enumerate-headings-plugin enumerate-heading-plugin">1.8.2</span> Parameter <code>Database</code></h3>
<div class="admonition warning">
<p class="admonition-title">Warning</p>
<p>This parameter is unused!
Use <a href="../Parameters/#InfluxDBv2-Basket"><code>Basket</code></a> instead!</p>
</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>
<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>
<p>This is an <strong>Expert Parameter</strong>! Only change it if you understand what it does!</p>
</div>
<p>This parameter can be used to configure the GPIO <code>IO0</code> pin.</p>
<div class="admonition warning">
<p class="admonition-title">Warning</p>
<p>This pin is only usable with restrictions!
It must be disabled when the camera is used.
Additionally, it is used to activate Bootloader mode and must therefore be HIGH after a reset!</p>
</div>
<p>Parameters:</p>
<ul>
<li><code>GPIO 0 state</code>: One of <code>input</code>, <code>input pullup</code>, <code>input pulldown</code> or <code>output</code>.</li>
<li><code>GPIO 0 use interrupt</code>: Enable interrupt trigger</li>
<li><code>GPIO 0 PWM duty resolution</code>: LEDC PWM duty resolution in bit</li>
<li><code>GPIO 0 enable MQTT</code>: Enable MQTT publishing/subscribing</li>
<li><code>GPIO 0 enable HTTP</code>: Enable HTTP write/read</li>
<li><code>GPIO 0 name</code>: MQTT topic name (empty = <code>GPIO0</code>). Allowed characters: <code>a-z, A-Z, 0-9, _, -</code>.</li>
</ul>
<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>
<p>This is an <strong>Expert Parameter</strong>! Only change it if you understand what it does!</p>
</div>
<p>This parameter can be used to configure the GPIO <code>IO1</code> pin.</p>
<div class="admonition warning">
<p class="admonition-title">Warning</p>
<p>This pin is by default used for the serial communication as TX pin (USB logging)!</p>
</div>
<p>Parameters:</p>
<ul>
<li><code>GPIO 1 state</code>: One of <code>input</code>, <code>input pullup</code>, <code>input pulldown</code> or <code>output</code>.</li>
<li><code>GPIO 1 use interrupt</code>: Enable interrupt trigger</li>
<li><code>GPIO 1 PWM duty resolution</code>: LEDC PWM duty resolution in bit</li>
<li><code>GPIO 1 enable MQTT</code>: Enable MQTT publishing/subscribing</li>
<li><code>GPIO 1 enable HTTP</code>: Enable HTTP write/read</li>
<li><code>GPIO 1 name</code>: MQTT topic name (empty = <code>GPIO1</code>). Allowed characters: <code>a-z, A-Z, 0-9, _, -</code>.</li>
</ul>
<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>
<p>This is an <strong>Expert Parameter</strong>! Only change it if you understand what it does!</p>
</div>
<p>This parameter can be used to configure the GPIO <code>IO12</code> pin.</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>This pin is usable without known restrictions!</p>
</div>
<p>Parameters:</p>
<ul>
<li><code>GPIO 12 state</code>: One of <code>external-flash-ws281x</code>, <code>input</code>, <code>input pullup</code>, <code>input pulldown</code> or <code>output</code>.</li>
<li><code>GPIO 12 use interrupt</code>: Enable interrupt trigger</li>
<li><code>GPIO 12 PWM duty resolution</code>: LEDC PWM duty resolution in bit</li>
<li><code>GPIO 12 enable MQTT</code>: Enable MQTT publishing/subscribing</li>
<li><code>GPIO 12 enable HTTP</code>: Enable HTTP write/read</li>
<li><code>GPIO 12 name</code>: MQTT topic name (empty = <code>GPIO12</code>). Allowed characters: <code>a-z, A-Z, 0-9, _, -</code>.</li>
</ul>
<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>
<p>This is an <strong>Expert Parameter</strong>! Only change it if you understand what it does!</p>
</div>
<p>This parameter can be used to configure the GPIO <code>IO13</code> pin.</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>This pin is usable without known restrictions!</p>
</div>
<p>Parameters:</p>
<ul>
<li><code>GPIO 13 state</code>: One of <code>input</code>, <code>input pullup</code>, <code>input pulldown</code> or <code>output</code>.</li>
<li><code>GPIO 13 use interrupt</code>: Enable interrupt trigger</li>
<li><code>GPIO 13 PWM duty resolution</code>: LEDC PWM duty resolution in bit</li>
<li><code>GPIO 13 enable MQTT</code>: Enable MQTT publishing/subscribing</li>
<li><code>GPIO 13 enable HTTP</code>: Enable HTTP write/read</li>
<li><code>GPIO 13 name</code>: MQTT topic name (empty = <code>GPIO13</code>). Allowed characters: <code>a-z, A-Z, 0-9, _, -</code>.</li>
</ul>
<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>
<p>This is an <strong>Expert Parameter</strong>! Only change it if you understand what it does!</p>
</div>
<p>This parameter can be used to configure the GPIO <code>IO3</code> pin.</p>
<div class="admonition warning">
<p class="admonition-title">Warning</p>
<p>This pin is by default used for the serial communication as RX pin (USB logging)!</p>
</div>
<p>Parameters:</p>
<ul>
<li><code>GPIO 3 state</code>: One of <code>input</code>, <code>input pullup</code>, <code>input pulldown</code> or <code>output</code>.</li>
<li><code>GPIO 3 use interrupt</code>: Enable interrupt trigger</li>
<li><code>GPIO 3 PWM duty resolution</code>: LEDC PWM duty resolution in bit</li>
<li><code>GPIO 3 enable MQTT</code>: Enable MQTT publishing/subscribing</li>
<li><code>GPIO 3 enable HTTP</code>: Enable HTTP write/read</li>
<li><code>GPIO 3 name</code>: MQTT topic name (empty = <code>GPIO3</code>). Allowed characters: <code>a-z, A-Z, 0-9, _, -</code>.</li>
</ul>
<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>
<p>This is an <strong>Expert Parameter</strong>! Only change it if you understand what it does!</p>
</div>
<p>This parameter can be used to configure the GPIO <code>IO4</code> pin.</p>
<div class="admonition warning">
<p class="admonition-title">Warning</p>
<p>This pin is only usable with restrictions!
By default, it is used for build-in flash light (onboard LED).</p>
</div>
<p>Parameters:</p>
<ul>
<li><code>GPIO 4 state</code>: One of <code>built-in-led</code>, <code>input</code>, <code>input pullup</code>, <code>input pulldown</code> or <code>output</code>.</li>
<li><code>GPIO 4 use interrupt</code>: Enable interrupt trigger</li>
<li><code>GPIO 4 PWM duty resolution</code>: LEDC PWM duty resolution in bit</li>
<li><code>GPIO 4 enable MQTT</code>: Enable MQTT publishing/subscribing</li>
<li><code>GPIO 4 enable HTTP</code>: Enable HTTP write/read</li>
<li><code>GPIO 4 name</code>: MQTT topic name (empty = <code>GPIO4</code>). Allowed characters: <code>a-z, A-Z, 0-9, _, -</code>.</li>
</ul>
<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>
<p>This parameter is not accessible through the Web Interface Configuration Page!</p>
</div>
<p>The GPIO Interface is prepared to report it's status and status changes as a MQTT topic. With this parameter you configure the MQTT main topic, under which the status is published.
As this parameter is still experimental it can only be set manually in the <code>config.ini</code> itself and has not been tested in detail so far.</p>
<hr style="border:2px solid"/>
<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>
<p>This is an <strong>Expert Parameter</strong>! Only change it if you understand what it does!</p>
</div>
<p>Automatically start the Flow (Digitization Rounds) immediately after power up.</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>Typically this is set to <code>true</code>.
The 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>
<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.
If a round takes longer than this interval, the next round gets postponed until the current round completes.</p>
<hr style="border:2px solid"/>
<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>
<div class="admonition warning">
<p class="admonition-title">Warning</p>
<p>A SD-Card has limited write cycles. Since the device does not do <a href="https://en.wikipedia.org/wiki/Wear_leveling">Wear Leveling</a>, this can wear out your SD-Card!</p>
</div>
<hr style="border:2px solid"/>
<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>
<ul>
<li><code>1</code>: <code>ERROR</code></li>
<li><code>2</code>: <code>WARNING</code></li>
<li><code>3</code>: <code>INFO</code></li>
<li><code>4</code>: <code>DEBUG</code></li>
</ul>
<p>As higher the level, as more log messages get written to the SD-Card.</p>
<div class="admonition warning">
<p class="admonition-title">Warning</p>
<p><code>DEBUG</code> or <code>INFO</code> might damage the SD-Card if enabled long term due to excessive writes to the SD-Card!
A SD-Card has limited write cycles. Since the device does not do <a href="https://en.wikipedia.org/wiki/Wear_leveling">Wear Leveling</a>, this can wear out your SD-Card!</p>
</div>
<hr style="border:2px solid"/>
<p><a id="Debug-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>
<hr style="border:2px solid"/>
<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">
<p class="admonition-title">Warning</p>
<p>Setting it to 240 will lead to a faster device, but it will also require a stronger power supply!
Additionally, depending on the quality of your ESP32-CAM, it might run unstable!</p>
</div>
<p>Possible values: </p>
<ul>
<li>160</li>
<li>240 </li>
</ul>
<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>
<p>This is an <strong>Expert Parameter</strong>! Only change it if you understand what it does!</p>
</div>
<p>Hostname for the device.
It gets automatically transferred to <code>/wlan.ini</code> on the SD-Card at the next startup.</p>
<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">
<p class="admonition-title">Warning</p>
<p>This is an <strong>Expert Parameter</strong>! Only change it if you understand what it does!</p>
</div>
<p>This parameter activates a client triggered AP switching functionality (simplified roaming).
If actual RSSI value is lower (more negative) than <code>RSSIThreshold</code>, all WIFI channels will be scanned for configured access point SSID. If an access point is in range which has better RSSI value (less negative) than actual RSSI value + 5 dBm, the device is trying to connect to this access point with the better RSSI value.</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>The RSSI check only gets initiated at the end of each round to avoid any disturbance of processing.</p>
</div>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>It gets automatically transferred to <code>/wlan.ini</code> on the SD-Card at next startup.</p>
</div>
<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>
<p>This parameter is not accessible through the Web Interface Configuration Page!</p>
</div>
<p>Set this parameter to <code>true</code> to stay in the Setup Mode after the next start of the device.</p>
<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>
<p>This is an <strong>Expert Parameter</strong>! Only change it if you understand what it does!</p>
</div>
<p>Time server to synchronize system time. If it is disabled or <code>undefined</code>, <code>pool.ntp.org</code> will be used.
You can also set it to the IP of your router. Many routers like Fritzboxes can act as a local NTP server.
To disable NTP, you need to activate it but set the TimeServer config to be empty (<code>""</code>).
In such case the time always starts at <code>01.01.1970</code> after each power cycle!</p>
<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>
<hr style="border:2px solid"/>
<h2 id="section-webhook"><span class="enumerate-headings-plugin enumerate-heading-plugin">1.14</span> Section <code>Webhook</code></h2>
<p><a id="Webhook-ApiKey"></a></p>
<h3 id="parameter-apikey"><span class="enumerate-headings-plugin enumerate-heading-plugin">1.14.1</span> Parameter <code>ApiKey</code></h3>
<p>Section: <a href="#section-webhook">1.14 Webhook</a></p>
<p>Default Value: <code>undefined</code></p>
<p>ApiKey sent as Header</p>
<hr style="border:2px solid"/>
<p><a id="Webhook-Uri"></a></p>
<h3 id="parameter-uri_3"><span class="enumerate-headings-plugin enumerate-heading-plugin">1.14.2</span> Parameter <code>Uri</code></h3>
<p>Section: <a href="#section-webhook">1.14 Webhook</a></p>
<p>Default Value: <code>undefined</code></p>
<p>URI of the HTTP Endpoint receiving requests, e.g. <code>http://192.168.1.1/watermeter/webhook</code>.</p>
<hr style="border:2px solid"/>
</article>
</div>
<script>var target=document.getElementById(location.hash.slice(1));target&&target.name&&(target.checked=target.name.startsWith("__tabbed_"))</script>
</div>
</main>
<footer class="md-footer">
<div class="md-footer-meta md-typeset">
<div class="md-footer-meta__inner md-grid">
<div class="md-copyright">
Made with
<a href="https://squidfunk.github.io/mkdocs-material/" rel="noopener" target="_blank">
Material for MkDocs
</a>
</div>
</div>
</div>
</footer>
</div>
<div class="md-dialog" data-md-component="dialog">
<div class="md-dialog__inner md-typeset"></div>
</div>
<script id="__config" type="application/json">{"base": "..", "features": [], "search": "../assets/javascripts/workers/search.07f07601.min.js", "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}}</script>
<script src="../assets/javascripts/bundle.56dfad97.min.js"></script>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink