wiliot-certificate 4.4.3__py3-none-any.whl → 4.5.0__py3-none-any.whl

common/api_if/206/data.json

@@ -0,0 +1,85 @@
+{
+    "type": "object",
+    "properties": {
+        "gatewayId": {
+            "type": "string",
+            "maxLength": 36
+        },
+        "gatewayType": {
+            "type": "string"
+        },
+        "timestamp": {
+            "type": "number"
+        },
+        "packets": {
+            "description": "Unified Packet",
+            "type": "array",
+            "items": {
+                "type": "object",
+                "properties": {
+                    "aliasBridgeId": {
+                        "type": "string"
+                    },
+                    "timestamp": {
+                        "type": "number"
+                    },
+                    "sequenceId": {
+                        "type": "number"
+                    },
+                    "rssi": { 
+                        "type": "number"
+                    },
+                    "payload": {
+                        "type": "string"
+                    }
+                },
+                "if": {
+                    "description":  "unified SI packet + Sensor packet",
+                    "properties":{
+                        "payload": {
+                            "oneOf": [
+                                { "pattern": "[1][eE][1][6][cC][6][fF][cC][0][0][0][0][37bBfF][fF]" },
+                                { "pattern": "[1][eE][1][6][cC][6][fF][cC][0][0][0][0][eE][eE]" },
+                                { "pattern": "[1][eE][1][6][9][0][fF][cC]" },
+                                { "pattern": "[1][eE][1][6][cC][6][fF][cC][0][0][0][0][eE][bB]" }
+                            ]
+                        }
+                    }
+                },
+                "then": {
+                        "required": ["aliasBridgeId", "timestamp", "sequenceId", "payload"]
+                },
+                "else": {
+                        "required": ["timestamp", "sequenceId", "payload"]
+                }
+            }
+        }
+    },
+    "required": [
+        "gatewayId",
+        "gatewayType",
+        "timestamp",
+        "packets"
+    ],
+    "dependentSchemas": {
+        "location": {
+            "properties": {
+                "location": {
+                    "type": "object",
+                    "properties": {
+                        "lat": {
+                            "type": "number"
+                        },
+                        "lng": {
+                            "type": "number"
+                        }
+                    },
+                    "required": [
+                        "lat",
+                        "lng"
+                    ]
+                }
+            }
+        }
+    }
+}

common/api_if/206/status.json

@@ -0,0 +1,69 @@
+{
+    "type": "object",
+    "patternProperties": {
+        "^gatewayI[dD]$": {
+            "type": "string",
+            "maxLength": 36
+        }
+    },
+    "properties": {
+        "gatewayType": {
+            "type": "string"
+        },
+        "gatewayConf": {
+            "type": "object",
+            "properties": {
+                "apiVersion": {
+                    "type": "string",
+                    "enum": ["206"]
+                },
+                "bleAddress": {
+                    "type": "string"
+                },
+                "gatewayVersion": {
+                    "type": "string"
+                },
+                "interfaceChipSwVersion": {
+                    "type": "string"
+                },
+                "bleChipSwVersion": {
+                    "type": "string"
+                },
+                "additional": {
+                    "additionalProperties": true
+                }
+            },
+            "required": ["apiVersion", "bleAddress"],
+            "oneOf":[
+                {"required": ["gatewayVersion"]},
+                {"required": ["interfaceChipSwVersion", "bleChipSwVersion"]}
+            ]
+        },
+        "tagMetadataCouplingSupported": {
+            "type": "boolean"
+        },
+        "downlinkSupported": {
+            "type": "boolean"
+        },
+        "bridgeOtaUpgradeSupported": {
+            "type": "boolean"
+        },
+        "fwUpgradeSupported": {
+            "type": "boolean"
+        },
+        "geoLocationSupport": {
+            "type": "boolean"
+        },
+        "gatewayInfo": {
+            "type":"object",
+            "additionalProperties":true
+        }
+    },
+    "oneOf":[
+        {"required": ["gatewayId", "gatewayType", "gatewayConf", "tagMetadataCouplingSupported", "downlinkSupported", "bridgeOtaUpgradeSupported", "fwUpgradeSupported"]},
+        {"required": ["gatewayID", "gatewayType", "gatewayConf", "tagMetadataCouplingSupported", "downlinkSupported", "bridgeOtaUpgradeSupported", "fwUpgradeSupported"]}
+    ],
+    "additionalProperties": false
+}
+
+

