blob: ad90e6fa6ec663beb1dc843154308f0843477a7c [file] [log] [blame]
Brad Bishop45387d62016-11-10 21:58:58 -06001description: >
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
9
10 Additionally, any object implementing Sensor.Threshold.Critical must also
11 implement Sensor.Value.
12
13properties:
14 - name: CriticalHigh
15 type: int64
16 description: >
17 The upper bound of the critical threshold.
18 - name: CriticalLow
19 type: int64
20 description: >
21 The lower bound of the critical threshold.
22 - name: CriticalAlarm
23 type: boolean
24 description: >
25 True if the sensor value has exceeded the defined bounds.
26 False if the sensor value has not exceeded the defined bounds.
27
28 CriticalAlarm may be set to False to clear an alarm condition.
29 The behavior of setting CriticalAlarm to True is undefined.
30
31# vim: tabstop=8 expandtab shiftwidth=4 softtabstop=4