feat: support MQTT_NAMESPACE via optional environment variable

closes: #38

CHANGELOG.md

@@ -4,6 +4,8 @@
 
 ### New Features
 
+- feat: support MQTT_NAMESPACE via optional environment variable (#38)
+
 ### Enhancements
 
 - doc: remove version tag in example docker compose as it is obsolete in docker 25.05

README.md

@@ -59,10 +59,11 @@ This setup is recommended only if you are running TeslaMate Telegram Bot **on yo
           restart: unless-stopped
           environment:
             # - CAR_ID=1 # optional, defaults to 1
-            - MQTT_BROKER_HOST=IP_Address
+            - MQTT_BROKER_HOST=IP_Address # defaults to 127.0.0.1
             # - MQTT_BROKER_PORT=1883 #optional, defaults to 1883
             # - MQTT_BROKER_USERNAME=username #optional, only needed when broker has authentication enabled
             # - MQTT_BROKER_PASSWORD=password #optional, only needed when broker has authentication enabled
+            # - MQTT_NAMESPACE=namespace # optional, only needed when you specified MQTT_NAMESPACE on your TeslaMate installation
             - TELEGRAM_BOT_API_KEY=secret_api_key
             - TELEGRAM_BOT_CHAT_ID=secret_chat_id
           ports:

src/teslamate_telegram_bot.py

@@ -17,6 +17,7 @@
 MQTT_BROKER_KEEPALIVE = 60
 MQTT_BROKER_USERNAME_DEFAULT = ''
 MQTT_BROKER_PASSWORD_DEFAULT = ''
+MQTT_NAMESPACE_DEFAULT = ''
 
 # Environment variables
 TELEGRAM_BOT_API_KEY = 'TELEGRAM_BOT_API_KEY'
@@ -25,6 +26,7 @@
 MQTT_BROKER_PASSWORD = 'MQTT_BROKER_PASSWORD'
 MQTT_BROKER_HOST = 'MQTT_BROKER_HOST'
 MQTT_BROKER_PORT = 'MQTT_BROKER_PORT'
+MQTT_NAMESPACE = 'MQTT_NAMESPACE'
 CAR_ID = 'CAR_ID'
 
 ##############################################################################
@@ -67,7 +69,14 @@ def get_env_variable(var_name, default_value=None):
                             )
     raise EnvironmentError(error_message_car_id) from value_error_car_id
 
-teslamate_mqtt_topic_base = f"teslamate/cars/{car_id}/"
+
+namespace = get_env_variable(MQTT_NAMESPACE, MQTT_NAMESPACE_DEFAULT)
+if namespace:
+    logging.info("Using MQTT namespace: %s", namespace)
+    teslamate_mqtt_topic_base = f"teslamate/{namespace}/cars/{car_id}/"
+else:
+    teslamate_mqtt_topic_base = f"teslamate/cars/{car_id}/"
+
 teslamate_mqtt_topic_update_available = teslamate_mqtt_topic_base + "update_available"
 teslamate_mqtt_topic_update_version = teslamate_mqtt_topic_base + "update_version"