2020-10-29 23:07:20

by Daniel Winkler

Subject: [Bluez PATCH v6 01/10] 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

Reviewed-by: Sonny Sasaka <[email protected]>
Reviewed-by: Alain Michaud <[email protected]>
---

Changes in v6: None
Changes in v5:
- Changed interval API from jiffies to milliseconds for clarity
- Changed new dbus endpoints to be experimental

Changes in v4: None
Changes in v3: None
Changes in v2: None

doc/advertising-api.txt | 48 +++++++++++++++++++++++++++++++++++++++++
1 file changed, 48 insertions(+)

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)
--
2.29.1.341.ge80a0c044ae-goog

2020-10-30 00:48:30

by Luiz Augusto von Dentz

Subject: Re: [Bluez PATCH v6 01/10] doc/advertising-api: update API with new interface

Hi Daniel,

On Thu, Oct 29, 2020 at 4:09 PM Daniel Winkler <[email protected]> wrote:
>
> 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
>
> Reviewed-by: Sonny Sasaka <[email protected]>
> Reviewed-by: Alain Michaud <[email protected]>
> ---
>
> Changes in v6: None
> Changes in v5:
> - Changed interval API from jiffies to milliseconds for clarity
> - Changed new dbus endpoints to be experimental
>
> Changes in v4: None
> Changes in v3: None
> Changes in v2: None
>
> doc/advertising-api.txt | 48 +++++++++++++++++++++++++++++++++++++++++
> 1 file changed, 48 insertions(+)
>
> 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)
> --
> 2.29.1.341.ge80a0c044ae-goog

Applied, thanks.

--
Luiz Augusto von Dentz