summaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorMatt Ranostay <matt.ranostay@konsulko.com>2019-06-20 12:49:03 -0700
committerJan-Simon Moeller <jsmoeller@linuxfoundation.org>2019-06-21 11:31:03 +0000
commita8d8db0b5fbc67569b04470444f42cb9c6296303 (patch)
treedd2b1d4289ae9956b311faf0624423ce23948dfe /README.md
parent010af2a73f721b987f55028332023b00df7a70ce (diff)
binding: bluetooth-pbap: add import verb to improve transfer of contacts
Previously contacts are requested on every connection of a device by OBEX transfers, and due to issues with transfer rates it should be only done when requested. import verb requests new phonebook transfer, and returns data as the contacts verb currently does. Also this patchset switchs from the canonical MAC address to using the identifier from the Bluetooth stack for better connection tracking. Bug-AGL: SPEC-2541 Change-Id: I27ad0626248e8dba0cacd65f34843b8eec2ca754 Signed-off-by: Matt Ranostay <matt.ranostay@konsulko.com>
Diffstat (limited to 'README.md')
-rw-r--r--README.md31
1 files changed, 21 insertions, 10 deletions
diff --git a/README.md b/README.md
index 5d72482..8520dcd 100644
--- a/README.md
+++ b/README.md
@@ -6,19 +6,30 @@ Bluetooth PBAP service reports respective vCard phonebook data from BlueZ via co
## Verbs
-| Name | Description | JSON Response |
-|-------------|-------------------------------------------|----------------------------------------------------|
-| subscribe | subscribe to Bluetooth PBAP events | *Request:* {"value": "status"} |
-| unsubscribe | unsubscribe to Bluetooth PBAP events | *Request:* {"value": "status"} |
-| contacts | return all contacts from connected device | see **contacts verb section** |
-| entry | return vCard data from handle | see **entry verb section** |
-| history | return call history list | see **history verb section** |
-| search | search for respective vCard handle | see **search verb section** |
-| status | current device connection status | same response as noted in **status event section** |
+| Name | Description | JSON Response |
+|-------------|--------------------------------------------|----------------------------------------------------|
+| subscribe | subscribe to Bluetooth PBAP events | *Request:* {"value": "status"} |
+| unsubscribe | unsubscribe to Bluetooth PBAP events | *Request:* {"value": "status"} |
+| import | request contact data from connected device | see **import verb section** |
+| contacts | return all contacts from connected device | see **contacts verb section** |
+| entry | return vCard data from handle | see **entry verb section** |
+| history | return call history list | see **history verb section** |
+| search | search for respective vCard handle | see **search verb section** |
+| status | current device connection status | same response as noted in **status event section** |
+
+
+### import Verb
+
+Requests phonebook from connected device via OBEX transfers, caches the results to a database, and
+returns a response as documented in the **contacts verb section**
+
### contacts Verb
-Returns all vCards that are accessible from respective connected device in concatenated output:
+Returns all vCards that are accessible from respective connected device in concatenated output
+from the cached database.
+
+NOTE: This doesn't request refreshed data from device
<pre>