summaryrefslogtreecommitdiffstats
path: root/doc/input-api.txt
diff options
context:
space:
mode:
authorMarcel Holtmann <marcel@holtmann.org>2008-05-29 07:27:55 +0000
committerMarcel Holtmann <marcel@holtmann.org>2008-05-29 07:27:55 +0000
commit73f5d492078f1438a6d8164010a779e676b8c2d3 (patch)
treeaee3edd0c81c132f4c8df4e755abdc234eae74a1 /doc/input-api.txt
parent2f7d49d41e6c4fd80e5b117777012fbbbd6730ed (diff)
Add basic API document for new input interface
Diffstat (limited to 'doc/input-api.txt')
-rw-r--r--doc/input-api.txt29
1 files changed, 29 insertions, 0 deletions
diff --git a/doc/input-api.txt b/doc/input-api.txt
new file mode 100644
index 00000000..881825ec
--- /dev/null
+++ b/doc/input-api.txt
@@ -0,0 +1,29 @@
+BlueZ D-Bus Input API description
+*********************************
+
+Copyright (C) 2004-2008 Marcel Holtmann <marcel@holtmann.org>
+
+
+Input hierarchy
+===============
+
+Service org.bluez
+Interface org.bluez.Input
+Object path /{hci0,hci1,...}/dev_XX_XX_XX_XX_XX_XX
+
+Methods void Connect()
+
+ Connect to the input device.
+
+ Possible errors: org.bluez.Error.AlreadyConnected
+ org.bluez.Error.ConnectionAttemptFailed
+
+ void Disconnect()
+
+ Disconnect from the input device.
+
+ Possible errors: org.bluez.Error.Failed
+
+Signals void Connected()
+
+ void Disconnected()