Skip to content

Commit 9bfb792

Browse files
peknisArekBalysNordic
authored andcommitted
doc: Matter bridge app: Kconfig fixes
Adding sample-specific Kconfig options and fixing links to them. Signed-off-by: Pekka Niskanen <[email protected]>
1 parent 620f81c commit 9bfb792

File tree

6 files changed

+127
-86
lines changed

6 files changed

+127
-86
lines changed

applications/matter_bridge/doc/matter_bridge_description.rst

Lines changed: 41 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -470,6 +470,41 @@ CONFIG_BRIDGE_BT_RECOVERY_SCAN_TIMEOUT_MS
470470
CONFIG_BRIDGE_BT_SCAN_TIMEOUT_MS
471471
``int`` - Set the Bluetooth LE scan timeout in milliseconds.
472472

473+
.. _CONFIG_BRIDGE_FORCE_BT_CONNECTION_PARAMS:
474+
475+
CONFIG_BRIDGE_FORCE_BT_CONNECTION_PARAMS
476+
``bool`` - Determines whether the Matter bridge forces connection parameters or accepts the Bluetooth LE peripheral device selection.
477+
478+
.. _CONFIG_BRIDGE_BT_SCAN_WINDOW:
479+
480+
CONFIG_BRIDGE_BT_SCAN_WINDOW
481+
``int`` - Duration of a central actively scanning for devices within scan interval, equal to ``CONFIG_BRIDGE_BT_SCAN_WINDOW`` * 0.625 ms.
482+
483+
.. _CONFIG_BRIDGE_BT_SCAN_INTERVAL:
484+
485+
CONFIG_BRIDGE_BT_SCAN_INTERVAL
486+
``int`` - Time between consecutive Bluetooth scan windows, equal to ``CONFIG_BRIDGE_BT_SCAN_INTERVAL`` * 0.625 ms.
487+
488+
.. _CONFIG_BRIDGE_BT_CONNECTION_INTERVAL_MIN:
489+
490+
CONFIG_BRIDGE_BT_CONNECTION_INTERVAL_MIN
491+
``int`` - The minimum duration of time requested by central after the peripheral device should wake up to communicate, equal to ``CONFIG_BRIDGE_BT_CONNECTION_INTERVAL_MIN`` * 1.25 ms.
492+
493+
.. _CONFIG_BRIDGE_BT_CONNECTION_INTERVAL_MAX:
494+
495+
CONFIG_BRIDGE_BT_CONNECTION_INTERVAL_MAX
496+
``int`` - The maximum duration of time requested by central after the peripheral device should wake up to communicate, equal to ``CONFIG_BRIDGE_BT_CONNECTION_INTERVAL_MAX`` * 1.25 ms.
497+
498+
.. _CONFIG_BRIDGE_BT_CONNECTION_TIMEOUT:
499+
500+
CONFIG_BRIDGE_BT_CONNECTION_TIMEOUT
501+
``int`` - The time since the last packet was successfully received until the devices consider the connection lost, equal to ``CONFIG_BRIDGE_BT_CONNECTION_TIMEOUT`` cs.
502+
503+
.. _CONFIG_BRIDGE_BT_CONNECTION_LATENCY:
504+
505+
CONFIG_BRIDGE_BT_CONNECTION_LATENCY
506+
``int`` - The number of connection events the peripheral can skip waking up for if it does not have any data to send.
507+
473508
The following options affect how many bridged devices the application supports.
474509
See the :ref:`matter_bridge_app_bridged_support_configs` section for more information.
475510

