1ORG.BLUEZ.ADAPTER(5) Linux System Administration ORG.BLUEZ.ADAPTER(5)
2
3
4
6 org.bluez.Adapter - BlueZ D-Bus Adapter API documentation
7
9 Service
10 org.bluez
11
12 Interface
13 org.bluez.Adapter1
14
15 Object path
16 [variable prefix]/{hci0,hci1,...}
17
18 Methods
19 void StartDiscovery()
20 Starts device discovery session which may include starting an in‐
21 quiry and/or scanning procedures and remote device name resolving.
22
23 Use StopDiscovery to release the sessions acquired.
24
25 This process will start creating Device objects as new devices are
26 discovered.
27
28 During discovery RSSI delta-threshold is imposed.
29
30 Each client can request a single device discovery session per
31 adapter.
32
33 Possible errors:
34
35 org.bluez.Error.NotReady
36
37 org.bluez.Error.Failed
38
39 org.bluez.Error.InProgress
40
41 void StopDiscovery()
42 Stops device discovery session started by StartDiscovery.
43
44 Note that a discovery procedure is shared between all discovery ses‐
45 sions thus calling StopDiscovery will only release a single session
46 and discovery will stop when all sessions from all clients have fin‐
47 ished.
48
49 Possible errors:
50
51 org.bluez.Error.NotReady
52
53 org.bluez.Error.Failed
54
55 org.bluez.Error.NotAuthorized
56
57 void RemoveDevice(object device)
58 Removes the remote device object at the given path including cahed
59 information such as bonding information.
60
61 Possible errors:
62
63 org.bluez.Error.InvalidArguments
64
65 org.bluez.Error.Failed
66
67 void SetDiscoveryFilter(dict filter)
68 Sets the device discovery filter for the caller. When this method is
69 called with no filter parameter, filter is removed.
70
71 Possible filter values:
72
73 array{string} UUIDs
74 Filter by service UUIDs, empty means match any UUID.
75
76 When a remote device is found that advertises any UUID from
77 UUIDs, it will be reported if:
78
79 • Pathloss and RSSI are both empty.
80
81 • only Pathloss param is set, device advertise TX power, and
82 computed pathloss is less than Pathloss param.
83
84 • only RSSI param is set, and received RSSI is higher than
85 RSSI param.
86
87 int16 RSSI
88 RSSI threshold value.
89
90 PropertiesChanged signals will be emitted for already exist‐
91 ing Device objects, with updated RSSI value. If one or more
92 discovery filters have been set, the RSSI delta-threshold,
93 that is imposed by StartDiscovery by default, will not be ap‐
94 plied.
95
96 uint16 Pathloss
97 Pathloss threshold value.
98
99 PropertiesChanged signals will be emitted for already exist‐
100 ing Device objects, with updated Pathloss value.
101
102 string Transport (Default "auto")
103 Transport parameter determines the type of scan.
104
105 Possible values:
106
107 "auto" Interleaved scan, use LE, BREDR, or both, depending on
108 what's currently enabled.
109
110 "bredr"
111 BR/EDR inquiry only.
112
113 "le" LE scan only.
114
115 bool DuplicateData (Default true)
116 Disables duplicate detection of advertisement data.
117
118 When enabled PropertiesChanged signals will be generated for
119 either ManufacturerData and ServiceData everytime they are
120 discovered.
121
122 bool Discoverable (Default false)
123 Make adapter discoverable while discovering, if the adapter
124 is already discoverable setting this filter won't do any‐
125 thing.
126
127 string Pattern (Default none)
128 Discover devices where the pattern matches either the prefix
129 of the address or device name which is convenient way to lim‐
130 ited the number of device objects created during a discovery.
131
132 When set disregards device discoverable flags.
133
134 Note: The pattern matching is ignored if there are other
135 client that don't set any pattern as it work as a logical OR,
136 also setting empty string "" pattern will match any device
137 found.
138
139 When discovery filter is set, Device objects will be created
140 as new devices with matching criteria are discovered regard‐
141 less of they are connectable or discoverable which enables
142 listening to non-connectable and non-discoverable devices.
143
144 When multiple clients call SetDiscoveryFilter, their filters
145 are internally merged, and notifications about new devices
146 are sent to all clients. Therefore, each client must check
147 that device updates actually match its filter.
148
149 When SetDiscoveryFilter is called multiple times by the same
150 client, last filter passed will be active for given client.
151
152 SetDiscoveryFilter can be called before StartDiscovery. It
153 is useful when client will create first discovery session, to
154 ensure that proper scan will be started right after call to
155 StartDiscovery.
156
157 Possible errors:
158
159 org.bluez.Error.NotReady
160
161 org.bluez.Error.NotSupported
162
163 org.bluez.Error.Failed
164
165 array{string} GetDiscoveryFilters()
166 Returns available filters that can be given to SetDiscoveryFilter.
167
168 Possible errors: None
169
170 object ConnectDevice(dict properties) [experimental]
171 connects to device without need of performing General Discovery.
172 Connection mechanism is similar to Connect method on org.bluez.De‐
173 vice1(5) interface with exception that this method returns success
174 when physical connection is established and you can specify bearer
175 to connect with parameter. After this method returns, services dis‐
176 covery will continue and any supported profile will be connected.
177 There is no need for calling Connect on Device1 after this call. If
178 connection was successful this method returns object path to created
179 device object or device that already exist.
180
181 Possible properties values:
182
183 string Address (Mandatory)
184 The Bluetooth device address of the remote device.
185
186 string AddressType (Default "BR/EDR")
187 The Bluetooth device Address Type. This is address type that
188 should be used for initial connection.
189
190 Possible values:
191
192 "public"
193 Public address
194
195 "random"
196 Random address
197
198 Possible errors:
199
200 org.bluez.Error.InvalidArguments
201
202 org.bluez.Error.AlreadyExists
203
204 org.bluez.Error.NotSupported
205
206 org.bluez.Error.NotReady
207
208 org.bluez.Error.Failed
209
210 Properties
211 string Address [readonly]
212 The Bluetooth device address.
213
214 string AddressType [readonly]
215 The Bluetooth Address Type. For dual-mode and BR/EDR only adapter
216 this defaults to "public". Single mode LE adapters may have either
217 value. With privacy enabled this contains type of Identity Address
218 and not type of address used for connection.
219
220 Possible values:
221
222 "public"
223 Public address.
224
225 "random
226 Random address.
227
228 string Name [readonly]
229 The Bluetooth system name (pretty hostname).
230
231 This property is either a static system default or controlled by an
232 external daemon providing access to the pretty hostname configura‐
233 tion.
234
235 string Alias [readwrite]
236 The Bluetooth friendly name. This value can be changed.
237
238 In case no alias is set, it will return the system provided name.
239 Setting an empty string as alias will convert it back to the system
240 provided name.
241
242 When resetting the alias with an empty string, the property will de‐
243 fault back to system name.
244
245 On a well configured system, this property never needs to be changed
246 since it defaults to the system name and provides the pretty host‐
247 name. Only if the local name needs to be different from the pretty
248 hostname, this property should be used as last resort.
249
250 uint32 Class [readonly]
251 The Bluetooth class of device.
252
253 This property represents the value that is either automatically con‐
254 figured by DMI/ACPI information or provided as static configuration.
255
256 boolean Powered [readwrite]
257 Switch an adapter on or off. This will also set the appropriate con‐
258 nectable state of the controller.
259
260 The value of this property is not persistent. After restart or un‐
261 plugging of the adapter it will reset back to false.
262
263 string PowerState [readonly, experimental]
264 The power state of an adapter.
265
266 The power state will show whether the adapter is turning off, or
267 turning on, as well as being on or off.
268
269 Possible values:
270
271 "on" Powered on.
272
273 "off" Powered off
274
275 "off-enabling"
276 Transitioning from "off" to "on".
277
278 "on-disabling"
279 Transitioning from "on" to "off".
280
281 "off-blocked"
282 Blocked by rfkill.
283
284 boolean Discoverable [readwrite] (Default: false)
285 Switch an adapter to discoverable or non-discoverable to either make
286 it visible or hide it. This is a global setting and should only be
287 used by the settings application.
288
289 If the DiscoverableTimeout is set to a non-zero value then the sys‐
290 tem will set this value back to false after the timer expired.
291
292 In case the adapter is switched off, setting this value will fail.
293
294 When changing the Powered property the new state of this property
295 will be updated via a PropertiesChanged signal.
296
297 boolean Pairable [readwrite] (Default: true)
298 Switch an adapter to pairable or non-pairable. This is a global set‐
299 ting and should only be used by the settings application.
300
301 Note that this property only affects incoming pairing requests.
302
303 uint32 PairableTimeout [readwrite] (Default: 0)
304 The pairable timeout in seconds. A value of zero means that the
305 timeout is disabled and it will stay in pairable mode forever.
306
307 uint32 DiscoverableTimeout [readwrite] (Default: 180)
308 The discoverable timeout in seconds. A value of zero means that the
309 timeout is disabled and it will stay in discoverable/limited mode
310 forever.
311
312 boolean Discovering [readonly]
313 Indicates that a device discovery procedure is active.
314
315 array{string} UUIDs [readonly]
316 List of 128-bit UUIDs that represents the available local services.
317
318 string Modalias [readonly, optional]
319 Local Device ID information in modalias format used by the kernel
320 and udev.
321
322 array{string} Roles [readonly]
323 List of supported roles.
324
325 Possible values:
326
327 "central"
328 Supports the central role.
329
330 "peripheral"
331 Supports the peripheral role.
332
333 "central-peripheral"
334 Supports both roles concurrently.
335
336 array{string} ExperimentalFeatures [readonly, optional]
337 List of 128-bit UUIDs that represents the experimental features cur‐
338 rently enabled.
339
340 uint16 Manufacturer [readonly]
341 The manufacturer of the device, as a uint16 company identifier de‐
342 fined by the Core Bluetooth Specification.
343
344 byte Version [readonly]
345 The Bluetooth version supported by the device, as a core version
346 code defined by the Core Bluetooth Specification.
347
348
349
350
351BlueZ October 2023 ORG.BLUEZ.ADAPTER(5)