summaryrefslogtreecommitdiff
path: root/doc/mesh-api.txt
diff options
context:
space:
mode:
authorInga Stotland <inga.stotland@intel.com>2021-02-12 13:42:41 -0800
committerBrian Gix <brian.gix@intel.com>2021-02-16 11:51:00 -0800
commit400e738bf07b5950460e3246af343a1737918481 (patch)
treee521f32082dc2eedceb11dd887098d40022bfc5e /doc/mesh-api.txt
parent1f4ec8fb9d36fb7678385fd631459d80b57fc662 (diff)
downloadbluez-400e738bf07b5950460e3246af343a1737918481.tar.gz
doc/mesh-api: Add notion of Device UUID compliance
Add requirement that the value of Device UUID supplied in CreateNetwork/Join/Import methods should be compliant with RFC 4122.
Diffstat (limited to 'doc/mesh-api.txt')
-rw-r--r--doc/mesh-api.txt9
1 files changed, 6 insertions, 3 deletions
diff --git a/doc/mesh-api.txt b/doc/mesh-api.txt
index 254ccbd7f..f2c6b9e5c 100644
--- a/doc/mesh-api.txt
+++ b/doc/mesh-api.txt
@@ -27,7 +27,8 @@ Methods:
The uuid parameter is a 16-byte array that contains Device UUID.
This UUID must be unique (at least from the daemon perspective),
therefore attempting to call this function using already
- registered UUID results in an error.
+ registered UUID results in an error. The composition of the UUID
+ octets must be in compliance with RFC 4122.
When provisioning finishes, the daemon will call either
JoinComplete or JoinFailed method on object implementing
@@ -149,7 +150,8 @@ Methods:
The uuid parameter is a 16-byte array that contains Device UUID.
This UUID must be unique (at least from the daemon perspective),
therefore attempting to call this function using already
- registered UUID results in an error.
+ registered UUID results in an error. The composition of the UUID
+ octets must be in compliance with RFC 4122.
The other information the bluetooth-meshd daemon will preserve
about the initial node, is to give it the initial primary
@@ -179,7 +181,8 @@ Methods:
The uuid parameter is a 16-byte array that contains Device UUID.
This UUID must be unique (at least from the daemon perspective),
therefore attempting to call this function using already
- registered UUID results in an error.
+ registered UUID results in an error. The composition of the UUID
+ octets must be in compliance with RFC 4122.
The dev_key parameter is the 16-byte value of the dev key of
the imported mesh node.