From 2f1cd0f99dc740bccf61ce27a4ec31428d0a3eb2 Mon Sep 17 00:00:00 2001 From: Pavel Vasilyev Date: Tue, 6 Jun 2023 15:56:38 +0200 Subject: [PATCH] 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 --- doc/connectivity/bluetooth/api/mesh/cfg.rst | 4 ++++ doc/connectivity/bluetooth/api/mesh/core.rst | 2 ++ 2 files changed, 6 insertions(+) diff --git a/doc/connectivity/bluetooth/api/mesh/cfg.rst b/doc/connectivity/bluetooth/api/mesh/cfg.rst index 68bf085069944c6..fbf9d84f2ce3a3a 100644 --- a/doc/connectivity/bluetooth/api/mesh/cfg.rst +++ b/doc/connectivity/bluetooth/api/mesh/cfg.rst @@ -14,6 +14,10 @@ cases, the mesh node can't rely on the Configuration Client to detect or determi local constraints, such as low battery power or changes in topology. For these scenarios, this API can be used to change the configuration locally. +.. note:: + Any changes done to the runtime configuration before the node is provisioned + will not be stored in the :ref:`persistent storage `. + API reference ************* diff --git a/doc/connectivity/bluetooth/api/mesh/core.rst b/doc/connectivity/bluetooth/api/mesh/core.rst index e27f29a31350691..8f2738d253eeb00 100644 --- a/doc/connectivity/bluetooth/api/mesh/core.rst +++ b/doc/connectivity/bluetooth/api/mesh/core.rst @@ -67,6 +67,8 @@ vulnerability and flash wear out. the RPL between reboots, will make the device vulnerable to replay attacks and not perform the replay protection required by the spec. +.. _bluetooth_mesh_persistent_storage: + Persistent storage ******************