mirror of
https://github.com/jomjol/AI-on-the-edge-device-docs.git
synced 2025-12-08 12:36:54 +03:00
1259 lines
56 KiB
HTML
1259 lines
56 KiB
HTML
<!DOCTYPE html>
|
|
<html class="writer-html5" lang="en" >
|
|
<head>
|
|
<meta charset="utf-8" />
|
|
<meta http-equiv="X-UA-Compatible" content="IE=edge" />
|
|
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><link rel="canonical" href="https://jomjol.github.io/AI-on-the-edge-device-docs/Parameters/" />
|
|
<link rel="shortcut icon" href="../img/favicon.ico" />
|
|
<title>Parameters - AI on the Edge Device</title>
|
|
<link rel="stylesheet" href="../css/theme.css" />
|
|
<link rel="stylesheet" href="../css/theme_extra.css" />
|
|
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.5.0/styles/github.min.css" />
|
|
|
|
<script>
|
|
// Current page data
|
|
var mkdocs_page_name = "Parameters";
|
|
var mkdocs_page_input_path = "Parameters.md";
|
|
var mkdocs_page_url = "/AI-on-the-edge-device-docs/Parameters/";
|
|
</script>
|
|
|
|
<script src="../js/jquery-3.6.0.min.js" defer></script>
|
|
<!--[if lt IE 9]>
|
|
<script src="../js/html5shiv.min.js"></script>
|
|
<![endif]-->
|
|
<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.5.0/highlight.min.js"></script>
|
|
<script>hljs.initHighlightingOnLoad();</script>
|
|
</head>
|
|
|
|
<body class="wy-body-for-nav" role="document">
|
|
|
|
<div class="wy-grid-for-nav">
|
|
<nav data-toggle="wy-nav-shift" class="wy-nav-side stickynav">
|
|
<div class="wy-side-scroll">
|
|
<div class="wy-side-nav-search">
|
|
<img src=https://jomjol.github.io/AI-on-the-edge-device-docs//img/logo.png>
|
|
<a href=".." class="icon icon-home"> AI on the Edge Device
|
|
</a><div role="search">
|
|
<form id ="rtd-search-form" class="wy-form" action="../search.html" method="get">
|
|
<input type="text" name="q" placeholder="Search docs" title="Type search term here" />
|
|
</form>
|
|
</div>
|
|
</div>
|
|
|
|
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
|
|
<p class="caption"><span class="caption-text">Getting Started</span></p>
|
|
<ul>
|
|
<li class="toctree-l1"><a class="reference internal" href="..">Welcome</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../Installation/">Installation</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../initial-setup/">Initial Setup</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../Hardware-Compatibility/">Hardware Compatibility</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../Best-Practice/">Best Practice</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../FAQs/">Frequently Asked Questions</a>
|
|
</li>
|
|
</ul>
|
|
<p class="caption"><span class="caption-text">External Links</span></p>
|
|
<ul>
|
|
<li class="toctree-l1"><a class="" href="https://github.com/jomjol/AI-on-the-edge-device/releases">Releases</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="" href="https://jomjol.github.io/AI-on-the-edge-device/index.html">Web Installer/Console</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="" href="https://github.com/jomjol/AI-on-the-edge-device/issues">Place an Issue</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="" href="https://github.com/jomjol/AI-on-the-edge-device/discussions">Join a Discussion</a>
|
|
</li>
|
|
</ul>
|
|
<p class="caption"><span class="caption-text">Configuration</span></p>
|
|
<ul class="current">
|
|
<li class="toctree-l1"><a class="reference internal" href="../ROI-Configuration/">ROI (Region of Interest)</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../Choosing-the-Model/">Model Selection</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../Neural-Network-Types/">Neural Network Types</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../ota/">Over-The-Air (OTA) Update</a>
|
|
</li>
|
|
<li class="toctree-l1 current"><a class="reference internal current" href="./">Parameters</a>
|
|
<ul class="current">
|
|
<li class="toctree-l2"><a class="reference internal" href="#alignment">[Alignment]</a>
|
|
<ul>
|
|
<li class="toctree-l3"><a class="reference internal" href="#parameter-alignmentalgo">Parameter AlignmentAlgo</a>
|
|
<ul>
|
|
<li class="toctree-l4"><a class="reference internal" href="#description">Description</a>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
<li class="toctree-l3"><a class="reference internal" href="#parameter-flipimagesize">Parameter FlipImageSize</a>
|
|
<ul>
|
|
<li class="toctree-l4"><a class="reference internal" href="#description_1">Description</a>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
<li class="toctree-l3"><a class="reference internal" href="#parameter-initialmirror">Parameter InitialMirror</a>
|
|
<ul>
|
|
<li class="toctree-l4"><a class="reference internal" href="#description_2">Description</a>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
<li class="toctree-l3"><a class="reference internal" href="#parameter-initialrotate">Parameter InitialRotate</a>
|
|
<ul>
|
|
<li class="toctree-l4"><a class="reference internal" href="#description_3">Description</a>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
<li class="toctree-l3"><a class="reference internal" href="#parameter-searchfieldx">Parameter SearchFieldX</a>
|
|
<ul>
|
|
<li class="toctree-l4"><a class="reference internal" href="#description_4">Description</a>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
<li class="toctree-l3"><a class="reference internal" href="#parameter-searchfieldy">Parameter SearchFieldY</a>
|
|
<ul>
|
|
<li class="toctree-l4"><a class="reference internal" href="#description_5">Description</a>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
<li class="toctree-l2"><a class="reference internal" href="#analog">[Analog]</a>
|
|
<ul>
|
|
<li class="toctree-l3"><a class="reference internal" href="#parameter-cnngoodthreshold">Parameter CNNGoodThreshold</a>
|
|
<ul>
|
|
<li class="toctree-l4"><a class="reference internal" href="#description_6">Description</a>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
<li class="toctree-l3"><a class="reference internal" href="#parameter-extendedresolution">Parameter ExtendedResolution</a>
|
|
<ul>
|
|
<li class="toctree-l4"><a class="reference internal" href="#description_7">Description</a>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
<li class="toctree-l3"><a class="reference internal" href="#parameter-logimagelocation">Parameter LogImageLocation</a>
|
|
<ul>
|
|
<li class="toctree-l4"><a class="reference internal" href="#description_8">Description</a>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
<li class="toctree-l3"><a class="reference internal" href="#parameter-logfileretentionindays">Parameter LogfileRetentionInDays</a>
|
|
<ul>
|
|
<li class="toctree-l4"><a class="reference internal" href="#description_9">Description</a>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
<li class="toctree-l3"><a class="reference internal" href="#parameter-model">Parameter Model</a>
|
|
<ul>
|
|
<li class="toctree-l4"><a class="reference internal" href="#description_10">Description</a>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
<li class="toctree-l2"><a class="reference internal" href="#autotimer">[AutoTimer]</a>
|
|
<ul>
|
|
<li class="toctree-l3"><a class="reference internal" href="#parameter-autostart">Parameter AutoStart</a>
|
|
<ul>
|
|
<li class="toctree-l4"><a class="reference internal" href="#description_11">Description</a>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
<li class="toctree-l3"><a class="reference internal" href="#parameter-intervall">Parameter Intervall</a>
|
|
<ul>
|
|
<li class="toctree-l4"><a class="reference internal" href="#description_12">Description</a>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
<li class="toctree-l2"><a class="reference internal" href="#datalogging">[DataLogging]</a>
|
|
<ul>
|
|
<li class="toctree-l3"><a class="reference internal" href="#parameter-datalogactive">Parameter DataLogActive</a>
|
|
<ul>
|
|
<li class="toctree-l4"><a class="reference internal" href="#description_13">Description</a>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
<li class="toctree-l3"><a class="reference internal" href="#parameter-datalogretentionindays">Parameter DataLogRetentionInDays</a>
|
|
<ul>
|
|
<li class="toctree-l4"><a class="reference internal" href="#description_14">Description</a>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
<li class="toctree-l2"><a class="reference internal" href="#debug">[Debug]</a>
|
|
<ul>
|
|
<li class="toctree-l3"><a class="reference internal" href="#parameter-logfile">Parameter Logfile</a>
|
|
<ul>
|
|
<li class="toctree-l4"><a class="reference internal" href="#description_15">Description</a>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
<li class="toctree-l3"><a class="reference internal" href="#parameter-logfileretentionindays_1">Parameter LogfileRetentionInDays</a>
|
|
<ul>
|
|
<li class="toctree-l4"><a class="reference internal" href="#description_16">Description</a>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
<li class="toctree-l2"><a class="reference internal" href="#digits">[Digits]</a>
|
|
<ul>
|
|
<li class="toctree-l3"><a class="reference internal" href="#parameter-cnngoodthreshold_1">Parameter CNNGoodThreshold</a>
|
|
<ul>
|
|
<li class="toctree-l4"><a class="reference internal" href="#description_17">Description</a>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
<li class="toctree-l3"><a class="reference internal" href="#parameter-logimagelocation_1">Parameter LogImageLocation</a>
|
|
<ul>
|
|
<li class="toctree-l4"><a class="reference internal" href="#description_18">Description</a>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
<li class="toctree-l3"><a class="reference internal" href="#parameter-logfileretentionindays_2">Parameter LogfileRetentionInDays</a>
|
|
<ul>
|
|
<li class="toctree-l4"><a class="reference internal" href="#description_19">Description</a>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
<li class="toctree-l3"><a class="reference internal" href="#parameter-model_1">Parameter Model</a>
|
|
<ul>
|
|
<li class="toctree-l4"><a class="reference internal" href="#description_20">Description</a>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
<li class="toctree-l2"><a class="reference internal" href="#gpio">[GPIO]</a>
|
|
<ul>
|
|
<li class="toctree-l3"><a class="reference internal" href="#parameter-io0">Parameter IO0</a>
|
|
<ul>
|
|
<li class="toctree-l4"><a class="reference internal" href="#description_21">Description</a>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
<li class="toctree-l3"><a class="reference internal" href="#parameter-io1">Parameter IO1</a>
|
|
<ul>
|
|
<li class="toctree-l4"><a class="reference internal" href="#description_22">Description</a>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
<li class="toctree-l3"><a class="reference internal" href="#parameter-io12">Parameter IO12</a>
|
|
<ul>
|
|
<li class="toctree-l4"><a class="reference internal" href="#description_23">Description</a>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
<li class="toctree-l3"><a class="reference internal" href="#parameter-io13">Parameter IO13</a>
|
|
<ul>
|
|
<li class="toctree-l4"><a class="reference internal" href="#description_24">Description</a>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
<li class="toctree-l3"><a class="reference internal" href="#parameter-io3">Parameter IO3</a>
|
|
<ul>
|
|
<li class="toctree-l4"><a class="reference internal" href="#description_25">Description</a>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
<li class="toctree-l3"><a class="reference internal" href="#parameter-io4">Parameter IO4</a>
|
|
<ul>
|
|
<li class="toctree-l4"><a class="reference internal" href="#description_26">Description</a>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
<li class="toctree-l3"><a class="reference internal" href="#parameter-ledcolor">Parameter LEDColor</a>
|
|
<ul>
|
|
<li class="toctree-l4"><a class="reference internal" href="#description_27">Description</a>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
<li class="toctree-l3"><a class="reference internal" href="#parameter-lednumbers">Parameter LEDNumbers</a>
|
|
<ul>
|
|
<li class="toctree-l4"><a class="reference internal" href="#description_28">Description</a>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
<li class="toctree-l3"><a class="reference internal" href="#parameter-ledtype">Parameter LEDType</a>
|
|
<ul>
|
|
<li class="toctree-l4"><a class="reference internal" href="#description_29">Description</a>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
<li class="toctree-l3"><a class="reference internal" href="#parameter-maintopicmqtt">Parameter MainTopicMQTT</a>
|
|
<ul>
|
|
<li class="toctree-l4"><a class="reference internal" href="#description_30">Description</a>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
<li class="toctree-l2"><a class="reference internal" href="#influxdb">[InfluxDB]</a>
|
|
<ul>
|
|
<li class="toctree-l3"><a class="reference internal" href="#parameter-database">Parameter Database</a>
|
|
<ul>
|
|
<li class="toctree-l4"><a class="reference internal" href="#description_31">Description</a>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
<li class="toctree-l3"><a class="reference internal" href="#parameter-measurement">Parameter Measurement</a>
|
|
<ul>
|
|
<li class="toctree-l4"><a class="reference internal" href="#description_32">Description</a>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
<li class="toctree-l3"><a class="reference internal" href="#parameter-uri">Parameter Uri</a>
|
|
<ul>
|
|
<li class="toctree-l4"><a class="reference internal" href="#description_33">Description</a>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
<li class="toctree-l3"><a class="reference internal" href="#parameter-password">Parameter password</a>
|
|
<ul>
|
|
<li class="toctree-l4"><a class="reference internal" href="#description_34">Description</a>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
<li class="toctree-l3"><a class="reference internal" href="#parameter-user">Parameter user</a>
|
|
<ul>
|
|
<li class="toctree-l4"><a class="reference internal" href="#description_35">Description</a>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
<li class="toctree-l2"><a class="reference internal" href="#mqtt">[MQTT]</a>
|
|
<ul>
|
|
<li class="toctree-l3"><a class="reference internal" href="#parameter-clientid">Parameter ClientID</a>
|
|
<ul>
|
|
<li class="toctree-l4"><a class="reference internal" href="#description_36">Description</a>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
<li class="toctree-l3"><a class="reference internal" href="#parameter-homeassistantdiscovery">Parameter HomeassistantDiscovery</a>
|
|
<ul>
|
|
<li class="toctree-l4"><a class="reference internal" href="#description_37">Description</a>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
<li class="toctree-l3"><a class="reference internal" href="#parameter-maintopic">Parameter MainTopic</a>
|
|
<ul>
|
|
<li class="toctree-l4"><a class="reference internal" href="#description_38">Description</a>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
<li class="toctree-l3"><a class="reference internal" href="#parameter-metertype">Parameter MeterType</a>
|
|
<ul>
|
|
<li class="toctree-l4"><a class="reference internal" href="#description_39">Description</a>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
<li class="toctree-l3"><a class="reference internal" href="#parameter-setretainflag">Parameter SetRetainFlag</a>
|
|
<ul>
|
|
<li class="toctree-l4"><a class="reference internal" href="#description_40">Description</a>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
<li class="toctree-l3"><a class="reference internal" href="#parameter-uri_1">Parameter Uri</a>
|
|
<ul>
|
|
<li class="toctree-l4"><a class="reference internal" href="#description_41">Description</a>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
<li class="toctree-l3"><a class="reference internal" href="#parameter-password_1">Parameter password</a>
|
|
<ul>
|
|
<li class="toctree-l4"><a class="reference internal" href="#description_42">Description</a>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
<li class="toctree-l3"><a class="reference internal" href="#parameter-user_1">Parameter user</a>
|
|
<ul>
|
|
<li class="toctree-l4"><a class="reference internal" href="#description_43">Description</a>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
<li class="toctree-l2"><a class="reference internal" href="#makeimage">[MakeImage]</a>
|
|
<ul>
|
|
<li class="toctree-l3"><a class="reference internal" href="#parameter-brightness">Parameter Brightness</a>
|
|
<ul>
|
|
<li class="toctree-l4"><a class="reference internal" href="#description_44">Description</a>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
<li class="toctree-l3"><a class="reference internal" href="#parameter-contrast">Parameter Contrast</a>
|
|
<ul>
|
|
<li class="toctree-l4"><a class="reference internal" href="#description_45">Description</a>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
<li class="toctree-l3"><a class="reference internal" href="#parameter-demo">Parameter Demo</a>
|
|
<ul>
|
|
<li class="toctree-l4"><a class="reference internal" href="#description_46">Description</a>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
<li class="toctree-l3"><a class="reference internal" href="#parameter-fixedexposure">Parameter FixedExposure</a>
|
|
<ul>
|
|
<li class="toctree-l4"><a class="reference internal" href="#description_47">Description</a>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
<li class="toctree-l3"><a class="reference internal" href="#parameter-imagequality">Parameter ImageQuality</a>
|
|
<ul>
|
|
<li class="toctree-l4"><a class="reference internal" href="#description_48">Description</a>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
<li class="toctree-l3"><a class="reference internal" href="#parameter-imagesize">Parameter ImageSize</a>
|
|
<ul>
|
|
<li class="toctree-l4"><a class="reference internal" href="#description_49">Description</a>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
<li class="toctree-l3"><a class="reference internal" href="#parameter-ledintensity">Parameter LEDIntensity</a>
|
|
<ul>
|
|
<li class="toctree-l4"><a class="reference internal" href="#description_50">Description</a>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
<li class="toctree-l3"><a class="reference internal" href="#parameter-logimagelocation_2">Parameter LogImageLocation</a>
|
|
<ul>
|
|
<li class="toctree-l4"><a class="reference internal" href="#description_51">Description</a>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
<li class="toctree-l3"><a class="reference internal" href="#parameter-logfileretentionindays_3">Parameter LogfileRetentionInDays</a>
|
|
<ul>
|
|
<li class="toctree-l4"><a class="reference internal" href="#description_52">Description</a>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
<li class="toctree-l3"><a class="reference internal" href="#parameter-saturation">Parameter Saturation</a>
|
|
<ul>
|
|
<li class="toctree-l4"><a class="reference internal" href="#description_53">Description</a>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
<li class="toctree-l3"><a class="reference internal" href="#parameter-waitbeforetakingpicture">Parameter WaitBeforeTakingPicture</a>
|
|
<ul>
|
|
<li class="toctree-l4"><a class="reference internal" href="#description_54">Description</a>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
<li class="toctree-l2"><a class="reference internal" href="#postprocessing">[PostProcessing]</a>
|
|
<ul>
|
|
<li class="toctree-l3"><a class="reference internal" href="#parameter-numberanalogdigitaltransitionstart">Parameter <NUMBER>.AnalogDigitalTransitionStart</a>
|
|
<ul>
|
|
<li class="toctree-l4"><a class="reference internal" href="#description_55">Description</a>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
<li class="toctree-l3"><a class="reference internal" href="#parameter-numberdecimalshift">Parameter <NUMBER>.DecimalShift</a>
|
|
<ul>
|
|
<li class="toctree-l4"><a class="reference internal" href="#description_56">Description</a>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
<li class="toctree-l3"><a class="reference internal" href="#parameter-numberextendedresolution">Parameter <NUMBER>.ExtendedResolution</a>
|
|
<ul>
|
|
<li class="toctree-l4"><a class="reference internal" href="#description_57">Description</a>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
<li class="toctree-l3"><a class="reference internal" href="#parameter-numberignoreleadingnan">Parameter <NUMBER>.IgnoreLeadingNaN</a>
|
|
<ul>
|
|
<li class="toctree-l4"><a class="reference internal" href="#description_58">Description</a>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
<li class="toctree-l3"><a class="reference internal" href="#parameter-numbermaxratetype">Parameter <NUMBER>.MaxRateType</a>
|
|
<ul>
|
|
<li class="toctree-l4"><a class="reference internal" href="#description_59">Description</a>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
<li class="toctree-l3"><a class="reference internal" href="#parameter-numbermaxratevalue">Parameter <NUMBER>.MaxRateValue</a>
|
|
<ul>
|
|
<li class="toctree-l4"><a class="reference internal" href="#description_60">Description</a>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
<li class="toctree-l3"><a class="reference internal" href="#parameter-numbersallownegativerates">Parameter <NUMBERS>.AllowNegativeRates</a>
|
|
<ul>
|
|
<li class="toctree-l4"><a class="reference internal" href="#description_61">Description</a>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
<li class="toctree-l3"><a class="reference internal" href="#parameter-allownegativerates">Parameter AllowNegativeRates</a>
|
|
<ul>
|
|
<li class="toctree-l4"><a class="reference internal" href="#description_62">Description</a>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
<li class="toctree-l3"><a class="reference internal" href="#parameter-checkdigitincreaseconsistency">Parameter CheckDigitIncreaseConsistency</a>
|
|
<ul>
|
|
<li class="toctree-l4"><a class="reference internal" href="#description_63">Description</a>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
<li class="toctree-l3"><a class="reference internal" href="#parameter-errormessage">Parameter ErrorMessage</a>
|
|
<ul>
|
|
<li class="toctree-l4"><a class="reference internal" href="#description_64">Description</a>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
<li class="toctree-l3"><a class="reference internal" href="#parameter-prevalueagestartup">Parameter PreValueAgeStartup</a>
|
|
<ul>
|
|
<li class="toctree-l4"><a class="reference internal" href="#description_65">Description</a>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
<li class="toctree-l3"><a class="reference internal" href="#parameter-prevalueuse">Parameter PreValueUse</a>
|
|
<ul>
|
|
<li class="toctree-l4"><a class="reference internal" href="#description_66">Description</a>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
<li class="toctree-l2"><a class="reference internal" href="#system">[System]</a>
|
|
<ul>
|
|
<li class="toctree-l3"><a class="reference internal" href="#parameter-autoadjustsummertime">Parameter AutoAdjustSummertime</a>
|
|
<ul>
|
|
<li class="toctree-l4"><a class="reference internal" href="#description_67">Description</a>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
<li class="toctree-l3"><a class="reference internal" href="#parameter-hostname">Parameter Hostname</a>
|
|
<ul>
|
|
<li class="toctree-l4"><a class="reference internal" href="#description_68">Description</a>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
<li class="toctree-l3"><a class="reference internal" href="#parameter-setupmode">Parameter SetupMode</a>
|
|
<ul>
|
|
<li class="toctree-l4"><a class="reference internal" href="#description_69">Description</a>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
<li class="toctree-l3"><a class="reference internal" href="#parameter-timeserver">Parameter TimeServer</a>
|
|
<ul>
|
|
<li class="toctree-l4"><a class="reference internal" href="#description_70">Description</a>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
<li class="toctree-l3"><a class="reference internal" href="#parameter-timezone">Parameter TimeZone</a>
|
|
<ul>
|
|
<li class="toctree-l4"><a class="reference internal" href="#description_71">Description</a>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
<p class="caption"><span class="caption-text">Advanced</span></p>
|
|
<ul>
|
|
<li class="toctree-l1"><a class="reference internal" href="../Integration-Home-Assistant/">Integration into Home Assistant</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../External-LED/">External LED</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../rolling-installation/">Living on the Edge</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../Configuration-Parameter-Details/">Configuration Parameter Details</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../Configuration/">Configuration</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../Watermeter-specific-analog---digital-transition/">Analog/Digital Transition on Water Meters</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../collect-new-images/">Collect images to improve the models</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../Learn-models-with-your-own-images/">Learn a model with your own images</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../Correction%20Algorithm/">Correction Algorithm</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../Additional-Information/">Additional Information</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../New-Releases-Notification/">Notification about new Releases</a>
|
|
</li>
|
|
</ul>
|
|
<p class="caption"><span class="caption-text">Troubleshooting</span></p>
|
|
<ul>
|
|
<li class="toctree-l1"><a class="reference internal" href="../Error-Codes/">Error Codes</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../Error-Debugging/">Error Debugging</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../Frequent-Reboots/">Frequent Reboots</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../Demo-Mode/">Demo Mode</a>
|
|
</li>
|
|
</ul>
|
|
<p class="caption"><span class="caption-text">API's</span></p>
|
|
<ul>
|
|
<li class="toctree-l1"><a class="reference internal" href="../REST-API/">REST API</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../MQTT-API/">MQTT API</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../Influx-DB/">Influx DB</a>
|
|
</li>
|
|
</ul>
|
|
<p class="caption"><span class="caption-text">Development</span></p>
|
|
<ul>
|
|
<li class="toctree-l1"><a class="reference internal" href="../Build-Instructions/">Build the Project</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../Upload-files-by-script/">Scripted File Upload</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../Testing/">Testing</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../Release-creation/">Preparing for Release</a>
|
|
</li>
|
|
</ul>
|
|
<p class="caption"><span class="caption-text">Old Pages (no longer maintained)</span></p>
|
|
<ul>
|
|
<li class="toctree-l1"><a class="reference internal" href="../outdated--Integrated-Functions/">Integrated Functions</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../outdated--Gasmeter-Log-Downloader/">Gas Meter Log Downloader</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../outdated--Migrate-Old-Config-To-New-Config/">Migration from water-meter „old“ to water-meter “AI-on-the-edge-device”</a>
|
|
</li>
|
|
</ul>
|
|
<p class="caption"><span class="caption-text">Assorted Pages</span></p>
|
|
<ul>
|
|
<li class="toctree-l1"><a class="reference internal" href="../Graphical-Configuration/">Graphical Configuration</a>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</nav>
|
|
|
|
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
|
|
<nav class="wy-nav-top" role="navigation" aria-label="Mobile navigation menu">
|
|
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
|
|
<a href="..">AI on the Edge Device</a>
|
|
|
|
</nav>
|
|
<div class="wy-nav-content">
|
|
<div class="rst-content"><div role="navigation" aria-label="breadcrumbs navigation">
|
|
<ul class="wy-breadcrumbs">
|
|
<li><a href=".." class="icon icon-home" alt="Docs"></a> »</li>
|
|
<li>Configuration »</li>
|
|
<li>Parameters</li>
|
|
<li class="wy-breadcrumbs-aside">
|
|
<a href="https://github.com/jomjol/AI-on-the-edge-device-docs/edit/main/docs/Parameters.md" class="icon icon-github"> Edit on GitHub</a>
|
|
</li>
|
|
</ul>
|
|
<hr/>
|
|
</div>
|
|
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
|
|
<div class="section" itemprop="articleBody">
|
|
|
|
<h1 id="parameters">Parameters</h1>
|
|
<p>This page lists all available <a href="../Configuration">Configuration</a> Parameters.</p>
|
|
<p>If a parameter or section 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 />
|
|
<h2 id="alignment">[Alignment]</h2>
|
|
<h3 id="parameter-alignmentalgo">Parameter <code>AlignmentAlgo</code></h3>
|
|
<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>
|
|
<h4 id="description">Description</h4>
|
|
<p>Algorithm used for the alignment step.</p>
|
|
<ul>
|
|
<li><code>Default</code>: Use only red color channel</li>
|
|
<li><code>HighAccuracy</code>: Use all 3 color Channels (3x slower)</li>
|
|
<li><code>Fast</code>: First time use <code>HighAccuracy</code>, then only check if the image is shifted</li>
|
|
</ul>
|
|
<hr />
|
|
<h3 id="parameter-flipimagesize">Parameter <code>FlipImageSize</code></h3>
|
|
<p>Default Value: <code>false</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>
|
|
<h4 id="description_1">Description</h4>
|
|
<p>Please fill me with an explanation and useful links</p>
|
|
<hr />
|
|
<h3 id="parameter-initialmirror">Parameter <code>InitialMirror</code></h3>
|
|
<p>Default Value: <code>false</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>
|
|
<h4 id="description_2">Description</h4>
|
|
<p>Please fill me with an explanation and useful links</p>
|
|
<hr />
|
|
<h3 id="parameter-initialrotate">Parameter <code>InitialRotate</code></h3>
|
|
<p>Default Value: <code>179</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>
|
|
<h4 id="description_3">Description</h4>
|
|
<p>Please fill me with an explanation and useful links</p>
|
|
<hr />
|
|
<h3 id="parameter-searchfieldx">Parameter <code>SearchFieldX</code></h3>
|
|
<p>Default Value: <code>20</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>
|
|
<h4 id="description_4">Description</h4>
|
|
<p><code>x</code> size (width) in which the reference is searched.</p>
|
|
<hr />
|
|
<h3 id="parameter-searchfieldy">Parameter <code>SearchFieldY</code></h3>
|
|
<p>Default Value: <code>20</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>
|
|
<h4 id="description_5">Description</h4>
|
|
<p><code>y</code> size (height) in which the reference is searched.</p>
|
|
<hr />
|
|
<h2 id="analog">[Analog]</h2>
|
|
<h3 id="parameter-cnngoodthreshold">Parameter <code>CNNGoodThreshold</code></h3>
|
|
<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>
|
|
<h4 id="description_6">Description</h4>
|
|
<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>EXPERIMENTAL - NOT WORKING FOR ALL CNNs!</p>
|
|
</div>
|
|
<hr />
|
|
<h3 id="parameter-extendedresolution">Parameter <code>ExtendedResolution</code></h3>
|
|
<p>Default Value: <code>true</code></p>
|
|
<h4 id="description_7">Description</h4>
|
|
<p>Please fill me with an explanation and useful links</p>
|
|
<hr />
|
|
<h3 id="parameter-logimagelocation">Parameter <code>LogImageLocation</code></h3>
|
|
<p>Default Value: <code>/log/analog</code></p>
|
|
<h4 id="description_8">Description</h4>
|
|
<p>Location to store separated analog images on the SD-Card for logging.</p>
|
|
<hr />
|
|
<h3 id="parameter-logfileretentionindays">Parameter <code>LogfileRetentionInDays</code></h3>
|
|
<p>Default Value: <code>3</code></p>
|
|
<h4 id="description_9">Description</h4>
|
|
<p>Days to keep the separated analog images (<code>0</code> = forever).</p>
|
|
<hr />
|
|
<h3 id="parameter-model">Parameter <code>Model</code></h3>
|
|
<p>Default Value: <code>/config/ana-cont_11.3.1_s2.tflite</code></p>
|
|
<h4 id="description_10">Description</h4>
|
|
<p>Path to CNN model file for image recognition. See <a href="../Choosing-the-Model">here</a> for details. </p>
|
|
<hr />
|
|
<h2 id="autotimer">[AutoTimer]</h2>
|
|
<h3 id="parameter-autostart">Parameter <code>AutoStart</code></h3>
|
|
<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>
|
|
<h4 id="description_11">Description</h4>
|
|
<p>Please fill me with an explanation and useful links</p>
|
|
<hr />
|
|
<h3 id="parameter-intervall">Parameter <code>Intervall</code></h3>
|
|
<p>Default Value: <code>5</code></p>
|
|
<h4 id="description_12">Description</h4>
|
|
<p>Please fill me with an explanation and useful links</p>
|
|
<hr />
|
|
<h2 id="datalogging">[DataLogging]</h2>
|
|
<h3 id="parameter-datalogactive">Parameter <code>DataLogActive</code></h3>
|
|
<p>Default Value: <code>true</code></p>
|
|
<h4 id="description_13">Description</h4>
|
|
<p>Please fill me with an explanation and useful links</p>
|
|
<hr />
|
|
<h3 id="parameter-datalogretentionindays">Parameter <code>DataLogRetentionInDays</code></h3>
|
|
<p>Default Value: <code>3</code></p>
|
|
<h4 id="description_14">Description</h4>
|
|
<p>Please fill me with an explanation and useful links</p>
|
|
<hr />
|
|
<h2 id="debug">[Debug]</h2>
|
|
<h3 id="parameter-logfile">Parameter <code>Logfile</code></h3>
|
|
<p>Default Value: <code>1</code></p>
|
|
<h4 id="description_15">Description</h4>
|
|
<p>Please fill me with an explanation and useful links</p>
|
|
<hr />
|
|
<h3 id="parameter-logfileretentionindays_1">Parameter <code>LogfileRetentionInDays</code></h3>
|
|
<p>Default Value: <code>3</code></p>
|
|
<h4 id="description_16">Description</h4>
|
|
<p>Please fill me with an explanation and useful links</p>
|
|
<hr />
|
|
<h2 id="digits">[Digits]</h2>
|
|
<h3 id="parameter-cnngoodthreshold_1">Parameter <code>CNNGoodThreshold</code></h3>
|
|
<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>
|
|
<h4 id="description_17">Description</h4>
|
|
<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>EXPERIMENTAL - NOT WORKING FOR ALL CNNs!</p>
|
|
</div>
|
|
<hr />
|
|
<h3 id="parameter-logimagelocation_1">Parameter <code>LogImageLocation</code></h3>
|
|
<p>Default Value: <code>/log/digit</code></p>
|
|
<h4 id="description_18">Description</h4>
|
|
<p>Location to store separated digit images on the SD-Card for logging.</p>
|
|
<hr />
|
|
<h3 id="parameter-logfileretentionindays_2">Parameter <code>LogfileRetentionInDays</code></h3>
|
|
<p>Default Value: <code>3</code></p>
|
|
<h4 id="description_19">Description</h4>
|
|
<p>Days to keep the separated digit images (<code>0</code> = forever).</p>
|
|
<hr />
|
|
<h3 id="parameter-model_1">Parameter <code>Model</code></h3>
|
|
<p>Default Value: <code>/config/dig-cont_0600_s3.tflite</code></p>
|
|
<h4 id="description_20">Description</h4>
|
|
<p>Path to CNN model file for image recognition. See <a href="../Choosing-the-Model">here</a> for details. </p>
|
|
<hr />
|
|
<h2 id="gpio">[GPIO]</h2>
|
|
<h3 id="parameter-io0">Parameter <code>IO0</code></h3>
|
|
<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>
|
|
<h4 id="description_21">Description</h4>
|
|
<p>Please fill me with an explanation and useful links</p>
|
|
<hr />
|
|
<h3 id="parameter-io1">Parameter <code>IO1</code></h3>
|
|
<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>
|
|
<h4 id="description_22">Description</h4>
|
|
<p>Please fill me with an explanation and useful links</p>
|
|
<hr />
|
|
<h3 id="parameter-io12">Parameter <code>IO12</code></h3>
|
|
<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>
|
|
<h4 id="description_23">Description</h4>
|
|
<p>Please fill me with an explanation and useful links</p>
|
|
<hr />
|
|
<h3 id="parameter-io13">Parameter <code>IO13</code></h3>
|
|
<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>
|
|
<h4 id="description_24">Description</h4>
|
|
<p>Please fill me with an explanation and useful links</p>
|
|
<hr />
|
|
<h3 id="parameter-io3">Parameter <code>IO3</code></h3>
|
|
<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>
|
|
<h4 id="description_25">Description</h4>
|
|
<p>Please fill me with an explanation and useful links</p>
|
|
<hr />
|
|
<h3 id="parameter-io4">Parameter <code>IO4</code></h3>
|
|
<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>
|
|
<h4 id="description_26">Description</h4>
|
|
<p>Please fill me with an explanation and useful links</p>
|
|
<hr />
|
|
<h3 id="parameter-ledcolor">Parameter <code>LEDColor</code></h3>
|
|
<p>Default Value: <code>150 150 150</code></p>
|
|
<h4 id="description_27">Description</h4>
|
|
<p>Please fill me with an explanation and useful links</p>
|
|
<hr />
|
|
<h3 id="parameter-lednumbers">Parameter <code>LEDNumbers</code></h3>
|
|
<p>Default Value: <code>2</code></p>
|
|
<h4 id="description_28">Description</h4>
|
|
<p>Please fill me with an explanation and useful links</p>
|
|
<hr />
|
|
<h3 id="parameter-ledtype">Parameter <code>LEDType</code></h3>
|
|
<p>Default Value: <code>WS2812</code></p>
|
|
<h4 id="description_29">Description</h4>
|
|
<p>Please fill me with an explanation and useful links</p>
|
|
<hr />
|
|
<h3 id="parameter-maintopicmqtt">Parameter <code>MainTopicMQTT</code></h3>
|
|
<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>
|
|
<h4 id="description_30">Description</h4>
|
|
<p>Please fill me with an explanation and useful links</p>
|
|
<hr />
|
|
<h2 id="influxdb">[InfluxDB]</h2>
|
|
<h3 id="parameter-database">Parameter <code>Database</code></h3>
|
|
<p>Default Value: ``</p>
|
|
<h4 id="description_31">Description</h4>
|
|
<p>Please fill me with an explanation and useful links</p>
|
|
<hr />
|
|
<h3 id="parameter-measurement">Parameter <code>Measurement</code></h3>
|
|
<p>Default Value: <code>undefined</code></p>
|
|
<h4 id="description_32">Description</h4>
|
|
<p>Please fill me with an explanation and useful links</p>
|
|
<hr />
|
|
<h3 id="parameter-uri">Parameter <code>Uri</code></h3>
|
|
<p>Default Value: <code>undefined</code></p>
|
|
<h4 id="description_33">Description</h4>
|
|
<p>Please fill me with an explanation and useful links</p>
|
|
<hr />
|
|
<h3 id="parameter-password">Parameter <code>password</code></h3>
|
|
<p>Default Value: <code>undefined</code></p>
|
|
<h4 id="description_34">Description</h4>
|
|
<p>Please fill me with an explanation and useful links</p>
|
|
<hr />
|
|
<h3 id="parameter-user">Parameter <code>user</code></h3>
|
|
<p>Default Value: <code>undefined</code></p>
|
|
<h4 id="description_35">Description</h4>
|
|
<p>Please fill me with an explanation and useful links</p>
|
|
<hr />
|
|
<h2 id="mqtt">[MQTT]</h2>
|
|
<h3 id="parameter-clientid">Parameter <code>ClientID</code></h3>
|
|
<p>Default Value: <code>watermeter</code></p>
|
|
<h4 id="description_36">Description</h4>
|
|
<p>Please fill me with an explanation and useful links</p>
|
|
<hr />
|
|
<h3 id="parameter-homeassistantdiscovery">Parameter <code>HomeassistantDiscovery</code></h3>
|
|
<p>Default Value: <code>true</code></p>
|
|
<h4 id="description_37">Description</h4>
|
|
<p>Please fill me with an explanation and useful links</p>
|
|
<hr />
|
|
<h3 id="parameter-maintopic">Parameter <code>MainTopic</code></h3>
|
|
<p>Default Value: <code>watermeter</code></p>
|
|
<h4 id="description_38">Description</h4>
|
|
<p>Please fill me with an explanation and useful links</p>
|
|
<hr />
|
|
<h3 id="parameter-metertype">Parameter <code>MeterType</code></h3>
|
|
<p>Default Value: <code>other</code></p>
|
|
<h4 id="description_39">Description</h4>
|
|
<p>Please fill me with an explanation and useful links</p>
|
|
<hr />
|
|
<h3 id="parameter-setretainflag">Parameter <code>SetRetainFlag</code></h3>
|
|
<p>Default Value: <code>true</code></p>
|
|
<h4 id="description_40">Description</h4>
|
|
<p>Please fill me with an explanation and useful links</p>
|
|
<hr />
|
|
<h3 id="parameter-uri_1">Parameter <code>Uri</code></h3>
|
|
<p>Default Value: <code>mqtt://IP-ADRESS:1883</code></p>
|
|
<h4 id="description_41">Description</h4>
|
|
<p>Please fill me with an explanation and useful links</p>
|
|
<hr />
|
|
<h3 id="parameter-password_1">Parameter <code>password</code></h3>
|
|
<p>Default Value: <code>PASSWORD</code></p>
|
|
<h4 id="description_42">Description</h4>
|
|
<p>Please fill me with an explanation and useful links</p>
|
|
<hr />
|
|
<h3 id="parameter-user_1">Parameter <code>user</code></h3>
|
|
<p>Default Value: <code>USERNAME</code></p>
|
|
<h4 id="description_43">Description</h4>
|
|
<p>Please fill me with an explanation and useful links</p>
|
|
<hr />
|
|
<h2 id="makeimage">[MakeImage]</h2>
|
|
<h3 id="parameter-brightness">Parameter <code>Brightness</code></h3>
|
|
<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>
|
|
<h4 id="description_44">Description</h4>
|
|
<p>Image Brightness (<code>-2</code> .. <code>2</code>) </p>
|
|
<hr />
|
|
<h3 id="parameter-contrast">Parameter <code>Contrast</code></h3>
|
|
<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>
|
|
<h4 id="description_45">Description</h4>
|
|
<p>Image Contrast (<code>-2</code> .. <code>2</code>)</p>
|
|
<div class="admonition note">
|
|
<p class="admonition-title">Note</p>
|
|
<p>Camera driver is not fully supporting this setting yet (no impact on image) </p>
|
|
</div>
|
|
<hr />
|
|
<h3 id="parameter-demo">Parameter <code>Demo</code></h3>
|
|
<p>Default Value: <code>false</code></p>
|
|
<h4 id="description_46">Description</h4>
|
|
<p>Enable to use demo images instead of the real camera images.
|
|
Make sure to have a <code>/demo</code> folder on your SD-Card and it contains the expected files!
|
|
Check <a href="../Demo-Mode">here</a> for details. </p>
|
|
<hr />
|
|
<h3 id="parameter-fixedexposure">Parameter <code>FixedExposure</code></h3>
|
|
<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>
|
|
<h4 id="description_47">Description</h4>
|
|
<p>Fixes the illumination setting of camera at the startup and uses this later -->
|
|
individual round is faster.</p>
|
|
<hr />
|
|
<h3 id="parameter-imagequality">Parameter <code>ImageQuality</code></h3>
|
|
<p>Default Value: <code>12</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>
|
|
<h4 id="description_48">Description</h4>
|
|
<p>Quality index for pictures. <code>0</code> (high) .. <code>63</code> (low)</p>
|
|
<div class="admonition warning">
|
|
<p class="admonition-title">Warning</p>
|
|
<p>Values below <code>12</code> can result in reboots as the image gets larger and might no longer fit in the available RAM!</p>
|
|
</div>
|
|
<hr />
|
|
<h3 id="parameter-imagesize">Parameter <code>ImageSize</code></h3>
|
|
<p>Default Value: <code>VGA</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>
|
|
<h4 id="description_49">Description</h4>
|
|
<p>Size of the camera picture.
|
|
Available options:</p>
|
|
<ul>
|
|
<li><code>VGA</code> (640 x 480 pixel)</li>
|
|
<li><code>QVGA</code> (320 x 240 pixel)</li>
|
|
</ul>
|
|
<hr />
|
|
<h3 id="parameter-ledintensity">Parameter <code>LEDIntensity</code></h3>
|
|
<p>Default Value: <code>50</code></p>
|
|
<div class="admonition warning">
|
|
<p class="admonition-title">Warning</p>
|
|
<p>This is an <strong>Expert Parameter</strong>! Only change it if you understand what it does!</p>
|
|
</div>
|
|
<h4 id="description_50">Description</h4>
|
|
<p>Please fill me with an explanation and useful links</p>
|
|
<hr />
|
|
<h3 id="parameter-logimagelocation_2">Parameter <code>LogImageLocation</code></h3>
|
|
<p>Default Value: <code>/log/source</code></p>
|
|
<h4 id="description_51">Description</h4>
|
|
<p>Location on the SD-Card to store the raw images for logging.</p>
|
|
<hr />
|
|
<h3 id="parameter-logfileretentionindays_3">Parameter <code>LogfileRetentionInDays</code></h3>
|
|
<p>Default Value: <code>15</code></p>
|
|
<h4 id="description_52">Description</h4>
|
|
<p>Number of days to keep the raw images (<code>0</code> = forever)</p>
|
|
<hr />
|
|
<h3 id="parameter-saturation">Parameter <code>Saturation</code></h3>
|
|
<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>
|
|
<h4 id="description_53">Description</h4>
|
|
<p>Image Saturation (<code>-2</code> .. <code>2</code>)</p>
|
|
<div class="admonition note">
|
|
<p class="admonition-title">Note</p>
|
|
<p>Camera driver is not fully supporting this setting yet (no impact on image)!</p>
|
|
</div>
|
|
<hr />
|
|
<h3 id="parameter-waitbeforetakingpicture">Parameter <code>WaitBeforeTakingPicture</code></h3>
|
|
<p>Default Value: <code>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>
|
|
<h4 id="description_54">Description</h4>
|
|
<p>Waiting time between switching illumination on and taking the picture (in seconds)-</p>
|
|
<hr />
|
|
<h2 id="postprocessing">[PostProcessing]</h2>
|
|
<h3 id="parameter-numberanalogdigitaltransitionstart">Parameter <code><NUMBER>.AnalogDigitalTransitionStart</code></h3>
|
|
<p>Default Value: <code>9.2</code></p>
|
|
<h4 id="description_55">Description</h4>
|
|
<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>
|
|
<hr />
|
|
<h3 id="parameter-numberdecimalshift">Parameter <code><NUMBER>.DecimalShift</code></h3>
|
|
<p>Default Value: <code>0</code></p>
|
|
<h4 id="description_56">Description</h4>
|
|
<p>Shift the decimal separator (positiv or negativ).
|
|
Eg. to move from 'm³' to 'liter' (1 m³ equals 1000 liters), you need to set it to +3.</p>
|
|
<hr />
|
|
<h3 id="parameter-numberextendedresolution">Parameter <code><NUMBER>.ExtendedResolution</code></h3>
|
|
<p>Default Value: <code>false</code></p>
|
|
<h4 id="description_57">Description</h4>
|
|
<p>Use the decimal place of the last analog counter for increased accuracy.</p>
|
|
<hr />
|
|
<h3 id="parameter-numberignoreleadingnan">Parameter <code><NUMBER>.IgnoreLeadingNaN</code></h3>
|
|
<p>Default Value: <code>true</code></p>
|
|
<h4 id="description_58">Description</h4>
|
|
<p>Leading <code>N</code>'s will be deleted before further processing.</p>
|
|
<p>This is only relevant for models which use <code>N</code>!</p>
|
|
<hr />
|
|
<h3 id="parameter-numbermaxratetype">Parameter <code><NUMBER>.MaxRateType</code></h3>
|
|
<p>Default Value: <code>AbsoluteChange</code></p>
|
|
<h4 id="description_59">Description</h4>
|
|
<p>Defines if the <strong>Change Rate</strong> compared to the previous value is calculated as absolute change (<code>AbsoluteChange</code>) or
|
|
as rate normalized to the interval (<code>RateChange</code> = change/minute).</p>
|
|
<hr />
|
|
<h3 id="parameter-numbermaxratevalue">Parameter <code><NUMBER>.MaxRateValue</code></h3>
|
|
<p>Default Value: <code>0.05</code></p>
|
|
<h4 id="description_60">Description</h4>
|
|
<p>Maximum change of a reading.</p>
|
|
<p>Depending on the settings of <code><NUMBER>.MaxRateType</code> it is either treated as <code>absolute</code> or <code>relative</code>!</p>
|
|
<hr />
|
|
<h3 id="parameter-numbersallownegativerates">Parameter <code><NUMBERS>.AllowNegativeRates</code></h3>
|
|
<p>Default Value: <code>false</code></p>
|
|
<h4 id="description_61">Description</h4>
|
|
<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 />
|
|
<h3 id="parameter-allownegativerates">Parameter <code>AllowNegativeRates</code></h3>
|
|
<p>Default Value: <code>false</code></p>
|
|
<h4 id="description_62">Description</h4>
|
|
<p>Please fill me with an explanation and useful links</p>
|
|
<hr />
|
|
<h3 id="parameter-checkdigitincreaseconsistency">Parameter <code>CheckDigitIncreaseConsistency</code></h3>
|
|
<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>
|
|
<h4 id="description_63">Description</h4>
|
|
<p>An additional consistency check.
|
|
It especially improves the zero crossing check between digits.</p>
|
|
<hr />
|
|
<h3 id="parameter-errormessage">Parameter <code>ErrorMessage</code></h3>
|
|
<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>
|
|
<h4 id="description_64">Description</h4>
|
|
<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 />
|
|
<h3 id="parameter-prevalueagestartup">Parameter <code>PreValueAgeStartup</code></h3>
|
|
<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>
|
|
<h4 id="description_65">Description</h4>
|
|
<p>Time in minutes, how long a previous read value is valid after reboot.</p>
|
|
<hr />
|
|
<h3 id="parameter-prevalueuse">Parameter <code>PreValueUse</code></h3>
|
|
<p>Default Value: <code>true</code></p>
|
|
<h4 id="description_66">Description</h4>
|
|
<p>Use the previous value (value from previous round) for consistency checks.
|
|
This also work through a reboot of the device!</p>
|
|
<hr />
|
|
<h2 id="system">[System]</h2>
|
|
<h3 id="parameter-autoadjustsummertime">Parameter <code>AutoAdjustSummertime</code></h3>
|
|
<p>Default Value: <code>false</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>
|
|
<h4 id="description_67">Description</h4>
|
|
<p>Please fill me with an explanation and useful links</p>
|
|
<hr />
|
|
<h3 id="parameter-hostname">Parameter <code>Hostname</code></h3>
|
|
<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>
|
|
<h4 id="description_68">Description</h4>
|
|
<p>Please fill me with an explanation and useful links</p>
|
|
<hr />
|
|
<h3 id="parameter-setupmode">Parameter <code>SetupMode</code></h3>
|
|
<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>
|
|
<h4 id="description_69">Description</h4>
|
|
<p>Please fill me with an explanation and useful links</p>
|
|
<hr />
|
|
<h3 id="parameter-timeserver">Parameter <code>TimeServer</code></h3>
|
|
<p>Default Value: <code>pool.ntp.org</code></p>
|
|
<h4 id="description_70">Description</h4>
|
|
<p>Please fill me with an explanation and useful links</p>
|
|
<hr />
|
|
<h3 id="parameter-timezone">Parameter <code>TimeZone</code></h3>
|
|
<p>Default Value: <code>CET-1CEST,M3.5.0,M10.5.0/3</code></p>
|
|
<h4 id="description_71">Description</h4>
|
|
<p>Please fill me with an explanation and useful links</p>
|
|
<hr />
|
|
|
|
</div>
|
|
</div><footer>
|
|
<div class="rst-footer-buttons" role="navigation" aria-label="Footer Navigation">
|
|
<a href="../ota/" class="btn btn-neutral float-left" title="Over-The-Air (OTA) Update"><span class="icon icon-circle-arrow-left"></span> Previous</a>
|
|
<a href="../Integration-Home-Assistant/" class="btn btn-neutral float-right" title="Integration into Home Assistant">Next <span class="icon icon-circle-arrow-right"></span></a>
|
|
</div>
|
|
|
|
<hr/>
|
|
|
|
<div role="contentinfo">
|
|
<!-- Copyright etc -->
|
|
</div>
|
|
|
|
Built with <a href="https://www.mkdocs.org/">MkDocs</a> using a <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
|
|
</footer>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
</section>
|
|
|
|
</div>
|
|
|
|
<div class="rst-versions" role="note" aria-label="Versions">
|
|
<span class="rst-current-version" data-toggle="rst-current-version">
|
|
|
|
<span>
|
|
<a href="https://github.com/jomjol/AI-on-the-edge-device-docs" class="fa fa-github" style="color: #fcfcfc"> GitHub</a>
|
|
</span>
|
|
|
|
|
|
<span><a href="../ota/" style="color: #fcfcfc">« Previous</a></span>
|
|
|
|
|
|
<span><a href="../Integration-Home-Assistant/" style="color: #fcfcfc">Next »</a></span>
|
|
|
|
</span>
|
|
</div>
|
|
<script>var base_url = '..';</script>
|
|
<script src="../js/theme_extra.js" defer></script>
|
|
<script src="../js/theme.js" defer></script>
|
|
<script src="../search/main.js" defer></script>
|
|
<script defer>
|
|
window.onload = function () {
|
|
SphinxRtdTheme.Navigation.enable(true);
|
|
};
|
|
</script>
|
|
|
|
</body>
|
|
</html>
|