Blob: org.bluez.Bearer.LE.rst

Blob id: a4657755d119b0089ad89c511e49f3fdf566e321

Size: 3.7 KB

  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
===================
org.bluez.Bearer.LE
===================

---------------------------------------
BlueZ D-Bus Bearer LE API documentation
---------------------------------------

:Version: BlueZ
:Date: July 2025
:Manual section: 5
:Manual group: Linux System Administration

Interface
=========

:Service:	org.bluez
:Interface:	org.bluez.Bearer.LE1
:Object path:	[variable prefix]/{hci0,hci1,...}/dev_{BDADDR}

Methods
-------

void Connect() [experimental]
`````````````````````````````

Connects all LE profiles the remote device supports that can be connected to and
have been flagged as auto-connectable. If only subset of profiles is already
connected it will try to connect currently disconnected ones.

If at least one profile was connected successfully this method will indicate
success.

Possible errors:

:org.bluez.Error.NotReady:
:org.bluez.Error.Failed:
:org.bluez.Error.InProgress:
:org.bluez.Error.AlreadyConnected:

void Disconnect() [experimental]
````````````````````````````````

Disconnects all connected profiles and then terminates low-level ACL-LE
connection.

ACL-LE connection will be terminated even if some profiles were not disconnected
properly e.g. due to misbehaving device.

This method can be also used to cancel a preceding Connect call before a reply
to it has been received.

For non-trusted devices connected calling this method will disable incoming
connections until Connect method is called again.

Possible errors:

:org.bluez.Error.NotConnected:

Signals
-------

void Disconnected(string reason, string message) [experimental]
```````````````````````````````````````````````````````````````

This signal is launched when a device is disconnected, with the reason of the
disconnection.

This could be used by client application, depending on internal policy, to try
to reconnect to the device in case of timeout or unknown disconnection, or to
try to connect to another device.

Possible reasons:

:org.bluez.Reason.Unknown:

:org.bluez.Reason.Timeout:

	Connection timeout.

	The link supervision timeout has expired for a connection or the
	synchronization timeout has expired for a broadcast.

:org.bluez.Reason.Local:

	Connection terminated by local host.

	The local device terminated the connection, terminated synchronization
	with a broadcaster, or terminated broadcasting packets.

:org.bluez.Reason.Remote:

	Connection terminated by remote host.

	This disconnection can be due to:

	- the user on the remote device either terminated the connection or
	  stopped broadcasting packets,

	- the remote device terminated the connection because of low
	  resources,

	- the remote device terminated the connection because the device is
	  about to power off.

:org.bluez.Reason.Authentication:

	Connection terminated due to an authentication failure.

:org.bluez.Reason.Suspend:

	Connection terminated by local host for suspend.

Properties
----------

object Adapter [readonly, experimental]
```````````````````````````````````````

The object path of the adapter the set belongs to.

boolean Paired [readonly, experimental]
```````````````````````````````````````

Indicates if the remote device is paired to LE bearer.

Paired means the pairing process where devices exchange the information to
establish an encrypted connection has been completed.

boolean Bonded [readonly, experimental]
```````````````````````````````````````

Indicates if the remote device is bonded to LE bearer.

Bonded means the information exchanged on pairing process has been stored and
will be persisted.

boolean Connected [readonly, experimental]
``````````````````````````````````````````

Indicates if the remote device is currently connected to LE bearer.

A PropertiesChanged signal indicate changes to this status.