1
1
# Matter nRF Connect All Clusters Example Application
2
2
3
+ > ** Note:** This example is intended only to perform smoke tests of a Matter
4
+ > solution integrated with nRF Connect SDK platform. The example quality is not
5
+ > production ready and it may contain minor bugs or use not optimal
6
+ > configuration. It is not recommended to use this example as a basis for
7
+ > creating a market ready product.
8
+ >
9
+ > For the production ready and optimized Matter samples, see
10
+ > [ nRF Connect SDK samples] ( https://docs.nordicsemi.com/bundle/ncs-latest/page/nrf/samples/matter.html ) .
11
+ > The Matter samples in nRF Connect SDK use various additional software
12
+ > components and provide multiple optional features that improve the developer
13
+ > and user experience. To read more about it, see
14
+ > [ Matter support in nRF Connect SDK] ( https://docs.nordicsemi.com/bundle/ncs-latest/page/nrf/protocols/matter/index.html#ug-matter )
15
+ > page. Using Matter samples from nRF Connect SDK allows you to get a full
16
+ > Nordic technical support via [ DevZone] ( https://devzone.nordicsemi.com/ )
17
+ > portal.
18
+
3
19
The nRF All Clusters Example Application implements various ZCL clusters
4
20
populated on three endpoints. You can use this example as a reference for
5
21
creating your own application.
@@ -85,10 +101,10 @@ The example supports building and running on the following devices:
85
101
86
102
| Hardware platform | Build target | Platform image |
87
103
| ------------------------------------------------------------------------------------------------- | -------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- |
88
- | [ nRF52840 DK] ( https://www.nordicsemi.com/Software-and-Tools/Development-Kits/nRF52840-DK ) | ` nrf52840dk_nrf52840 ` | <details ><summary >nRF52840 DK</summary ><img src =" ../../platform/nrfconnect/doc/images/nRF52840_DK_info-medium.jpg " alt =" nRF52840 DK " /></details > |
89
- | [ nRF5340 DK] ( https://www.nordicsemi.com/Software-and-Tools/Development-Kits/nRF5340-DK ) | ` nrf5340dk_nrf5340_cpuapp ` | <details ><summary >nRF5340 DK</summary ><img src =" ../../platform/nrfconnect/doc/images/nRF5340_DK_info-medium.jpg " alt =" nRF5340 DK " /></details > |
90
- | [ nRF52840 Dongle] ( https://www.nordicsemi.com/Software-and-Tools/Development-Kits/nRF52840-Dongle ) | ` nrf52840dongle_nrf52840 ` | <details ><summary >nRF52840 Dongle</summary ><img src =" ../../platform/nrfconnect/doc/images/nRF52840_Dongle-medium.jpg " alt =" nRF52840 Dongle " /></details > |
91
- | [ nRF7002 DK] ( https://www.nordicsemi.com/Products/Development-hardware/nRF7002-DK ) | ` nrf7002dk_nrf5340_cpuapp ` | <details ><summary >nRF7002 DK</summary ><img src =" ../../platform/nrfconnect/doc/images/nRF7002-DK_Front-small.png " alt =" nRF7002 DK " /></details > |
104
+ | [ nRF52840 DK] ( https://www.nordicsemi.com/Software-and-Tools/Development-Kits/nRF52840-DK ) | ` nrf52840dk/nrf52840 ` | <details ><summary >nRF52840 DK</summary ><img src =" ../../platform/nrfconnect/doc/images/nRF52840_DK_info-medium.jpg " alt =" nRF52840 DK " /></details > |
105
+ | [ nRF5340 DK] ( https://www.nordicsemi.com/Software-and-Tools/Development-Kits/nRF5340-DK ) | ` nrf5340dk/nrf5340/cpuapp ` | <details ><summary >nRF5340 DK</summary ><img src =" ../../platform/nrfconnect/doc/images/nRF5340_DK_info-medium.jpg " alt =" nRF5340 DK " /></details > |
106
+ | [ nRF52840 Dongle] ( https://www.nordicsemi.com/Software-and-Tools/Development-Kits/nRF52840-Dongle ) | ` nrf52840dongle/nrf52840 ` | <details ><summary >nRF52840 Dongle</summary ><img src =" ../../platform/nrfconnect/doc/images/nRF52840_Dongle-medium.jpg " alt =" nRF52840 Dongle " /></details > |
107
+ | [ nRF7002 DK] ( https://www.nordicsemi.com/Products/Development-hardware/nRF7002-DK ) | ` nrf7002dk/nrf5340/cpuapp ` | <details ><summary >nRF7002 DK</summary ><img src =" ../../platform/nrfconnect/doc/images/nRF7002-DK_Front-small.png " alt =" nRF7002 DK " /></details > |
92
108
93
109
<hr >
94
110
@@ -97,9 +113,9 @@ The example supports building and running on the following devices:
97
113
The development kits for this sample offer the following IPv6 network support
98
114
for Matter:
99
115
100
- - Matter over Thread is supported for ` nrf52840dk_nrf52840 ` and
101
- ` nrf5340dk_nrf5340_cpuapp ` .
102
- - Matter over Wi-Fi is supported for ` nrf7002dk_nrf5340_cpuapp ` .
116
+ - Matter over Thread is supported for ` nrf52840dk/nrf52840 ` and
117
+ ` nrf5340dk/nrf5340/cpuapp ` .
118
+ - Matter over Wi-Fi is supported for ` nrf7002dk/nrf5340/cpuapp ` .
103
119
104
120
## Device UI
105
121
@@ -248,14 +264,15 @@ Complete the following steps to build the sample:
248
264
249
265
2. Run the following command to build the example, with _build-target_ replaced
250
266
with the build target name of the Nordic Semiconductor's kit you own, for
251
- example `nrf52840dk_nrf52840 `:
267
+ example `nrf52840dk/nrf52840 `:
252
268
253
- $ west build -b build-target
269
+ $ west build -b build-target --sysbuild
254
270
255
271
You only need to specify the build target on the first build. See
256
272
[Requirements](#requirements) for the build target names of compatible kits.
257
273
258
- The output `zephyr.hex` file will be available in the `build/zephyr/` directory.
274
+ The output `zephyr.hex` file will be available in the `build/nrfconnect/zephyr/`
275
+ directory.
259
276
260
277
### Removing build artifacts
261
278
@@ -270,7 +287,7 @@ following command:
270
287
To build the example with release configuration that disables the diagnostic
271
288
features like logs and command-line interface, run the following command:
272
289
273
- $ west build -b build-target -- -DCONF_FILE=prj_release.conf
290
+ $ west build -b build-target --sysbuild -- -DCONF_FILE=prj_release.conf
274
291
275
292
Remember to replace _build-target_ with the build target name of the Nordic
276
293
Semiconductor's kit you own.
@@ -281,9 +298,9 @@ Support for DFU using Matter OTA is disabled by default.
281
298
282
299
To build the example with configuration that supports DFU, run the following
283
300
command with _build-target_ replaced with the build target name of the Nordic
284
- Semiconductor kit you are using (for example `nrf52840dk_nrf52840 `):
301
+ Semiconductor kit you are using (for example `nrf52840dk/nrf52840 `):
285
302
286
- $ west build -b build-target -- -DCONF_FILE=prj_dfu.conf
303
+ $ west build -b build-target --sysbuild -- -DCONF_FILE=prj_dfu.conf
287
304
288
305
> **Note**:
289
306
>
@@ -299,7 +316,7 @@ Semiconductor kit you are using (for example `nrf52840dk_nrf52840`):
299
316
#### Changing bootloader configuration
300
317
301
318
To change the default MCUboot configuration, edit the `prj.conf` file located in
302
- the `child_image /mcuboot` directory.
319
+ the `sysbuild /mcuboot` directory.
303
320
304
321
#### Changing flash memory settings
305
322
@@ -311,8 +328,9 @@ purposes. You can change these settings by defining
311
328
This example uses this option to define using an external flash.
312
329
313
330
To modify the flash settings of your board (that is, your _build-target_, for
314
- example `nrf52840dk_nrf52840`), edit the `pm_static_dfu.yml` file located in the
315
- `configuration/build-target/` directory.
331
+ example `nrf52840dk/nrf52840`), edit the `pm_static_<build_target>.yml` file
332
+ (for example `pm_static_nrf52840dk_nrf52840.yml`), located in the main
333
+ application directory.
316
334
317
335
<hr>
318
336
@@ -324,7 +342,7 @@ using the menuconfig utility.
324
342
To open the menuconfig utility, run the following command from the example
325
343
directory:
326
344
327
- $ west build -b build-target -t menuconfig
345
+ $ west build -b build-target --sysbuild - t menuconfig
328
346
329
347
Remember to replace _build-target_ with the build target name of the Nordic
330
348
Semiconductor's kit you own.
0 commit comments