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

brg_certificate/tests/energy2400/signal_indicator_ble5_10_500k_test/signal_indicator_ble5_10_500k_test.py

@@ -0,0 +1,343 @@
+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
+
+# Test Description:
+# This test is to verify the functionality of both signal indicator tx (tx_brg) and rx (rx_brg) at BRG level.
+# rssi_threshold = phase 0 , check the if rssi value is between 0 to -25.
+# brg0_rx_brg1_tx  = phase 1+2
+# phase 1 - One BRG will be configured as signal indicator tx, and the other as signal indicator rx,
+# and we expect to see signal indicator packets only from the rx BRG according to the tx params (repetition and cycle params).
+# phase 2 - Same as phase 1, but with different tx params configured.
+# brg0_none_brg1_rx = phase 3 - One rx BRG without any tx BRG. We don't expect to see any signal indicator packets.
+# This phase is to verify the brg module logic is working properly,
+# and no tag packet is accidentally being treated as signal indicator packet.
+# brg0_rxtx_brg1_rxtx =  phase 4 - Both BRG's will be configured to be transmitters and receivers, with different tx params for each one.
+# we expect to see signal indicator packets from both BRG's, according to the tx params.
+# brg0_tx_brg1_none = phase 5 - One BRG will be configured as signal indicator tx,
+# but no rx, so we don't expect to receive signal indicator packets.
+# that way we can assure the logic within the receiver is not confused by the signal indicator uuid as external sensor.
+
+# Test MACROS #
+NUM_OF_TX_CYCLES = 2
+DEFAULT_SCAN_TIME = 60
+SCAN_DELAY_TIME = 5
+BLE4_LISTEN_PERIOD = 15
+BLE4_BROADCAST_DURATION = BLE4_LISTEN_PERIOD + 1
+
+
+# Test functions #
+def terminate_test(test, phase, revert_rx_brg=False, revert_tx_brg=False, modules=[]):
+    # Temp solution for internal_brg test because test_epilog doesn't support both internal brg and test.brgs
+    utPrint(f"Terminating test (phase={phase})!!!!!!!!\n", "BLUE")
+    if revert_rx_brg:
+        restore_modules = [modules[1]] if (test.internal_brg or phase != 4) else modules
+        restore_modules.append(eval_pkt(f'ModuleDatapathV{test.active_brg.api_version}'))
+        utPrint(f"reverting rx_brg {test.brg1.id_str} to defaults\n", "BOLD")
+        test, response = cert_config.config_brg1_defaults(test, modules=restore_modules, ble5=True)
+        if response == NO_RESPONSE and test.exit_on_param_failure:
+            test.rc = TEST_FAILED
+            test.add_reason(f"BRG {test.brg1.id_str} didn't revert modules "
+                            f"{restore_modules} to default configuration!")
+
+    if revert_tx_brg:
+        restore_modules = [modules[0]] if (test.internal_brg or phase != 4) else modules
+        restore_modules.append(eval_pkt(f'ModuleDatapathV{test.active_brg.api_version}'))
+        utPrint(f"reverting tx_brg {test.brg0.id_str} to defaults\n", "BOLD")
+        test, response = cert_config.config_brg_defaults(test, modules=restore_modules, ble5=True)
+        if response == NO_RESPONSE and test.exit_on_param_failure:
+            test.rc = TEST_FAILED
+            test.add_reason(f"BRG {test.brg0.id_str} didn't revert modules"
+                            f"{restore_modules} to default configuration!")
+    return cert_common.test_epilog(test)
+
+
+def brg0_tx_brg1_none(test, energy2400_module, ext_sensors_module, tx_brg_, rx_brg_, modules):
+    datapath_module = eval_pkt(f'ModuleDatapathV{test.active_brg.api_version}')
+
+    # Phase 5 - Tx BRG without rx. just waiting for packets to be sent from the transmitter and verify
+    # The receiver isn't receiving any signal indicator packets.
+    phase = "brg0_tx_brg1_none"
+    tx_signal_ind_cycle = 15
+    tx_signal_ind_rep = 1
+    utPrint(f"TX BRG without RX - cycle = {tx_signal_ind_cycle}, repetition = {tx_signal_ind_rep}\n", "BLUE")
+    # restore default configuration for receiver #
+    utPrint(f"Configuring BRG {rx_brg_.id_str} to default", "BOLD")
+    restore_modules = [modules[1]] if (test.internal_brg) else modules
+    test = cert_config.config_brg1_defaults(test, modules=restore_modules, ble5=True)[0]
+    print_update_wait(BLE4_BROADCAST_DURATION)  # BLE5 configuration can take up to BLE4_BROADCAST_DURATION sec
+    if test.rc == TEST_FAILED and test.exit_on_param_failure:
+        test.add_reason(f"BRG {rx_brg_.id_str}: didn't revert to default configuration!")
+
+    # configuring transmitter #
+    utPrint(f"Configuring BRG {tx_brg_.id_str} as Signal Indicator Transmitter", "BOLD")
+    test = cert_config.brg1_configure(test=test, module=energy2400_module, fields=[BRG_SIGNAL_INDICATOR_CYCLE, BRG_SIGNAL_INDICATOR_REP],
+                                      values=[tx_signal_ind_cycle, tx_signal_ind_rep], ble5=True)[0]
+    if test.rc == TEST_FAILED:
+        test.add_reason(f"BRG {tx_brg_.id_str}: didn't receive signal indicator transmitter configuration!")
+
+    print_update_wait(BLE4_BROADCAST_DURATION)  # BLE5 configuration can take up to BLE4_BROADCAST_DURATION sec
+    utPrint(f"BRG {tx_brg_.id_str} configured to be transmitter - cycle = {tx_signal_ind_cycle},"
+            f"repetition = {tx_signal_ind_rep}", "BOLD")
+
+    # phase analysis #
+    mqtt_scan_n_create_log_file(test, (NUM_OF_TX_CYCLES * tx_signal_ind_cycle) + SCAN_DELAY_TIME, phase)
+    expected_signal_ind_pkts = [0]
+    received_signal_ind_pkts = cert_common.get_all_sig_ind_pkts(test=test, rx_brg=rx_brg_, tx_brg=tx_brg_)
+    if len(received_signal_ind_pkts) not in expected_signal_ind_pkts:
+        test.rc = TEST_FAILED
+        test.add_reason(f"Phase {phase} failed - received signal indicator packet from BRG {rx_brg_.id_str}")
+
+    # Revert bridges to BLE4 before next loop
+    utPrint(f"reverting rx_brg {test.brg1.id_str} to defaults\n", "BOLD")
+    test, response = cert_config.config_brg1_defaults(test, modules=[datapath_module], ble5=True)
+    if response == NO_RESPONSE and test.exit_on_param_failure:
+        test.rc = TEST_FAILED
+        test.add_reason(f"BRG {test.brg1.id_str} didn't revert datapath_module to default configuration!")
+
+    utPrint(f"reverting tx_brg {test.brg0.id_str} to defaults\n", "BOLD")
+    test, response = cert_config.config_brg_defaults(test, modules=[datapath_module], ble5=True)
+    if response == NO_RESPONSE and test.exit_on_param_failure:
+        test.rc = TEST_FAILED
+        test.add_reason(f"BRG {test.brg0.id_str} didn't revert datapath module to default configuration!")
+
+    # Test epilog
+    return terminate_test(test, phase=phase, revert_rx_brg=True, revert_tx_brg=True, modules=modules)
+
+
+def brg0_rxtx_brg1_rxtx(test, energy2400_module, ext_sensors_module, tx_brg_, rx_brg_, modules):
+    phase = "brg0_rxtx_brg1_rxtx"
+
+    if not test.internal_brg:
+        # Phase 4 - Both BRG's will be configured to be transmitters and receivers, with different tx params for each one.
+        # expecting to see signal indicator packets from both BRG's, according to the tx params.
+        utPrint("Both BRG's are transmitter and receivers, with different values\n", "BLUE")
+
+        # configuring first BRG (tx_brg_) #
+        tx_brg_signal_indicator_cycle = 15
+        tx_brg_signal_indicator_rep = 3
+        # configuring first brg (tx_brg_) as receiver
+        utPrint(f"Configuring BRG {tx_brg_.id_str} as Signal Indicator Receiver", "BOLD")
+        cert_config.brg_configure_ble5(test=test, module=ext_sensors_module, fields=[BRG_SENSOR0],
+                                       values=[ag.EXTERNAL_SENSORS_SIGNAL_INDICATOR], wait=False)
+        print_update_wait(BLE4_BROADCAST_DURATION)  # BLE5 configuration can take up to BLE4_BROADCAST_DURATION sec
+        utPrint(f"BRG {tx_brg_.id_str} successfully configured as Signal Indicator Receiver\n", "BOLD")
+
+        # configuring transmitter #
+        utPrint(f"Configuring BRG {tx_brg_.id_str} as Signal Indicator Transmitter", "BOLD")
+        test = cert_config.brg_configure(test=test, module=energy2400_module,
+                                         fields=[BRG_SIGNAL_INDICATOR_CYCLE, BRG_SIGNAL_INDICATOR_REP],
+                                         values=[tx_brg_signal_indicator_cycle, tx_brg_signal_indicator_rep])[0]
+        if test.rc == TEST_FAILED:
+            test.add_reason(f"BRG {tx_brg_.id_str}: didn't receive signal indicator transmitter configuration!")
+
+        print_update_wait(BLE4_BROADCAST_DURATION)  # BLE5 configuration can take up to BLE4_BROADCAST_DURATION sec
+        utPrint(f"BRG {tx_brg_.id_str} configured to be transmitter - cycle = {tx_brg_signal_indicator_cycle},"
+                f"repetition = {tx_brg_signal_indicator_rep}", "BOLD")
+
+        # configuring second brg (rx_brg_) as receiver
+        utPrint(f"Configuring BRG {rx_brg_.id_str} as Signal Indicator Receiver", "BOLD")
+        test = cert_config.brg1_configure(test=test, module=ext_sensors_module,
+                                          fields=[BRG_SENSOR0], values=[ag.EXTERNAL_SENSORS_SIGNAL_INDICATOR], ble5=True)[0]
+        print_update_wait(BLE4_BROADCAST_DURATION)  # BLE5 configuration can take up to BLE4_BROADCAST_DURATION sec
+        utPrint(f"BRG {rx_brg_.id_str} successfully configured as Signal Indicator Receiver\n", "BOLD")
+
+        # configuring second brg (rx_brg_) as transmitter
+        utPrint(f"Configuring BRG {rx_brg_.id_str} as Signal Indicator Transmitter", "BOLD")
+        rx_brg_signal_indicator_cycle = 15
+        rx_brg_signal_indicator_rep = 4
+        test = cert_config.brg1_configure(test=test, module=energy2400_module,
+                                          fields=[BRG_SIGNAL_INDICATOR_CYCLE, BRG_SIGNAL_INDICATOR_REP],
+                                          values=[rx_brg_signal_indicator_cycle, rx_brg_signal_indicator_rep], ble5=True)[0]
+        print_update_wait(BLE4_BROADCAST_DURATION)  # BLE5 configuration can take up to BLE4_BROADCAST_DURATION sec
+        if test.rc == TEST_FAILED:
+            test.add_reason(f"BRG {tx_brg_.id_str}: didn't receive signal indicator transmitter configuration!")
+        utPrint(f"BRG {tx_brg_.id_str} configured to be transmitter - cycle = {rx_brg_signal_indicator_cycle},"
+                f"repetition = {rx_brg_signal_indicator_rep}")
+
+        # phase analysis #
+        mqtt_scan_n_create_log_file(test,
+                                    NUM_OF_TX_CYCLES * max(tx_brg_signal_indicator_cycle, rx_brg_signal_indicator_cycle) + SCAN_DELAY_TIME,
+                                    phase)
+
+        # Analyzing tx_brg_ performance as receiver
+        utPrint(f"Analyzing tx_brg {tx_brg_.id_str} performance as a Receiver\n", "BOLD")
+        rx_brg_tx_cycles = max(tx_brg_signal_indicator_cycle, rx_brg_signal_indicator_cycle) / rx_brg_signal_indicator_cycle
+        expected_signal_ind_pkts = [int(x * rx_brg_tx_cycles) for x in cert_common.exp_sig_ind_pkts(rx_brg_, tx_brg_, NUM_OF_TX_CYCLES)]
+        received_signal_ind_pkts = cert_common.get_all_sig_ind_pkts(test=test, rx_brg=tx_brg_, tx_brg=rx_brg_)
+        txt = f"""Phase {phase} - BRG {tx_brg_.id_str} signal indicator packets: received {len(received_signal_ind_pkts)} packets,"
+              " expected {expected_signal_ind_pkts} packets"""
+        print(txt)
+        if len(received_signal_ind_pkts) not in expected_signal_ind_pkts:
+            test.rc = TEST_FAILED
+            test.add_reason(txt)
+
+        # Analyzing rx_brg_ performance as receiver
+        utPrint(f"Analyzing rx_brg {rx_brg_.id_str} performance as a Receiver\n", "BOLD")
+        tx_brg_tx_cycles = max(tx_brg_signal_indicator_cycle, rx_brg_signal_indicator_cycle) / tx_brg_signal_indicator_cycle
+        expected_signal_ind_pkts = [int(x * tx_brg_tx_cycles) for x in cert_common.exp_sig_ind_pkts(rx_brg_, tx_brg_)]
+        received_signal_ind_pkts = cert_common.get_all_sig_ind_pkts(test=test, rx_brg=rx_brg_, tx_brg=tx_brg_)
+        txt = f"""Phase {phase} - BRG {rx_brg_.id_str} signal indicator packets: received {len(received_signal_ind_pkts)}"
+              " packets, expected {expected_signal_ind_pkts} packets"""
+        print(txt)
+        if len(received_signal_ind_pkts) not in expected_signal_ind_pkts:
+            test.rc = TEST_FAILED
+            test.add_reason(txt)
+    else:
+        test.add_reason("skip for internal BRG")
+    return terminate_test(test, phase=phase, revert_rx_brg=True, revert_tx_brg=True, modules=modules)
+
+
+def brg0_none_brg1_rx(test, energy2400_module, ext_sensors_module, tx_brg_, rx_brg_, modules):
+    phase = "brg0_none_brg1_rx"
+    # Phase 3 - Rx BRG without tx.Expecting no signal indicator packets to be received.
+    tx_signal_ind_cycle = ag.BRG_DEFAULT_SIGNAL_INDICATOR_CYCLE
+    tx_signal_ind_rep = ag.BRG_DEFAULT_SIGNAL_INDICATOR_REP
+    utPrint(f"RX BRG without TX- cycle = {tx_signal_ind_cycle}, repetition = {tx_signal_ind_rep}\n", "BLUE")
+
+    # configuring transmitter #
+    utPrint(f"Configuring BRG {tx_brg_.id_str} as Signal Indicator Transmitter", "BOLD")
+    test = cert_config.brg1_configure(test=test, module=energy2400_module, fields=[BRG_SIGNAL_INDICATOR_CYCLE, BRG_SIGNAL_INDICATOR_REP],
+                                      values=[tx_signal_ind_cycle, tx_signal_ind_rep], ble5=True)[0]
+    print_update_wait(BLE4_BROADCAST_DURATION)  # BLE5 configuration can take up to BLE4_BROADCAST_DURATION sec
+    if test.rc == TEST_FAILED:
+        test.add_reason(f"BRG {tx_brg_.id_str}: didn't receive signal indicator transmitter configuration!")
+    utPrint(f"BRG {tx_brg_.id_str} configured to default!!! cycle = {tx_signal_ind_cycle},"f"repetition = {tx_signal_ind_rep}", "BOLD")
+
+    # phase analysis #
+    mqtt_scan_n_create_log_file(test, DEFAULT_SCAN_TIME, phase)
+    expected_signal_ind_pkts = [0]
+    received_signal_ind_pkts = cert_common.get_all_sig_ind_pkts(test=test, rx_brg=rx_brg_, tx_brg=tx_brg_)
+    if len(received_signal_ind_pkts) not in expected_signal_ind_pkts:
+        test.rc = TEST_FAILED
+        test.add_reason(f"Phase {phase} failed - received signal indicator packet from BRG"
+                        f"{rx_brg_.id_str}")
+    return terminate_test(test, phase=phase, revert_rx_brg=True, revert_tx_brg=True, modules=modules)
+
+
+def brg0_rx_brg1_tx(test, energy2400_module, ext_sensors_module, tx_brg_, rx_brg_, modules):
+    phase = "brg0_rx_brg1_tx"
+    cycle_rep = [(30, 3), (60, 4)]
+    for tx_signal_ind_cycle, tx_signal_ind_rep in cycle_rep:
+
+        utPrint(f"TX BRG with RX- cycle = {tx_signal_ind_cycle}, repetition = {tx_signal_ind_rep}\n", "BLUE")
+        # configuring receiver #
+        utPrint(f"Configuring BRG {rx_brg_.id_str} as Signal Indicator Receiver", "BOLD")
+        test = cert_config.brg_configure(test=test, module=energy2400_module,
+                                         fields=[BRG_SIGNAL_INDICATOR_CYCLE, BRG_SIGNAL_INDICATOR_REP],
+                                         values=[tx_signal_ind_cycle, tx_signal_ind_rep])[0]
+        if test.rc == TEST_FAILED:
+            test.add_reason(f"BRG {tx_brg_.id_str}: didn't receive signal indicator transmitter configuration!")
+
+        # configuring transmitter #
+        utPrint(f"Configuring BRG {tx_brg_.id_str} as Signal Indicator Transmitter", "BOLD")
+        test = cert_config.brg1_configure(test=test, module=energy2400_module,
+                                          fields=[BRG_SIGNAL_INDICATOR_CYCLE, BRG_SIGNAL_INDICATOR_REP],
+                                          values=[tx_signal_ind_cycle, tx_signal_ind_rep], ble5=True)[0]
+        print_update_wait(BLE4_BROADCAST_DURATION)  # BLE5 configuration can take up to BLE4_BROADCAST_DURATION sec
+        if test.rc == TEST_FAILED:
+            test.add_reason(f"BRG {tx_brg_.id_str}: didn't receive signal indicator transmitter configuration!")
+
+        utPrint(f"BRG {tx_brg_.id_str} configured to be transmitter - cycle={tx_signal_ind_cycle}, repetition={tx_signal_ind_rep}", "BOLD")
+
+        # phase analysis
+        mqtt_scan_n_create_log_file(test, (NUM_OF_TX_CYCLES * tx_signal_ind_cycle) + SCAN_DELAY_TIME, phase)
+        expected_signal_ind_pkts = cert_common.exp_sig_ind_pkts(tx_brg_, rx_brg_, NUM_OF_TX_CYCLES)
+        received_signal_ind_pkts = cert_common.get_all_sig_ind_pkts(test=test, rx_brg=rx_brg_, tx_brg=tx_brg_)
+        txt = f"""Phase {phase} - BRG {rx_brg_.id_str} signal indicator packets: received {len(received_signal_ind_pkts)} packets,"
+               expected {expected_signal_ind_pkts} packets"""
+        print(txt)
+        # TODO: change condition
+        if len(received_signal_ind_pkts) not in expected_signal_ind_pkts:
+            test.rc = TEST_FAILED
+            test.add_reason(txt)
+        return terminate_test(test, phase=phase, revert_rx_brg=True, revert_tx_brg=True, modules=modules)
+
+
+def rssi_threshold(test, energy2400_module, ext_sensors_module, tx_brg_, rx_brg_, modules):
+    phase = "rssi_threshold"
+    # RSSI Threshold
+    rssi_threshold = -25
+    tx_signal_ind_cycle = 15
+    tx_signal_ind_rep = 3
+    utPrint(f"TX BRG with RX- cycle = {tx_signal_ind_cycle}, repetition = {tx_signal_ind_rep}\n", "BLUE")
+
+    # configuring receiver #
+    utPrint(f"Configuring BRG {rx_brg_.id_str} as Signal Indicator Receiver with RSSI Threshold of {rssi_threshold}", "BOLD")
+    test = cert_config.brg1_configure(test=test, module=ext_sensors_module, fields=[BRG_SENSOR0, BRG_RSSI_THRESHOLD],
+                                      values=[ag.EXTERNAL_SENSORS_SIGNAL_INDICATOR, rssi_threshold], ble5=True)[0]
+    print_update_wait(BLE4_BROADCAST_DURATION)  # BLE5 configuration can take up to BLE4_BROADCAST_DURATION sec
+
+    if test.rc == TEST_FAILED and test.exit_on_param_failure:
+        test.add_reason(f"BRG {rx_brg_.id_str}: didn't receive signal indicator receiver configuration!")
+
+    # configuring transmitter #
+    utPrint(f"Configuring BRG {tx_brg_.id_str} as Signal Indicator Transmitter", "BOLD")
+    test = cert_config.brg1_configure(test=test, module=energy2400_module, fields=[BRG_SIGNAL_INDICATOR_CYCLE, BRG_SIGNAL_INDICATOR_REP],
+                                      values=[tx_signal_ind_cycle, tx_signal_ind_rep], ble5=True)[0]
+    print_update_wait(BLE4_BROADCAST_DURATION)  # BLE5 configuration can take up to BLE4_BROADCAST_DURATION sec
+    if test.rc == TEST_FAILED:
+        test.add_reason(f"BRG {tx_brg_.id_str}: didn't receive signal indicator transmitter configuration!")
+
+    utPrint(f"BRG {tx_brg_.id_str} configured to be transmitter - cycle = {tx_signal_ind_cycle},"
+            f"repetition = {tx_signal_ind_rep}", "BOLD")
+    # phase analysis #
+    mqtt_scan_n_create_log_file(test, (NUM_OF_TX_CYCLES * tx_signal_ind_cycle) + SCAN_DELAY_TIME, phase)
+    received_signal_ind_pkts = cert_common.get_all_sig_ind_pkts(test=test, rx_brg=rx_brg_, tx_brg=tx_brg_)
+    rssi_threshold_viloation_pkts = [p for p in received_signal_ind_pkts if p[RSSI] >= -1 * rssi_threshold]
+    if rssi_threshold_viloation_pkts:
+        test.rc = TEST_FAILED
+        test.add_reason(f"rssi_threshold phase failed - BRG {rx_brg_.id_str} echoed"
+                        f" {len(rssi_threshold_viloation_pkts)} signal indicator packets\n with RSSI weaker than {rssi_threshold}")
+    field_functionality_pass_fail_print(test, 'phase', phase)
+
+    return terminate_test(test, phase=phase, revert_rx_brg=True, revert_tx_brg=True, modules=modules)
+
+
+SIGNAL_INDICATOR_TEST_MAP = {
+    "rssi_threshold": rssi_threshold,  # phase 0
+    "brg0_rx_brg1_tx": brg0_rx_brg1_tx,  # phase 1 + 2
+    "brg0_none_brg1_rx": brg0_none_brg1_rx,  # phase 3
+    "brg0_rxtx_brg1_rxtx": brg0_rxtx_brg1_rxtx,  # phase 4, skip for internal brg
+    "brg0_tx_brg1_none": brg0_tx_brg1_none}  # phase 5
+
+
+def run(test):
+
+    # Test modules evaluation #
+    energy2400_module = eval_pkt(f'ModuleEnergy2400V{test.active_brg.api_version}')
+    ext_sensors_module = eval_pkt(f'ModuleExtSensorsV{test.active_brg.api_version}')
+    datapath_module = eval_pkt(f'ModuleDatapathV{test.active_brg.api_version}')
+
+    # Transmitter related defines #
+    tx_brg_ = test.brg0
+    tx_module = energy2400_module
+
+    # Receiver related defines #
+    rx_brg_ = test.brg1
+
+    # Modules list #
+    modules = [tx_module, ext_sensors_module]
+
+    # Test prolog
+    test = cert_common.test_prolog(test)
+    test = cert_config.brg_configure(test, fields=[BRG_RX_CHANNEL], values=[ag.RX_CHANNEL_10_500K], module=datapath_module)[0]
+    test = cert_config.brg1_configure(test, fields=[BRG_RX_CHANNEL], values=[ag.RX_CHANNEL_10_500K], module=datapath_module)[0]
+    if test.rc == TEST_FAILED and test.exit_on_param_failure:
+        return terminate_test(test, phase=1, revert_rx_brg=True, revert_tx_brg=True, modules=modules)
+    for param in test.params:
+        functionality_run_print(param.name)
+        test = SIGNAL_INDICATOR_TEST_MAP[param.value](test, energy2400_module, ext_sensors_module, tx_brg_, rx_brg_, modules)
+        generate_log_file(test, param.name)
+        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:
+            break
+        else:
+            test.reset_result()
+
+    return cert_common.test_epilog(test, revert_brgs=True, modules=[energy2400_module, ext_sensors_module],
+                                   brg1_modules=[energy2400_module, ext_sensors_module])

