summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorMarcel Holtmann <marcel@holtmann.org>2008-09-16 13:56:41 +0200
committerMarcel Holtmann <marcel@holtmann.org>2008-09-16 13:56:41 +0200
commit438c23eb400088fbdc830f7287af175559ce9a18 (patch)
treed3f5a4b650f818e57fa09df28f3106a7f742310b
parent39b1c2582f86e28f313fbb9e0b11211fee887190 (diff)
Add API definition for device nodes
-rw-r--r--doc/device-api.txt34
-rw-r--r--doc/node-api.txt28
2 files changed, 62 insertions, 0 deletions
diff --git a/doc/device-api.txt b/doc/device-api.txt
index 8aaa86f6..8584a9ee 100644
--- a/doc/device-api.txt
+++ b/doc/device-api.txt
@@ -70,6 +70,32 @@ Methods dict GetProperties()
Possible errors: org.bluez.Error.NotConnected
+ array{object} ListNodes()
+
+ Returns list of device node object paths.
+
+ Possible errors: org.bluez.Error.InvalidArguments
+ org.bluez.Error.Failed
+ org.bluez.Error.OutOfMemory
+
+ object CreateNode(string uuid)
+
+ Creates a persistent device node binding with a
+ remote device. The actual support for the specified
+ UUID depends if the device driver has support for
+ persistent binding. At the moment only RFCOMM TTY
+ nodes are supported.
+
+ Possible errors: org.bluez.Error.InvalidArguments
+ org.bluez.Error.NotSupported
+
+ void RemoveNode(object node)
+
+ Removes a persistent device node binding.
+
+ Possible errors: org.bluez.Error.InvalidArguments
+ org.bluez.Error.DoesNotExist
+
Signals PropertyChanged(string name, variant value)
This signal indicates a changed value of the given
@@ -81,6 +107,14 @@ Signals PropertyChanged(string name, variant value)
disconnection to a remote device has been requested.
The actual disconnection will happen 2 seconds later.
+ NodeCreated(object node)
+
+ Parameter is object path of created device node.
+
+ NodeRemoved(object node)
+
+ Parameter is object path of removed device node.
+
Properties string Address [readonly]
The Bluetooth device address of the remote device.
diff --git a/doc/node-api.txt b/doc/node-api.txt
new file mode 100644
index 00000000..7a33dab0
--- /dev/null
+++ b/doc/node-api.txt
@@ -0,0 +1,28 @@
+BlueZ D-Bus Node API description
+********************************
+
+Copyright (C) 2004-2008 Marcel Holtmann <marcel@holtmann.org>
+
+
+Node hierarchy
+==============
+
+Service org.bluez
+Interface org.bluez.Node
+Object path [variable prefix]/{hci0,hci1,...}/dev_XX_XX_XX_XX_XX_XX/{node0,...}
+
+Methods dict GetProperties()
+
+ Returns all properties for the device node. See the
+ properties section for available properties.
+
+ Possible Errors: org.bluez.Error.DoesNotExist
+ org.bluez.Error.InvalidArguments
+
+Properties string Name [readonly]
+
+ The name of the node. For example "rfcomm0".
+
+ object Device [readonly]
+
+ The object path of the device this node belongs to.