diff --git a/doc/mgmt-api.txt b/doc/mgmt-api.txt
index 47efac6..58f60a5 100644
--- a/doc/mgmt-api.txt
+++ b/doc/mgmt-api.txt
switching the controller off will expire this timeout and
disable discoverable.
+ Settings programmed via Set Advertising and Add/Remove
+ Advertising while the controller was powered off will be activated
+ when powering the controller on.
+
+ Switching the controller off will permanently cancel and remove
+ all advertising instances with a timeout set, i.e. time limited
+ advertising instances are not being remembered across power cycles.
+ Advertising Removed events will be issued accordingly.
+
This command generates a Command Complete event on success or
a Command Status event on failure.
In case the kernel subsystem does not support Low Energy or the
controller does not either, the command will fail regardless.
+ Disabling LE support will permanently disable and remove all
+ advertising instances configured with the Add Advertising
+ command. Advertising Removed events will be issued accordingly.
+
This command generates a Command Complete event on success or
a Command Status event on failure.
Using this command will temporarily deactive any configuration
made by the Add Advertising command. This command takes precedence.
+ Once a Set Advertising command with value 0x00 is issued any
+ previously made configurations via Add/Remove Advertising, including
+ such changes made while Set Advertising was active, will be re-
+ enabled.
A pre-requisite is that LE is already enabled, otherwise this
command will return a "rejected" response.
can be used to switch a Bluetooth Low Energy controller into
advertising mode.
- Added advertising information with this command will be ignored
- when using the Set Advertising command to enable advertising. The
- usage of Set Advertising command take precedence over this command.
+ Added advertising information with this command will not be visible
+ immediately if advertising is enabled via the Set Advertising
+ command. The usage of the Set Advertising command takes precedence
+ over this command. Instance information is stored and will be
+ advertised once advertising via Set Advertising has been disabled.
The Instance identifier is a value between 1 and the number of
supported instances. The value 0 is reserved.
broadcaster role.
The Duration parameter configures the length of an Instance. The
- value is in seconds and a value of 0 indicates an automatic choice
- for the Duration. If only one advertising Instance has been added,
- then the Duration value will be ignored. It only applies for the
- case where multiple Instances are configured. In that case every
- Instance will be available for the Duration time and after that
- it switches to the next one. This is a simple round-robin based
- approach.
+ value is in seconds.
+
+ A value of 0 indicates a default value is chosen for the
+ Duration. The default is 2 seconds.
+
+ If only one advertising Instance has been added, then the Duration
+ value will be ignored. It only applies for the case where multiple
+ Instances are configured. In that case every Instance will be
+ available for the Duration time and after that it switches to
+ the next one. This is a simple round-robin based approach.
The Timeout parameter configures the life-time of an Instance. In
case the value 0 is used it indicates no expiration time. If a
When a Timeout is provided, then the Duration substracts from
the actual Timeout value of that Instance. For example an Instance
- with Timeout of 6 and Duration of 2 will be scheduled exactly 3
- times. Other Instances have no influence on the Timeout.
+ with Timeout of 5 and Duration of 2 will be scheduled exactly 3
+ times, twice with 2 seconds and once with one second. Other
+ Instances have no influence on the Timeout.
+
+ Re-adding an already existing instance (i.e. issuing the Add
+ Advertising command with an Instance identifier of an existing
+ instance) will update that instance's configuration.
+
+ An instance being added or changed while another instance is
+ being advertised will not be visible immediately but only when
+ the new/changed instance is being scheduled by the round robin
+ advertising algorithm.
+
+ Changes to an instance that is currently being advertised will
+ cancel that instance and switch to the next instance. The changes
+ will be visible the next time the instance is scheduled for
+ advertising. In case a single instance is active, this means
+ that changes will be visible right away.
A pre-requisite is that LE is already enabled, otherwise this
command will return a "rejected" response.
When the Instance parameter is zero, then all previously added
advertising Instances will be removed.
+ Removing advertising information with this command will not be
+ visible as long as advertising is enabled via the Set Advertising
+ command. The usage of the Set Advertising command takes precedence
+ over this command. Changes to Instance information are stored and
+ will be advertised once advertising via Set Advertising has been
+ disabled.
+
+ Removing an instance while it is being advertised will immediately
+ cancel the instance, even when it has been advertised less then its
+ configured Timeout or Duration.
+
This command can be used when the controller is not powered and
all settings will be programmed once powered.