diff options
author | Patrick Venture <venture@google.com> | 2017-11-08 10:18:18 -0800 |
---|---|---|
committer | Patrick Venture <venture@google.com> | 2017-11-17 15:35:31 +0000 |
commit | 573f182806b61b8046573ef025de9c48a19887e8 (patch) | |
tree | b827d2b8810f6a421237750abea3f7715826c020 /xyz | |
parent | bb97d96dae396941ab7882d3c54f0671acca093b (diff) | |
download | phosphor-dbus-interfaces-573f182806b61b8046573ef025de9c48a19887e8.tar.gz phosphor-dbus-interfaces-573f182806b61b8046573ef025de9c48a19887e8.zip |
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 <venture@google.com>
Diffstat (limited to 'xyz')
-rw-r--r-- | xyz/openbmc_project/Sensor/Value.interface.yaml | 3 |
1 files changed, 2 insertions, 1 deletions
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 |