common/api_if/api_validation.py

@@ -0,0 +1,91 @@
+import json
+from jsonschema import Draft202012Validator
+import pkg_resources
+from enum import Enum
+
+from certificate.cert_prints import *
+from certificate.cert_defines import GW_LOGS
+import certificate.cert_utils as cert_utils
+import certificate.cert_mqtt as cert_mqtt
+
+class MESSAGE_TYPES(Enum):
+    STATUS = "status"
+    DATA = "data"
+    LOGS = "logs"
+
+API_VALIDATION = "API Validation"
+
+def api_validation(test):
+    phase_run_print(API_VALIDATION)
+    api_validation_phase = cert_utils.Phase(API_VALIDATION, rc=TEST_PASSED)
+
+    if test.dut.protobuf:
+        utPrint("API validation is skipped for protobuf messages", "WARNING")
+        api_validation_phase.rc = TEST_SKIPPED
+        api_validation_phase.reason = "API validation is skipped for protobuf messages"
+        test.add_phase(api_validation_phase)
+        return test
+    elif not test.dut.gw_api_version:
+        utPrint("API validation is skipped because no API version was specified", "WARNING")
+        api_validation_phase.rc = TEST_FAILED
+        api_validation_phase.reason = "API validation is skipped because no API version was specified"
+        test.add_phase(api_validation_phase)
+        return test
+    else:
+        def validate_message(message: dict, msg_type=MESSAGE_TYPES.DATA.value) -> tuple[bool, str]:
+            json_path = pkg_resources.resource_filename(__name__, f"{test.dut.gw_api_version}/{msg_type}.json")
+            with open(json_path) as f:
+                relevant_schema = json.load(f)
+            validator = Draft202012Validator(relevant_schema)
+            valid = validator.is_valid(message)
+            errors = [e for e in validator.iter_errors(message)]
+            return (valid, errors)
+
+        utPrint(f"Validating all messages in the test according to API version {test.dut.gw_api_version} validation schema", "BLUE")
+        report = []
+        phase_passed = True
+        for msg_type in MESSAGE_TYPES:
+            if msg_type.value == MESSAGE_TYPES.STATUS.value:
+                all_msgs = [msg.body for msg in test.get_mqttc_by_target(DUT)._userdata[PKTS].status if GW_LOGS not in msg.body]
+            elif msg_type.value == MESSAGE_TYPES.LOGS.value:
+                all_msgs = [msg.body for msg in test.get_mqttc_by_target(DUT)._userdata[PKTS].status if GW_LOGS in msg.body]
+            else:
+                all_msgs = [msg.body for msg in test.get_mqttc_by_target(DUT)._userdata[PKTS].data]
+
+            utPrint(f"Validating {msg_type.value} messages", "BLUE")
+            message_type_passed = True
+            total_num_of_errors = 0
+            error_report = []
+            for idx, message_body in enumerate(all_msgs):
+                if msg_type.value == MESSAGE_TYPES.DATA.value and len(message_body[PACKETS]) == 0:
+                    continue
+                validation = validate_message(message_body, msg_type.value)
+                errors = []
+                for e in validation[1]:
+                    if e.message not in errors:
+                        errors.append(e.message)
+                if not validation[0]:
+                    phase_passed = False
+                    message_type_passed = False
+                    total_num_of_errors += len(errors)
+                    error_report.append(f'The errors in message (idx={idx}, json timestamp={message_body.get(TIMESTAMP)}) Errors:')
+                    for idx, e in enumerate(errors):
+                        error_report.append(f'Error number {idx}:\n {e}')
+            report.append("\n")
+            report.append(f'Summary for {msg_type.value} messages')
+            report.append({'valid': {message_type_passed}, 'num of errors': total_num_of_errors})
+            report.append('******************************************************\n')
+            report.extend(error_report)
+        utPrint("\nAPI validation errors:", "BLUE")
+        for line in report:
+            print(line)
+        report_path = os.path.join(ARTIFACTS_DIR, test.dir, 'api_validation_report.txt')
+        with open(report_path, 'w') as f:
+            for line in report:
+                f.write(str(line) + '\n')
+        if not phase_passed:
+            api_validation_phase.rc = TEST_FAILED
+            api_validation_phase.reason = "API (JSON strcture) is invalid"
+        field_functionality_pass_fail_print(api_validation_phase, API_VALIDATION)
+        test.add_phase(api_validation_phase)
+        return test

