diff --git a/param-docs/parameter-pages/InfluxDB/NUMBER.Field.md b/param-docs/parameter-pages/InfluxDB/NUMBER.Field.md index 8035ca6b..dcf4def4 100644 --- a/param-docs/parameter-pages/InfluxDB/NUMBER.Field.md +++ b/param-docs/parameter-pages/InfluxDB/NUMBER.Field.md @@ -1,4 +1,7 @@ -# Parameter `.Field` +# Parameter `Field` Default Value: `undefined` Dedicated definition of the field for InfluxDB use for saving in the Influx database (e.g.: "watermeter/value"). + +!!! Note + This parameter must be prefixed with `` followed by a dot (eg. `main.Field`). `` is the name of the number sequence defined in the ROI's. diff --git a/param-docs/parameter-pages/InfluxDBv2/NUMBER.Field.md b/param-docs/parameter-pages/InfluxDBv2/NUMBER.Field.md index 58611ad8..33b26f31 100644 --- a/param-docs/parameter-pages/InfluxDBv2/NUMBER.Field.md +++ b/param-docs/parameter-pages/InfluxDBv2/NUMBER.Field.md @@ -1,4 +1,7 @@ -# Parameter `.Field` +# Parameter `Field` Default Value: `undefined` Field for InfluxDB v2 to use for saving. + +!!! Note + This parameter must be prefixed with `` followed by a dot (eg. `main.Field`). `` is the name of the number sequence defined in the ROI's. diff --git a/param-docs/parameter-pages/MQTT/NUMBER.DomoticzIDX.md b/param-docs/parameter-pages/MQTT/NUMBER.DomoticzIDX.md index 8ec2c70b..b4c2dec3 100644 --- a/param-docs/parameter-pages/MQTT/NUMBER.DomoticzIDX.md +++ b/param-docs/parameter-pages/MQTT/NUMBER.DomoticzIDX.md @@ -1,4 +1,7 @@ -# Parameter `.DomoticzIDX` +# Parameter `DomoticzIDX` Default Value: `0` The Idx number for the counter device. Can be obtained from the devices setup page on the Domoticz system. + +!!! Note + This parameter must be prefixed with `` followed by a dot (eg. `main.DomoticzIDX`). `` is the name of the number sequence defined in the ROI's. diff --git a/param-docs/parameter-pages/PostProcessing/NUMBER.AnalogToDigitTransitionStart.md b/param-docs/parameter-pages/PostProcessing/NUMBER.AnalogToDigitTransitionStart.md index 8d2aacf5..653d997a 100644 --- a/param-docs/parameter-pages/PostProcessing/NUMBER.AnalogToDigitTransitionStart.md +++ b/param-docs/parameter-pages/PostProcessing/NUMBER.AnalogToDigitTransitionStart.md @@ -1,4 +1,4 @@ -# Parameter `.AnalogToDigitTransitionStart` +# Parameter `AnalogToDigitTransitionStart` Default Value: `9.2` This can be used if you have wrong values, but the recognition of the individual ROIs are correct. @@ -7,3 +7,6 @@ Set it here. Only used on combination of digits and analog pointers. See [here](../Watermeter-specific-analog---digit-transition) for details. Range: `6.0` .. `9.9`. + +!!! Note + This parameter must be prefixed with `` followed by a dot (eg. `main.AnalogToDigitTransitionStart`). `` is the name of the number sequence defined in the ROI's. diff --git a/param-docs/parameter-pages/PostProcessing/NUMBER.ChangeRateThreshold.md b/param-docs/parameter-pages/PostProcessing/NUMBER.ChangeRateThreshold.md index d0b4b29b..f3a61948 100644 --- a/param-docs/parameter-pages/PostProcessing/NUMBER.ChangeRateThreshold.md +++ b/param-docs/parameter-pages/PostProcessing/NUMBER.ChangeRateThreshold.md @@ -1,4 +1,4 @@ -# Parameter `.ChangeRateThreshold` +# Parameter `ChangeRateThreshold` Default Value: `2` Range: `1` .. `9`. @@ -9,6 +9,9 @@ This parameter is intended to compensate for small reading fluctuations that occ 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. +!!! Note + This parameter must be prefixed with `` followed by a dot (eg. `main.ChangeRateThreshold`). `` is the name of the number sequence defined in the ROI's. + ## Example - Smallest ROI provides value for `0.000'x` (Eg. a water meter with 4 pointers behind the decimal point) diff --git a/param-docs/parameter-pages/PostProcessing/NUMBER.DecimalShift.md b/param-docs/parameter-pages/PostProcessing/NUMBER.DecimalShift.md index 604bb020..9fc7e79f 100644 --- a/param-docs/parameter-pages/PostProcessing/NUMBER.DecimalShift.md +++ b/param-docs/parameter-pages/PostProcessing/NUMBER.DecimalShift.md @@ -1,5 +1,8 @@ -# Parameter `.DecimalShift` +# Parameter `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`. + +!!! Note + This parameter must be prefixed with `` followed by a dot (eg. `main.DecimalShift`). `` is the name of the number sequence defined in the ROI's. diff --git a/param-docs/parameter-pages/PostProcessing/NUMBER.ExtendedResolution.md b/param-docs/parameter-pages/PostProcessing/NUMBER.ExtendedResolution.md index 3689e6f2..086c5eb2 100644 --- a/param-docs/parameter-pages/PostProcessing/NUMBER.ExtendedResolution.md +++ b/param-docs/parameter-pages/PostProcessing/NUMBER.ExtendedResolution.md @@ -1,7 +1,10 @@ -# Parameter `.ExtendedResolution` +# Parameter `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. + +!!! Note + This parameter must be prefixed with `` followed by a dot (eg. `main.ExtendedResolution`). `` is the name of the number sequence defined in the ROI's. diff --git a/param-docs/parameter-pages/PostProcessing/NUMBER.IgnoreLeadingNaN.md b/param-docs/parameter-pages/PostProcessing/NUMBER.IgnoreLeadingNaN.md index 5fa11ab7..ee045b5b 100644 --- a/param-docs/parameter-pages/PostProcessing/NUMBER.IgnoreLeadingNaN.md +++ b/param-docs/parameter-pages/PostProcessing/NUMBER.IgnoreLeadingNaN.md @@ -1,6 +1,9 @@ -# Parameter `.IgnoreLeadingNaN` +# Parameter `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. + +!!! Note + This parameter must be prefixed with `` followed by a dot (eg. `main.IgnoreLeadingNaN`). `` is the name of the number sequence defined in the ROI's. diff --git a/param-docs/parameter-pages/PostProcessing/NUMBER.MaxRateType.md b/param-docs/parameter-pages/PostProcessing/NUMBER.MaxRateType.md index aab9d29b..d9aab8eb 100644 --- a/param-docs/parameter-pages/PostProcessing/NUMBER.MaxRateType.md +++ b/param-docs/parameter-pages/PostProcessing/NUMBER.MaxRateType.md @@ -1,5 +1,8 @@ -# Parameter `.MaxRateType` +# Parameter `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). + +!!! Note + This parameter must be prefixed with `` followed by a dot (eg. `main.MaxRateType`). `` is the name of the number sequence defined in the ROI's. diff --git a/param-docs/parameter-pages/PostProcessing/NUMBER.MaxRateValue.md b/param-docs/parameter-pages/PostProcessing/NUMBER.MaxRateValue.md index 98bb0afd..0562c283 100644 --- a/param-docs/parameter-pages/PostProcessing/NUMBER.MaxRateValue.md +++ b/param-docs/parameter-pages/PostProcessing/NUMBER.MaxRateValue.md @@ -1,6 +1,9 @@ -# Parameter `.MaxRateValue` +# Parameter `MaxRateValue` Default Value: `0,05` Maximum allowed change between two readings, if exceeded the last reading will be rejected. Depending on the settings of `.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`! + +!!! Note + This parameter must be prefixed with `` followed by a dot (eg. `main.MaxRateValue`). `` is the name of the number sequence defined in the ROI's.