doc/mesh-api: Add ExportKeys call

Add description for a new method:
ExportKeys() on org.bluez.mesh.Management1 interface.

This method is used by the authorized application to export information
about network keys, application keys and device keys present in the local
key database.

Signed-off-by: Anuj Jain <anuj01.jain@samsung.com>
Signed-off-by: Ayush Garg <ayush.garg@samsung.com>

diff --git a/doc/mesh-api.txt b/doc/mesh-api.txt
index d1d29d23634b48bc18b2f7064ab1cceceffefba7..9c32dbe6e5da25dc7367fd20abbd8b5e6ced69de 100644 (file)
--- a/doc/mesh-api.txt
+++ b/doc/mesh-api.txt
@@ -739,6 +739,62 @@ Methods:
                PossibleErrors:
                        org.bluez.mesh.Error.InvalidArguments
 
+       dict ExportKeys(void)
+
+               This method is used by the application to export information
+               about network keys, application keys and device keys present
+               in the local key database.
+
+               dict
+                       A dictionary that contains information for the keys
+                       stored in the keyring with the following keys defined:
+
+                       NetKeys:
+                               array{struct} net_keys:
+
+                               uint16 index
+                                       Subnet index
+
+                               array{byte}[16] key
+
+                               dict:
+                                       A dictionary that contains optional
+                                       key info with the following keys
+                                       defined:
+
+                                       uint8 Phase
+                                               Key Refresh phase of the subnet
+
+                                       array{byte}[16] OldKey
+
+                                       array{struct} AppKeys:
+
+                                               uint16 index
+
+                                                       Application key index
+
+                                               array{byte}[16] key
+
+                                               dict:
+                                                       A dictionary of optional
+                                                       key info with the
+                                                       following keys defined:
+
+                                                       array{byte}[16] OldKey
+
+                       DevKeys:
+                               array{struct} dev_keys:
+
+                               Device Key information for known remote
+                               nodes in the configured Mesh network
+
+                               uint16 unicast
+
+                                       Unicast address of the node's primary
+                                       element
+
+                               array{byte}[16] key
+
 Mesh Application Hierarchy
 ==========================
 Service                unique name