Skip to content

Commit 4563896

Browse files
wy-hhpull[bot]
authored andcommitted
[Bouffalolab] Remove platform limit for tool installation and update readme (#24051)
* update readme * remove platform limit on bflb-iot-tool * update readme * Fix restyle
1 parent ddb8fbe commit 4563896

File tree

2 files changed

+27
-33
lines changed

2 files changed

+27
-33
lines changed

examples/lighting-app/bouffalolab/README.md

+26-32
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,7 @@ Mac OS.
6262
sudo bash scripts/setup.sh
6363
```
6464
65-
Please execute following command export `BOUFFALOLAB_SDK_ROOT` before
65+
Please execute following command to export `BOUFFALOLAB_SDK_ROOT` before
6666
building.
6767
6868
```
@@ -74,36 +74,27 @@ Mac OS.
7474
The following steps take examples for BL602 develop board `BL602-IoT-Matter-V1`
7575
and BL706 develop board `XT-ZB6-DevKit`.
7676
77-
- Build lighting app
77+
- Build lighting app with UART baudrate 2000000
7878
7979
```
8080
./scripts/build/build_examples.py --target bouffalolab-bl602-iot-matter-v1-light build
8181
./scripts/build/build_examples.py --target bouffalolab-xt-zb6-devkit-light build
8282
```
8383
84-
- UART baudrate is 2000000 by default; for baudrate 115200, please build
85-
target name with `-115200` appended
84+
- Build lighting app with UART baudrate 115200
8685
87-
```shell
86+
```
8887
./scripts/build/build_examples.py --target bouffalolab-bl602-iot-matter-v1-light-115200 build
8988
./scripts/build/build_examples.py --target bouffalolab-xt-zb6-devkit-light-115200 build
9089
```
9190
92-
- Build target name with `-rpc` appended for rpc enabled as following
93-
commands.
91+
- Build lighting app with RPC enabled and UART baudrate 115200.
9492
95-
```shell
93+
```
9694
./scripts/build/build_examples.py --target bouffalolab-bl602-iot-matter-v1-light-rpc build
9795
./scripts/build/build_examples.py --target bouffalolab-xt-zb6-devkit-light-rpc build
9896
```
9997
100-
- For multiple build options ,such as UART baudrate 115200 + rpc, please try
101-
102-
```shell
103-
./scripts/build/build_examples.py --target bouffalolab-bl602-iot-matter-v1-light-rpc-115200 build
104-
./scripts/build/build_examples.py --target bouffalolab-xt-zb6-devkit-light-rpc-115200 build
105-
```
106-
10798
## Download image
10899
109100
- Using script `*.flash.py`.
@@ -113,9 +104,11 @@ and BL706 develop board `XT-ZB6-DevKit`.
113104
`chip-bl702-lighting-example.flash.py` will generate under build output
114105
folder for BL602 or BL702 building.
115106
116-
> Note, different build options will generate different output folder.
117-
118-
> Note, make sure terminal is under Matter build environment.
107+
> Note 1, `*.flash.py` should be ran under Matter build environment; if
108+
> python module `bflb_iot_tool` is not found, please try to do
109+
> `source scripts/bootstrap.sh` or install as
110+
> `pip3 install bflb-iot-tool`.<br> Note 2, different build options will
111+
> generate different output folder.
119112
120113
Download operation steps as below, please check `help` option of script for
121114
more detail.
@@ -154,7 +147,8 @@ and BL706 develop board `XT-ZB6-DevKit`.
154147
> Note, better to append --erase option to download image for BL602
155148
> develop board at first time.
156149
157-
- Using `Bouffalo Lab` GUI flash tool`BLDevCube`
150+
- Using `Bouffalo Lab` GUI flash tool `BLDevCube`, please download on
151+
[this page](https://dev.bouffalolab.com/download).
158152
- Hold BOOT pin and reset chip, put the board in download mode.
159153
- Select `DTS` file;
160154
- Select Partition Table under
@@ -168,7 +162,7 @@ and BL706 develop board `XT-ZB6-DevKit`.
168162
## Run the example
169163
170164
- You can open the serial console. For example, if the device is at
171-
`/dev/ttyACM0`:
165+
`/dev/ttyACM0` with UART baudrate 2000000 built:
172166
173167
```shell
174168
picocom -b 2000000 /dev/ttyACM0
@@ -182,11 +176,10 @@ and BL706 develop board `XT-ZB6-DevKit`.
182176
- To do factory reset, press BOOT button over 4 seconds, release BOOT button
183177
after led blink stopped.
184178
185-
## Test with chip-tool
179+
## Test Commission and Control with chip-tool
186180
187181
Please follow [chip_tool_guide](../../../docs/guides/chip_tool_guide.md) and
188-
[guide](../../chip-tool/README.md) to build and use Matter official test
189-
chip-tool.
182+
[guide](../../chip-tool/README.md) to build and use chip-tool for test.
190183
191184
### Prerequisite for Thread Protocol
192185
@@ -202,7 +195,7 @@ router to get Thread network credential.
202195
sudo ot-ctl dataset active -x
203196
```
204197

205-
#### Commissioning over BLE
198+
### Commissioning over BLE
206199

207200
- Reset the board or factory reset the board
208201

@@ -222,10 +215,10 @@ sudo ot-ctl dataset active -x
222215
```
223216

224217
> `<node_id>`, which is node ID assigned to device within chip-tool
225-
> fabric<br> > `<wifi_ssid>`, Wi-Fi network SSID<br> > `<wifi_passwd>`,
226-
> Wi-FI network password<br> > `<thread_operational_dataset>`, Thread
227-
> network credential which running `sudo ot-ctl dataset active -x` command
228-
> on border router to get.<br>
218+
> fabric<br> `<wifi_ssid>`, Wi-Fi network SSID<br> `<wifi_passwd>`, Wi-FI
219+
> network password<br> `<thread_operational_dataset>`, Thread network
220+
> credential which running `sudo ot-ctl dataset active -x` command on border
221+
> router to get.
229222

230223
### Cluster control
231224

@@ -263,7 +256,7 @@ After successful commissioning, cluster commands available to control the board.
263256
./chip-tool identify identify 10 <node_id> 1
264257
```
265258

266-
## OTA software upgrade with ota-provider-app
259+
## Test OTA software upgrade with ota-provider-app
267260

268261
Please take [guide](../../ota-provider-app/linux/README.md) for more detail on
269262
ota-provider-app build and usage.
@@ -309,13 +302,14 @@ ota-provider-app build and usage.
309302

310303
### Start ota software upgrade
311304

312-
- BLE commission BL702 lighting if not commissioned.
305+
- BLE commission BL602/BL702 lighting if not commissioned.
313306
- Start OTA software upgrade process
314307
```shell
315308
./chip-tool otasoftwareupdaterequestor announce-ota-provider 1 0 0 0 <node_id_to_lighting_app> 0
316309
```
317-
where `<node_id_to_lighting_app>` is node id of BL702 lighting app.
318-
- After OTA software upgrade gets done, BL702 will get reboot automatically.
310+
where `<node_id_to_lighting_app>` is node id of BL602/BL702 lighting app.
311+
- After OTA software upgrade gets done, BL602/BL702 will get reboot
312+
automatically.
319313

320314
## Run RPC Console
321315

scripts/requirements.bouffalolab.txt

+1-1
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
bflb-iot-tool>=1.8.0 ; platform_machine != 'aarch64' and sys_platform == 'linux'
1+
bflb-iot-tool>=1.8.0

0 commit comments

Comments
 (0)