Skip to content

Commit 620f81c

Browse files
doc: matter: fix Kconfig references
Fixed Kconfig references in multiple places. Signed-off-by: Arkadiusz Balys <[email protected]>
1 parent 580e76c commit 620f81c

File tree

8 files changed

+107
-56
lines changed

8 files changed

+107
-56
lines changed

applications/matter_bridge/doc/matter_bridge_description.rst

Lines changed: 20 additions & 40 deletions
Original file line numberDiff line numberDiff line change
@@ -382,23 +382,15 @@ Configuration options
382382

383383
Check and configure the following configuration options:
384384

385-
.. _CONFIG_BRIDGED_DEVICE_IMPLEMENTATION:
385+
.. _CONFIG_BRIDGED_DEVICE_SIMULATED:
386386

387-
CONFIG_BRIDGED_DEVICE_IMPLEMENTATION
388-
``bool`` - Select bridged device implementation.
389-
See the :ref:`matter_bridge_app_bridged_support_configs` section for more information.
390-
Accepts the following values:
387+
CONFIG_BRIDGED_DEVICE_SIMULATED
388+
``bool`` - Implement a simulated bridged device.
391389

392-
.. _CONFIG_BRIDGED_DEVICE_SIMULATED:
390+
.. _CONFIG_BRIDGED_DEVICE_BT:
393391

394-
CONFIG_BRIDGED_DEVICE_SIMULATED
395-
``bool`` - Implement a simulated bridged device.
396-
You must also configure :ref:`CONFIG_BRIDGED_DEVICE_SIMULATED_ONOFF_IMPLEMENTATION <CONFIG_BRIDGED_DEVICE_SIMULATED_ONOFF_IMPLEMENTATION>`
397-
398-
.. _CONFIG_BRIDGED_DEVICE_BT:
399-
400-
CONFIG_BRIDGED_DEVICE_BT
401-
``bool`` - Implement a Bluetooth LE bridged device.
392+
CONFIG_BRIDGED_DEVICE_BT
393+
``bool`` - Implement a Bluetooth LE bridged device.
402394

403395
.. _CONFIG_BRIDGE_HUMIDITY_SENSOR_BRIDGED_DEVICE:
404396

@@ -410,21 +402,15 @@ CONFIG_BRIDGE_HUMIDITY_SENSOR_BRIDGED_DEVICE
410402
CONFIG_BRIDGE_ONOFF_LIGHT_BRIDGED_DEVICE
411403
``bool`` - Enable support for OnOff Light bridged device.
412404

413-
.. _CONFIG_BRIDGE_SWITCH_BRIDGED_DEVICE:
414-
415-
CONFIG_BRIDGE_SWITCH_BRIDGED_DEVICE
416-
``bool`` - Enable support for a switch bridged device.
417-
Accepts the following values:
405+
.. _CONFIG_BRIDGE_GENERIC_SWITCH_BRIDGED_DEVICE:
418406

419-
.. _CONFIG_BRIDGE_GENERIC_SWITCH_BRIDGED_DEVICE:
407+
CONFIG_BRIDGE_GENERIC_SWITCH_BRIDGED_DEVICE
408+
``bool`` - Enable support for Generic Switch bridged device.
420409

421-
CONFIG_BRIDGE_GENERIC_SWITCH_BRIDGED_DEVICE
422-
``bool`` - Enable support for Generic Switch bridged device.
410+
.. _CONFIG_BRIDGE_ONOFF_LIGHT_SWITCH_BRIDGED_DEVICE:
423411

424-
.. _CONFIG_BRIDGE_ONOFF_LIGHT_SWITCH_BRIDGED_DEVICE:
425-
426-
CONFIG_BRIDGE_ONOFF_LIGHT_SWITCH_BRIDGED_DEVICE
427-
``bool`` - Enable support for OnOff Light Switch bridged device.
412+
CONFIG_BRIDGE_ONOFF_LIGHT_SWITCH_BRIDGED_DEVICE
413+
``bool`` - Enable support for OnOff Light Switch bridged device.
428414

429415
.. _CONFIG_BRIDGE_TEMPERATURE_SENSOR_BRIDGED_DEVICE:
430416

