1b1b4d261SWilliam A. Kennington IIIdescription: >
2b1b4d261SWilliam A. Kennington III    Implement to provide soft shutdown class sensor thresholds.  Objects
3b1b4d261SWilliam A. Kennington III    implementing Sensor.Threshold.Shutdown must be instantiated in the correct
4b1b4d261SWilliam A. Kennington III    hierarchy within the sensors namespace.  The following sensor hierarchies
5b1b4d261SWilliam A. Kennington III    are recognized:
6*d5f36359SPatrick Williams      airflow
7b1b4d261SWilliam A. Kennington III      altitude
8b1b4d261SWilliam A. Kennington III      current
9b1b4d261SWilliam A. Kennington III      energy
10*d5f36359SPatrick Williams      fan_tach
11*d5f36359SPatrick Williams      power
1286f8c536SPatrick Williams      pressure
13*d5f36359SPatrick Williams      temperature
14*d5f36359SPatrick Williams      utilization
15*d5f36359SPatrick Williams      voltage
16b1b4d261SWilliam A. Kennington III
17b1b4d261SWilliam A. Kennington III    Additionally, any object implementing Sensor.Threshold.SoftShutdown must
18b1b4d261SWilliam A. Kennington III    also implement Sensor.Value.
19b1b4d261SWilliam A. Kennington III
20b1b4d261SWilliam A. Kennington IIIproperties:
21b1b4d261SWilliam A. Kennington III    - name: SoftShutdownHigh
22b1b4d261SWilliam A. Kennington III      type: double
23b1b4d261SWilliam A. Kennington III      default: NaN
24b1b4d261SWilliam A. Kennington III      description: >
25b1b4d261SWilliam A. Kennington III          The upper bound of the soft shutdown threshold.  A value of 'NaN' is
26b1b4d261SWilliam A. Kennington III          used to indicate there is no threshold of this type.
27b1b4d261SWilliam A. Kennington III    - name: SoftShutdownLow
28b1b4d261SWilliam A. Kennington III      type: double
29b1b4d261SWilliam A. Kennington III      default: NaN
30b1b4d261SWilliam A. Kennington III      description: >
31b1b4d261SWilliam A. Kennington III          The lower bound of the soft shutdown threshold.  A value of 'NaN' is
32b1b4d261SWilliam A. Kennington III          used to indicate there is no threshold of this type.
33b1b4d261SWilliam A. Kennington III    - name: SoftShutdownAlarmHigh
34b1b4d261SWilliam A. Kennington III      type: boolean
35b1b4d261SWilliam A. Kennington III      description: >
36b1b4d261SWilliam A. Kennington III          True if the sensor value has exceeded the defined bound.
37b1b4d261SWilliam A. Kennington III          False if the sensor value has not exceeded the defined bound.
38b1b4d261SWilliam A. Kennington III
39b1b4d261SWilliam A. Kennington III          SoftShutdownAlarmHigh may be set to False to clear an alarm condition.
40b1b4d261SWilliam A. Kennington III          The behavior of setting SoftShutdownAlarmHigh to True is undefined.
41b1b4d261SWilliam A. Kennington III    - name: SoftShutdownAlarmLow
42b1b4d261SWilliam A. Kennington III      type: boolean
43b1b4d261SWilliam A. Kennington III      description: >
44b1b4d261SWilliam A. Kennington III          True if the sensor value has exceeded the defined bound.
45b1b4d261SWilliam A. Kennington III          False if the sensor value has not exceeded the defined bound.
46b1b4d261SWilliam A. Kennington III
47b1b4d261SWilliam A. Kennington III          SoftShutdownAlarmLow may be set to False to clear an alarm condition.
48b1b4d261SWilliam A. Kennington III          The behavior of setting SoftShutdownAlarmLow to True is undefined.
49b1b4d261SWilliam A. Kennington III
50b1b4d261SWilliam A. Kennington IIIsignals:
51b1b4d261SWilliam A. Kennington III    - name: SoftShutdownHighAlarmAsserted
52b1b4d261SWilliam A. Kennington III      description: >
53b1b4d261SWilliam A. Kennington III          The high threshold alarm asserted.
54b1b4d261SWilliam A. Kennington III      properties:
55b1b4d261SWilliam A. Kennington III         - name: SensorValue
56b1b4d261SWilliam A. Kennington III           type: double
57b1b4d261SWilliam A. Kennington III           description: >
58b1b4d261SWilliam A. Kennington III               The sensor value that triggered the alarm change.
59b1b4d261SWilliam A. Kennington III    - name: SoftShutdownHighAlarmDeasserted
60b1b4d261SWilliam A. Kennington III      description: >
61b1b4d261SWilliam A. Kennington III          The high threshold alarm deasserted.
62b1b4d261SWilliam A. Kennington III      properties:
63b1b4d261SWilliam A. Kennington III         - name: SensorValue
64b1b4d261SWilliam A. Kennington III           type: double
65b1b4d261SWilliam A. Kennington III           description: >
66b1b4d261SWilliam A. Kennington III               The sensor value that triggered the alarm change.
67b1b4d261SWilliam A. Kennington III    - name: SoftShutdownLowAlarmAsserted
68b1b4d261SWilliam A. Kennington III      description: >
69b1b4d261SWilliam A. Kennington III          The low threshold alarm asserted.
70b1b4d261SWilliam A. Kennington III      properties:
71b1b4d261SWilliam A. Kennington III         - name: SensorValue
72b1b4d261SWilliam A. Kennington III           type: double
73b1b4d261SWilliam A. Kennington III           description: >
74b1b4d261SWilliam A. Kennington III               The sensor value that triggered the alarm change.
75b1b4d261SWilliam A. Kennington III    - name: SoftShutdownLowAlarmDeasserted
76b1b4d261SWilliam A. Kennington III      description: >
77b1b4d261SWilliam A. Kennington III          The low threshold alarm deasserted.
78b1b4d261SWilliam A. Kennington III      properties:
79b1b4d261SWilliam A. Kennington III         - name: SensorValue
80b1b4d261SWilliam A. Kennington III           type: double
81b1b4d261SWilliam A. Kennington III           description: >
82b1b4d261SWilliam A. Kennington III               The sensor value that triggered the alarm change.
83