summaryrefslogtreecommitdiffstats
path: root/doc/adapter-api.txt
blob: 1f9cdd880d6381b9f23ee22984ed120b205f0d9d (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
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
BlueZ D-Bus Adapter API description
***********************************

Copyright (C) 2006-2008  Marcel Holtmann <marcel@holtmann.org>
Copyright (C) 2005-2006  Johan Hedberg <johan.hedberg@nokia.com>
Copyright (C) 2005-2006  Claudio Takahasi <claudio.takahasi@indt.org.br>
Copyright (C) 2005-2006  Eduardo Rocha <eduardo.rocha@indt.org.br>
Copyright (C) 2008-2008  Luiz von Dentz <luiz.dentz@indt.org.br>

Adapter hierarchy
=================

Service		org.bluez
Interface	org.bluez.Adapter
Object path	/org/bluez/{hci0,hci1,...}

Methods		dict GetProperties()

			TBD

		void SetProperty(string name, variant value)

			TBD

		array{object} ListDevices()

			TBD

		void DiscoverDevices()

			This method starts the device discovery procedure. This
			includes an inquiry procedure and remote device name
			resolving.

			On start up this process will generate a DiscoveryStarted
			signal and then return RemoteDeviceFound and also
			RemoteNameUpdated signals. If the procedure has been
			finished an DiscoveryCompleted signal will be sent.

			Possible errors: org.bluez.Error.NotReady
					 org.bluez.Error.Failed
					 org.bluez.Error.InProgress
					 org.bluez.Error.NoSuchAdapter

		void CancelDiscovery()

			This method will cancel any previous DiscoverDevices
			or DiscoverDevicesWithoutNameResolving actions.

			Possible errors: org.bluez.Error.NotReady
					 org.bluez.Error.Failed
					 org.bluez.Error.NotAuthorized
					 org.bluez.Error.NoSuchAdapter

		object CreateDevice(string address)

			TBD

		object CreateDeviceWithAgent(string address, object path)

			TBD

		void RemoveDevice(object path)

Signals		DeviceCreated(object path)

			TBD

		DeviceRemoved(object path)

			TBD

		PropertyChanged(string name, variant value)

			TBD

		DiscoveryStarted()

			TBD

		DiscoveryCompleted()

			TBD

		DeviceFound(string address, dict values)

			TBD

		DeviceDisappeared(string address)

			TBD

Properties	string Name [readonly]

		string Address [readonly]

		boolean PeriodicInquiry [readwrite]

		string Mode [readwrite]

		uint32 DiscoverableTimeout [readwrite]