From 7f7217243f2dcc931a022525f0bdb11c04cbb01e Mon Sep 17 00:00:00 2001 From: shchen-Lab Date: Thu, 20 Jul 2023 20:56:44 +0800 Subject: [PATCH 1/4] add factory qr code scripts --- scripts/setup/requirements.bouffalolab.txt | 6 ++ scripts/tools/bouffalolab/factory_qrcode.py | 97 +++++++++++++++++++++ 2 files changed, 103 insertions(+) create mode 100644 scripts/tools/bouffalolab/factory_qrcode.py diff --git a/scripts/setup/requirements.bouffalolab.txt b/scripts/setup/requirements.bouffalolab.txt index 87fa5c49ab96e5..acd5fa726bb22b 100644 --- a/scripts/setup/requirements.bouffalolab.txt +++ b/scripts/setup/requirements.bouffalolab.txt @@ -1 +1,7 @@ bflb-iot-tool>=1.8.0 +jsonschema>=4.4.0 +cbor2>=5.4.3 +ecdsa>=0.18.0 +qrcode==7.4.2 +bitarray==2.6.0 +python_stdnum==1.18 diff --git a/scripts/tools/bouffalolab/factory_qrcode.py b/scripts/tools/bouffalolab/factory_qrcode.py new file mode 100644 index 00000000000000..3a7b275806ba5a --- /dev/null +++ b/scripts/tools/bouffalolab/factory_qrcode.py @@ -0,0 +1,97 @@ +#!/usr/bin/env python3 +# +# Copyright (c) 2022 Project CHIP Authors +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +import argparse +import base64 +import json +import logging as log +import os +import secrets +import subprocess +import sys +from collections import namedtuple +from os.path import exists + +try: + import qrcode + from generate_setup_payload import CommissioningFlow, SetupPayload +except ImportError: + SDK_ROOT = os.path.dirname(os.path.dirname(os.path.dirname(os.path.dirname(os.path.realpath(__file__))))) + sys.path.append(os.path.join(SDK_ROOT, "src/setup_payload/python")) + try: + import qrcode + from generate_setup_payload import CommissioningFlow, SetupPayload + except ModuleNotFoundError or ImportError: + no_onboarding_modules = True + else: + no_onboarding_modules = False +else: + no_onboarding_modules = False + +try: + import jsonschema +except ImportError: + no_jsonschema_module = True +else: + no_jsonschema_module = False + +def allow_any_int(i): return int(i, 0) + +def get_args(): + parser = argparse.ArgumentParser(description="BouffaloLab QR Code generator tool") + mandatory_arguments = parser.add_argument_group("Mandatory keys", "These arguments must be provided to generate QR Code JSON file") + + + mandatory_arguments.add_argument("--vendor_id", type=allow_any_int, required=True, + help="[int | hex int] Provide Vendor Identification Number") + mandatory_arguments.add_argument("--product_id", type=allow_any_int, required=True, + help="[int | hex int] Provide Product Identification Number") + mandatory_arguments.add_argument("--discriminator", type=allow_any_int, required=True, + help="[int] Provide BLE pairing discriminator. \ + A 12-bit value matching the field of the same name in \ + the setup code. Discriminator is used during a discovery process.") + mandatory_arguments.add_argument("--pincode", type=allow_any_int,required=True, + help=("[int | hex] Default PASE session passcode. " + "(This is mandatory to generate QR Code).")) + mandatory_arguments.add_argument("-o", "--output", type=str, required=True, + help="Output path to store .json file, e.g. my_dir/output.json") + return parser.parse_args() + +def generate_qrcode_data(args): + + if no_jsonschema_module== False and no_onboarding_modules == False: + + setup_payload = SetupPayload(discriminator=args.discriminator, + pincode=args.pincode, + rendezvous=2, # fixed pairing BLE + flow=CommissioningFlow.Standard, + vid=args.vendor_id, + pid=args.product_id) + with open(args.output[:-len(".json")] + ".txt", "w") as manual_code_file: + manual_code_file.write("Manualcode : " + setup_payload.generate_manualcode() + "\n") + manual_code_file.write("QRCode : " + setup_payload.generate_qrcode()) + qr = qrcode.make(setup_payload.generate_qrcode()) + qr.save(args.output[:-len(".json")] + ".png") + else: + print("Please install it with all dependencies: pip3 install -r ./scripts/setup/requirements.bouffalolab.txt from the Matter root directory") + +def main(): + args=get_args() + generate_qrcode_data(args) + + +if __name__ == "__main__": + main() From db5c625e2192b4150de496bea1157948844c64c9 Mon Sep 17 00:00:00 2001 From: shchen-Lab Date: Fri, 21 Jul 2023 10:46:37 +0800 Subject: [PATCH 2/4] remove unused modules --- scripts/tools/bouffalolab/factory_qrcode.py | 19 +------------------ 1 file changed, 1 insertion(+), 18 deletions(-) diff --git a/scripts/tools/bouffalolab/factory_qrcode.py b/scripts/tools/bouffalolab/factory_qrcode.py index 3a7b275806ba5a..6adee0bdc3db62 100644 --- a/scripts/tools/bouffalolab/factory_qrcode.py +++ b/scripts/tools/bouffalolab/factory_qrcode.py @@ -15,15 +15,10 @@ # limitations under the License. import argparse -import base64 import json -import logging as log import os -import secrets -import subprocess import sys from collections import namedtuple -from os.path import exists try: import qrcode @@ -41,20 +36,11 @@ else: no_onboarding_modules = False -try: - import jsonschema -except ImportError: - no_jsonschema_module = True -else: - no_jsonschema_module = False - def allow_any_int(i): return int(i, 0) def get_args(): parser = argparse.ArgumentParser(description="BouffaloLab QR Code generator tool") mandatory_arguments = parser.add_argument_group("Mandatory keys", "These arguments must be provided to generate QR Code JSON file") - - mandatory_arguments.add_argument("--vendor_id", type=allow_any_int, required=True, help="[int | hex int] Provide Vendor Identification Number") mandatory_arguments.add_argument("--product_id", type=allow_any_int, required=True, @@ -71,9 +57,7 @@ def get_args(): return parser.parse_args() def generate_qrcode_data(args): - - if no_jsonschema_module== False and no_onboarding_modules == False: - + if no_onboarding_modules == False: setup_payload = SetupPayload(discriminator=args.discriminator, pincode=args.pincode, rendezvous=2, # fixed pairing BLE @@ -92,6 +76,5 @@ def main(): args=get_args() generate_qrcode_data(args) - if __name__ == "__main__": main() From 41e0c925cc215a68558e0d88bc083af74e2a477c Mon Sep 17 00:00:00 2001 From: "Restyled.io" Date: Fri, 21 Jul 2023 02:47:08 +0000 Subject: [PATCH 3/4] Restyled by autopep8 --- scripts/tools/bouffalolab/factory_qrcode.py | 50 ++++++++++++--------- 1 file changed, 28 insertions(+), 22 deletions(-) diff --git a/scripts/tools/bouffalolab/factory_qrcode.py b/scripts/tools/bouffalolab/factory_qrcode.py index 6adee0bdc3db62..ef2bb71e89aac5 100644 --- a/scripts/tools/bouffalolab/factory_qrcode.py +++ b/scripts/tools/bouffalolab/factory_qrcode.py @@ -36,11 +36,14 @@ else: no_onboarding_modules = False + def allow_any_int(i): return int(i, 0) + def get_args(): parser = argparse.ArgumentParser(description="BouffaloLab QR Code generator tool") - mandatory_arguments = parser.add_argument_group("Mandatory keys", "These arguments must be provided to generate QR Code JSON file") + mandatory_arguments = parser.add_argument_group( + "Mandatory keys", "These arguments must be provided to generate QR Code JSON file") mandatory_arguments.add_argument("--vendor_id", type=allow_any_int, required=True, help="[int | hex int] Provide Vendor Identification Number") mandatory_arguments.add_argument("--product_id", type=allow_any_int, required=True, @@ -49,32 +52,35 @@ def get_args(): help="[int] Provide BLE pairing discriminator. \ A 12-bit value matching the field of the same name in \ the setup code. Discriminator is used during a discovery process.") - mandatory_arguments.add_argument("--pincode", type=allow_any_int,required=True, - help=("[int | hex] Default PASE session passcode. " - "(This is mandatory to generate QR Code).")) + mandatory_arguments.add_argument("--pincode", type=allow_any_int, required=True, + help=("[int | hex] Default PASE session passcode. " + "(This is mandatory to generate QR Code).")) mandatory_arguments.add_argument("-o", "--output", type=str, required=True, - help="Output path to store .json file, e.g. my_dir/output.json") + help="Output path to store .json file, e.g. my_dir/output.json") return parser.parse_args() - + + def generate_qrcode_data(args): - if no_onboarding_modules == False: - setup_payload = SetupPayload(discriminator=args.discriminator, - pincode=args.pincode, - rendezvous=2, # fixed pairing BLE - flow=CommissioningFlow.Standard, - vid=args.vendor_id, - pid=args.product_id) - with open(args.output[:-len(".json")] + ".txt", "w") as manual_code_file: - manual_code_file.write("Manualcode : " + setup_payload.generate_manualcode() + "\n") - manual_code_file.write("QRCode : " + setup_payload.generate_qrcode()) - qr = qrcode.make(setup_payload.generate_qrcode()) - qr.save(args.output[:-len(".json")] + ".png") - else: - print("Please install it with all dependencies: pip3 install -r ./scripts/setup/requirements.bouffalolab.txt from the Matter root directory") - + if no_onboarding_modules == False: + setup_payload = SetupPayload(discriminator=args.discriminator, + pincode=args.pincode, + rendezvous=2, # fixed pairing BLE + flow=CommissioningFlow.Standard, + vid=args.vendor_id, + pid=args.product_id) + with open(args.output[:-len(".json")] + ".txt", "w") as manual_code_file: + manual_code_file.write("Manualcode : " + setup_payload.generate_manualcode() + "\n") + manual_code_file.write("QRCode : " + setup_payload.generate_qrcode()) + qr = qrcode.make(setup_payload.generate_qrcode()) + qr.save(args.output[:-len(".json")] + ".png") + else: + print("Please install it with all dependencies: pip3 install -r ./scripts/setup/requirements.bouffalolab.txt from the Matter root directory") + + def main(): - args=get_args() + args = get_args() generate_qrcode_data(args) + if __name__ == "__main__": main() From 11483f664b880398d75ec19e761db68928ea3dfd Mon Sep 17 00:00:00 2001 From: shchen-Lab Date: Fri, 21 Jul 2023 11:06:58 +0800 Subject: [PATCH 4/4] remove unused modules --- scripts/tools/bouffalolab/factory_qrcode.py | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) diff --git a/scripts/tools/bouffalolab/factory_qrcode.py b/scripts/tools/bouffalolab/factory_qrcode.py index ef2bb71e89aac5..1a7f6303495775 100644 --- a/scripts/tools/bouffalolab/factory_qrcode.py +++ b/scripts/tools/bouffalolab/factory_qrcode.py @@ -15,10 +15,8 @@ # limitations under the License. import argparse -import json import os import sys -from collections import namedtuple try: import qrcode @@ -61,7 +59,7 @@ def get_args(): def generate_qrcode_data(args): - if no_onboarding_modules == False: + if no_onboarding_modules is False: setup_payload = SetupPayload(discriminator=args.discriminator, pincode=args.pincode, rendezvous=2, # fixed pairing BLE