common/web/templates/generator.html

@@ -0,0 +1,210 @@
+<!doctype html>
+<html lang="en">
+    <head>
+        <!-- Required meta tags -->
+        <meta charset="utf-8">
+        <meta name="viewport" content="width=device-width, initial-scale=1">
+        <title>{{ app }}</title>
+        <link rel="icon" href="https://www.wiliot.com/favicon.ico" type="image/x-icon" />
+        <!-- Bootstrap CSS -->
+        <link href="https://cdn.jsdelivr.net/npm/bootstrap@5.0.2/dist/css/bootstrap.min.css" rel="stylesheet" integrity="sha384-EVSTQN3/azprG1Anm3QDgpJLIm9Nao0Yz1ztcQTwFspd3yD65VohhpuuCOmLASjC" crossorigin="anonymous">
+        <style>
+            #card-body {
+                height: 550px;
+                overflow:auto;
+            }
+        </style>
+    </head>
+    <body>
+        <div class="container">
+        {% include 'menu.html' %}
+        <h1 style="color:#00AB83">{{ title }}</h1>
+        <hr>
+        <form class="form-horizontal" id="form" action="">
+            <div class="row mb-3">
+                <div class="col-md-6">
+                    <label for="filter_category" class="form-label"><strong>Filter by Type:</strong></label>
+                    <select class="form-select" id="filter_category" name="filter_category" onchange="applyFilters()">
+                        <option value="">All Types</option>
+                        {% for cat in categories %}
+                        <option value="{{ cat }}" {% if cat == filter_category or (not filter_category and cat == 'Module') %}selected{% endif %}>{{ cat }}</option>
+                        {% endfor %}
+                    </select>
+                </div>
+                <div class="col-md-6">
+                    <label for="filter_version" class="form-label"><strong>Filter by API Version:</strong></label>
+                    <select class="form-select" id="filter_version" name="filter_version" onchange="applyFilters()">
+                        <option value="">All Versions</option>
+                        {% for ver in api_versions %}
+                        <option value="{{ ver }}" {% if ver == filter_version or (not filter_version and ver|int == API_VERSION_LATEST) %}selected{% endif %}>V{{ ver }}</option>
+                        {% endfor %}
+                    </select>
+                </div>
+            </div>
+            <hr>
+            <div id="builder_form">
+                {% for n in pkt_types_list %}
+                        <div class="form-check form-check-inline pkt-radio" 
+                             data-category="{{ pkt_metadata.get(n, {}).get('category', 'Other') }}" 
+                             data-version="{{ pkt_metadata.get(n, {}).get('api_version', '') }}">
+                            <input class="form-check-input" type="radio" name="radios" value="{{ n }}" id="radio_{{ n }}" 
+                                   {% if n == wanted_pkt_type %}checked{% endif %} onclick="show();">
+                            <label class="form-check-label" for="radio_{{ n }}">{{ n }}</label>
+                        </div>
+                {% endfor %}
+                {% for n,p in pkt_types.items() %}
+                    <div id="{{ n }}_form" style="display: none;">
+                        <hr>
+                        {% for k,v in p.__dict__.items() %}
+                            <div class="row">
+                                <label for="{{ n }}_{{ k }}" class="col-sm-2">{{ k }}:</label>
+                                {% set field_name = n + '_' + k %}
+                                {% set saved_value = form_values.get(field_name, '') %}
+                                {% if saved_value %}
+                                    {% set display_value = saved_value %}
+                                {% elif k == 'brg_mac' or k == 'pkt_size' or k == 'ad_type' or k == 'uuid_msb' or k == 'uuid_lsb' or k == 'group_id' %}
+                                    {% set display_value = '0x' + ('%0x' % v).upper() %}
+                                {% else %}
+                                    {% set display_value = v %}
+                                {% endif %}
+                                <input type="text" class="col-sm-4" name="{{ n }}_{{ k }}" value="{{ display_value }}">
+                            </div>
+                        {% endfor %}
+                    </div>
+                {% endfor %}
+            </div>
+            <hr>
+            <div class="row">
+                <button type="submit" class="btn btn-primary col-sm-12">Build Packet</button>
+            </div>
+        </form>
+        <br>
+        <br>
+        <div class="card">
+            <div class="card-header">
+                Output
+            </div>
+            <div class="card-body" id="card-body">
+                <samp>{{ output | safe }}</samp>
+            </div>
+        </div>
+        <br>
+        <br>
+        <script src="https://cdn.jsdelivr.net/npm/bootstrap@5.0.2/dist/js/bootstrap.bundle.min.js" integrity="sha384-MrcW6ZMFYlzcLA8Nl+NtUVF0sA7MsXsP1UyJoMp4YLEuNSfAP+JcXn/tWtIaxVXM" crossorigin="anonymous"></script>
+        <script>
+            var pktMetadata = {{ pkt_metadata | tojson | safe }};
+            
+            function applyFilters() {
+                const categoryFilter = document.getElementById('filter_category').value;
+                const versionFilter = document.getElementById('filter_version').value;
+                const radioContainers = document.querySelectorAll('.pkt-radio');
+                radioContainers.forEach(function(container) {
+                    const category = container.getAttribute('data-category');
+                    const version = container.getAttribute('data-version');
+                    const radio = container.querySelector('input[type="radio"]');
+                    let show = true;
+                    // Filter by category
+                    if (categoryFilter && category !== categoryFilter) {
+                        show = false;
+                    }
+                    // Filter by version
+                    if (versionFilter && version !== versionFilter) {
+                        show = false;
+                    }
+                    // Show/hide the container
+                    if (show) {
+                        container.style.display = 'inline-block';
+                    } else {
+                        container.style.display = 'none';
+                        // Uncheck if hidden
+                        if (radio.checked) {
+                            radio.checked = false;
+                        }
+                    }
+                });
+            }
+            
+            const form = document.getElementById('form');
+            const group_id_brg2gw = {{ GROUP_ID_BRG2GW }};
+            const group_id_gw2brg = {{ GROUP_ID_GW2BRG }};
+            const group_id_side_info_sensor = {{ GROUP_ID_SIDE_INFO_SENSOR }};
+            const group_id_side_info = {{ GROUP_ID_SIDE_INFO }};
+            const group_id_signal_indicator = {{ GROUP_ID_SIGNAL_INDICATOR }};
+            const group_id_unified_v0 = {{ GROUP_ID_UNIFIED_PKT_V0 }};
+            const group_id_unified_v1 = {{ GROUP_ID_UNIFIED_PKT_V1 }};
+            const group_id_unified_v2 = {{ GROUP_ID_UNIFIED_PKT_V2 }};
+            const group_id_unified_ext_v0 = {{ GROUP_ID_BLE5_EXTENDED_V0 }};
+            const group_id_unified_ext_v1 = {{ GROUP_ID_BLE5_EXTENDED_V1 }};
+            var pktTypes = {{ pkt_types_list | tojson | safe }};
+            
+            function showPktForm(pktType) {
+                // Hide all packet forms
+                pktTypes.forEach(function(type) {
+                    var formEl = document.getElementById(type + "_form");
+                    if (formEl) formEl.style.display = 'none';
+                });
+                
+                // Show appropriate header and packet form
+                if (pktType && pktType.includes("Unified")) {
+                    document.getElementById("Hdr_form").style.display = 'none';
+                    document.getElementById("DataHdr_form").style.display = 'block';
+                    var default_value = 0;
+                    if (pktType.includes("V0")) {
+                        default_value = pktType.includes("Ext") ? group_id_unified_ext_v0 : group_id_unified_v0;
+                    } else if (pktType.includes("V1")) {
+                        default_value = pktType.includes("Ext") ? group_id_unified_ext_v1 : group_id_unified_v1;
+                    } else if (pktType.includes("V2")) {
+                        default_value = group_id_unified_v2;
+                    }
+                    if (form.elements.DataHdr_group_id_major) {
+                        form.elements.DataHdr_group_id_major.value = "0x" + default_value.toString(16).toUpperCase();
+                    }
+                } else {
+                    document.getElementById("Hdr_form").style.display = 'block';
+                    document.getElementById("DataHdr_form").style.display = 'none';
+                    var default_value = 0;
+                    if (pktType && pktType.includes("Brg2Gw")) {
+                        default_value = group_id_brg2gw;
+                    } else if (pktType && pktType.includes("Gw2Brg")) {
+                        default_value = group_id_gw2brg;
+                    } else if (pktType && pktType.includes("SignalIndicator")) {
+                        default_value = group_id_signal_indicator;
+                    } else if (pktType && pktType.includes("SideInfoSensor")) {
+                        default_value = group_id_side_info_sensor;
+                    } else if (pktType && pktType.includes("SideInfo")) {
+                        default_value = group_id_side_info;
+                    }
+                    if (form.elements.Hdr_group_id) {
+                        form.elements.Hdr_group_id.value = "0x" + default_value.toString(16).toUpperCase();
+                    }
+                }
+                
+                // Show the selected packet form
+                if (pktType) {
+                    var pktForm = document.getElementById(pktType + "_form");
+                    if (pktForm) pktForm.style.display = 'block';
+                }
+            }
+            
+            function show() {
+                // Set up click handlers
+                var radios = document.getElementsByName("radios");
+                for (var i = 0; i < radios.length; i++) {
+                    radios[i].onclick = function() {
+                        showPktForm(this.value);
+                    };
+                }
+                
+                // Show form for checked radio (if any)
+                for (var i = 0; i < radios.length; i++) {
+                    if (radios[i].checked) {
+                        showPktForm(radios[i].value);
+                        break;
+                    }
+                }
+            }
+            applyFilters(); // Apply filters on page load
+            show(); // Initialize form display (will show selected packet form if one is checked)
+        </script>
+    </body>
+</html>

