aboutsummaryrefslogtreecommitdiffstatshomepage
path: root/doc/org.bluez.DeviceSet.rst
blob: c6dc8b075980a95cf90b6e3448ae9c2e33422880 (plain)
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
===================
org.bluez.DeviceSet
===================

---------------------------------------
BlueZ D-Bus DeviceSet API documentation
---------------------------------------

:Version: BlueZ
:Date: September 2023
:Manual section: 5
:Manual group: Linux System Administration

Interface
=========

:Service:	org.bluez
:Interface:	org.bluez.DeviceSet1
:Object path:	[variable prefix]/{hci0,hci1,...}/set_{sirk}

Methods
-------

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

	Connects all **devices** members of the set, each member is
	connected in sequence as they were added/loaded following the
	same proceedure as described in **Device1.Connect**.

	Possible errors:

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

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

	Disconnects all **devices** members of the set, each member is
	disconnected in sequence as they were connected following the
	same proceedure as described in **Device1.Disconnect**.

	Possible errors:

	:org.bluez.Error.NotConnected:

Properties
----------

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

	The object path of the adapter the set belongs to.

bool AutoConnect [read-write, experimental]
```````````````````````````````````````````

	Indicates if the **devices** members of the set shall be automatically
	connected once any of its members is connected.

array(object) Devices [ready-only, experimental]
````````````````````````````````````````````````

	List of devices objects that are members of the set.

byte Size [read-only, experimental]
```````````````````````````````````

	Set members size.