Skip to content

Commit

Permalink
doc: Update ESB documentation with ACK configuration changes.
Browse files Browse the repository at this point in the history
Clarified the meaning of the selective_auto_ack and noack parameters.

Ref: NCSDK-28905

Signed-off-by: Marcin Jelinski <[email protected]>
  • Loading branch information
maje-emb authored and rlubos committed Sep 20, 2024
1 parent 3e120af commit e8755ef
Showing 1 changed file with 3 additions and 1 deletion.
4 changes: 3 additions & 1 deletion doc/nrf/protocols/esb/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -124,8 +124,10 @@ However, repeated packets will always be ACKed by the PRX, even though they are

A PTX can select that individual packets that are transmitted to the PRX do not require an ACK to be sent in return from the PRX.
This decision is taken by the application when uploading a packet to the TX FIFO using the :c:member:`esb_payload.noack` field of the :c:struct:`esb_payload` parameter that is passed to the :c:func:`esb_write_payload` function.
When the :c:member:`selective_auto_ack` field in the :c:struct:`esb_config` configuration structure is disabled, all packets will be acknowledged, ignoring the :c:member:`esb_payload.noack` field.

When the PRX receives a packet that does not require an ACK, it does not send an ACK packet to the PTX, and as a result the PTX will continue retransmitting the packet until the maximum number of allowed retransmission attempts is reached.
When the PRX receives a packet that does not require an ACK, it does not send an ACK packet to the PTX.
In this case, when :c:member:`esb_payload.noack` = ``true``, packet retransmission does not occur.

.. _esb_getting_started:

Expand Down

0 comments on commit e8755ef

Please sign in to comment.