Add mqtt support

home-assistant · ryanjones-gentex · Jan 24, 2025 · Feb 4, 2025 · Feb 18, 2025 · Feb 19, 2025
commit a61375d205d16a65f688dfd6783fa48fa379717c
diff --git a/homeassistant/components/gentex_homelink/__init__.py b/homeassistant/components/gentex_homelink/__init__.py
@@ -4,7 +4,7 @@
 
 import logging
 
-from homelink.provider import Provider
+from homelink.mqtt_provider import MQTTProvider
 
 from homeassistant.config_entries import ConfigEntry
 from homeassistant.const import Platform
@@ -40,7 +40,7 @@ async def async_setup_entry(hass: HomeAssistant, entry: HomeLinkConfigEntry) ->
         aiohttp_client.async_get_clientsession(hass), session
     )
 
-    provider = Provider(authenticated_session)
+    provider = MQTTProvider(authenticated_session)
     coordinator = HomeLinkCoordinator(hass, provider, entry)
 
     await coordinator.async_config_entry_first_refresh()

diff --git a/homeassistant/components/gentex_homelink/config_flow.py b/homeassistant/components/gentex_homelink/config_flow.py
@@ -40,7 +40,6 @@ async def async_step_user(
         """Ask for username and password."""
         errors: dict[str, str] = {}
         if user_input is not None:
-            _LOGGER.info(user_input)
             self._async_abort_entries_match({CONF_EMAIL: user_input[CONF_EMAIL]})
 
             srp_auth = SRPAuth()
@@ -53,6 +52,7 @@ async def async_step_user(
                     user_input[CONF_PASSWORD],
                 )
             except botocore.exceptions.ClientError:
+                _LOGGER.exception("Error authenticating homelink account")
                 errors["base"] = "Error authenticating HomeLink account"
             except Exception:
                 _LOGGER.exception("An unexpected error occurred")

diff --git a/homeassistant/components/gentex_homelink/coordinator.py b/homeassistant/components/gentex_homelink/coordinator.py
@@ -1,19 +1,18 @@
 """Makes requests to the state server and stores the resulting data so that the buttons can access it."""
 
-import asyncio
 from dataclasses import dataclass
-from datetime import timedelta
+import functools
 import logging
 from typing import Any
 
-from homelink.provider import Provider
+from homelink.mqtt_provider import MQTTProvider
 
 from homeassistant.config_entries import ConfigEntry
 from homeassistant.core import HomeAssistant
 import homeassistant.helpers.device_registry as dr
 from homeassistant.helpers.update_coordinator import DataUpdateCoordinator
+from homeassistant.util.ssl import get_default_context
 
-from .const import POLLING_INTERVAL
 from .event import HomeLinkEventEntity
 
 _LOGGER = logging.getLogger(__name__)
@@ -23,7 +22,7 @@
 class HomeLinkData:
     """Class for HomeLink integration runtime data."""
 
-    provider: Provider
+    provider: MQTTProvider
     coordinator: DataUpdateCoordinator
     last_update_id: str | None
 
@@ -34,7 +33,7 @@ class HomeLinkCoordinator(DataUpdateCoordinator[dict[str, Any]]):
     def __init__(
         self,
         hass: HomeAssistant,
-        provider: Provider,
+        provider: MQTTProvider,
         config_entry: ConfigEntry[HomeLinkData],
     ) -> None:
         """Initialize my coordinator."""
@@ -43,8 +42,6 @@ def __init__(
             _LOGGER,
             # Name of the data. For logging purposes.
             name="HomeLink Coordinator",
-            # Polling interval. Will only be polled if there are subscribers.
-            update_interval=timedelta(seconds=POLLING_INTERVAL),
             config_entry=config_entry,
         )
         self.provider = provider
@@ -54,8 +51,14 @@ def __init__(
         self.buttons: list[HomeLinkEventEntity] = []
 
     async def _async_setup(self):
-        await self.provider.enable()
+        await self.provider.enable(get_default_context())
 
+        await self.discover_devices()
+        callback = functools.partial(on_message, self)
+        self.provider.listen(callback)
+
+    async def discover_devices(self):
+        """Discover devices and build the Entities."""
         device_data = await self.provider.discover()
 
         for device in device_data:
@@ -72,37 +75,23 @@ async def _async_setup(self):
 
     async def _async_update_data(self) -> dict[str, Any]:
         """Fetch data from API endpoint."""
-        if self.config_entry is None:
-            _LOGGER.error("Config entry is empty, unable to update data")
-            return {}
-
-        # Note: asyncio.TimeoutError and aiohttp.ClientError are already
-        # handled by the data update coordinator.
-        async with asyncio.timeout(10):
-            # Grab active context variables to limit data required to be fetched from API
-            # Note: using context is not required if there is no need or ability to limit
-            # data retrieved from API.
-            try:
-                should_sync, devices = await self.provider.get_state()
-            except Exception:
-                _LOGGER.exception(
-                    "An unexpected error occurred retrieving HomeLink device state"
-                )
-                return {}
-            else:
-                if (
-                    should_sync
-                    and should_sync["requestId"] != self.last_sync_id
-                    and self.config_entry.data["last_update_id"]
-                    != should_sync["requestId"]
-                    and should_sync["timestamp"] != self.last_sync_timestamp
-                ):
-                    config_data = self.config_entry.data.copy()
-                    config_data["last_update_id"] = should_sync["requestId"]
-
-                    self.hass.config_entries.async_update_entry(
-                        self.config_entry, data=config_data
-                    )
-                    self.last_sync_id = should_sync["requestId"]
-                    self.last_sync_timestamp = should_sync["timestamp"]
-                return devices
+        return {}
+
+    async def async_update_devices(self, message):
+        """Update the devices from the server."""
+        config_data = self.config_entry.data.copy()
+        config_data["last_update_id"] = message["requestId"]
+        await self.discover_devices()
+
+        self.hass.config_entries.async_update_entry(self.config_entry, data=config_data)
+        self.last_sync_id = message["requestId"]
+        self.last_sync_timestamp = message["timestamp"]
+
+
+def on_message(coordinator: HomeLinkCoordinator, _topic, message):
+    "MQTT Callback function."
+
+    if message["type"] == "state":
+        coordinator.hass.add_job(coordinator.async_set_updated_data, message["data"])
+    if message["type"] == "requestSync":
+        coordinator.hass.add_job(coordinator.async_set_updated_data, message["data"])
diff --git a/homeassistant/components/gentex_homelink/event.py b/homeassistant/components/gentex_homelink/event.py
@@ -2,13 +2,15 @@
 
 from __future__ import annotations
 
-import time
-from typing import TYPE_CHECKING
+import asyncio
+from typing import TYPE_CHECKING, Any
 
 if TYPE_CHECKING:
     # Import keeps mypy happy but is a circular reference otherwise
     from .coordinator import HomeLinkCoordinator  # noqa: F401
 
+import logging
+
 from homeassistant.components.event import EventDeviceClass, EventEntity
 from homeassistant.config_entries import ConfigEntry
 from homeassistant.core import HomeAssistant, callback
@@ -20,6 +22,8 @@
 
 from .const import DOMAIN, EVENT_OFF, EVENT_PRESSED, EVENT_TIMEOUT
 
+_LOGGER = logging.getLogger(__name__)
+
 
 async def async_setup_entry(
     hass: HomeAssistant,
@@ -60,25 +64,41 @@ def __init__(self, id, param_name, device_id, device_name, coordinator) -> None:
         self.name = name
         self.unique_id = id
         self.last_request_id = None
+        self.button_off_task: asyncio.Task[Any] | None = None
 
     @callback
     def _handle_coordinator_update(self) -> None:
         """Update this button."""
-        if not self.coordinator.data or self.id not in self.coordinator.data:
-            if self.state_attributes["event_type"] == EVENT_PRESSED:
-                self._trigger_event(EVENT_OFF)
-                self.async_write_ha_state()
+
+        if self.id not in self.coordinator.data:
+            # Not for us
+            return
+
+        # Handles debounce case - if we're pressed again, and we have an active stop timer, cancel the previous timer and restart it
+        if (
+            self.state_attributes["event_type"] == EVENT_PRESSED
+            and self.button_off_task
+        ):
+            self.button_off_task.cancel()
+            self.button_off_task = asyncio.create_task(self.button_off())
             return
+
+        # If this is the first press, set to off before setting pressed
         if self.last_request_id is None:
             self._trigger_event(EVENT_OFF)
 
         latest_update = self.coordinator.data[self.id]
+        # Set button to pressed and then schedule the turnoff
         if latest_update["requestId"] != self.last_request_id:
             self._trigger_event(EVENT_PRESSED)
             self.last_request_id = latest_update["requestId"]
-        elif (
-            self.state_attributes["event_type"] == EVENT_PRESSED
-            and time.time() - latest_update["timestamp"] < EVENT_TIMEOUT
-        ):
-            self._trigger_event(EVENT_OFF)
+            self.button_off_task = asyncio.create_task(self.button_off())
+
+        self.async_write_ha_state()
+
+    async def button_off(self):
+        """Wait for the specific time then turn the pressed button off."""
+        await asyncio.sleep(EVENT_TIMEOUT)
+        self._trigger_event(EVENT_OFF)
+        self.button_off_task = None
         self.async_write_ha_state()
diff --git a/homeassistant/components/gentex_homelink/manifest.json b/homeassistant/components/gentex_homelink/manifest.json
@@ -6,5 +6,5 @@
   "documentation": "https://www.home-assistant.io/integrations/gentex_homelink",
   "iot_class": "cloud_polling",
   "quality_scale": "bronze",
-  "requirements": ["homelink-home-assistant==0.0.6"]
+  "requirements": ["homelink-home-assistant==0.0.7"]
 }
diff --git a/requirements_all.txt b/requirements_all.txt
diff --git a/requirements_test_all.txt b/requirements_test_all.txt