1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
|
# Bluetooth Service
## Overview
Bluetooth service uses the respective BlueZ package to connect to bluetooth devices
## Verbs
| Name | Description | JSON Response |
|--------------------|---------------------------------------------------------|-------------------------------------------------------------------------|
| subscribe | subscribe to bluetooth events | *Request:* {"value": "device_changes"} |
| unsubscribe | unsubscribe to bluetooth events | *Request:* {"value": "device_changes"} |
| managed_objects | retrieve managed bluetooth devices | see managed_objects verb section |
| adapter_state | retrieve or change adapter scan settings | see adapter_state verb section |
| default_adapter | retrieve or change default adapter setting | *Request:* {"adapter": "hci1"} |
| avrcp_controls | avrcp controls for MediaPlayer1 playback | see avrcp_controls verb section |
| connect | connect to already paired device | see connect/disconnect verb section |
| disconnect | disconnect to already connected device | see connect/disconnect verb section |
| pair | initialize a pairing request | *Request:* {"device":"dev_88_0F_10_96_D3_20"} |
| cancel_pairing | cancel an outgoing pair request | |
| confirm_pairing | confirm incoming/outgoing bluetooth pairing pincode | *Request:* {"pincode": 31415} |
| remove_device | remove already paired device | *Request:* {"device": "dev_88_0F_10_96_D3_20"} |
### managed_objects verb
This verb allows an client to get initial paired devices, and discovered unpaired devices before subscriptio to *devices_changed* event.
<pre>
{
"response": {
"adapters": [
{
"name": "hci0",
"properties": {
"address": "00:1A:7D:DA:71:0F",
"powered": true,
"discoverable": true,
"discoverabletimeout": 180,
"pairable": true,
"pairabletimeout": 0,
"discovering": true,
"uuids": [
"00001112-0000-1000-8000-00805f9b34fb",
"00001801-0000-1000-8000-00805f9b34fb",
"0000110e-0000-1000-8000-00805f9b34fb",
"00001800-0000-1000-8000-00805f9b34fb",
"00001200-0000-1000-8000-00805f9b34fb",
"0000110c-0000-1000-8000-00805f9b34fb",
"0000110b-0000-1000-8000-00805f9b34fb",
"0000110a-0000-1000-8000-00805f9b34fb",
"0000111e-0000-1000-8000-00805f9b34fb",
"0000111f-0000-1000-8000-00805f9b34fb",
"00001108-0000-1000-8000-00805f9b34fb"
]
}
}
],
"devices": [
{
"adapter": "hci0",
"device": "dev_F8_34_41_DA_BA_46",
"properties": {
"address": "F8:34:41:DA:BA:46",
"name": "roguebox",
"alias": "roguebox",
"class": 1835276,
"icon": "computer",
"paired": false,
"trusted": false,
"blocked": false,
"legacypairing": false,
"rssi": -63,
"connected": false,
"uuids": [
"0000110e-0000-1000-8000-00805f9b34fb",
"0000110c-0000-1000-8000-00805f9b34fb",
"00001112-0000-1000-8000-00805f9b34fb",
"00001108-0000-1000-8000-00805f9b34fb",
"00001133-0000-1000-8000-00805f9b34fb",
"00001132-0000-1000-8000-00805f9b34fb",
"0000112f-0000-1000-8000-00805f9b34fb",
"00001104-0000-1000-8000-00805f9b34fb",
"00001106-0000-1000-8000-00805f9b34fb",
"00001105-0000-1000-8000-00805f9b34fb",
"0000110a-0000-1000-8000-00805f9b34fb",
"0000110b-0000-1000-8000-00805f9b34fb",
"00005005-0000-1000-8000-0002ee000001"
],
"modalias": "usb:v1D6Bp0246d0530",
"adapter": "/org/bluez/hci0",
"txpower": 12,
"servicesresolved": false
}
},
{
"adapter": "hci0",
"device": "dev_67_13_E2_57_29_0F",
"properties": {
"address": "68:13:E2:57:29:0F",
"alias": "67-13-E2-57-29-0F",
"paired": false,
"trusted": false,
"blocked": false,
"legacypairing": false,
"rssi": -69,
"connected": false,
"uuids": [],
"adapter": "/org/bluez/hci0",
"servicesresolved": false
}
},
],
"transports": [
{
"endpoint": "fd1",
"adapter": "hci0",
"device": "dev_D0_81_7A_5A_BC_5E",
"properties": {
"uuid": "0000110B-0000-1000-8000-00805F9B34FB",
"state": "idle",
"volume": 127
}
}
],
}
</pre>
### adapter_state verb
#### adapter_state verb allows setting and retrieving of requested adapter settings
| Name | Description |
|-----------------|------------------------------------------------------------------------|
| adapter | Must be the name of the adapter (i.e. hci0) |
| discovery | Discover nearby broadcasting devices |
| discoverable | Allow other devices to detect this device |
| powered | Adapter power state (optional, rfkill should be disabled already) |
#### adapter_state verb write-only parameters
| Name | Description |
|-----------------|--------------------------------------------------------------------------|
| filter | Scan for devices only with respective UUIDS listed |
| transport | Scan for devices with only defined transport type (e.g. auto, bredr, le) |
### avrcp_controls verb
avrcp_controls verb allow controlling the playback of the defined device
| Name | Description |
|-----------------|----------------------------------------------------------------------------------------------|
| adapter | Name of the adapter (i.e. hci0) |
| device | Must be the name of the device (i.e. dev_88_0F_10_96_D3_20) |
| action | Playback control action to take (e.g Play, Pause, Stop, Next, Previous, FastForward, Rewind) |
### connect/disconnect verbs
NOTE: uuid in this respect is not related to the afb framework but the Bluetooth profile UUID
To connect/disconnect using the respective verb with all known and authenticated profiles:
<pre>
{"device": "dev_88_0F_10_96_D3_20"}
</pre>
To do the same for the respective device, verb, and for singular profile
<pre>
{"device": "dev_88_0F_10_96_D3_20", "uuid": "0000110e-0000-1000-8000-00805f9b34fb"}
</pre>
## Events
| Name | Description | JSON Event Data |
|-------------------|------------------------------------------|-------------------------------------------|
| adapter_changes | report on Bluetooth adapter states | see adapter_changes event section |
| device_changes | report on Bluetooth devices | see device_changes event section |
| media | report on MediaPlayer1 events | see media event section |
| agent | PIN from BlueZ agent for confirmation | see agent event section |
### adapter_changes event
Sample of adding new adapter event:
<pre>
{
"adapter": "hci0",
"action": "added",
"properties": {
"address": "60:30:D4:66:55:A7",
"powered": false,
"discoverable": false,
"discoverabletimeout": 180,
"pairable": true,
"pairabletimeout": 0,
"discovering": false,
"uuids": [
"00001801-0000-1000-8000-00805f9b34fb",
"0000110e-0000-1000-8000-00805f9b34fb",
"00001200-0000-1000-8000-00805f9b34fb",
"00001800-0000-1000-8000-00805f9b34fb",
"0000111e-0000-1000-8000-00805f9b34fb",
"0000110c-0000-1000-8000-00805f9b34fb"
]
}
}
</pre>
Sample of adapter being remove:
<pre>
{
"adapter": "hci0",
"action": "removed",
}
</pre>
### device_changes event
Sample of discovering a new device event:
<pre>
{
"adapter": "hci0",
"device": "dev_88_0F_10_96_D3_20",
"action": "added",
"properties": {
"address": "88:0F:10:96:D3:20",
"name": "MI_SCALE",
"alias": "MI_SCALE",
"class": 7995916,
"icon": "phone",
"paired": false,
"trusted": false,
"blocked": false,
"legacypairing": false,
"rssi": -55,
"connected": false,
"uuids": [
"00001200-0000-1000-8000-00805f9b34fb",
"0000111f-0000-1000-8000-00805f9b34fb",
"0000112f-0000-1000-8000-00805f9b34fb",
"0000110a-0000-1000-8000-00805f9b34fb",
"0000110c-0000-1000-8000-00805f9b34fb",
"00001116-0000-1000-8000-00805f9b34fb",
"00001132-0000-1000-8000-00805f9b34fb",
"00000000-deca-fade-deca-deafdecacafe",
"02030302-1d19-415f-86f2-22a2106a0a77",
"2d8d2466-e14d-451c-88bc-7301abea291a"
],
"adapter": "/org/bluez/hci0",
"servicesresolved": false
}
}
</pre>
Changed status events for a device:
<pre>
{
"adapter": "hci0",
"device": "dev_88_0F_10_96_D3_20",
"action": "changed",
"properties": {
"connected": true
}
}
</pre>
### media event
Playing audio reporting event (not all fields will be passed in every event):
<pre>
{
"adapter": "hci0",
"device": "dev_D0_81_7A_5A_BC_5E",
"type": "playback",
"track": {
"title": "True Colors",
"duration": 228000,
"album": "True Colors",
"tracknumber": 6,
"artist": "Zedd",
"numberoftracks": 11,
"genre": "Dance & DJ/General"
},
"position": 5600,
"status": "playing",
"connected": true,
"player": "player0"
}
</pre>
A2DP transport addition/removal (some fields are optional):
<pre>
{
"adapter": "hci0",
"device": "dev_D0_81_7A_5A_BC_5E",
"action": "added",
"type": "transport",
"endpoint": "fd0"
"properties": {
"uuid": "0000110B-0000-1000-8000-00805F9B34FB",
"state": "idle",
"volume": 127
},
}
...
{
"adapter": "hci0",
"device": "dev_D0_81_7A_5A_BC_5E",
"action": "removed",
"type": "transport",
"endpoint": "fd0"
}
</pre>
### agent event
After pairing request agent will send event for a pincode that must be confirmed on both sides:
<pre>
{
"adapter": "hci0",
"device": "dev_88_OF_10_96_D3_20",
"action": "request_confirmation",
"pincode": 327142
}
</pre>
If pairing is canceled or fails:
<pre>
{
"action": "canceled_pairing"
}
</pre>
|
