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