@@ -443,23 +429,17 @@ CONFIG_BRIDGE_MIGRATE_VERSION_1
443429

444430
If you selected the simulated device implementation using the :ref:`CONFIG_BRIDGED_DEVICE_SIMULATED <CONFIG_BRIDGED_DEVICE_SIMULATED>` Kconfig option, also check and configure the following option:
445431

446-
.. _CONFIG_BRIDGED_DEVICE_SIMULATED_ONOFF_IMPLEMENTATION:
447-
448-
CONFIG_BRIDGED_DEVICE_SIMULATED_ONOFF_IMPLEMENTATION
449-
``bool`` - Select the simulated OnOff device implementation.
450-
Accepts the following values:
451-
452-
.. _CONFIG_BRIDGED_DEVICE_SIMULATED_ONOFF_AUTOMATIC:
432+
.. _CONFIG_BRIDGED_DEVICE_SIMULATED_ONOFF_AUTOMATIC:
453433

454-
CONFIG_BRIDGED_DEVICE_SIMULATED_ONOFF_AUTOMATIC
455-
``bool`` - Automatically simulated OnOff device.
456-
The simulated device automatically changes its state periodically.
434+
CONFIG_BRIDGED_DEVICE_SIMULATED_ONOFF_AUTOMATIC
435+
``bool`` - Automatically simulated OnOff device.
436+
The simulated device automatically changes its state periodically.
457437

458-
.. _CONFIG_BRIDGED_DEVICE_SIMULATED_ONOFF_SHELL:
438+
.. _CONFIG_BRIDGED_DEVICE_SIMULATED_ONOFF_SHELL:
459439

460-
CONFIG_BRIDGED_DEVICE_SIMULATED_ONOFF_SHELL
461-
``bool`` - Shell-controlled simulated OnOff device.
462-
The state of the simulated device is changed using shell commands.
440+
CONFIG_BRIDGED_DEVICE_SIMULATED_ONOFF_SHELL
441+
``bool`` - Shell-controlled simulated OnOff device.
442+
The state of the simulated device is changed using shell commands.
463443

464444
If you selected the Bluetooth LE device implementation using the :ref:`CONFIG_BRIDGED_DEVICE_BT <CONFIG_BRIDGED_DEVICE_BT>` Kconfig option, also check and configure the following options:
465445

doc/nrf/protocols/matter/end_product/factory_provisioning.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -140,7 +140,7 @@ The following table lists the parameters of a factory data set:
140140
| ``rd_uid`` | rotating device ID unique ID | <16, 32> B | byte string | optional | The unique ID for rotating device ID, which consists of a randomly-generated 128-bit (or longer) octet string. |
141141
| | | | | | The rotating device ID is an optional identifier that is used for the :ref:`ug_matter_configuring_ffs` purposes. |
142142
| | | | | | This parameter should be protected against reading or writing over-the-air after initial introduction into the device, and stay fixed during the lifetime of the device. |
143-
| | | | | | When building an application with the Factory Data support, the `CONFIG_CHIP_FACTORY_DATA_ROTATING_DEVICE_UID_MAX_LEN` must be set with the length of the actual ``rd_uid`` stored in the Factory Data partition. |
143+
| | | | | | When building an application with the Factory Data support, the :ref:`CONFIG_CHIP_FACTORY_DATA_ROTATING_DEVICE_UID_MAX_LEN` must be set with the length of the actual ``rd_uid`` stored in the Factory Data partition. |
144144
+------------------------+--------------------------------------+----------------------+--------------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
145145
| ``user`` | User data | variable, max 1024 B | CBOR map | optional | The user data is provided in the JSON format. |
146146
| | | | | | This parameter is optional and depends on the device manufacturer's purpose. |
@@ -968,7 +968,7 @@ To override the inherited classes, complete the following steps:
968968
#. Disable building both the default and the nRF Connect implementations of factory data providers to start using your own implementation of factory data parser and provider.
969969
This can be done in one of the following ways:
970970

