chore: release 0.13.0

CHANGELOG.md

@@ -1,5 +1,41 @@
 # Change Log
 
+## 0.13.0
+
+### Changed
+
+* Replace gmqtt with aiomqtt for MQTT connectivity. The new client uses a
+  pure-asyncio architecture — no more `run_coroutine_threadsafe` cross-thread
+  calls. Reconnect now uses exponential backoff (5 s → 10 s → … → 5 min)
+  instead of a fixed interval (#457).
+
+### Fixed
+
+* Exit immediately on permanent MQTT connection failures (bad credentials,
+  unknown protocol version, identifier rejected, not authorised) instead of
+  looping forever (#457).
+
+* Restore MQTT subscriptions and trigger HA re-discovery on broker reconnect
+  after a transient disconnect (#457).
+
+* Suppress spurious `WARNING: Could not extract a valid SoC kWh` log on every
+  poll for non-EV vehicles. The warning is preserved for EVs where the BMS
+  returns invalid data (#460).
+
+* Publish command result topics (`Success` / `Failed: …`) with `retain=False`
+  so a stale result from a previous session does not persist on the broker
+  across restarts (#461).
+
+* Emit `retain` as a JSON boolean (`true`/`false`) in Home Assistant MQTT
+  discovery payloads instead of the string `"true"`/`"false"` that the HA
+  schema requires (#459).
+
+* Warn when TLS hostname verification is disabled regardless of whether a
+  custom CA certificate is configured. Self-signed cert users (who typically
+  have no CA file) now see the warning too (#462).
+
+**Full Changelog**: https://github.com/SAIC-iSmart-API/saic-python-mqtt-gateway/compare/0.12.0...0.13.0
+
 ## 0.12.0
 
 ### Added

pyproject.toml

@@ -17,10 +17,10 @@ requires-python = '>=3.12,<4.0'
 dependencies = [
     "saic-ismart-client-ng (>=0.9.3,<0.10.0)",
     'httpx (>=0.28.1,<0.29.0)',
-    'gmqtt (>=0.7.0,<0.8.0)',
     'inflection (>=0.5.1,<0.6.0)',
     'apscheduler (>=3.11.0,<4.0.0)',
     'python-dotenv (>=1.1.1,<2.0.0)',
+    "aiomqtt (>=2.4.0,<3.0.0)",
 ]
 
 [project.urls]

src/configuration/__init__.py

@@ -1,16 +1,19 @@
 from __future__ import annotations
 
 from enum import Enum
-from typing import TYPE_CHECKING
+from typing import TYPE_CHECKING, Literal
 
 if TYPE_CHECKING:
     from zoneinfo import ZoneInfo
 
     from integrations.openwb.charging_station import ChargingStation
 
 
+Transport = Literal["tcp", "websockets"]
+
+
 class TransportProtocol(Enum):
-    def __init__(self, transport_mechanism: str, with_tls: bool) -> None:
+    def __init__(self, transport_mechanism: Transport, with_tls: bool) -> None:
         self.transport_mechanism = transport_mechanism
         self.with_tls = with_tls
 

src/configuration/parser.py

@@ -105,15 +105,18 @@ def __parse_mqtt_transport(args: Namespace, config: Configuration) -> None:
                     args.tls_server_cert_check_hostname
                 )
         else:
-            msg = f"Invalid MQTT URI scheme: {parse_result.scheme}, use tcp or ws"
+            msg = f"Invalid MQTT URI scheme: {parse_result.scheme}, use tls, tcp or ws"
             raise SystemExit(msg)
 
         if parse_result.port:
             config.mqtt_port = parse_result.port
-        elif config.mqtt_transport_protocol == TransportProtocol.TCP:
-            config.mqtt_port = 1883
-        else:
+        elif config.mqtt_transport_protocol == TransportProtocol.TLS:
+            config.mqtt_port = 8883
+        elif config.mqtt_transport_protocol == TransportProtocol.WS:
             config.mqtt_port = 9001
+        else:
+            # fallback to default mqtt port
+            config.mqtt_port = 1883
         config.mqtt_host = str(parse_result.hostname)
 
 

src/extractors/__init__.py

@@ -43,17 +43,17 @@ def extract_soc_kwh(
     charge_status: ChrgMgmtDataRespProcessingResult | None,
     soc: float | None,
 ) -> float | None:
-    if (
-        charge_status is not None
-        and (raw_soc_kwh := charge_status.soc_kwh) is not None
-        and (soc_kwh := __validate_and_convert_soc_kwh(raw_soc_kwh)) is not None
-    ):
+    if charge_status is None:
+        return None
+
+    if (raw_soc_kwh := charge_status.soc_kwh) is not None and (
+        soc_kwh := __validate_and_convert_soc_kwh(raw_soc_kwh)
+    ) is not None:
         LOG.debug("SoC kWh derived from realtimePower")
         return soc_kwh
 
     if (
         soc is not None
-        and charge_status is not None
         and (
             capacity := __validate_and_convert_soc_kwh(
                 charge_status.real_total_battery_capacity

src/handlers/vehicle_command.py

@@ -70,7 +70,7 @@ def __report_command_failure(
         else:
             LOG.error("Command %s failed: %s", command, detail)
         try:
-            self.publisher.publish_str(result_topic, f"Failed: {detail}")
+            self.publisher.publish_str(result_topic, f"Failed: {detail}", retain=False)
         except Exception:
             LOG.warning(
                 "Failed to publish failure result for command %s",
@@ -138,7 +138,7 @@ async def __execute_mqtt_command_handler(
 
         try:
             execution_result = await handler.handle(payload, retained=retained)
-            self.publisher.publish_str(result_topic, "Success")
+            self.publisher.publish_str(result_topic, "Success", retain=False)
             if execution_result.force_refresh:
                 self.vehicle_state.set_refresh_mode(
                     RefreshMode.FORCE, f"after command execution on topic {topic}"
@@ -165,7 +165,7 @@ async def __execute_mqtt_command_handler(
                 return
             try:
                 execution_result = await handler.handle(payload, retained=retained)
-                self.publisher.publish_str(result_topic, "Success")
+                self.publisher.publish_str(result_topic, "Success", retain=False)
                 if execution_result.force_refresh:
                     self.vehicle_state.set_refresh_mode(
                         RefreshMode.FORCE,

src/integrations/home_assistant/base.py

@@ -55,7 +55,7 @@ def _publish_select(
             "command_topic": self._get_command_topic(topic),
             "value_template": value_template,
             "command_template": command_template,
-            "retain": str(retain).lower(),
+            "retain": retain,
             "options": options,
             "enabled_by_default": enabled,
         }
@@ -87,7 +87,7 @@ def _publish_text(
             "command_topic": self._get_command_topic(topic),
             "value_template": value_template,
             "command_template": command_template,
-            "retain": str(retain).lower(),
+            "retain": retain,
             "enabled_by_default": enabled,
         }
         if min_value is not None:
@@ -153,7 +153,7 @@ def _publish_number(
             "state_topic": self._get_state_topic(topic),
             "command_topic": self._get_command_topic(topic),
             "value_template": value_template,
-            "retain": str(retain).lower(),
+            "retain": retain,
             "mode": mode,
             "min": min_value,
             "max": max_value,

src/log_config.py

@@ -7,7 +7,7 @@
 
 MODULES_DEFAULT_LOG_LEVEL = {
     "asyncio": "WARNING",
-    "gmqtt": "WARNING",
+    "aiomqtt": "WARNING",
     "httpcore": "WARNING",
     "httpx": "WARNING",
     "saic_ismart_client_ng": "WARNING",

src/main.py

@@ -27,4 +27,5 @@
     configuration = process_command_line()
 
     mqtt_gateway = MqttGateway(configuration)
+
     asyncio.run(mqtt_gateway.run(), debug=debug_log_enabled())

src/publisher/core.py

@@ -102,30 +102,55 @@ def publish_json(
         no_prefix: bool = False,
         *,
         retain: bool = True,
+        qos: int = 0,
     ) -> None:
         raise NotImplementedError
 
     @abstractmethod
     def publish_str(
-        self, key: str, value: str, no_prefix: bool = False, *, retain: bool = True
+        self,
+        key: str,
+        value: str,
+        no_prefix: bool = False,
+        *,
+        retain: bool = True,
+        qos: int = 0,
     ) -> None:
         raise NotImplementedError
 
     @abstractmethod
     def publish_int(
-        self, key: str, value: int, no_prefix: bool = False, *, retain: bool = True
+        self,
+        key: str,
+        value: int,
+        no_prefix: bool = False,
+        *,
+        retain: bool = True,
+        qos: int = 0,
     ) -> None:
         raise NotImplementedError
 
     @abstractmethod
     def publish_bool(
-        self, key: str, value: bool, no_prefix: bool = False, *, retain: bool = True
+        self,
+        key: str,
+        value: bool,
+        no_prefix: bool = False,
+        *,
+        retain: bool = True,
+        qos: int = 0,
     ) -> None:
         raise NotImplementedError
 
     @abstractmethod
     def publish_float(
-        self, key: str, value: float, no_prefix: bool = False, *, retain: bool = True
+        self,
+        key: str,
+        value: float,
+        no_prefix: bool = False,
+        *,
+        retain: bool = True,
+        qos: int = 0,
     ) -> None:
         raise NotImplementedError
 
@@ -173,7 +198,7 @@ def publish(
             raise TypeError(msg)
 
     @abstractmethod
-    def clear_topic(self, key: str, no_prefix: bool = False) -> None:
+    def clear_topic(self, key: str, no_prefix: bool = False, qos: int = 0) -> None:
         raise NotImplementedError
 
     def get_mqtt_account_prefix(self) -> str:
@@ -249,7 +274,9 @@ def __anonymize(self, data: T) -> T:
         return data
 
     def keepalive(self) -> None:
-        self.publish_str(mqtt_topics.INTERNAL_LWT, "online", False)
+        self.publish_str(
+            mqtt_topics.INTERNAL_LWT, "online", no_prefix=False, retain=True, qos=1
+        )
 
     @staticmethod
     def anonymize_str(value: str) -> str: