wiliot-certificate 1.5.0a1__py3-none-any.whl → 1.5.2a1__py3-none-any.whl

brg_certificate/tests/sensors/ext_sensor_test/ext_sensor_test.py

@@ -0,0 +1,306 @@
+from brg_certificate.cert_prints import *
+from brg_certificate.cert_defines import *
+from brg_certificate.wlt_types import *
+import brg_certificate.cert_common as cert_common
+import brg_certificate.cert_config as cert_config
+import brg_certificate.cert_mqtt as cert_mqtt
+import csv
+# test MACROS definitions #
+DEFAULT_SENSOR_PAYLOAD_DATA = "0200002929B0FFF98DB104FA68BD5491456B55CC18AADB"
+DEFAULT_ADVA0 = "112233445566"
+DEFAULT_ADVA1 = "778899AABBCC"
+ERM_SMART_MS_PAYLOAD = "0201060303374C17FFAE0421EF9DE99CE7AE7C5EB13B744D401CC6CFCF0107"
+ZEBRA_PRINTER_PAYLOAD = "0201020F0958585A564A323331363038333435030279FEA5A5A5A5A5A5A5A5"
+DEFAULT_SPECIAL_PAYLOAD = ZEBRA_PRINTER_PAYLOAD
+DEFAULT_PACKET_LENGTH = "1E"
+
+SCAN_TIMEOUT = 60
+
+# UUID defines for logs review #
+ERM_SMART_MS_UUID = 0xFFAE04
+ZEBRA_PRINTER_UUID = 0x0279FE
+UUID_0 = ZEBRA_PRINTER_UUID
+UUID_1 = 0x987654
+SCRAMBLE_ON = 0x01
+SCRAMBLE_OFF = 0x00
+
+
+def uuid_scramble_cfg_add(uuid, scramble):
+    return uuid << 8 | scramble
+
+
+def unscramble(packet):
+    unscrambled_packet_id = int(hex(packet[RSSI])[2:] + packet[SENSOR_ID][-6:], 16)  # transforming parameters string to hex format
+    for idx in range(6, 60, 8):
+        current_word = int(packet[PAYLOAD][idx: idx + 8], 16)
+        unscrambled_packet_id ^= current_word
+    return packet[PAYLOAD][8:-8] + hex(unscrambled_packet_id)[2:]
+
+
+def find_packet_in_csv(unscrambled_payload):
+    base_path = os.path.dirname(os.path.abspath(__file__))
+    with open(f'{base_path}/out_sensor_data.csv', 'r') as csv_file:
+        csv_reader = csv.DictReader(csv_file)
+        next(csv_reader)                        # stepping over the header line
+        for line in csv_reader:
+            raw_data_payload = line['raw packet'][20:]
+            if raw_data_payload[:8] == unscrambled_payload[:8]:
+                return True
+        return False
+
+
+# Test functions description #
+def create_csv_file_in(test, length=500):
+    if test.data != DATA_SIMULATION:
+        return []
+    else:
+        base_path = os.path.dirname(os.path.abspath(__file__))
+    pkts = []
+    payload_0 = DEFAULT_ADVA0 + DEFAULT_SPECIAL_PAYLOAD
+    payload_1 = DEFAULT_ADVA1 + DEFAULT_PACKET_LENGTH + cert_common.int2mac_get(UUID_1)[6:] + DEFAULT_SENSOR_PAYLOAD_DATA
+    with open(f"{base_path}/in_sensor_data.csv", "w+") as f:
+        f.write("raw packet,output power,delay,duplicates,channel,COM\n")
+        for i in range(length):
+            f.write(payload_0 + ",8,200,6,37,COM3\n")
+            f.write(payload_1 + "{:08X}".format(i) + ",8,200,6,37,COM3\n")
+            pkts.append(payload_0)
+            pkts.append(payload_1 + "{:08X}".format(i))
+    return pkts
+
+
+def create_csv_file_out(test):
+    if test.data != DATA_SIMULATION:
+        return
+    else:
+        base_path = os.path.dirname(os.path.abspath(__file__))
+    uuid_0 = cert_common.int2mac_get(UUID_0)[6:]
+    with (open(f"{base_path}/in_sensor_data.csv", "r") as csv_in,
+          open(f"{base_path}/out_sensor_data.csv", "w") as csv_out):
+        csv_out.write("raw packet,output power,delay,duplicates,channel,COM\n")
+        csv_in = csv.DictReader(csv_in)
+        next(csv_in)                        # stepping over the header line
+        for line in csv_in:
+            input_payload = line['raw packet'][12:]
+            if uuid_0 in input_payload:
+                csv_out.write(DEFAULT_ADVA0 + process_sensor_payload(input_payload, uuid_0) + ",8,200,6,37,COM3\n")
+            else:
+                csv_out.write(line['raw packet'] + ",8,200,6,37,COM3\n")
+
+
+def process_sensor_payload(payload, uuid):
+    uuid_idx = payload.find(uuid)
+    if uuid_idx == -1:
+        raise ValueError(f"Pattern {uuid_idx} not found in the packet")
+
+    len = int(payload[uuid_idx - 2:uuid_idx], 16)
+    segment_start_idx = uuid_idx - 2
+    segment_end_idx = uuid_idx + len * 2
+    segment = payload[segment_start_idx:segment_end_idx]
+    output = segment + payload[:segment_start_idx] + payload[segment_end_idx:]
+    return output
+
+
+def pkts_get(test, phase):
+    test.mqttc.flush_pkts()
+    mqtt_scan_wait(test, duration=SCAN_TIMEOUT)
+    sensor_pkts = cert_mqtt.get_all_sensor_pkts(test)
+    generate_log_file(test, phase)
+
+    if len(sensor_pkts) == 0:
+        if phase != "tag_data_only" and phase != "rssi_threshold":
+            test.rc = TEST_FAILED
+            test.add_reason(f"Phase {phase} failed - didn't find any sensor packets")
+    else:
+        if phase == "tag_data_only":
+            test.rc = TEST_FAILED
+            test.add_reason(f"Phase {phase} failed - found sensor packets")
+        sensor0_pkts = [p[SENSOR_UUID] == f"{UUID_0:06X}" for p in sensor_pkts]
+        if phase == "snsr0_scrmbl_snsr1_no_scrmbl" or phase == "snsr0_scrmbl_snsr1_scrmbl" or phase == "snsr0_no_scrmbl":
+            if not any(sensor0_pkts):
+                test.rc = TEST_FAILED
+                test.add_reason(f"Phase {phase} failed - didn't find any sensor0 packets")
+        sensor1_pkts = [p[SENSOR_UUID] == f"{UUID_1:06X}" for p in sensor_pkts]
+        if phase == "snsr0_scrmbl_snsr1_no_scrmbl" or phase == "snsr0_scrmbl_snsr1_scrmbl" or phase == "snsr1_scrmbl":
+            if not any(sensor1_pkts):
+                test.rc = TEST_FAILED
+                test.add_reason(f"Phase {phase} failed - didn't find any sensor1 packets")
+
+    return sensor_pkts
+
+
+def test_tag_data_only(test, phase, _):
+    pkts_get(test, phase)
+    return test
+
+
+def test_rssi_threshold(test, phase, ext_sensors_module):
+    rssi_threshold = -25
+    # Config
+    utPrint(f"UUID_0 only without scrambling, RSSI Threshold = {rssi_threshold}\n", "BLUE")
+    sensor0 = uuid_scramble_cfg_add(UUID_0, SCRAMBLE_OFF)
+    test = cert_config.brg_configure(test=test, module=ext_sensors_module,
+                                     fields=[BRG_SENSOR0, BRG_RSSI_THRESHOLD], values=[sensor0, rssi_threshold])[0]
+    # Analyze
+    sensor_pkts = pkts_get(test, phase)
+    if test.rc == TEST_FAILED:
+        return test
+    rssi_threshold_viloation_pkts = [p for p in sensor_pkts if p[RSSI] >= -1 * rssi_threshold]
+    if rssi_threshold_viloation_pkts:
+        test.rc = TEST_FAILED
+        test.add_reason("rssi_threshold phase failed - received"
+                        f" {len(rssi_threshold_viloation_pkts)} sensor packets\n with RSSI weaker than {rssi_threshold}")
+        return test
+    return test
+
+
+def test_snsr0_no_scrmbl(test, phase, ext_sensors_module):
+    # Config
+    utPrint("UUID_0 only without scrambling - UUID is 0x{:06X}".format(UUID_0), "BLUE")
+    sensor0 = uuid_scramble_cfg_add(UUID_0, SCRAMBLE_OFF)
+    test = cert_config.brg_configure(test=test, module=ext_sensors_module, fields=[BRG_SENSOR0], values=[sensor0])[0]
+    if test.rc == TEST_FAILED:
+        test.add_reason(f"Configuration for phase {phase} failed")
+        return test
+    # Analyze
+    sensor_pkts = pkts_get(test, phase)
+    if test.rc == TEST_FAILED:
+        return test
+    for p in sensor_pkts:
+        if p[SENSOR_UUID] != "{:06X}".format(UUID_0):
+            test.rc = TEST_FAILED
+            test.add_reason(f"Phase {phase} failed - received packets from an un-registered sensor")
+            return test
+        unscrambled_payload = p[PAYLOAD][8:]
+        if find_packet_in_csv(unscrambled_payload) is False:
+            test.rc = TEST_FAILED
+            test.add_reason(f"Phase {phase} failed - couldn't find unscrambled payload")
+            return test
+    return test
+
+
+def test_snsr1_scrmbl(test, phase, ext_sensors_module):
+    # Config
+    utPrint("UUID_1 only with scrambling - UUID is 0x{:06X}".format(UUID_1), "BLUE")
+    sensor1 = uuid_scramble_cfg_add(UUID_1, SCRAMBLE_ON)
+    test = cert_config.brg_configure(test=test, module=ext_sensors_module, fields=[BRG_SENSOR1], values=[sensor1])[0]
+    if test.rc == TEST_FAILED:
+        test.add_reason(f"Configuration for phase {phase} failed")
+        return test
+    # Analyze
+    sensor_pkts = pkts_get(test, phase)
+    if test.rc == TEST_FAILED:
+        return test
+    for p in sensor_pkts:
+        if p[SENSOR_UUID] != "{:06X}".format(UUID_1):
+            test.rc = TEST_FAILED
+            test.add_reason(f"Phase {phase} failed - received packets from an un-registered sensor")
+            return test
+        unscrambled_payload = unscramble(p)
+        if find_packet_in_csv(unscrambled_payload) is False:
+            test.rc = TEST_FAILED
+            test.add_reason(f"Phase {phase} failed - scrambling algorithm error")
+            return test
+    return test
+
+
+def test_snsr0_scrmbl_snsr1_no_scrmbl(test, phase, ext_sensors_module):
+    # Config
+    print(f"UUID_0 with scrambling, UUID_1 without scrambling, {SCAN_TIMEOUT} sec\n")
+    sensor0 = uuid_scramble_cfg_add(UUID_0, SCRAMBLE_ON)
+    sensor1 = uuid_scramble_cfg_add(UUID_1, SCRAMBLE_OFF)
+    test = cert_config.brg_configure(test=test, module=ext_sensors_module, fields=[BRG_SENSOR0, BRG_SENSOR1], values=[sensor0, sensor1])[0]
+    if test.rc == TEST_FAILED:
+        test.add_reason(f"Configuration for phase {phase} failed")
+        return test
+    # Analyze
+    sensor_pkts = pkts_get(test, phase)
+    if test.rc == TEST_FAILED:
+        return test
+    for p in sensor_pkts:
+        if p[SENSOR_UUID] == "{:06X}".format(UUID_0):
+            unscrambled_payload = unscramble(p)
+            if find_packet_in_csv(unscrambled_payload) is False:
+                test.rc = TEST_FAILED
+                test.add_reason(f"Phase {phase} failed - scrambling algorithm error")
+                return test
+        if p[SENSOR_UUID] == "{:06X}".format(UUID_1):
+            unscrambled_payload = p[PAYLOAD][8:]
+            if find_packet_in_csv(unscrambled_payload) is False:
+                test.rc = TEST_FAILED
+                test.add_reason(f"Phase {phase} failed - couldn't find unscrambled payload")
+                return test
+    return test
+
+
+def test_snsr0_scrmbl_snsr1_scrmbl(test, phase, ext_sensors_module):
+    # Config
+    utPrint(f"UUID_0 with scrambling, UUID_1 with scrambling, {SCAN_TIMEOUT} sec\n", "BLUE")
+    sensor0 = uuid_scramble_cfg_add(UUID_0, SCRAMBLE_ON)
+    sensor1 = uuid_scramble_cfg_add(UUID_1, SCRAMBLE_ON)
+    test = cert_config.brg_configure(test=test, module=ext_sensors_module, fields=[BRG_SENSOR0, BRG_SENSOR1], values=[sensor0, sensor1])[0]
+    if test.rc == TEST_FAILED:
+        return test
+    # Analyze
+    sensor_pkts = pkts_get(test, phase)
+    if test.rc == TEST_FAILED:
+        return test
+    for p in sensor_pkts:
+        unscrambled_payload = unscramble(p)
+        if find_packet_in_csv(unscrambled_payload) is False:
+            test.rc = TEST_FAILED
+            test.add_reason(f"Phase {phase} failed - scrambling algorithm error")
+            return test
+    return test
+
+
+EXT_SENSOR_TEST_MAP = {"tag_data_only": test_tag_data_only,
+                       "rssi_threshold": test_rssi_threshold,
+                       "snsr0_no_scrmbl": test_snsr0_no_scrmbl,
+                       "snsr1_scrmbl": test_snsr1_scrmbl,
+                       "snsr0_scrmbl_snsr1_no_scrmbl": test_snsr0_scrmbl_snsr1_no_scrmbl,
+                       "snsr0_scrmbl_snsr1_scrmbl": test_snsr0_scrmbl_snsr1_scrmbl}
+
+
+def run(test):
+    datapath_module = eval_pkt(f'ModuleDatapathV{test.active_brg.api_version}')
+    ext_sensors_module = eval_pkt(f'ModuleExtSensorsV{test.active_brg.api_version}')
+    test = cert_common.test_prolog(test)
+    # check for problems in prolog
+    if test.rc == TEST_FAILED:
+        test = cert_common.test_epilog(test)
+        return test
+
+    # Adaptation of GW configuration for internal BRG test
+    if test.internal_brg:
+        test = cert_config.brg_configure(test, fields=[BRG_RX_CHANNEL], values=[ag.RX_CHANNEL_37], module=datapath_module, wait=True)[0]
+        if test.rc == TEST_FAILED and test.exit_on_param_failure:
+            return cert_common.test_epilog(test, revert_gws=True)
+
+    # create csv file for the test
+    in_pkts = create_csv_file_in(test)
+    create_csv_file_out(test)
+
+    if test.data == DATA_SIMULATION:
+        # start generating sensor pkts and send them using data simulator
+        pixel_sim_thread = cert_data_sim.DataSimThread(test=test, num_of_pixels=len(in_pkts), duplicates=6, delay=200,
+                                                       pkt_types=[0], pixels_type=RAW_DATA, pkts=in_pkts)
+        pixel_sim_thread.start()
+        ble_sim_thread = pixel_sim_thread
+
+    for param in test.params:
+        functionality_run_print(param.name)
+        test = EXT_SENSOR_TEST_MAP[param.value](test, param.name, ext_sensors_module)
+        field_functionality_pass_fail_print(test, param.name)
+        test.set_phase_rc(param.name, test.rc)
+        test.add_phase_reason(param.name, test.reason)
+        if test.rc == TEST_FAILED and test.exit_on_param_failure:
+            field_functionality_pass_fail_print(test, 'phase', param.name)
+            break
+        else:
+            test.reset_result()
+
+    # Kill the ble simulator
+    if test.data == DATA_SIMULATION:
+        ble_sim_thread.stop()
+
+    return cert_common.test_epilog(test, revert_brgs=True, modules=[ext_sensors_module, datapath_module])

