Add serial API documentation

diff --git a/doc/Makefile.am b/doc/Makefile.am
index 8af862e..d21be88 100644 (file)
--- a/doc/Makefile.am
+++ b/doc/Makefile.am
@@ -1,4 +1,5 @@
 
-EXTRA_DIST = manager-api.txt adapter-api.txt device-api.txt agent-api.txt
+EXTRA_DIST = manager-api.txt adapter-api.txt device-api.txt agent-api.txt \
+                                                               serial-api.txt
 
 MAINTAINERCLEANFILES = Makefile.in

diff --git a/doc/serial-api.txt b/doc/serial-api.txt
new file mode 100644 (file)
index 0000000..7be4277
--- /dev/null
+++ b/doc/serial-api.txt
@@ -0,0 +1,31 @@
+BlueZ D-Bus Serial API description
+**********************************
+
+Copyright (C) 2004-2008  Marcel Holtmann <marcel@holtmann.org>
+
+
+Serial hierarchy
+================
+
+Service                org.bluez
+Interface      org.bluez.Serial
+Object path    /{hci0,hci1,...}/dev_XX_XX_XX_XX_XX_XX
+
+Methods                string Connect(string uuid)
+
+                       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 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.
+
+                       Possible errors: org.bluez.Error.InvalidArguments
+                                        org.bluez.Error.DoesNotExist