You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
[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
Copy file name to clipboardexpand all lines: examples/all-clusters-app/nrfconnect/README.md
+23-17
Original file line number
Diff line number
Diff line change
@@ -1,5 +1,12 @@
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 production ready
5
+
> and it may contain minor bugs or use not optimal configuration. It is not recommended to use this
6
+
> example as a basis for creating a market ready product.
7
+
>
8
+
> For the production ready and optimized Matter samples, see [nRF Connect SDK samples](https://docs.nordicsemi.com/bundle/ncs-latest/page/nrf/samples/matter.html). The Matter samples in nRF Connect SDK use various additional software components and provide multiple optional features that improve the developer and user experience. To read more about it, see [Matter support in nRF Connect SDK](https://docs.nordicsemi.com/bundle/ncs-latest/page/nrf/protocols/matter/index.html#ug-matter) page. Using Matter samples from nRF Connect SDK allows you to get a full Nordic technical support via [DevZone](https://devzone.nordicsemi.com/) portal.
9
+
3
10
The nRF All Clusters Example Application implements various ZCL clusters
4
11
populated on three endpoints. You can use this example as a reference for
5
12
creating your own application.
@@ -85,10 +92,10 @@ The example supports building and running on the following devices:
@@ -97,9 +104,9 @@ The example supports building and running on the following devices:
97
104
The development kits for this sample offer the following IPv6 network support
98
105
for Matter:
99
106
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`.
107
+
- Matter over Thread is supported for `nrf52840dk/nrf52840` and
108
+
`nrf5340dk/nrf5340/cpuapp`.
109
+
- Matter over Wi-Fi is supported for `nrf7002dk/nrf5340/cpuapp`.
103
110
104
111
## Device UI
105
112
@@ -248,14 +255,14 @@ Complete the following steps to build the sample:
248
255
249
256
2. Run the following command to build the example, with _build-target_ replaced
250
257
with the build target name of the Nordic Semiconductor's kit you own, for
251
-
example `nrf52840dk_nrf52840`:
258
+
example `nrf52840dk/nrf52840`:
252
259
253
-
$ west build -b build-target
260
+
$ west build -b build-target --sysbuild
254
261
255
262
You only need to specify the build target on the first build. See
256
263
[Requirements](#requirements) for the build target names of compatible kits.
257
264
258
-
The output `zephyr.hex` file will be available in the `build/zephyr/` directory.
265
+
The output `zephyr.hex` file will be available in the `build/nrfconnect/zephyr/` directory.
259
266
260
267
### Removing build artifacts
261
268
@@ -270,7 +277,7 @@ following command:
270
277
To build the example with release configuration that disables the diagnostic
271
278
features like logs and command-line interface, run the following command:
272
279
273
-
$ west build -b build-target -- -DCONF_FILE=prj_release.conf
280
+
$ west build -b build-target --sysbuild -- -DCONF_FILE=prj_release.conf
274
281
275
282
Remember to replace _build-target_ with the build target name of the Nordic
276
283
Semiconductor's kit you own.
@@ -281,9 +288,9 @@ Support for DFU using Matter OTA is disabled by default.
281
288
282
289
To build the example with configuration that supports DFU, run the following
283
290
command with _build-target_ replaced with the build target name of the Nordic
284
-
Semiconductor kit you are using (for example `nrf52840dk_nrf52840`):
291
+
Semiconductor kit you are using (for example `nrf52840dk/nrf52840`):
285
292
286
-
$ west build -b build-target -- -DCONF_FILE=prj_dfu.conf
293
+
$ west build -b build-target --sysbuild -- -DCONF_FILE=prj_dfu.conf
287
294
288
295
> **Note**:
289
296
>
@@ -299,7 +306,7 @@ Semiconductor kit you are using (for example `nrf52840dk_nrf52840`):
299
306
#### Changing bootloader configuration
300
307
301
308
To change the default MCUboot configuration, edit the `prj.conf` file located in
302
-
the `child_image/mcuboot` directory.
309
+
the `sysbuild/mcuboot` directory.
303
310
304
311
#### Changing flash memory settings
305
312
@@ -311,8 +318,7 @@ purposes. You can change these settings by defining
311
318
This example uses this option to define using an external flash.
312
319
313
320
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.
321
+
example `nrf52840dk/nrf52840`), edit the `pm_static_<build_target>.yml` file (for example `pm_static_nrf52840dk_nrf52840.yml`), located in the main application directory.
316
322
317
323
<hr>
318
324
@@ -324,7 +330,7 @@ using the menuconfig utility.
324
330
To open the menuconfig utility, run the following command from the example
325
331
directory:
326
332
327
-
$ west build -b build-target -t menuconfig
333
+
$ west build -b build-target --sysbuild -t menuconfig
328
334
329
335
Remember to replace _build-target_ with the build target name of the Nordic
Copy file name to clipboardexpand all lines: examples/all-clusters-minimal-app/nrfconnect/README.md
+19-13
Original file line number
Diff line number
Diff line change
@@ -1,5 +1,12 @@
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 production ready
5
+
> and it may contain minor bugs or use not optimal configuration. It is not recommended to use this
6
+
> example as a basis for creating a market ready product.
7
+
>
8
+
> For the production ready and optimized Matter samples, see [nRF Connect SDK samples](https://docs.nordicsemi.com/bundle/ncs-latest/page/nrf/samples/matter.html). The Matter samples in nRF Connect SDK use various additional software components and provide multiple optional features that improve the developer and user experience. To read more about it, see [Matter support in nRF Connect SDK](https://docs.nordicsemi.com/bundle/ncs-latest/page/nrf/protocols/matter/index.html#ug-matter) page. Using Matter samples from nRF Connect SDK allows you to get a full Nordic technical support via [DevZone](https://devzone.nordicsemi.com/) portal.
9
+
3
10
The nRF All Clusters Example Application implements various ZCL clusters
4
11
populated on three endpoints. You can use this example as a reference for
5
12
creating your own application.
@@ -77,9 +84,9 @@ The example supports building and running on the following devices:
2. Run the following command to build the example, with _build-target_ replaced
242
249
with the build target name of the Nordic Semiconductor's kit you own, for
243
-
example `nrf52840dk_nrf52840`:
250
+
example `nrf52840dk/nrf52840`:
244
251
245
-
$ west build -b build-target
252
+
$ west build -b build-target --sysbuild
246
253
247
254
You only need to specify the build target on the first build. See
248
255
[Requirements](#requirements) for the build target names of compatible kits.
249
256
250
-
The output `zephyr.hex` file will be available in the `build/zephyr/` directory.
257
+
The output `zephyr.hex` file will be available in the `build/nrfconnect/zephyr/` directory.
251
258
252
259
### Removing build artifacts
253
260
@@ -262,7 +269,7 @@ following command:
262
269
To build the example with release configuration that disables the diagnostic
263
270
features like logs and command-line interface, run the following command:
264
271
265
-
$ west build -b build-target -- -DCONF_FILE=prj_release.conf
272
+
$ west build -b build-target --sysbuild -- -DCONF_FILE=prj_release.conf
266
273
267
274
Remember to replace _build-target_ with the build target name of the Nordic
268
275
Semiconductor's kit you own.
@@ -273,9 +280,9 @@ Support for DFU using Matter OTA is disabled by default.
273
280
274
281
To build the example with configuration that supports DFU, run the following
275
282
command with _build-target_ replaced with the build target name of the Nordic
276
-
Semiconductor kit you are using (for example `nrf52840dk_nrf52840`):
283
+
Semiconductor kit you are using (for example `nrf52840dk/nrf52840`):
277
284
278
-
$ west build -b build-target -- -DCONF_FILE=prj_dfu.conf
285
+
$ west build -b build-target --sysbuild -- -DCONF_FILE=prj_dfu.conf
279
286
280
287
> **Note**:
281
288
>
@@ -291,7 +298,7 @@ Semiconductor kit you are using (for example `nrf52840dk_nrf52840`):
291
298
#### Changing bootloader configuration
292
299
293
300
To change the default MCUboot configuration, edit the `prj.conf` file located in
294
-
the `child_image/mcuboot` directory.
301
+
the `sysbuild/mcuboot` directory.
295
302
296
303
#### Changing flash memory settings
297
304
@@ -303,8 +310,7 @@ purposes. You can change these settings by defining
303
310
This example uses this option to define using an external flash.
304
311
305
312
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.
313
+
example `nrf52840dk/nrf52840`), edit the `pm_static_<build_target>.yml` file (for example `pm_static_nrf52840dk_nrf52840.yml`), located in the main application directory.
308
314
309
315
<hr>
310
316
@@ -316,7 +322,7 @@ using the menuconfig utility.
316
322
To open the menuconfig utility, run the following command from the example
317
323
directory:
318
324
319
-
$ west build -b build-target -t menuconfig
325
+
$ west build -b build-target --sysbuild -t menuconfig
320
326
321
327
Remember to replace _build-target_ with the build target name of the Nordic
Copy file name to clipboardexpand all lines: examples/chef/nrfconnect/README.md
+7
Original file line number
Diff line number
Diff line change
@@ -1,5 +1,12 @@
1
1
# CHIP nRF Connect SDK Shell 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 production ready
5
+
> and it may contain minor bugs or use not optimal configuration. It is not recommended to use this
6
+
> example as a basis for creating a market ready product.
7
+
>
8
+
> For the production ready and optimized Matter samples, see [nRF Connect SDK samples](https://docs.nordicsemi.com/bundle/ncs-latest/page/nrf/samples/matter.html). The Matter samples in nRF Connect SDK use various additional software components and provide multiple optional features that improve the developer and user experience. To read more about it, see [Matter support in nRF Connect SDK](https://docs.nordicsemi.com/bundle/ncs-latest/page/nrf/protocols/matter/index.html#ug-matter) page. Using Matter samples from nRF Connect SDK allows you to get a full Nordic technical support via [DevZone](https://devzone.nordicsemi.com/) portal.
9
+
3
10
A [chip-shell](../README.md) project for the Nordic nRF52840 and nRF5340
4
11
development kits, built using the nRF Connect SDK.
0 commit comments