michaelh/zephyr
1
0
Fork 0
Code Releases Activity
zephyr/doc/connectivity/bluetooth/api/mesh/srpl_cli.rst

32 lines
1.5 KiB
ReStructuredText
Raw Normal View History

Bluetooth: Mesh: add implementation for Proxy Solicitation This is initial implementation of Proxy solicitation procedure. This includes: - support for sending and receiving Solicitation PDUs - On-Demand Private Proxy functionality (Server and Client) controlling behaviour of node after receiving Solicitation PDU - Solicitation PDU RPL Configuration (Server and Client), which manages Replay Protection List for Solicitation PDUs. Proxy Solicitation allows to enable advertising of Proxy service on node by sending Solicitation PDUs. These PDUs are not part of Mesh messages; instead, these are non-connectable, undirected advertising PDUs with their own format, containing Proxy Solicitation UUID. Signed-off-by: Krzysztof Kopyściński <krzysztof.kopyscinski@codecoup.pl>
2022-10-19 09:42:02 +02:00
.. _bluetooth_mesh_srpl_cli:
Solicitation PDU RPL Configuration Client
#########################################
doc: Bluetooth: Mesh: update proxy solicitation docs Updated related docs. Small fix in mesh/Kconfig and shell.rst. Signed-off-by: Stine Åkredalen <stine.akredalen@nordicsemi.no>
2023-04-25 01:00:36 +02:00
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.
doc: Bluetooth: Mesh: Align wording for models instantiation req According to https://github.com/zephyrproject-rtos/zephyr/pull/61886#issuecomment-1713302331 we need to use "must only" for models that spec states: `If supported, ... shall be supported by the primary element and shall not be supported by any secondary element`. Signed-off-by: Pavel Vasilyev <pavel.vasilyev@nordicsemi.no>
2023-09-12 10:22:59 +02:00
If present, the Solicitation PDU RPL Configuration Client model must only be instantiated on the
primary element.
doc: Bluetooth: Mesh: update proxy solicitation docs Updated related docs. Small fix in mesh/Kconfig and shell.rst. Signed-off-by: Stine Åkredalen <stine.akredalen@nordicsemi.no>
2023-04-25 01:00:36 +02:00
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`.
Bluetooth: Mesh: add implementation for Proxy Solicitation This is initial implementation of Proxy solicitation procedure. This includes: - support for sending and receiving Solicitation PDUs - On-Demand Private Proxy functionality (Server and Client) controlling behaviour of node after receiving Solicitation PDU - Solicitation PDU RPL Configuration (Server and Client), which manages Replay Protection List for Solicitation PDUs. Proxy Solicitation allows to enable advertising of Proxy service on node by sending Solicitation PDUs. These PDUs are not part of Mesh messages; instead, these are non-connectable, undirected advertising PDUs with their own format, containing Proxy Solicitation UUID. Signed-off-by: Krzysztof Kopyściński <krzysztof.kopyscinski@codecoup.pl>
2022-10-19 09:42:02 +02:00
API reference
*************
.. doxygengroup:: bt_mesh_sol_pdu_rpl_cli
:project: Zephyr
Revert "doc: Remove :members: on doxygengroup directives" This reverts commit 88c1519414aa5b4d8bd2bae767cc2f21295f2833. Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>
2023-08-09 17:50:19 +02:00
:members:
Copy permalink