brg_certificate/tests/energy2400/signal_indicator_sub1g_2_4_test/signal_indicator_sub1g_2_4_test.json

@@ -1,13 +1,20 @@
 {
-    "name": "signal_indicator_functionality_sub1g_2_4_test",
-    "module": "energy2400",
-    "purpose": "TODO",
-    "documentaion": "<TEST_DOCUMENTATION_LINK>",
-    "initialCondition": "TODO",
-    "procedure": ["Test prolog", "TODO", "Test epilog"],
-    "expectedOutcome": "TODO",
+    "name": "Signal Indicator 2.4 & Sub1g Sync",
+    "module": "Energizer 2.4GHz",
+    "purpose": "Verify the signal indicator tx sync mechanism when transmitting in both sub1g & 2.4 GHz bands.",
+    "documentation": "<TEST_DOCUMENTATION_LINK>",
+    "initialCondition": "1 GW and at least 1 BRG (tx brg) connected to the GW.",
+    "procedure": ["Test prolog",
+                  "Configure rx BRG to receive signal indicator packets (can be BRG or internal BRG)",
+                  "Configure tx BRG to transmit signal indicator 2.4 GHz packets",
+                  "Configure tx BRG to transmit signal indicator sub1g packets with same repetitions & cycle time as 2.4 GHz",
+                  "Scan packets for 3 cycles",
+                  "Verify same number of packets received in both sub1g & 2.4 GHz bands",
+                  "Test epilog"],
+    "expectedOutcome": "Sync mechanism should work correctly, with the same number of packets received in both sub1g & 2.4 GHz bands.",
     "mandatory": 0,
     "multiBridgeTest": 1,
     "gwOnlyTest": 0,
+    "internalBridge": 1,
     "allSupportedValues": []
 }

