| Brad Bishop | 45387d6 | 2016-11-10 21:58:58 -0600 | [diff] [blame] | 1 | description: > |
| 2 | Implement to provide warning class sensor thresholds. Objects implementing |
| 3 | Sensor.Threshold.Warning 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 |
| 12 | |
| Brad Bishop | 45387d6 | 2016-11-10 21:58:58 -0600 | [diff] [blame] | 13 | |
| 14 | Additionally, any object implementing Sensor.Threshold.Warning must also |
| 15 | implement Sensor.Value. |
| 16 | |
| 17 | properties: |
| 18 | - name: WarningHigh |
| 19 | type: int64 |
| 20 | description: > |
| 21 | The upper bound of the warning threshold. |
| 22 | - name: WarningLow |
| 23 | type: int64 |
| 24 | description: > |
| 25 | The lower bound of the warning threshold. |
| Brad Bishop | 6d51435 | 2017-01-05 21:33:17 -0500 | [diff] [blame^] | 26 | - name: WarningAlarmHigh |
| Brad Bishop | 45387d6 | 2016-11-10 21:58:58 -0600 | [diff] [blame] | 27 | type: boolean |
| 28 | description: > |
| Brad Bishop | 6d51435 | 2017-01-05 21:33:17 -0500 | [diff] [blame^] | 29 | True if the sensor value has exceeded the defined bound. |
| 30 | False if the sensor value has not exceeded the defined bound. |
| Brad Bishop | 45387d6 | 2016-11-10 21:58:58 -0600 | [diff] [blame] | 31 | |
| Brad Bishop | 6d51435 | 2017-01-05 21:33:17 -0500 | [diff] [blame^] | 32 | WarningAlarmHigh may be set to False to clear an alarm condition. |
| 33 | The behavior of setting WarningAlarmHigh to True is undefined. |
| 34 | - name: WarningAlarmLow |
| 35 | type: boolean |
| 36 | description: > |
| 37 | True if the sensor value has exceeded the defined bound. |
| 38 | False if the sensor value has not exceeded the defined bound. |
| 39 | |
| 40 | WarningAlarmLow may be set to False to clear an alarm condition. |
| 41 | The behavior of setting WarningAlarmLow to True is undefined. |
| Brad Bishop | 45387d6 | 2016-11-10 21:58:58 -0600 | [diff] [blame] | 42 | |
| 43 | # vim: tabstop=8 expandtab shiftwidth=4 softtabstop=4 |