brg_certificate/wltPb_pb2.py

@@ -24,7 +24,7 @@ _sym_db = _symbol_database.Default()
 
 
 
-DESCRIPTOR = _descriptor_pool.Default().AddSerializedFile(b'\n\x0bwltPb.proto\x12\x05wltPb\"$\n\x08Location\x12\x0b\n\x03lat\x18\x01 \x01(\x01\x12\x0b\n\x03lng\x18\x02 \x01(\x01\"j\n\x05Value\x12\x16\n\x0cintegerValue\x18\x01 \x01(\x03H\x00\x12\x15\n\x0bnumberValue\x18\x02 \x01(\x01H\x00\x12\x15\n\x0bstringValue\x18\x03 \x01(\tH\x00\x12\x13\n\tboolValue\x18\x04 \x01(\x08H\x00\x42\x06\n\x04type\"\x89\x02\n\x0bGatewayData\x12\x11\n\tgatewayId\x18\x01 \x01(\t\x12\x11\n\ttimestamp\x18\x02 \x01(\x04\x12*\n\x07packets\x18\x03 \x03(\x0b\x32\x19.wltPb.GatewayData.Packet\x12&\n\x08location\x18\x04 \x01(\x0b\x32\x0f.wltPb.LocationH\x00\x88\x01\x01\x1as\n\x06Packet\x12\x0f\n\x07payload\x18\x01 \x01(\x0c\x12\x11\n\ttimestamp\x18\x02 \x01(\x04\x12\x12\n\nsequenceId\x18\x03 \x01(\r\x12\x11\n\x04rssi\x18\x04 \x01(\rH\x00\x88\x01\x01\x12\x15\n\raliasBridgeId\x18\x05 \x01(\tB\x07\n\x05_rssiB\x0b\n\t_location\"\xc9\x01\n\rUplinkMessage\x12-\n\rgatewayStatus\x18\x01 \x01(\x0b\x32\x14.wltPb.GatewayStatusH\x00\x12)\n\x0bgatewayInfo\x18\x02 \x01(\x0b\x32\x12.wltPb.GatewayInfoH\x00\x12)\n\x0bgatewayLogs\x18\x03 \x01(\x0b\x32\x12.wltPb.GatewayLogsH\x00\x12+\n\x0c\x61\x63tionStatus\x18\x04 \x01(\x0b\x32\x13.wltPb.ActionStatusH\x00\x42\x06\n\x04type\"&\n\x03\x41\x43L\x12\x12\n\nmode_allow\x18\x01 \x01(\x08\x12\x0b\n\x03ids\x18\x02 \x03(\x0c\"\x97\x01\n\x12GatewayConfigValue\x12\x16\n\x0cintegerValue\x18\x01 \x01(\x03H\x00\x12\x15\n\x0bnumberValue\x18\x02 \x01(\x01H\x00\x12\x15\n\x0bstringValue\x18\x03 \x01(\tH\x00\x12\x13\n\tboolValue\x18\x04 \x01(\x08H\x00\x12\x1e\n\x08\x61\x63lValue\x18\x05 \x01(\x0b\x32\n.wltPb.ACLH\x00\x42\x06\n\x04type\"\xe8\x03\n\rGatewayStatus\x12\x11\n\tgatewayId\x18\x01 \x01(\t\x12\x13\n\x0bgatewayType\x18\x02 \x01(\t\x12\x19\n\x11\x64ownlinkSupported\x18\x03 \x01(\x08\x12!\n\x19\x62ridgeOtaUpgradeSupported\x18\x04 \x01(\x08\x12\x12\n\napiVersion\x18\x05 \x01(\r\x12\x14\n\x07version\x18\x06 \x01(\tH\x00\x88\x01\x01\x12\x19\n\x0c\x62leSwVersion\x18\x07 \x01(\tH\x01\x88\x01\x01\x12\x1f\n\x12interfaceSwVersion\x18\x08 \x01(\tH\x02\x88\x01\x01\x12&\n\x08location\x18\t \x01(\x0b\x32\x0f.wltPb.LocationH\x03\x88\x01\x01\x12\x30\n\x06\x63onfig\x18\n \x03(\x0b\x32 .wltPb.GatewayStatus.ConfigEntry\x12\x17\n\nbleAddress\x18\x0b \x01(\tH\x04\x88\x01\x01\x1aH\n\x0b\x43onfigEntry\x12\x0b\n\x03key\x18\x01 \x01(\t\x12(\n\x05value\x18\x02 \x01(\x0b\x32\x19.wltPb.GatewayConfigValue:\x02\x38\x01\x42\n\n\x08_versionB\x0f\n\r_bleSwVersionB\x15\n\x13_interfaceSwVersionB\x0b\n\t_locationB\r\n\x0b_bleAddress\"}\n\x0bGatewayInfo\x12\x30\n\x07\x65ntries\x18\x01 \x03(\x0b\x32\x1f.wltPb.GatewayInfo.EntriesEntry\x1a<\n\x0c\x45ntriesEntry\x12\x0b\n\x03key\x18\x01 \x01(\t\x12\x1b\n\x05value\x18\x02 \x01(\x0b\x32\x0c.wltPb.Value:\x02\x38\x01\"\x1b\n\x0bGatewayLogs\x12\x0c\n\x04logs\x18\x01 \x03(\t\".\n\x0c\x41\x63tionStatus\x12\x0e\n\x06\x61\x63tion\x18\x01 \x01(\r\x12\x0e\n\x06status\x18\x02 \x01(\r\"\x8e\x02\n\x0f\x44ownlinkMessage\x12#\n\x08txPacket\x18\x01 \x01(\x0b\x32\x0f.wltPb.TxPacketH\x00\x12-\n\rgatewayAction\x18\x02 \x01(\x0b\x32\x14.wltPb.GatewayActionH\x00\x12-\n\rbridgeUpgrade\x18\x03 \x01(\x0b\x32\x14.wltPb.BridgeUpgradeH\x00\x12-\n\rgatewayConfig\x18\x04 \x01(\x0b\x32\x14.wltPb.GatewayConfigH\x00\x12-\n\rcustomMessage\x18\x06 \x01(\x0b\x32\x14.wltPb.CustomMessageH\x00\x42\x06\n\x04typeJ\x04\x08\x05\x10\x06R\x0c\x63ustomBroker\"F\n\x08TxPacket\x12\x0f\n\x07payload\x18\x01 \x01(\x0c\x12\x12\n\nmaxRetries\x18\x02 \x01(\r\x12\x15\n\rmaxDurationMs\x18\x03 \x01(\r\"\x1f\n\rGatewayAction\x12\x0e\n\x06\x61\x63tion\x18\x01 \x01(\t\"\xa5\x01\n\rBridgeUpgrade\x12\x14\n\x0crebootPacket\x18\x01 \x01(\x0c\x12\x17\n\x0ftxMaxDurationMs\x18\x02 \x01(\r\x12\x14\n\x0ctxMaxRetries\x18\x03 \x01(\r\x12\x10\n\x08\x62ridgeId\x18\x04 \x01(\t\x12\x13\n\x0bversionUuid\x18\x05 \x01(\t\x12\x13\n\x0bupgradeBlSd\x18\x06 \x01(\x08\x12\x13\n\x0bimageDirUrl\x18\x07 \x01(\t\"\xc6\x02\n\rGatewayConfig\x12\x14\n\x07version\x18\x01 \x01(\tH\x00\x88\x01\x01\x12\x19\n\x0c\x62leSwVersion\x18\x02 \x01(\tH\x01\x88\x01\x01\x12\x1f\n\x12interfaceSwVersion\x18\x03 \x01(\tH\x02\x88\x01\x01\x12&\n\x08location\x18\x04 \x01(\x0b\x32\x0f.wltPb.LocationH\x03\x88\x01\x01\x12\x30\n\x06\x63onfig\x18\x05 \x03(\x0b\x32 .wltPb.GatewayConfig.ConfigEntry\x1aH\n\x0b\x43onfigEntry\x12\x0b\n\x03key\x18\x01 \x01(\t\x12(\n\x05value\x18\x02 \x01(\x0b\x32\x19.wltPb.GatewayConfigValue:\x02\x38\x01\x42\n\n\x08_versionB\x0f\n\r_bleSwVersionB\x15\n\x13_interfaceSwVersionB\x0b\n\t_location\"\x81\x01\n\rCustomMessage\x12\x32\n\x07\x65ntries\x18\x01 \x03(\x0b\x32!.wltPb.CustomMessage.EntriesEntry\x1a<\n\x0c\x45ntriesEntry\x12\x0b\n\x03key\x18\x01 \x01(\t\x12\x1b\n\x05value\x18\x02 \x01(\x0b\x32\x0c.wltPb.Value:\x02\x38\x01\x62\x06proto3')
+DESCRIPTOR = _descriptor_pool.Default().AddSerializedFile(b'\n\x0bwltPb.proto\x12\x05wltPb\"$\n\x08Location\x12\x0b\n\x03lat\x18\x01 \x01(\x01\x12\x0b\n\x03lng\x18\x02 \x01(\x01\"j\n\x05Value\x12\x16\n\x0cintegerValue\x18\x01 \x01(\x03H\x00\x12\x15\n\x0bnumberValue\x18\x02 \x01(\x01H\x00\x12\x15\n\x0bstringValue\x18\x03 \x01(\tH\x00\x12\x13\n\tboolValue\x18\x04 \x01(\x08H\x00\x42\x06\n\x04type\"\x89\x02\n\x0bGatewayData\x12\x11\n\tgatewayId\x18\x01 \x01(\t\x12\x11\n\ttimestamp\x18\x02 \x01(\x04\x12*\n\x07packets\x18\x03 \x03(\x0b\x32\x19.wltPb.GatewayData.Packet\x12&\n\x08location\x18\x04 \x01(\x0b\x32\x0f.wltPb.LocationH\x00\x88\x01\x01\x1as\n\x06Packet\x12\x0f\n\x07payload\x18\x01 \x01(\x0c\x12\x11\n\ttimestamp\x18\x02 \x01(\x04\x12\x12\n\nsequenceId\x18\x03 \x01(\r\x12\x11\n\x04rssi\x18\x04 \x01(\rH\x00\x88\x01\x01\x12\x15\n\raliasBridgeId\x18\x05 \x01(\tB\x07\n\x05_rssiB\x0b\n\t_location\"\xc9\x01\n\rUplinkMessage\x12-\n\rgatewayStatus\x18\x01 \x01(\x0b\x32\x14.wltPb.GatewayStatusH\x00\x12)\n\x0bgatewayInfo\x18\x02 \x01(\x0b\x32\x12.wltPb.GatewayInfoH\x00\x12)\n\x0bgatewayLogs\x18\x03 \x01(\x0b\x32\x12.wltPb.GatewayLogsH\x00\x12+\n\x0c\x61\x63tionStatus\x18\x04 \x01(\x0b\x32\x13.wltPb.ActionStatusH\x00\x42\x06\n\x04type\"&\n\x03\x41\x43L\x12\x12\n\nmode_allow\x18\x01 \x01(\x08\x12\x0b\n\x03ids\x18\x02 \x03(\x0c\"\x97\x01\n\x12GatewayConfigValue\x12\x16\n\x0cintegerValue\x18\x01 \x01(\x03H\x00\x12\x15\n\x0bnumberValue\x18\x02 \x01(\x01H\x00\x12\x15\n\x0bstringValue\x18\x03 \x01(\tH\x00\x12\x13\n\tboolValue\x18\x04 \x01(\x08H\x00\x12\x1e\n\x08\x61\x63lValue\x18\x05 \x01(\x0b\x32\n.wltPb.ACLH\x00\x42\x06\n\x04type\"\xe8\x03\n\rGatewayStatus\x12\x11\n\tgatewayId\x18\x01 \x01(\t\x12\x13\n\x0bgatewayType\x18\x02 \x01(\t\x12\x19\n\x11\x64ownlinkSupported\x18\x03 \x01(\x08\x12!\n\x19\x62ridgeOtaUpgradeSupported\x18\x04 \x01(\x08\x12\x12\n\napiVersion\x18\x05 \x01(\r\x12\x14\n\x07version\x18\x06 \x01(\tH\x00\x88\x01\x01\x12\x19\n\x0c\x62leSwVersion\x18\x07 \x01(\tH\x01\x88\x01\x01\x12\x1f\n\x12interfaceSwVersion\x18\x08 \x01(\tH\x02\x88\x01\x01\x12&\n\x08location\x18\t \x01(\x0b\x32\x0f.wltPb.LocationH\x03\x88\x01\x01\x12\x30\n\x06\x63onfig\x18\n \x03(\x0b\x32 .wltPb.GatewayStatus.ConfigEntry\x12\x17\n\nbleAddress\x18\x0b \x01(\tH\x04\x88\x01\x01\x1aH\n\x0b\x43onfigEntry\x12\x0b\n\x03key\x18\x01 \x01(\t\x12(\n\x05value\x18\x02 \x01(\x0b\x32\x19.wltPb.GatewayConfigValue:\x02\x38\x01\x42\n\n\x08_versionB\x0f\n\r_bleSwVersionB\x15\n\x13_interfaceSwVersionB\x0b\n\t_locationB\r\n\x0b_bleAddress\"}\n\x0bGatewayInfo\x12\x30\n\x07\x65ntries\x18\x01 \x03(\x0b\x32\x1f.wltPb.GatewayInfo.EntriesEntry\x1a<\n\x0c\x45ntriesEntry\x12\x0b\n\x03key\x18\x01 \x01(\t\x12\x1b\n\x05value\x18\x02 \x01(\x0b\x32\x0c.wltPb.Value:\x02\x38\x01\"\x1b\n\x0bGatewayLogs\x12\x0c\n\x04logs\x18\x01 \x03(\t\"\x92\x01\n\x0c\x41\x63tionStatus\x12\x0e\n\x06\x61\x63tion\x18\x01 \x01(\r\x12\x0e\n\x06status\x18\x02 \x01(\r\x12\x11\n\x04step\x18\x03 \x01(\rH\x00\x88\x01\x01\x12\x15\n\x08progress\x18\x04 \x01(\rH\x01\x88\x01\x01\x12\x15\n\x08\x62ridgeId\x18\x05 \x01(\x0cH\x02\x88\x01\x01\x42\x07\n\x05_stepB\x0b\n\t_progressB\x0b\n\t_bridgeId\"\x8e\x02\n\x0f\x44ownlinkMessage\x12#\n\x08txPacket\x18\x01 \x01(\x0b\x32\x0f.wltPb.TxPacketH\x00\x12-\n\rgatewayAction\x18\x02 \x01(\x0b\x32\x14.wltPb.GatewayActionH\x00\x12-\n\rbridgeUpgrade\x18\x03 \x01(\x0b\x32\x14.wltPb.BridgeUpgradeH\x00\x12-\n\rgatewayConfig\x18\x04 \x01(\x0b\x32\x14.wltPb.GatewayConfigH\x00\x12-\n\rcustomMessage\x18\x06 \x01(\x0b\x32\x14.wltPb.CustomMessageH\x00\x42\x06\n\x04typeJ\x04\x08\x05\x10\x06R\x0c\x63ustomBroker\"F\n\x08TxPacket\x12\x0f\n\x07payload\x18\x01 \x01(\x0c\x12\x12\n\nmaxRetries\x18\x02 \x01(\r\x12\x15\n\rmaxDurationMs\x18\x03 \x01(\r\"\x1f\n\rGatewayAction\x12\x0e\n\x06\x61\x63tion\x18\x01 \x01(\t\"\xa5\x01\n\rBridgeUpgrade\x12\x14\n\x0crebootPacket\x18\x01 \x01(\x0c\x12\x17\n\x0ftxMaxDurationMs\x18\x02 \x01(\r\x12\x14\n\x0ctxMaxRetries\x18\x03 \x01(\r\x12\x10\n\x08\x62ridgeId\x18\x04 \x01(\t\x12\x13\n\x0bversionUuid\x18\x05 \x01(\t\x12\x13\n\x0bupgradeBlSd\x18\x06 \x01(\x08\x12\x13\n\x0bimageDirUrl\x18\x07 \x01(\t\"\xc6\x02\n\rGatewayConfig\x12\x14\n\x07version\x18\x01 \x01(\tH\x00\x88\x01\x01\x12\x19\n\x0c\x62leSwVersion\x18\x02 \x01(\tH\x01\x88\x01\x01\x12\x1f\n\x12interfaceSwVersion\x18\x03 \x01(\tH\x02\x88\x01\x01\x12&\n\x08location\x18\x04 \x01(\x0b\x32\x0f.wltPb.LocationH\x03\x88\x01\x01\x12\x30\n\x06\x63onfig\x18\x05 \x03(\x0b\x32 .wltPb.GatewayConfig.ConfigEntry\x1aH\n\x0b\x43onfigEntry\x12\x0b\n\x03key\x18\x01 \x01(\t\x12(\n\x05value\x18\x02 \x01(\x0b\x32\x19.wltPb.GatewayConfigValue:\x02\x38\x01\x42\n\n\x08_versionB\x0f\n\r_bleSwVersionB\x15\n\x13_interfaceSwVersionB\x0b\n\t_location\"\x81\x01\n\rCustomMessage\x12\x32\n\x07\x65ntries\x18\x01 \x03(\x0b\x32!.wltPb.CustomMessage.EntriesEntry\x1a<\n\x0c\x45ntriesEntry\x12\x0b\n\x03key\x18\x01 \x01(\t\x12\x1b\n\x05value\x18\x02 \x01(\x0b\x32\x0c.wltPb.Value:\x02\x38\x01\x62\x06proto3')
 
 _globals = globals()
 _builder.BuildMessageAndEnumDescriptors(DESCRIPTOR, _globals)
