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