Blob: org.bluez.Network.rst

Blob id: bc775f5dd48f0487a12b99e87b3472e5285ac372

Size: 1.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
=================
org.bluez.Network
=================

-------------------------------------
BlueZ D-Bus Network API documentation
-------------------------------------

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

Interface
=========

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

Methods
-------

string Connect(string uuid)
```````````````````````````

Connects to the network device and return the network interface name.

Possible uuid values:

:"panu", "00001115-0000-1000-8000-00805f9b34fb":

	Personal Network User role.

:"nap", "00001116-0000-1000-8000-00805f9b34fb":

	Network Access Point role.

:"gn", "00001117-0000-1000-8000-00805f9b34fb":

	Group Network role.

The connection will be closed and network device released either upon calling
**Disconnect()** or when the client disappears from the message bus.

Possible errors:

:org.bluez.Error.InvalidArguments:
:org.bluez.Error.NotSupported:
:org.bluez.Error.InProgress:
:org.bluez.Error.Failed:

void Disconnect()
`````````````````

Disconnects from the network device.

To abort a connection attempt in case of errors or timeouts in the client it is
fine to call this method.

Possible errors:

:org.bluez.Error.Failed:
:org.bluez.Error.NotConnected:

Properties
----------

boolean Connected [readonly]
````````````````````````````

Indicates if the device is connected.

string Interface [readonly, optional]
`````````````````````````````````````

Indicates the network interface name when available.

string UUID [readonly, optional]
````````````````````````````````

Indicates the connection role when available.