Skip to content

Commit 646c2a9

Browse files
docs: Align with add-on
Signed-off-by: Arkadiusz Balys <arkadiusz.balys@nordicsemi.no>
1 parent e6637e6 commit 646c2a9

49 files changed

Lines changed: 1226 additions & 639 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

docs/include/requirements/thread.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
If you want to commission the |matter_name| device and control it remotely through a Thread network, you need to set-up the `Thread Border Router <Thread Border Router>`_ and control it with the `chip-tool`_, or use a commercial ecosystem controller.
1+
If you want to commission the |matter_name| device and control it remotely through a Thread network, you need to set-up the `Thread Border Router <Thread Border Router>`_ and control it with the :ref:`CHIP Tool <ug_matter_gs_tools_chip>`, or use a commercial ecosystem controller.
22
When this happens, you will also be able to control it through a Matter controller device :ref:`configured on PC or smartphone <ug_matter_configuring>`.
33
This requires additional hardware depending on the setup you choose.
44

docs/include/requirements/thread_wifi.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
If you want to commission the |matter_name| device and control it remotely through a Thread or Wi-Fi network, you need to set-up the `Thread Border Router <Thread Border Router>`_ (Matter over Thread only) and control it with the `chip-tool`_, or use a commercial ecosystem controller.
1+
If you want to commission the |matter_name| device and control it remotely through a Thread or Wi-Fi network, you need to set-up the `Thread Border Router <Thread Border Router>`_ (Matter over Thread only) and control it with the :ref:`CHIP Tool <ug_matter_gs_tools_chip>`, or use a commercial ecosystem controller.
22
When this happens, you will also be able to control it through a Matter controller device :ref:`configured on PC or smartphone <ug_matter_configuring>`.
33
This requires additional hardware depending on the setup you choose.
44

docs/includes/sample_board_rows.txt

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,14 +2,40 @@
22

33
| Hardware platforms | PCA | Board name | Board target |
44

5+
.. nrf52840dk_nrf52840
6+
7+
| `Developing with nRF52 Series`_ | PCA10056 | `nrf52840dk`_ | ``nrf52840dk/nrf52840`` |
8+
9+
.. nrf5340dk_nrf5340_cpuapp
10+
11+
| `Developing with nRF53 Series`_ | PCA10095 | `nrf5340dk`_ | ``nrf5340dk/nrf5340/cpuapp`` |
12+
513
.. nrf54l15dk_nrf54l15_cpuapp
614

715
| `Developing with nRF54L Series`_ | PCA10156 | `nrf54l15dk`_ | ``nrf54l15dk/nrf54l15/cpuapp`` |
816

17+
.. nrf54l15dk_nrf54l15_cpuapp_ns
18+
19+
| `Developing with nRF54L Series`_ | PCA10156 | `nrf54l15dk`_ | ``nrf54l15dk/nrf54l15/cpuapp/ns`` |
20+
21+
.. nrf54l15dk_nrf54l10_cpuapp
22+
23+
| `Developing with nRF54L Series`_ | PCA10156 | `nrf54l15dk`_ | ``nrf54l15dk/nrf54l10/cpuapp`` |
24+
925
.. nrf54lm20dk_nrf54lm20a_cpuapp
1026

1127
| `Developing with nRF54L Series`_ | PCA10184 | `nrf54lm20dk`_ | ``nrf54lm20dk/nrf54lm20a/cpuapp`` |
1228

1329
.. nrf54lm20dk_nrf54lm20b_cpuapp
1430

1531
| `Developing with nRF54L Series`_ | PCA10184 | `nrf54lm20dk`_ | ``nrf54lm20dk/nrf54lm20b/cpuapp`` |
32+
33+
.. nrf54l15tag_nrf54l15_cpuapp
34+
35+
| `Developing with nRF54L Series`_ | PCA10156 | `nrf54l15dk`_ | ``nrf54l15tag/nrf54l15/cpuapp`` |
36+
37+
.. nrf54l15dk_nrf54l15_cpuapp_and_cpuapp_ns
38+
39+
| `Developing with nRF54L Series`_ | PCA10156 | `nrf54l15dk`_ | ``nrf54l15dk/nrf54l15/cpuapp`` |
40+
| | | | |
41+
| | | | ``nrf54l15dk/nrf54l15/cpuapp/ns`` |

