From eb19d94f9908395cb3ceca781c32073974f402c9 Mon Sep 17 00:00:00 2001 From: 8ohamed <114395272+8ohamed@users.noreply.github.com> Date: Sun, 9 Feb 2025 13:41:35 +0100 Subject: [PATCH 1/5] created the hbk folder --- src/cp-sens/data/accel/hbk/METADATA.md | 64 +++++++++++++++++++ src/cp-sens/data/accel/hbk/accelerometer.py | 53 +++++++++++++++ src/cp-sens/data/accel/hbk/json_config.json | 11 ++++ .../data/accel/hbk/test_mqtt_client.py | 25 ++++++++ 4 files changed, 153 insertions(+) create mode 100644 src/cp-sens/data/accel/hbk/METADATA.md create mode 100644 src/cp-sens/data/accel/hbk/accelerometer.py create mode 100644 src/cp-sens/data/accel/hbk/json_config.json create mode 100644 src/cp-sens/data/accel/hbk/test_mqtt_client.py diff --git a/src/cp-sens/data/accel/hbk/METADATA.md b/src/cp-sens/data/accel/hbk/METADATA.md new file mode 100644 index 0000000..eecbcaf --- /dev/null +++ b/src/cp-sens/data/accel/hbk/METADATA.md @@ -0,0 +1,64 @@ +# METADATA Documentation + +## Overview +This document describes the structure and handling of the metadata and data topics used in the MQTT communication system for accelerometer sensors. It explains the format of the payloads, metadata versioning, data consistency checks, and handling sensor-specific metadata. + +The MQTT system uses hierarchical topics to identify the source and type of data. The two key topics are: +1. **Data Topic**: Contains dynamic data from sensors. +2. **Metadata Topic**: Contains static information, including metadata related to the sensor, analysis chain, and engineering information. + +## MQTT Topic Format +The MQTT topic structure follows the pattern: + +cpsens/DAQ_ID/MODULE_ID/CH_ID/PHYSICS/ANALYSIS/DATA_ID + + +### Example Topics: +- **Data Topic**: +cpsens/RPi_1234/1/1/acc/raw/data + + +This represents data coming from an accelerometer (`acc`), processed as raw data (`raw`), from channel 1 of module 1 on device `RPi_1234`. + +- **Metadata Topic**: +cpsens/RPi_1234/1/1/acc/raw/metadata + +This topic contains metadata for the raw data from the same device, module, and channel. + +## Payload Format + +### Data Topic Payload +The **data topic** payload consists of two parts: +1. **Descriptor**: Contains dynamic metadata related to the data. +2. **Data**: Contains the actual sensor readings (typically as binary data). + +#### Example Data Topic Payload: +```json +{ +"descriptor": { + "length": 10, + "timestamp": "1638493434", + "metadata_version": 1 +}, +"data": { + "type": "double", + "values": [0.5, 0.3, 0.7] +}, +"sensor": { + "sensing": "acceleration", + "sensitivity": 100, + "unit": "mV/ms-2" +}, +"DAQ_device": { + "IP_address": "192.168.100.101", + "type": "Raspberry PI" +}, +"analysis_chain": { + "analysis1": { + "name": "raw", + "sampling_rate_Sa_per_s": 100 + } +} +} + + diff --git a/src/cp-sens/data/accel/hbk/accelerometer.py b/src/cp-sens/data/accel/hbk/accelerometer.py new file mode 100644 index 0000000..62b7c9d --- /dev/null +++ b/src/cp-sens/data/accel/hbk/accelerometer.py @@ -0,0 +1,53 @@ +import json +import os +from paho.mqtt.client import Client as MQTTClient # type: ignore + +# Load configuration from json_config.json +current_directory = os.path.dirname(os.path.abspath(__file__)) +json_config_path = os.path.join(current_directory, 'json_config.json') + +try: + with open(json_config_path, 'r') as f: + json_config = json.load(f) + print("JSON configuration loaded successfully.") +except FileNotFoundError: + print(f"Error: The file {json_config_path} was not found.") + raise + +# setup +mqttc = MQTTClient(client_id=json_config["MQTT"]["ClientID"]) + +#authentication +if json_config["MQTT"]["userId"]: + mqttc.username_pw_set(json_config["MQTT"]["user"], json_config["MQTT"]["password"]) + + +# Callback functions for MQTT client +def on_connect(mqttc, userdata, flags, rc, properties=None): + print(f"on_connect: Connected with response code {rc}") + # Subscribe to relevant topics for accelerometer data + for topic in json_config["MQTT"]["TopicsToSubscribe"]: + print(f"Subscribing to the topic {topic}...") + mqttc.subscribe(topic, qos=json_config["MQTT"]["QoS"]) + + +# I had to change the parameter "msg" to "mid", so instead of the message topic its now the message id +def on_subscribe(mqttc, userdata, mid, granted_qos): + print(f"on_subscribe: Subscription ID {mid} with QoS levels {granted_qos}") + +def on_message(client, userdata, msg): + print(f"on_message: Received message on {msg.topic}") + print(f"Message payload: {msg.payload.decode()}") # Handle the message + +def on_publish(client, userdata, mid): + print(f"on_publish: Message {mid} published.") + + +# Connect to the broker using host and port from the config +mqttc.on_connect = on_connect +mqttc.on_message = on_message +mqttc.on_subscribe = on_subscribe +mqttc.on_publish = on_publish + +mqttc.connect(json_config["MQTT"]["host"], json_config["MQTT"]["port"], 60) +mqttc.loop_start() diff --git a/src/cp-sens/data/accel/hbk/json_config.json b/src/cp-sens/data/accel/hbk/json_config.json new file mode 100644 index 0000000..4e08974 --- /dev/null +++ b/src/cp-sens/data/accel/hbk/json_config.json @@ -0,0 +1,11 @@ +{ + "MQTT": { + "host": "test.mosquitto.org", + "port": 1883, + "userId": "", + "password": "", + "ClientID": "test_client_id", + "QoS": 1, + "TopicsToSubscribe": ["topic"] + } +} diff --git a/src/cp-sens/data/accel/hbk/test_mqtt_client.py b/src/cp-sens/data/accel/hbk/test_mqtt_client.py new file mode 100644 index 0000000..c82b002 --- /dev/null +++ b/src/cp-sens/data/accel/hbk/test_mqtt_client.py @@ -0,0 +1,25 @@ +# This is to test the clinet MQtt code that I extracted from cpsns_pyOMA.py +import time +from accelerometer import mqttc, on_connect, on_message, on_subscribe, on_publish + +def test_mqtt_connection(): + # Set up the callbacks + mqttc.on_connect = on_connect + mqttc.on_message = on_message + mqttc.on_subscribe = on_subscribe + mqttc.on_publish = on_publish + + # Connect to the broker (using the port from json) + mqttc.connect("test.mosquitto.org", 1883, 60) + + # Start the loop to maintain the connection and handle callbacks + mqttc.loop_start() + + # test message + mqttc.publish("topic", "test message", qos=1) + time.sleep(5) + mqttc.loop_stop() + + + +test_mqtt_connection() From 835facc0a1e42944520e4f9dd4129680bdeb6cc0 Mon Sep 17 00:00:00 2001 From: 8ohamed <114395272+8ohamed@users.noreply.github.com> Date: Thu, 20 Feb 2025 19:37:50 +0100 Subject: [PATCH 2/5] pytest and structure update --- src/cp-sens/data/accel/hbk/accelerometer.py | 113 ++++++++++++------ .../data/accel/hbk/test_mqtt_client.py | 25 ---- .../hbk/json_config.json => config/mqtt.json} | 0 tests/data/accel/hbk/test_accelerometer.py | 91 ++++++++++++++ 4 files changed, 165 insertions(+), 64 deletions(-) delete mode 100644 src/cp-sens/data/accel/hbk/test_mqtt_client.py rename src/cp-sens/data/{accel/hbk/json_config.json => config/mqtt.json} (100%) create mode 100644 tests/data/accel/hbk/test_accelerometer.py diff --git a/src/cp-sens/data/accel/hbk/accelerometer.py b/src/cp-sens/data/accel/hbk/accelerometer.py index 62b7c9d..da918f4 100644 --- a/src/cp-sens/data/accel/hbk/accelerometer.py +++ b/src/cp-sens/data/accel/hbk/accelerometer.py @@ -1,53 +1,88 @@ import json import os -from paho.mqtt.client import Client as MQTTClient # type: ignore +from paho.mqtt.client import Client as MQTTClient, CallbackAPIVersion, MQTTv5 # type: ignore -# Load configuration from json_config.json -current_directory = os.path.dirname(os.path.abspath(__file__)) -json_config_path = os.path.join(current_directory, 'json_config.json') -try: - with open(json_config_path, 'r') as f: - json_config = json.load(f) - print("JSON configuration loaded successfully.") -except FileNotFoundError: - print(f"Error: The file {json_config_path} was not found.") - raise -# setup -mqttc = MQTTClient(client_id=json_config["MQTT"]["ClientID"]) +def load_config(config_path: str) -> dict: + """ + Loads JSON configuration from the provided config path. -#authentication -if json_config["MQTT"]["userId"]: - mqttc.username_pw_set(json_config["MQTT"]["user"], json_config["MQTT"]["password"]) + Raises: + FileNotFoundError: If the file is not found. + ValueError: If the file cannot be decoded as JSON. + Exception: For any other unexpected error. + """ + try: + with open(config_path, "r") as f: + json_config = json.load(f) + print("JSON configuration loaded successfully.") + return json_config + except FileNotFoundError: + raise FileNotFoundError(f"Error: The file {config_path} was not found.") + except json.JSONDecodeError: + raise ValueError(f"Error: The file {config_path} could not be decoded as JSON.") + except Exception as e: + raise Exception(f"An unexpected error occurred: {e}") -# Callback functions for MQTT client -def on_connect(mqttc, userdata, flags, rc, properties=None): - print(f"on_connect: Connected with response code {rc}") - # Subscribe to relevant topics for accelerometer data - for topic in json_config["MQTT"]["TopicsToSubscribe"]: - print(f"Subscribing to the topic {topic}...") - mqttc.subscribe(topic, qos=json_config["MQTT"]["QoS"]) +def create_on_connect_callback(topics, qos): + def on_connect(client, userdata, flags, rc, properties=None): + print(f"on_connect: Connected with response code {rc}") + if rc == 0: # Connection was successful + for topic in topics: + print(f"Subscribing to the topic {topic}...") + client.subscribe(topic, qos=qos) + else: + print("Connection failed with result code:", rc) + return on_connect +def create_on_subscribe_callback(): + def on_subscribe(client, userdata, mid, granted_qos): + print(f"on_subscribe: Subscription ID {mid} with QoS levels {granted_qos}") + return on_subscribe +def create_on_subscribe_callback(): + def on_subscribe(client, userdata, mid, granted_qos): + print(f"on_subscribe: Subscription ID {mid} with QoS levels {granted_qos}") + return on_subscribe -# I had to change the parameter "msg" to "mid", so instead of the message topic its now the message id -def on_subscribe(mqttc, userdata, mid, granted_qos): - print(f"on_subscribe: Subscription ID {mid} with QoS levels {granted_qos}") +def create_on_message_callback(): + def on_message(client, userdata, msg): + print(f"on_message: Received message on {msg.topic}") + print(f"Message payload: {msg.payload.decode()}") + return on_message +def create_on_message_callback(): + def on_message(client, userdata, msg): + print(f"on_message: Received message on {msg.topic}") + print(f"Message payload: {msg.payload.decode()}") + return on_message -def on_message(client, userdata, msg): - print(f"on_message: Received message on {msg.topic}") - print(f"Message payload: {msg.payload.decode()}") # Handle the message +def create_on_publish_callback(): + def on_publish(client, userdata, mid): + print(f"on_publish: Message {mid} published.") + return on_publish -def on_publish(client, userdata, mid): - print(f"on_publish: Message {mid} published.") - +def setup_mqtt_client(config): + mqttc = MQTTClient( + client_id=config["MQTT"]["ClientID"], + callback_api_version=CallbackAPIVersion.VERSION2, + protocol=MQTTv5 + ) + if config["MQTT"]["userId"]: + mqttc.username_pw_set(config["MQTT"]["userId"], config["MQTT"]["password"]) -# Connect to the broker using host and port from the config -mqttc.on_connect = on_connect -mqttc.on_message = on_message -mqttc.on_subscribe = on_subscribe -mqttc.on_publish = on_publish + # Assign callbacks. + mqttc.on_connect = create_on_connect_callback(config["MQTT"]["TopicsToSubscribe"], + config["MQTT"]["QoS"]) + mqttc.on_subscribe = create_on_subscribe_callback() + mqttc.on_message = create_on_message_callback() + mqttc.on_publish = create_on_publish_callback() + return mqttc -mqttc.connect(json_config["MQTT"]["host"], json_config["MQTT"]["port"], 60) -mqttc.loop_start() +if __name__ == "__main__": + current_dir = os.path.dirname(os.path.abspath(__file__)) + config_path = os.path.join(current_dir, "../../config/mqtt.json") + json_config = load_config(config_path) + mqttc = setup_mqtt_client(json_config) + mqttc.connect(json_config["MQTT"]["host"], json_config["MQTT"]["port"], 60) + mqttc.loop_start() \ No newline at end of file diff --git a/src/cp-sens/data/accel/hbk/test_mqtt_client.py b/src/cp-sens/data/accel/hbk/test_mqtt_client.py deleted file mode 100644 index c82b002..0000000 --- a/src/cp-sens/data/accel/hbk/test_mqtt_client.py +++ /dev/null @@ -1,25 +0,0 @@ -# This is to test the clinet MQtt code that I extracted from cpsns_pyOMA.py -import time -from accelerometer import mqttc, on_connect, on_message, on_subscribe, on_publish - -def test_mqtt_connection(): - # Set up the callbacks - mqttc.on_connect = on_connect - mqttc.on_message = on_message - mqttc.on_subscribe = on_subscribe - mqttc.on_publish = on_publish - - # Connect to the broker (using the port from json) - mqttc.connect("test.mosquitto.org", 1883, 60) - - # Start the loop to maintain the connection and handle callbacks - mqttc.loop_start() - - # test message - mqttc.publish("topic", "test message", qos=1) - time.sleep(5) - mqttc.loop_stop() - - - -test_mqtt_connection() diff --git a/src/cp-sens/data/accel/hbk/json_config.json b/src/cp-sens/data/config/mqtt.json similarity index 100% rename from src/cp-sens/data/accel/hbk/json_config.json rename to src/cp-sens/data/config/mqtt.json diff --git a/tests/data/accel/hbk/test_accelerometer.py b/tests/data/accel/hbk/test_accelerometer.py new file mode 100644 index 0000000..9ac381c --- /dev/null +++ b/tests/data/accel/hbk/test_accelerometer.py @@ -0,0 +1,91 @@ +import io +import os +import pytest +from unittest.mock import MagicMock + +import sys +sys.path.append(os.path.abspath(os.path.join(os.path.dirname(__file__), "../../../../src/cp-sens"))) + +from data.accel.hbk.accelerometer import ( + create_on_connect_callback, + create_on_subscribe_callback, + create_on_message_callback, + create_on_publish_callback, + setup_mqtt_client +) + +def test_on_connect_callback_success(): + topics = ["test/topic1", "test/topic2"] + qos = 1 + on_connect = create_on_connect_callback(topics, qos) + client = MagicMock() + # Simulate a successful connection (rc == 0) + on_connect(client, None, None, 0) + # Verify that subscribe was called for each topic with the expected QoS. + assert client.subscribe.call_count == len(topics) + for topic in topics: + client.subscribe.assert_any_call(topic, qos=qos) + +def test_on_connect_callback_failure(): + topics = ["test/topic1", "test/topic2"] + qos = 1 + on_connect = create_on_connect_callback(topics, qos) + client = MagicMock() + # Simulate a failed connection (rc != 0) + on_connect(client, None, None, 1) + # Verify that subscribe is not called when connection fails. + client.subscribe.assert_not_called() + +def test_on_subscribe_callback(capsys): + on_subscribe = create_on_subscribe_callback() + client = MagicMock() + # Call on_subscribe with a sample message id and granted QoS list. + on_subscribe(client, None, 42, [1, 1]) + captured = capsys.readouterr().out + assert "Subscription ID 42" in captured + assert "QoS levels [1, 1]" in captured + +def test_on_message_callback(capsys): + on_message = create_on_message_callback() + client = MagicMock() + + # Create a fake message object. + class FakeMsg: + topic = "test/topic" + payload = b"test payload" + + fake_msg = FakeMsg() + on_message(client, None, fake_msg) + captured = capsys.readouterr().out + assert "Received message on test/topic" in captured + assert "Message payload: test payload" in captured + +def test_on_publish_callback(capsys): + on_publish = create_on_publish_callback() + client = MagicMock() + on_publish(client, None, 99) + captured = capsys.readouterr().out + assert "Message 99 published" in captured + +def test_setup_mqtt_client(): + dummy_config = { + "MQTT": { + "ClientID": "test_client", + "userId": "test_user", + "password": "test_pass", + "TopicsToSubscribe": ["test/topic1", "test/topic2"], + "QoS": 1, + "host": "localhost", + "port": 1883 + } + } + client = setup_mqtt_client(dummy_config) + # Check that the client has the correct client_id. + client_id = client._client_id.decode() if isinstance(client._client_id, bytes) else client._client_id + assert client_id == "test_client" + + # Verify that all callback functions has been assigned. + assert client.on_connect is not None + assert client.on_subscribe is not None + assert client.on_message is not None + assert client.on_publish is not None \ No newline at end of file From 2b50857a830d8fc0d2b970eb0f200f3ffc9a22bf Mon Sep 17 00:00:00 2001 From: prasadtalasila Date: Sat, 22 Feb 2025 10:38:02 +0100 Subject: [PATCH 3/5] Adds poetry commands and project README --- .coveragerc | 11 + .pylintrc | 585 +++++++++++++++++++++++++++++++++++++++++++++++++ README.md | 34 +++ poetry.lock | 139 +++++++++++- pyproject.toml | 7 +- src/main.py | 6 + 6 files changed, 771 insertions(+), 11 deletions(-) create mode 100644 .coveragerc create mode 100644 .pylintrc create mode 100644 src/main.py diff --git a/.coveragerc b/.coveragerc new file mode 100644 index 0000000..ec5cd66 --- /dev/null +++ b/.coveragerc @@ -0,0 +1,11 @@ +[run] +omit = + */tests/* + */venv/* + */.venv/* + */__init__.py + +[report] +exclude_lines = + if __name__ == .__main__.: + pragma: no cover \ No newline at end of file diff --git a/.pylintrc b/.pylintrc new file mode 100644 index 0000000..8db6638 --- /dev/null +++ b/.pylintrc @@ -0,0 +1,585 @@ +[MASTER] + +# A comma-separated list of package or module names from where C extensions may +# be loaded. Extensions are loading into the active Python interpreter and may +# run arbitrary code. +extension-pkg-allow-list= + +# A comma-separated list of package or module names from where C extensions may +# be loaded. Extensions are loading into the active Python interpreter and may +# run arbitrary code. (This is an alternative name to extension-pkg-allow-list +# for backward compatibility.) +extension-pkg-whitelist= + +# Return non-zero exit code if any of these messages/categories are detected, +# even if score is above --fail-under value. Syntax same as enable. Messages +# specified are enabled, while categories only check already-enabled messages. +fail-on= + +# Specify a score threshold to be exceeded before program exits with error. +fail-under=10.0 + +# Files or directories to be skipped. They should be base names, not paths. +ignore=CVS + +# Add files or directories matching the regex patterns to the ignore-list. The +# regex matches against paths and can be in Posix or Windows format. +ignore-paths= + +# Files or directories matching the regex patterns are skipped. The regex +# matches against base names, not paths. The default value ignores emacs file +# locks +ignore-patterns=^\.# + +# Python code to execute, usually for sys.path manipulation such as +# pygtk.require(). +#init-hook= + +# Use multiple processes to speed up Pylint. Specifying 0 will auto-detect the +# number of processors available to use. +jobs=1 + +# Control the amount of potential inferred values when inferring a single +# object. This can help the performance when dealing with large functions or +# complex, nested conditions. +limit-inference-results=100 + +# List of plugins (as comma separated values of python module names) to load, +# usually to register additional checkers. +load-plugins= + +# Pickle collected data for later comparisons. +persistent=yes + +# Minimum Python version to use for version dependent checks. Will default to +# the version used to run pylint. +py-version=3.10 + +# Discover python modules and packages in the file system subtree. +recursive=no + +# When enabled, pylint would attempt to guess common misconfiguration and emit +# user-friendly hints instead of false-positive error messages. +suggestion-mode=yes + +# Allow loading of arbitrary C extensions. Extensions are imported into the +# active Python interpreter and may run arbitrary code. +unsafe-load-any-extension=no + + +[MESSAGES CONTROL] + +# Only show warnings with the listed confidence levels. Leave empty to show +# all. Valid levels: HIGH, CONTROL_FLOW, INFERENCE, INFERENCE_FAILURE, +# UNDEFINED. +confidence= + +# Disable the message, report, category or checker with the given id(s). You +# can either give multiple identifiers separated by comma (,) or put this +# option multiple times (only on the command line, not in the configuration +# file where it should appear only once). You can also use "--disable=all" to +# disable everything first and then re-enable specific checks. For example, if +# you want to run only the similarities checker, you can use "--disable=all +# --enable=similarities". If you want to run only the classes checker, but have +# no Warning level messages displayed, use "--disable=all --enable=classes +# --disable=W". +disable=raw-checker-failed, + bad-inline-option, + locally-disabled, + file-ignored, + suppressed-message, + useless-suppression, + deprecated-pragma, + use-symbolic-message-instead + +# Enable the message, report, category or checker with the given id(s). You can +# either give multiple identifier separated by comma (,) or put this option +# multiple time (only on the command line, not in the configuration file where +# it should appear only once). See also the "--disable" option for examples. +enable=c-extension-no-member + + +[REPORTS] + +# Python expression which should return a score less than or equal to 10. You +# have access to the variables 'fatal', 'error', 'warning', 'refactor', +# 'convention', and 'info' which contain the number of messages in each +# category, as well as 'statement' which is the total number of statements +# analyzed. This score is used by the global evaluation report (RP0004). +evaluation=max(0, 0 if fatal else 10.0 - ((float(5 * error + warning + refactor + convention) / statement) * 10)) + +# Template used to display messages. This is a python new-style format string +# used to format the message information. See doc for all details. +#msg-template= + +# Set the output format. Available formats are text, parseable, colorized, json +# and msvs (visual studio). You can also give a reporter class, e.g. +# mypackage.mymodule.MyReporterClass. +output-format=text + +# Tells whether to display a full report or only the messages. +reports=no + +# Activate the evaluation score. +score=yes + + +[REFACTORING] + +# Maximum number of nested blocks for function / method body +max-nested-blocks=5 + +# Complete name of functions that never returns. When checking for +# inconsistent-return-statements if a never returning function is called then +# it will be considered as an explicit return statement and no message will be +# printed. +never-returning-functions=sys.exit,argparse.parse_error + + +[TYPECHECK] + +# List of decorators that produce context managers, such as +# contextlib.contextmanager. Add to this list to register other decorators that +# produce valid context managers. +contextmanager-decorators=contextlib.contextmanager + +# List of members which are set dynamically and missed by pylint inference +# system, and so shouldn't trigger E1101 when accessed. Python regular +# expressions are accepted. +generated-members= + +# Tells whether missing members accessed in mixin class should be ignored. A +# class is considered mixin if its name matches the mixin-class-rgx option. +ignore-mixin-members=yes + +# Tells whether to warn about missing members when the owner of the attribute +# is inferred to be None. +ignore-none=yes + +# This flag controls whether pylint should warn about no-member and similar +# checks whenever an opaque object is returned when inferring. The inference +# can return multiple potential results while evaluating a Python object, but +# some branches might not be evaluated, which results in partial inference. In +# that case, it might be useful to still emit no-member and other checks for +# the rest of the inferred objects. +ignore-on-opaque-inference=yes + +# List of class names for which member attributes should not be checked (useful +# for classes with dynamically set attributes). This supports the use of +# qualified names. +ignored-classes=optparse.Values,thread._local,_thread._local + +# List of module names for which member attributes should not be checked +# (useful for modules/projects where namespaces are manipulated during runtime +# and thus existing member attributes cannot be deduced by static analysis). It +# supports qualified module names, as well as Unix pattern matching. +ignored-modules= + +# Show a hint with possible names when a member name was not found. The aspect +# of finding the hint is based on edit distance. +missing-member-hint=yes + +# The minimum edit distance a name should have in order to be considered a +# similar match for a missing member name. +missing-member-hint-distance=1 + +# The total number of similar names that should be taken in consideration when +# showing a hint for a missing member. +missing-member-max-choices=1 + +# Regex pattern to define which classes are considered mixins ignore-mixin- +# members is set to 'yes' +mixin-class-rgx=.*[Mm]ixin + +# List of decorators that change the signature of a decorated function. +signature-mutators= + + +[LOGGING] + +# The type of string formatting that logging methods do. `old` means using % +# formatting, `new` is for `{}` formatting. +logging-format-style=old + +# Logging modules to check that the string format arguments are in logging +# function parameter format. +logging-modules=logging + + +[BASIC] + +# Naming style matching correct argument names. +argument-naming-style=camelCase + +# Regular expression matching correct argument names. Overrides argument- +# naming-style. If left empty, argument names will be checked with the set +# naming style. +#argument-rgx= + +# Naming style matching correct attribute names. +attr-naming-style=camelCase + +# Regular expression matching correct attribute names. Overrides attr-naming- +# style. If left empty, attribute names will be checked with the set naming +# style. +#attr-rgx= + +# Bad variable names which should always be refused, separated by a comma. +bad-names=foo, + bar, + baz, + toto, + tutu, + tata + +# Bad variable names regexes, separated by a comma. If names match any regex, +# they will always be refused +bad-names-rgxs= + +# Naming style matching correct class attribute names. +class-attribute-naming-style=any + +# Regular expression matching correct class attribute names. Overrides class- +# attribute-naming-style. If left empty, class attribute names will be checked +# with the set naming style. +#class-attribute-rgx= + +# Naming style matching correct class constant names. +class-const-naming-style=UPPER_CASE + +# Regular expression matching correct class constant names. Overrides class- +# const-naming-style. If left empty, class constant names will be checked with +# the set naming style. +#class-const-rgx= + +# Naming style matching correct class names. +class-naming-style=PascalCase + +# Regular expression matching correct class names. Overrides class-naming- +# style. If left empty, class names will be checked with the set naming style. +#class-rgx= + +# Naming style matching correct constant names. +const-naming-style=UPPER_CASE + +# Regular expression matching correct constant names. Overrides const-naming- +# style. If left empty, constant names will be checked with the set naming +# style. +#const-rgx= + +# Minimum line length for functions/classes that require docstrings, shorter +# ones are exempt. +docstring-min-length=-1 + +# Naming style matching correct function names. +function-naming-style=camelCase + +# Regular expression matching correct function names. Overrides function- +# naming-style. If left empty, function names will be checked with the set +# naming style. +#function-rgx= + +# Good variable names which should always be accepted, separated by a comma. +good-names=i, + j, + k, + ex, + Run, + _ + +# Good variable names regexes, separated by a comma. If names match any regex, +# they will always be accepted +good-names-rgxs= + +# Include a hint for the correct naming format with invalid-name. +include-naming-hint=no + +# Naming style matching correct inline iteration names. +inlinevar-naming-style=any + +# Regular expression matching correct inline iteration names. Overrides +# inlinevar-naming-style. If left empty, inline iteration names will be checked +# with the set naming style. +#inlinevar-rgx= + +# Naming style matching correct method names. +method-naming-style=camelCase + +# Regular expression matching correct method names. Overrides method-naming- +# style. If left empty, method names will be checked with the set naming style. +#method-rgx= + +# Naming style matching correct module names. +module-naming-style=camelCase + +# Regular expression matching correct module names. Overrides module-naming- +# style. If left empty, module names will be checked with the set naming style. +#module-rgx= + +# Colon-delimited sets of names that determine each other's naming style when +# the name regexes allow several styles. +name-group= + +# Regular expression which should only match function or class names that do +# not require a docstring. +no-docstring-rgx=^_ + +# List of decorators that produce properties, such as abc.abstractproperty. Add +# to this list to register other decorators that produce valid properties. +# These decorators are taken in consideration only for invalid-name. +property-classes=abc.abstractproperty + +# Regular expression matching correct type variable names. If left empty, type +# variable names will be checked with the set naming style. +#typevar-rgx= + +# Naming style matching correct variable names. +variable-naming-style=camelCase + +# Regular expression matching correct variable names. Overrides variable- +# naming-style. If left empty, variable names will be checked with the set +# naming style. +#variable-rgx= + + +[SPELLING] + +# Limits count of emitted suggestions for spelling mistakes. +max-spelling-suggestions=4 + +# Spelling dictionary name. Available dictionaries: none. To make it work, +# install the 'python-enchant' package. +spelling-dict= + +# List of comma separated words that should be considered directives if they +# appear and the beginning of a comment and should not be checked. +spelling-ignore-comment-directives=fmt: on,fmt: off,noqa:,noqa,nosec,isort:skip,mypy: + +# List of comma separated words that should not be checked. +spelling-ignore-words= + +# A path to a file that contains the private dictionary; one word per line. +spelling-private-dict-file= + +# Tells whether to store unknown words to the private dictionary (see the +# --spelling-private-dict-file option) instead of raising a message. +spelling-store-unknown-words=no + + +[MISCELLANEOUS] + +# List of note tags to take in consideration, separated by a comma. +notes=FIXME, + XXX, + TODO + +# Regular expression of note tags to take in consideration. +#notes-rgx= + + +[VARIABLES] + +# List of additional names supposed to be defined in builtins. Remember that +# you should avoid defining new builtins when possible. +additional-builtins= + +# Tells whether unused global variables should be treated as a violation. +allow-global-unused-variables=yes + +# List of names allowed to shadow builtins +allowed-redefined-builtins= + +# List of strings which can identify a callback function by name. A callback +# name must start or end with one of those strings. +callbacks=cb_, + _cb + +# A regular expression matching the name of dummy variables (i.e. expected to +# not be used). +dummy-variables-rgx=_+$|(_[a-zA-Z0-9_]*[a-zA-Z0-9]+?$)|dummy|^ignored_|^unused_ + +# Argument names that match this expression will be ignored. Default to name +# with leading underscore. +ignored-argument-names=_.*|^ignored_|^unused_ + +# Tells whether we should check for unused import in __init__ files. +init-import=no + +# List of qualified module names which can have objects that can redefine +# builtins. +redefining-builtins-modules=six.moves,past.builtins,future.builtins,builtins,io + + +[SIMILARITIES] + +# Comments are removed from the similarity computation +ignore-comments=yes + +# Docstrings are removed from the similarity computation +ignore-docstrings=yes + +# Imports are removed from the similarity computation +ignore-imports=no + +# Signatures are removed from the similarity computation +ignore-signatures=no + +# Minimum lines number of a similarity. +min-similarity-lines=4 + + +[FORMAT] + +# Expected format of line ending, e.g. empty (any line ending), LF or CRLF. +expected-line-ending-format= + +# Regexp for a line that is allowed to be longer than the limit. +ignore-long-lines=^\s*(# )??$ + +# Number of spaces of indent required inside a hanging or continued line. +indent-after-paren=4 + +# String used as indentation unit. This is usually " " (4 spaces) or "\t" (1 +# tab). +indent-string=' ' + +# Maximum number of characters on a single line. +max-line-length=100 + +# Maximum number of lines in a module. +max-module-lines=1000 + +# Allow the body of a class to be on the same line as the declaration if body +# contains single statement. +single-line-class-stmt=no + +# Allow the body of an if to be on the same line as the test if there is no +# else. +single-line-if-stmt=no + + +[STRING] + +# This flag controls whether inconsistent-quotes generates a warning when the +# character used as a quote delimiter is used inconsistently within a module. +check-quote-consistency=no + +# This flag controls whether the implicit-str-concat should generate a warning +# on implicit string concatenation in sequences defined over several lines. +check-str-concat-over-line-jumps=no + + +[IMPORTS] + +# List of modules that can be imported at any level, not just the top level +# one. +allow-any-import-level= + +# Allow wildcard imports from modules that define __all__. +allow-wildcard-with-all=no + +# Analyse import fallback blocks. This can be used to support both Python 2 and +# 3 compatible code, which means that the block might have code that exists +# only in one or another interpreter, leading to false positives when analysed. +analyse-fallback-blocks=no + +# Deprecated modules which should not be used, separated by a comma. +deprecated-modules= + +# Output a graph (.gv or any supported image format) of external dependencies +# to the given file (report RP0402 must not be disabled). +ext-import-graph= + +# Output a graph (.gv or any supported image format) of all (i.e. internal and +# external) dependencies to the given file (report RP0402 must not be +# disabled). +import-graph= + +# Output a graph (.gv or any supported image format) of internal dependencies +# to the given file (report RP0402 must not be disabled). +int-import-graph= + +# Force import order to recognize a module as part of the standard +# compatibility libraries. +known-standard-library= + +# Force import order to recognize a module as part of a third party library. +known-third-party=enchant + +# Couples of modules and preferred modules, separated by a comma. +preferred-modules= + + +[CLASSES] + +# Warn about protected attribute access inside special methods +check-protected-access-in-special-methods=no + +# List of method names used to declare (i.e. assign) instance attributes. +defining-attr-methods=__init__, + __new__, + setUp, + __post_init__ + +# List of member names, which should be excluded from the protected access +# warning. +exclude-protected=_asdict, + _fields, + _replace, + _source, + _make + +# List of valid names for the first argument in a class method. +valid-classmethod-first-arg=cls + +# List of valid names for the first argument in a metaclass class method. +valid-metaclass-classmethod-first-arg=cls + + +[DESIGN] + +# List of regular expressions of class ancestor names to ignore when counting +# public methods (see R0903) +exclude-too-few-public-methods= + +# List of qualified class names to ignore when counting class parents (see +# R0901) +ignored-parents= + +# Maximum number of arguments for function / method. +max-args=5 + +# Maximum number of attributes for a class (see R0902). +max-attributes=7 + +# Maximum number of boolean expressions in an if statement (see R0916). +max-bool-expr=5 + +# Maximum number of branch for function / method body. +max-branches=12 + +# Maximum number of locals for function / method body. +max-locals=15 + +# Maximum number of parents for a class (see R0901). +max-parents=7 + +# Maximum number of public methods for a class (see R0904). +max-public-methods=20 + +# Maximum number of return / yield for function / method body. +max-returns=6 + +# Maximum number of statements in function / method body. +max-statements=50 + +# Minimum number of public methods for a class (see R0903). +min-public-methods=2 + + +[EXCEPTIONS] + +# Exceptions that will emit a warning when being caught. Defaults to +# "BaseException, Exception". +overgeneral-exceptions=BaseException, + Exception diff --git a/README.md b/README.md index e69de29..37feb64 100644 --- a/README.md +++ b/README.md @@ -0,0 +1,34 @@ +# Purpose + +This project creates a fully-functional demo of CP-SENS project. +The demo is to be run inside the +[DTaaS platform](https://github.com/into-cps-association/DTaaS). + +## Development Setup + +This is a [poetry-based project](https://python-poetry.org/docs/). +The relevant commands to run the project are: + +```bash +python -m venv .venv +.\.venv\Scripts\Activate.ps1 # On Windows +source .venv/bin/activate # On Linux + +pip install poetry #Specifically install poetry to your system +# If you have poetry installed globally +poetry env activate # shows the command to activate venv +pylint src --rcfile=../.pylintrc # runs linting checks + +poetry install # installs all required python packages +poetry build # builds cp-sens package that can be published on pip +poetry run start # runs the main script +``` + +## Testing + +Write tests in the _tests_ directory. Be sure to name any new files as +_test_*_.py_. To run all tests, with coverage: + +```bash +pytest --cov +``` diff --git a/poetry.lock b/poetry.lock index fd791bf..392b587 100644 --- a/poetry.lock +++ b/poetry.lock @@ -1,4 +1,4 @@ -# This file is automatically @generated by Poetry 1.8.5 and should not be changed by hand. +# This file is automatically @generated by Poetry 2.1.1 and should not be changed by hand. [[package]] name = "astroid" @@ -6,6 +6,7 @@ version = "3.3.8" description = "An abstract syntax tree for Python with inference support." optional = false python-versions = ">=3.9.0" +groups = ["dev"] files = [ {file = "astroid-3.3.8-py3-none-any.whl", hash = "sha256:187ccc0c248bfbba564826c26f070494f7bc964fd286b6d9fff4420e55de828c"}, {file = "astroid-3.3.8.tar.gz", hash = "sha256:a88c7994f914a4ea8572fac479459f4955eeccc877be3f2d959a33273b0cf40b"}, @@ -17,6 +18,8 @@ version = "0.4.6" description = "Cross-platform colored terminal text." optional = false python-versions = "!=3.0.*,!=3.1.*,!=3.2.*,!=3.3.*,!=3.4.*,!=3.5.*,!=3.6.*,>=2.7" +groups = ["dev"] +markers = "sys_platform == \"win32\"" files = [ {file = "colorama-0.4.6-py2.py3-none-any.whl", hash = "sha256:4f1d9991f5acc0ca119f9d443620b77f9d6b33703e51011c16baf57afb285fc6"}, {file = "colorama-0.4.6.tar.gz", hash = "sha256:08695f5cb7ed6e0531a20572697297273c47b8cae5a63ffc6d6ed5c201be6e44"}, @@ -28,6 +31,7 @@ version = "1.3.1" description = "Python library for calculating contours of 2D quadrilateral grids" optional = false python-versions = ">=3.10" +groups = ["main"] files = [ {file = "contourpy-1.3.1-cp310-cp310-macosx_10_9_x86_64.whl", hash = "sha256:a045f341a77b77e1c5de31e74e966537bba9f3c4099b35bf4c2e3939dd54cdab"}, {file = "contourpy-1.3.1-cp310-cp310-macosx_11_0_arm64.whl", hash = "sha256:500360b77259914f7805af7462e41f9cb7ca92ad38e9f94d6c8641b089338124"}, @@ -95,12 +99,89 @@ mypy = ["contourpy[bokeh,docs]", "docutils-stubs", "mypy (==1.11.1)", "types-Pil test = ["Pillow", "contourpy[test-no-images]", "matplotlib"] test-no-images = ["pytest", "pytest-cov", "pytest-rerunfailures", "pytest-xdist", "wurlitzer"] +[[package]] +name = "coverage" +version = "7.6.12" +description = "Code coverage measurement for Python" +optional = false +python-versions = ">=3.9" +groups = ["dev"] +files = [ + {file = "coverage-7.6.12-cp310-cp310-macosx_10_9_x86_64.whl", hash = "sha256:704c8c8c6ce6569286ae9622e534b4f5b9759b6f2cd643f1c1a61f666d534fe8"}, + {file = "coverage-7.6.12-cp310-cp310-macosx_11_0_arm64.whl", hash = "sha256:ad7525bf0241e5502168ae9c643a2f6c219fa0a283001cee4cf23a9b7da75879"}, + {file = "coverage-7.6.12-cp310-cp310-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:06097c7abfa611c91edb9e6920264e5be1d6ceb374efb4986f38b09eed4cb2fe"}, + {file = "coverage-7.6.12-cp310-cp310-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:220fa6c0ad7d9caef57f2c8771918324563ef0d8272c94974717c3909664e674"}, + {file = "coverage-7.6.12-cp310-cp310-manylinux_2_5_x86_64.manylinux1_x86_64.manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:3688b99604a24492bcfe1c106278c45586eb819bf66a654d8a9a1433022fb2eb"}, + {file = "coverage-7.6.12-cp310-cp310-musllinux_1_2_aarch64.whl", hash = "sha256:d1a987778b9c71da2fc8948e6f2656da6ef68f59298b7e9786849634c35d2c3c"}, + {file = "coverage-7.6.12-cp310-cp310-musllinux_1_2_i686.whl", hash = "sha256:cec6b9ce3bd2b7853d4a4563801292bfee40b030c05a3d29555fd2a8ee9bd68c"}, + {file = "coverage-7.6.12-cp310-cp310-musllinux_1_2_x86_64.whl", hash = "sha256:ace9048de91293e467b44bce0f0381345078389814ff6e18dbac8fdbf896360e"}, + {file = "coverage-7.6.12-cp310-cp310-win32.whl", hash = "sha256:ea31689f05043d520113e0552f039603c4dd71fa4c287b64cb3606140c66f425"}, + {file = "coverage-7.6.12-cp310-cp310-win_amd64.whl", hash = "sha256:676f92141e3c5492d2a1596d52287d0d963df21bf5e55c8b03075a60e1ddf8aa"}, + {file = "coverage-7.6.12-cp311-cp311-macosx_10_9_x86_64.whl", hash = "sha256:e18aafdfb3e9ec0d261c942d35bd7c28d031c5855dadb491d2723ba54f4c3015"}, + {file = "coverage-7.6.12-cp311-cp311-macosx_11_0_arm64.whl", hash = "sha256:66fe626fd7aa5982cdebad23e49e78ef7dbb3e3c2a5960a2b53632f1f703ea45"}, + {file = "coverage-7.6.12-cp311-cp311-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:0ef01d70198431719af0b1f5dcbefc557d44a190e749004042927b2a3fed0702"}, + {file = "coverage-7.6.12-cp311-cp311-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:07e92ae5a289a4bc4c0aae710c0948d3c7892e20fd3588224ebe242039573bf0"}, + {file = "coverage-7.6.12-cp311-cp311-manylinux_2_5_x86_64.manylinux1_x86_64.manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:e695df2c58ce526eeab11a2e915448d3eb76f75dffe338ea613c1201b33bab2f"}, + {file = "coverage-7.6.12-cp311-cp311-musllinux_1_2_aarch64.whl", hash = "sha256:d74c08e9aaef995f8c4ef6d202dbd219c318450fe2a76da624f2ebb9c8ec5d9f"}, + {file = "coverage-7.6.12-cp311-cp311-musllinux_1_2_i686.whl", hash = "sha256:e995b3b76ccedc27fe4f477b349b7d64597e53a43fc2961db9d3fbace085d69d"}, + {file = "coverage-7.6.12-cp311-cp311-musllinux_1_2_x86_64.whl", hash = "sha256:b1f097878d74fe51e1ddd1be62d8e3682748875b461232cf4b52ddc6e6db0bba"}, + {file = "coverage-7.6.12-cp311-cp311-win32.whl", hash = "sha256:1f7ffa05da41754e20512202c866d0ebfc440bba3b0ed15133070e20bf5aeb5f"}, + {file = "coverage-7.6.12-cp311-cp311-win_amd64.whl", hash = "sha256:e216c5c45f89ef8971373fd1c5d8d1164b81f7f5f06bbf23c37e7908d19e8558"}, + {file = "coverage-7.6.12-cp312-cp312-macosx_10_13_x86_64.whl", hash = "sha256:b172f8e030e8ef247b3104902cc671e20df80163b60a203653150d2fc204d1ad"}, + {file = "coverage-7.6.12-cp312-cp312-macosx_11_0_arm64.whl", hash = "sha256:641dfe0ab73deb7069fb972d4d9725bf11c239c309ce694dd50b1473c0f641c3"}, + {file = "coverage-7.6.12-cp312-cp312-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:0e549f54ac5f301e8e04c569dfdb907f7be71b06b88b5063ce9d6953d2d58574"}, + {file = "coverage-7.6.12-cp312-cp312-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:959244a17184515f8c52dcb65fb662808767c0bd233c1d8a166e7cf74c9ea985"}, + {file = "coverage-7.6.12-cp312-cp312-manylinux_2_5_x86_64.manylinux1_x86_64.manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:bda1c5f347550c359f841d6614fb8ca42ae5cb0b74d39f8a1e204815ebe25750"}, + {file = "coverage-7.6.12-cp312-cp312-musllinux_1_2_aarch64.whl", hash = "sha256:1ceeb90c3eda1f2d8c4c578c14167dbd8c674ecd7d38e45647543f19839dd6ea"}, + {file = "coverage-7.6.12-cp312-cp312-musllinux_1_2_i686.whl", hash = "sha256:0f16f44025c06792e0fb09571ae454bcc7a3ec75eeb3c36b025eccf501b1a4c3"}, + {file = "coverage-7.6.12-cp312-cp312-musllinux_1_2_x86_64.whl", hash = "sha256:b076e625396e787448d27a411aefff867db2bffac8ed04e8f7056b07024eed5a"}, + {file = "coverage-7.6.12-cp312-cp312-win32.whl", hash = "sha256:00b2086892cf06c7c2d74983c9595dc511acca00665480b3ddff749ec4fb2a95"}, + {file = "coverage-7.6.12-cp312-cp312-win_amd64.whl", hash = "sha256:7ae6eabf519bc7871ce117fb18bf14e0e343eeb96c377667e3e5dd12095e0288"}, + {file = "coverage-7.6.12-cp313-cp313-macosx_10_13_x86_64.whl", hash = "sha256:488c27b3db0ebee97a830e6b5a3ea930c4a6e2c07f27a5e67e1b3532e76b9ef1"}, + {file = "coverage-7.6.12-cp313-cp313-macosx_11_0_arm64.whl", hash = "sha256:5d1095bbee1851269f79fd8e0c9b5544e4c00c0c24965e66d8cba2eb5bb535fd"}, + {file = "coverage-7.6.12-cp313-cp313-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:0533adc29adf6a69c1baa88c3d7dbcaadcffa21afbed3ca7a225a440e4744bf9"}, + {file = "coverage-7.6.12-cp313-cp313-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:53c56358d470fa507a2b6e67a68fd002364d23c83741dbc4c2e0680d80ca227e"}, + {file = "coverage-7.6.12-cp313-cp313-manylinux_2_5_x86_64.manylinux1_x86_64.manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:64cbb1a3027c79ca6310bf101014614f6e6e18c226474606cf725238cf5bc2d4"}, + {file = "coverage-7.6.12-cp313-cp313-musllinux_1_2_aarch64.whl", hash = "sha256:79cac3390bfa9836bb795be377395f28410811c9066bc4eefd8015258a7578c6"}, + {file = "coverage-7.6.12-cp313-cp313-musllinux_1_2_i686.whl", hash = "sha256:9b148068e881faa26d878ff63e79650e208e95cf1c22bd3f77c3ca7b1d9821a3"}, + {file = "coverage-7.6.12-cp313-cp313-musllinux_1_2_x86_64.whl", hash = "sha256:8bec2ac5da793c2685ce5319ca9bcf4eee683b8a1679051f8e6ec04c4f2fd7dc"}, + {file = "coverage-7.6.12-cp313-cp313-win32.whl", hash = "sha256:200e10beb6ddd7c3ded322a4186313d5ca9e63e33d8fab4faa67ef46d3460af3"}, + {file = "coverage-7.6.12-cp313-cp313-win_amd64.whl", hash = "sha256:2b996819ced9f7dbb812c701485d58f261bef08f9b85304d41219b1496b591ef"}, + {file = "coverage-7.6.12-cp313-cp313t-macosx_10_13_x86_64.whl", hash = "sha256:299cf973a7abff87a30609879c10df0b3bfc33d021e1adabc29138a48888841e"}, + {file = "coverage-7.6.12-cp313-cp313t-macosx_11_0_arm64.whl", hash = "sha256:4b467a8c56974bf06e543e69ad803c6865249d7a5ccf6980457ed2bc50312703"}, + {file = "coverage-7.6.12-cp313-cp313t-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:2458f275944db8129f95d91aee32c828a408481ecde3b30af31d552c2ce284a0"}, + {file = "coverage-7.6.12-cp313-cp313t-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:0a9d8be07fb0832636a0f72b80d2a652fe665e80e720301fb22b191c3434d924"}, + {file = "coverage-7.6.12-cp313-cp313t-manylinux_2_5_x86_64.manylinux1_x86_64.manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:14d47376a4f445e9743f6c83291e60adb1b127607a3618e3185bbc8091f0467b"}, + {file = "coverage-7.6.12-cp313-cp313t-musllinux_1_2_aarch64.whl", hash = "sha256:b95574d06aa9d2bd6e5cc35a5bbe35696342c96760b69dc4287dbd5abd4ad51d"}, + {file = "coverage-7.6.12-cp313-cp313t-musllinux_1_2_i686.whl", hash = "sha256:ecea0c38c9079570163d663c0433a9af4094a60aafdca491c6a3d248c7432827"}, + {file = "coverage-7.6.12-cp313-cp313t-musllinux_1_2_x86_64.whl", hash = "sha256:2251fabcfee0a55a8578a9d29cecfee5f2de02f11530e7d5c5a05859aa85aee9"}, + {file = "coverage-7.6.12-cp313-cp313t-win32.whl", hash = "sha256:eb5507795caabd9b2ae3f1adc95f67b1104971c22c624bb354232d65c4fc90b3"}, + {file = "coverage-7.6.12-cp313-cp313t-win_amd64.whl", hash = "sha256:f60a297c3987c6c02ffb29effc70eadcbb412fe76947d394a1091a3615948e2f"}, + {file = "coverage-7.6.12-cp39-cp39-macosx_10_9_x86_64.whl", hash = "sha256:e7575ab65ca8399c8c4f9a7d61bbd2d204c8b8e447aab9d355682205c9dd948d"}, + {file = "coverage-7.6.12-cp39-cp39-macosx_11_0_arm64.whl", hash = "sha256:8161d9fbc7e9fe2326de89cd0abb9f3599bccc1287db0aba285cb68d204ce929"}, + {file = "coverage-7.6.12-cp39-cp39-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:3a1e465f398c713f1b212400b4e79a09829cd42aebd360362cd89c5bdc44eb87"}, + {file = "coverage-7.6.12-cp39-cp39-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:f25d8b92a4e31ff1bd873654ec367ae811b3a943583e05432ea29264782dc32c"}, + {file = "coverage-7.6.12-cp39-cp39-manylinux_2_5_x86_64.manylinux1_x86_64.manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:1a936309a65cc5ca80fa9f20a442ff9e2d06927ec9a4f54bcba9c14c066323f2"}, + {file = "coverage-7.6.12-cp39-cp39-musllinux_1_2_aarch64.whl", hash = "sha256:aa6f302a3a0b5f240ee201297fff0bbfe2fa0d415a94aeb257d8b461032389bd"}, + {file = "coverage-7.6.12-cp39-cp39-musllinux_1_2_i686.whl", hash = "sha256:f973643ef532d4f9be71dd88cf7588936685fdb576d93a79fe9f65bc337d9d73"}, + {file = "coverage-7.6.12-cp39-cp39-musllinux_1_2_x86_64.whl", hash = "sha256:78f5243bb6b1060aed6213d5107744c19f9571ec76d54c99cc15938eb69e0e86"}, + {file = "coverage-7.6.12-cp39-cp39-win32.whl", hash = "sha256:69e62c5034291c845fc4df7f8155e8544178b6c774f97a99e2734b05eb5bed31"}, + {file = "coverage-7.6.12-cp39-cp39-win_amd64.whl", hash = "sha256:b01a840ecc25dce235ae4c1b6a0daefb2a203dba0e6e980637ee9c2f6ee0df57"}, + {file = "coverage-7.6.12-pp39.pp310-none-any.whl", hash = "sha256:7e39e845c4d764208e7b8f6a21c541ade741e2c41afabdfa1caa28687a3c98cf"}, + {file = "coverage-7.6.12-py3-none-any.whl", hash = "sha256:eb8668cfbc279a536c633137deeb9435d2962caec279c3f8cf8b91fff6ff8953"}, + {file = "coverage-7.6.12.tar.gz", hash = "sha256:48cfc4641d95d34766ad41d9573cc0f22a48aa88d22657a1fe01dca0dbae4de2"}, +] + +[package.extras] +toml = ["tomli ; python_full_version <= \"3.11.0a6\""] + [[package]] name = "cycler" version = "0.12.1" description = "Composable style cycles" optional = false python-versions = ">=3.8" +groups = ["main"] files = [ {file = "cycler-0.12.1-py3-none-any.whl", hash = "sha256:85cef7cff222d8644161529808465972e51340599459b8ac3ccbac5a854e0d30"}, {file = "cycler-0.12.1.tar.gz", hash = "sha256:88bb128f02ba341da8ef447245a9e138fae777f6a23943da4540077d3601eb1c"}, @@ -116,6 +197,7 @@ version = "0.3.9" description = "serialize all of Python" optional = false python-versions = ">=3.8" +groups = ["dev"] files = [ {file = "dill-0.3.9-py3-none-any.whl", hash = "sha256:468dff3b89520b474c0397703366b7b95eebe6303f108adf9b19da1f702be87a"}, {file = "dill-0.3.9.tar.gz", hash = "sha256:81aa267dddf68cbfe8029c42ca9ec6a4ab3b22371d1c450abc54422577b4512c"}, @@ -131,6 +213,7 @@ version = "4.55.3" description = "Tools to manipulate font files" optional = false python-versions = ">=3.8" +groups = ["main"] files = [ {file = "fonttools-4.55.3-cp310-cp310-macosx_10_9_universal2.whl", hash = "sha256:1dcc07934a2165ccdc3a5a608db56fb3c24b609658a5b340aee4ecf3ba679dc0"}, {file = "fonttools-4.55.3-cp310-cp310-macosx_10_9_x86_64.whl", hash = "sha256:f7d66c15ba875432a2d2fb419523f5d3d347f91f48f57b8b08a2dfc3c39b8a3f"}, @@ -185,18 +268,18 @@ files = [ ] [package.extras] -all = ["brotli (>=1.0.1)", "brotlicffi (>=0.8.0)", "fs (>=2.2.0,<3)", "lxml (>=4.0)", "lz4 (>=1.7.4.2)", "matplotlib", "munkres", "pycairo", "scipy", "skia-pathops (>=0.5.0)", "sympy", "uharfbuzz (>=0.23.0)", "unicodedata2 (>=15.1.0)", "xattr", "zopfli (>=0.1.4)"] +all = ["brotli (>=1.0.1) ; platform_python_implementation == \"CPython\"", "brotlicffi (>=0.8.0) ; platform_python_implementation != \"CPython\"", "fs (>=2.2.0,<3)", "lxml (>=4.0)", "lz4 (>=1.7.4.2)", "matplotlib", "munkres ; platform_python_implementation == \"PyPy\"", "pycairo", "scipy ; platform_python_implementation != \"PyPy\"", "skia-pathops (>=0.5.0)", "sympy", "uharfbuzz (>=0.23.0)", "unicodedata2 (>=15.1.0) ; python_version <= \"3.12\"", "xattr ; sys_platform == \"darwin\"", "zopfli (>=0.1.4)"] graphite = ["lz4 (>=1.7.4.2)"] -interpolatable = ["munkres", "pycairo", "scipy"] +interpolatable = ["munkres ; platform_python_implementation == \"PyPy\"", "pycairo", "scipy ; platform_python_implementation != \"PyPy\""] lxml = ["lxml (>=4.0)"] pathops = ["skia-pathops (>=0.5.0)"] plot = ["matplotlib"] repacker = ["uharfbuzz (>=0.23.0)"] symfont = ["sympy"] -type1 = ["xattr"] +type1 = ["xattr ; sys_platform == \"darwin\""] ufo = ["fs (>=2.2.0,<3)"] -unicode = ["unicodedata2 (>=15.1.0)"] -woff = ["brotli (>=1.0.1)", "brotlicffi (>=0.8.0)", "zopfli (>=0.1.4)"] +unicode = ["unicodedata2 (>=15.1.0) ; python_version <= \"3.12\""] +woff = ["brotli (>=1.0.1) ; platform_python_implementation == \"CPython\"", "brotlicffi (>=0.8.0) ; platform_python_implementation != \"CPython\"", "zopfli (>=0.1.4)"] [[package]] name = "iniconfig" @@ -204,6 +287,7 @@ version = "2.0.0" description = "brain-dead simple config-ini parsing" optional = false python-versions = ">=3.7" +groups = ["dev"] files = [ {file = "iniconfig-2.0.0-py3-none-any.whl", hash = "sha256:b6a85871a79d2e3b22d2d1b94ac2824226a63c6b741c88f7ae975f18b6778374"}, {file = "iniconfig-2.0.0.tar.gz", hash = "sha256:2d91e135bf72d31a410b17c16da610a82cb55f6b0477d1a902134b24a455b8b3"}, @@ -215,6 +299,7 @@ version = "5.13.2" description = "A Python utility / library to sort Python imports." optional = false python-versions = ">=3.8.0" +groups = ["dev"] files = [ {file = "isort-5.13.2-py3-none-any.whl", hash = "sha256:8ca5e72a8d85860d5a3fa69b8745237f2939afe12dbf656afbcb47fe72d947a6"}, {file = "isort-5.13.2.tar.gz", hash = "sha256:48fdfcb9face5d58a4f6dde2e72a1fb8dcaf8ab26f95ab49fab84c2ddefb0109"}, @@ -229,6 +314,7 @@ version = "1.4.8" description = "A fast implementation of the Cassowary constraint solver" optional = false python-versions = ">=3.10" +groups = ["main"] files = [ {file = "kiwisolver-1.4.8-cp310-cp310-macosx_10_9_universal2.whl", hash = "sha256:88c6f252f6816a73b1f8c904f7bbe02fd67c09a69f7cb8a0eecdbf5ce78e63db"}, {file = "kiwisolver-1.4.8-cp310-cp310-macosx_10_9_x86_64.whl", hash = "sha256:c72941acb7b67138f35b879bbe85be0f6c6a70cab78fe3ef6db9c024d9223e5b"}, @@ -318,6 +404,7 @@ version = "3.10.0" description = "Python plotting package" optional = false python-versions = ">=3.10" +groups = ["main"] files = [ {file = "matplotlib-3.10.0-cp310-cp310-macosx_10_12_x86_64.whl", hash = "sha256:2c5829a5a1dd5a71f0e31e6e8bb449bc0ee9dbfb05ad28fc0c6b55101b3a4be6"}, {file = "matplotlib-3.10.0-cp310-cp310-macosx_11_0_arm64.whl", hash = "sha256:a2a43cbefe22d653ab34bb55d42384ed30f611bcbdea1f8d7f431011a2e1c62e"}, @@ -375,6 +462,7 @@ version = "0.7.0" description = "McCabe checker, plugin for flake8" optional = false python-versions = ">=3.6" +groups = ["dev"] files = [ {file = "mccabe-0.7.0-py2.py3-none-any.whl", hash = "sha256:6c2d30ab6be0e4a46919781807b4f0d834ebdd6c6e3dca0bda5a15f863427b6e"}, {file = "mccabe-0.7.0.tar.gz", hash = "sha256:348e0240c33b60bbdf4e523192ef919f28cb2c3d7d5c7794f74009290f236325"}, @@ -386,6 +474,7 @@ version = "2.2.1" description = "Fundamental package for array computing in Python" optional = false python-versions = ">=3.10" +groups = ["main"] files = [ {file = "numpy-2.2.1-cp310-cp310-macosx_10_9_x86_64.whl", hash = "sha256:5edb4e4caf751c1518e6a26a83501fda79bff41cc59dac48d70e6d65d4ec4440"}, {file = "numpy-2.2.1-cp310-cp310-macosx_11_0_arm64.whl", hash = "sha256:aa3017c40d513ccac9621a2364f939d39e550c542eb2a894b4c8da92b38896ab"}, @@ -450,6 +539,7 @@ version = "24.2" description = "Core utilities for Python packages" optional = false python-versions = ">=3.8" +groups = ["main", "dev"] files = [ {file = "packaging-24.2-py3-none-any.whl", hash = "sha256:09abb1bccd265c01f4a3aa3f7a7db064b36514d2cba19a2f694fe6150451a759"}, {file = "packaging-24.2.tar.gz", hash = "sha256:c228a6dc5e932d346bc5739379109d49e8853dd8223571c7c5b55260edc0b97f"}, @@ -461,6 +551,7 @@ version = "2.1.0" description = "MQTT version 5.0/3.1.1 client class" optional = false python-versions = ">=3.7" +groups = ["main"] files = [ {file = "paho_mqtt-2.1.0-py3-none-any.whl", hash = "sha256:6db9ba9b34ed5bc6b6e3812718c7e06e2fd7444540df2455d2c51bd58808feee"}, {file = "paho_mqtt-2.1.0.tar.gz", hash = "sha256:12d6e7511d4137555a3f6ea167ae846af2c7357b10bc6fa4f7c3968fc1723834"}, @@ -475,6 +566,7 @@ version = "11.0.0" description = "Python Imaging Library (Fork)" optional = false python-versions = ">=3.9" +groups = ["main"] files = [ {file = "pillow-11.0.0-cp310-cp310-macosx_10_10_x86_64.whl", hash = "sha256:6619654954dc4936fcff82db8eb6401d3159ec6be81e33c6000dfd76ae189947"}, {file = "pillow-11.0.0-cp310-cp310-macosx_11_0_arm64.whl", hash = "sha256:b3c5ac4bed7519088103d9450a1107f76308ecf91d6dabc8a33a2fcfb18d0fba"}, @@ -558,7 +650,7 @@ docs = ["furo", "olefile", "sphinx (>=8.1)", "sphinx-copybutton", "sphinx-inline fpx = ["olefile"] mic = ["olefile"] tests = ["check-manifest", "coverage", "defusedxml", "markdown2", "olefile", "packaging", "pyroma", "pytest", "pytest-cov", "pytest-timeout"] -typing = ["typing-extensions"] +typing = ["typing-extensions ; python_version < \"3.10\""] xmp = ["defusedxml"] [[package]] @@ -567,6 +659,7 @@ version = "4.3.6" description = "A small Python package for determining appropriate platform-specific dirs, e.g. a `user data dir`." optional = false python-versions = ">=3.8" +groups = ["dev"] files = [ {file = "platformdirs-4.3.6-py3-none-any.whl", hash = "sha256:73e575e1408ab8103900836b97580d5307456908a03e92031bab39e4554cc3fb"}, {file = "platformdirs-4.3.6.tar.gz", hash = "sha256:357fb2acbc885b0419afd3ce3ed34564c13c9b95c89360cd9563f73aa5e2b907"}, @@ -583,6 +676,7 @@ version = "1.5.0" description = "plugin and hook calling mechanisms for python" optional = false python-versions = ">=3.8" +groups = ["dev"] files = [ {file = "pluggy-1.5.0-py3-none-any.whl", hash = "sha256:44e1ad92c8ca002de6377e165f3e0f1be63266ab4d554740532335b9d75ea669"}, {file = "pluggy-1.5.0.tar.gz", hash = "sha256:2cffa88e94fdc978c4c574f15f9e59b7f4201d439195c3715ca9e2486f1d0cf1"}, @@ -598,6 +692,7 @@ version = "3.3.3" description = "python code static checker" optional = false python-versions = ">=3.9.0" +groups = ["dev"] files = [ {file = "pylint-3.3.3-py3-none-any.whl", hash = "sha256:26e271a2bc8bce0fc23833805a9076dd9b4d5194e2a02164942cb3cdc37b4183"}, {file = "pylint-3.3.3.tar.gz", hash = "sha256:07c607523b17e6d16e2ae0d7ef59602e332caa762af64203c24b41c27139f36a"}, @@ -608,7 +703,7 @@ astroid = ">=3.3.8,<=3.4.0-dev0" colorama = {version = ">=0.4.5", markers = "sys_platform == \"win32\""} dill = [ {version = ">=0.3.7", markers = "python_version >= \"3.12\""}, - {version = ">=0.3.6", markers = "python_version >= \"3.11\" and python_version < \"3.12\""}, + {version = ">=0.3.6", markers = "python_version == \"3.11\""}, ] isort = ">=4.2.5,<5.13.0 || >5.13.0,<6" mccabe = ">=0.6,<0.8" @@ -625,6 +720,7 @@ version = "3.2.0" description = "pyparsing module - Classes and methods to define and execute parsing grammars" optional = false python-versions = ">=3.9" +groups = ["main"] files = [ {file = "pyparsing-3.2.0-py3-none-any.whl", hash = "sha256:93d9577b88da0bbea8cc8334ee8b918ed014968fd2ec383e868fb8afb1ccef84"}, {file = "pyparsing-3.2.0.tar.gz", hash = "sha256:cbf74e27246d595d9a74b186b810f6fbb86726dbf3b9532efb343f6d7294fe9c"}, @@ -639,6 +735,7 @@ version = "8.3.4" description = "pytest: simple powerful testing with Python" optional = false python-versions = ">=3.8" +groups = ["dev"] files = [ {file = "pytest-8.3.4-py3-none-any.whl", hash = "sha256:50e16d954148559c9a74109af1eaf0c945ba2d8f30f0a3d3335edde19788b6f6"}, {file = "pytest-8.3.4.tar.gz", hash = "sha256:965370d062bce11e73868e0335abac31b4d3de0e82f4007408d242b4f8610761"}, @@ -653,12 +750,32 @@ pluggy = ">=1.5,<2" [package.extras] dev = ["argcomplete", "attrs (>=19.2)", "hypothesis (>=3.56)", "mock", "pygments (>=2.7.2)", "requests", "setuptools", "xmlschema"] +[[package]] +name = "pytest-cov" +version = "6.0.0" +description = "Pytest plugin for measuring coverage." +optional = false +python-versions = ">=3.9" +groups = ["dev"] +files = [ + {file = "pytest-cov-6.0.0.tar.gz", hash = "sha256:fde0b595ca248bb8e2d76f020b465f3b107c9632e6a1d1705f17834c89dcadc0"}, + {file = "pytest_cov-6.0.0-py3-none-any.whl", hash = "sha256:eee6f1b9e61008bd34975a4d5bab25801eb31898b032dd55addc93e96fcaaa35"}, +] + +[package.dependencies] +coverage = {version = ">=7.5", extras = ["toml"]} +pytest = ">=4.6" + +[package.extras] +testing = ["fields", "hunter", "process-tests", "pytest-xdist", "virtualenv"] + [[package]] name = "python-dateutil" version = "2.9.0.post0" description = "Extensions to the standard Python datetime module" optional = false python-versions = "!=3.0.*,!=3.1.*,!=3.2.*,>=2.7" +groups = ["main"] files = [ {file = "python-dateutil-2.9.0.post0.tar.gz", hash = "sha256:37dd54208da7e1cd875388217d5e00ebd4179249f90fb72437e91a35459a0ad3"}, {file = "python_dateutil-2.9.0.post0-py2.py3-none-any.whl", hash = "sha256:a8b2bc7bffae282281c8140a97d3aa9c14da0b136dfe83f850eea9a5f7470427"}, @@ -673,6 +790,7 @@ version = "1.17.0" description = "Python 2 and 3 compatibility utilities" optional = false python-versions = "!=3.0.*,!=3.1.*,!=3.2.*,>=2.7" +groups = ["main"] files = [ {file = "six-1.17.0-py2.py3-none-any.whl", hash = "sha256:4721f391ed90541fddacab5acf947aa0d3dc7d27b2e1e8eda2be8970586c3274"}, {file = "six-1.17.0.tar.gz", hash = "sha256:ff70335d468e7eb6ec65b95b99d3a2836546063f63acc5171de367e834932a81"}, @@ -684,12 +802,13 @@ version = "0.13.2" description = "Style preserving TOML library" optional = false python-versions = ">=3.8" +groups = ["dev"] files = [ {file = "tomlkit-0.13.2-py3-none-any.whl", hash = "sha256:7a974427f6e119197f670fbbbeae7bef749a6c14e793db934baefc1b5f03efde"}, {file = "tomlkit-0.13.2.tar.gz", hash = "sha256:fff5fe59a87295b278abd31bec92c15d9bc4a06885ab12bcea52c71119392e79"}, ] [metadata] -lock-version = "2.0" +lock-version = "2.1" python-versions = "^3.11" -content-hash = "60ad97a40d188728876ef8d59fb3178607a3d6e7df0c026834107de55d197b82" +content-hash = "624ccebfb71fd020a3379f1770fa9683f59e9887380c9c1fad27c586735bc4be" diff --git a/pyproject.toml b/pyproject.toml index 177028a..c04a576 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -4,17 +4,22 @@ version = "0.1.0" description = "" authors = ["prasadtalasila "] readme = "README.md" +license = "INTO-CPS Association" +packages = [{include = "*", from="src"}] [tool.poetry.dependencies] python = "^3.11" paho-mqtt = "^2.1.0" matplotlib = "^3.10.0" - [tool.poetry.group.dev.dependencies] pylint = "^3.3.3" pytest = "^8.3.4" +pytest-cov = "^6.0.0" [build-system] requires = ["poetry-core"] build-backend = "poetry.core.masonry.api" + +[tool.poetry.scripts] +start = "src.main:main" diff --git a/src/main.py b/src/main.py new file mode 100644 index 0000000..63248d4 --- /dev/null +++ b/src/main.py @@ -0,0 +1,6 @@ + +def main() -> None: + print("Hello World") + +if __name__ == "__main__": + main() From 12f2cd1478f662d81acc0178ef85bdc172531008 Mon Sep 17 00:00:00 2001 From: prasadtalasila Date: Sat, 22 Feb 2025 11:03:06 +0100 Subject: [PATCH 4/5] Fixes tests --- src/cp-sens/data/{__init.py__ => __init__.py} | 0 src/cp-sens/data/accel/hbk/METADATA.md | 30 +++++++++++++------ src/cp-sens/data/accel/hbk/accelerometer.py | 9 +++--- .../data/accel/hbk/test_accelerometer.py | 2 +- 4 files changed, 27 insertions(+), 14 deletions(-) rename src/cp-sens/data/{__init.py__ => __init__.py} (100%) rename tests/{ => cp-sens}/data/accel/hbk/test_accelerometer.py (98%) diff --git a/src/cp-sens/data/__init.py__ b/src/cp-sens/data/__init__.py similarity index 100% rename from src/cp-sens/data/__init.py__ rename to src/cp-sens/data/__init__.py diff --git a/src/cp-sens/data/accel/hbk/METADATA.md b/src/cp-sens/data/accel/hbk/METADATA.md index eecbcaf..da79800 100644 --- a/src/cp-sens/data/accel/hbk/METADATA.md +++ b/src/cp-sens/data/accel/hbk/METADATA.md @@ -1,38 +1,51 @@ # METADATA Documentation ## Overview + This document describes the structure and handling of the metadata and data topics used in the MQTT communication system for accelerometer sensors. It explains the format of the payloads, metadata versioning, data consistency checks, and handling sensor-specific metadata. The MQTT system uses hierarchical topics to identify the source and type of data. The two key topics are: + 1. **Data Topic**: Contains dynamic data from sensors. -2. **Metadata Topic**: Contains static information, including metadata related to the sensor, analysis chain, and engineering information. +1. **Metadata Topic**: Contains static information, including metadata related to the sensor, analysis chain, and engineering information. ## MQTT Topic Format + The MQTT topic structure follows the pattern: +```txt cpsens/DAQ_ID/MODULE_ID/CH_ID/PHYSICS/ANALYSIS/DATA_ID +``` +### Example Topics -### Example Topics: -- **Data Topic**: -cpsens/RPi_1234/1/1/acc/raw/data +#### Data Topic +```txt +cpsens/RPi_1234/1/1/acc/raw/data +``` This represents data coming from an accelerometer (`acc`), processed as raw data (`raw`), from channel 1 of module 1 on device `RPi_1234`. -- **Metadata Topic**: +#### Metadata Topic + +```txt cpsens/RPi_1234/1/1/acc/raw/metadata +``` This topic contains metadata for the raw data from the same device, module, and channel. ## Payload Format ### Data Topic Payload + The **data topic** payload consists of two parts: + 1. **Descriptor**: Contains dynamic metadata related to the data. -2. **Data**: Contains the actual sensor readings (typically as binary data). +1. **Data**: Contains the actual sensor readings (typically as binary data). + +#### Example Data Topic Payload -#### Example Data Topic Payload: ```json { "descriptor": { @@ -60,5 +73,4 @@ The **data topic** payload consists of two parts: } } } - - +``` diff --git a/src/cp-sens/data/accel/hbk/accelerometer.py b/src/cp-sens/data/accel/hbk/accelerometer.py index da918f4..602f464 100644 --- a/src/cp-sens/data/accel/hbk/accelerometer.py +++ b/src/cp-sens/data/accel/hbk/accelerometer.py @@ -2,8 +2,6 @@ import os from paho.mqtt.client import Client as MQTTClient, CallbackAPIVersion, MQTTv5 # type: ignore - - def load_config(config_path: str) -> dict: """ Loads JSON configuration from the provided config path. @@ -79,10 +77,13 @@ def setup_mqtt_client(config): mqttc.on_publish = create_on_publish_callback() return mqttc -if __name__ == "__main__": +def main() -> None: current_dir = os.path.dirname(os.path.abspath(__file__)) config_path = os.path.join(current_dir, "../../config/mqtt.json") json_config = load_config(config_path) mqttc = setup_mqtt_client(json_config) mqttc.connect(json_config["MQTT"]["host"], json_config["MQTT"]["port"], 60) - mqttc.loop_start() \ No newline at end of file + mqttc.loop_start() + +if __name__ == "__main__": + main() \ No newline at end of file diff --git a/tests/data/accel/hbk/test_accelerometer.py b/tests/cp-sens/data/accel/hbk/test_accelerometer.py similarity index 98% rename from tests/data/accel/hbk/test_accelerometer.py rename to tests/cp-sens/data/accel/hbk/test_accelerometer.py index 9ac381c..7a31785 100644 --- a/tests/data/accel/hbk/test_accelerometer.py +++ b/tests/cp-sens/data/accel/hbk/test_accelerometer.py @@ -4,7 +4,7 @@ from unittest.mock import MagicMock import sys -sys.path.append(os.path.abspath(os.path.join(os.path.dirname(__file__), "../../../../src/cp-sens"))) +sys.path.append(os.path.abspath(os.path.join(os.path.dirname(__file__), "../../../../../src/cp-sens"))) from data.accel.hbk.accelerometer import ( create_on_connect_callback, From ffca4a06f9a38af2f71c55f8fed8052c43380f94 Mon Sep 17 00:00:00 2001 From: prasadtalasila Date: Sat, 22 Feb 2025 13:18:36 +0100 Subject: [PATCH 5/5] Refactors code and adds work plan --- README.md | 12 +++++++- TODO.md | 29 +++++++++++++++++++ pytest.ini | 15 ++++++++++ src/cp-sens/{data => }/config/mqtt.json | 0 src/cp-sens/data/accel/hbk/.gitkeep | 0 src/cp-sens/data/sources/__init__.py | 0 .../hbk/accelerometer.py => sources/mqtt.py} | 15 +++------- .../test_mqtt.py} | 9 ++---- 8 files changed, 62 insertions(+), 18 deletions(-) create mode 100644 TODO.md create mode 100644 pytest.ini rename src/cp-sens/{data => }/config/mqtt.json (100%) create mode 100644 src/cp-sens/data/accel/hbk/.gitkeep create mode 100644 src/cp-sens/data/sources/__init__.py rename src/cp-sens/data/{accel/hbk/accelerometer.py => sources/mqtt.py} (84%) rename tests/cp-sens/data/{accel/hbk/test_accelerometer.py => sources/test_mqtt.py} (91%) diff --git a/README.md b/README.md index 37feb64..80415fe 100644 --- a/README.md +++ b/README.md @@ -30,5 +30,15 @@ Write tests in the _tests_ directory. Be sure to name any new files as _test_*_.py_. To run all tests, with coverage: ```bash -pytest --cov +pytest +``` + +## Use + +Only MQTT client code is working at the moment. +You can use it by setting the `src/cp-sens/data/config/mqtt.json` +and executing, + +```bash +python .\src\cp-sens\data\sources\mqtt.py ``` diff --git a/TODO.md b/TODO.md new file mode 100644 index 0000000..ca3c155 --- /dev/null +++ b/TODO.md @@ -0,0 +1,29 @@ +# TODO + +1. Convert live HBK data into numpy array + +2. Integrate synchronous MQTT class into + codebase + +3. Add and integrate SysID into the project + +4. Add local ADXL375 setup as data source + +5. Integrate model update into the project + (use YaFEM package) + +6. Wrap both _SysID_ and _Model Update_ + into MQTT blocks. + +7. Perform live distributed simulation + of _SysID_ and _Model Update_. + +8. Save the received MQTT readings into + 1. `.bin` file used by Dmitri + 2. json file + 3. json file to be pushed into MongoDB + +9. Load structured data into numpy from + 1. `.bin` file used by Dmitri + (script available in + `https://dtl-server-2.st.lab.au.dk/TestUserDTaaS/notebooks/common/hbk/pyOMA-2%20test/OMA_on_my_beam.py`) diff --git a/pytest.ini b/pytest.ini new file mode 100644 index 0000000..1a38571 --- /dev/null +++ b/pytest.ini @@ -0,0 +1,15 @@ +[pytest] +minversion = 8.3 +pythonpath = src/cp-sens tests/cp-sens +testpaths = + tests +addopts = --cov=src --cov-report=term-missing --cov-report=html +python_files = test_*.py + +log_cli=true +log_level=DEBUG +log_format = %(asctime)s %(levelname)s %(message)s +log_date_format = %Y-%m-%d %H:%M:%S + +#timeout slow tests +timeout=5 diff --git a/src/cp-sens/data/config/mqtt.json b/src/cp-sens/config/mqtt.json similarity index 100% rename from src/cp-sens/data/config/mqtt.json rename to src/cp-sens/config/mqtt.json diff --git a/src/cp-sens/data/accel/hbk/.gitkeep b/src/cp-sens/data/accel/hbk/.gitkeep new file mode 100644 index 0000000..e69de29 diff --git a/src/cp-sens/data/sources/__init__.py b/src/cp-sens/data/sources/__init__.py new file mode 100644 index 0000000..e69de29 diff --git a/src/cp-sens/data/accel/hbk/accelerometer.py b/src/cp-sens/data/sources/mqtt.py similarity index 84% rename from src/cp-sens/data/accel/hbk/accelerometer.py rename to src/cp-sens/data/sources/mqtt.py index 602f464..1166e8a 100644 --- a/src/cp-sens/data/accel/hbk/accelerometer.py +++ b/src/cp-sens/data/sources/mqtt.py @@ -1,5 +1,6 @@ import json import os +import time from paho.mqtt.client import Client as MQTTClient, CallbackAPIVersion, MQTTv5 # type: ignore def load_config(config_path: str) -> dict: @@ -36,23 +37,14 @@ def on_connect(client, userdata, flags, rc, properties=None): return on_connect def create_on_subscribe_callback(): - def on_subscribe(client, userdata, mid, granted_qos): - print(f"on_subscribe: Subscription ID {mid} with QoS levels {granted_qos}") - return on_subscribe -def create_on_subscribe_callback(): - def on_subscribe(client, userdata, mid, granted_qos): + def on_subscribe(client, userdata, mid, granted_qos, properties=None): print(f"on_subscribe: Subscription ID {mid} with QoS levels {granted_qos}") return on_subscribe def create_on_message_callback(): def on_message(client, userdata, msg): print(f"on_message: Received message on {msg.topic}") - print(f"Message payload: {msg.payload.decode()}") - return on_message -def create_on_message_callback(): - def on_message(client, userdata, msg): - print(f"on_message: Received message on {msg.topic}") - print(f"Message payload: {msg.payload.decode()}") + #print(f"Message payload: {msg.payload.decode()}") return on_message def create_on_publish_callback(): @@ -84,6 +76,7 @@ def main() -> None: mqttc = setup_mqtt_client(json_config) mqttc.connect(json_config["MQTT"]["host"], json_config["MQTT"]["port"], 60) mqttc.loop_start() + time.sleep(10) if __name__ == "__main__": main() \ No newline at end of file diff --git a/tests/cp-sens/data/accel/hbk/test_accelerometer.py b/tests/cp-sens/data/sources/test_mqtt.py similarity index 91% rename from tests/cp-sens/data/accel/hbk/test_accelerometer.py rename to tests/cp-sens/data/sources/test_mqtt.py index 7a31785..d3d871d 100644 --- a/tests/cp-sens/data/accel/hbk/test_accelerometer.py +++ b/tests/cp-sens/data/sources/test_mqtt.py @@ -3,10 +3,7 @@ import pytest from unittest.mock import MagicMock -import sys -sys.path.append(os.path.abspath(os.path.join(os.path.dirname(__file__), "../../../../../src/cp-sens"))) - -from data.accel.hbk.accelerometer import ( +from data.sources.mqtt import ( create_on_connect_callback, create_on_subscribe_callback, create_on_message_callback, @@ -40,7 +37,7 @@ def test_on_subscribe_callback(capsys): on_subscribe = create_on_subscribe_callback() client = MagicMock() # Call on_subscribe with a sample message id and granted QoS list. - on_subscribe(client, None, 42, [1, 1]) + on_subscribe(client, None, 42, [1, 1], properties=None) captured = capsys.readouterr().out assert "Subscription ID 42" in captured assert "QoS levels [1, 1]" in captured @@ -58,7 +55,7 @@ class FakeMsg: on_message(client, None, fake_msg) captured = capsys.readouterr().out assert "Received message on test/topic" in captured - assert "Message payload: test payload" in captured + #assert "Message payload: test payload" in captured def test_on_publish_callback(capsys): on_publish = create_on_publish_callback()