Skip to content

Commit 7a62dbf

Browse files
kkasperczyk-nokkasperczyk-no
committed
[nrfconnect] Updated documentation for all nrfconnect examples
Updated docs for all nrfconnect examples to: * be aligned with the most recent NCS 2.7.0 version * mention that the examples are not production ready and redirect to the production ready NCS Matter samples
1 parent 34462f1 commit 7a62dbf

File tree

11 files changed

+324
-188
lines changed

11 files changed

+324
-188
lines changed

‎examples/all-clusters-app/nrfconnect/README.md

+35-17
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,21 @@
11
# Matter nRF Connect All Clusters Example Application
22

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+
319
The nRF All Clusters Example Application implements various ZCL clusters
420
populated on three endpoints. You can use this example as a reference for
521
creating your own application.
@@ -85,10 +101,10 @@ The example supports building and running on the following devices:
85101

86102
| Hardware platform | Build target | Platform image |
87103
| ------------------------------------------------------------------------------------------------- | -------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- |
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> |
92108

93109
<hr>
94110

@@ -97,9 +113,9 @@ The example supports building and running on the following devices:
97113
The development kits for this sample offer the following IPv6 network support
98114
for Matter:
99115

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`.
103119

104120
## Device UI
105121

@@ -248,14 +264,15 @@ Complete the following steps to build the sample:
248264
249265
2. Run the following command to build the example, with _build-target_ replaced
250266
with the build target name of the Nordic Semiconductor's kit you own, for
251-
example `nrf52840dk_nrf52840`:
267+
example `nrf52840dk/nrf52840`:
252268
253-
$ west build -b build-target
269+
$ west build -b build-target --sysbuild
254270
255271
You only need to specify the build target on the first build. See
256272
[Requirements](#requirements) for the build target names of compatible kits.
257273
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.
259276
260277
### Removing build artifacts
261278
@@ -270,7 +287,7 @@ following command:
270287
To build the example with release configuration that disables the diagnostic
271288
features like logs and command-line interface, run the following command:
272289
273-
$ west build -b build-target -- -DCONF_FILE=prj_release.conf
290+
$ west build -b build-target --sysbuild -- -DCONF_FILE=prj_release.conf
274291
275292
Remember to replace _build-target_ with the build target name of the Nordic
276293
Semiconductor's kit you own.
@@ -281,9 +298,9 @@ Support for DFU using Matter OTA is disabled by default.
281298
282299
To build the example with configuration that supports DFU, run the following
283300
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`):
285302
286-
$ west build -b build-target -- -DCONF_FILE=prj_dfu.conf
303+
$ west build -b build-target --sysbuild -- -DCONF_FILE=prj_dfu.conf
287304
288305
> **Note**:
289306
>
@@ -299,7 +316,7 @@ Semiconductor kit you are using (for example `nrf52840dk_nrf52840`):
299316
#### Changing bootloader configuration
300317
301318
To change the default MCUboot configuration, edit the `prj.conf` file located in
302-
the `child_image/mcuboot` directory.
319+
the `sysbuild/mcuboot` directory.
303320
304321
#### Changing flash memory settings
305322
@@ -311,8 +328,9 @@ purposes. You can change these settings by defining
311328
This example uses this option to define using an external flash.
312329
313330
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.
316334
317335
<hr>
318336
@@ -324,7 +342,7 @@ using the menuconfig utility.
324342
To open the menuconfig utility, run the following command from the example
325343
directory:
326344
327-
$ west build -b build-target -t menuconfig
345+
$ west build -b build-target --sysbuild -t menuconfig
328346
329347
Remember to replace _build-target_ with the build target name of the Nordic
330348
Semiconductor's kit you own.

‎examples/all-clusters-minimal-app/nrfconnect/README.md

+31-13
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,21 @@
11
# Matter nRF Connect All Clusters Example Application
22

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+
319
The nRF All Clusters Example Application implements various ZCL clusters
420
populated on three endpoints. You can use this example as a reference for
521
creating your own application.
@@ -77,9 +93,9 @@ The example supports building and running on the following devices:
7793

