summaryrefslogtreecommitdiffstats
path: root/xyz/openbmc_project/Sensor/Threshold/Warning.interface.yaml
blob: f8ef993e63cdb229d470e39c2e95cb7310e0d4dd (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
description: >
    Implement to provide warning class sensor thresholds.  Objects implementing
    Sensor.Threshold.Warning must be instantiated in the correct hierarchy within
    the sensors namespace.  The following sensor hierarchies are recognized:
      temperature
      fan_tach
      voltage
      altitude
      current
      power
      energy


    Additionally, any object implementing Sensor.Threshold.Warning must also
    implement Sensor.Value.

properties:
    - name: WarningHigh
      type: int64
      description: >
          The upper bound of the warning threshold.
    - name: WarningLow
      type: int64
      description: >
          The lower bound of the warning threshold.
    - name: WarningAlarm
      type: boolean
      description: >
          True if the sensor value has exceeded the defined bounds.
          False if the sensor value has not exceeded the defined bounds.

          WarningAlarm may be set to False to clear an alarm condition.
          The behavior of setting WarningAlarm to True is undefined.

# vim: tabstop=8 expandtab shiftwidth=4 softtabstop=4
OpenPOWER on IntegriCloud