Blame - yaml/xyz/openbmc_project/Sensor/Threshold/Warning.interface.yaml - openbmc/phosphor-dbus-interfaces

blob: 6310306d7f5b39454078ebad9c4c538e94b8aa95 [file] [log] [blame]

Brad Bishop	45387d6	2016-11-10 21:58:58 -0600	[diff] [blame]	1	description: >
				2	Implement to provide warning class sensor thresholds. Objects implementing
				3	Sensor.Threshold.Warning must be instantiated in the correct hierarchy within
				4	the sensors namespace. The following sensor hierarchies are recognized:
				5	temperature
				6	fan_tach
				7	voltage
				8	altitude
Brad Bishop	6c4e2e9	2016-12-28 13:38:31 -0500	[diff] [blame]	9	current
				10	power
				11	energy
Patrick Williams	86f8c53	2021-10-01 06:34:04 -0500	[diff] [blame^]	12	utilization
				13	airflow
				14	pressure
Brad Bishop	45387d6	2016-11-10 21:58:58 -0600	[diff] [blame]	15
				16	Additionally, any object implementing Sensor.Threshold.Warning must also
				17	implement Sensor.Value.
				18
				19	properties:
				20	- name: WarningHigh
James Feist	4ec6587	2018-07-31 11:00:25 -0700	[diff] [blame]	21	type: double
Patrick Williams	2c33a89	2020-11-04 12:14:13 -0600	[diff] [blame]	22	default: NaN
Brad Bishop	45387d6	2016-11-10 21:58:58 -0600	[diff] [blame]	23	description: >
Patrick Williams	2c33a89	2020-11-04 12:14:13 -0600	[diff] [blame]	24	The upper bound of the warning threshold. A value of 'NaN' is used
				25	to indicate there is no threshold of this type.
Brad Bishop	45387d6	2016-11-10 21:58:58 -0600	[diff] [blame]	26	- name: WarningLow
James Feist	4ec6587	2018-07-31 11:00:25 -0700	[diff] [blame]	27	type: double
Patrick Williams	2c33a89	2020-11-04 12:14:13 -0600	[diff] [blame]	28	default: NaN
Brad Bishop	45387d6	2016-11-10 21:58:58 -0600	[diff] [blame]	29	description: >
Patrick Williams	2c33a89	2020-11-04 12:14:13 -0600	[diff] [blame]	30	The lower bound of the warning threshold. A value of 'NaN' is used
				31	to indicate there is no threshold of this type.
Brad Bishop	6d51435	2017-01-05 21:33:17 -0500	[diff] [blame]	32	- name: WarningAlarmHigh
Brad Bishop	45387d6	2016-11-10 21:58:58 -0600	[diff] [blame]	33	type: boolean
				34	description: >
Brad Bishop	6d51435	2017-01-05 21:33:17 -0500	[diff] [blame]	35	True if the sensor value has exceeded the defined bound.
				36	False if the sensor value has not exceeded the defined bound.
Brad Bishop	45387d6	2016-11-10 21:58:58 -0600	[diff] [blame]	37
Brad Bishop	6d51435	2017-01-05 21:33:17 -0500	[diff] [blame]	38	WarningAlarmHigh may be set to False to clear an alarm condition.
				39	The behavior of setting WarningAlarmHigh to True is undefined.
				40	- name: WarningAlarmLow
				41	type: boolean
				42	description: >
				43	True if the sensor value has exceeded the defined bound.
				44	False if the sensor value has not exceeded the defined bound.
				45
				46	WarningAlarmLow may be set to False to clear an alarm condition.
				47	The behavior of setting WarningAlarmLow to True is undefined.
Matt Spinler	70ee1cf	2021-01-21 15:25:59 -0600	[diff] [blame]	48	signals:
				49	- name: WarningHighAlarmAsserted
				50	description: >
				51	The high threshold alarm asserted.
				52	properties:
				53	- name: SensorValue
				54	type: double
				55	description: >
				56	The sensor value that triggered the alarm change.
				57	- name: WarningHighAlarmDeasserted
				58	description: >
				59	The high threshold alarm deasserted.
				60	properties:
				61	- name: SensorValue
				62	type: double
				63	description: >
				64	The sensor value that triggered the alarm change.
				65	- name: WarningLowAlarmAsserted
				66	description: >
				67	The low threshold alarm asserted.
				68	properties:
				69	- name: SensorValue
				70	type: double
				71	description: >
				72	The sensor value that triggered the alarm change.
				73	- name: WarningLowAlarmDeasserted
				74	description: >
				75	The low threshold alarm deasserted.
				76	properties:
				77	- name: SensorValue
				78	type: double
				79	description: >
				80	The sensor value that triggered the alarm change.