971-
* Set the :kconfig:option:`CONFIG_FACTORY_DATA_CUSTOM_BACKEND` Kconfig option to ``y`` in the :file:`prj.conf` file.
971+
* Set the :ref:`CONFIG_FACTORY_DATA_CUSTOM_BACKEND` Kconfig option to ``y`` in the :file:`prj.conf` file.
972972
* Build an example with the following option (replace ``<build_target>`` with your board name, for example ``nrf52840dk_nrf52840``):
973973

974974
.. parsed-literal::

doc/nrf/protocols/matter/end_product/security.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -352,7 +352,7 @@ If the :kconfig:option:`CONFIG_CHIP_CRYPTO_PSA_DAC_PRIV_KEY_KMU_ENCRYPTED` Kconf
352352

353353
By default, the DAC private key occupies the last slots dedicated for application purposes.
354354
For the non-encrypted version, it occupies the last two slots (178 and 179), and for the encrypted version, it occupies the last four slots (176-179).
355-
You can change the default slots by setting the :kconfig:option:`CONFIG_CHIP_CRYPTO_PSA_DAC_PRIV_KEY_KMU_SLOT` Kconfig option to the first slot number of the desired slots, making sure that all slots fit within the possible range.
355+
You can change the default slots by setting the :kconfig:option:`CONFIG_CHIP_CRYPTO_PSA_DAC_PRIV_KEY_KMU_SLOT_ID` Kconfig option to the first slot number of the desired slots, making sure that all slots fit within the possible range.
356356
This means you can set it to slot numbers 0-176 for encrypted, or 0-178 for non-encrypted.
357357
To read more about KMU slots, see the :ref:`ug_nrf54l_crypto_kmu_slots` section of the :ref:`ug_nrf54l_cryptography` page, which details the KMU peripheral.
358358

doc/nrf/protocols/matter/getting_started/advanced_kconfigs.rst

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -222,25 +222,25 @@ When the device leaves the last fabric, one of several reactions can be set to h
222222

223223
To enable one of the reactions to the last fabric removal, set the corresponding Kconfig option to ``y``:
224224

225-
* :kconfig:option:`CONFIG_CHIP_LAST_FABRIC_REMOVED_NONE` - Do not react to the last fabric removal.
225+
* :ref:`CONFIG_CHIP_LAST_FABRIC_REMOVED_NONE` - Do not react to the last fabric removal.
226226
The device will keep all saved data and network credentials, and will not reboot.
227-
* :kconfig:option:`CONFIG_CHIP_LAST_FABRIC_REMOVED_ERASE_ONLY` - Remove all saved network credentials.
227+
* :ref:`CONFIG_CHIP_LAST_FABRIC_REMOVED_ERASE_ONLY` - Remove all saved network credentials.
228228
The device will remove all saved network credentials, keep application-specific non-volatile data, and will not reboot.
229-
* :kconfig:option:`CONFIG_CHIP_LAST_FABRIC_REMOVED_ERASE_AND_PAIRING_START` - Remove all saved network credentials and start Bluetooth LE advertising.
229+
* :ref:`CONFIG_CHIP_LAST_FABRIC_REMOVED_ERASE_AND_PAIRING_START` - Remove all saved network credentials and start Bluetooth LE advertising.
230230
The device will remove all saved network credentials, keep application-specific non-volatile data, and start advertising Bluetooth LE Matter service.
231231
After that, it will be ready for commissioning to Matter over Bluetooth LE.
232-
* :kconfig:option:`CONFIG_CHIP_LAST_FABRIC_REMOVED_ERASE_AND_REBOOT` - Remove all saved network credentials and reboot the device.
232+
* :ref:`CONFIG_CHIP_LAST_FABRIC_REMOVED_ERASE_AND_REBOOT` - Remove all saved network credentials and reboot the device.
233233
This option is selected by default.
234234

235235
When the :kconfig:option:`CONFIG_CHIP_FACTORY_RESET_ERASE_SETTINGS` Kconfig option is also set to ``y``, the device will also remove all non-volatile data stored on the device, including application-specific entries.
236236
This means the device is restored to the factory settings.
237237