docs/index.rst

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,8 +11,8 @@ In combination with the |NCS|, the |addon| allows for development of Matter acce
1111

1212
For additional context on other solutions, refer to the following resources:
1313

14-
* `Matter overview`_ — Introduction to the Matter protocol and its use in the |NCS|.
15-
* `Matter architecture`_ — How Matter accessories, controllers, and networks fit together.
14+
* :ref:`Matter overview <ug_matter_intro_overview>` — Introduction to the Matter protocol and its use in the |NCS|.
15+
* :ref:`ug_matter_overview_architecture` — How Matter accessories, controllers, and networks fit together.
1616
* `Matter add-on repository`_ — Source code for the Matter add-on.
1717

1818
.. toctree::
@@ -21,6 +21,8 @@ For additional context on other solutions, refer to the following resources:
2121
:glob:
2222

2323
setup
24+
samples/index
25+
snippets/index
2426
matter/index
2527
config
2628
release_notes

docs/links.txt

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,8 @@
1717
.. _`Matter nRF Connect releases`: https://github.com/nrfconnect/sdk-connectedhomeip/releases
1818
.. _`Thread tools`: https://docs.nordicsemi.com/bundle/ncs-|ncs_version|/page/nrf/protocols/thread/tools.html
1919
.. _`Running OTBR using Docker`: https://docs.nordicsemi.com/bundle/ncs-|ncs_version|/page/nrf/protocols/thread/tools.html#ug-thread-tools-tbr-docker
20+
.. _`nRF Sniffer for 802.15.4`: https://docs.nordicsemi.com/bundle/ug_sniffer_802154/page/UG/sniffer_802154/intro_802154.html
21+
.. _`nRF Thread Topology Monitor`: https://docs.nordicsemi.com/bundle/ug_nrf_ttm/page/UG/nrf_ttm/ttm_introduction.html
2022
.. _`Testing Matter in the NCS`: https://docs.nordicsemi.com/bundle/ncs-|ncs_version|/page/nrf/protocols/matter/getting_started/testing/index.html
2123
.. _`Matter controller`: https://docs.nordicsemi.com/bundle/ncs-|ncs_version|/page/nrf/protocols/matter/overview/network_topologies.html#ug-matter-configuring-controller
2224
.. _`Onboarding information formats`: https://docs.nordicsemi.com/bundle/ncs-|ncs_version|/page/nrf/protocols/matter/overview/commissioning.html#ug-matter-network-topologies-commissioning-onboarding-formats
@@ -34,6 +36,16 @@
3436

3537
.. ### Matter add-on external :ref: targets
3638

39+
.. _app_approtect: https://docs.nordicsemi.com/bundle/ncs-|ncs_version|/page/nrf/security/ap_protect.html
40+
.. _ug_thread_tools: https://docs.nordicsemi.com/bundle/ncs-|ncs_version|/page/nrf/protocols/thread/tools.html
41+
.. _ug_thread_tools_tbr: https://docs.nordicsemi.com/bundle/ncs-|ncs_version|/page/nrf/protocols/thread/tools.html#ug-thread-tools-tbr
42+
.. _partition_manager: https://docs.nordicsemi.com/bundle/ncs-|ncs_version|/page/nrf/scripts/partition_manager/partition_manager.html
43+
.. _migration_partitions: https://docs.nordicsemi.com/bundle/ncs-|ncs_version|/page/nrf/releases_and_maturity/migration/migration_partitions.html
44+
.. _ncs_release_notes_340: https://docs.nordicsemi.com/bundle/ncs-|ncs_version|/page/nrf/releases_and_maturity/releases/release-notes-3.4.0.html
45+
.. _`Power optimization recommendations`: https://docs.nordicsemi.com/bundle/ncs-|ncs_version|/page/nrf/test_and_optimize/optimizing/power_general.html
46+
.. _`Disable unused pins and peripherals`: https://docs.nordicsemi.com/bundle/ncs-|ncs_version|/page/nrf/test_and_optimize/optimizing/power_general.html#disable-unused-pins-and-peripherals
47+
.. _`Enable Device Power Management module`: https://docs.nordicsemi.com/bundle/ncs-|ncs_version|/page/nrf/test_and_optimize/optimizing/power_general.html#enable-device-power-management-module
48+
.. _`Configure radio transmitter power`: https://docs.nordicsemi.com/bundle/ncs-|ncs_version|/page/nrf/test_and_optimize/optimizing/power_general.html#configure-radio-transmitter-power
3749

