Feature/qos config (#19)

* increase version and add QoS default value

* add QoS feature and add new link o next version

* increase version and implement QoS feature, also move publish code to seaparate fnction and make initialize mqtt connecton as an internal function

* increase version and make adjustements to the newly marked internal function

Author: cybcon

Dockerfile

@@ -1,7 +1,7 @@
 FROM alpine:3.23.2
 
 LABEL maintainer="Michael Oberdorf <info@oberdorf-itc.de>"
-LABEL site.local.program.version="1.3.4"
+LABEL site.local.program.version="1.4.0"
 
 ENV TZ="UTC" \
     REQUESTS_CA_BUNDLE=/etc/ssl/certs/ca-certificates.crt \
@@ -14,6 +14,7 @@ ENV TZ="UTC" \
     MQTT_TLS="false" \
     MQTT_TLS_INSECURE="false" \
     MQTT_PROTOCOL_VERSION="5" \
+    MQTT_QOS="0" \
     MQTT_TOPIC="com/github/cybcon/docker.weather2mqtt.git/weather" \
     MQTT_RETAIN="false" \
     CACHE_DIR="/app/cache" \

README.md

@@ -26,7 +26,8 @@ Container image: [DockerHub](https://hub.docker.com/r/oitc/weather2mqtt)
 
 # Supported tags and respective `Dockerfile` links
 
-* [`latest`, `1.3.4`](https://github.com/cybcon/docker.weather2mqtt/blob/v1.3.4/Dockerfile)
+* [`latest`, `1.4.0`](https://github.com/cybcon/docker.weather2mqtt/blob/v1.4.0/Dockerfile)
+* [`1.3.4`](https://github.com/cybcon/docker.weather2mqtt/blob/v1.3.4/Dockerfile)
 * [`1.3.3`](https://github.com/cybcon/docker.weather2mqtt/blob/v1.3.3/Dockerfile)
 * [`1.3.1`](https://github.com/cybcon/docker.weather2mqtt/blob/v1.3.1/Dockerfile)
 * [`1.3.0`](https://github.com/cybcon/docker.weather2mqtt/blob/v1.3.0/Dockerfile)
@@ -151,6 +152,7 @@ The container grab some configuration via environment variables.
 | `MQTT_PASSWORD_FILE`         | File that contains the password to authenticate to MQTT broker.                  | optional     |               |
 | `MQTT_SERVER`                | MQTT broker hostname to connect to.                                              | optional     | `test.mosquitto.org` |
 | `MQTT_PORT`                  | MQTT broker TCP port to connect to.                                              | optional     | `1883`        |
+| `MQTT_QOS`                   | MQTT quality of service for published messages.                                  | optional     | `0`           |
 | `MQTT_RETAIN`                | Publish MQTT message in retain mode fpr persistance.                             | optional     | `false`       |
 | `MQTT_TOPIC`                 | The MQTT topic to publish the weather data.                                      | optional     | `com/github/cybcon/docker.weather2mqtt.git/weather` |
 | `CACHE_DIR`                  | Directory used for API request caching.                                          | optional     | `/app/cache`  |

src/app/bin/weather2mqtt.py

@@ -11,7 +11,7 @@
 # Author: Michael Oberdorf
 # Date: 2025-04-11
 # Last modified by: Michael Oberdorf
-# Last modified at: 2026-01-11
+# Last modified at: 2026-01-18
 ###############################################################################
 """
 
@@ -30,7 +30,7 @@
 from lib.weather_codes import WeatherCodes
 from retry_requests import retry  # seeAlso: https://pypi.org/project/retry-requests/
 
-__version__ = "1.3.4"
+__version__ = "1.4.0"
 __script_path__ = os.path.dirname(__file__)
 __config_path__ = os.path.join(os.path.dirname(__script_path__), "etc")
 __local_tz__ = pytz.timezone("UTC")
@@ -134,7 +134,7 @@ def load_config_file() -> dict:
     return config
 
 
-def initialize_mqtt_client() -> mqtt.Client:
+def __initialize_mqtt_client() -> mqtt.Client:
     """
     Initialize the MQTT client with the given configuration from environment.
 
@@ -174,7 +174,7 @@ def initialize_mqtt_client() -> mqtt.Client:
             client.tls_set(
                 ca_certs=os.environ.get("REQUESTS_CA_BUNDLE"),
                 cert_reqs=ssl.CERT_NONE,
-                tls_version=ssl.PROTOCOL_TLS,
+                tls_version=ssl.PROTOCOL_TLSv1_2,
                 ciphers=None,
             )
             client.tls_insecure_set(True)
@@ -183,7 +183,7 @@ def initialize_mqtt_client() -> mqtt.Client:
             client.tls_set(
                 ca_certs=os.environ.get("REQUESTS_CA_BUNDLE"),
                 cert_reqs=ssl.CERT_REQUIRED,
-                tls_version=ssl.PROTOCOL_TLS,
+                tls_version=ssl.PROTOCOL_TLSv1_2,
                 ciphers=None,
             )
             client.tls_insecure_set(False)
@@ -338,6 +338,58 @@ def parse_daily_weather(data: any, fields: list = []) -> dict:
     return parsed_data
 
 
+def publish_weather_data(topic: str, payload: dict) -> None:
+    """
+    Publish the weather data to the MQTT broker.
+
+    :param topic str: The MQTT topic to publish the weather data to.
+    :param payload dict: The weather data to publish.
+    :raise ssl.SSLCertVerificationError: If there is an SSL certificate verification error.
+    :raise Exception: If the weather data cannot be published.
+    """
+    log.debug(f"Publish weather data to MQTT topic {topic} with payload: {json.dumps(payload)}")
+
+    # Initialize MQTT client
+    client = __initialize_mqtt_client()
+    log.debug("MQTT client initialized")
+
+    log.debug("Connecting to MQTT server {}:{}".format(os.environ.get("MQTT_SERVER"), os.environ.get("MQTT_PORT")))
+    try:
+        client.connect(os.environ.get("MQTT_SERVER"), int(os.environ.get("MQTT_PORT")), 60)
+    except ssl.SSLCertVerificationError as e:
+        log.error("SSL certificate verification error: {}".format(e))
+        sys.exit(1)
+    log.debug("Connected to MQTT server")
+
+    mqtt_retain = False
+    if os.environ.get("MQTT_RETAIN", "false").lower() == "true":
+        mqtt_retain = True
+    mqtt_qos = int(os.environ.get("MQTT_QOS", "0"))
+    if mqtt_qos not in [0, 1, 2]:
+        log.warning("Invalid MQTT QoS level: {}. Using QoS 0.".format(mqtt_qos))
+        mqtt_qos = 0
+    log.debug(
+        "Publishing weather data to MQTT topic: {}, using retain: {}, qos: {}".format(
+            os.environ.get("MQTT_TOPIC"), mqtt_retain, mqtt_qos
+        )
+    )
+
+    result, mid = client.publish(
+        topic=topic,
+        payload=json.dumps(payload, ensure_ascii=False),
+        qos=mqtt_qos,
+        retain=mqtt_retain,
+    )
+
+    if result != mqtt.MQTT_ERR_SUCCESS:
+        raise Exception(f"Failed to publish weather data to MQTT topic {topic}. Error code: {result}")
+
+    log.debug(f"Published weather data to MQTT topic {topic} with message ID {mid}")
+
+    client.disconnect()
+    log.debug("Disconnected from MQTT server")
+
+
 """
 ###############################################################################
 # M A I N
@@ -381,28 +433,11 @@ def parse_daily_weather(data: any, fields: list = []) -> dict:
 
     log.debug("Payload: {}".format(json.dumps(weather_result, ensure_ascii=False)))
 
-    # initialize MQTT client and connect to broker
-    client = initialize_mqtt_client()
-    log.debug("MQTT client initialized")
-    log.debug("Connecting to MQTT server {}:{}".format(os.environ.get("MQTT_SERVER"), os.environ.get("MQTT_PORT")))
-    try:
-        client.connect(os.environ.get("MQTT_SERVER"), int(os.environ.get("MQTT_PORT")), 60)
-    except ssl.SSLCertVerificationError as e:
-        log.error("SSL certificate verification error: {}".format(e))
-        sys.exit(1)
-
-    retain = False
-    if os.environ.get("MQTT_RETAIN", "false").lower() == "true":
-        retain = True
-    log.debug(
-        "Publishing weather data to MQTT topic: {}, using retain: {}".format(os.environ.get("MQTT_TOPIC"), retain)
-    )
-    client.publish(
-        topic=os.environ.get("MQTT_TOPIC"), payload=json.dumps(weather_result, ensure_ascii=False), qos=0, retain=retain
+    # Publish weather data
+    publish_weather_data(
+        topic=os.environ.get("MQTT_TOPIC"),
+        payload=weather_result,
     )
 
-    client.disconnect()
-    log.debug("Disconnected from MQTT server")
-
     log.info(f"Stop weather2mqtt version {__version__}")
     sys.exit(0)

test/test_weather2mqtt.py

@@ -5,14 +5,14 @@
 Author: Michael Oberdorf
 Date:   2025-04-13
 Last modified by: Michael Oberdorf
-Last modified at: 2026-01-11
+Last modified at: 2026-01-18
 ***************************************************************************
 """
 
 __author__ = "Michael Oberdorf <info@oberdorf-itc.de>"
 __status__ = "production"
-__date__ = "2026-01-11"
-__version_info__ = ("1", "0", "1")
+__date__ = "2026-01-18"
+__version_info__ = ("1", "0", "2")
 __version__ = ".".join(__version_info__)
 
 __all__ = ["TestWeather2Mqtt"]
@@ -23,9 +23,9 @@
 
 import paho.mqtt.client as mqtt
 
+from src.app.bin.weather2mqtt import __initialize_mqtt_client as initialize_mqtt_client
 from src.app.bin.weather2mqtt import (
     initialize_logger,
-    initialize_mqtt_client,
     load_config_file,
 )