summaryrefslogtreecommitdiffstats
path: root/xyz/openbmc_project/Sensor/Value.interface.yaml
diff options
context:
space:
mode:
authorBrad Bishop <bradleyb@us.ibm.com>2016-11-10 21:58:58 -0600
committerPatrick Williams <patrick@stwcx.xyz>2016-11-21 19:42:32 +0000
commit45387d650cd3ffa3ff8cd75e8478d1936fcd9ca4 (patch)
tree76015a65b80d4fa4358bbeff64c15437511b425f /xyz/openbmc_project/Sensor/Value.interface.yaml
parent6dc0fa206784840fa10d99786aae9fb9632bc0d4 (diff)
downloadphosphor-dbus-interfaces-45387d650cd3ffa3ff8cd75e8478d1936fcd9ca4.tar.gz
phosphor-dbus-interfaces-45387d650cd3ffa3ff8cd75e8478d1936fcd9ca4.zip
Add initial sensor interfaces
xyz.openbmc_project.Sensor.Value xyz.openbmc_project.Sensor.Threshold.Warning xyz.openbmc_project.Sensor.Threshold.Critical Change-Id: Ib3e993d0b2e87387993d7b6c1c8b1a47e71b5af1 Signed-off-by: Brad Bishop <bradleyb@fuzziesquirrel.com>
Diffstat (limited to 'xyz/openbmc_project/Sensor/Value.interface.yaml')
-rw-r--r--xyz/openbmc_project/Sensor/Value.interface.yaml53
1 files changed, 53 insertions, 0 deletions
diff --git a/xyz/openbmc_project/Sensor/Value.interface.yaml b/xyz/openbmc_project/Sensor/Value.interface.yaml
new file mode 100644
index 0000000..f8c1585
--- /dev/null
+++ b/xyz/openbmc_project/Sensor/Value.interface.yaml
@@ -0,0 +1,53 @@
+description: >
+ Implement to provide sensor readings. Objects implementing
+ Sensor.Value must be instantiated in the correct
+ hierarchy within the sensors namespace. The following sensor
+ hierarchies are recognized:
+ temperature
+ fan_tach
+ voltage
+ altitude
+
+ Any service implementing Sensor.Value on one or more objects must
+ implement org.freedesktop.DBus.ObjectManager on the sensors namespace root.
+
+ All Sensor.Value properties are read-only.
+
+properties:
+ - name: Value
+ type: int64
+ description: >
+ The sensor reading.
+ - name: Unit
+ type: enum[self.Unit]
+ description: >
+ The unit of the reading.
+ 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 altitude namespace, Unit must be "Meters".
+ - name: Scale
+ type: int64
+ description: >
+ The reading scaling factor N, where the actual reading is Value * 10^N.
+
+enumerations:
+ - name: Unit
+ description: >
+ A sensor reading unit.
+ values:
+ - name: DegreesC
+ description: >
+ Temperature as degrees Celsius.
+ - name: RPMS
+ description: >
+ Frequency of rotation as revolutions per minute.
+ - name: Volts
+ description: >
+ Electomotive force as volts.
+ - name: Meters
+ description: >
+ Length as meters.
+
+
+# vim: tabstop=8 expandtab shiftwidth=4 softtabstop=4
OpenPOWER on IntegriCloud