common/web/templates/index.html

@@ -0,0 +1,20 @@
+
+<!DOCTYPE html>
+<html>
+    <head>
+        <!-- Required meta tags -->
+        <meta charset="utf-8">
+        <meta name="viewport" content="width=device-width, initial-scale=1">
+        <title>{{ app }}</title>
+        <link rel="icon" href="https://www.wiliot.com/favicon.ico" type="image/x-icon" />
+        <!-- Bootstrap CSS -->
+        <link href="https://cdn.jsdelivr.net/npm/bootstrap@5.0.2/dist/css/bootstrap.min.css" rel="stylesheet" integrity="sha384-EVSTQN3/azprG1Anm3QDgpJLIm9Nao0Yz1ztcQTwFspd3yD65VohhpuuCOmLASjC" crossorigin="anonymous">
+    </head>
+<body>
+<div class="container">
+{% include 'menu.html' %}
+<h1 style="color:#00AB83">{{ title }}</h1>
+<hr>
+{% include wlt_types_html %}
+</body>
+</html>

common/web/templates/menu.html

@@ -0,0 +1,54 @@
+<nav class="navbar navbar-light navbar-expand-lg" style="background-color: #E5F7F3;">
+    <div class="container-fluid">
+        <ul class="navbar-nav">
+            <li class="nav-item">
+                <a class="nav-link active" aria-current="page" href="/">
+                    <img src="https://www.wiliot.com/src/img/svg/logo.svg" width="100" height="40" alt="Wiliot logo">
+                </a>
+            </li>
+            {% if app == FDM %}
+                <li>
+                    <a class="nav-link" href="/">
+                        <button class="btn btn-outline-success my-5 my-sm-0">DEV MODE</button>
+                    </a>
+                </li>
+                <li>
+                    <a class="nav-link" href="/gw">
+                        <button class="btn btn-outline-success my-5 my-sm-0">GW</button>
+                    </a>
+                </li>
+                <li>
+                    <a class="nav-link" href="/brg">
+                        <button class="btn btn-outline-success my-5 my-sm-0">BRG</button>
+                    </a>
+                </li>
+                <li>
+                    <a class="nav-link" href="/tag2brg">
+                        <button class="btn btn-outline-success my-5 my-sm-0">Tag to Bridge Packet</button>
+                    </a>
+                </li>
+            {% elif app == CERT_WEB %}
+                <li>
+                    <a class="nav-link" href="/">
+                        <button class="btn btn-outline-success my-5 my-sm-0">RUN CERTIFICATE</button>
+                    </a>
+                </li>
+            {% endif %}
+            <li>
+                <a class="nav-link" href="/parser"> 
+                    <button class="btn btn-outline-success my-5 my-sm-0">PACKET PARSER</button>
+                </a>
+            </li>
+            <li>
+                <a class="nav-link" href="/generator">
+                    <button class="btn btn-outline-success my-5 my-sm-0">PACKET GENERATOR</button>
+                </a>
+            </li>
+            <li>
+               <a class="nav-link" href="/data_structs">
+                   <button class="btn btn-outline-success my-5 my-sm-0">DATA STRUCTURES</button>
+               </a>
+           </li>
+        </ul>
+    </div>
+</nav>

