Gitiles
Code Review Sign In
gerrit.openbmc.org / openbmc / phosphor-dbus-interfaces / a1347418307d31a94bd21f22897aa508df938dcf / . / yaml / xyz / openbmc_project / Sensor / Threshold / HardShutdown.interface.yaml
blob: 0329c3378c016a8026abd168b11f4d95b459cca3 [file] [log] [blame]
Matt Spinler45ed88d2020-11-20 11:33:16 -0600[diff] [blame]1description: >
2
3 Implement to provide hard shutdown class sensor thresholds. Objects
4 implementing Sensor.Threshold.HardShutdown must be instantiated in the
5 correct hierarchy within the sensors namespace. The following sensor
6 hierarchies are recognized:
Patrick Williamsd5f36352021-12-22 09:13:27 -0600[diff] [blame]7 airflow
Matt Spinler45ed88d2020-11-20 11:33:16 -0600[diff] [blame]8 altitude
9 current
Matt Spinler45ed88d2020-11-20 11:33:16 -0600[diff] [blame]10 energy
Patrick Williamsd5f36352021-12-22 09:13:27 -0600[diff] [blame]11 fan_tach
Patrick Williams1bcf7fa2021-12-22 09:14:37 -0600[diff] [blame]12 humidity
Patrick Williamsd5f36352021-12-22 09:13:27 -0600[diff] [blame]13 power
Patrick Williams86f8c532021-10-01 06:34:04 -0500[diff] [blame]14 pressure
Patrick Williamsd5f36352021-12-22 09:13:27 -0600[diff] [blame]15 temperature
16 utilization
17 voltage
Matt Spinler45ed88d2020-11-20 11:33:16 -0600[diff] [blame]18
19 Additionally, any object implementing Sensor.Threshold.HardShutdown must
20 also implement Sensor.Value.
21
22properties:
23 - name: HardShutdownHigh
24 type: double
25 default: NaN
26 description: >
27 The upper bound of the shutdown threshold. A value of 'NaN' is used
28 to indicate there is no threshold of this type.
29 - name: HardShutdownLow
30 type: double
31 default: NaN
32 description: >
33 The lower bound of the shutdown threshold. A value of 'NaN' is used
34 to indicate there is no threshold of this type.
35 - name: HardShutdownAlarmHigh
36 type: boolean
37 description: >
Patrick Williamsa1347412022-12-06 10:56:22 -0600[diff] [blame^]38 True if the sensor value has exceeded the defined bound. False if the
39 sensor value has not exceeded the defined bound.
Matt Spinler45ed88d2020-11-20 11:33:16 -0600[diff] [blame]40
41 HardShutdownAlarmHigh may be set to False to clear an alarm condition.
42 The behavior of setting HardShutdownAlarmHigh to True is undefined.
43 - name: HardShutdownAlarmLow
44 type: boolean
45 description: >
Patrick Williamsa1347412022-12-06 10:56:22 -0600[diff] [blame^]46 True if the sensor value has exceeded the defined bound. False if the
47 sensor value has not exceeded the defined bound.
Matt Spinler45ed88d2020-11-20 11:33:16 -0600[diff] [blame]48
49 HardShutdownAlarmLow may be set to False to clear an alarm condition.
50 The behavior of setting HardShutdownAlarmLow to True is undefined.
Matt Spinler70ee1cf2021-01-21 15:25:59 -0600[diff] [blame]51
52signals:
53 - name: HardShutdownHighAlarmAsserted
54 description: >
55 The high threshold alarm asserted.
56 properties:
Patrick Williams8da396c2022-03-14 14:21:02 -0500[diff] [blame]57 - name: SensorValue
58 type: double
59 description: >
60 The sensor value that triggered the alarm change.
Matt Spinler70ee1cf2021-01-21 15:25:59 -0600[diff] [blame]61 - name: HardShutdownHighAlarmDeasserted
62 description: >
63 The high threshold alarm deasserted.
64 properties:
Patrick Williams8da396c2022-03-14 14:21:02 -0500[diff] [blame]65 - name: SensorValue
66 type: double
67 description: >
68 The sensor value that triggered the alarm change.
Matt Spinler70ee1cf2021-01-21 15:25:59 -0600[diff] [blame]69 - name: HardShutdownLowAlarmAsserted
70 description: >
71 The low threshold alarm asserted.
72 properties:
Patrick Williams8da396c2022-03-14 14:21:02 -0500[diff] [blame]73 - name: SensorValue
74 type: double
75 description: >
76 The sensor value that triggered the alarm change.
Matt Spinler70ee1cf2021-01-21 15:25:59 -0600[diff] [blame]77 - name: HardShutdownLowAlarmDeasserted
78 description: >
79 The low threshold alarm deasserted.
80 properties:
Patrick Williams8da396c2022-03-14 14:21:02 -0500[diff] [blame]81 - name: SensorValue
82 type: double
83 description: >
84 The sensor value that triggered the alarm change.