From 7ce093041a19b7195ddab6940e62587edc7b99ea Mon Sep 17 00:00:00 2001 From: Luiz Augusto von Dentz Date: Wed, 4 May 2022 16:39:30 -0700 Subject: device-api: Clarify Paired/Bonded documentation This attempt to clarify the distinction of Paired and Bonded properties. --- doc/device-api.txt | 13 ++++++------- 1 file changed, 6 insertions(+), 7 deletions(-) (limited to 'doc') diff --git a/doc/device-api.txt b/doc/device-api.txt index 6a9066440..628accb8a 100644 --- a/doc/device-api.txt +++ b/doc/device-api.txt @@ -169,17 +169,16 @@ Properties string Address [readonly] boolean Paired [readonly] - Indicates if the remote device is paired. Pairing is - the process where devices exchange the information to - establish an encrypted connection. + Indicates if the remote device is paired. Paired means + the pairing process where devices exchange the + information to establish an encrypted connection has + been completed. boolean Bonded [readonly] Indicates if the remote device is bonded. Bonded means - the link key or the ltk from the pairing process has - been stored. - A PropertiesChanged signal indicate changes to this - status. + the information exchanged on pairing process has been + stored and will be persisted. boolean Connected [readonly] -- cgit v1.2.1