brg_certificate/tests/energy2400/signal_indicator_sub1g_2_4_test/signal_indicator_sub1g_2_4_test.py

@@ -1,4 +1,3 @@
-import random
 from brg_certificate.cert_prints import *
 from brg_certificate.cert_defines import *
 import brg_certificate.cert_common as cert_common
@@ -7,43 +6,26 @@ from brg_certificate.wlt_types import *
 
 
 # Test MACROS #
-DEFAULT_HDR = ag.Hdr(group_id=ag.GROUP_ID_GW2BRG)
 NUM_OF_SCANNING_CYCLE = 3
 DEFAULT_SCAN_TIME = 60
 SCAN_DELAY_TIME = 5
-BOARD_TYPES_2_POLARIZATION_ANT_LIST = [ag.BOARD_TYPE_MINEW_SINGLE_BAND_V0, ag.BOARD_TYPE_MINEW_DUAL_BAND_V0, ag.BOARD_TYPE_ENERGOUS_V2, ag.BOARD_TYPE_ERM_V0, ag.BOARD_TYPE_ERM_V1]
 ANTENNA_TYPE_2_4 = 0
 ANTENNA_TYPE_SUB1G = 1
-ANTENNA_TYPE_IDX = 21
 
-# Test functions #
-def mqtt_scan_n_create_log_file(test, duration):
-    test.mqttc.flush_pkts()
-    mqtt_scan_wait(test, duration=duration)
-    generate_log_file(test, "15&4")
-
-def get_all_signal_ind_pkt(test=None, rx_brg=None, tx_brg=None):
-    if rx_brg == test.brg1:
-        all_sensor_packets = cert_mqtt.get_all_brg1_ext_sensor_pkts(mqttc=test.mqttc, test=test)
-    elif rx_brg == test.brg0:
-        all_sensor_packets = cert_mqtt.get_all_sensor_pkts(mqttc=test.mqttc, test=test)
-    signal_ind_pkts = []
-    for p in all_sensor_packets:
-        if p[SENSOR_UUID] == "{:06X}".format(ag.SENSOR_SERVICE_ID_SIGNAL_INDICATOR) and p[BRIDGE_ID] == rx_brg.id_str and (p[SENSOR_ID] == tx_brg.id_alias or p[SENSOR_ID] == tx_brg.id_str):
-            signal_ind_pkts.append(p)
-    return signal_ind_pkts
 