@@ -63,22 +63,22 @@ if not _descriptor._USE_C_DESCRIPTORS:
   _globals['_GATEWAYINFO_ENTRIESENTRY']._serialized_end=1450
   _globals['_GATEWAYLOGS']._serialized_start=1452
   _globals['_GATEWAYLOGS']._serialized_end=1479
-  _globals['_ACTIONSTATUS']._serialized_start=1481
-  _globals['_ACTIONSTATUS']._serialized_end=1527
-  _globals['_DOWNLINKMESSAGE']._serialized_start=1530
-  _globals['_DOWNLINKMESSAGE']._serialized_end=1800
-  _globals['_TXPACKET']._serialized_start=1802
-  _globals['_TXPACKET']._serialized_end=1872
-  _globals['_GATEWAYACTION']._serialized_start=1874
-  _globals['_GATEWAYACTION']._serialized_end=1905
-  _globals['_BRIDGEUPGRADE']._serialized_start=1908
-  _globals['_BRIDGEUPGRADE']._serialized_end=2073
-  _globals['_GATEWAYCONFIG']._serialized_start=2076
-  _globals['_GATEWAYCONFIG']._serialized_end=2402
+  _globals['_ACTIONSTATUS']._serialized_start=1482
+  _globals['_ACTIONSTATUS']._serialized_end=1628
+  _globals['_DOWNLINKMESSAGE']._serialized_start=1631
+  _globals['_DOWNLINKMESSAGE']._serialized_end=1901
+  _globals['_TXPACKET']._serialized_start=1903
+  _globals['_TXPACKET']._serialized_end=1973
+  _globals['_GATEWAYACTION']._serialized_start=1975
+  _globals['_GATEWAYACTION']._serialized_end=2006
+  _globals['_BRIDGEUPGRADE']._serialized_start=2009
+  _globals['_BRIDGEUPGRADE']._serialized_end=2174
+  _globals['_GATEWAYCONFIG']._serialized_start=2177
+  _globals['_GATEWAYCONFIG']._serialized_end=2503
   _globals['_GATEWAYCONFIG_CONFIGENTRY']._serialized_start=1171
   _globals['_GATEWAYCONFIG_CONFIGENTRY']._serialized_end=1243
