mirror of
https://github.com/jomjol/AI-on-the-edge-device.git
synced 2025-12-06 11:36:51 +03:00
updated param doc
This commit is contained in:
@@ -1,4 +1,7 @@
|
|||||||
# Parameter `<NUMBER>.Field`
|
# Parameter `Field`
|
||||||
Default Value: `undefined`
|
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
|
||||||
|
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.
|
||||||
|
|||||||
@@ -1,4 +1,7 @@
|
|||||||
# Parameter `<NUMBER>.Field`
|
# Parameter `Field`
|
||||||
Default Value: `undefined`
|
Default Value: `undefined`
|
||||||
|
|
||||||
Field for InfluxDB v2 to use for saving.
|
Field for InfluxDB v2 to use for saving.
|
||||||
|
|
||||||
|
!!! 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.
|
||||||
|
|||||||
@@ -1,4 +1,7 @@
|
|||||||
# Parameter `<NUMBER>.DomoticzIDX`
|
# Parameter `DomoticzIDX`
|
||||||
Default Value: `0`
|
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
|
||||||
|
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.
|
||||||
|
|||||||
@@ -1,4 +1,4 @@
|
|||||||
# Parameter `<NUMBER>.AnalogToDigitTransitionStart`
|
# Parameter `AnalogToDigitTransitionStart`
|
||||||
Default Value: `9.2`
|
Default Value: `9.2`
|
||||||
|
|
||||||
This can be used if you have wrong values, but the recognition of the individual ROIs are correct.
|
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.
|
See [here](../Watermeter-specific-analog---digit-transition) for details.
|
||||||
|
|
||||||
Range: `6.0` .. `9.9`.
|
Range: `6.0` .. `9.9`.
|
||||||
|
|
||||||
|
!!! 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.
|
||||||
|
|||||||
@@ -1,4 +1,4 @@
|
|||||||
# Parameter `<NUMBER>.ChangeRateThreshold`
|
# Parameter `ChangeRateThreshold`
|
||||||
Default Value: `2`
|
Default Value: `2`
|
||||||
|
|
||||||
Range: `1` .. `9`.
|
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).
|
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
|
||||||
|
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.
|
||||||
|
|
||||||
## Example
|
## Example
|
||||||
|
|
||||||
- Smallest ROI provides value for `0.000'x` (Eg. a water meter with 4 pointers behind the decimal point)
|
- Smallest ROI provides value for `0.000'x` (Eg. a water meter with 4 pointers behind the decimal point)
|
||||||
|
|||||||
@@ -1,5 +1,8 @@
|
|||||||
# Parameter `<NUMBER>.DecimalShift`
|
# Parameter `DecimalShift`
|
||||||
Default Value: `0`
|
Default Value: `0`
|
||||||
|
|
||||||
Shift the decimal separator (positiv or negativ).
|
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
|
||||||
|
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.
|
||||||
|
|||||||
@@ -1,7 +1,10 @@
|
|||||||
# Parameter `<NUMBER>.ExtendedResolution`
|
# Parameter `ExtendedResolution`
|
||||||
Default Value: `false`
|
Default Value: `false`
|
||||||
|
|
||||||
Use the decimal place of the last analog counter for increased accuracy.
|
Use the decimal place of the last analog counter for increased accuracy.
|
||||||
|
|
||||||
!!! Note
|
!!! Note
|
||||||
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
|
||||||
|
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.
|
||||||
|
|||||||
@@ -1,6 +1,9 @@
|
|||||||
# Parameter `<NUMBER>.IgnoreLeadingNaN`
|
# Parameter `IgnoreLeadingNaN`
|
||||||
Default Value: `true`
|
Default Value: `true`
|
||||||
|
|
||||||
Leading `N`'s will be deleted before further processing.
|
Leading `N`'s will be deleted before further processing.
|
||||||
This is only relevant for models which use `N`!
|
This is only relevant for models which use `N`!
|
||||||
See [here](../Choosing-the-Model) for details.
|
See [here](../Choosing-the-Model) for details.
|
||||||
|
|
||||||
|
!!! 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.
|
||||||
|
|||||||
@@ -1,5 +1,8 @@
|
|||||||
# Parameter `<NUMBER>.MaxRateType`
|
# Parameter `MaxRateType`
|
||||||
Default Value: `AbsoluteChange`
|
Default Value: `AbsoluteChange`
|
||||||
|
|
||||||
Defines if the **Change Rate** is calculated as the difference between the last two readings (`AbsoluteChange` = difference) or
|
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).
|
as the difference normalized to the interval (`RateChange` = difference per minute).
|
||||||
|
|
||||||
|
!!! 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.
|
||||||
|
|||||||
@@ -1,6 +1,9 @@
|
|||||||
# Parameter `<NUMBER>.MaxRateValue`
|
# Parameter `MaxRateValue`
|
||||||
Default Value: `0,05`
|
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).
|
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`!
|
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 `<NUMBER>` followed by a dot (eg. `main.MaxRateValue`). `<NUMBER>` is the name of the number sequence defined in the ROI's.
|
||||||
|
|||||||
Reference in New Issue
Block a user