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
343
344
345
346
347
348
349
|
D-Bus API description for BlueZ
*******************************
Copyright (C) 2004-2006 Marcel Holtmann <marcel@holtmann.org>
Error hierachy
==============
Interface org.bluez.Error
Errors UnknownError
An unknown error occured. The error messages is
taken from the strerror(errno) function.
OutOfMemory
Error returned when a memory allocation via malloc()
fails. This error is similar to ENOMEM.
NoSuchAdapter
Error returned when the requested adapter doesn't
exists. This error is similar to ENODEV.
Manager hierarchy
=================
Service org.bluez
Interface org.bluez.Manager
Object path /org/bluez/Manager/
Methods array{string} ListAdapters()
Returns list of object paths under /org/bluez/Adapter/
string DefaultAdapter()
Returns object path for the default adapter.
Signals void AdapterAdded(string path)
Parameter is object path of added adapter.
void AdapterRemoved(string path)
Parameter is object path of removed adapter.
Adapter hierarchy
================
Service org.bluez
Interface org.bluez.Adapter
Object path /org/bluez/Adapter/{hci0,hci1,...}/
Methods string GetAddress()
Returns the device address for a given path.
Example: "00:11:22:33:44:55"
string GetVersion()
Returns the version of the Bluetooth chip. This version
is compiled from the LMP version. In case of EDR the
features attribute must be checked.
Example: "Bluetooth 2.0 + EDR"
string GetRevision()
Returns the revision of the Bluetooth chip. This is a
vendor specific value and in most cases it represents
the firmware version. This might derive from the HCI
revision and LMP subversion values or via extra vendor
specific commands.
Example: "HCI 19.2"
string GetManufacturer()
Returns the manufacturer of the Bluetooth chip.
Example: "Cambridge Silicon Radio"
string GetCompany()
Returns the company name from the OUI database of the
Bluetooth device address. This function will need a
valid and up-to-date oui.txt from the IEEE. This value
will be different from the manufacturer string in the
most cases.
Example: "Apple Computer"
array{string} GetFeatures()
Returns list of features supported by the adapter. This
list is only for showing them in the UI. No application
should implement different behaviors based on these
strings.
string GetMode()
Returns the current mode of a adapter.
Valid modes: "off", "connectable", "discoverable"
void SetMode(string mode)
Sets mode of the adapter. See GetMode for valid strings
for the mode parameter.
uint32 GetDiscoverableTimeout()
Returns the discoverable timeout in seconds. A value
of zero means that the timeout is disabled and it will
stay in discoverable mode forever.
The default value for the discoverable timeout should
be 180 seconds (3 minutes).
void SetDiscoverableTimeout(uint32 timeout)
Sets the discoverable timeout in seconds. A value of
zero disables the timeout and the adapter would be
always discoverable.
Changing this value doesn't set the adapter into
discoverable mode. The SetMode method must be used.
boolean IsConnectable()
Returns true if the local adapter is connectable and
false if it is switched off.
It is also possible to use GetMode to retrieve this
information.
boolean IsDiscoverable()
Returns true if the local adapter is discoverable and
false if it is only connectable or switched off.
It is also possible to use GetMode to retrieve this
information.
string GetMajorClass()
Returns the current major class value for this
system. This value is set to "computer" for now.
string GetMinorClass()
Returns the current minor class value for this
system where the default major class is "computer".
Valid values: "uncategorized", "desktop", "server",
"laptop", "handheld", "palm", "wearable"
The default value is "uncategorized".
void SetMinorClass(string minor)
Sets the local minor class and on success it sends
a MinorClassChanged signal.
array{string} GetServiceClasses()
Returns the current set of service classes.
Valid values: "positioning", "networking", "rendering",
"capturing", "object transfer", "audio",
"telephony", "information"
string GetName()
Returns the local adapter name (friendly name) in UTF-8.
void SetName(string name)
Sets the local adapter name. If EIR is supported by the
local hardware this modifies also the extended response
data value.
string GetRemoteVersion(string address)
Get the version info for a remote device. This request
returns always this information based on its cached
data. The base for this string is the LMP version
value and the features for EDR support.
Example: "Bluetooth 2.0 + EDR"
string GetRemoteRevision(string address)
Get the revision of the Bluetooth chip. This is a
vendor specific value and in most cases it represents
the firmware version. This derives only from the LMP
subversion value.
Example: "HCI 19.2"
string GetRemoteManufacturer(string address)
Get the manufacturer of the chip for a remote device.
Example: "Nokia Mobile Phones"
string GetRemoteCompany(string address)
Get the company name from the OUI database of the
Bluetooth device address. This function will need a
valid and up-to-date oui.txt from the IEEE. This value
will be different from the manufacturer string in the
most cases.
Example: "Microsoft Corporation"
string GetRemoteName(string address)
Get adapter name for a remote device. This request
returns always a cached name. The service daemon is
responsible for updating the cache.
If this is an empty value, then no remote name
available at the moment. The UI should show the
address in this case.
Example: "00:11:22:33:44:55", "Nokia 770"
string GetRemoteAlias(string address)
Returns alias name for remote device. If this is
an empty value, then no alias has been defined so far.
This is the default case and the UI should show the
remote name instead.
An alias should supersede the remote name.
void SetRemoteAlias(string address, string alias)
Sets alias name for remote device. If alias name is
empty, then no alias is set.
On success the SetRemoteAlias method will produce a
RemoteAliasChanged signal which applications can use
to update their current display of the remote device
name.
string LastSeen(string address)
Returns the date and time when the adapter has been
seen by a discover procedure.
Example: "2006-02-08 12:00:00 GMT"
string LastUsed(string address)
Returns the date and time of the last time when the
adapter has been connected.
Example: "2006-02-08 12:00:00 GMT"
void CreateBonding(string address)
This method creates a bonding with a remote device.
If a link key for this adapter already exists, this
procedure should fail instead of trying to create a
new pairing.
void RemoveBonding(string address)
This method removes the bonding with a remote device.
For security reasons this includes removing the actual
link key and also disconnecting any open connections
for the remote device.
If the link key was stored on the Bluetooth chip, it
must be removed from there, too.
boolean HasBonding(string address)
Returns true if the remote device is bonded and false
if no link key is available.
array{string} ListBondings()
List device addresses of currently bonded adapter.
uint8 PinCodeLength(string address)
Returns the PIN code length that was used in the
pairing process.
uint8 EncryptionKeySize(string address)
Returns the currently used encryption key size.
This method will fail if no connection to that adapter
has been established.
Signals void ModeChanged(string mode)
If the current mode is changed with SetMode this signal
will inform about the new mode.
This signal can also be triggered by low-level HCI
commands.
void MinorClassChanged(string minor)
After changing the minor class with SetMinorClass this
signal will provide the new class value.
void NameChanged(string name)
After changing the local adapter name with SetName this
signal will provide the new name.
This signal can also be triggered by low-level HCI
commands.
void RemoteNameChanged(string address, string name)
This signal will be send every time the service daemon
detect a new name for a remote device.
void RemoteAliasChanged(string address, string alias)
After changing an alias with SetRemoteAlias this signal
will indicate the new alias.
void BondingCreated(string address)
Signals that a successful bonding has been created.
void BondingFailed(string address)
Signals that a bonding has failed.
void BondingRemoved(string address)
Signals that a bonding was removed.
|
