summaryrefslogtreecommitdiffstats
path: root/serial/serial-api.txt
diff options
context:
space:
mode:
authorClaudio Takahasi <claudio.takahasi@openbossa.org>2007-05-01 18:07:12 +0000
committerClaudio Takahasi <claudio.takahasi@openbossa.org>2007-05-01 18:07:12 +0000
commit3c157186641a97c2d37d122b391dc0d6b258735b (patch)
tree9488bdfc88abfba1e42dbcc85d0cac59a3836a5d /serial/serial-api.txt
parentf05b9d3834fb8f587987026f8ffde549fa6497d3 (diff)
serial: Added initial API description
Diffstat (limited to 'serial/serial-api.txt')
-rw-r--r--serial/serial-api.txt51
1 files changed, 48 insertions, 3 deletions
diff --git a/serial/serial-api.txt b/serial/serial-api.txt
index d85acf2d..9ae947db 100644
--- a/serial/serial-api.txt
+++ b/serial/serial-api.txt
@@ -4,9 +4,54 @@ Bluetooth serial service API description
Copyright (C) 2006-2007 Marcel Holtmann <marcel@holtmann.org>
-Manager hierarchy
+Manager hierarchy (experimental)
=================
-
-Service org.bluez.serial
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