From 9b80a1f0632998b424d20c319761326e95796096 Mon Sep 17 00:00:00 2001 From: Johan Hedberg Date: Wed, 17 Oct 2012 10:42:41 +0300 Subject: [PATCH] doc: Update to match latest BlueZ 5 API --- doc/adapter-api.txt | 32 ++++++-------------------------- doc/control-api.txt | 5 ----- doc/device-api.txt | 30 ++++-------------------------- doc/manager-api.txt | 15 +-------------- 4 files changed, 11 insertions(+), 71 deletions(-) diff --git a/doc/adapter-api.txt b/doc/adapter-api.txt index a72e9df76..b63858656 100644 --- a/doc/adapter-api.txt +++ b/doc/adapter-api.txt @@ -14,22 +14,7 @@ Service org.bluez Interface org.bluez.Adapter Object path [variable prefix]/{hci0,hci1,...} -Methods dict GetProperties() - - Returns all properties for the adapter. See the - properties section for available properties. - - Possible Errors: org.bluez.Error.NotReady - - void SetProperty(string name, variant value) - - Changes the value of the specified property. Only - properties that are listed as read-write are changeable. - On success this will emit a PropertyChanged signal. - - Possible Errors: org.bluez.Error.InvalidArguments - - void RequestSession() +Methods void RequestSession() This method requests a client session that provides operational Bluetooth. A possible mode change must be @@ -47,9 +32,9 @@ Methods dict GetProperties() adapter to the mode in use on the moment of session request. - SetProperty method call changes adapter's mode - persistently, such that session release will not - modify it. + Setting the powered or discoverable properties + changes adapter's mode persistently, such that session + release will not modify it. Possible Errors: org.bluez.Error.DoesNotExist @@ -60,7 +45,7 @@ Methods dict GetProperties() resolving. Use StopDiscovery to release the sessions acquired. - This process will start emitting DeviceFound and + This process will start emitting DevicesFound and PropertyChanged "Discovering" signals. Possible errors: org.bluez.Error.NotReady @@ -122,12 +107,7 @@ Methods dict GetProperties() Possible errors: org.bluez.Error.DoesNotExist -Signals PropertyChanged(string name, variant value) - - This signal indicates a changed value of the given - property. - - DevicesFound(array{object path, dict values}) +Signals DevicesFound(array{object path, dict values}) This signal will be sent every time devices have been found. In general they only appear during a diff --git a/doc/control-api.txt b/doc/control-api.txt index 5391a8aa4..85b644262 100644 --- a/doc/control-api.txt +++ b/doc/control-api.txt @@ -16,11 +16,6 @@ Methods boolean IsConnected() {deprecated} Returns True if connected, otherwise FALSE. - dict GetProperties() - - Returns all properties for the interface. See the - properties section for available properties. - void Connect() Connect to remote device. diff --git a/doc/device-api.txt b/doc/device-api.txt index 962322745..c1f236164 100644 --- a/doc/device-api.txt +++ b/doc/device-api.txt @@ -14,24 +14,7 @@ Service org.bluez Interface org.bluez.Device Object path [variable prefix]/{hci0,hci1,...}/dev_XX_XX_XX_XX_XX_XX -Methods dict GetProperties() - - Returns all properties for the device. See the - properties section for available properties. - - Possible Errors: org.bluez.Error.DoesNotExist - org.bluez.Error.InvalidArguments - - void SetProperty(string name, variant value) - - Changes the value of the specified property. Only - properties that are listed as read-write are changeable. - On success this will emit a PropertyChanged signal. - - Possible Errors: org.bluez.Error.DoesNotExist - org.bluez.Error.InvalidArguments - - dict DiscoverServices(string pattern) +Methods dict DiscoverServices(string pattern) This method starts the service discovery to retrieve remote service records. The pattern parameter can @@ -133,12 +116,7 @@ Methods dict GetProperties() This method can be used to cancel a pairing operation initiated by the Pair method. -Signals PropertyChanged(string name, variant value) - - This signal indicates a changed value of the given - property. - - DisconnectRequested() +Signals DisconnectRequested() This signal will be sent when a low level disconnection to a remote device has been requested. @@ -198,7 +176,7 @@ Properties string Address [readonly] boolean Connected [readonly] Indicates if the remote device is currently connected. - A PropertyChanged signal indicate changes to this + A PropertiesChanged signal indicate changes to this status. boolean Trusted [readwrite] @@ -224,7 +202,7 @@ Properties string Address [readonly] convert it back to the remote device name. When resetting the alias with an empty string, the - emitted PropertyChanged signal will show the remote + emitted PropertiesChanged signal will show the remote name again. object Adapter [readonly] diff --git a/doc/manager-api.txt b/doc/manager-api.txt index 6efa58b3f..fe5055696 100644 --- a/doc/manager-api.txt +++ b/doc/manager-api.txt @@ -14,14 +14,6 @@ Service org.bluez Interface org.bluez.Manager Object path / -Methods dict GetProperties() - - Returns all global properties. See the - properties section for available properties. - - Possible Errors: org.bluez.Error.DoesNotExist - org.bluez.Error.InvalidArguments - object DefaultAdapter() Returns object path for the default adapter. @@ -114,12 +106,7 @@ Methods dict GetProperties() Possible errors: org.bluez.Error.DoesNotExist -Signals PropertyChanged(string name, variant value) - - This signal indicates a changed value of the given - property. - - AdapterAdded(object adapter) +Signals AdapterAdded(object adapter) Parameter is object path of added adapter. -- 2.47.3