diff mbox series

[Bluez,v4,01/10] doc/advertising-api: update API with new interface

Message ID 20201001155738.Bluez.v4.1.Ifaa96e71a871158e5d9d454073b2b6846eae339f@changeid (mailing list archive)
State New, archived
Headers show
Series Bluetooth: Add new MGMT interface for advertising add | expand

Commit Message

Daniel Winkler Oct. 1, 2020, 11:01 p.m. UTC 
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 <sonnysasaka@chromium.org>
Reviewed-by: Alain Michaud <alainm@chromium.org>
---

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

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

Comments

Luiz Augusto von Dentz Oct. 27, 2020, 9:59 p.m. UTC | #1 
Hi Daniel,

On Thu, Oct 1, 2020 at 4:07 PM Daniel Winkler <danielwinkler@google.com> 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 <sonnysasaka@chromium.org>
> Reviewed-by: Alain Michaud <alainm@chromium.org>
> ---
>
> Changes in v4: None
> Changes in v3: None
> Changes in v2: None
>
>  doc/advertising-api.txt | 50 +++++++++++++++++++++++++++++++++++++++++
>  1 file changed, 50 insertions(+)
>
> diff --git a/doc/advertising-api.txt b/doc/advertising-api.txt
> index b0565eab2..3215a52f7 100644
> --- a/doc/advertising-api.txt
> +++ b/doc/advertising-api.txt
> @@ -138,6 +138,33 @@ Properties string Type
>                                         "2M"
>                                         "Coded"
>
> +               uint32 MinInterval
> +
> +                       Minimum advertising interval to be used by the
> +                       advertising set, in .625 millisecond slots.
> +                       Time = N * .625 ms, where N has range
> +                       [0x000020, 0xFFFFFF]. If the provided MinInterval is
> +                       larger than the provided MaxInterval, the registration
> +                       will return failure.
> +
> +               uint32 MaxInterval
> +
> +                       Maximum advertising interval to be used by the
> +                       advertising set, in .625 millisecond slots.
> +                       Time = N * .625 ms, where N has range
> +                       [0x000020, 0xFFFFFF]. If the provided MinInterval is
> +                       larger than the provided MaxInterval, the registration
> +                       will return failure.
> +
> +               int16 TxPower
> +
> +                       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 +236,26 @@ Properties byte ActiveInstances
>                         Possible values: "1M"
>                                          "2M"
>                                          "Coded"
> +
> +               dict SupportedCapabilities
> +
> +                       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.28.0.709.gb0816b6eb0-goog

Please mark these as experimental for now, other than that it looks good to me.
diff mbox series

Patch

diff --git a/doc/advertising-api.txt b/doc/advertising-api.txt
index b0565eab2..3215a52f7 100644
--- a/doc/advertising-api.txt
+++ b/doc/advertising-api.txt
@@ -138,6 +138,33 @@  Properties	string Type
 					"2M"
 					"Coded"
 
+		uint32 MinInterval
+
+			Minimum advertising interval to be used by the
+			advertising set, in .625 millisecond slots.
+			Time = N * .625 ms, where N has range
+			[0x000020, 0xFFFFFF]. If the provided MinInterval is
+			larger than the provided MaxInterval, the registration
+			will return failure.
+
+		uint32 MaxInterval
+
+			Maximum advertising interval to be used by the
+			advertising set, in .625 millisecond slots.
+			Time = N * .625 ms, where N has range
+			[0x000020, 0xFFFFFF]. If the provided MinInterval is
+			larger than the provided MaxInterval, the registration
+			will return failure.
+
+		int16 TxPower
+
+			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 +236,26 @@  Properties	byte ActiveInstances
 			Possible values: "1M"
 					 "2M"
 					 "Coded"
+
+		dict SupportedCapabilities
+
+			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)