-  _globals['_CUSTOMMESSAGE']._serialized_start=2405
-  _globals['_CUSTOMMESSAGE']._serialized_end=2534
+  _globals['_CUSTOMMESSAGE']._serialized_start=2506
+  _globals['_CUSTOMMESSAGE']._serialized_end=2635
   _globals['_CUSTOMMESSAGE_ENTRIESENTRY']._serialized_start=1390
   _globals['_CUSTOMMESSAGE_ENTRIESENTRY']._serialized_end=1450
 # @@protoc_insertion_point(module_scope)

brg_certificate/wltPb_pb2.pyi

@@ -137,12 +137,18 @@ class GatewayLogs(_message.Message):
     def __init__(self, logs: _Optional[_Iterable[str]] = ...) -> None: ...
 
 class ActionStatus(_message.Message):
-    __slots__ = ("action", "status")
+    __slots__ = ("action", "status", "step", "progress", "bridgeId")
     ACTION_FIELD_NUMBER: _ClassVar[int]
     STATUS_FIELD_NUMBER: _ClassVar[int]
+    STEP_FIELD_NUMBER: _ClassVar[int]
+    PROGRESS_FIELD_NUMBER: _ClassVar[int]
+    BRIDGEID_FIELD_NUMBER: _ClassVar[int]
     action: int
     status: int