7894
| Hardware platform | Build target | Platform image |
7995
| ------------------------------------------------------------------------------------------------- | -------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- |
80-
| [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> |
81-
| [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> |
82-
| [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> |
96+
| [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> |
97+
| [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> |
98+
| [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> |
8399

84100
<hr>
85101

@@ -240,14 +256,15 @@ environment:
240256

241257
2. Run the following command to build the example, with _build-target_ replaced
242258
with the build target name of the Nordic Semiconductor's kit you own, for
243-
example `nrf52840dk_nrf52840`:
259+
example `nrf52840dk/nrf52840`:
244260

245-
$ west build -b build-target
261+
$ west build -b build-target --sysbuild
246262

247263
You only need to specify the build target on the first build. See
248264
[Requirements](#requirements) for the build target names of compatible kits.
249265

250-
The output `zephyr.hex` file will be available in the `build/zephyr/` directory.
266+
The output `zephyr.hex` file will be available in the `build/nrfconnect/zephyr/`
267+
directory.
251268

252269
### Removing build artifacts
253270

@@ -262,7 +279,7 @@ following command:
262279
To build the example with release configuration that disables the diagnostic
263280
features like logs and command-line interface, run the following command:
264281

265-
$ west build -b build-target -- -DCONF_FILE=prj_release.conf
282+
$ west build -b build-target --sysbuild -- -DCONF_FILE=prj_release.conf
266283

267284
Remember to replace _build-target_ with the build target name of the Nordic
268285
Semiconductor's kit you own.
@@ -273,9 +290,9 @@ Support for DFU using Matter OTA is disabled by default.
273290

274291
To build the example with configuration that supports DFU, run the following
275292
command with _build-target_ replaced with the build target name of the Nordic
276-
Semiconductor kit you are using (for example `nrf52840dk_nrf52840`):
293+
Semiconductor kit you are using (for example `nrf52840dk/nrf52840`):
277294

278-
$ west build -b build-target -- -DCONF_FILE=prj_dfu.conf
295+
$ west build -b build-target --sysbuild -- -DCONF_FILE=prj_dfu.conf
279296

280297
> **Note**:
281298
>
@@ -291,7 +308,7 @@ Semiconductor kit you are using (for example `nrf52840dk_nrf52840`):
291308
#### Changing bootloader configuration
292309

293310
To change the default MCUboot configuration, edit the `prj.conf` file located in
294-
the `child_image/mcuboot` directory.
311+
the `sysbuild/mcuboot` directory.
295312

296313
#### Changing flash memory settings
297314

@@ -303,8 +320,9 @@ purposes. You can change these settings by defining
303320
This example uses this option to define using an external flash.
304321

305322
To modify the flash settings of your board (that is, your _build-target_, for
306-
example `nrf52840dk_nrf52840`), edit the `pm_static_dfu.yml` file located in the
307-
`configuration/build-target/` directory.
323+
example `nrf52840dk/nrf52840`), edit the `pm_static_<build_target>.yml` file
324+
(for example `pm_static_nrf52840dk_nrf52840.yml`), located in the main
325+
application directory.
308326

309327
<hr>
310328

@@ -316,7 +334,7 @@ using the menuconfig utility.
316334
To open the menuconfig utility, run the following command from the example
317335
directory:
318336

319-
$ west build -b build-target -t menuconfig
337+
$ west build -b build-target --sysbuild -t menuconfig
320338

321339
Remember to replace _build-target_ with the build target name of the Nordic
322340
Semiconductor's kit you own.

‎examples/chef/nrfconnect/README.md

+16
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,21 @@
11
# CHIP nRF Connect SDK Shell Application
22

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+
319
A [chip-shell](../README.md) project for the Nordic nRF52840 and nRF5340
420
development kits, built using the nRF Connect SDK.
521

0 commit comments

Comments
 (0)