From 573f182806b61b8046573ef025de9c48a19887e8 Mon Sep 17 00:00:00 2001 From: Patrick Venture Date: Wed, 8 Nov 2017 10:18:18 -0800 Subject: sensor.value: update property documentation The Scale and Unit fields are immutable, they can't change for a sensor. This is to enable pre-configuring the Scale or Unit in the phosphor-host-ipmid YAML. Change-Id: I36d0567a04687146defc70d2e4dcd3444653f4fe Signed-off-by: Patrick Venture --- xyz/openbmc_project/Sensor/Value.interface.yaml | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/xyz/openbmc_project/Sensor/Value.interface.yaml b/xyz/openbmc_project/Sensor/Value.interface.yaml index 2a060e8..daa7f24 100644 --- a/xyz/openbmc_project/Sensor/Value.interface.yaml +++ b/xyz/openbmc_project/Sensor/Value.interface.yaml @@ -24,7 +24,7 @@ properties: - name: Unit type: enum[self.Unit] description: > - The unit of the reading. + 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". @@ -36,6 +36,7 @@ properties: type: int64 description: > The reading scaling factor N, where the actual reading is Value * 10^N. + This is immutable once set for a sensor. enumerations: - name: Unit -- cgit v1.2.1