sensor: sort units and document all types
Signed-off-by: Patrick Williams <patrick@stwcx.xyz>
Change-Id: I9f227d4c670cb03a704855bb0cca9f3920b3e098
diff --git a/yaml/xyz/openbmc_project/Sensor/Threshold/Critical.interface.yaml b/yaml/xyz/openbmc_project/Sensor/Threshold/Critical.interface.yaml
index 59a8ad5..ee60102 100644
--- a/yaml/xyz/openbmc_project/Sensor/Threshold/Critical.interface.yaml
+++ b/yaml/xyz/openbmc_project/Sensor/Threshold/Critical.interface.yaml
@@ -2,16 +2,16 @@
Implement to provide critical class sensor thresholds. Objects implementing
Sensor.Threshold.Critical must be instantiated in the correct hierarchy within
the sensors namespace. The following sensor hierarchies are recognized:
- temperature
- fan_tach
- voltage
+ airflow
altitude
current
- power
energy
- utilization
- airflow
+ fan_tach
+ power
pressure
+ temperature
+ utilization
+ voltage
Additionally, any object implementing Sensor.Threshold.Critical must also
implement Sensor.Value.
diff --git a/yaml/xyz/openbmc_project/Sensor/Threshold/HardShutdown.interface.yaml b/yaml/xyz/openbmc_project/Sensor/Threshold/HardShutdown.interface.yaml
index fbb6d78..2f444b4 100644
--- a/yaml/xyz/openbmc_project/Sensor/Threshold/HardShutdown.interface.yaml
+++ b/yaml/xyz/openbmc_project/Sensor/Threshold/HardShutdown.interface.yaml
@@ -4,16 +4,16 @@
implementing Sensor.Threshold.HardShutdown must be instantiated in the
correct hierarchy within the sensors namespace. The following sensor
hierarchies are recognized:
- temperature
- fan_tach
- voltage
+ airflow
altitude
current
- power
energy
- utilization
- airflow
+ fan_tach
+ power
pressure
+ temperature
+ utilization
+ voltage
Additionally, any object implementing Sensor.Threshold.HardShutdown must
also implement Sensor.Value.
diff --git a/yaml/xyz/openbmc_project/Sensor/Threshold/PerformanceLoss.interface.yaml b/yaml/xyz/openbmc_project/Sensor/Threshold/PerformanceLoss.interface.yaml
index 2d510f1..83eb024 100644
--- a/yaml/xyz/openbmc_project/Sensor/Threshold/PerformanceLoss.interface.yaml
+++ b/yaml/xyz/openbmc_project/Sensor/Threshold/PerformanceLoss.interface.yaml
@@ -3,16 +3,16 @@
implementing Sensor.Threshold.PerformanceLoss must be instantiated in the
correct hierarchy within the sensors namespace. The following sensor
hierarchies are recognized:
- temperature
- fan_tach
- voltage
+ airflow
altitude
current
- power
energy
- utilization
- airflow
+ fan_tach
+ power
pressure
+ temperature
+ utilization
+ voltage
Additionally, any object implementing Sensor.Threshold.PerformanceLoss must
also implement Sensor.Value.
diff --git a/yaml/xyz/openbmc_project/Sensor/Threshold/SoftShutdown.interface.yaml b/yaml/xyz/openbmc_project/Sensor/Threshold/SoftShutdown.interface.yaml
index 7a518d9..a4522da 100644
--- a/yaml/xyz/openbmc_project/Sensor/Threshold/SoftShutdown.interface.yaml
+++ b/yaml/xyz/openbmc_project/Sensor/Threshold/SoftShutdown.interface.yaml
@@ -3,16 +3,16 @@
implementing Sensor.Threshold.Shutdown must be instantiated in the correct
hierarchy within the sensors namespace. The following sensor hierarchies
are recognized:
- temperature
- fan_tach
- voltage
+ airflow
altitude
current
- power
energy
- utilization
- airflow
+ fan_tach
+ power
pressure
+ temperature
+ utilization
+ voltage
Additionally, any object implementing Sensor.Threshold.SoftShutdown must
also implement Sensor.Value.
diff --git a/yaml/xyz/openbmc_project/Sensor/Threshold/Warning.interface.yaml b/yaml/xyz/openbmc_project/Sensor/Threshold/Warning.interface.yaml
index 6310306..aa5d989 100644
--- a/yaml/xyz/openbmc_project/Sensor/Threshold/Warning.interface.yaml
+++ b/yaml/xyz/openbmc_project/Sensor/Threshold/Warning.interface.yaml
@@ -2,16 +2,16 @@
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
+ airflow
altitude
current
- power
energy
- utilization
- airflow
+ fan_tach
+ power
pressure
+ temperature
+ utilization
+ voltage
Additionally, any object implementing Sensor.Threshold.Warning must also
implement Sensor.Value.
diff --git a/yaml/xyz/openbmc_project/Sensor/Value.interface.yaml b/yaml/xyz/openbmc_project/Sensor/Value.interface.yaml
index 3c55da7..c593653 100644
--- a/yaml/xyz/openbmc_project/Sensor/Value.interface.yaml
+++ b/yaml/xyz/openbmc_project/Sensor/Value.interface.yaml
@@ -3,16 +3,16 @@
Sensor.Value must be instantiated in the correct
hierarchy within the sensors namespace. The following sensor
hierarchies are recognized:
- temperature
- fan_tach
- voltage
+ airflow
altitude
current
- power
energy
- utilization
- airflow
+ fan_tach
+ power
pressure
+ temperature
+ utilization
+ voltage
Any service implementing Sensor.Value on one or more objects must
implement org.freedesktop.DBus.ObjectManager on the sensors namespace root.
@@ -38,49 +38,49 @@
type: enum[self.Unit]
description: >
The unit of the reading. Immutable once set for a sensor.
- For objects in the temperature namespace, Unit must be "DegreesC".
- For objects in the fan_tach namespace, Unit must be "RPMS".
- For objects in the voltage namespace, Unit must be "Volts".
+ For objects in the airflow namespace, Unit must be "CFM"
For objects in the altitude namespace, Unit must be "Meters".
For objects in the current namespace, Unit must be "Amperes".
- For objects in the power namespace, Unit must be "Watts".
For objects in the energy namespace, Unit must be "Joules".
- For objects in the utilization namespace, Unit must be "Percent"
- For objects in the airflow namespace, Unit must be "CFM"
+ For objects in the fan_tach namespace, Unit must be "RPMS".
+ For objects in the power namespace, Unit must be "Watts".
For objects in the pressure namespace, Unit must be "Pascals"
+ For objects in the temperature namespace, Unit must be "DegreesC".
+ For objects in the utilization namespace, Unit must be "Percent"
+ For objects in the voltage namespace, Unit must be "Volts".
enumerations:
- name: Unit
description: >
A sensor reading unit.
values:
+ - name: Amperes
+ description: >
+ Electrical charge flow rate as Amperes.
+ - name: CFM
+ description: >
+ To calculate Air Flow in Cubic Feet per Minute
- name: DegreesC
description: >
Temperature as degrees Celsius.
+ - name: Joules
+ description: >
+ Energy transfer as Joules.
+ - name: Meters
+ description: >
+ Length as meters.
+ - name: Percent
+ description: >
+ Resource utilization as a percentage.
+ - name: Pascals
+ description: >
+ Pressure as pascals.
- name: RPMS
description: >
Frequency of rotation as revolutions per minute.
- name: Volts
description: >
Electomotive force as volts.
- - name: Meters
- description: >
- Length as meters.
- - name: Amperes
- description: >
- Electrical charge flow rate as Amperes.
- name: Watts
description: >
Rate of energy transfer as Watts.
- - name: Joules
- description: >
- Energy transfer as Joules.
- - name: Percent
- description: >
- Resource utilization as percentage.
- - name: CFM
- description: >
- To calculate Air Flow in Cubic Feet per Minute
- - name: Pascals
- description: >
- Pressure as pascal.