3850
.. ### Matter documentation backtick links (from sdk-nrf links.txt)
3951

docs/matter/end_product/attestation.rst

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -153,10 +153,12 @@ Dedicating a separate partition for this purpose lets avoid recertification when
153153

154154
For information about how to generate the factory data, read the detailed :ref:`ug_matter_device_factory_provisioning` guide in the Matter documentation.
155155

156+
.. _ug_matter_device_attestation_secured_communication:
157+
156158
Requirements for secured communication
157159
======================================
158160

159-
Before the commissioner can verify the DAC information, it must establish a secure PASE session, which is required for sending commissioning messages, including the `Device Attestation procedure`_.
161+
Before the commissioner can verify the DAC information, it must establish a secure PASE session, which is required for sending commissioning messages, including the :ref:`Device Attestation procedure <ug_matter_device_attestation_procedure>`.
160162

161163
The Verifier is used for this purpose.
162164
This is one of the input values of the underlying SPAKE2+ protocol.
@@ -183,12 +185,12 @@ Product Attestation Intermediate certificate
183185

184186
Verifier
185187
The Verifier itself is not a part of the DAC, although it is included in the factory data.
186-
See `Requirements for secured communication`_.
188+
See :ref:`Requirements for secured communication <ug_matter_device_attestation_secured_communication>`.
187189

188190
Certification Declaration
189191
This is |matter_cd_definition|.
190192
It contains a series of information required for Device Attestation, including Vendor ID, Certificate ID, certification type, optional information related to DAC, and other.
191-
CD is included in the attestation information packet send by the commissionee during the `Device Attestation procedure`_.
193+
CD is included in the attestation information packet send by the commissionee during the :ref:`Device Attestation procedure <ug_matter_device_attestation_procedure>`.
192194

193195
.. note::
194196
The CD information is not located in the factory data, but in the application itself.
@@ -198,6 +200,8 @@ Certification Declaration
198200

199201
These are the elements that are checked and validated by the commissioner at the start of the commissioning procedure.
200202

203+
.. _ug_matter_device_attestation_procedure:
204+
201205
Device Attestation procedure
202206
****************************
203207

docs/matter/end_product/bootloader.rst

Lines changed: 15 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -16,15 +16,15 @@ Adding MCUboot to application
1616
*****************************
1717

1818
Read :ref:`ug_bootloader_adding_sysbuild_immutable_mcuboot` to learn how to add MCUboot to an |NCS| application.
19-
Some Matter samples include :term:`Device Firmware Update (DFU)` support out of the box, as listed in the :ref:`sample feature matrix table <matter_samples>`.
19+
Some Matter samples include Device Firmware Update (DFU) support out of the box, as listed in the :ref:`sample feature matrix table <matter_samples>`.
2020

2121
MCUboot minimal configuration
2222
*****************************
2323

2424
MCUboot is by default configured to enable debug features, such as logs.
2525
You can reduce the size of the bootloader image by disabling unnecessary features.
2626

27-
See the following files for the MCUboot minimal configuration used by :ref:`Matter samples <matter_samples>` in the |NCS|:
27+
See the following files for the MCUboot minimal configuration used by :ref:`matter_samples` in the |NCS|:
2828

2929
* :file:`prj.conf` file located in each sample's :file:`sysbuild/mcuboot` directory
3030
* Board files located in each sample's :file:`sysbuild/mcuboot/boards` directory
@@ -37,7 +37,17 @@ This configuration allows to reduce the flash partition occupied by MCUboot to 2
3737
Partition layout
3838
****************
3939

40-
.. include:: ../../../includes/pm_deprecation.txt
40+
.. note::
41+
The :ref:`partition_manager` is a component in the |NCS| and is responsible for handling the memory partitioning at build time.
42+
43+
This functionality is in the process of being deprecated and replaced by Zephyr's default devicetree-based memory partitioning.
44+
It is recommended that all new designs using Nordic devices are to be built with DTS instead of Partition Manager.
45+
Partition Manager will be removed from the |NCS| by the end of 2026 from the main branch.
46+
47+
For more information on how to configure partitions using DTS and how to migrate your existing configuration to DTS, see the following pages:
48+
49+
* :ref:`migration_partitions`
50+
* :ref:`ncs_release_notes_340`
4151

