xref: /openbmc/phosphor-dbus-interfaces/yaml/xyz/openbmc_project/Sensor/Threshold/Warning.interface.yaml (revision 1f7befd2490bed95e38efa75a540cbdbb9823600) 
1description: >
2    Implement to provide warning class sensor thresholds.  Objects implementing
3    Sensor.Threshold.Warning must be instantiated in the correct hierarchy
4    within the sensors namespace.  The following sensor hierarchies are
5    recognized:
6      airflow
7      altitude
8      current
9      energy
10      fan_tach
11      frequency
12      humidity
13      liquidflow
14      power
15      pressure
16      temperature
17      utilization
18      voltage
19
20    Additionally, any object implementing Sensor.Threshold.Warning must also
21    implement Sensor.Value.
22
23properties:
24    - name: WarningHigh
25      type: double
26      default: NaN
27      description: >
28          The upper bound of the warning threshold.  A value of 'NaN' is used to
29          indicate there is no threshold of this type.
30    - name: WarningLow
31      type: double
32      default: NaN
33      description: >
34          The lower bound of the warning threshold.  A value of 'NaN' is used to
35          indicate there is no threshold of this type.
36    - name: WarningAlarmHigh
37      type: boolean
38      description: >
39          True if the sensor value has exceeded the defined bound. False if the
40          sensor value has not exceeded the defined bound.
41
42          WarningAlarmHigh may be set to False to clear an alarm condition. The
43          behavior of setting WarningAlarmHigh to True is undefined.
44    - name: WarningAlarmLow
45      type: boolean
46      description: >
47          True if the sensor value has exceeded the defined bound. False if the
48          sensor value has not exceeded the defined bound.
49
50          WarningAlarmLow may be set to False to clear an alarm condition. The
51          behavior of setting WarningAlarmLow to True is undefined.
52signals:
53    - name: WarningHighAlarmAsserted
54      description: >
55          The high threshold alarm asserted.
56      properties:
57          - name: SensorValue
58            type: double
59            description: >
60                The sensor value that triggered the alarm change.
61    - name: WarningHighAlarmDeasserted
62      description: >
63          The high threshold alarm deasserted.
64      properties:
65          - name: SensorValue
66            type: double
67            description: >
68                The sensor value that triggered the alarm change.
69    - name: WarningLowAlarmAsserted
70      description: >
71          The low threshold alarm asserted.
72      properties:
73          - name: SensorValue
74            type: double
75            description: >
76                The sensor value that triggered the alarm change.
77    - name: WarningLowAlarmDeasserted
78      description: >
79          The low threshold alarm deasserted.
80      properties:
81          - name: SensorValue
82            type: double
83            description: >
84                The sensor value that triggered the alarm change.
85