-    def __init__(self, action: _Optional[int] = ..., status: _Optional[int] = ...) -> None: ...
+    step: int
+    progress: int
+    bridgeId: bytes
+    def __init__(self, action: _Optional[int] = ..., status: _Optional[int] = ..., step: _Optional[int] = ..., progress: _Optional[int] = ..., bridgeId: _Optional[bytes] = ...) -> None: ...
 
 class DownlinkMessage(_message.Message):
     __slots__ = ("txPacket", "gatewayAction", "bridgeUpgrade", "gatewayConfig", "customMessage")

brg_certificate/wlt_types.py

@@ -109,4 +109,5 @@ class WltPkt():
             self.pkt = ag.SensorData(string)
         # Unparsed pkts
         else:
-            print(f"Unable to parse packet with payload: {string}")
+            # print(f"Unable to parse packet with payload: {string}")
+            pass

gw_certificate/cert_results.py

@@ -39,6 +39,7 @@ def generate_pdf_results_file(gw_cert):
     module_header = STYLES_PDF.get("MODULE_HEADER", ParagraphStyle("Default"))
     test_header = STYLES_PDF.get("TEST_HEADER", ParagraphStyle("Default"))
     text_style_bold = STYLES_PDF.get("BLACK_BOLD", ParagraphStyle("Default"))