4252
A bootloader is a critical component in a Matter device, ensuring secure firmware updates and authenticating new application images.
4353
All Nordic Matter samples in the |NCS| use MCUboot as the primary bootloader, with configuration and partitioning adapted to application and device needs.
@@ -174,11 +184,11 @@ The following tables summarize the partitions by target.
174184
Settings partition
175185
==================
176186

177-
The nRF Connect platform in Matter uses Zephyr's :ref:`zephyr:settings_api` API to provide the storage capabilities to the Matter stack.
187+
The nRF Connect platform in Matter uses Zephyr's `Settings <Settings>`_ API to provide the storage capabilities to the Matter stack.
178188
This requires that you define the ``settings_storage`` partition in the flash.
179189
The recommended minimum size of the partition is 32 kB, but you can reserve even more space if your application uses the storage extensively.
180190

181-
The Zephyr settings storage is implemented by the :ref:`Zephyr NVS (Non-Volatile Storage) <zephyr:nvs_api>` or :ref:`ZMS (Zephyr Memory Storage) <zephyr:zms_api>` backends.
191+
The Zephyr settings storage is implemented by the `Zephyr NVS (Non-Volatile Storage) <Non-Volatile Storage (NVS)>`_ or `ZMS (Zephyr Memory Storage) <ZMS (Zephyr Memory Storage)>`_ backends.
182192
You can select either backend, and the selection affects several factors, such as the operational performance or memory lifetime.
183193
To achieve the optimal experience, it is recommended to use:
184194

docs/matter/end_product/certification.rst

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -100,7 +100,7 @@ Reporting
100100
=========
101101

102102
After the Matter component successfully passes all required test cases, the ATL sends a test report to both you and CSA.
103-
The test report summarizes the testing process and includes a variety of information, including details about the device, `Certification types`_, test plans, and Test Harness.
103+
The test report summarizes the testing process and includes a variety of information, including details about the device, :ref:`Certification types <ug_matter_device_certification_types>`, test plans, and Test Harness.
104104

105105
Application
106106
===========
@@ -401,6 +401,8 @@ In contrast, portfolio certification accommodates devices that may differ at the
401401

402402
For more details, read a dedicated document in the `Matter Resource Kit`_.
403403

404+
.. _ug_matter_device_product_family_certification:
405+
404406
Product Family Certification
405407
----------------------------
406408

@@ -423,7 +425,7 @@ Certification by Similarity
423425
---------------------------
424426

425427
Certification by Similarity lets you certify products that derive from a previously certified product.
426-
This variant is meant for Matter components that use Matter software that was already certified as part of either the standard procedure or the `Product Family certification`_.
428+
This variant is meant for Matter components that use Matter software that was already certified as part of either the standard procedure or the :ref:`Product Family certification <ug_matter_device_product_family_certification>`.
427429

428430
.. figure:: images/matter_device_certification_process_cbs.svg
429431
:alt: Matter certification by similarity overview

docs/matter/end_product/ecosystems_certification.rst

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -25,11 +25,11 @@ The Matter samples delivered in the |NCS| have not received official certificate
2525
However, they have been tested against the Works with Google Home certification test cases and have successfully passed all of them.
2626
The following is a full list of Matter samples that were verified to pass the Works with Google certification test cases:
2727

28-
* :ref:`matter_lock_sample`
29-
* :ref:`matter_light_bulb_sample`
30-
* :ref:`matter_thermostat_sample`
31-
* :ref:`matter_window_covering_sample`
32-
* :ref:`matter_weather_station_app`
28+
* `Matter lock sample <Matter lock sample>`_
29+
* `Matter light bulb sample <Matter light bulb sample>`_
30+
* `Matter thermostat sample <Matter thermostat sample>`_
31+
* `Matter window covering sample <Matter window covering sample>`_
32+
* `Matter Weather Station sample <Matter Weather Station sample>`_
3333

3434
.. _ug_matter_amazon_certification:
3535

@@ -53,12 +53,12 @@ This means that if you create a Matter product based on the |NCS|, you can appro
5353
You can do this by filling the Reference APID field when you register your product on Amazon's developer page.
5454
Use one of the following values:
5555

