doc: nrf-bm: lib: add documentation for ble_adv library #415
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
github-actions
bot
added
changelog-entry-required
|
You can find the documentation preview for this PR here. |
eivindj-nordic
force-pushed
the
doc_ble_adv
branch
2 times, most recently
from
67f8346 to
7a536f5
Compare
|
|
||
| The advertising modes are enabled by Kconfig options. See the :ref:`lib_ble_adv_configure` section below. | ||
|
|
||
| When advertising, the module pass through the enabled advertising modes until a connection is made or advertising times out. |
There was a problem hiding this comment.
Suggested change
| When advertising, the module pass through the enabled advertising modes until a connection is made or advertising times out. | |
| When advertising, the library transitions through the enabled advertising modes until a connection is made or advertising times out. |
| ``Direct High Duty`` is a one-shot burst and its time-out thresholdsand advertising interval cannot be configured. | ||
|
|
||
| Whitelist | ||
| ========= |
| You should also provide an event handler that is called when advertising transitions to a new mode. | ||
| Use the event handler to add functionality, for example to indicate such transitions to the user by flashing an LED when advertising starts, or to power down the application when no peer is found. | ||
|
|
||
| If enabled, the event handler must handle requests to update the whitelist (:c:enum:`BLE_ADV_EVT_WHITELIST_REQUEST`) and peer address (:c:enum:`BLE_ADV_EVT_PEER_ADDR_REQUEST``). |
There was a problem hiding this comment.
Suggested change
| If enabled, the event handler must handle requests to update the whitelist (:c:enum:`BLE_ADV_EVT_WHITELIST_REQUEST`) and peer address (:c:enum:`BLE_ADV_EVT_PEER_ADDR_REQUEST``). | |
| If enabled, the event handler must handle requests to update the whitelist (:c:enum:`BLE_ADV_EVT_WHITELIST_REQUEST`) and peer address (:c:enum:`BLE_ADV_EVT_PEER_ADDR_REQUEST`). |
eivindj-nordic
force-pushed
the
doc_ble_adv
branch
from
7a536f5 to
144f4b6
Compare
anhmolt
approved these changes
Oct 15, 2025
Add ble_adv library documentation. Signed-off-by: Eivind Jølsgard <[email protected]>
eivindj-nordic
force-pushed
the
doc_ble_adv
branch
from
144f4b6 to
8b809af
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Add ble_adv library documentation.