+    text_style_centered = STYLES_PDF.get("BLACK", ParagraphStyle("Default"))
     if gw_cert.error:
         title = Paragraph(f"<b>Wiliot Gateway Certificate Error!</b>", red_header)
         hdr_page.append(title)
@@ -50,11 +51,17 @@ def generate_pdf_results_file(gw_cert):
         hdr_page.append(Spacer(1, 20))
         hdr_page.append(Paragraph(f"<b>Summary</b>", module_header))
         hdr_page.append(Spacer(1, 20))
+        hdr_page.append(Paragraph("<u>Run Info:</u>", text_style_bold))
         hdr_page.append(Paragraph(f"Run date: {gw_cert.current_datetime.strftime('%d/%m/%Y, %H:%M:%S')}", text_style_bold))
         hdr_page.append(Paragraph(f"Tests duration: {format_timedelta(gw_cert.runtime())}", text_style_bold))
         hdr_page.append(Paragraph(f"Certificate version: {gw_cert.gw_cert_version}", text_style_bold))
-        hdr_page.append(Paragraph(f"BLE simulator mac: {gw_cert.uart.mac}", text_style_bold))
-        hdr_page.append(Paragraph(f"BLE simulator version: {gw_cert.uart.fw_version}", text_style_bold))
+        hdr_page.append(Spacer(1, 10))
+        if gw_cert.use_uart:
+            hdr_page.append(Paragraph("<u>Certification Kit Info:</u>", text_style_bold))
+            hdr_page.append(Paragraph(f"BLE simulator mac: {gw_cert.uart.mac}", text_style_bold))
+            hdr_page.append(Paragraph(f"BLE simulator version: {gw_cert.uart.fw_version}", text_style_bold))
+            hdr_page.append(Spacer(1, 10))
+        hdr_page.append(Paragraph("<u>Tested Device Info:</u>", text_style_bold))
         hdr_page.append(Paragraph(f"Tested gateway ID: {gw_cert.gw_id}", text_style_bold))
         hdr_page.append(Spacer(1, 20))
 
