Merge remote-tracking branch 'origin/main' into add-option-for-custom-openapi-metadata

Author: Teddy-1000

.pre-commit-config.yaml

@@ -65,13 +65,13 @@ repos:
         args: ["--ignore=W503", "--max-line-length=120"]
 
   # hadolint ~ Docker linter
-  - repo: https://github.com/hadolint/hadolint
-    rev: v2.13.1-beta
-    hooks:
-      - id: hadolint-docker
-        args: [
-            "--ignore=DL3008", # Pin versions in apt get install.
-          ]
+  #- repo: https://github.com/hadolint/hadolint
+  #  rev: v2.13.1-beta
+  #  hooks:
+  #    - id: hadolint-docker
+  #      args: [
+  #          "--ignore=DL3008", # Pin versions in apt get install.
+  #        ]
 
   # ShellCheck ~ Gives warnings and suggestions for bash/sh shell scripts
   - repo: https://github.com/koalaman/shellcheck-precommit

docker-compose.yml

@@ -113,6 +113,7 @@ services:
       - MQTT_PASSWORD=${MQTT_PASSWORD}
       - MQTT_PORT=${MQTT_PORT:-1883}
       - MQTT_TLS=${MQTT_TLS:-False}
+      - MQTT_PROTOCOL_VERSION=${MQTT_PROTOCOL_VERSION:-5}
       - MQTT_TOPIC_PREPEND=${MQTT_TOPIC_PREPEND:-'TEMP_TOPIC'}
       - WIS2_TOPIC=${WIS2_TOPIC:-'TEMP_TOPIC'}
       - WIS2_MQTT_HOST=${MQTT_HOST:-mqtt_wis2}

ingest/README.md

@@ -21,6 +21,7 @@
 | `INGEST_LOGLEVEL`          |                            | Logging level for the ingestion process.                                     |
 | `GUNICORN_CMD_ARGS`        |                            | Command-line arguments for configuring Gunicorn, a Python WSGI HTTP Server.  |
 | `FASTAPI_ROOT_PATH`        |                            | If this api is behind proxy, this need to be set to the root path |
+| `MQTT_PROTOCOL_VERSION` | 5 | Set the MQTT protocol version. Defaults to v5. Available protocols are v3.1, v3.1.1 and v5 |
 
 ## Dev install
 
@@ -34,9 +35,10 @@ To install in dev mode run `pip install --editable .` from the top level of this
 | rapidjson-dev   | 1.1.0   |
 | pybind11-dev    | 2.9.1   |
 
-
 ## Prerequisites of running locally
+
 Move the `std_unit_names.json`to the ingest/api folder with
+
 ```bash
 just copy-units
 ```

ingest/api/send_mqtt.py

@@ -6,8 +6,18 @@
 
 logger = logging.getLogger(__name__)
 
-if "MQTT_TOPIC_PREPEND" in os.environ:
-    mqtt_topic_prepend = os.getenv("MQTT_TOPIC_PREPEND", "")
+
+mqtt_protocols = {
+    "3.1": mqtt_client.MQTTv31,
+    "3.1.1": mqtt_client.MQTTv311,
+    "5": mqtt_client.MQTTv5,
+}
+
+mqtt_topic_prepend = os.getenv("MQTT_TOPIC_PREPEND", "")
+if not mqtt_topic_prepend or mqtt_topic_prepend == "/":
+    mqtt_topic_prepend = ""
+    logger.error("MQTT_TOPIC_PREPEND cannot be just a '/'. Setting topic prepend to empty string.")
+else:
     mqtt_topic_prepend = mqtt_topic_prepend if mqtt_topic_prepend.endswith("/") else mqtt_topic_prepend + "/"
 
 
@@ -21,7 +31,10 @@ def on_connect(client, userdata, flags, rc, properties=None):
     def on_disconnect(client, userdata, flags, rc, properties):
         logger.warning(f"Disconnected from MQTT broker with result code {str(rc)}")
 
-    client = mqtt_client.Client(mqtt_client.CallbackAPIVersion.VERSION2)
+    client = mqtt_client.Client(
+        mqtt_client.CallbackAPIVersion.VERSION2,
+        protocol=mqtt_protocols[os.getenv("MQTT_PROTOCOL_VERSION", "5")],
+    )
     client.enable_logger(logger)
     client.username_pw_set(mqtt_conf["username"], mqtt_conf["password"])