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      liquidflow
13      power
14      pressure
15      temperature
16      utilization
17      voltage
18
19    Additionally, any object implementing Sensor.Threshold.SoftShutdown must
20    also implement Sensor.Value.
21
22properties:
23    - name: SoftShutdownHigh
24      type: double
25      default: NaN
26      description: >
27          The upper bound of the soft shutdown threshold.  A value of 'NaN' is
28          used to indicate there is no threshold of this type.
29    - name: SoftShutdownLow
30      type: double
31      default: NaN
32      description: >
33          The lower bound of the soft shutdown threshold.  A value of 'NaN' is
34          used to indicate there is no threshold of this type.
35    - name: SoftShutdownAlarmHigh
36      type: boolean
37      description: >
38          True if the sensor value has exceeded the defined bound. False if the
39          sensor value has not exceeded the defined bound.
40
41          SoftShutdownAlarmHigh may be set to False to clear an alarm condition.
42          The behavior of setting SoftShutdownAlarmHigh to True is undefined.
43    - name: SoftShutdownAlarmLow
44      type: boolean
45      description: >
46          True if the sensor value has exceeded the defined bound. False if the
47          sensor value has not exceeded the defined bound.
48
49          SoftShutdownAlarmLow may be set to False to clear an alarm condition.
50          The behavior of setting SoftShutdownAlarmLow to True is undefined.
51
52signals:
53    - name: SoftShutdownHighAlarmAsserted
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: SoftShutdownHighAlarmDeasserted
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: SoftShutdownLowAlarmAsserted
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: SoftShutdownLowAlarmDeasserted
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