56-
+-----------------------------------------------------------+-----------------------+
57-
| Matter platform variant | Reference Design APID |
58-
+===========================================================+=======================+
59-
| :ref:`nRF52840 DK <ug_nrf52>` (Matter over Thread) | ZNwt |
60-
+-----------------------------------------------------------+-----------------------+
61-
| :ref:`nRF5340 DK <ug_nrf5340>` (Matter over Thread) | xzNd |
62-
+-----------------------------------------------------------+-----------------------+
63-
| :ref:`nRF7002 DK <ug_nrf70>` (Matter over Wi-Fi®) | jyjh |
64-
+-----------------------------------------------------------+-----------------------+
56+
+-----------------------------------------------------------------------------+-----------------------+
57+
| Matter platform variant | Reference Design APID |
58+
+=============================================================================+=======================+
59+
| `nRF52 Series <Developing with nRF52 Series>`_ (Matter over Thread) | ZNwt |
60+
+-----------------------------------------------------------------------------+-----------------------+
61+
| `nRF53 Series <Developing with nRF53 Series>`_ (Matter over Thread) | xzNd |
62+
+-----------------------------------------------------------------------------+-----------------------+
63+
| `nRF70 Series <Developing with nRF70 Series>`_ (Matter over Wi-Fi®) | jyjh |
64+
+-----------------------------------------------------------------------------+-----------------------+

docs/matter/end_product/factory_provisioning.rst

Lines changed: 15 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -663,13 +663,13 @@ Preparing factory data partition on a device
663663
============================================
664664

665665
The factory data partition is an area in the device's persistent storage, where the factory data set is stored.
666-
This area is configured using the :ref:`partition_manager`, within which all partitions are declared in the :file:`pm_static.yml` file.
666+
This area is configured using the `Partition Manager <Partition Manager>`_, within which all partitions are declared in the :file:`pm_static.yml` file.
667667

668668
To prepare an example that supports factory data, add a partition called ``factory_data`` to the :file:`pm_static.yml` file.
669669
The partition size should be a multiple of one flash page (for nRF52 and nRF53 SoCs, a single page size equals 4 kB).
670670

671671
See the following code snippet for an example of a factory data partition in the :file:`pm_static.yml` file.
672-
The snippet is based on the :file:`pm_static.yml` file from the :ref:`matter_lock_sample` and uses the nRF52840 DK:
672+
The snippet is based on the :file:`pm_static.yml` file from the `Matter lock sample <Matter lock sample>`_ and uses the nRF52840 DK:
673673

674674
.. parsed-literal::
675675
:class: highlight
@@ -694,7 +694,17 @@ The snippet is based on the :file:`pm_static.yml` file from the :ref:`matter_loc
694694
In this example, a ``factory_data`` partition has been placed between the application partition (``mcuboot_primary_app``) and the settings storage.
695695
Its size has been set to one flash page (4 kB).
696696

697-
.. include:: ../../../includes/pm_deprecation.txt
697+
.. note::
698+
The :ref:`partition_manager` is a component in the |NCS| and is responsible for handling the memory partitioning at build time.
699+
700+
This functionality is in the process of being deprecated and replaced by Zephyr's default devicetree-based memory partitioning.
701+
It is recommended that all new designs using Nordic devices are to be built with DTS instead of Partition Manager.
702+
Partition Manager will be removed from the |NCS| by the end of 2026 from the main branch.
703+
704+
For more information on how to configure partitions using DTS and how to migrate your existing configuration to DTS, see the following pages:
705+
706+
* :ref:`migration_partitions`
707+
* :ref:`ncs_release_notes_340`
698708

699709
Use Partition Manager's report tool to ensure you created the factory data partition correctly.
700710
Navigate to the example directory and run the following command:
@@ -895,8 +905,8 @@ Another way to program the factory data to a device is to use the nRF Connect pl
895905
896906
$ west build -b nrf52840dk_nrf52840 -- \
897907
-DCONFIG_CHIP_FACTORY_DATA=y \
898-
-DSB_CONFIG_MATTER_FACTORY_DATA_GENERATE=y \
899-
-DSB_CONFIG_MATTER_FACTORY_DATA_MERGE_WITH_FIRMWARE=y
908+
-DSB_CONFIG_MATTER_ADD_ON_FACTORY_DATA_GENERATE=y \
909+
-DSB_CONFIG_MATTER_ADD_ON_FACTORY_DATA_MERGE_WITH_FIRMWARE=y
900910
901911
You can also build an example with auto-generation of new CD, DAC and PAI certificates.
902912
The newly generated certificates will be added to factory data set automatically.

0 commit comments

Comments
 (0)