385f8e127d
Do not pass options to doxygengroup to rationalize usage and be less dependent on Breathe. Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>
33 lines
1.5 KiB
ReStructuredText
33 lines
1.5 KiB
ReStructuredText
.. _bluetooth_mesh_srpl_cli:
|
|
|
|
Solicitation PDU RPL Configuration Client
|
|
#########################################
|
|
|
|
The Solicitation PDU RPL Configuration Client model is a foundation model defined by the Bluetooth
|
|
mesh specification. The model is optional, and is enabled through the
|
|
:kconfig:option:`CONFIG_BT_MESH_SOL_PDU_RPL_CLI` option.
|
|
|
|
The Solicitation PDU RPL Configuration Client model was introduced in the Bluetooth Mesh Protocol
|
|
Specification version 1.1, and supports the functionality of removing addresses from the
|
|
solicitation replay protection list (SRPL) of a node that supports the
|
|
:ref:`bluetooth_mesh_srpl_srv` model.
|
|
|
|
The Solicitation PDU RPL Configuration Client model communicates with a Solicitation PDU RPL
|
|
Configuration Server model using the application keys configured by the Configuration Client.
|
|
|
|
If present, the Solicitation PDU RPL Configuration Client model must only be instantiated on the
|
|
primary element.
|
|
|
|
Configurations
|
|
**************
|
|
|
|
The Solicitation PDU RPL Configuration Client model behavior can be configured with the transmission
|
|
timeout option :kconfig:option:`CONFIG_BT_MESH_SOL_PDU_RPL_CLI_TIMEOUT`. The
|
|
:kconfig:option:`CONFIG_BT_MESH_SOL_PDU_RPL_CLI_TIMEOUT` controls how long the Solicitation PDU RPL
|
|
Configuration Client waits for a response message to arrive in milliseconds. This value can be
|
|
changed at runtime using :c:func:`bt_mesh_sol_pdu_rpl_cli_timeout_set`.
|
|
|
|
API reference
|
|
*************
|
|
|
|
.. doxygengroup:: bt_mesh_sol_pdu_rpl_cli
|