Skip to content

Commit 81ee51b

Browse files
doc: Matter: Add a guide for custom board creation
A new guide is added to each sample and contains instruction on how to create a custom board and prepare it to work with Matter. Signed-off-by: Arkadiusz Balys <[email protected]>
1 parent e7a05d3 commit 81ee51b

File tree

4 files changed

+31
-3
lines changed

4 files changed

+31
-3
lines changed

doc/nrf/includes/advanced_conf_matter.txt

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,3 +23,10 @@ Factory data support
2323
.. include:: ../lock/README.rst
2424
:start-after: matter_door_lock_sample_factory_data_start
2525
:end-before: matter_door_lock_sample_factory_data_end
26+
27+
.. _matter_custom_board:
28+
29+
Custom board with Nordic SoC
30+
----------------------------
31+
32+
.. include:: /includes/matter_custom_board.txt

doc/nrf/includes/matter_building_nrf5340dk_70ek

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ To build the Matter over Wi-Fi sample variant on nRF5340 DK with nRF7002 EK shie
1010

1111
.. code-block:: console
1212

13-
-- -DSHIELD=nrf7002ek -DFILE_SUFFIX=nrf70ek -DSB_CONFIG_WIFI_NRF70=y
13+
-- -DSHIELD=nrf7002ek -DFILE_SUFFIX=nrf70ek -DSB_CONFIG_WIFI_NRF70=y -DCONFIG_CHIP_WIFI=y
1414

1515
.. group-tab:: Command line
1616

@@ -20,11 +20,11 @@ To build the Matter over Wi-Fi sample variant on nRF5340 DK with nRF7002 EK shie
2020

2121
.. code-block:: console
2222

23-
west build -p -b nrf5340dk/nrf5340/cpuapp -- -DSHIELD=nrf7002ek -DFILE_SUFFIX=nrf70ek -DSB_CONFIG_WIFI_NRF70=y
23+
west build -p -b nrf5340dk/nrf5340/cpuapp -- -DSHIELD=nrf7002ek -DFILE_SUFFIX=nrf70ek -DSB_CONFIG_WIFI_NRF70=y -DCONFIG_CHIP_WIFI=y
2424

2525
* CMake with the following command:
2626

2727
.. code-block:: console
2828

29-
cmake -GNinja -Bbuild -DBOARD=nrf5340dk/nrf5340/cpuapp -DSHIELD=nrf7002ek -DFILE_SUFFIX=nrf70ek -DSB_CONFIG_WIFI_NRF70=y-DAPP_DIR=*app_path* *path_to_zephyr*/share/sysbuild
29+
cmake -GNinja -Bbuild -DBOARD=nrf5340dk/nrf5340/cpuapp -DSHIELD=nrf7002ek -DFILE_SUFFIX=nrf70ek -DSB_CONFIG_WIFI_NRF70=y -DCONFIG_CHIP_WIFI=y -DAPP_DIR=*app_path* *path_to_zephyr*/share/sysbuild
3030
ninja -C build
Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
.. toggle::
2+
3+
To prepare the sample to work with a custom board, complete the following steps:
4+
5+
1. Refer to the :ref:`create-your-board-directory` Zephyr guide and create your board directory.
6+
#. Modify the contents of the :file:`board.yaml` file according to the :ref:`board_description` user guide.
7+
#. Update the :ref:`default_board_configuration` (all `.dts` and `.dtsi` files) to match your board's requirements.
8+
#. Write Kconfig files to enable all required Kconfig options for your board.
9+
#. If you want to build your custom board with nRF70 Wi-Fi support, set the :kconfig:option:`CONFIG_CHIP_WIFI` and :kconfig:option:`SB_CONFIG_NRF70` Kconfig options to ``y``.
10+
#. If your device uses external flash, add its devicetree definition under the :file:`board/<board_name>_<soc_name>.overlay` file, and set ``nordic,pm-ext-flash`` in the devicetree's ``chosen`` configuration.
11+
#. Refer to the :ref:`ug_matter_device_advanced_kconfigs` user guide, create your list of advanced configurations for your board, and apply the selected Kconfig options in the :file:`board/<board_name>_<soc_name>.conf` file.
12+
#. See the :ref:`list of threads used in Matter application <matter_threads_table>` and adjust stack sizes according to your board and project requirements.
13+
#. A custom board does not have support for LEDs and buttons by default. Therefore, you need to provide your own implementation of the :file:`nrf/samples/matter/common/src/board/board.cpp` board file.
14+
15+
For more information, see the following guides:
16+
17+
* :ref:`board_porting_guide` and :ref:`custom_board_definition` to learn how to create a custom board directory.
18+
* :ref:`ug_matter_device_optimizing_memory` to learn how to optimize memory on your board.
19+
* :ref:`ug_matter_device_advanced_kconfigs` to learn about Matter configuration.
20+
* :ref:`ug_matter_hw_requirements` to learn about hardware requirements for Nordic Development Kits and to use as a reference when planning your custom board.

doc/nrf/releases_and_maturity/releases/release-notes-changelog.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -466,6 +466,7 @@ Matter samples
466466

467467
* The :ref:`matter_temperature_sensor_sample` sample that demonstrates how to implement and test a Matter temperature sensor device.
468468
* The :ref:`matter_contact_sensor_sample` sample that demonstrates how to implement and test a Matter contact sensor device.
469+
* The :ref:`matter_custom_board` Matter advanced configuration section that demonstrates how add and configure a custom board.
469470

470471
* Updated all Matter over Wi-Fi samples and applications to store a portion of the application code related to the nRF70 Series Wi-Fi firmware in the external flash memory by default.
471472
This change breaks the DFU between the previous |NCS| versions and the |NCS| v3.2.0.

0 commit comments

Comments
 (0)