+# Test functions #
 def expected_signal_ind_pkts_calc(tx_brg, rx_brg, antenna_type):
-    if (antenna_type == ANTENNA_TYPE_2_4 and tx_brg.board_type in BOARD_TYPES_2_POLARIZATION_ANT_LIST):
+    if (antenna_type == ANTENNA_TYPE_2_4 and tx_brg.board_type in cert_common.dual_polarization_ant_boards_get()):
         tx_brg_ant_polarization_num = 2
     else:
         tx_brg_ant_polarization_num = 1
-    if (antenna_type == ANTENNA_TYPE_2_4 and rx_brg.board_type in BOARD_TYPES_2_POLARIZATION_ANT_LIST):
+    if (antenna_type == ANTENNA_TYPE_2_4 and rx_brg.board_type in cert_common.dual_polarization_ant_boards_get()):
         rx_brg_ant_polarization_num = 2
     else:
         rx_brg_ant_polarization_num = 1
     return NUM_OF_SCANNING_CYCLE * tx_brg_ant_polarization_num * rx_brg_ant_polarization_num
 
+
 def terminate_test(test, revert_rx_brg=False, revert_tx_brg=False, rx_modules=[], tx_modules=[]):
     # Temp solution for internal_brg test because test_epilog doesn't support both internal brg and test.brgs
     utPrint("Terminating test!!!!!!!!\n", "BLUE")
