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