Move param doc (#2843)

moved param doc from docs repo to here
This commit is contained in:
CaCO3
2024-01-31 21:53:56 +01:00
committed by GitHub
parent 4990858101
commit 8410df6144
104 changed files with 958 additions and 18 deletions

View File

@@ -0,0 +1,5 @@
# Parameter `AllowNegativeRates`
!!! Warning
This parameter is unused!
Use [`NUMBER.AllowNegativeRates`](../Parameters/#PostProcessing-NUMBER.AllowNegativeRates) instead!

View File

@@ -0,0 +1,8 @@
# Parameter `CheckDigitIncreaseConsistency`
Default Value: `false`
!!! Warning
This is an **Expert Parameter**! Only change it if you understand what it does!
An additional consistency check.
It especially improves the zero crossing check between digits.

View File

@@ -0,0 +1,8 @@
# Parameter `ErrorMessage`
Default Value: `true`
!!! Warning
This is an **Expert Parameter**! Only change it if you understand what it does!
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, ...).

View File

@@ -0,0 +1,7 @@
# Parameter `<NUMBERS>.AllowNegativeRates`
Default Value: `false`
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!

View File

@@ -0,0 +1,9 @@
# Parameter `<NUMBER>.AnalogDigitalTransitionStart`
Default Value: `9.2`
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](../Watermeter-specific-analog---digital-transition) for details.
Range: `6.0` .. `9.9`.

View File

@@ -0,0 +1,5 @@
# Parameter `<NUMBER>.DecimalShift`
Default Value: `0`
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`.

View File

@@ -0,0 +1,7 @@
# Parameter `<NUMBER>.ExtendedResolution`
Default Value: `false`
Use the decimal place of the last analog counter for increased accuracy.
!!! Note
This parameter is only supported on the `*-class*` and `*-const` models! See [Choosing-the-Model](../Choosing-the-Model) for details.

View File

@@ -0,0 +1,6 @@
# Parameter `<NUMBER>.IgnoreLeadingNaN`
Default Value: `true`
Leading `N`'s will be deleted before further processing.
This is only relevant for models which use `N`!
See [here](../Choosing-the-Model) for details.

View File

@@ -0,0 +1,5 @@
# Parameter `<NUMBER>.MaxRateType`
Default Value: `AbsoluteChange`
Defines if the **Change Rate** is calculated as the difference between the last two readings (`AbsoluteChange` = difference) or
as the difference normalized to the interval (`RateChange` = difference per minute).

View File

@@ -0,0 +1,6 @@
# Parameter `<NUMBER>.MaxRateValue`
Default Value: `0,05`
Maximum allowed change between two readings, if exceeded the last reading will be rejected. Depending on the settings of `<NUMBER>.MaxRateType` the `MaxRateValue` is either treated as the difference between the two measurements (`AbsoluteChange` = difference) not taking the set time interval into account or as the difference normalized to the interval (`RateChange` = difference per minute).
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 `600,00` and it's read incorrectly as` 610,00`, all measurements will be skipped until the counter reaches `610,00`. Setting the MaxRateValue to `0,05` leads to a rejection of all readings with a difference `> 0,05`, in this case `610,00`. The rejection also applies to correct readings with a difference `> 0,05`!

View File

@@ -0,0 +1,7 @@
# Parameter `PreValueAgeStartup`
Default Value: `720`
!!! Warning
This is an **Expert Parameter**! Only change it if you understand what it does!
Time in minutes, how long a previous read value is valid after reboot.

View File

@@ -0,0 +1,5 @@
# Parameter `PreValueUse`
Default Value: `true`
Use the previous value (value from previous round) for consistency checks.
This also works through a reboot of the device!