238-
To create a delay between the chosen reaction and the last fabric being removed, set the :kconfig:option:`CONFIG_CHIP_LAST_FABRIC_REMOVED_ACTION_DELAY` Kconfig option to a specific time in milliseconds.
238+
To create a delay between the chosen reaction and the last fabric being removed, set the :ref:`CONFIG_CHIP_LAST_FABRIC_REMOVED_ACTION_DELAY` Kconfig option to a specific time in milliseconds.
239239
By default this Kconfig option is set to 1 second.
240240

241241
.. note::
242242
The :kconfig:option:`CONFIG_CHIP_FACTORY_RESET_ERASE_SETTINGS` Kconfig option is set to ``y`` by default.
243-
To disable removing application-specific non-volatile data when the :kconfig:option:`CONFIG_CHIP_LAST_FABRIC_REMOVED_ERASE_AND_REBOOT` Kconfig option is selected, set the :kconfig:option:`CONFIG_CHIP_FACTORY_RESET_ERASE_SETTINGS` Kconfig option to ``n``.
243+
To disable removing application-specific non-volatile data when the :ref:`CONFIG_CHIP_LAST_FABRIC_REMOVED_ERASE_AND_REBOOT` Kconfig option is selected, set the :kconfig:option:`CONFIG_CHIP_FACTORY_RESET_ERASE_SETTINGS` Kconfig option to ``n``.
244244

245245
.. _ug_matter_configuring_read_client:
246246

doc/nrf/protocols/matter/getting_started/memory_optimization.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -67,7 +67,7 @@ Measuring memory usage
6767
======================
6868

6969
You can obtain the current memory statistics from the device using Kconfig options and UART shell commands.
70-
To do this, set the :kconfig:option:`CONFIG_CHIP_MEMORY_PROFILING` global Matter memory profiling Kconfig to ``y``.
70+
Set the :ref:`CONFIG_CHIP_MEMORY_PROFILING` Kconfig option to ``y``.
7171
This activates all the other necessary Kconfig options and enables all UART shell commands for measuring memory usage.
7272
Alternatively, you can enable each option separately.
7373

samples/matter/common/config.rst

Lines changed: 75 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -248,3 +248,78 @@ The following snippets are available:
248248

249249
* ``diagnostic-logs`` - Enables the set of configurations needed for full Matter diagnostic logs support.
250250
See :ref:`ug_matter_diagnostic_logs_snippet` in the Matter protocol section for more information.
251+
252+
.. _matter_stack_config:
253+
254+
Shared configurations in Matter stack
255+
#####################################
256+
257+
.. contents::
258+
:local:
259+
:depth: 2
260+
261+
This page lists Kconfig options and snippets shared by ``sdk-connectedhomeip``.
262+
See the :ref:`ug_matter_device_advanced_kconfigs` page for more detailed information.
263+
264+
Configuration options
265+
*********************
266+
267+
Check and configure the following configuration options:
268+
269+
.. _CONFIG_CHIP_LAST_FABRIC_REMOVED_ACTION_DELAY:
270+
271+
CONFIG_CHIP_LAST_FABRIC_REMOVED_ACTION_DELAY
272+
``int`` - After removing the last fabric wait defined time [in milliseconds] to perform an action.
273+
After removing the last fabric the device will wait for the defined time and then perform an action chosen by the CHIP_LAST_FABRIC_REMOVED_ACTION option.
274+
This schedule will allow for avoiding race conditions before the device removes non-volatile data.
275+
276+
.. _CONFIG_FACTORY_DATA_CUSTOM_BACKEND:
277+
278+
CONFIG_FACTORY_DATA_CUSTOM_BACKEND
279+
``bool`` - Enable a custom backend for factory data.
280+
This option is used to enable a custom backend for factory data.
281+
The custom backend is used to store the factory data in a custom location.
282+
283+
.. _CONFIG_CHIP_LAST_FABRIC_REMOVED_ERASE_AND_PAIRING_START:
284+
285+
CONFIG_CHIP_LAST_FABRIC_REMOVED_ERASE_AND_PAIRING_START
286+
``bool`` - After removing the last fabric erase NVS and start Bluetooth LE advertising.
287+
After removing the last fabric the device will perform the factory reset without rebooting and start the Bluetooth LE advertisement automatically.
288+
The current RAM state will be saved and the new commissioning to the next fabric will use the next possible fabric index.
289+
This option should not be used for devices that normally do not advertise Bluetooth LE on boot to keep their original behavior.
290+
291+
.. _CONFIG_CHIP_LAST_FABRIC_REMOVED_ERASE_AND_REBOOT:
292+
293+
CONFIG_CHIP_LAST_FABRIC_REMOVED_ERASE_AND_REBOOT
294+
``bool`` - After removing the last fabric erase NVS and reboot.
295+
After removing the last fabric the device will perform the factory reset and then reboot.
296+
The current RAM state will be removed and the new commissioning to the new fabric will use the initial fabric index.
297+
This option is the most safe.
298+
299+
.. _CONFIG_CHIP_LAST_FABRIC_REMOVED_ERASE_ONLY:
300+
301+
CONFIG_CHIP_LAST_FABRIC_REMOVED_ERASE_ONLY
302+
``bool`` - After removing the last fabric erase NVS only.
303+
After removing the last fabric the device will perform the factory reset only without rebooting.
304+
The current RAM state will be saved and the new commissioning to the next fabric will use the next possible fabric index.
305+
306+
.. _CONFIG_CHIP_LAST_FABRIC_REMOVED_NONE:
307+
308+
CONFIG_CHIP_LAST_FABRIC_REMOVED_NONE
309+
``bool`` - After removing the last fabric do not perform any action.
310+
After removing the last fabric the device will not perform factory reset or reboot.
311+
The current state will be left as it is and the BLE advertising will not start automatically.
312+
313+
.. _CONFIG_CHIP_MEMORY_PROFILING:
314+
315+
CONFIG_CHIP_MEMORY_PROFILING
316+
``bool`` - Enable features for tracking memory usage.
317+
Enables features for tracking memory usage in Matter.
318+
319+
.. _CONFIG_CHIP_NUS:
320+
321+
CONFIG_CHIP_NUS
322+
``bool`` - Enable Nordic UART service for Matter purposes.
323+
Enables Nordic UART service (NUS) for Matter samples.
324+
Using NUS service you can control a Matter sample using pre-defined BLE commands and do defined operations.
325+
The CHIP NUS service can be useful to keep communication with a smart home device when a connection within Matter network is lost.

