CompleteAppKeyUpdate() - Used in conjunction with SetKeyPhase()
---
doc/mesh-api.txt | 26 +++++++++++++++++++++++++-
1 file changed, 25 insertions(+), 1 deletion(-)
diff --git a/doc/mesh-api.txt b/doc/mesh-api.txt
index 112990a5d..3fad2fc6f 100644
--- a/doc/mesh-api.txt
+++ b/doc/mesh-api.txt
@@ -434,6 +434,7 @@ Methods:
PossibleErrors:
org.bluez.mesh.Error.InvalidArguments
org.bluez.mesh.Error.DoesNotExist
+ org.bluez.mesh.Error.Busy
void DeleteSubnet(uint16 net_index)
@@ -451,7 +452,9 @@ Methods:
void SetKeyPhase(uint16 net_index, uint8 phase)
This method is used to set the master key update phase of the
- given subnet.
+ given subnet. When finalizing the procedure, it is important
+ to CompleteAppKeyUpdate() on all app keys that have been
+ updated during the procedure prior to setting phase 3.
The net_index parameter is a 12-bit value (0x000-0xFFF)
specifying which subnet phase to set.
@@ -491,6 +494,7 @@ Methods:
PossibleErrors:
org.bluez.mesh.Error.InvalidArguments
org.bluez.mesh.Error.AlreadyExists
+ org.bluez.mesh.Error.DoesNotExist
void ImportAppKey(uint16 net_index, uint16 app_index,
array{byte}[16] app_key)
@@ -512,6 +516,7 @@ Methods:
PossibleErrors:
org.bluez.mesh.Error.InvalidArguments
org.bluez.mesh.Error.AlreadyExists
+ org.bluez.mesh.Error.DoesNotExist
void UpdateAppKey(uint16 app_index)
@@ -524,6 +529,25 @@ Methods:
This call affects the local bluetooth-meshd key database only.
+ PossibleErrors:
+ org.bluez.mesh.Error.InvalidArguments
+ org.bluez.mesh.Error.DoesNotExist
+ org.bluez.mesh.Error.Busy
+
+ void CompleteAppKeyUpdate(uint16 app_index)
+
+ This method is used by the application at the completion of
+ a Key Refresh Procedure. This method should be called for each
+ app key being updated during the procedure, and must be
+ performed prior to changing the phase of the bound net key
+ to phase 3. (See SetKeyPhase() method).
+
+ The app_index parameter is a 12-bit value (0x000-0xFFF)
+ specifying which app key was updated. Note that the subnet that
+ the key is bound to must exist and be in Phase 2.
+
+ This call affects the local bluetooth-meshd key database only.
+
PossibleErrors:
org.bluez.mesh.Error.InvalidArguments
org.bluez.mesh.Error.DoesNotExist
--
2.14.5
