summaryrefslogtreecommitdiff
path: root/doc/serial-api.txt
blob: 5f9bd5f2ccd23b1b37e066b553b5ff60c271ceb7 (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
BlueZ D-Bus Serial API description
**********************************

Copyright (C) 2004-2010  Marcel Holtmann <marcel@holtmann.org>


Serial hierarchy
================

Service		org.bluez
Interface	org.bluez.Serial
Object path	[variable prefix]/{hci0,hci1,...}/dev_XX_XX_XX_XX_XX_XX

Methods		string Connect(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.

			Possible patterns: UUID 128 bit as string
					   Profile short names, e.g: spp, dun
					   RFCOMM channel as string, 1-30

			Possible errors: org.bluez.Error.InvalidArguments
					 org.bluez.Error.InProgress
					 org.bluez.Error.ConnectionAttemptFailed
					 org.bluez.Error.NotSupported

		void Disconnect(string device)

			Disconnect a RFCOMM TTY device that has been
			created by Connect method.

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

			In that case one of patterns of the Connect method should
			be suplied instead of the TTY device.

			Possible errors: org.bluez.Error.InvalidArguments
					 org.bluez.Error.DoesNotExist