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