summaryrefslogtreecommitdiffstats
path: root/input
diff options
context:
space:
mode:
authorMarcel Holtmann <marcel@holtmann.org>2007-01-18 21:43:08 +0000
committerMarcel Holtmann <marcel@holtmann.org>2007-01-18 21:43:08 +0000
commitfb0189533b77a5c7d4fb38107096fb2e1b149e15 (patch)
tree053f8367c70f0029dcebed988762b56d2d9a5777 /input
parente2ae84b915bc9c854d731a84375f7031a59dc858 (diff)
Small clenaup to the API definitions
Diffstat (limited to 'input')
-rw-r--r--input/input-api.txt45
1 files changed, 14 insertions, 31 deletions
diff --git a/input/input-api.txt b/input/input-api.txt
index f321ac2b..f63faa38 100644
--- a/input/input-api.txt
+++ b/input/input-api.txt
@@ -1,56 +1,41 @@
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()
+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.
+ Create an input device object. The HID service
+ record will be retrieved and the pairing will
+ be initiated if needed.
void RemoveDevice(string path)
Remove the input device object for a given path.
+Signals void DeviceCreated(string path)
+
+ void DeviceRemoved(string path)
-Input hierarchy
-=================
+
+Input Device hierarchy
+======================
Service org.bluez.input
-Interface org.bluez.input
-Object path /org/bluez/input_*
+Interface org.bluez.input.Device
+Object path /org/bluez/input/{keyboard*|mouse*|...}
Methods string GetAddress()
@@ -89,5 +74,3 @@ Methods string GetAddress()
void SetTimeout(uint32 timeout)
Set the idle timeout.
-
-