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      temperature
7      fan_tach
8      voltage
9      altitude
10      current
11      power
12      energy
13
14
15    Additionally, any object implementing Sensor.Threshold.SoftShutdown must
16    also implement Sensor.Value.
17
18properties:
19    - name: SoftShutdownHigh
20      type: double
21      default: NaN
22      description: >
23          The upper bound of the soft shutdown threshold.  A value of 'NaN' is
24          used to indicate there is no threshold of this type.
25    - name: SoftShutdownLow
26      type: double
27      default: NaN
28      description: >
29          The lower bound of the soft shutdown threshold.  A value of 'NaN' is
30          used to indicate there is no threshold of this type.
31    - name: SoftShutdownAlarmHigh
32      type: boolean
33      description: >
34          True if the sensor value has exceeded the defined bound.
35          False if the sensor value has not exceeded the defined bound.
36
37          SoftShutdownAlarmHigh may be set to False to clear an alarm condition.
38          The behavior of setting SoftShutdownAlarmHigh to True is undefined.
39    - name: SoftShutdownAlarmLow
40      type: boolean
41      description: >
42          True if the sensor value has exceeded the defined bound.
43          False if the sensor value has not exceeded the defined bound.
44
45          SoftShutdownAlarmLow may be set to False to clear an alarm condition.
46          The behavior of setting SoftShutdownAlarmLow to True is undefined.
47
48signals:
49    - name: SoftShutdownHighAlarmAsserted
50      description: >
51          The high threshold alarm asserted.
52      properties:
53         - name: SensorValue
54           type: double
55           description: >
56               The sensor value that triggered the alarm change.
57    - name: SoftShutdownHighAlarmDeasserted
58      description: >
59          The high threshold alarm deasserted.
60      properties:
61         - name: SensorValue
62           type: double
63           description: >
64               The sensor value that triggered the alarm change.
65    - name: SoftShutdownLowAlarmAsserted
66      description: >
67          The low threshold alarm asserted.
68      properties:
69         - name: SensorValue
70           type: double
71           description: >
72               The sensor value that triggered the alarm change.
73    - name: SoftShutdownLowAlarmDeasserted
74      description: >
75          The low threshold alarm deasserted.
76      properties:
77         - name: SensorValue
78           type: double
79           description: >
80               The sensor value that triggered the alarm change.
81