@@ -54,7 +36,7 @@ def terminate_test(test, revert_rx_brg=False, revert_tx_brg=False, rx_modules=[]
         if response == NO_RESPONSE and test.exit_on_param_failure:
             test.rc = TEST_FAILED
             test.add_reason(f"BRG {test.brg1.id_str} didn't revert modules "
-                                   f"{restore_modules} to default configuration!")
+                            f"{restore_modules} to default configuration!")
 
     if revert_tx_brg:
         restore_modules = tx_modules
@@ -63,16 +45,17 @@ def terminate_test(test, revert_rx_brg=False, revert_tx_brg=False, rx_modules=[]
         if response == NO_RESPONSE and test.exit_on_param_failure:
             test.rc = TEST_FAILED
             test.add_reason(f"BRG {test.brg0.id_str} didn't revert modules"
-                                   f"{restore_modules} to default configuration!")
+                            f"{restore_modules} to default configuration!")
     return cert_common.test_epilog(test)
 
+
 # Test execution #
 def run(test):
 
     # Test modules evaluation #
-    energy2400_module = eval(f'ModuleEnergy2400V{test.active_brg.api_version}')
-    ext_sensors_module = eval(f'ModuleExtSensorsV{test.active_brg.api_version}')
-    energy_sub1g_module = eval(f'ModuleEnergySub1GV{test.active_brg.api_version}')
+    energy2400_module = eval_pkt(f'ModuleEnergy2400V{test.active_brg.api_version}')
+    ext_sensors_module = eval_pkt(f'ModuleExtSensorsV{test.active_brg.api_version}')
+    energy_sub1g_module = eval_pkt(f'ModuleEnergySub1GV{test.active_brg.api_version}')
 
     # Transmitter related defines #
     tx_brg_ = test.brg0
