summaryrefslogtreecommitdiff
path: root/doc/advertising-api.txt
diff options
context:
space:
mode:
authorDaniel Winkler <danielwinkler@google.com>2020-10-29 16:06:13 -0700
committerLuiz Augusto von Dentz <luiz.von.dentz@intel.com>2020-10-29 17:42:26 -0700
commit66abcfb3e7346ce078fdfa7351354c3230075971 (patch)
tree0e35081199cf6e2f21e563b470c6849f1d2de640 /doc/advertising-api.txt
parenta443c408d6acf6381859c35f676ac6bfea222f52 (diff)
downloadbluez-66abcfb3e7346ce078fdfa7351354c3230075971.tar.gz
doc/advertising-api: update API with new interface
This updates the advertising documentation to include the following features: LE Advertising Manager: - New SupportedCapabilities property LE Advertisement: - New min/max interval properties - New tx power property
Diffstat (limited to 'doc/advertising-api.txt')
-rw-r--r--doc/advertising-api.txt48
1 files changed, 48 insertions, 0 deletions
diff --git a/doc/advertising-api.txt b/doc/advertising-api.txt
index b0565eab2..541c57004 100644
--- a/doc/advertising-api.txt
+++ b/doc/advertising-api.txt
@@ -138,6 +138,31 @@ Properties string Type
"2M"
"Coded"
+ uint32 MinInterval [Experimental]
+
+ Minimum advertising interval to be used by the
+ advertising set, in milliseconds. Acceptable values
+ are in the range [20ms, 10,485s]. If the provided
+ MinInterval is larger than the provided MaxInterval,
+ the registration will return failure.
+
+ uint32 MaxInterval [Experimental]
+
+ Maximum advertising interval to be used by the
+ advertising set, in milliseconds. Acceptable values
+ are in the range [20ms, 10,485s]. If the provided
+ MinInterval is larger than the provided MaxInterval,
+ the registration will return failure.
+
+ int16 TxPower [Experimental]
+
+ Requested transmission power of this advertising set.
+ The provided value is used only if the "CanSetTxPower"
+ feature is enabled on the Advertising Manager. The
+ provided value must be in range [-127 to +20], where
+ units are in dBm.
+
+
LE Advertising Manager hierarchy
================================
@@ -209,3 +234,26 @@ Properties byte ActiveInstances
Possible values: "1M"
"2M"
"Coded"
+
+ dict SupportedCapabilities [Experimental]
+
+ Enumerates Advertising-related controller capabilities
+ useful to the client.
+
+ Possible Values:
+
+ byte MaxAdvLen
+
+ Max advertising data length
+
+ byte MaxScnRspLen
+
+ Max advertising scan response length
+
+ int16 MinTxPower
+
+ Min advertising tx power (dBm)
+
+ int16 MaxTxPower
+
+ Max advertising tx power (dBm)