Skip to content

Commit c23e116

Browse files
committedJul 8, 2024
[NXP] Fix spelling issues on all-clusters-app Readme
1 parent 4deacb0 commit c23e116

File tree

1 file changed

+18
-16
lines changed
  • examples/all-clusters-app/nxp/zephyr

1 file changed

+18
-16
lines changed
 

‎examples/all-clusters-app/nxp/zephyr/README.md

+18-16
Original file line numberDiff line numberDiff line change
@@ -10,18 +10,18 @@ commissioning and different cluster control.
1010

1111
<hr>
1212

13-
- [Introduction](#intro)
13+
- [Introduction](#introduction)
1414
- [Building](#building)
15-
- [Flashing and debugging](#flashdebug)
16-
- [Factory data](#factorydata)
17-
- [Manufacturing data](#manufacturing)
15+
- [Flashing and debugging](#flashing-and-debugging)
16+
- [Factory data](#factory-data)
17+
- [Manufacturing data](#generate-factory-data)
1818
- [OTA Software Update](#ota-software-update)
1919
- [Testing the example](#testing-the-example)
20-
- [Using Matter CLI in NXP Zephyr examples](#matter-cli)
20+
- [Using Matter CLI in NXP Zephyr examples](#using-matter-cli-in-nxp-zephyr-examples)
2121

2222
<hr>
2323

24-
<a name="intro"></a>
24+
<a name="introduction"></a>
2525

2626
## Introduction
2727

@@ -57,12 +57,12 @@ Prerequisites:
5757
$ west init zephyrproject -m https://github.com/nxp-zephyr-ear/zephyr.git --mr zephyr_rw61x_v3.6_RFP
5858
```
5959

60-
> **Note**: Currently, supported NXP platforms in Zephyr targetting Matter are
60+
> **Note**: Currently, supported NXP platforms in Zephyr targeting Matter are
6161
> not available in the official Zephyr repo, you'll have to use the NXP fork
6262
> `https://github.com/nxp-zephyr-ear/zephyr` github repo. Reach to your NXP
6363
> contact for more details.
6464
65-
Steps to build the example, targetting `rd_rw612_bga` board:
65+
Steps to build the example, targeting `rd_rw612_bga` board:
6666

6767
1. Activate your Matter env:
6868

@@ -89,7 +89,7 @@ command from. The binaries will be created in `build/zephyr` with the name
8989
You can get more details on `west build` with
9090
[Zephyr's building guide](https://docs.zephyrproject.org/latest/develop/west/build-flash-debug.html#building-west-build)
9191

92-
<a name="flashdebug"></a>
92+
<a name="flashing-and-debugging"></a>
9393

9494
## Flashing and debugging
9595

@@ -118,7 +118,7 @@ To debug a Matter with Zephyr application, you could use several methods:
118118
> **Note**: As the build provides an elf file, any compatible debugging tool can
119119
> be used.
120120
121-
<a name="factorydata"></a>
121+
<a name="factory-data"></a>
122122

123123
## Factory data
124124

@@ -128,8 +128,8 @@ the the section below to build with factory data.
128128
You may refer to `src/platform/nxp/zephyr/boards/<board>/<board>.overlay` file
129129
to obtain the memory region used by this partition.
130130

131-
For example, the factory data partition on rd_rw612_bga is reserved in the last
132-
sector of the flexspi flash of RD BGA board, at `0x1BFFF000`.
131+
For example, the factory data partition on `rd_rw612_bga` is reserved in the
132+
last sector of the `flexspi` flash of `RD BGA` board, at `0x1BFFF000`.
133133

134134
```
135135
&flexspi {
@@ -164,13 +164,15 @@ west build -b rd_rw612_bga -p <path to example folder> -- -DFILE_SUFFIX=fdata
164164
`prj_fdata.conf` configuration file will enable `CONFIG_CHIP_FACTORY_DATA`
165165
Kconfig so the application will load the factory data at boot.
166166

167+
<a name="generate-factory-data"></a>
168+
167169
### Generate factory data
168170

169171
#### Automatically (recommended)
170172

171173
The factory data can be generated automatically during the build of the
172-
application. To do so, you can uncomment the `CONFIG_CHIP_FACTORY_DATA_BUILD=y`
173-
in `prj_fdata.conf`.
174+
application. To do so, you can use the configuration
175+
`CONFIG_CHIP_FACTORY_DATA_BUILD=y` in `prj_fdata.conf`.
174176

175177
You will have to specify the source of the certificates to be used for the
176178
factory data. Please refer to `CHIP_FACTORY_DATA_CERT_SOURCE` Kconfig for more
@@ -208,7 +210,7 @@ See
208210
To know how to commission a device over BLE, follow the instructions from
209211
[chip-tool's README.md 'Commission a device over BLE'](../../../chip-tool/README.md#commission-a-device-over-ble).
210212

211-
<a name="matter-cli"></a>
213+
<a name="using-matter-cli-in-nxp-zephyr-examples"></a>
212214

213215
## Using Matter CLI in NXP Zephyr examples
214216

@@ -228,7 +230,7 @@ As an example, the Matter CLI on `rd_rw612_bga` is configured to be output on
228230
`flexcomm3` with a baudrate of `115200`. The logs are configured to be output on
229231
`flexcomm0` with a baudrate of `115200`.
230232

231-
> **Note**: `flexcomm3` is wired to the USB FTDI port of the RD BGA board by
233+
> **Note**: `flexcomm3` is wired to the USB `FTDI` port of the `RD BGA` board by
232234
> default. `flexcomm0` is wired to `GPIO2` (RX) and `GPIO3` (TX). Those pins are
233235
> accessible on `HD2` pin header.
234236

0 commit comments

Comments
 (0)