From 3c9315fe4ef6fb82a7cdc4a47999589b6c1776cf Mon Sep 17 00:00:00 2001 From: Daniel Winkler Date: Thu, 29 Oct 2020 16:06:13 -0700 Subject: [PATCH] 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 Signed-off-by: Anuj Jain Signed-off-by: Ayush Garg --- doc/advertising-api.txt | 48 ++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 48 insertions(+) diff --git a/doc/advertising-api.txt b/doc/advertising-api.txt index b0565ea..541c570 100755 --- 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) -- 2.7.4