Skip to content

Commit 1483323

Browse files
restyled-commitsmarius-alex-tache
authored andcommitted
Restyled by prettier-markdown
1 parent d5d774c commit 1483323

File tree

2 files changed

+71
-58
lines changed

2 files changed

+71
-58
lines changed

examples/contact-sensor-app/nxp/k32w1/README.md

+31-24
Original file line numberDiff line numberDiff line change
@@ -13,26 +13,26 @@ into an existing Matter network and can be controlled by this network.
1313

1414
<hr>
1515

16-
- [Matter K32W1 Contact Sensor Example Application](#matter-k32w1-contact-sensor-example-application)
17-
- [Introduction](#introduction)
18-
- [Bluetooth LE Advertising](#bluetooth-le-advertising)
19-
- [Bluetooth LE Rendezvous](#bluetooth-le-rendezvous)
20-
- [Thread Provisioning](#thread-provisioning)
21-
- [Device UI](#device-ui)
22-
- [Building](#building)
23-
- [Long Idle Time ICD Support](#long-idle-time-icd-support)
24-
- [Manufacturing data](#manufacturing-data)
25-
- [Flashing](#flashing)
26-
- [Flashing the `NBU` image](#flashing-the-nbu-image)
27-
- [Flashing the host image](#flashing-the-host-image)
28-
- [Debugging](#debugging)
29-
- [OTA](#ota)
30-
- [Convert `srec` into `sb3` file](#convert-srec-into-sb3-file)
31-
- [Convert `sb3` into `ota` file](#convert-sb3-into-ota-file)
32-
- [OTA factory data](#ota-factory-data)
33-
- [Running OTA](#running-ota)
34-
- [Low power](#low-power)
35-
- [Known issues](#known-issues)
16+
- [Matter K32W1 Contact Sensor Example Application](#matter-k32w1-contact-sensor-example-application)
17+
- [Introduction](#introduction)
18+
- [Bluetooth LE Advertising](#bluetooth-le-advertising)
19+
- [Bluetooth LE Rendezvous](#bluetooth-le-rendezvous)
20+
- [Thread Provisioning](#thread-provisioning)
21+
- [Device UI](#device-ui)
22+
- [Building](#building)
23+
- [Long Idle Time ICD Support](#long-idle-time-icd-support)
24+
- [Manufacturing data](#manufacturing-data)
25+
- [Flashing](#flashing)
26+
- [Flashing the `NBU` image](#flashing-the-nbu-image)
27+
- [Flashing the host image](#flashing-the-host-image)
28+
- [Debugging](#debugging)
29+
- [OTA](#ota)
30+
- [Convert `srec` into `sb3` file](#convert-srec-into-sb3-file)
31+
- [Convert `sb3` into `ota` file](#convert-sb3-into-ota-file)
32+
- [OTA factory data](#ota-factory-data)
33+
- [Running OTA](#running-ota)
34+
- [Low power](#low-power)
35+
- [Known issues](#known-issues)
3636

3737
## Introduction
3838

@@ -119,21 +119,26 @@ Matter shutdown procedure.
119119
## Building
120120

121121
In order to build the Project CHIP example, we recommend using a Linux
122-
distribution (supported Operating Systems are listed in [BUILDING.md](../../../../../docs/guides/BUILDING.md)).
122+
distribution (supported Operating Systems are listed in
123+
[BUILDING.md](../../../../../docs/guides/BUILDING.md)).
124+
125+
- Make sure that below prerequisites are correctly installed (as described in
126+
[BUILDING.md](../../../../../docs/guides/BUILDING.md)))
123127

124-
- Make sure that below prerequisites are correctly installed (as described in [BUILDING.md](../../../../../docs/guides/BUILDING.md)))
125128
```
126129
sudo apt-get install git gcc g++ pkg-config libssl-dev libdbus-1-dev \
127130
libglib2.0-dev libavahi-client-dev ninja-build python3-venv python3-dev \
128131
python3-pip unzip libgirepository1.0-dev libcairo2-dev libreadline-dev
129132
```
130133

131134
- Step 1: checkout NXP specific submodules only
135+
132136
```
133137
user@ubuntu:~/Desktop/git/connectedhomeip$ scripts/checkout_submodules.py --shallow --platform nxp --recursive
134138
```
135139

136-
- Step 2: activate local environment
140+
- Step 2: activate local environment
141+
137142
```
138143
user@ubuntu:~/Desktop/git/connectedhomeip$ source scripts/activate.sh
139144
```
@@ -150,7 +155,9 @@ user@ubuntu:~/Desktop/git/connectedhomeip$ source scripts/bootstrap.sh
150155
```
151156
user@ubuntu:~/Desktop/git/connectedhomeip$ scripts/setup/nxp/update_nxp_sdk.py --platform common_sdk
152157
```
153-
Note: By default setup/nxp/update_nxp_sdk.py will try to initialize all NXP SDKs. Arg "-- help" could be used to view all available options.
158+
159+
Note: By default setup/nxp/update_nxp_sdk.py will try to initialize all NXP
160+
SDKs. Arg "-- help" could be used to view all available options.
154161

155162
```
156163
user@ubuntu:~/Desktop/git/connectedhomeip$ cd examples/contact-sensor-app/nxp/k32w1

examples/lighting-app/nxp/k32w1/README.md

+40-34
Original file line numberDiff line numberDiff line change
@@ -15,27 +15,27 @@ into an existing Matter network and can be controlled by this network.
1515

1616
<hr>
1717

18-
- [Matter K32W1 Lighting Example Application](#matter-k32w1-lighting-example-application)
19-
- [Introduction](#introduction)
20-
- [Bluetooth LE Advertising](#bluetooth-le-advertising)
21-
- [Bluetooth LE Rendezvous](#bluetooth-le-rendezvous)
22-
- [Thread Provisioning](#thread-provisioning)
23-
- [Device UI](#device-ui)
24-
- [Building](#building)
25-
- [`SMU2` Memory](#smu2-memory)
26-
- [LED PWM](#led-pwm)
27-
- [Manufacturing data](#manufacturing-data)
28-
- [Flashing](#flashing)
29-
- [Flashing the `NBU` image](#flashing-the-nbu-image)
30-
- [Flashing the host image](#flashing-the-host-image)
31-
- [Debugging](#debugging)
32-
- [OTA](#ota)
33-
- [Convert `srec` into `sb3` file](#convert-srec-into-sb3-file)
34-
- [Convert `sb3` into `ota` file](#convert-sb3-into-ota-file)
35-
- [OTA factory data](#ota-factory-data)
36-
- [Running OTA](#running-ota)
37-
- [Known issues](#known-issues)
38-
- [Running RPC console](#running-rpc-console)
18+
- [Matter K32W1 Lighting Example Application](#matter-k32w1-lighting-example-application)
19+
- [Introduction](#introduction)
20+
- [Bluetooth LE Advertising](#bluetooth-le-advertising)
21+
- [Bluetooth LE Rendezvous](#bluetooth-le-rendezvous)
22+
- [Thread Provisioning](#thread-provisioning)
23+
- [Device UI](#device-ui)
24+
- [Building](#building)
25+
- [`SMU2` Memory](#smu2-memory)
26+
- [LED PWM](#led-pwm)
27+
- [Manufacturing data](#manufacturing-data)
28+
- [Flashing](#flashing)
29+
- [Flashing the `NBU` image](#flashing-the-nbu-image)
30+
- [Flashing the host image](#flashing-the-host-image)
31+
- [Debugging](#debugging)
32+
- [OTA](#ota)
33+
- [Convert `srec` into `sb3` file](#convert-srec-into-sb3-file)
34+
- [Convert `sb3` into `ota` file](#convert-sb3-into-ota-file)
35+
- [OTA factory data](#ota-factory-data)
36+
- [Running OTA](#running-ota)
37+
- [Known issues](#known-issues)
38+
- [Running RPC console](#running-rpc-console)
3939

4040
</hr>
4141

@@ -122,21 +122,26 @@ does a clean soft reset that takes into account Matter shutdown procedure.
122122
## Building
123123

124124
In order to build the Project CHIP example, we recommend using a Linux
125-
distribution (supported Operating Systems are listed in [BUILDING.md](../../../../../docs/guides/BUILDING.md)).
125+
distribution (supported Operating Systems are listed in
126+
[BUILDING.md](../../../../../docs/guides/BUILDING.md)).
127+
128+
- Make sure that below prerequisites are correctly installed (as described in
129+
[BUILDING.md](../../../../../docs/guides/BUILDING.md)))
126130

127-
- Make sure that below prerequisites are correctly installed (as described in [BUILDING.md](../../../../../docs/guides/BUILDING.md)))
128131
```
129132
sudo apt-get install git gcc g++ pkg-config libssl-dev libdbus-1-dev \
130133
libglib2.0-dev libavahi-client-dev ninja-build python3-venv python3-dev \
131134
python3-pip unzip libgirepository1.0-dev libcairo2-dev libreadline-dev
132135
```
133136

134137
- Step 1: checkout NXP specific submodules only
138+
135139
```
136140
user@ubuntu:~/Desktop/git/connectedhomeip$ scripts/checkout_submodules.py --shallow --platform nxp --recursive
137141
```
138142

139-
- Step 2: activate local environment
143+
- Step 2: activate local environment
144+
140145
```
141146
user@ubuntu:~/Desktop/git/connectedhomeip$ source scripts/activate.sh
142147
```
@@ -153,7 +158,9 @@ user@ubuntu:~/Desktop/git/connectedhomeip$ source scripts/bootstrap.sh
153158
```
154159
user@ubuntu:~/Desktop/git/connectedhomeip$ scripts/setup/nxp/update_nxp_sdk.py --platform common_sdk
155160
```
156-
Note: By default setup/nxp/update_nxp_sdk.py will try to initialize all NXP SDKs. Arg "-- help" could be used to view all available options.
161+
162+
Note: By default setup/nxp/update_nxp_sdk.py will try to initialize all NXP
163+
SDKs. Arg "-- help" could be used to view all available options.
157164

158165
- Start building the application.
159166

@@ -184,8 +191,8 @@ memory:
184191
These instances and global variables are placed in `SMU2` memory through name
185192
matching in the application linker script. They should not be changed or, if
186193
changed, the names must be updated in `k32w1_app.ld`. See
187-
[k32w1_app.ld](../../../platform/nxp/k32w1/app/ldscripts/k32w1_app.ld)
188-
for names and `SMU2` memory range size.
194+
[k32w1_app.ld](../../../platform/nxp/k32w1/app/ldscripts/k32w1_app.ld) for names
195+
and `SMU2` memory range size.
189196

190197
The OpenThread buffers can be allocated from a 13KB `SMU2` range after a
191198
successful commissioning process until a factory reset is initiated. This way,
@@ -381,7 +388,6 @@ The OTA image used must be updated to include the new factory data.
381388

382389
[OTA image tool guide](../../../../scripts/tools/nxp/ota/README.md).
383390

384-
385391
### Running OTA
386392

387393
The OTA topology used for OTA testing is illustrated in the figure below.
@@ -507,11 +513,11 @@ the `chip-console`, a user can send specific commands to the device.
507513
For button commands, please run `rpcs.chip.rpc.Button.Event(index)` based on the
508514
table below:
509515

510-
| index | action |
511-
| ----- | ------ |
512-
| 0 | Start/stop BLE advertising |
513-
| 1 | Factory reset the device |
514-
| 2 | Application specific action (e.g. toggle LED) |
515-
| 3 | Soft reset the device |
516+
| index | action |
517+
| ----- | --------------------------------------------- |
518+
| 0 | Start/stop BLE advertising |
519+
| 1 | Factory reset the device |
520+
| 2 | Application specific action (e.g. toggle LED) |
521+
| 3 | Soft reset the device |
516522

517523
To reboot the device, please run `rpcs.chip.rpc.Device.Reboot()`.

0 commit comments

Comments
 (0)