@@ -573,12 +608,12 @@ You can disable configuring the parameters by setting the :kconfig:option:`CONFI
573608

574609
Use the following Kconfig options to set the desired parameters:
575610

576-
- :kconfig:option:`CONFIG_BRIDGE_BT_SCAN_WINDOW` - The duration a central actively scans for devices within the scan interval.
577-
- :kconfig:option:`CONFIG_BRIDGE_BT_SCAN_INTERVAL` - Time between consecutive Bluetooth LE scan windows.
578-
- :kconfig:option:`CONFIG_BRIDGE_BT_CONNECTION_INTERVAL_MIN` - The minimum time requested by the central (the bridge) after which the peripheral device should wake up to communicate.
579-
- :kconfig:option:`CONFIG_BRIDGE_BT_CONNECTION_INTERVAL_MAX` - The maximum time requested by the central (the bridge) after which the peripheral device should wake up to communicate.
580-
- :kconfig:option:`CONFIG_BRIDGE_BT_CONNECTION_TIMEOUT` - The time since the last packet was successfully received until the devices consider the connection lost.
581-
- :kconfig:option:`CONFIG_BRIDGE_BT_CONNECTION_LATENCY` - Allows the peripheral to skip waking up for a certain number of connection events if it does not have any data to send.
611+
- :ref:`CONFIG_BRIDGE_BT_SCAN_WINDOW` - The duration a central actively scans for devices within the scan interval.
612+
- :ref:`CONFIG_BRIDGE_BT_SCAN_INTERVAL` - Time between consecutive Bluetooth LE scan windows.
613+
- :ref:`CONFIG_BRIDGE_BT_CONNECTION_INTERVAL_MIN` - The minimum time requested by the central (the bridge) after which the peripheral device should wake up to communicate.
614+
- :ref:`CONFIG_BRIDGE_BT_CONNECTION_INTERVAL_MAX` - The maximum time requested by the central (the bridge) after which the peripheral device should wake up to communicate.
615+
- :ref:`CONFIG_BRIDGE_BT_CONNECTION_TIMEOUT` - The time since the last packet was successfully received until the devices consider the connection lost.
616+
- :ref:`CONFIG_BRIDGE_BT_CONNECTION_LATENCY` - Allows the peripheral to skip waking up for a certain number of connection events if it does not have any data to send.
582617

583618
The parameters in this application have been selected based on the :ref:`multiprotocol_bt_thread` information in the :ref:`ug_multiprotocol_support` section.
584619

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

Lines changed: 1 addition & 1 deletion
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 :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. |
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. |

doc/nrf/samples/matter.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -123,3 +123,4 @@ In addition to these samples, check also the following Matter applications:
123123

124124
../../../samples/matter/*/README
125125
../../../samples/matter/common/config
126+
../../../samples/matter/common/config_matter_stack

samples/matter/common/config.rst

Lines changed: 1 addition & 76 deletions
Original file line numberDiff line numberDiff line change
@@ -94,7 +94,7 @@ CONFIG_NCS_SAMPLE_MATTER_DIAGNOSTIC_LOGS_NETWORK_LOGS
9494

9595
.. _CONFIG_NCS_SAMPLE_MATTER_DIAGNOSTIC_LOGS_TEST:
9696

97-
ONFIG_NCS_SAMPLE_MATTER_DIAGNOSTIC_LOGS_TEST
97+
CONFIG_NCS_SAMPLE_MATTER_DIAGNOSTIC_LOGS_TEST
9898
``bool`` - Enable the testing module for the diagnostic logs cluster.
9999

100100
.. _CONFIG_NCS_SAMPLE_MATTER_DIAGNOSTIC_LOGS_REDIRECT:
@@ -248,78 +248,3 @@ 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.
Lines changed: 80 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,80 @@
1+
.. _matter_stack_config:
2+
3+
Shared configurations in Matter stack
4+
#####################################
5+
6+
.. contents::
7+
:local:
8+
:depth: 2
9+
10+
This page lists Kconfig options and snippets shared by ``sdk-connectedhomeip``.
11+
See the :ref:`ug_matter_device_advanced_kconfigs` page for more detailed information.
12+
13+
Configuration options
14+
*********************
15+
16+
Check and configure the following configuration options:
17+
18+
.. _CONFIG_CHIP_LAST_FABRIC_REMOVED_ACTION_DELAY:
19+
20+
CONFIG_CHIP_LAST_FABRIC_REMOVED_ACTION_DELAY
21+
``int`` - After removing the last fabric wait defined time [in milliseconds] to perform an action.
22+
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.
23+
This schedule will allow for avoiding race conditions before the device removes non-volatile data.
24+
25+
.. _CONFIG_FACTORY_DATA_CUSTOM_BACKEND:
26+
27+
CONFIG_FACTORY_DATA_CUSTOM_BACKEND
28+
``bool`` - Enable a custom backend for factory data.
29+
This option is used to enable a custom backend for factory data.
30+
The custom backend is used to store the factory data in a custom location.
31+
32+
.. _CONFIG_CHIP_LAST_FABRIC_REMOVED_ERASE_AND_PAIRING_START:
33+
34+
CONFIG_CHIP_LAST_FABRIC_REMOVED_ERASE_AND_PAIRING_START
35+
``bool`` - After removing the last fabric erase NVS and start Bluetooth LE advertising.
36+
After removing the last fabric the device will perform the factory reset without rebooting and start the Bluetooth LE advertisement automatically.
37+
The current RAM state will be saved and the new commissioning to the next fabric will use the next possible fabric index.
38+
This option should not be used for devices that normally do not advertise Bluetooth LE on boot to keep their original behavior.
39+
40+
.. _CONFIG_CHIP_LAST_FABRIC_REMOVED_ERASE_AND_REBOOT:
41+
42+
CONFIG_CHIP_LAST_FABRIC_REMOVED_ERASE_AND_REBOOT
43+
``bool`` - After removing the last fabric erase NVS and reboot.
44+
After removing the last fabric the device will perform the factory reset and then reboot.
45+
The current RAM state will be removed and the new commissioning to the new fabric will use the initial fabric index.
46+
This option is the safest.
47+
48+
.. _CONFIG_CHIP_LAST_FABRIC_REMOVED_ERASE_ONLY:
49+
50+
CONFIG_CHIP_LAST_FABRIC_REMOVED_ERASE_ONLY
51+
``bool`` - After removing the last fabric erase NVS only.
52+
After removing the last fabric the device will perform the factory reset only without rebooting.
53+
The current RAM state will be saved and the new commissioning to the next fabric will use the next possible fabric index.
54+
55+
.. _CONFIG_CHIP_LAST_FABRIC_REMOVED_NONE:
56+
57+
CONFIG_CHIP_LAST_FABRIC_REMOVED_NONE
58+
``bool`` - After removing the last fabric do not perform any action.
59+
After removing the last fabric the device will not perform factory reset or reboot.
60+
The current state will be left as it is and the Bluetooth LE advertising will not start automatically.
61+
62+
.. _CONFIG_CHIP_MEMORY_PROFILING:
63+
64+
CONFIG_CHIP_MEMORY_PROFILING
65+
``bool`` - Enable features for tracking memory usage.
66+
Enables features for tracking memory usage in Matter.
67+
68+
.. _CONFIG_CHIP_NUS:
69+
70+
CONFIG_CHIP_NUS
71+
``bool`` - Enable Nordic UART service for Matter purposes.
72+
Enables Nordic UART service (NUS) for Matter samples.
73+
Using the NUS service, you can control a Matter sample using pre-defined Bluetooth LE commands and perform defined operations.
74+
The CHIP NUS service can be useful to keep communication with a smart home device when a connection within Matter network is lost.
75+
76+
.. _CONFIG_CHIP_FACTORY_DATA_ROTATING_DEVICE_UID_MAX_LEN:
77+
78+
CONFIG_CHIP_FACTORY_DATA_ROTATING_DEVICE_UID_MAX_LEN
79+
``int`` - Maximum length of rotating device ID unique ID in bytes
80+
Maximum acceptable length of rotating device ID unique ID in bytes.

samples/matter/lock/README.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -138,7 +138,7 @@ In the door lock sample, you can use the following commands with the Bluetooth L
138138
* ``Lock`` - To lock the door of the connected device.
139139
* ``Unlock`` - To unlock the door of the connected device.
140140

141-
If the device is already connected to the Matter network, the notification about changing the lock state will be send to the Bluetooth controller.
141+
If the device is already connected to the Matter network, the notification about changing the lock state will be sent to the Bluetooth controller.
142142

143143
Currently, the door lock's Bluetooth LE service extension with NUS is only available for the nRF52840 and the nRF5340 DKs in the :ref:`Matter over Thread <ug_matter_gs_testing>` network variant.
144144
However, you can use the Bluetooth LE service extension regardless of whether the device is connected to a Matter over Thread network or not.
@@ -556,7 +556,7 @@ Onboarding information
556556
++++++++++++++++++++++
557557

558558
When you start the commissioning procedure, the controller must get the onboarding information from the Matter accessory device.
559-
The onboarding information representation depends on your commissioner setup.
559+
The onboarding information representation depends on your commissioner set-up.
560560

561561
For this sample, you can use one of the following :ref:`onboarding information formats <ug_matter_network_topologies_commissioning_onboarding_formats>` to provide the commissioner with the data payload that includes the device discriminator and the setup PIN code:
562562

@@ -822,7 +822,7 @@ To test the :ref:`matter_lock_sample_ble_nus` feature, complete the following st
822822
823823
west flash --erase
824824
825-
#. If you built the sample with the debug configuration, connect the board to an UART console to see the log entries from the device.
825+
#. If you built the sample with the debug configuration, connect the board to a UART console to see the log entries from the device.
826826
#. Open the nRF Toolbox application on your smartphone.
827827
#. Select :guilabel:`Universal Asynchronous Receiver/Transmitter UART` from the list in the nRF Toolbox application.
828828
#. Tap on :guilabel:`Connect`.

0 commit comments

Comments
 (0)