summaryrefslogtreecommitdiffstats
path: root/doc/node-api.txt
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 /doc/node-api.txt
parent39b1c2582f86e28f313fbb9e0b11211fee887190 (diff)
Add API definition for device nodes
Diffstat (limited to 'doc/node-api.txt')
-rw-r--r--doc/node-api.txt28
1 files changed, 28 insertions, 0 deletions
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.