diff options
Diffstat (limited to 'doc/serial-api.txt')
| -rw-r--r-- | doc/serial-api.txt | 41 |
1 files changed, 41 insertions, 0 deletions
diff --git a/doc/serial-api.txt b/doc/serial-api.txt new file mode 100644 index 0000000..5f9bd5f --- /dev/null +++ b/doc/serial-api.txt @@ -0,0 +1,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 |