1description: >
2    Implement to provide soft shutdown class sensor thresholds.  Objects
3    implementing Sensor.Threshold.Shutdown must be instantiated in the correct
4    hierarchy within the sensors namespace.  The following sensor hierarchies
5    are recognized:
6      airflow
7      altitude
8      current
9      energy
10      fan_tach
11      humidity
12      power
13      pressure
14      temperature
15      utilization
16      voltage
17
18    Additionally, any object implementing Sensor.Threshold.SoftShutdown must
19    also implement Sensor.Value.
20
21properties:
22    - name: SoftShutdownHigh
23      type: double
24      default: NaN
25      description: >
26          The upper bound of the soft shutdown threshold.  A value of 'NaN' is
27          used to indicate there is no threshold of this type.
28    - name: SoftShutdownLow
29      type: double
30      default: NaN
31      description: >
32          The lower bound of the soft shutdown threshold.  A value of 'NaN' is
33          used to indicate there is no threshold of this type.
34    - name: SoftShutdownAlarmHigh
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          SoftShutdownAlarmHigh may be set to False to clear an alarm condition.
41          The behavior of setting SoftShutdownAlarmHigh to True is undefined.
42    - name: SoftShutdownAlarmLow
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          SoftShutdownAlarmLow may be set to False to clear an alarm condition.
49          The behavior of setting SoftShutdownAlarmLow to True is undefined.
50
51signals:
52    - name: SoftShutdownHighAlarmAsserted
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: SoftShutdownHighAlarmDeasserted
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: SoftShutdownLowAlarmAsserted
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: SoftShutdownLowAlarmDeasserted
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