1b1b4d261SWilliam A. Kennington IIIdescription: >
2b1b4d261SWilliam A. Kennington III    Implement to provide performance loss class sensor thresholds.  Objects
386f8c536SPatrick Williams    implementing Sensor.Threshold.PerformanceLoss must be instantiated in the
486f8c536SPatrick Williams    correct hierarchy within the sensors namespace.  The following sensor
586f8c536SPatrick Williams    hierarchies 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
1886f8c536SPatrick Williams    Additionally, any object implementing Sensor.Threshold.PerformanceLoss must
1986f8c536SPatrick Williams    also implement Sensor.Value.
20b1b4d261SWilliam A. Kennington III
21b1b4d261SWilliam A. Kennington IIIproperties:
22b1b4d261SWilliam A. Kennington III    - name: PerformanceLossHigh
23b1b4d261SWilliam A. Kennington III      type: double
24b1b4d261SWilliam A. Kennington III      default: NaN
25b1b4d261SWilliam A. Kennington III      description: >
26*a1347418SPatrick Williams          The upper bound of the warning threshold.  A value of 'NaN' is used to
27*a1347418SPatrick Williams          indicate there is no threshold of this type.
28b1b4d261SWilliam A. Kennington III    - name: PerformanceLossLow
29b1b4d261SWilliam A. Kennington III      type: double
30b1b4d261SWilliam A. Kennington III      default: NaN
31b1b4d261SWilliam A. Kennington III      description: >
32*a1347418SPatrick Williams          The lower bound of the warning threshold.  A value of 'NaN' is used to
33*a1347418SPatrick Williams          indicate there is no threshold of this type.
34b1b4d261SWilliam A. Kennington III    - name: PerformanceLossAlarmHigh
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
4086f8c536SPatrick Williams          PerformanceLossAlarmHigh may be set to False to clear an alarm
41*a1347418SPatrick Williams          condition. The behavior of setting PerformanceLossAlarmHigh to True is
42*a1347418SPatrick Williams          undefined.
43b1b4d261SWilliam A. Kennington III    - name: PerformanceLossAlarmLow
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
4986f8c536SPatrick Williams          PerformanceLossAlarmLow may be set to False to clear an alarm
5086f8c536SPatrick Williams          condition. The behavior of setting PerformanceLossAlarmLow to True is
5186f8c536SPatrick Williams          undefined.
52b1b4d261SWilliam A. Kennington IIIsignals:
53b1b4d261SWilliam A. Kennington III    - name: PerformanceLossHighAlarmAsserted
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: PerformanceLossHighAlarmDeasserted
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: PerformanceLossLowAlarmAsserted
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: PerformanceLossLowAlarmDeasserted
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