From eaf134d609bf34bb73032efdcd94d9ba03743c1e Mon Sep 17 00:00:00 2001 From: wyhong Date: Mon, 26 Aug 2024 15:29:28 +0800 Subject: [PATCH] fix lint code and spell --- docs/Makefile | 1 + docs/guides/bouffalolab/matter_factory_data.md | 11 ++++++----- docs/guides/index.md | 1 + examples/lighting-app/bouffalolab/README.md | 2 +- scripts/tools/bouffalolab/generate_factory_data.py | 1 - 5 files changed, 9 insertions(+), 7 deletions(-) diff --git a/docs/Makefile b/docs/Makefile index aca7a0f6cbd7de..556e00f05de492 100644 --- a/docs/Makefile +++ b/docs/Makefile @@ -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) diff --git a/docs/guides/bouffalolab/matter_factory_data.md b/docs/guides/bouffalolab/matter_factory_data.md index d3c5504e89622f..9021cd80f61815 100644 --- a/docs/guides/bouffalolab/matter_factory_data.md +++ b/docs/guides/bouffalolab/matter_factory_data.md @@ -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 @@ -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 ``` @@ -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 @@ -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 @@ -234,12 +235,12 @@ key. /out/bouffalolab-bl616dk-light-wifi-mfd/chip-bl616-lighting-example.flash.py --port --mfd out/test-cert/ ``` -> If mfd file has cipher text data, please append +> If `MFD` file has cipher text data, please append > `--key ` 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 ` needs pass to script, otherwise, flash tool will raise an error. And SoC BL602, BL702 and BL702L use BL IOT SDK for Matter Application. diff --git a/docs/guides/index.md b/docs/guides/index.md index 61641d1de74565..c1a879277865ed 100644 --- a/docs/guides/index.md +++ b/docs/guides/index.md @@ -9,6 +9,7 @@ and features. :hidden: * +bouffalolab/matter_factory_data esp32/README nxp/README ti/ti_matter_overview diff --git a/examples/lighting-app/bouffalolab/README.md b/examples/lighting-app/bouffalolab/README.md index b9b3d1501ddc7c..b39f65b96d77c7 100644 --- a/examples/lighting-app/bouffalolab/README.md +++ b/examples/lighting-app/bouffalolab/README.md @@ -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) diff --git a/scripts/tools/bouffalolab/generate_factory_data.py b/scripts/tools/bouffalolab/generate_factory_data.py index e03058857bc08d..28f362ba2d3b21 100755 --- a/scripts/tools/bouffalolab/generate_factory_data.py +++ b/scripts/tools/bouffalolab/generate_factory_data.py @@ -22,7 +22,6 @@ import os import random import secrets -import ssl import subprocess import sys from datetime import datetime, timedelta