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