common/web/templates/parser.html

@@ -0,0 +1,53 @@
+<!doctype html>
+<html lang="en">
+    <head>
+        <!-- Required meta tags -->
+        <meta charset="utf-8">
+        <meta name="viewport" content="width=device-width, initial-scale=1">
+        <title>{{ app }}</title>
+        <link rel="icon" href="https://www.wiliot.com/favicon.ico" type="image/x-icon" />
+        <!-- Bootstrap CSS -->
+        <link href="https://cdn.jsdelivr.net/npm/bootstrap@5.0.2/dist/css/bootstrap.min.css" rel="stylesheet" integrity="sha384-EVSTQN3/azprG1Anm3QDgpJLIm9Nao0Yz1ztcQTwFspd3yD65VohhpuuCOmLASjC" crossorigin="anonymous">
+        <style>
+            #card-body {
+                height: 550px;
+                overflow:auto; 
+            }
+        </style>
+    </head>
+    <body>
+        <div class="container">
+        {% include 'menu.html' %}
+        <h1 style="color:#00AB83">{{ title }}</h1>
+        <hr>
+        <form class="form-horizontal" action="">
+            <div class="row">
+                <label for="payload" class="col-sm-2">PAYLOAD:</label>
+                <input type="text" class="col-sm-4" name="payload" value="" placeholder="required" required>
+            </div>
+            {% if app == FDM %}
+                <div class="row">
+                    <label for="packet_version" class="col-sm-2">PACKET VERSION:</label>
+                    <input type="text" class="col-sm-4" name="packet_version" value="3.0">
+                </div>
+            {% endif %}
+            <hr>
+            <div class="row">
+                <button type="submit" class="btn btn-primary col-sm-12">Parse Packet</button>
+            </div>
+        </form>
+        <br>
+        <br>
+        <div class="card">
+            <div class="card-header">
+                Output
+            </div>
+            <div class="card-body" id="card-body">
+                <samp>{{ output | safe }}</samp>
+            </div>
+        </div>
+        <br>
+        <br>
+        <script src="https://cdn.jsdelivr.net/npm/bootstrap@5.0.2/dist/js/bootstrap.bundle.min.js" integrity="sha384-MrcW6ZMFYlzcLA8Nl+NtUVF0sA7MsXsP1UyJoMp4YLEuNSfAP+JcXn/tWtIaxVXM" crossorigin="anonymous"></script>
+    </body>
+</html>