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