@@ -86,68 +69,73 @@ def run(test):
         return terminate_test(test)
 
     tx_signal_ind_cycle, tx_signal_ind_rep = 15, 4
-    utPrint(f"TX BRG with RX- cycle = {tx_signal_ind_cycle}, repetition = {tx_signal_ind_rep}\n", "HEADER")
+    utPrint(f"TX BRG in both sub1g & 2.4 - cycle = {tx_signal_ind_cycle}, repetition = {tx_signal_ind_rep}\n", "HEADER")
 
     # configuring receiver #
     utPrint(f"Configuring BRG {rx_brg_.id_str} as Signal Indicator Receiver", "BOLD")
-    test =  cert_config.brg1_configure(test=test, module=ext_sensors_module, fields=[BRG_SENSOR0], values=[ag.EXTERNAL_SENSORS_SIGNAL_INDICATOR])[0]
+    test = cert_config.brg1_configure(test=test, module=ext_sensors_module, fields=[BRG_SENSOR0],
+                                      values=[ag.EXTERNAL_SENSORS_SIGNAL_INDICATOR])[0]
     if test.rc == TEST_FAILED and test.exit_on_param_failure:
         test.add_reason(f"BRG {rx_brg_.id_str}: didn't receive signal indicator receiver configuration!")
         return terminate_test(test, revert_rx_brg=True, rx_modules=[ext_sensors_module])
