Brad Bishop | 45387d6 | 2016-11-10 21:58:58 -0600 | [diff] [blame] | 1 | description: > |
| 2 | Implement to provide critical class sensor thresholds. Objects implementing |
| 3 | Sensor.Threshold.Critical must be instantiated in the correct hierarchy within |
| 4 | the sensors namespace. The following sensor hierarchies are recognized: |
| 5 | temperature |
| 6 | fan_tach |
| 7 | voltage |
| 8 | altitude |
Brad Bishop | 6c4e2e9 | 2016-12-28 13:38:31 -0500 | [diff] [blame] | 9 | current |
| 10 | power |
| 11 | energy |
Brad Bishop | 45387d6 | 2016-11-10 21:58:58 -0600 | [diff] [blame] | 12 | |
| 13 | Additionally, any object implementing Sensor.Threshold.Critical must also |
| 14 | implement Sensor.Value. |
| 15 | |
| 16 | properties: |
| 17 | - name: CriticalHigh |
James Feist | 4ec6587 | 2018-07-31 11:00:25 -0700 | [diff] [blame] | 18 | type: double |
Patrick Williams | 2c33a89 | 2020-11-04 12:14:13 -0600 | [diff] [blame] | 19 | default: NaN |
Brad Bishop | 45387d6 | 2016-11-10 21:58:58 -0600 | [diff] [blame] | 20 | description: > |
Patrick Williams | 2c33a89 | 2020-11-04 12:14:13 -0600 | [diff] [blame] | 21 | The upper bound of the critical threshold. A value of 'NaN' is used |
| 22 | to indicate there is no threshold of this type. |
Brad Bishop | 45387d6 | 2016-11-10 21:58:58 -0600 | [diff] [blame] | 23 | - name: CriticalLow |
James Feist | 4ec6587 | 2018-07-31 11:00:25 -0700 | [diff] [blame] | 24 | type: double |
Patrick Williams | 2c33a89 | 2020-11-04 12:14:13 -0600 | [diff] [blame] | 25 | default: NaN |
Brad Bishop | 45387d6 | 2016-11-10 21:58:58 -0600 | [diff] [blame] | 26 | description: > |
Patrick Williams | 2c33a89 | 2020-11-04 12:14:13 -0600 | [diff] [blame] | 27 | The lower bound of the critical threshold. A value of 'NaN' is used |
| 28 | to indicate there is no threshold of this type. |
Brad Bishop | 6d51435 | 2017-01-05 21:33:17 -0500 | [diff] [blame] | 29 | - name: CriticalAlarmHigh |
Brad Bishop | 45387d6 | 2016-11-10 21:58:58 -0600 | [diff] [blame] | 30 | type: boolean |
| 31 | description: > |
Brad Bishop | 6d51435 | 2017-01-05 21:33:17 -0500 | [diff] [blame] | 32 | True if the sensor value has exceeded the defined bound. |
| 33 | False if the sensor value has not exceeded the defined bound. |
Brad Bishop | 45387d6 | 2016-11-10 21:58:58 -0600 | [diff] [blame] | 34 | |
Brad Bishop | 6d51435 | 2017-01-05 21:33:17 -0500 | [diff] [blame] | 35 | CriticalAlarmHigh may be set to False to clear an alarm condition. |
| 36 | The behavior of setting CriticalAlarmHigh to True is undefined. |
| 37 | - name: CriticalAlarmLow |
| 38 | type: boolean |
| 39 | description: > |
| 40 | True if the sensor value has exceeded the defined bound. |
| 41 | False if the sensor value has not exceeded the defined bound. |
| 42 | |
| 43 | CriticalAlarmLow may be set to False to clear an alarm condition. |
| 44 | The behavior of setting CriticalAlarmLow to True is undefined. |