summaryrefslogtreecommitdiff
path: root/doc/mesh-api.txt
diff options
context:
space:
mode:
authorMichaƂ Lowas-Rzechonek <michal.lowas-rzechonek@silvair.com>2020-06-17 22:26:57 +0200
committerBrian Gix <brian.gix@intel.com>2020-06-18 08:34:14 -0700
commitc3410029520e7b1389446c34f03c51bb95bbf71b (patch)
treefbb6647fd6f32d00ce72af35e043e46cd33eaa2f /doc/mesh-api.txt
parentfd353235439effcb30402590b4e8a25c5dc189fc (diff)
downloadbluez-c3410029520e7b1389446c34f03c51bb95bbf71b.tar.gz
mesh: Replace BeaconFlags with just IvUpdate
To import nodes, applications need just IvIndex and IvUpdate. KeyRefresh phase in under provisioner's control, so we don't need to expose it. Moreover, BeaconFlags property dealt just with the primary net key, and each subnet key is refreshed separately.
Diffstat (limited to 'doc/mesh-api.txt')
-rw-r--r--doc/mesh-api.txt8
1 files changed, 4 insertions, 4 deletions
diff --git a/doc/mesh-api.txt b/doc/mesh-api.txt
index a0dcc6ff1..3be11e342 100644
--- a/doc/mesh-api.txt
+++ b/doc/mesh-api.txt
@@ -422,11 +422,11 @@ Properties:
This property indicates whether the periodic beaconing is
enabled (true) or disabled (false).
- uint8 BeaconFlags [read-only]
+ boolean IvUpdate [read-only]
- This property may be read at any time to determine the flag
- field setting on sent and received beacons of the primary
- network key.
+ When true, indicates that the network is in the middle of IV
+ Index Update procedure. This information is only useful for
+ provisioning.
uint32 IvIndex [read-only]