@@ -73,8 +80,8 @@ def generate_pdf_results_file(gw_cert):
         text_style_center = STYLES_PDF.get("BLACK", ParagraphStyle("Default"))
         text_style_left = STYLES_PDF.get("BLACK_LEFT", ParagraphStyle("Default"))
         for test in gw_cert.tests:
-            summary_data += [[test, pass_or_fail_pdf(test), format_timedelta(test.duration)]]
-            elements.append(Paragraph(f"<b>{test.test_name}</b>", module_header))
+            summary_data += [[Paragraph(f'<a href="#{test}">{test}</a>', text_style_centered), pass_or_fail_pdf(test), format_timedelta(test.duration)]]
+            elements.append(Paragraph(f"<a name='{test}'/><b>{test}</b>", module_header))
             elements.append(Spacer(1, 20))
             elements.append(pass_or_fail_pdf(test))
             elements.append(Spacer(1, 10))

gw_certificate/gw_certificate.py

@@ -81,7 +81,6 @@ class GWCertificate:
             debug_print(f'UART Ports:{self.uart_comports}')
             if len(self.uart_comports) < 1:
                 self.error = "A Wiliot certification kit must be connected to USB!"
-                cert_results.generate_pdf_results_file(self)
                 raise GWCertificateError(self.error)
         
             for port in self.uart_comports:
