Parameters
This page lists all available Configuration Parameters.
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.
Note
This is an auto-generated page! See the README for details!
[Alignment]
Parameter AlignmentAlgo
Default Value: Default
Warning
This is an Expert Parameter! Only change it if you understand what it does!
Description
Algorithm used for the alignment step.
Default: Use only red color channelHighAccuracy: Use all 3 color Channels (3x slower)Fast: First time useHighAccuracy, then only check if the image is shifted
Parameter FlipImageSize
Default Value: false
Note
This parameter is not accessible through the Web Interface Configuration Page!
Description
Please fill me with an explanation and useful links
Parameter InitialMirror
Default Value: false
Note
This parameter is not accessible through the Web Interface Configuration Page!
Description
Please fill me with an explanation and useful links
Parameter InitialRotate
Default Value: 179
Note
This parameter is not accessible through the Web Interface Configuration Page!
Description
Please fill me with an explanation and useful links
Parameter SearchFieldX
Default Value: 20
Warning
This is an Expert Parameter! Only change it if you understand what it does!
Description
x size (width) in which the reference is searched.
Parameter SearchFieldY
Default Value: 20
Warning
This is an Expert Parameter! Only change it if you understand what it does!
Description
y size (height) in which the reference is searched.
[Analog]
Parameter CNNGoodThreshold
Default Value: 0.5
Warning
This is an Expert Parameter! Only change it if you understand what it does!
Description
Threshold above which the classification should be to accept the value (only meaningful for digits).
Warning
EXPERIMENTAL - NOT WORKING FOR ALL CNNs!
Parameter ExtendedResolution
Default Value: true
Description
Please fill me with an explanation and useful links
Parameter LogImageLocation
Default Value: /log/analog
Description
Location to store separated analog images on the SD-Card for logging.
Parameter LogfileRetentionInDays
Default Value: 3
Description
Days to keep the separated analog images (0 = forever).
Parameter Model
Default Value: /config/ana-cont_11.3.1_s2.tflite
Description
Path to CNN model file for image recognition. See here for details.
[AutoTimer]
Parameter AutoStart
Default Value: true
Warning
This is an Expert Parameter! Only change it if you understand what it does!
Description
Please fill me with an explanation and useful links
Parameter Intervall
Default Value: 5
Description
Please fill me with an explanation and useful links
[DataLogging]
Parameter DataLogActive
Default Value: true
Description
Please fill me with an explanation and useful links
Parameter DataLogRetentionInDays
Default Value: 3
Description
Please fill me with an explanation and useful links
[Debug]
Parameter Logfile
Default Value: 1
Description
Please fill me with an explanation and useful links
Parameter LogfileRetentionInDays
Default Value: 3
Description
Please fill me with an explanation and useful links
[Digits]
Parameter CNNGoodThreshold
Default Value: 0.5
Warning
This is an Expert Parameter! Only change it if you understand what it does!
Description
Threshold above which the classification should be to accept the value (only meaningful for digits).
Warning
EXPERIMENTAL - NOT WORKING FOR ALL CNNs!
Parameter LogImageLocation
Default Value: /log/digit
Description
Location to store separated digit images on the SD-Card for logging.
Parameter LogfileRetentionInDays
Default Value: 3
Description
Days to keep the separated digit images (0 = forever).
Parameter Model
Default Value: /config/dig-cont_0600_s3.tflite
Description
Path to CNN model file for image recognition. See here for details.
[GPIO]
Parameter IO0
Default Value: input disabled 10 false false
Warning
This is an Expert Parameter! Only change it if you understand what it does!
Description
Please fill me with an explanation and useful links
Parameter IO1
Default Value: input disabled 10 false false
Warning
This is an Expert Parameter! Only change it if you understand what it does!
Description
Please fill me with an explanation and useful links
Parameter IO12
Default Value: input-pullup disabled 10 false false
Warning
This is an Expert Parameter! Only change it if you understand what it does!
Description
Please fill me with an explanation and useful links
Parameter IO13
Default Value: input-pullup disabled 10 false false
Warning
This is an Expert Parameter! Only change it if you understand what it does!
Description
Please fill me with an explanation and useful links
Parameter IO3
Default Value: input disabled 10 false false
Warning
This is an Expert Parameter! Only change it if you understand what it does!
Description
Please fill me with an explanation and useful links
Parameter IO4
Default Value: built-in-led disabled 10 false false
Warning
This is an Expert Parameter! Only change it if you understand what it does!
Description
Please fill me with an explanation and useful links
Parameter LEDColor
Default Value: 150 150 150
Description
Please fill me with an explanation and useful links
Parameter LEDNumbers
Default Value: 2
Description
Please fill me with an explanation and useful links
Parameter LEDType
Default Value: WS2812
Description
Please fill me with an explanation and useful links
Parameter MainTopicMQTT
Default Value: wasserzaehler/GPIO
Note
This parameter is not accessible through the Web Interface Configuration Page!
Description
Please fill me with an explanation and useful links
[InfluxDB]
Parameter Database
Default Value: ``
Description
Please fill me with an explanation and useful links
Parameter Measurement
Default Value: undefined
Description
Please fill me with an explanation and useful links
Parameter Uri
Default Value: undefined
Description
Please fill me with an explanation and useful links
Parameter password
Default Value: undefined
Description
Please fill me with an explanation and useful links
Parameter user
Default Value: undefined
Description
Please fill me with an explanation and useful links
[MQTT]
Parameter ClientID
Default Value: watermeter
Description
Please fill me with an explanation and useful links
Parameter HomeassistantDiscovery
Default Value: true
Description
Please fill me with an explanation and useful links
Parameter MainTopic
Default Value: watermeter
Description
Please fill me with an explanation and useful links
Parameter MeterType
Default Value: other
Description
Please fill me with an explanation and useful links
Parameter SetRetainFlag
Default Value: true
Description
Please fill me with an explanation and useful links
Parameter Uri
Default Value: mqtt://IP-ADRESS:1883
Description
Please fill me with an explanation and useful links
Parameter password
Default Value: PASSWORD
Description
Please fill me with an explanation and useful links
Parameter user
Default Value: USERNAME
Description
Please fill me with an explanation and useful links
[MakeImage]
Parameter Brightness
Default Value: 0
Warning
This is an Expert Parameter! Only change it if you understand what it does!
Description
Image Brightness (-2 .. 2)
Parameter Contrast
Default Value: 0
Warning
This is an Expert Parameter! Only change it if you understand what it does!
Description
Image Contrast (-2 .. 2)
Note
Camera driver is not fully supporting this setting yet (no impact on image)
Parameter Demo
Default Value: false
Description
Enable to use demo images instead of the real camera images.
Make sure to have a /demo folder on your SD-Card and it contains the expected files!
Check here for details.
Parameter FixedExposure
Default Value: false
Warning
This is an Expert Parameter! Only change it if you understand what it does!
Description
Fixes the illumination setting of camera at the startup and uses this later --> individual round is faster.
Parameter ImageQuality
Default Value: 12
Warning
This is an Expert Parameter! Only change it if you understand what it does!
Description
Quality index for pictures. 0 (high) .. 63 (low)
Warning
Values below 12 can result in reboots as the image gets larger and might no longer fit in the available RAM!
Parameter ImageSize
Default Value: VGA
Warning
This is an Expert Parameter! Only change it if you understand what it does!
Description
Size of the camera picture. Available options:
VGA(640 x 480 pixel)QVGA(320 x 240 pixel)
Parameter LEDIntensity
Default Value: 50
Warning
This is an Expert Parameter! Only change it if you understand what it does!
Description
Please fill me with an explanation and useful links
Parameter LogImageLocation
Default Value: /log/source
Description
Location on the SD-Card to store the raw images for logging.
Parameter LogfileRetentionInDays
Default Value: 15
Description
Number of days to keep the raw images (0 = forever)
Parameter Saturation
Default Value: 0
Warning
This is an Expert Parameter! Only change it if you understand what it does!
Description
Image Saturation (-2 .. 2)
Note
Camera driver is not fully supporting this setting yet (no impact on image)!
Parameter WaitBeforeTakingPicture
Default Value: 5
Warning
This is an Expert Parameter! Only change it if you understand what it does!
Description
Waiting time between switching illumination on and taking the picture (in seconds)-
[PostProcessing]
Parameter <NUMBER>.AnalogDigitalTransitionStart
Default Value: 9.2
Description
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 here for details.
Parameter <NUMBER>.DecimalShift
Default Value: 0
Description
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.
Parameter <NUMBER>.ExtendedResolution
Default Value: false
Description
Use the decimal place of the last analog counter for increased accuracy.
Parameter <NUMBER>.IgnoreLeadingNaN
Default Value: true
Description
Leading N's will be deleted before further processing.
This is only relevant for models which use N!
Parameter <NUMBER>.MaxRateType
Default Value: AbsoluteChange
Description
Defines if the Change Rate compared to the previous value is calculated as absolute change (AbsoluteChange) or
as rate normalized to the interval (RateChange = change/minute).
Parameter <NUMBER>.MaxRateValue
Default Value: 0.05
Description
Maximum change of a reading.
Depending on the settings of <NUMBER>.MaxRateType it is either treated as absolute or relative!
Parameter <NUMBERS>.AllowNegativeRates
Default Value: false
Description
Allow a meter to count backwards (decreasing values).
Note
This is unusual (it means there is a negative rate) and not wanted in most cases!
Parameter AllowNegativeRates
Default Value: false
Description
Please fill me with an explanation and useful links
Parameter CheckDigitIncreaseConsistency
Default Value: false
Warning
This is an Expert Parameter! Only change it if you understand what it does!
Description
An additional consistency check. It especially improves the zero crossing check between digits.
Parameter ErrorMessage
Default Value: true
Warning
This is an Expert Parameter! Only change it if you understand what it does!
Description
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, ...).
Parameter PreValueAgeStartup
Default Value: 720
Warning
This is an Expert Parameter! Only change it if you understand what it does!
Description
Time in minutes, how long a previous read value is valid after reboot.
Parameter PreValueUse
Default Value: true
Description
Use the previous value (value from previous round) for consistency checks. This also work through a reboot of the device!
[System]
Parameter AutoAdjustSummertime
Default Value: false
Note
This parameter is not accessible through the Web Interface Configuration Page!
Description
Please fill me with an explanation and useful links
Parameter Hostname
Default Value: undefined
Warning
This is an Expert Parameter! Only change it if you understand what it does!
Description
Please fill me with an explanation and useful links
Parameter SetupMode
Default Value: true
Note
This parameter is not accessible through the Web Interface Configuration Page!
Description
Please fill me with an explanation and useful links
Parameter TimeServer
Default Value: pool.ntp.org
Description
Please fill me with an explanation and useful links
Parameter TimeZone
Default Value: CET-1CEST,M3.5.0,M10.5.0/3
Description
Please fill me with an explanation and useful links