diff options
| author | Marcel Holtmann <marcel@holtmann.org> | 2008-05-28 14:15:24 +0000 |
|---|---|---|
| committer | Marcel Holtmann <marcel@holtmann.org> | 2008-05-28 14:15:24 +0000 |
| commit | 2f7d49d41e6c4fd80e5b117777012fbbbd6730ed (patch) | |
| tree | 71f605c95249ab2852c464919f027994d94eb56b | |
| parent | b32e7c98584fe6ad17fe22bd6c3e347b2d6c0a2c (diff) | |
Add serial API documentation
| -rw-r--r-- | doc/Makefile.am | 3 | ||||
| -rw-r--r-- | doc/serial-api.txt | 31 |
2 files changed, 33 insertions, 1 deletions
diff --git a/doc/Makefile.am b/doc/Makefile.am index 8af862e8..d21be88e 100644 --- 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 index 00000000..7be4277d --- /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 |