From 73f5d492078f1438a6d8164010a779e676b8c2d3 Mon Sep 17 00:00:00 2001 From: Marcel Holtmann Date: Thu, 29 May 2008 07:27:55 +0000 Subject: Add basic API document for new input interface --- doc/input-api.txt | 29 +++++++++++++++++++++++++++++ 1 file changed, 29 insertions(+) create mode 100644 doc/input-api.txt (limited to 'doc/input-api.txt') 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 + + +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() -- cgit From 2cd3aa2618dedd8d5683ccdc7caaafaed03b9364 Mon Sep 17 00:00:00 2001 From: Marcel Holtmann Date: Thu, 29 May 2008 08:56:25 +0000 Subject: Add CancelConnect() and IsConnected() methods --- doc/input-api.txt | 11 +++++++++++ 1 file changed, 11 insertions(+) (limited to 'doc/input-api.txt') diff --git a/doc/input-api.txt b/doc/input-api.txt index 881825ec..e9ad0aa7 100644 --- a/doc/input-api.txt +++ b/doc/input-api.txt @@ -18,12 +18,23 @@ Methods void Connect() Possible errors: org.bluez.Error.AlreadyConnected org.bluez.Error.ConnectionAttemptFailed + void CancelConnect() + + Abort connection attempt in case of errors or + timeouts in the client. + + Possible errors: org.bluez.Error.Failed + void Disconnect() Disconnect from the input device. Possible errors: org.bluez.Error.Failed + bool IsConnected() + + Returns the connection status. + Signals void Connected() void Disconnected() -- cgit From 07d1404659065104580ce7b24315af99dcd02ec0 Mon Sep 17 00:00:00 2001 From: Marcel Holtmann Date: Thu, 29 May 2008 21:15:47 +0000 Subject: Remove CancelConnect methods --- doc/input-api.txt | 10 +++------- 1 file changed, 3 insertions(+), 7 deletions(-) (limited to 'doc/input-api.txt') diff --git a/doc/input-api.txt b/doc/input-api.txt index e9ad0aa7..65f87e7d 100644 --- a/doc/input-api.txt +++ b/doc/input-api.txt @@ -18,17 +18,13 @@ Methods void Connect() Possible errors: org.bluez.Error.AlreadyConnected org.bluez.Error.ConnectionAttemptFailed - void CancelConnect() - - Abort connection attempt in case of errors or - timeouts in the client. - - Possible errors: org.bluez.Error.Failed - void Disconnect() Disconnect from the input device. + To abort a connection attempt in case of errors or + timeouts in the client it is fine to call this method. + Possible errors: org.bluez.Error.Failed bool IsConnected() -- cgit From 77000b708ed9aafcfc232311e812c172b4a791b9 Mon Sep 17 00:00:00 2001 From: Marcel Holtmann Date: Fri, 30 May 2008 08:04:22 +0000 Subject: Fix whitespaces --- doc/input-api.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'doc/input-api.txt') diff --git a/doc/input-api.txt b/doc/input-api.txt index 65f87e7d..c0816eec 100644 --- a/doc/input-api.txt +++ b/doc/input-api.txt @@ -16,7 +16,7 @@ Methods void Connect() Connect to the input device. Possible errors: org.bluez.Error.AlreadyConnected - org.bluez.Error.ConnectionAttemptFailed + org.bluez.Error.ConnectionAttemptFailed void Disconnect() -- cgit