summaryrefslogtreecommitdiffstats
path: root/serial/serial-api.txt
blob: f3c39e228d03bdd1f7e1421d284cb7a031359cc7 (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
Bluetooth serial service API description
****************************************

Copyright (C) 2006-2007  Marcel Holtmann <marcel@holtmann.org>


Manager hierarchy (experimental)
=================
Interface	org.bluez.serial.Manager
Object path	/org/bluez/serial

Methods		string CreatePort(string address, string pattern)

			Creates a serial port object.

			Possible errors:org.bluez.serial.Error.AlreadyExists
					org.bluez.serial.Error.NotSupported
					org.bluez.serial.Error.ConnectionAttemptFailed
					org.bluez.serial.Error.Failed

		void RemovePort(string path)
			Removes the serial port object for given path.

			Possible errors:org.bluez.serial.Error.DoesNotExist
					org.bluez.serial.Error.Failed

		array{string} ListPorts()

			Returns an array of available serial port paths.

		string ConnectService(string address, string pattern)

			Connects to a specific RFCOMM based service on a
			remote device and then creates a RFCOMM TTY
			device for it. The RFCOMM TTY device is returned.

		void CancelConnectService(string address, string pattern)

			Cancel a previous ConnectService method call.

		void DisconnectService(string device)

			Disconnect a RFCOMM TTY device that has been
			created via the ConnectService method.

Signals

		void PortCreated(string path)

		void PortRemoved(string path)

		void ServiceConnected(string device, string adddress, string pattern)

		void ServiceDisconnected(string device)

Port hierarchy (experimental)
=======================================

Interface	org.bluez.serial.Port
Object path	/org/bluez/serial/port*

Methods		string GetAddress()
			Returns the Bluetooth address of the ending point.

		string Connect()

			Connects to remote device associated to the port object.

			Possible errors:org.bluez.serial.Error.ConnectionAttemptFailed
					org.bluez.serial.Error.Failed

		void Disconnect()

			Disconnects from remote device.

			Possible errors:org.bluez.serial.Error.Failed