Skip to content

Conversation

@eivindj-nordic
Copy link
Contributor

Add documentation for BLE queued writes library.

@eivindj-nordic eivindj-nordic self-assigned this Oct 8, 2025
@eivindj-nordic eivindj-nordic requested review from a team as code owners October 8, 2025 11:31
@github-actions github-actions bot added changelog-entry-required Update changelog before merge. Remove label if entry is not needed or already added. doc-required PR must not be merged without tech writer approval. labels Oct 8, 2025
@github-actions
Copy link

github-actions bot commented Oct 8, 2025

You can find the documentation preview for this PR here.


Writing to a GATT characteristic can be done in a single write command or in a series of commands.
Splitting the write operation into several commands makes it possible to write attribute values that are longer than a single packet.
Such a series of write commands, called a Queued Write operation, consists of multiple prepare write commands followed by one execute write command.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Emphasis, also elsewhere

Suggested change
Such a series of write commands, called a Queued Write operation, consists of multiple prepare write commands followed by one execute write command.
Such a series of write commands, called a Queued Write operation, consists of multiple Prepare Write commands followed by one Execute Write command.

# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.

PREDEFINED = __DOXYGEN__ \
CONFIG_BLE_QWR_MAX_ATTR=1 \
Copy link
Contributor

@b-gent b-gent Oct 29, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Adding this because the register function was surrounded by an IF which prevented it from being picked up by doxygen.

Add documentation for BLE queued writes library.

Signed-off-by: Eivind Jølsgard <[email protected]>
@eivindj-nordic eivindj-nordic merged commit 3af2e32 into nrfconnect:main Oct 30, 2025
10 checks passed
@eivindj-nordic eivindj-nordic deleted the doc_qwr branch October 30, 2025 09:47
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

changelog-entry-required Update changelog before merge. Remove label if entry is not needed or already added. doc-required PR must not be merged without tech writer approval.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants