Skip to content

Commit 38a898e

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 <arkadiusz.balys@nordicsemi.no>
1 parent fc97d4f commit 38a898e

3 files changed

Lines changed: 27 additions & 0 deletions

File tree

doc/nrf/includes/advanced_conf_matter.txt

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,3 +23,8 @@ 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+
Custom board with Nordic SoC
28+
----------------------------
29+
30+
.. include:: /includes/matter_custom_board.txt
Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
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_WIFI_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:`prj.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.
14+
Therefore, you need to provide your own implementation of the :file:`nrf/samples/matter/common/src/board/board.cpp` board file.
15+
16+
For more information, see the following guides:
17+
18+
* :ref:`board_porting_guide` and :ref:`custom_board_definition` to learn how to create a custom board directory.
19+
* :ref:`ug_matter_device_optimizing_memory` to learn how to optimize memory on your board.
20+
* :ref:`ug_matter_device_advanced_kconfigs` to learn about Matter configuration.
21+
* :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
@@ -484,6 +484,7 @@ Matter samples
484484

485485
* The :ref:`matter_temperature_sensor_sample` sample that demonstrates how to implement and test a Matter temperature sensor device.
486486
* The :ref:`matter_contact_sensor_sample` sample that demonstrates how to implement and test a Matter contact sensor device.
487+
* The ``matter_custom_board`` toggle paragraph in the Matter advanced configuration section of all Matter samples that demonstrates how add and configure a custom board.
487488

488489
* 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.
489490
This change breaks the DFU between the previous |NCS| versions and the |NCS| v3.2.0.

0 commit comments

Comments
 (0)