wiliot-certificate 4.4.3__tar.gz → 4.5.0__tar.gz

wiliot_certificate-4.5.0/PKG-INFO

@@ -0,0 +1,99 @@
+Metadata-Version: 2.4
+Name: wiliot_certificate
+Version: 4.5.0
+Summary: A library for certifying Wiliot-compliant boards
+Author-email: Wiliot <support@wiliot.com>
+License-Expression: MIT
+Project-URL: Wiliot, https://www.wiliot.com
+Project-URL: Certified, https://www.wiliot.com/product/ambient-iot-network#partner-device-certification
+Classifier: Programming Language :: Python :: 3
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: flask>=3.1
+Requires-Dist: appdirs>=1.4.4
+Requires-Dist: plotly>=6.0.0
+Requires-Dist: numpy>=1.21.5
+Requires-Dist: pandas>=2.2.3
+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.20.0
+Requires-Dist: protobuf>=6.30.2
+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
+Dynamic: license-file
+
+# wiliot-certificate
+
+<!-- Description -->
+wiliot-certificate is a Python library that provides tools for testing and certifying boards for compatibility with Wiliot’s ecosystem.
+This python package includes the following tools:
+ - Certification Wizard (`wlt-cert`)
+ - Certificate CLI (`wlt-cert-cli`)
+ - Tester Upgrade (`wlt-cert-tester-upgrade`)
+ - Registration Certificate Test (`wlt-cert-reg`)
+
+# Versioning: 
+wiliot-certificate versions 4.5.x are compatible with firmware version >=4.4.0 (API VERSION: 12)
+
+## Installing wiliot-certificate
+````commandline
+pip install wiliot-certificate
+````
+
+## Using wiliot-certificate
+### Certification
+````commandline
+wlt-cert
+````
+This tool is the default to test and certify your device.
+It runs a setup wizard that walks you through the initialization steps before running the tests.
+You'll need a [validation schema](https://community.wiliot.com/customers/s/article/Validation-Schema) and a [tester device](https://community.wiliot.com/customers/s/article/Wiliot-Certification).
+Once set up it opens a terminal and tests your device.
+
+
+
+### Certificate CLI
+````commandline
+wlt-cert-cli -h
+````
+CLI version of the certificate. Use -h for details on the different arguments.
+
+
+### Tester Upgrade
+````commandline
+wlt-cert-tester-upgrade
+````
+Upgrades the firmware of the tester device to the version required for certification.
+
+
+### Registration Certificate
+````commandline
+wlt-cert-reg
+````
+Certify the gateway registration process to Wiliot platform.
+The gateway must use Wiliot production MQTT broker, and mustn't be registered to any account on Wiliot platform.
+Use -h for details on the arguments (see [Registration](https://community.wiliot.com/customers/s/article/Wiliot-Certification) for more info).
+
+
+## The following capabilities are not tested in this version
+##### Cloud Connectivity & Misc
+ - Board type registered within the Board Type Management system
+ - Bridge OTA progress reporting
+##### Module Energy 2400
+  - Functionality of energy pattern, output power and duty cycle
+##### Module Energy SUB1G
+  - Functionality of energy pattern and duty cycle 
+##### Module Datapath 
+  - RSSI edge cases: -127 and 0 
+  - Functionality of transmission pattern, output power
+##### Calibration 
+  - Functionality of output power and interval calibration 
+  - Functionality of calibration transmission patterns for the configuration STANDARD & EU & DISABLE

wiliot_certificate-4.5.0/README.md

@@ -0,0 +1,67 @@
+# wiliot-certificate
+
+<!-- Description -->
+wiliot-certificate is a Python library that provides tools for testing and certifying boards for compatibility with Wiliot’s ecosystem.
+This python package includes the following tools:
+ - Certification Wizard (`wlt-cert`)
+ - Certificate CLI (`wlt-cert-cli`)
+ - Tester Upgrade (`wlt-cert-tester-upgrade`)
+ - Registration Certificate Test (`wlt-cert-reg`)
+
+# Versioning: 
+wiliot-certificate versions 4.5.x are compatible with firmware version >=4.4.0 (API VERSION: 12)
+
+## Installing wiliot-certificate
+````commandline
+pip install wiliot-certificate
+````
+
+## Using wiliot-certificate
+### Certification
+````commandline
+wlt-cert
+````
+This tool is the default to test and certify your device.
+It runs a setup wizard that walks you through the initialization steps before running the tests.
+You'll need a [validation schema](https://community.wiliot.com/customers/s/article/Validation-Schema) and a [tester device](https://community.wiliot.com/customers/s/article/Wiliot-Certification).
+Once set up it opens a terminal and tests your device.
+
+
+
+### Certificate CLI
+````commandline
+wlt-cert-cli -h
+````
+CLI version of the certificate. Use -h for details on the different arguments.
+
+
+### Tester Upgrade
+````commandline
+wlt-cert-tester-upgrade
+````
+Upgrades the firmware of the tester device to the version required for certification.
+
+
+### Registration Certificate
+````commandline
+wlt-cert-reg
+````
+Certify the gateway registration process to Wiliot platform.
+The gateway must use Wiliot production MQTT broker, and mustn't be registered to any account on Wiliot platform.
+Use -h for details on the arguments (see [Registration](https://community.wiliot.com/customers/s/article/Wiliot-Certification) for more info).
+
+
+## The following capabilities are not tested in this version
+##### Cloud Connectivity & Misc
+ - Board type registered within the Board Type Management system
+ - Bridge OTA progress reporting
+##### Module Energy 2400
+  - Functionality of energy pattern, output power and duty cycle
+##### Module Energy SUB1G
+  - Functionality of energy pattern and duty cycle 
+##### Module Datapath 
+  - RSSI edge cases: -127 and 0 
+  - Functionality of transmission pattern, output power
+##### Calibration 
+  - Functionality of output power and interval calibration 
+  - Functionality of calibration transmission patterns for the configuration STANDARD & EU & DISABLE

{wiliot_certificate-4.4.3 → wiliot_certificate-4.5.0}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "wiliot_certificate"
-version = "4.4.3"
+version = "4.5.0"
 authors = [
   { name="Wiliot", email="support@wiliot.com" }
 ]
@@ -13,13 +13,13 @@ readme = "README.md"
 requires-python = ">=3.9"
 classifiers = [
     "Programming Language :: Python :: 3",
-    "License :: OSI Approved :: MIT License",
     "Operating System :: OS Independent"
 ]
-license = { file = "LICENSE" }
+license = "MIT"
+license-files = ["LICENSE"]
 
 dependencies = [
-    "jinja2>=3.1.5",
+    "flask>=3.1",
     "appdirs>=1.4.4",
     "plotly>=6.0.0",
     "numpy>=1.21.5",
@@ -29,7 +29,7 @@ dependencies = [
     "wiliot-core>=5.9.1",
     "paho-mqtt>=2.1.0",
     "bitstruct>=8.20.0",
-    "protobuf>=6.30.0",
+    "protobuf>=6.30.2",
     "wiliot-api>=4.10.8",
     "jsonschema>=4.23.0",
     "statsmodels>=0.14.4",
@@ -43,17 +43,19 @@ Wiliot = "https://www.wiliot.com"
 Certified = "https://www.wiliot.com/product/ambient-iot-network#partner-device-certification"
 
 [project.scripts]
-wlt-cert-gw = "gw_certificate.gw_certificate_cli:main"
-wlt-cert-brg = "brg_certificate.brg_certificate_cli:main"
+wlt-cert = "gui_certificate.gui_certificate_cli:main"
+wlt-cert-cli = "certificate.certificate_cli:main"
+wlt-cert-tester-upgrade = "common.utils.tester_upgrade:main"
+wlt-cert-reg = "certificate.tests.cloud_connectivity.registration_test.registration_test_cli:main"
 
 [tool.setuptools.packages.find]
 where = ["src"]
 exclude = ["*.ut*"]
 
 [tool.setuptools.package-data]
-common = ["wlt_logo.png"]
-gw_certificate = ["**/*.csv", "**/*.html", "**/*.json", "**/*.zip", "interface/nrfutil*"]
-brg_certificate = ["**/*.json", "**/*.md", "*_list.txt", "**/wlt_cmd_if.html", "**/wlt_types.html"]
+common = ["wlt_logo.png", "**/*.html", "**/*.json"]
+certificate = ["tests/**/*.json", "*_list.txt", "**/wlt_cmd_if.html"]
+gui_certificate = ["**/*.html"]
 
 [tool.setuptools.exclude-package-data]
-brg_certificate = ["**/mqtt_log_*.json", "*cert_mqtt_log.json", "*_log.txt", "*ut/*"]
+certificate = ["*ut/*", "config/*"]

{wiliot_certificate-4.4.3/src/brg_certificate → wiliot_certificate-4.5.0/src/certificate}/ag/wlt_cmd_if.html

@@ -30,7 +30,7 @@ tr:nth-child(odd) {
 <tr><td>ant_sel_mode_set</td><td>asms</td><td>1</td><td>set antenna polarity mode, whereas 0 = random_toggle, 1 = clear, 2 = set, 3 = toggle</td><td>!ant_sel_mode_set 1</td></tr>
 <tr><td>ant_sel_set</td><td>ass</td><td>1</td><td>Set the antenna select pin to be 0 or 1</td><td>!ant_sel_set 1</td></tr>
 <tr><td>pwr_cal_set</td><td>pcs</td><td>2</td><td>Set power calibration value (used by Energous during production line)</td><td>!pwr_cal_set 127 124</td></tr>
-<tr><td>sensor_set</td><td>sc</td><td>5</td><td>Format: (sensor idx) (sensor_ad_type) (sensor_uuid_msb) (sensor_uuid_lsb) (sensor_scramble).                     Provides Instructions for the bridge on how to handle a specified External sensor. (sensor idx) - The index of in the sensors table sized 2 , (ad_type) + (uuid_msb) + (uuid_lsb) - The external sensor identifier , (scramble) - Indicates whether the bridge should apply data scrambling to incoming data from the specified sensor. Relevant only for ADD action</td><td>!sc 0 FF 76 54 1</td></tr>
+<tr><td>sensor_set</td><td>sc</td><td>5</td><td>Format: (sensor idx) (sensor_ad_type) (sensor_uuid_msb) (sensor_uuid_lsb) (sensor_flags).                     Provides Instructions for the bridge on how to handle a specified External sensor. (sensor idx) - The index of in the sensors table sized 3 , (ad_type) + (uuid_msb) + (uuid_lsb) - The external sensor identifier , (flags) - 2 - Indicates whether the bridge should relay the sensor data as a unified packet or as data + side info,                     1 - Indicates whether the bridge should apply data scrambling to incoming data from the specified sensor. Relevant only for ADD action.</td><td>!sc 0 FF 76 54 0 1</td></tr>
 <tr><td>sensor_get</td><td>sg</td><td>0</td><td>Request the bridge to provide information regarding all of its associated external sensors</td><td>!sensor_get</td></tr>
 <tr><td>gw_wifi_connected</td><td>NONE</td><td>0</td><td>Indicates the ESP is connected to Wi-Fi</td><td>!gw_wifi_connected</td></tr>
 <tr><td>gw_wifi_disconnected</td><td>NONE</td><td>1</td><td>Indicates the ESP is not connected to Wi-Fi. Also sets leds pre-state on/off</td><td>!gw_wifi_disconnected 1</td></tr>
@@ -47,7 +47,8 @@ tr:nth-child(odd) {
 <tr><td>set_power_mgmt</td><td>spm</td><td>3,6</td><td>Configures the power management parameters as follows: !set_power_mgmt (mode) (sleep_duration) (on_duration) [keep_alive_period] [keep_alive_scan_duration] [led]</td><td>!spm 1 120 30 15 300 0, !spm 0 120 30</td></tr>
 <tr><td>get_power_mgmt</td><td>gpm</td><td>1</td><td>Get static or dynamic powr managment configuration from the bridge as follows: IDLE, ON, KA_PERIOD, KA_SCAN, LEDS</td><td>!get_power_mgmt</td></tr>
 <tr><td>send_pkt</td><td>sp</td><td>1, 2</td><td>Transmit a ble pkt. Optional - add an extra argument, specifying the number of repetitions for transmission. The default repetitions value is set to 8. BLE5 case - the packet must be of size 47 or 39 bytes</td><td>!send_pkt 04CBA011902C1E16AFFD0200002929B0FFF98DB104FA68BD5491456B55CC18AADBC230A83E 3</td></tr>
-<tr><td>ble_sim</td><td>bs</td><td>5, 6</td><td>Format: !ble_sim (pkt) (duplicates) (output power) (frequency/channel) (delay) (optional - radio mode), (pkt) - BLE packet , (duplicates) - the number of times to send the same packet , (output power) - the output power in dBm before PA , (frequency) - 2402/2403/... or channel 37/38/39 , (delay) - the delay between the transmission of the current packet and the one after it, in milliseconds, (radio mode) - optional, for BLE5 transmission, could be 1 or 2, indicates if the transmission will be in 1Mbps or 2Mbps</td><td>!ble_sim 04CBA011902C1E16AFFD0200002929B0FFF98DB104FA68BD5491456B55CC18AADBC230A83E 10 2 2402 100 2</td></tr>
+<tr><td>ble_sim</td><td>bs</td><td>5, 6, 7, 8</td><td>Format: !ble_sim (pkt) (duplicates) (output power) (frequency/channel) (delay) (optional - radio mode) (optional - unique pkts) (optional - unique packet content), (pkt) - BLE packet , (duplicates) - the number of times to send the same packet , (output power) - the absolute value below max output power to transmit, (frequency) - 2402/2403/... or channel 37/38/39 , (delay) - the delay between the transmission of the current packet and the one after it, in milliseconds, (radio mode) - optional, for BLE5 transmission, could be 1 or 2, indicates if the transmission will be in 1Mbps or 2Mbps, (unique pkts) - optional for the device to increment the last bytes and send additional pkts, (unique_content) - sends packets with uniqe content to identify from what channel was the packet sent</td><td>!ble_sim 04CBA011902C1E16AFFD0200002929B0FFF98DB104FA68BD5491456B55CC18AADBC230A83E 10 2 2402 100 2 180</td></tr>
+<tr><td>ble_sim_ext_adv</td><td>NONE</td><td>4, 5, 6</td><td>Format: !ble_sim_ext_adv (pkt) (duplicates) (output power) (delay) (optional - unique pkts) (optional - add hardcoded data payload), (pkt) - BLE packet , (duplicates) - the number of times to send the same packet , (output power) - the absolute value below max output power to transmit, (delay) - the delay between the transmission of the current packet and the one after it, in milliseconds, (unique pkts) - optional for the device to increment the last bytes and send additional pkts, (add hardcoded data payload) - optional, add 5 data packets to the end of the ext adv packet. This command builds an aggregated packet and transmits it using extended advertising (sends pointers on channels 37, 38, 39 and data packet on a random secondary channel)</td><td>!ble_sim_ext_adv 04CBA011902C1E16AFFD0200002929B0FFF98DB104FA68BD5491456B55CC18AADBC230A83E 10 2 100 180</td></tr>
 <tr><td>ble_sim_init</td><td>NONE</td><td>1</td><td>Initiate the GW to be in simulator mode</td><td>!ble_sim_init 1 !ble_sim_init 0</td></tr>
 <tr><td>gateway_app</td><td>s</td><td>0</td><td>Initiates the GW application</td><td>!gateway_app</td></tr>
 <tr><td>pl_gw_config</td><td>NONE</td><td>1</td><td>Set production Line Status to enable (1) or disable (0)</td><td>!pl_gw_config 1</td></tr>
@@ -71,6 +72,7 @@ tr:nth-child(odd) {
 <tr><td>blink</td><td></td><td>0</td><td>Blink Leds</td><td>!blink</td></tr>
 <tr><td>stop_advertising</td><td>sa</td><td>0</td><td>Disables soft device and nus</td><td>!sa</td></tr>
 <tr><td>deduplication_pkts</td><td>dp</td><td>1</td><td>Set new configuration for packets deduplication, options are 0 to disable and 1 to enable</td><td>!dp 1</td></tr>
+<tr><td>gw_cert_tester</td><td>gct</td><td>1</td><td>Set new configuration for gateway certification tester, options are 0 to disable and 1 to enable</td><td>!gct 1</td></tr>
 <tr><td>sub1g_duty_cycle_set</td><td>sdcs</td><td>1</td><td>Set duty cycle in percentage for Sub1GHz energizing. Min = 0, Max = 100. (for dual-band bridges only)</td><td>!sdcs 30</td></tr>
 <tr><td>sub1g_ep_set</td><td>seps</td><td>1</td><td>Set energy pattern for Sub1GHz radio.  {0: No energizing, 1: Single tone 915MHz, 2: Hopping, 3: Japan1W, 4: Japan350mW, 5: Korea, 6: Single tone 916300MHz, 7: Single tone 917500MHz, 8: Australia, 9: Israel, 10: NZ (Hopping)}. (for dual-band bridges only)</td><td>!sub1g_ep_set 1</td></tr>
 <tr><td>output_power</td><td>op</td><td>2</td><td>Set output power [dBm], for either energizing, calibration, or communication. The type is determined by the first argument given ('e' for energizing, 'ca' for calibration, 'cm' for communication). </td><td>!output_power e pos8dBm \n !output_power ca -40</td></tr>
@@ -86,15 +88,19 @@ tr:nth-child(odd) {
 <tr><td>set_sensors_rssi_threshold</td><td>ssrt</td><td>1</td><td>Set new configuration for Sensors RSSI Threshold, options are 0 to 127 (0 disables feature)</td><td>!ssrt 20</td></tr>
 <tr><td>set_sub1g_rssi_threshold</td><td>sgrt</td><td>1</td><td>Set new configuration for Sub1G RSSI Threshold, options are 0 to 127 (0 disables feature)</td><td>!sgrt 20</td></tr>
 <tr><td>set_pacer_interval</td><td>pi</td><td>1</td><td>Set the mean interval between transmissions of a single tag [seconds]</td><td></td></tr>
+<tr><td>set_event_window</td><td>sew</td><td>2</td><td>Set the time frame for defining a tag as dynamic and disabling the pacing for it. Format: (units - secs/mins/hours) (value)</td><td>!pdw 0 30</td></tr>
+<tr><td>set_event_trigger</td><td>set</td><td>1</td><td>Set the types of events that will trigger dynamic pacing for tags. Format: 4 bits, each bit represents a trigger - 1 (0b0001): New tag, 2 (0b0010): Temp change, 4 (0b0100): Tx rate change, 8 (0b1000): RSSI change</td><td>!set 8</td></tr>
+<tr><td>set_event_pacer_interval</td><td>sepi</td><td>1</td><td>Set the dynamic pacer interval for dynamic tags. Format: seconds</td><td>!sepi 5</td></tr>
+<tr><td>set_rssi_movement_threshold</td><td>srmt</td><td>1</td><td>Set the threshold for detecting rssi movement - {6, 9, 12, 15} [dBm].</td><td>!srmt 12</td></tr>
 <tr><td>set_datapath_pattern</td><td>scp</td><td>1</td><td>Set new configuration for communicatiom pattern, could be - {0: 'Standard beaconing', 1: 'No beacons on channel 37', 2: 'EU pattern', 3: 'Disable communication beaconing'}</td><td>!scp 2</td></tr>
-<tr><td>set_rx_channel</td><td>src</td><td>1</td><td>Set new configuration for rx channel or frequency, could be - [37, 38, 39, 10] or any other valid channel or frequency</td><td>!src 10</td></tr>
+<tr><td>set_rx_channel</td><td>src</td><td>1</td><td>Set new configuration for rx channel or frequency, could be - [37, 38, 39, 10, 47 (37 and 10 hopping), 21] or any other valid channel or frequency</td><td>!src 10</td></tr>
 <tr><td>set_radio_mode</td><td>srm</td><td>1</td><td>Set new configuration for radio mode (rx rate), could be [1Mbps, 2Mbps E2/E3 Pixels, 2Mbps E4 Pixels] - [0, 1, 2]</td><td>!srm 1</td></tr>
 <tr><td>calib_interval</td><td>ci</td><td>1</td><td>Set new configuration for Calibration Interval, the actual interval is 20msec*(calib_interval)</td><td>!ci 10</td></tr>
 <tr><td>calib_pattern</td><td>cp</td><td>1</td><td>Set new configuration for Calibration Pattern, could be - {0: 'Standard beaconing', 1: 'No beacons on channel 37', 2: 'EU pattern', 3: 'Disable communication beaconing'}</td><td>!cp 0</td></tr>
 <tr><td>signal_indicator_2_4_set</td><td>si24</td><td>2</td><td>Set a new configuration for 2.4GHz signal_indicator packets cycle. The cycle is the duration in seconds between transmission of signal indicator packets. Min - 0 , Max - 16383. 0 - disable the transmission. When the 'Signal Indicator Cycle' is 0 repetitions value is irrelevant. repetitions Min - 1, Max - 4</td><td>!si24 60 4</td></tr>
 <tr><td>signal_indicator_sub1g_set</td><td>sis</td><td>2</td><td>Set a new configuration for sub1g signal_indicator packets cycle and repetition. The cycle is the duration in seconds between transmission of signal indicator packets. Min - 0 , Max - 16383. 0 - disable the transmission. When the 'Signal Indicator Cycle' is 0 repetitions value is irrelevant. repetitions Min - 1, Max - 4</td><td>!sis 60 4</td></tr>
 <tr><td>test_mode_2_4_set</td><td>tm24</td><td>3</td><td>Test mode for the 2.4Ghz radio, Frequency [2400-2480 MHz]; Power (before PA that can add ~20) [+8 dBm to -12 dBm]; Test Duration [Seconds]</td><td>!tm24 2400 2 30</td></tr>
-<tr><td>test_mode_sub1g_set</td><td>tms</td><td>5</td><td>Test mode for the Sub1G radio, Frequency [905000-920000 kHz], Output Power (before PA that can add ~20) ,On time [milliseconds], Off time [milliseconds]; Test Duration[Seconds]</td><td>!tms 905000 4 20 60 20</td></tr>
+<tr><td>test_mode_sub1g_set</td><td>tms</td><td>6</td><td>Test mode for the Sub1G radio, Frequency [905000-920000 kHz], Output Power (before PA that can add ~20), On time [milliseconds], Off time [milliseconds]; Test Duration[Seconds] Modulation[0-2 for CW,GFSK,LORA]</td><td>!tms 905000 4 20 60 20 0</td></tr>
 <tr><td>test_mode_operational_2_4_set</td><td>tmo24</td><td>3</td><td>Test mode for various 2.4Ghz operational modes: Pattern [0=Beacons 37/38/39, 1=Beacons 38/38/39, 2=EU pattern]; Power [+8 dBm to -12 dBm , before PA that can add ~20 [dBm]]; Test Duration[Seconds]</td><td>!tmo24 0 2 30</td></tr>
 <tr><td>test_mode_operational_sub1g_set</td><td>tmos</td><td>3</td><td>Test mode for various sub1G operational modes: Pattern [0=No energy, 1=Single one 915M, 2=FCC Hopping, 3=Japan_1W, 4=Jappan_350mW, 5=Korea, 6=916.3 MHz, 7=917.5 mHz,8=Australia, 9=Israel, 10=NZ Hopping; Output Power (before PA that can add ~20); Test Duration[Seconds]</td><td>!tmos 2 4 60</td></tr>