samples/matter/light_bulb/README.rst

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -187,10 +187,6 @@ To set up an AWS IoT instance and configure the sample, complete the following s
187187
#. Observe that the light bulb changes state.
188188
The local changes to the attributes always take precedence over what is set in the shadow's desired state.
189189

190-
.. note::
191-
The integration layer has built-in reconnection logic and tries to maintain the connection as long as the device is connected to the internet.
192-
The reconnection interval can be configured using the :kconfig:option:`CONFIG_AWS_IOT_RECONNECTION_INTERVAL_SECONDS` option.
193-
194190
User interface
195191
**************
196192

samples/matter/lock/README.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -340,7 +340,7 @@ Factory data support
340340
Enabling Matter Bluetooth LE with Nordic UART Service
341341
=====================================================
342342

343-
You can enable the :ref:`matter_lock_sample_ble_nus` feature by setting the :kconfig:option:`CONFIG_CHIP_NUS` Kconfig option to ``y``.
343+
You can enable the :ref:`matter_lock_sample_ble_nus` feature by setting the :ref:`CONFIG_CHIP_NUS` Kconfig option to ``y``.
344344

345345
.. note::
346346
This sample supports one Bluetooth LE connection at a time.
@@ -809,7 +809,7 @@ To test the :ref:`matter_lock_sample_ble_nus` feature, complete the following st
809809
Some of the steps depend on which :ref:`configuration <matter_lock_sample_custom_configs>` the sample was built with.
810810

811811
#. Install `nRF Toolbox`_ on your Android (Android 11 or newer) or iOS (iOS 16.1 or newer) smartphone.
812-
#. Build the door lock application for Matter over Thread with the :kconfig:option:`CONFIG_CHIP_NUS` set to ``y``.
812+
#. Build the door lock application for Matter over Thread with the :ref:`CONFIG_CHIP_NUS` set to ``y``.
813813
For example, if you build from command line for the ``nrf52840dk/nrf52840``, use the following command:
814814

815815
.. code-block:: console

0 commit comments

Comments
 (0)