1ORG.BLUEZ.DEVICE(5)       Linux System Administration      ORG.BLUEZ.DEVICE(5)
2
3
4

NAME

6       org.bluez.Device - BlueZ D-Bus Device API documentation
7

INTERFACE

9       Service
10              org.bluez
11
12       Interface
13              org.bluez.Device1
14
15       Object path
16              [variable prefix]/{hci0,hci1,...}/dev_XX_XX_XX_XX_XX_XX
17
18   Methods
19   void Connect()
20          Connects  all  profiles  the remote device supports that can be con‐
21          nected to and have been flagged as auto-connectable. If only  subset
22          of  profiles  is  already connected it will try to connect currently
23          disconnected ones.
24
25          If at least one profile was connected successfully this method  will
26          indicate success.
27
28          For dual-mode devices only one bearer is connected at time, the con‐
29          ditions are in the following order:
30
31          1. Connect the disconnected bearer if already connected.
32
33          2. Connect first the bonded bearer. If no bearers are bonded or both
34          are skip and check latest seen bearer.
35
36          3.  Connect  last  seen  bearer, in case the timestamps are the same
37          BR/EDR takes precedence.
38
39          Possible errors:
40
41          org.bluez.Error.NotReady
42
43          org.bluez.Error.Failed
44
45          org.bluez.Error.InProgress
46
47          org.bluez.Error.AlreadyConnected
48
49   void Disconnect()
50          Disconnects all connected profiles and then terminates low-level ACL
51          connection.
52
53          ACL  connection  will  be  terminated even if some profiles were not
54          disconnected properly e.g. due to misbehaving device.
55
56          This method can be also used to cancel a preceding Connect call  be‐
57          fore a reply to it has been received.
58
59          For non-trusted devices connected over LE bearer calling this method
60          will disable incoming connections until  Connect  method  is  called
61          again.
62
63          Possible errors:
64
65          org.bluez.Error.NotConnected
66
67   void ConnectProfile(string uuid)
68          Connects a specific profile of this device. The UUID provided is the
69          remote service UUID for the profile.
70
71          Possible errors:
72
73          org.bluez.Error.Failed
74
75          org.bluez.Error.InProgress
76
77          org.bluez.Error.InvalidArguments
78
79          org.bluez.Error.NotAvailable
80
81          org.bluez.Error.NotReady
82
83   void DisconnectProfile(string uuid)
84          Disconnects a specific profile of this device. The profile needs  to
85          be registered client profile.
86
87          There  is  no  connection  tracking for a profile, so as long as the
88          profile is registered this will always succeed.
89
90          Possible errors:
91
92          org.bluez.Error.Failed
93
94          org.bluez.Error.InProgress
95
96          org.bluez.Error.InvalidArguments
97
98          org.bluez.Error.NotSupported
99
100   void Pair()
101          Connects to the remote device and initiate  pairing  procedure  then
102          proceed with service discovery.
103
104          If  the application has registered its own agent, then that specific
105          agent will be used. Otherwise it will use the default agent.
106
107          Only for applications like a pairing wizard it would make  sense  to
108          have its own agent. In almost all other cases the default agent will
109          handle this just fine.
110
111          In case there is no application agent  and  also  no  default  agent
112          present, this method will fail.
113
114          Possible errors:
115
116          org.bluez.Error.InvalidArguments
117
118          org.bluez.Error.Failed
119
120          org.bluez.Error.AlreadyExists
121
122          org.bluez.Error.AuthenticationCanceled
123
124          org.bluez.Error.AuthenticationFailed
125
126          org.bluez.Error.AuthenticationRejected
127
128          org.bluez.Error.AuthenticationTimeout
129
130          org.bluez.Error.ConnectionAttemptFailed
131
132   void CancelPairing()
133          Cancels a pairing operation initiated by the Pair method.
134
135          Possible errors:
136
137          org.bluez.Error.DoesNotExist
138
139          org.bluez.Error.Failed
140
141   Properties
142   string Address [readonly]
143          The Bluetooth device address of the remote device.
144
145   string AddressType [readonly]
146          The Bluetooth device Address Type. For dual-mode and BR/EDR only de‐
147          vices this defaults to "public". Single mode LE devices may have ei‐
148          ther  value.  If remote device uses privacy than before pairing this
149          represents address type used for connection and Identity Address af‐
150          ter pairing.
151
152          Possible values:
153
154          "public"
155                 Public address
156
157          "random"
158                 Random address
159
160   string Name [readonly, optional]
161          The Bluetooth remote name.
162
163          This  value is only present for completeness. It is better to always
164          use the Alias property when displaying the devices name.
165
166          If the Alias property is unset, it will  reflect  this  value  which
167          makes it more convenient.
168
169   string Icon [readonly, optional]
170          Proposed  icon  name  according  to  the freedesktop.org icon naming
171          specification.
172
173   uint32 Class [readonly, optional]
174          The Bluetooth class of device of the remote device.
175
176   uint16 Appearance [readonly, optional]
177          External appearance of device, as found on GAP service.
178
179   array{string} UUIDs [readonly, optional]
180          List of 128-bit UUIDs that represents the available remote services.
181
182   boolean Paired [readonly]
183          Indicates if the remote device is paired. Paired means  the  pairing
184          process  where  devices exchange the information to establish an en‐
185          crypted connection has been completed.
186
187   boolean Bonded [readonly]
188          Indicates if the remote device is bonded. Bonded means the  informa‐
189          tion  exchanged  on pairing process has been stored and will be per‐
190          sisted.
191
192   boolean Connected [readonly]
193          Indicates if the remote device is currently connected.  A  Properti‐
194          esChanged signal indicate changes to this status.
195
196   boolean Trusted [readwrite]
197          Indicates  if  the  remote  is  seen as trusted. This setting can be
198          changed by the application.
199
200   boolean Blocked [readwrite]
201          If set to true any incoming connections from the device will be  im‐
202          mediately  rejected.  Any device drivers will also be removed and no
203          new ones will be probed as long as the device is blocked.
204
205   boolean WakeAllowed [readwrite]
206          If set to true this device will be allowed to  wake  the  host  from
207          system suspend.
208
209   string Alias [readwrite]
210          The  name alias for the remote device. The alias can be used to have
211          a different friendly name for the remote device.
212
213          In case no alias is set, it will return the remote device name. Set‐
214          ting an empty string as alias will convert it back to the remote de‐
215          vice name.
216
217          When resetting the alias with an empty string, the property will de‐
218          fault back to the remote name.
219
220   object Adapter [readonly]
221          The object path of the adapter the device belongs to.
222
223   boolean LegacyPairing [readonly]
224          Set  to  true if the device only supports the pre-2.1 pairing mecha‐
225          nism.  This property is useful during device discovery to anticipate
226          whether legacy or simple pairing will occur if pairing is initiated.
227
228          Note  that  this property can exhibit false-positives in the case of
229          Bluetooth 2.1 (or newer) devices that have disabled Extended Inquiry
230          Response support.
231
232   string Modalias [readonly, optional]
233          Remote  Device  ID information in modalias format used by the kernel
234          and udev.
235
236   int16 RSSI [readonly, optional]
237          Received Signal Strength Indicator of the remote device (inquiry  or
238          advertising).
239
240   int16 TxPower [readonly, optional]
241          Advertised transmitted power level (inquiry or advertising).
242
243   dict ManufacturerData [readonly, optional]
244          Manufacturer  specific advertisement data. Keys are 16 bits Manufac‐
245          turer ID followed by its byte array value.
246
247   dict ServiceData [readonly, optional]
248          Service advertisement data. Keys are the UUIDs in string format fol‐
249          lowed by its byte array value.
250
251   bool ServicesResolved [readonly]
252          Indicate whether or not service discovery has been resolved.
253
254   array{byte} AdvertisingFlags [readonly, experimental]
255          The Advertising Data Flags of the remote device.
256
257   dict AdvertisingData [readonly, experimental]
258          The  Advertising  Data of the remote device. Keys are 1 byte AD Type
259          followed by data as byte array.
260
261          Note: Only types considered safe to be handled  by  application  are
262          exposed.
263
264          Possible values:
265
266          <type> <byte array>
267
268          Example:
269              <Transport     Discovery>     <Organization    Flags...>    0x26
270              0x01         0x01...
271
272   array{object, dict} Sets [readonly, experimental]
273          The object paths of the sets the device belongs  to  followed  by  a
274          dictionary which can contain the following:
275
276          byte Rank
277                 Rank of the device in the Set.
278
279
280
281
282BlueZ                            October 2023              ORG.BLUEZ.DEVICE(5)