#292: Refactor publish HA discovery on HA reconnection to enable future supporto for global commands

Author: nanomad

configuration/__init__.py

@@ -57,3 +57,7 @@ def is_mqtt_enabled(self) -> bool:
     @property
     def username_is_email(self):
         return '@' in self.saic_user
+
+    @property
+    def ha_lwt_topic(self) -> str:
+        return f'{self.ha_discovery_prefix}/status'

handlers/vehicle.py

@@ -47,7 +47,10 @@ def __init__(
             True
         )
         self.vehicle_state = vehicle_state
-        self.ha_discovery = HomeAssistantDiscovery(vehicle_state, vin_info, config)
+        if self.configuration.ha_discovery_enabled:
+            self.__ha_discovery = HomeAssistantDiscovery(vehicle_state, vin_info, config)
+        else:
+            self.__ha_discovery = None
 
         self.__setup_abrp(config, vin_info)
         self.__setup_osmand(config, vin_info)
@@ -114,8 +117,7 @@ async def handle_vehicle(self) -> None:
                         exc_info=e
                     )
                 finally:
-                    if self.configuration.ha_discovery_enabled:
-                        self.ha_discovery.publish_ha_discovery_messages()
+                    self.publish_ha_discovery_messages(force=False)
             else:
                 # car not active, wait a second
                 await asyncio.sleep(1.0)
@@ -176,9 +178,10 @@ async def __refresh_abrp(self, charge_status, vehicle_status):
         else:
             LOG.info(f'ABRP not refreshed, reason {abrp_response}')
 
-    async def publish_ha_discovery_messages(self, force=False):
-        LOG.info(f'Sending HA discovery messages for {self.vin_info.vin} (Force: {force})')
-        self.ha_discovery.publish_ha_discovery_messages(force)
+    def publish_ha_discovery_messages(self, *, force=False):
+        if self.__ha_discovery is not None:
+            LOG.info(f'Sending HA discovery messages for {self.vin_info.vin} (Force: {force})')
+            self.__ha_discovery.publish_ha_discovery_messages(force=force)
 
     async def update_vehicle_status(self) -> VehicleStatusResp:
         LOG.info('Updating vehicle status')

integrations/home_assistant/discovery.py

@@ -96,15 +96,15 @@ def __init__(self, vehicle_state: VehicleState, vin_info: VinInfo, configuration
         )
         self.published = False
 
-    def publish_ha_discovery_messages(self, force=False):
-        if self.published and not force:
-            LOG.debug("Skipping Home Assistant discovery messages as it was already published")
-            return
-
+    def publish_ha_discovery_messages(self, *, force: bool = False):
         if not self.__vehicle_state.is_complete():
-            LOG.debug("Skipping Home Assistant discovery messages as vehicle state is not yet complete")
+            LOG.warning("Skipping Home Assistant discovery messages as vehicle state is not yet complete")
             return
 
+        if self.published and not force:
+            LOG.debug("Skipping Home Assistant discovery messages as it was already published")
+            return
+        
         self.__publish_ha_discovery_messages_real()
         self.published = True
 

mqtt_gateway.py

@@ -179,11 +179,15 @@ async def on_charging_detected(self, vin: str) -> None:
             LOG.debug(f'Charging detected for unknown vin {vin}')
 
     @override
-    async def on_homeassistant_got_online_received(self) -> None:
-        # we only receive this if we subscribed to this topic => resend
-        for (key, vh) in self.vehicle_handlers.items():
-            LOG.debug(f'Send HomeAssistant discovery for car {key}')
-            vh.publish_ha_discovery_messages(True)
+    async def on_mqtt_global_command_received(self, *, topic: str, payload: str):
+        match topic:
+            case self.configuration.ha_lwt_topic:
+                if payload == 'online':
+                    for (vin, vh) in self.vehicle_handlers.items():
+                        LOG.debug(f'Send HomeAssistant discovery for car {vin}')
+                        vh.publish_ha_discovery_messages(force=True)
+            case _:
+                LOG.warning(f'Received unknown global command {topic}: {payload}')
 
     def __on_publish_raw_value(self, key: str, raw: str):
         self.publisher.publish_str(key, raw)

publisher/core.py

@@ -8,14 +8,15 @@
 
 INVALID_MQTT_CHARS = re.compile(r'[+#*$>]')
 
+
 class MqttCommandListener(ABC):
     async def on_mqtt_command_received(self, *, vin: str, topic: str, payload: str) -> None:
         raise NotImplementedError("Should have implemented this")
 
     async def on_charging_detected(self, vin: str) -> None:
         raise NotImplementedError("Should have implemented this")
 
-    async def on_homeassistant_got_online_received(self) -> None:
+    async def on_mqtt_global_command_received(self, *, topic: str, payload: str):
         raise NotImplementedError("Should have implemented this")
 
 

publisher/mqtt_publisher.py

@@ -85,7 +85,7 @@ def __on_connect(self, _client, _flags, rc, _properties) -> None:
                     self.client.subscribe(charging_station.connected_topic)
             if self.configuration.ha_discovery_enabled:
                 # enable dynamic discovery pushing in case ha reconnects
-                self.client.subscibe(f'{self.configuration.ha_discovery_prefix}/status')
+                self.client.subscribe(self.configuration.ha_lwt_topic)
             self.keepalive()
         else:
             if rc == gmqtt.constants.CONNACK_REFUSED_BAD_USERNAME_PASSWORD:
@@ -123,9 +123,9 @@ async def __on_message_real(self, *, topic: str, payload: str) -> None:
                 LOG.debug(f'Vehicle with vin {vin} is connected to its charging station')
             else:
                 LOG.debug(f'Vehicle with vin {vin} is disconnected from its charging station')
-        elif topic == f'{self.configuration.ha_discovery_prefix}/status' and payload == "online":
-            LOG.debug('HomeAssistant restarted. Send discovery payload')
-            self.command_listener.on_homeassistant_got_online_received()
+        elif topic == self.configuration.ha_lwt_topic:
+            if self.command_listener is not None:
+                await self.command_listener.on_mqtt_global_command_received(topic=topic, payload=payload)
         else:
             vin = self.get_vin_from_topic(topic)
             if self.command_listener is not None:

tests/test_mqtt_publisher.py

@@ -14,6 +14,10 @@
 
 
 class TestMqttPublisher(unittest.IsolatedAsyncioTestCase, MqttCommandListener):
+    @override
+    async def on_mqtt_global_command_received(self, *, topic: str, payload: str):
+        pass
+
     @override
     async def on_mqtt_command_received(self, *, vin: str, topic: str, payload: str) -> None:
         self.received_vin = vin