summaryrefslogtreecommitdiff
path: root/doc/mesh-api.txt
diff options
context:
space:
mode:
authorMichaƂ Lowas-Rzechonek <michal.lowas-rzechonek@silvair.com>2019-11-26 15:54:00 +0100
committerBrian Gix <brian.gix@intel.com>2019-11-26 10:56:44 -0800
commit676c91d05530cfd4ef2b943e750a63482fcd730e (patch)
tree2aee596f3a6ad67f8302542fc0027f92bf82fe6d /doc/mesh-api.txt
parenta73cdc09c0b2092a7911ef30b343c98ec64b7f94 (diff)
downloadbluez-676c91d05530cfd4ef2b943e750a63482fcd730e.tar.gz
mesh: Provide destination address in MessageReceived API
Diffstat (limited to 'doc/mesh-api.txt')
-rw-r--r--doc/mesh-api.txt17
1 files changed, 12 insertions, 5 deletions
diff --git a/doc/mesh-api.txt b/doc/mesh-api.txt
index a589616eb..23a958771 100644
--- a/doc/mesh-api.txt
+++ b/doc/mesh-api.txt
@@ -768,7 +768,7 @@ Object path <app_defined_element_path>
Methods:
void MessageReceived(uint16 source, uint16 key_index,
- boolean subscription, array{byte} data)
+ variant destination, array{byte} data)
This method is called by bluetooth-meshd daemon when a message
arrives addressed to the application.
@@ -781,10 +781,17 @@ Methods:
be used by the application when sending a response to this
message (in case a response is expected).
- The subscription parameter is a boolean that is set to true if
- the message is received as a part of the subscription (i.e., the
- destination is either a well known group address or a virtual
- label.
+ The destination parameter contains the destination address of
+ received message. Underlying variant types are:
+
+ uint16
+
+ Destination is an unicast address, or a well known
+ group address
+
+ array{byte}
+
+ Destination is a virtual address label
The data parameter is the incoming message.