Skip to content

Commit 5572a27

Browse files
PavelVPVcarlescufi
authored andcommitted
docs: bluetooth: mesh: Add note about storing runtime configuration
All public API declared in cfg.h won't schedule storing of the change persistently if BT_MESH_VALID flag is not set. The flag is set after the node is provisioned. Signed-off-by: Pavel Vasilyev <[email protected]>
1 parent 2a31c4c commit 5572a27

File tree

2 files changed

+6
-0
lines changed

2 files changed

+6
-0
lines changed

doc/connectivity/bluetooth/api/mesh/cfg.rst

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,10 @@ cases, the mesh node can't rely on the Configuration Client to detect or determi
1414
local constraints, such as low battery power or changes in topology. For these
1515
scenarios, this API can be used to change the configuration locally.
1616

17+
.. note::
18+
Runtime configuration changes before the node is provisioned will not be stored
19+
in the :ref:`persistent storage <bluetooth_mesh_persistent_storage>`.
20+
1721
API reference
1822
*************
1923

doc/connectivity/bluetooth/api/mesh/core.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -67,6 +67,8 @@ vulnerability and flash wear out.
6767
the RPL between reboots, will make the device vulnerable to replay attacks
6868
and not perform the replay protection required by the spec.
6969
70+
.. _bluetooth_mesh_persistent_storage:
71+
7072
Persistent storage
7173
******************
7274

0 commit comments

Comments
 (0)