From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: From: Szymon Janc To: CC: Szymon Janc Subject: [PATCHv3 3/7] Add DBus OOB API documentation. Date: Tue, 16 Nov 2010 16:44:03 +0100 Message-ID: <1289922247-20712-4-git-send-email-szymon.janc@tieto.com> In-Reply-To: <1289922247-20712-1-git-send-email-szymon.janc@tieto.com> References: <1289922247-20712-1-git-send-email-szymon.janc@tieto.com> MIME-Version: 1.0 Content-Type: text/plain Sender: linux-bluetooth-owner@vger.kernel.org List-ID: --- Makefile.am | 2 +- doc/oob-api.txt | 64 +++++++++++++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 65 insertions(+), 1 deletions(-) create mode 100644 doc/oob-api.txt diff --git a/Makefile.am b/Makefile.am index 1f8f7fb..9098084 100644 --- a/Makefile.am +++ b/Makefile.am @@ -358,7 +358,7 @@ EXTRA_DIST += doc/manager-api.txt \ doc/service-api.txt doc/agent-api.txt doc/attribute-api.txt \ doc/serial-api.txt doc/network-api.txt \ doc/input-api.txt doc/audio-api.txt doc/control-api.txt \ - doc/hfp-api.txt doc/assigned-numbers.txt + doc/hfp-api.txt doc/assigned-numbers.txt doc/oob-api.txt AM_YFLAGS = -d diff --git a/doc/oob-api.txt b/doc/oob-api.txt new file mode 100644 index 0000000..051b868 --- /dev/null +++ b/doc/oob-api.txt @@ -0,0 +1,64 @@ +BlueZ D-Bus OOB API description +******************************* + +Copyright (C) 2010 ST-Ericsson SA + +Author: Szymon Janc for ST-Ericsson + +OOB hierarchy +================= + +Service unique name +Interface org.bluez.OOB +Object path freely definable + +Methods array{byte} hash, array{byte} randomizer + RequestRemoteOobData(object device) + + This method gets called when the service daemon needs to + get device's hash and randomizer for an OOB + authentication. Each array should be 16 bytes long. + + Possible errors: org.bluez.Error.NoData + + void Release() + + This method gets called when DBus plug-in for OOB was + deactivated. There is no need to unregister provider, + because when this method gets called it has already been + unregistered. + +-------------------------------------------------------------------------------- + +Service org.bluez +Interface org.bluez.OOB +Object path /org/bluez + +Methods void RegisterProvider(object provider) + + This method registers provider for DBus OOB plug-in. + When provider is successfully registered plug-in becomes + active. Only one provider can be registered at time. + + Possible errors: org.bluez.Error.AlreadyExists + + void UnregisterProvider(object provider) + + This method unregisters provider for DBus OOB plug-in. + + Possible errors: org.bluez.Error.DoesNotExist + + + array{byte} hash, array{byte} randomizer + ReadLocalOobData(object adapter) + + This method reads local OOB data for adapter. Return + value is pair of arrays 16 bytes each. Only registered + provider should call this method. + + Note: This method will generate and return new local + OOB data. + + Possible errors: org.bluez.Error.ReadFailed + org.bluez.Error.NoProvider + org.bluez.Error.InProgress -- 1.7.1