summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorLei YU <mine260309@gmail.com>2017-08-10 15:35:04 +0800
committerBrad Bishop <bradleyb@fuzziesquirrel.com>2017-10-16 09:20:42 -0400
commitdce347440e4307aa8ff237d67caee33246103708 (patch)
treee4018a7a0ae28fda14f825b2d7fa6d6ac44dc161
parent19cefffd6735cd869de7e63970ccd8ace7befa5a (diff)
downloadopenbmc-docs-dce347440e4307aa8ff237d67caee33246103708.tar.gz
openbmc-docs-dce347440e4307aa8ff237d67caee33246103708.zip
sensor-architecture.md: Add note for valid label path
Change-Id: I837dedae986c615ed9a23707bda4ffa7494a4a3b Signed-off-by: Lei YU <mine260309@gmail.com> Signed-off-by: Brad Bishop <bradleyb@fuzziesquirrel.com>
-rw-r--r--sensor-architecture.md5
1 files changed, 5 insertions, 0 deletions
diff --git a/sensor-architecture.md b/sensor-architecture.md
index 980f979..62df59b 100644
--- a/sensor-architecture.md
+++ b/sensor-architecture.md
@@ -25,6 +25,9 @@ case. Examples include `temperature, fan, voltage`.
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;**\<label>** : User defined
name of the sensor. Examples include `ambient, cpu0, fan5`
+**Note**: The label shall comply with "Valid Object Paths" of [D-Bus Spec][1],
+that shall only contain the ASCII characters "[A-Z][a-z][0-9]_".
+
## Development Details ##
@@ -243,3 +246,5 @@ added. The instance path will be `/xyz/openbmc_project/Sensors/fan/fan0`.
## Additional Reading ##
Mailing List [Comments on Sensor design](https://lists.ozlabs.org/pipermail/openbmc/2016-November/005309.html)
+
+[1]: https://dbus.freedesktop.org/doc/dbus-specification.html#basic-types
OpenPOWER on IntegriCloud