summaryrefslogtreecommitdiffstats
path: root/input/input-api.txt
diff options
context:
space:
mode:
authorClaudio Takahasi <claudio.takahasi@openbossa.org>2007-01-18 13:42:11 +0000
committerClaudio Takahasi <claudio.takahasi@openbossa.org>2007-01-18 13:42:11 +0000
commit8a7d17430468d08c3d0660e2159cc046eebc5dfc (patch)
tree3aef3fd126a6ab54117287117b888ac7b6d3f240 /input/input-api.txt
parent49f96ab96e2f7a0fabbb1c863fbca43b12b127ec (diff)
Added methods skeleton
Diffstat (limited to 'input/input-api.txt')
-rw-r--r--input/input-api.txt93
1 files changed, 93 insertions, 0 deletions
diff --git a/input/input-api.txt b/input/input-api.txt
new file mode 100644
index 00000000..f321ac2b
--- /dev/null
+++ b/input/input-api.txt
@@ -0,0 +1,93 @@
+Bluetooth input service API description
+******************************************
+
+Copyright (C) 2006-2007 Marcel Holtmann <marcel@holtmann.org>
+
+Error hierarchy
+===============
+
+Interface org.bluez.Error
+
+Errors Failed
+
+ An unknown error occured. The error messages is
+ taken from the strerror(errno) function.
+
+ UnknownDevice
+
+ Error returned when the input device path is invalid
+
+ UnknownMethod
+
+ Error returned when the input device path doesn't
+ implement the requested method.
+
+
+Input Manager hierarchy
+=================
+
+Service org.bluez.input
+Interface org.bluez.input.Manager
+Object path /org/bluez/input
+
+Methods
+ array{string} ListDevices()
+
+ Returns an array of available input devices path.
+
+ void CreateDevice(string address)
+
+ Create an input device object: HID service record is
+ retrieved and bonding(if applied) is created.
+
+ void RemoveDevice(string path)
+
+ Remove the input device object for a given path.
+
+
+Input hierarchy
+=================
+
+Service org.bluez.input
+Interface org.bluez.input
+Object path /org/bluez/input_*
+
+Methods string GetAddress()
+
+ Returns the device address.
+
+ Example: "00:11:22:33:44:55"
+
+ string GetName()
+
+ Returns the service name.
+
+ string GetProductId()
+
+ Returns the product id.
+
+ string GetVendorId()
+
+ Returns the vendor id.
+
+ boolean IsConnected()
+
+ Returns the connection status.
+
+ void Connect()
+
+ Connect to the input device.
+
+ void Disconnect()
+
+ Disconnect from the input device.
+
+ void Unplug()
+
+ Unplug the virtual cable device.
+
+ void SetTimeout(uint32 timeout)
+
+ Set the idle timeout.
+
+