From db0581986a46da79a2dc290a698444a0f8f60083 Mon Sep 17 00:00:00 2001
From: Matt Ranostay <matt.ranostay@konsulko.com>
Date: Thu, 3 Jan 2019 21:14:05 -0800
Subject: binding: bluetooth-pbap: add initial README.md

Bug-AGL: SPEC-2095
Change-Id: Ib932342dd9f3da2b5f40648c2c11de325a519639
Signed-off-by: Matt Ranostay <matt.ranostay@konsulko.com>
---
 README.md | 95 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 95 insertions(+)
 create mode 100644 README.md

(limited to 'README.md')

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..cc89cef
--- /dev/null
+++ b/README.md
@@ -0,0 +1,95 @@
+# Bluetooth PBAP Service
+
+## Overview
+
+Bluetooth PBAP service reports respective vCard phonebook data from BlueZ via communication with PBAP profile
+
+## 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** |
+
+### contacts Verb
+
+Returns all vCards that are accessible from respective connected device in concatenated output:
+
+<pre>
+ "response": {
+     "vcards": "BEGIN:VCARD\r\nVERSION:3.0\r\nFN:Art McGee\r\nN:Art\r\nTEL: +13305551212\r\nUID:27e\r\nEND:VCARD\r\n"
+ }
+</pre>
+
+### search Verb
+
+Example of a request for vCard search using **number** parameter (i.e. *{"number":"+15035551212"}*) results:
+
+<pre>
+ "response": {
+     "results": [
+           {
+                "handle": "27e.vcf",
+                "name": "Art McGee"
+           }
+     ]
+ }                                       },
+</pre>
+
+### entry Verb
+
+Client must pass one of the following values to the **list** parameter in request:
+
+| Value         | Description                                      |
+|---------------|--------------------------------------------------|
+| ich           | Incoming calls                                   |
+| och           | Outgoing calls                                   |
+| mch           | Missed calls                                     |
+| cch           | Combined calls (e.g. incoming, outgoing, missed) |
+| pb            | Phonebook (typically selected)                   |
+
+Also there is a **handle** parameter that must be in form of vCard path (e.g. 27e.vcf).
+
+<pre>
+ "response": {
+     "vcard":"BEGIN:VCARD\r\nVERSION:3.0\r\nFN:Art McGee\r\nN:;Art\r\nTEL;TYPE=CELL:+13305551212\r\nUID:27e\r\nEND:VCARD\r\n"
+ }
+</pre>
+
+### history Verb
+
+Client must pass one of the following values to the list parameter in request:
+
+| Value         | Description                                      |
+|---------------|--------------------------------------------------|
+| ich           | Incoming calls                                   |
+| och           | Outgoing calls                                   |
+| mch           | Missed calls                                     |
+| cch           | Combined calls (e.g. incoming, outgoing, missed) |
+
+Sample request for a combined list (i.e. *{"list":"cch"}*) and its respective response:
+
+<pre>
+ "response": {
+     "vcards":"BEGIN:VCARD\r\nVERSION:3.0\r\nFN:Art \r\nN:\r\nTEL:3305551212\r\nX-IRMC-CALL-DATETIME;DIALED:20190103T202524\r\nEND:VCARD\r\nBEGIN:VCARD\r\nVERSION:3.0\r\nFN:Art McGee\r\nN:;Art\r\nTEL;TYPE=CELL:+15035551212\r\nUID:27e\r\nX-IRMC-CALL-DATETIME;RECEIVED:20181207T065311\r\nEND:VCARD\r\nBEGIN:VCARD\r\nVERSION:3.0\r\n"
+ }
+</pre>
+
+## Events
+
+Respective binding only outputs one event that signals if an PBAP capable device is connected
+
+### status Event
+
+Sample of a Bluetooth PBAP status event:
+
+<pre>
+{
+  "connected": true
+}
+</pre>
-- 
cgit 1.2.3-korg