diff options
author | Luiz Augusto von Dentz <luiz.von.dentz@intel.com> | 2017-08-28 16:29:37 +0300 |
---|---|---|
committer | Luiz Augusto von Dentz <luiz.von.dentz@intel.com> | 2017-08-30 14:59:55 +0300 |
commit | edd07f7a5f9cb53e9668b76b562a19063761a1f3 (patch) | |
tree | 1f3aab5eed8c8152488beb983a1d5b37ded219c7 /doc/adapter-api.txt | |
parent | 48f1e3c5b7b73a6ddcad573d6307360aa31aae78 (diff) | |
download | bluez-edd07f7a5f9cb53e9668b76b562a19063761a1f3.tar.gz |
adapter-api: Rename ResetData to DuplicateData filter
Since essencially what this filter would be doing is disable duplicate
for data use it instead of ResetData.
Also inline the documentation of each filter option to make it easier to
read what each option does.
Diffstat (limited to 'doc/adapter-api.txt')
-rw-r--r-- | doc/adapter-api.txt | 92 |
1 files changed, 58 insertions, 34 deletions
diff --git a/doc/adapter-api.txt b/doc/adapter-api.txt index c2898694d..d852aa6b9 100644 --- a/doc/adapter-api.txt +++ b/doc/adapter-api.txt @@ -54,30 +54,64 @@ Methods void StartDiscovery() Parameters that may be set in the filter dictionary include the following: - array{string} UUIDs : filtered service UUIDs - int16 RSSI : RSSI threshold value - uint16 Pathloss : Pathloss threshold value - string Transport : type of scan to run - bool ResetData : Reset advertisement data - - When a remote device is found that advertises any UUID - from UUIDs, it will be reported if: - - Pathloss and RSSI are both empty, - - only Pathloss param is set, device advertise TX pwer, - and computed pathloss is less than Pathloss param, - - only RSSI param is set, and received RSSI is higher - than RSSI param, - - Transport parameter determines the type of scan: - "auto" - interleaved scan, default value - "bredr" - BR/EDR inquiry - "le" - LE scan only - - If "le" or "bredr" Transport is requested, and the - controller doesn't support it, org.bluez.Error.Failed - error will be returned. If "auto" transport is - requested, scan will use LE, BREDR, or both, depending - on what's currently enabled on the controller. + array{string} UUIDs + + Filter by service UUIDs, empty means match + _any_ UUID. + + When a remote device is found that advertises + any UUID from UUIDs, it will be reported if: + - Pathloss and RSSI are both empty. + - only Pathloss param is set, device advertise + TX pwer, and computed pathloss is less than + Pathloss param. + - only RSSI param is set, and received RSSI is + higher than RSSI param. + + int16 RSSI + + RSSI threshold value. + + PropertiesChanged signals will be emitted + for already existing Device objects, with + updated RSSI value. If one or more discovery + filters have been set, the RSSI delta-threshold, + that is imposed by StartDiscovery by default, + will not be applied. + + uint16 Pathloss + + Pathloss threshold value. + + PropertiesChanged signals will be emitted + for already existing Device objects, with + updated Pathloss value. + + string Transport (Default "auto") + + Transport parameter determines the type of + scan. + + Possible values: + "auto" - interleaved scan + "bredr" - BR/EDR inquiry + "le" - LE scan only + + If "le" or "bredr" Transport is requested, + and the controller doesn't support it, + org.bluez.Error.Failed error will be returned. + If "auto" transport is requested, scan will use + LE, BREDR, or both, depending on what's + currently enabled on the controller. + + bool DuplicateData (Default: true) + + Disables duplicate detection of advertisement + data. + + When enabled PropertiesChanged signals will be + generated for either ManufacturerData and + ServiceData everytime they are discovered. When discovery filter is set, Device objects will be created as new devices with matching criteria are @@ -85,16 +119,6 @@ Methods void StartDiscovery() discoverable which enables listening to non-connectable and non-discoverable devices. - PropertiesChanged signals will be emitted - for already existing Device objects, with updated RSSI - value. If one or more discovery filters have been set, - the RSSI delta-threshold, that is imposed by - StartDiscovery by default, will not be applied. - - If ResetData is enabled PropertiesChanged signals will - be generated for either ManufacturerData and ServiceData - everytime they are discovered. - When multiple clients call SetDiscoveryFilter, their filters are internally merged, and notifications about new devices are sent to all clients. Therefore, each |