Skip to content

Commit

Permalink
fix lint code and spell
Browse files Browse the repository at this point in the history
  • Loading branch information
wy-hh committed Aug 26, 2024
1 parent 4db58ed commit eaf134d
Show file tree
Hide file tree
Showing 5 changed files with 9 additions and 7 deletions.
1 change: 1 addition & 0 deletions docs/Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -18,4 +18,5 @@ help:
# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
%: Makefile
mkdir -p "$(SOURCEDIR)"
$(info "$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)")
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
11 changes: 6 additions & 5 deletions docs/guides/bouffalolab/matter_factory_data.md
Original file line number Diff line number Diff line change
Expand Up @@ -95,7 +95,7 @@ repo.

If not specified, script will use PAI certificate and key specified
by`--pai_cert` and `--pai-key` to generate DAC certificate and private key
for development and test prupose.
for development and test purpose.

- `--discriminator`, discriminator ID

Expand All @@ -116,6 +116,7 @@ Please reference to `--help` for more detail.
- Run following command to generate all plain text factory data

Please create output folder first. Here takes `out/test-cert` as example.

```shell
./scripts/tools/bouffalolab/generate_factory_data.py --output out/test-cert
```
Expand Down Expand Up @@ -181,7 +182,7 @@ user should know it has limit to work with real ecosystem.
./out/linux-x64-chip-cert/chip-cert gen-att-cert --type i --subject-cn "${TEST_CERT_CN} PAI 01" --subject-vid ${TEST_CERT_VENDOR_ID} --valid-from "2020-10-15 14:23:43" --lifetime 7305 --ca-key out/test-cert/Chip-PAA-Key-${TEST_CERT_VENDOR_ID}.pem --ca-cert out/test-cert/Chip-PAA-Cert-${TEST_CERT_VENDOR_ID}.pem --out-key out/test-cert/Chip-PAI-Key-${TEST_CERT_VENDOR_ID}.pem --out out/test-cert/Chip-PAI-Cert-${TEST_CERT_VENDOR_ID}.pem
```

- Generate MFD in plain text data
- Generate `MFD` in plain text data

```shell
./scripts/tools/bouffalolab/generate_factory_data.py --output out/test-cert --paa_cert out/test-cert/Chip-PAA-Cert-${TEST_CERT_VENDOR_ID}.pem --paa_key out/test-cert/Chip-PAA-Key-${TEST_CERT_VENDOR_ID}.pem --pai_cert out/test-cert/Chip-PAI-Cert-${TEST_CERT_VENDOR_ID}.pem --pai_key out/test-cert/Chip-PAI-Key-${TEST_CERT_VENDOR_ID}.pem
Expand Down Expand Up @@ -212,7 +213,7 @@ user should know it has limit to work with real ecosystem.
> **Note**, `--valid-from` and `--lifetime` should be in `--valid-from` and
> `--lifetime` of PAI certificate.

- Generate MFD in plain text data
- Generate `MFD` in plain text data

```shell
./scripts/tools/bouffalolab/generate_factory_data.py --output out/test-cert --pai_cert out/test-cert/Chip-PAI-Cert-${TEST_CERT_VENDOR_ID}.pem --dac_cert out/test-cert/Chip-DAC-Cert-${TEST_CERT_VENDOR_ID}-${TEST_CERT_PRODUCT_ID}.pem --dac_key out/test-cert/Chip-DAC-Key-${TEST_CERT_VENDOR_ID}-${TEST_CERT_PRODUCT_ID}.pem
Expand All @@ -234,12 +235,12 @@ key.
/out/bouffalolab-bl616dk-light-wifi-mfd/chip-bl616-lighting-example.flash.py --port <serial port> --mfd out/test-cert/<mfd bin file>
```

> If mfd file has cipher text data, please append
> If `MFD` file has cipher text data, please append
> `--key <hex string of 16 bytes>` option to program to this key to efuse.

- Limits on BL IOT SDK

If developer would like to program MFD with all plain text data, option
If developer would like to program `MFD` with all plain text data, option
`--key <hex string of 16 bytes>` needs pass to script, otherwise, flash tool
will raise an error. And SoC BL602, BL702 and BL702L use BL IOT SDK for
Matter Application.
Expand Down
1 change: 1 addition & 0 deletions docs/guides/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ and features.
:hidden:
*
bouffalolab/matter_factory_data
esp32/README
nxp/README
ti/ti_matter_overview
Expand Down
2 changes: 1 addition & 1 deletion examples/lighting-app/bouffalolab/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# `Bouffalo Lab`
# Matter `Bouffalo Lab` Lighting Example

This example functions as a light bulb device type, with on/off and level
capabilities and uses a test Vendor ID (VID) and a Product ID (PID)
Expand Down
1 change: 0 additions & 1 deletion scripts/tools/bouffalolab/generate_factory_data.py
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,6 @@
import os
import random
import secrets
import ssl
import subprocess
import sys
from datetime import datetime, timedelta
Expand Down

0 comments on commit eaf134d

Please sign in to comment.