-    utPrint(f"BRG {rx_brg_.id_str} succesfully configured to be receiver", "GREEN")
+    utPrint(f"BRG {rx_brg_.id_str} successfully configured to be receiver", "GREEN")
 
     # configuring transmitter 2_4 #
     utPrint(f"Configuring BRG {tx_brg_.id_str} as Signal Indicator 2_4 Transmitter", "BOLD")
-    transmitter_cfg_pkt_2_4 = WltPkt(hdr=DEFAULT_HDR, pkt=energy2400_module(seq_id=random.randrange(99), brg_mac=tx_brg_.id_int, signal_indicator_cycle=tx_signal_ind_cycle, signal_indicator_rep=tx_signal_ind_rep))
-    test = cert_config.brg_configure(test=test, cfg_pkt=transmitter_cfg_pkt_2_4)[0]
+    test = cert_config.brg_configure(test, fields=[BRG_SIGNAL_INDICATOR_CYCLE, BRG_SIGNAL_INDICATOR_REP],
+                                     values=[tx_signal_ind_cycle, tx_signal_ind_rep], module=energy2400_module)[0]
     if test.rc == TEST_FAILED and test.exit_on_param_failure:
         test.add_reason(f"BRG {tx_brg_.id_str}: didn't receive signal indicator 2_4 transmitter configuration!")
-        return terminate_test(test, revert_rx_brg=True,revert_tx_brg=True)
-    utPrint(f"BRG {tx_brg_.id_str} succesfully configured to be 2_4 transmitter - cycle = {tx_signal_ind_cycle},"
-              f"repetition = {tx_signal_ind_rep}", "GREEN")
-    
+        return terminate_test(test, revert_rx_brg=True, revert_tx_brg=True)
+    utPrint(f"BRG {tx_brg_.id_str} successfully configured to be 2_4 transmitter - cycle = {tx_signal_ind_cycle},"
+            f"repetition = {tx_signal_ind_rep}", "GREEN")
+
     # configuring transmitter sub1g #
     utPrint(f"Configuring BRG {tx_brg_.id_str} as Signal Indicator sub1g Transmitter", "BOLD")
-    transmitter_cfg_pkt_sub1g = WltPkt(hdr=DEFAULT_HDR, pkt=energy_sub1g_module(seq_id=random.randrange(99), brg_mac=tx_brg_.id_int, signal_indicator_cycle=tx_signal_ind_cycle, signal_indicator_rep=tx_signal_ind_rep, pattern=ag.SUB1G_ENERGY_PATTERN_ISRAEL))
-    test = cert_config.brg_configure(test=test, cfg_pkt=transmitter_cfg_pkt_sub1g)[0]
+    test = cert_config.brg_configure(test, fields=[BRG_SIGNAL_INDICATOR_CYCLE, BRG_SIGNAL_INDICATOR_REP, BRG_DUTY_CYCLE],
+                                     values=[tx_signal_ind_cycle, tx_signal_ind_rep, 0],
+                                     module=energy_sub1g_module)[0]
     if test.rc == TEST_FAILED and test.exit_on_param_failure:
         test.add_reason(f"BRG {tx_brg_.id_str}: didn't receive signal indicator sub1g transmitter configuration!")
-        return terminate_test(test, revert_rx_brg=True,revert_tx_brg=True, rx_modules=[ext_sensors_module], tx_modules=[energy2400_module, energy_sub1g_module])
-    utPrint(f"BRG {tx_brg_.id_str} succesfully configured to be Sub1g transmitter - cycle = {tx_signal_ind_cycle},"
-              f"repetition = {tx_signal_ind_rep}, EP = {ag.SUB1G_ENERGY_PATTERN_ISRAEL}", "GREEN")
-    
+        return terminate_test(test, revert_rx_brg=True, revert_tx_brg=True, rx_modules=[ext_sensors_module],
+                              tx_modules=[energy2400_module, energy_sub1g_module])
+    utPrint(f"BRG {tx_brg_.id_str} successfully configured to be Sub1g transmitter - cycle = {tx_signal_ind_cycle},"
+            f"repetition = {tx_signal_ind_rep}, EP = {ag.SUB1G_ENERGY_PATTERN_ISRAEL}", "GREEN")
+
     # analysis #
     mqtt_scan_n_create_log_file(test, (NUM_OF_SCANNING_CYCLE * tx_signal_ind_cycle) + SCAN_DELAY_TIME)
-    received_signal_ind_pkts = get_all_signal_ind_pkt(test=test, rx_brg=rx_brg_, tx_brg=tx_brg_)
+    received_signal_ind_pkts = cert_common.get_all_sig_ind_pkts(test=test, rx_brg=rx_brg_, tx_brg=tx_brg_)
     expected_signal_ind_2_4_pkts = expected_signal_ind_pkts_calc(tx_brg_, rx_brg_, ANTENNA_TYPE_2_4)
     expected_signal_ind_sub1g_pkts = expected_signal_ind_pkts_calc(tx_brg_, rx_brg_, ANTENNA_TYPE_SUB1G)
     signal_indicator_2_4_packets = 0
     signal_indicator_sub1g_packets = 0
     for p in received_signal_ind_pkts:
-        if int(p[PAYLOAD][ANTENNA_TYPE_IDX]) == ANTENNA_TYPE_SUB1G and p[SENSOR_ID] == tx_brg_.id_str:
+        if p[SENSOR_PKT].pkt.antenna_type == ANTENNA_TYPE_SUB1G and p[SENSOR_ID] == tx_brg_.id_str:
             signal_indicator_sub1g_packets += 1
