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