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