-        elif int(p[PAYLOAD][ANTENNA_TYPE_IDX]) == ANTENNA_TYPE_2_4 and p[SENSOR_ID] == tx_brg_.id_alias:
+        elif p[SENSOR_PKT].pkt.antenna_type == ANTENNA_TYPE_2_4 and p[SENSOR_ID] == tx_brg_.id_alias:
             signal_indicator_2_4_packets += 1
-    utPrint(f"Received {signal_indicator_2_4_packets} 2_4 signal indicator packets and {signal_indicator_sub1g_packets} subg signal indicator packets", "BLUE")
+    utPrint(f"Received {signal_indicator_2_4_packets} 2_4 signal indicator packets"
+            f" and {signal_indicator_sub1g_packets} sub1g signal indicator packets", "BLUE")
 
     # Test evaluation #
-    if len(received_signal_ind_pkts) < expected_signal_ind_2_4_pkts + expected_signal_ind_sub1g_pkts:
+    if len(received_signal_ind_pkts) != expected_signal_ind_2_4_pkts + expected_signal_ind_sub1g_pkts:
         test.rc = TEST_FAILED
         test.add_reason(f"Test failed - BRG {rx_brg_.id_str} received wrong number of "
-                                    f"total signal indicator packets\n received {len(received_signal_ind_pkts)} packets, "
-                                    f"expected {expected_signal_ind_2_4_pkts + expected_signal_ind_sub1g_pkts} packets")
-    elif signal_indicator_2_4_packets < expected_signal_ind_2_4_pkts:
+                        f"total signal indicator packets\n received {len(received_signal_ind_pkts)} packets, "
+                        f"expected {expected_signal_ind_2_4_pkts + expected_signal_ind_sub1g_pkts} packets")
+    elif signal_indicator_2_4_packets != expected_signal_ind_2_4_pkts:
         test.rc = TEST_FAILED
         test.add_reason(f"Test failed - BRG {rx_brg_.id_str} received wrong number of "
-                                f"signal indicator 2.4 packets\n received {signal_indicator_2_4_packets} packets, "
-                                f"expected {expected_signal_ind_2_4_pkts} packets")
-    elif signal_indicator_sub1g_packets < expected_signal_ind_sub1g_pkts:
+                        f"signal indicator 2.4 packets\n received {signal_indicator_2_4_packets} packets, "
+                        f"expected {expected_signal_ind_2_4_pkts} packets")
+    elif signal_indicator_sub1g_packets != expected_signal_ind_sub1g_pkts:
         test.rc = TEST_FAILED
         test.add_reason(f"Test failed - BRG {rx_brg_.id_str} received wrong number of "
-                                f"signal indicator sub1g packets\n received {signal_indicator_sub1g_packets} packets, "
-                                f"expected {expected_signal_ind_sub1g_pkts} packets")
+                        f"signal indicator sub1g packets\n received {signal_indicator_sub1g_packets} packets, "
+                        f"expected {expected_signal_ind_sub1g_pkts} packets")
 
-    field_functionality_pass_fail_print(test,'Signal Indicator Functionality 2_4 & Sub1g')
+    field_functionality_pass_fail_print(test, 'Signal Indicator Functionality 2_4 & Sub1g')
 
     # Test epilog
-    return terminate_test(test, revert_rx_brg=False,revert_tx_brg=True, rx_modules=[ext_sensors_module], tx_modules=[energy2400_module, energy_sub1g_module])
+    return terminate_test(test, revert_rx_brg=False, revert_tx_brg=True,
+                          rx_modules=[ext_sensors_module], tx_modules=[energy2400_module, energy_sub1g_module])

brg_certificate/tests/energy2400/signal_indicator_test/signal_indicator_test.json

@@ -1,13 +1,20 @@
 {
-    "name": "signal_indicator_functionality_test",
-    "module": "energy2400",
-    "purpose": "TODO",
-    "documentaion": "<TEST_DOCUMENTATION_LINK>",
-    "initialCondition": "TODO",
-    "procedure": ["Test prolog", "TODO", "Test epilog"],
-    "expectedOutcome": "TODO",
+    "name": "Signal Indicator",
+    "module": "Energizer 2.4GHz",
+    "purpose": "Test functionality for supported Energizer 2.4GHz signal indicator cycle & repetitions sets of values",
+    "documentation": "https://community.wiliot.com/customers/s/article/Wiliot-Network-Energizing-2-4Ghz",
+    "initialCondition": "Bridge configured to defaults",
+    "procedure": ["Test prolog",
+    "rssi_threshold - check the if rssi value is between 0 to -25.",
+    "brg0_rx_brg1_tx - one brg is transmitter and the second is receiver, we expect to get the same values from the receiver, according to the tx params",
+    "brg0_none_brg1_rx - One rx BRG without any tx BRG. We don't expect to see any signal indicator packets.",
+    "brg0_rxtx_brg1_rxtx - Both BRG's will be configured to be transmitters and receivers, with different tx params for each one. we expect to see signal indicator packets from both BRG's, according to the tx params.",
+    "brg0_tx_brg1_none - One BRG will be configured as signal indicator tx, but no rx, so we don't expect to receive signal indicator packets.",
+    "Test epilog"],
+    "expectedOutcome": "All phases passes successfully",
     "mandatory": 0,
     "multiBridgeTest": 1,
     "gwOnlyTest": 0,
+    "internalBridge": 1,
     "allSupportedValues": ["rssi_threshold", "brg0_rx_brg1_tx", "brg0_none_brg1_rx", "brg0_rxtx_brg1_rxtx", "brg0_tx_brg1_none"]
 }