From 0d90e21062f968e413c6f0a4f2dc32372fe076bd Mon Sep 17 00:00:00 2001 From: Szymon Janc Date: Sat, 26 Mar 2011 12:27:11 +0100 Subject: [PATCH] Add oob-api.txt with documentation about OOB D-Bus methods --- doc/oob-api.txt | 38 ++++++++++++++++++++++++++++++++++++++ 1 file changed, 38 insertions(+) create mode 100644 doc/oob-api.txt diff --git a/doc/oob-api.txt b/doc/oob-api.txt new file mode 100644 index 000000000..8f6aac91c --- /dev/null +++ b/doc/oob-api.txt @@ -0,0 +1,38 @@ +BlueZ D-Bus Out Of Band Pairing API description +=============================================== + +Copyright (C) 2011 Szymon Janc for ST-Ericsson + +Service org.bluez +Interface org.bluez.Oob +Object path [variable prefix]/{hci0,hci1,...} + +Methods array{byte} hash, array{byte} randomizer ReadLocalOobData() + + This method reads local OOB data from adapter. Return + value is pair of arrays 16 bytes each. + + Note: This method will generate and return new local + OOB data. + + Possible errors: org.bluez.Error.Failed + org.bluez.Error.InProgress + + void AddRemoteOobData(string address, array{byte} hash, + array{byte} randomizer) + + This method adds new Out Of Band data for + specified address. If data for specified address + already exists it will be overwritten with new one. + + Possible errors: org.bluez.Error.Failed + org.bluez.Error.InvalidArguments + + void RemoveRemoteOobData(string address) + + This method removes Out Of Band data for specified + address. If data for specified address does not exist + nothing is removed. + + Possible errors: org.bluez.Error.Failed + org.bluez.Error.InvalidArguments -- 2.47.3