wiliot-certificate 1.3.0a1__tar.gz → 1.4.0a1__tar.gz

{wiliot_certificate-1.3.0a1 → wiliot_certificate-1.4.0a1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: wiliot_certificate
-Version: 1.3.0a1
+Version: 1.4.0a1
 Summary: A library for certifying Wiliot-compliant boards
 Author-email: Wiliot <support@wiliot.com>
 License: MIT License
@@ -30,7 +30,7 @@ Project-URL: Certified, https://www.wiliot.com/product/ambient-iot-network#partn
 Classifier: Programming Language :: Python :: 3
 Classifier: License :: OSI Approved :: MIT License
 Classifier: Operating System :: OS Independent
-Requires-Python: >=3.9
+Requires-Python: >=3.13
 Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: jinja2>=3.1.5
@@ -42,18 +42,22 @@ Requires-Dist: colorama>=0.4.6
 Requires-Dist: tabulate>=0.9.0
 Requires-Dist: wiliot-core>=5.9.1
 Requires-Dist: paho-mqtt>=2.1.0
-Requires-Dist: bitstruct>=8.19.0
+Requires-Dist: bitstruct>=8.20.0
 Requires-Dist: protobuf>=5.29.3
 Requires-Dist: wiliot-api>=4.10.8
 Requires-Dist: jsonschema>=4.23.0
 Requires-Dist: statsmodels>=0.14.4
+Requires-Dist: pyserial>=3.5
+Requires-Dist: reportlab>=4.3.1
+Requires-Dist: google-api-python-client>=2.162.0
 
-# wiliot-certificate #
+# wiliot-certificate
 
 <!-- Description -->
 wiliot-certificate is a python library with tools used to test & certify boards and their compatibility with Wiliot's echosystem.
 This python package includes the following CLI utilities:
  - Gateway Certificate (`wlt-gw-certificate`)
+ - Bridge Certificate (`wlt-cert-brg`)
 
 ## Installing wiliot-certificate
 ````commandline
@@ -87,11 +91,12 @@ Sends advertising actions (txPacket) via MQTT to the GW and validates their adve
 Increments time delays between packets to evaluate GW's capability in handling increasing packets per second rates.
 
 #### GW Certificate Release Notes:
-1.3.0:
+1.4.0:
  - Released in a standalone wiliot-certificate package
- - Python 3.13 support
+ - Python 3.12 support
  - Gw API version 205 support
  - Registration Test
+ - Aggregation flag supported by StressTest
 
 
 ```
@@ -101,13 +106,59 @@ Gateway Certificate - CLI Tool to test Wiliot GWs
 
 required arguments:
   -gw GW        Gateway ID
-  -owner OWNER  Owner ID (optional when running only the registration test)
 
 optional arguments:
-  -suffix       Allow for different suffixes after the GW ID in MQTT topics
+  -owner OWNER  Owner ID (Required for non-registration tests)
   -tests        Pick specific tests to run
+  -actions      Pick specific actions to test during the ActionsTest
   -update       Update the firmware of the test board
   -pps          Pick specific PPS rate for the stress test
   -agg          Time the uplink stages should wait before processing packets
+  -suffix       Allow for different suffixes after the GW ID in MQTT topics
+  -env          Wiliot envrionment for Registration and bridgeOTA tests
   -h, --help    show this help message and exit
   ```
+
+### Bridge Certificate
+Test Wiliot BRGs capabilities.
+The BRG Certificate includes different tests that run sequentially to test each capability reported by the BRG.
+The BRG Certificate tool uses a public MQTT Broker (Eclipse):
+
+Host:	mqtt.eclipseprojects.io
+TLS TCP Port:	8883
+TLS Websocket Port:	443
+TCP Port:	1883
+Websocket Port:	80
+
+More information can be found at https://mqtt.eclipseprojects.io/.
+
+#### XXX Test
+TEST EXPLANATION
+
+#### BRG Certificate Release Notes:
+1.3.0:
+ - FIRST VERSION
+
+
+```
+usage: wlt-cert-brg [-h] [-h] [-b BRG] [-b1 BRG1] --gw GW [--data {tags,sim}] [--port PORT] [--clean] [--tl TL] [--run RUN] [--drun DRUN] [--exit_on_test_failure] [--exit_on_param_failure] [--analyze_interference]
+
+Gateway Certificate - CLI Tool to test Wiliot BRGs
+
+required arguments:
+  --gw, -g GW        Gateway ID
+  --port, -p PORT    COM Port
+  --brg, -b BRG      Bridge ID
+
+optional arguments:
+  --brg1, -b1 BRG1                              Second bridge id to run on tests two bridges needed
+  --data, -d {tags,sim}                         Choose if data generated from real tags or by simulation
+  --port, -p PORT                               Enable UT using UART connection for Gateway Simulation or Data Simulation
+  --clean                                       Clean all logs
+  --tl TL                                       Test list file to use
+  --run RUN                                     String to filter tests to run
+  --drun DRUN                                   String to filter tests not to run
+  --exit_on_test_failure                        Stop running the tests if a test failed
+  --exit_on_param_failure                       Sets exit_on_param_failure mode to true in order to prevent tests from continuing iteration over all possibilities in case of failure
+  --analyze_interference, -ai                   Analyze interference before tests start (relevant only for Gateway Simulator)
+  ```

wiliot_certificate-1.4.0a1/README.md

@@ -0,0 +1,111 @@
+# wiliot-certificate
+
+<!-- Description -->
+wiliot-certificate is a python library with tools used to test & certify boards and their compatibility with Wiliot's echosystem.
+This python package includes the following CLI utilities:
+ - Gateway Certificate (`wlt-gw-certificate`)
+ - Bridge Certificate (`wlt-cert-brg`)
+
+## Installing wiliot-certificate
+````commandline
+pip install wiliot-certificate
+````
+
+## Using wiliot-certificate
+### Gateway Certificate
+Test Wiliot GWs capabilities.
+The GW Certificate includes different test that run sequentially to test each capability reported by the GW.
+To run the GW Certificate the GW needs to use a public MQTT Broker (Eclipse):
+
+Host:	mqtt.eclipseprojects.io
+TLS TCP Port:	8883
+TLS Websocket Port:	443
+TCP Port:	1883
+Websocket Port:	80
+
+More information can be found at https://mqtt.eclipseprojects.io/.
+
+#### Connection Test
+Processes status packet sent by the GW to the MQTT Broker and validates it according to API Version.
+
+#### Uplink Test
+Simulates Wiliot MEL and validates that data is uploaded correctly to the cloud.
+
+#### Downlink Test
+Sends advertising actions (txPacket) via MQTT to the GW and validates their advertisements.
+
+#### Stress Test
+Increments time delays between packets to evaluate GW's capability in handling increasing packets per second rates.
+
+#### GW Certificate Release Notes:
+1.4.0:
+ - Released in a standalone wiliot-certificate package
+ - Python 3.12 support
+ - Gw API version 205 support
+ - Registration Test
+ - Aggregation flag supported by StressTest
+
+
+```
+usage: wlt-gw-certificate [-h] -owner OWNER -gw GW [-suffix SUFFIX] [-tests {connection,uplink,downlink,stress}]
+
+Gateway Certificate - CLI Tool to test Wiliot GWs
+
+required arguments:
+  -gw GW        Gateway ID
+
+optional arguments:
+  -owner OWNER  Owner ID (Required for non-registration tests)
+  -tests        Pick specific tests to run
+  -actions      Pick specific actions to test during the ActionsTest
+  -update       Update the firmware of the test board
+  -pps          Pick specific PPS rate for the stress test
+  -agg          Time the uplink stages should wait before processing packets
+  -suffix       Allow for different suffixes after the GW ID in MQTT topics
+  -env          Wiliot envrionment for Registration and bridgeOTA tests
+  -h, --help    show this help message and exit
+  ```
+
+### Bridge Certificate
+Test Wiliot BRGs capabilities.
+The BRG Certificate includes different tests that run sequentially to test each capability reported by the BRG.
+The BRG Certificate tool uses a public MQTT Broker (Eclipse):
+
+Host:	mqtt.eclipseprojects.io
+TLS TCP Port:	8883
+TLS Websocket Port:	443
+TCP Port:	1883
+Websocket Port:	80
+
+More information can be found at https://mqtt.eclipseprojects.io/.
+
+#### XXX Test
+TEST EXPLANATION
+
+#### BRG Certificate Release Notes:
+1.3.0:
+ - FIRST VERSION
+
+
+```
+usage: wlt-cert-brg [-h] [-h] [-b BRG] [-b1 BRG1] --gw GW [--data {tags,sim}] [--port PORT] [--clean] [--tl TL] [--run RUN] [--drun DRUN] [--exit_on_test_failure] [--exit_on_param_failure] [--analyze_interference]
+
+Gateway Certificate - CLI Tool to test Wiliot BRGs
+
+required arguments:
+  --gw, -g GW        Gateway ID
+  --port, -p PORT    COM Port
+  --brg, -b BRG      Bridge ID
+
+optional arguments:
+  --brg1, -b1 BRG1                              Second bridge id to run on tests two bridges needed
+  --data, -d {tags,sim}                         Choose if data generated from real tags or by simulation
+  --port, -p PORT                               Enable UT using UART connection for Gateway Simulation or Data Simulation
+  --clean                                       Clean all logs
+  --tl TL                                       Test list file to use
+  --run RUN                                     String to filter tests to run
+  --drun DRUN                                   String to filter tests not to run
+  --exit_on_test_failure                        Stop running the tests if a test failed
+  --exit_on_param_failure                       Sets exit_on_param_failure mode to true in order to prevent tests from continuing iteration over all possibilities in case of failure
+  --analyze_interference, -ai                   Analyze interference before tests start (relevant only for Gateway Simulator)
+  ```

{wiliot_certificate-1.3.0a1 → wiliot_certificate-1.4.0a1}/pyproject.toml

@@ -4,13 +4,13 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "wiliot_certificate"
-version = "1.3.0a1"
+version = "1.4.0a1"
 authors = [
   { name="Wiliot", email="support@wiliot.com" }
 ]
 description = "A library for certifying Wiliot-compliant boards"
 readme = "README.md"
-requires-python = ">=3.9"
+requires-python = ">=3.13"
 classifiers = [
     "Programming Language :: Python :: 3",
     "License :: OSI Approved :: MIT License",
@@ -28,11 +28,14 @@ dependencies = [
     "tabulate>=0.9.0",
     "wiliot-core>=5.9.1",
     "paho-mqtt>=2.1.0",
-    "bitstruct>=8.19.0",
+    "bitstruct>=8.20.0",
     "protobuf>=5.29.3",
     "wiliot-api>=4.10.8",
     "jsonschema>=4.23.0",
-    "statsmodels>=0.14.4"
+    "statsmodels>=0.14.4",
+    "pyserial>=3.5",
+    "reportlab>=4.3.1",
+    "google-api-python-client>=2.162.0",
 ]
 
 [project.urls]
@@ -40,7 +43,16 @@ Wiliot = "https://www.wiliot.com"
 Certified = "https://www.wiliot.com/product/ambient-iot-network#partner-device-certification"
 
 [project.scripts]
-wlt-gw-certificate = "gw_certificate.gw_certificate_cli:main"
+wlt-cert-gw = "gw_certificate.gw_certificate_cli:main"
+wlt-cert-brg = "brg_certificate.brg_certificate_cli:main"
+
+[tool.setuptools.packages.find]
+where = ["src"]
+exclude = ["*.ut*"]
 
 [tool.setuptools.package-data]
-gw_certificate = ["tests/*.csv", "tests/static/*.csv", "templates/*.html"]
+gw_certificate = ["**/*.csv", "**/*.html", "**/*.json", "**/*.zip", "interface/nrfutil*"]
+brg_certificate = ["**/*.json", "**/*.md", "*_list.txt", "**/wlt_cmd_if.html", "**/wlt_types.html"]
+
+[tool.setuptools.exclude-package-data]
+brg_certificate = ["**/mqtt_log_*.json", "*cert_mqtt_log.json", "*_log.txt", "*ut/*"]