1description: >
2
3    Implement to provide hard shutdown class sensor thresholds.  Objects
4    implementing Sensor.Threshold.HardShutdown must be instantiated in the
5    correct hierarchy within the sensors namespace.  The following sensor
6    hierarchies are recognized:
7      temperature
8      fan_tach
9      voltage
10      altitude
11      current
12      power
13      energy
14
15
16    Additionally, any object implementing Sensor.Threshold.HardShutdown must
17    also implement Sensor.Value.
18
19properties:
20    - name: HardShutdownHigh
21      type: double
22      default: NaN
23      description: >
24          The upper bound of the shutdown threshold.  A value of 'NaN' is used
25          to indicate there is no threshold of this type.
26    - name: HardShutdownLow
27      type: double
28      default: NaN
29      description: >
30          The lower bound of the shutdown threshold.  A value of 'NaN' is used
31          to indicate there is no threshold of this type.
32    - name: HardShutdownAlarmHigh
33      type: boolean
34      description: >
35          True if the sensor value has exceeded the defined bound.
36          False if the sensor value has not exceeded the defined bound.
37
38          HardShutdownAlarmHigh may be set to False to clear an alarm condition.
39          The behavior of setting HardShutdownAlarmHigh to True is undefined.
40    - name: HardShutdownAlarmLow
41      type: boolean
42      description: >
43          True if the sensor value has exceeded the defined bound.
44          False if the sensor value has not exceeded the defined bound.
45
46          HardShutdownAlarmLow may be set to False to clear an alarm condition.
47          The behavior of setting HardShutdownAlarmLow to True is undefined.
48
49signals:
50    - name: HardShutdownHighAlarmAsserted
51      description: >
52          The high threshold alarm asserted.
53      properties:
54         - name: SensorValue
55           type: double
56           description: >
57               The sensor value that triggered the alarm change.
58    - name: HardShutdownHighAlarmDeasserted
59      description: >
60          The high threshold alarm deasserted.
61      properties:
62         - name: SensorValue
63           type: double
64           description: >
65               The sensor value that triggered the alarm change.
66    - name: HardShutdownLowAlarmAsserted
67      description: >
68          The low threshold alarm asserted.
69      properties:
70         - name: SensorValue
71           type: double
72           description: >
73               The sensor value that triggered the alarm change.
74    - name: HardShutdownLowAlarmDeasserted
75      description: >
76          The low threshold alarm deasserted.
77      properties:
78         - name: SensorValue
79           type: double
80           description: >
81               The sensor value that triggered the alarm change.
82