@@ -92,7 +91,6 @@ class GWCertificate:
                     debug_print(f'Port: {port} - {e}')
             if type(self.uart) is not UARTInterface:
                 self.error = "Cannot initialize any port!"
-                cert_results.generate_pdf_results_file(self)
                 raise GWCertificateError(self.error)
             self.ble_sim = BLESimulator(self.uart)
             self.sniffer = BLESniffer(self.uart, logger_filepath=self.sniffer_logger_filepath)

gw_certificate/gw_certificate_cli.py

@@ -27,8 +27,8 @@ def filter_actions(actions_names):
 def main():
     usage = (
         "usage: wlt-gw-certificate [-h] -owner OWNER -gw GW\n"
-        f"                          [-tests {{connection, uplink, downlink, stress}}] [-update] [-pps {STRESS_DEFAULT_PPS}]\n"
-        "                           [-agg AGG] [-env {prod, test, dev}] [-no-reboot]"
+        f"                          [-tests {{connection, uplink, downlink, actions, stress}}] [-update] [-pps {STRESS_DEFAULT_PPS}]\n"
+        f"                          [-actions {{info, reboot, bridgeota}}] [-agg AGG] [-env {{prod, test, dev}}]"
         )
 
     parser = ArgumentParser(prog='wlt-gw-certificate',
@@ -43,7 +43,7 @@ def main():
                           help="Tests to run. Registration omitted by default.", required=False, nargs='+',
                           default=['connection', 'uplink', 'downlink', 'actions', 'stress'])
     optional.add_argument('-actions', type=str, choices=['info', 'reboot', 'bridgeota'],
-                          help="Action stages to run under ActionsTest", required=False, nargs='+', default=['info', 'reboot', 'ota'])
+                          help="Action stages to run under ActionsTest", required=False, nargs='+', default=['info', 'reboot', 'bridgeota'])
     optional.add_argument('-update', action='store_true', help='Update test board firmware', default=False, required=False)
     optional.add_argument('-pps', type=int, help='Single packets-per-second rate to simulate in the stress test',
                           choices=STRESS_DEFAULT_PPS, default=None, required=False)

gw_certificate/interface/uart_if.py

@@ -167,7 +167,7 @@ class UARTInterface:
     def check_fw_supported(self):
         hex_version = version.parse(os.path.splitext(os.path.basename(LATEST_VERSION_PATH))[0].split('_')[0])
         if self.fw_version >= hex_version:
-            debug_print(f'GW Running version {self.fw_version}')
+            debug_print(f'Certification kit version {self.fw_version}')
             return True
         return False
     

gw_certificate/tests/actions.py

@@ -128,7 +128,7 @@ class BridgeOTAStage(GenericActionsStage):
     def __init__(self, **kwargs):
         super().__init__(**kwargs, stage_name=type(self).__name__)
         self.stage_tooltip = "Issues a bridge OTA action to the gateway. Expects it to upgrade the bridge"
-        self.error_summary = "The target bridge was not upgraded"
+        self.error_summary = "Bridge wasn't upgraded."
         self.action = "Bridge Upgrade"
 
         OTA_VERSIONS_TO_USE = ("4.4.52", "4.4.53")
@@ -195,6 +195,7 @@ class BridgeOTAStage(GenericActionsStage):
 
         # Calculate whether stage pass/failed
         if self.action_status is None or self.status_code != 0:
+            debug_print("Failed to receive an actionStatus message.")
             self.stage_pass = MINIMUM_SCORE
             self.add_to_stage_report(f"The bridge OTA test failed")
             if self.action_status is None:
@@ -204,17 +205,22 @@ class BridgeOTAStage(GenericActionsStage):
             elif self.status_code != 0:
                 self.add_to_stage_report(f"Uploaded actionStatus status value received is {self.status_code}.")
             if self.current_version == self.desired_version:
+                debug_print("Bridge was upgraded successfully")
+                self.error_summary = "Failed to receive actionStatus message."
                 self.add_to_stage_report(f"Note that the bridge was actually upgraded successfully.")
+                self.add_to_stage_report(f"Reboot packet received {(self.reboot_packet_ts - self.start_time).total_seconds():.1f}s after start.")
             self.add_to_stage_report(f"{GW_BRIDGE_OTA_DOC}")
         else:
             if self.current_version == self.desired_version:
                 self.stage_pass = PERFECT_SCORE
+                debug_print("Bridge was upgraded successfully, actionStatus message received")
                 self.add_to_stage_report(f"Bridge was upgraded and an actionStatus message was received from the gateway.")
                 self.add_to_stage_report(f"Action status received {(self.action_status_ts - self.start_time).total_seconds():.1f}s after start.")
                 self.add_to_stage_report(f"Reboot packet received {(self.reboot_packet_ts - self.start_time).total_seconds():.1f}s after start.")
                 self.add_to_stage_report(f"Action status received {(self.action_status_ts - self.reboot_packet_ts).total_seconds():.1f}s after reboot.")
             else:
                 self.stage_pass = MINIMUM_SCORE
+                debug_print("Bridge failed to upgrade")
                 self.add_to_stage_report(f"The bridge OTA test failed")
                 self.add_to_stage_report(f"Uploaded actionStatus message indicated success although the bridge was not upgraded.")
 

gw_certificate/tests/registration.py

@@ -66,6 +66,7 @@ class GenericRegistrationStage(GenericStage):
         debug_print(f"Kick response:{response}")
     
     def validate_kong_logs(self, endpoint:Literal['device-authorize', 'registry', 'token', 'refresh']):
+        message = None
         try:
             message = self.edge.get_kong_logs(self.gw_id)
         except WiliotCloudError as wce:
@@ -78,7 +79,7 @@ class GenericRegistrationStage(GenericStage):
                 return False
             elif status_code == None:
                 raise wce
-        if message.get('status_code') != 200:
+        if isinstance(message, dict) and message.get('status_code') != 200:
             debug_print(f"Failed fetching logs, status_code:{message.get('status_code')}")
             return False