Browse Source

clarify the parameter prefix

CaCO3 9 tháng trước cách đây
mục cha
commit
74e150cfab

+ 1 - 1
param-docs/parameter-pages/InfluxDB/NUMBER.Field.md

@@ -4,4 +4,4 @@ Default Value: `undefined`
 Dedicated definition of the field for InfluxDB use for saving in the Influx database (e.g.: "watermeter/value").
 Dedicated definition of the field for InfluxDB use for saving in the Influx database (e.g.: "watermeter/value").
 
 
 !!! Note
 !!! Note
-    This parameter must be prefixed with `<NUMBER>` followed by a dot (eg. `main.Field`). `<NUMBER>` is the name of the number sequence  defined in the ROI's.
+    If you edit the config file manually, you must prefix this parameter with `<NUMBER>` followed by a dot (eg. `main.Field`). The reason is that this parameter is specific for each `<NUMBER>` (`<NUMBER>` is the name of the number sequence defined in the ROI's).

+ 1 - 1
param-docs/parameter-pages/InfluxDBv2/NUMBER.Field.md

@@ -4,4 +4,4 @@ Default Value: `undefined`
 Field for InfluxDB v2 to use for saving.
 Field for InfluxDB v2 to use for saving.
 
 
 !!! Note
 !!! Note
-    This parameter must be prefixed with `<NUMBER>` followed by a dot (eg. `main.Field`). `<NUMBER>` is the name of the number sequence  defined in the ROI's.
+    If you edit the config file manually, you must prefix this parameter with `<NUMBER>` followed by a dot (eg. `main.Field`). The reason is that this parameter is specific for each `<NUMBER>` (`<NUMBER>` is the name of the number sequence defined in the ROI's).

+ 1 - 1
param-docs/parameter-pages/MQTT/NUMBER.DomoticzIDX.md

@@ -4,4 +4,4 @@ Default Value: `0`
 The Idx number for the counter device. Can be obtained from the devices setup page on the Domoticz system.
 The Idx number for the counter device. Can be obtained from the devices setup page on the Domoticz system.
 
 
 !!! Note
 !!! Note
-    This parameter must be prefixed with `<NUMBER>` followed by a dot (eg. `main.DomoticzIDX`). `<NUMBER>` is the name of the number sequence  defined in the ROI's.
+    If you edit the config file manually, you must prefix this parameter with `<NUMBER>` followed by a dot (eg. `main.DomoticzIDX`). The reason is that this parameter is specific for each `<NUMBER>` (`<NUMBER>` is the name of the number sequence defined in the ROI's).

+ 1 - 1
param-docs/parameter-pages/PostProcessing/NUMBER.AllowNegativeRates.md

@@ -7,4 +7,4 @@ Allow a meter to count backwards (decreasing values).
     This is unusual (it means there is a negative rate) and not wanted in most cases!
     This is unusual (it means there is a negative rate) and not wanted in most cases!
 
 
 !!! Note
 !!! Note
-    This parameter must be prefixed with `<NUMBER>` followed by a dot (eg. `main.AllowNegativeRates`). `<NUMBER>` is the name of the number sequence  defined in the ROI's.
+    If you edit the config file manually, you must prefix this parameter with `<NUMBER>` followed by a dot (eg. `main.AllowNegativeRates`). The reason is that this parameter is specific for each `<NUMBER>` (`<NUMBER>` is the name of the number sequence defined in the ROI's).

+ 1 - 1
param-docs/parameter-pages/PostProcessing/NUMBER.AnalogToDigitTransitionStart.md

@@ -9,4 +9,4 @@ See [here](../Watermeter-specific-analog---digit-transition) for details.
 Range: `6.0` .. `9.9`.
 Range: `6.0` .. `9.9`.
 
 
 !!! Note
 !!! Note
-    This parameter must be prefixed with `<NUMBER>` followed by a dot (eg. `main.AnalogToDigitTransitionStart`). `<NUMBER>` is the name of the number sequence  defined in the ROI's.
+    If you edit the config file manually, you must prefix this parameter with `<NUMBER>` followed by a dot (eg. `main.AnalogToDigitTransitionStart`). The reason is that this parameter is specific for each `<NUMBER>` (`<NUMBER>` is the name of the number sequence defined in the ROI's).

+ 1 - 1
param-docs/parameter-pages/PostProcessing/NUMBER.ChangeRateThreshold.md

@@ -10,7 +10,7 @@ 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.
 If the read value is within PreValue +/- Threshold, no further calculation is carried out and the Value/Prevalue remains at the old value.
 
 
 !!! Note
 !!! Note
-    This parameter must be prefixed with `<NUMBER>` followed by a dot (eg. `main.ChangeRateThreshold`). `<NUMBER>` is the name of the number sequence  defined in the ROI's.
+    If you edit the config file manually, you must prefix this parameter with `<NUMBER>` followed by a dot (eg. `main.ChangeRateThreshold`). The reason is that this parameter is specific for each `<NUMBER>` (`<NUMBER>` is the name of the number sequence defined in the ROI's).
 
 
 ## Example
 ## Example
 
 

+ 1 - 1
param-docs/parameter-pages/PostProcessing/NUMBER.CheckDigitIncreaseConsistency.md

@@ -8,4 +8,4 @@ An additional consistency check.
 It especially improves the zero crossing check between digits.
 It especially improves the zero crossing check between digits.
 
 
 !!! Note
 !!! Note
-    This parameter must be prefixed with `<NUMBER>` followed by a dot (eg. `main.CheckDigitIncreaseConsistency`). `<NUMBER>` is the name of the number sequence  defined in the ROI's.
+    If you edit the config file manually, you must prefix this parameter with `<NUMBER>` followed by a dot (eg. `main.CheckDigitIncreaseConsistency`). The reason is that this parameter is specific for each `<NUMBER>` (`<NUMBER>` is the name of the number sequence defined in the ROI's).

+ 1 - 1
param-docs/parameter-pages/PostProcessing/NUMBER.DecimalShift.md

@@ -5,4 +5,4 @@ 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`.
 Eg. to move from `m³` to `liter` (`1 m³` equals `1000 liters`), you need to set it to `+3`.
 
 
 !!! Note
 !!! Note
-    This parameter must be prefixed with `<NUMBER>` followed by a dot (eg. `main.DecimalShift`). `<NUMBER>` is the name of the number sequence  defined in the ROI's.
+    If you edit the config file manually, you must prefix this parameter with `<NUMBER>` followed by a dot (eg. `main.DecimalShift`). The reason is that this parameter is specific for each `<NUMBER>` (`<NUMBER>` is the name of the number sequence defined in the ROI's).

+ 1 - 1
param-docs/parameter-pages/PostProcessing/NUMBER.ExtendedResolution.md

@@ -7,4 +7,4 @@ Use the decimal place of the last analog counter for increased accuracy.
     This parameter is only supported on the `*-class*` and `*-const` models! See [Choosing-the-Model](../Choosing-the-Model) for details.
     This parameter is only supported on the `*-class*` and `*-const` models! See [Choosing-the-Model](../Choosing-the-Model) for details.
 
 
 !!! Note
 !!! Note
-    This parameter must be prefixed with `<NUMBER>` followed by a dot (eg. `main.ExtendedResolution`). `<NUMBER>` is the name of the number sequence  defined in the ROI's.
+    If you edit the config file manually, you must prefix this parameter with `<NUMBER>` followed by a dot (eg. `main.ExtendedResolution`). The reason is that this parameter is specific for each `<NUMBER>` (`<NUMBER>` is the name of the number sequence defined in the ROI's).

+ 1 - 1
param-docs/parameter-pages/PostProcessing/NUMBER.IgnoreLeadingNaN.md

@@ -6,4 +6,4 @@ This is only relevant for models which use `N`!
 See [here](../Choosing-the-Model) for details.
 See [here](../Choosing-the-Model) for details.
 
 
 !!! Note
 !!! Note
-    This parameter must be prefixed with `<NUMBER>` followed by a dot (eg. `main.IgnoreLeadingNaN`). `<NUMBER>` is the name of the number sequence  defined in the ROI's.
+    If you edit the config file manually, you must prefix this parameter with `<NUMBER>` followed by a dot (eg. `main.IgnoreLeadingNaN`). The reason is that this parameter is specific for each `<NUMBER>` (`<NUMBER>` is the name of the number sequence defined in the ROI's).

+ 1 - 1
param-docs/parameter-pages/PostProcessing/NUMBER.MaxRateType.md

@@ -5,4 +5,4 @@ Defines if the **Change Rate** is calculated as the difference between the last
 as the difference normalized to the interval (`RateChange` = difference per minute).
 as the difference normalized to the interval (`RateChange` = difference per minute).
 
 
 !!! Note
 !!! Note
-    This parameter must be prefixed with `<NUMBER>` followed by a dot (eg. `main.MaxRateType`). `<NUMBER>` is the name of the number sequence  defined in the ROI's.
+    If you edit the config file manually, you must prefix this parameter with `<NUMBER>` followed by a dot (eg. `main.MaxRateType`). The reason is that this parameter is specific for each `<NUMBER>` (`<NUMBER>` is the name of the number sequence defined in the ROI's).

+ 1 - 1
param-docs/parameter-pages/PostProcessing/NUMBER.MaxRateValue.md

@@ -6,4 +6,4 @@ Maximum allowed change between two readings, if exceeded the last reading will b
 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`!
 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
 !!! Note
-    This parameter must be prefixed with `<NUMBER>` followed by a dot (eg. `main.MaxRateValue`). `<NUMBER>` is the name of the number sequence  defined in the ROI's.
+    If you edit the config file manually, you must prefix this parameter with `<NUMBER>` followed by a dot (eg. `main.MaxRateValue`). The reason is that this parameter is specific for each `<NUMBER>` (`<NUMBER>` is the name of the number sequence defined in the ROI's).