summaryrefslogtreecommitdiffstats
path: root/serial/serial-api.txt
blob: 9ae947dbc8d18d845f3641448a8842f19f3e7fa2 (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
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.

Signals

		void PortCreated(string path)

		void PortRemoved(string path)

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