Fix HomeKit Controller stale values at startup (home-assistant#152086)

Co-authored-by: TheJulianJES <[email protected]>

Author: 2 people

homeassistant/components/homekit_controller/connection.py

@@ -20,7 +20,12 @@
     EncryptionError,
 )
 from aiohomekit.model import Accessories, Accessory, Transport
-from aiohomekit.model.characteristics import Characteristic, CharacteristicsTypes
+from aiohomekit.model.characteristics import (
+    EVENT_CHARACTERISTICS,
+    Characteristic,
+    CharacteristicPermissions,
+    CharacteristicsTypes,
+)
 from aiohomekit.model.services import Service, ServicesTypes
 
 from homeassistant.components.thread import async_get_preferred_dataset
@@ -179,6 +184,21 @@ def remove_pollable_characteristics(
         for aid_iid in characteristics:
             self.pollable_characteristics.discard(aid_iid)
 
+    def get_all_pollable_characteristics(self) -> set[tuple[int, int]]:
+        """Get all characteristics that can be polled.
+
+        This is used during startup to poll all readable characteristics
+        before entities have registered what they care about.
+        """
+        return {
+            (accessory.aid, char.iid)
+            for accessory in self.entity_map.accessories
+            for service in accessory.services
+            for char in service.characteristics
+            if CharacteristicPermissions.paired_read in char.perms
+            and char.type not in EVENT_CHARACTERISTICS
+        }
+
     def add_watchable_characteristics(
         self, characteristics: list[tuple[int, int]]
     ) -> None:
@@ -309,9 +329,13 @@ async def async_setup(self) -> None:
         await self.async_process_entity_map()
 
         if transport != Transport.BLE:
-            # Do a single poll to make sure the chars are
-            # up to date so we don't restore old data.
-            await self.async_update()
+            # When Home Assistant starts, we restore the accessory map from storage
+            # which contains characteristic values from when HA was last running.
+            # These values are stale and may be incorrect (e.g., Ecobee thermostats
+            # report 100°C when restarting). We need to poll for fresh values before
+            # creating entities. Use poll_all=True since entities haven't registered
+            # their characteristics yet.
+            await self.async_update(poll_all=True)
             self._async_start_polling()
 
         # If everything is up to date, we can create the entities
@@ -863,9 +887,25 @@ async def async_request_update(self, now: datetime | None = None) -> None:
         """Request an debounced update from the accessory."""
         await self._debounced_update.async_call()
 
-    async def async_update(self, now: datetime | None = None) -> None:
-        """Poll state of all entities attached to this bridge/accessory."""
-        to_poll = self.pollable_characteristics
+    async def async_update(
+        self, now: datetime | None = None, *, poll_all: bool = False
+    ) -> None:
+        """Poll state of all entities attached to this bridge/accessory.
+
+        Args:
+            now: The current time (used by time interval callbacks).
+            poll_all: If True, poll all readable characteristics instead
+                     of just the registered ones.
+                     This is useful during initial setup before entities have
+                     registered their characteristics.
+        """
+        if poll_all:
+            # Poll all readable characteristics during initial startup
+            # excluding device trigger characteristics (buttons, doorbell, etc.)
+            to_poll = self.get_all_pollable_characteristics()
+        else:
+            to_poll = self.pollable_characteristics
+
         if not to_poll:
             self.async_update_available_state()
             _LOGGER.debug(

tests/components/homekit_controller/test_connection.py

@@ -2,6 +2,7 @@
 
 from collections.abc import Callable
 import dataclasses
+from typing import Any
 from unittest import mock
 
 from aiohomekit.controller import TransportType
@@ -11,6 +12,7 @@
 from aiohomekit.testing import FakeController
 import pytest
 
+from homeassistant.components.climate import ATTR_CURRENT_TEMPERATURE
 from homeassistant.components.homekit_controller.const import (
     DEBOUNCE_COOLDOWN,
     DOMAIN,
@@ -439,3 +441,88 @@ def _create_accessory(accessory: Accessory) -> Service:
         await time_changed(hass, DEBOUNCE_COOLDOWN)
         await hass.async_block_till_done()
         assert len(mock_get_characteristics.call_args_list[0][0][0]) > 1
+
+
+async def test_poll_all_on_startup_refreshes_stale_values(
+    hass: HomeAssistant, hass_storage: dict[str, Any]
+) -> None:
+    """Test that entities get fresh values on startup instead of stale stored values."""
+    # Load actual Ecobee accessory fixture
+    accessories = await setup_accessories_from_file(hass, "ecobee3.json")
+
+    # Pre-populate storage with the accessories data (already has stale values)
+    hass_storage["homekit_controller-entity-map"] = {
+        "version": 1,
+        "minor_version": 1,
+        "key": "homekit_controller-entity-map",
+        "data": {
+            "pairings": {
+                "00:00:00:00:00:00": {
+                    "config_num": 1,
+                    "accessories": [
+                        a.to_accessory_and_service_list() for a in accessories
+                    ],
+                }
+            }
+        },
+    }
+
+    # Track what gets polled during setup
+    polled_chars: list[tuple[int, int]] = []
+
+    # Set up the test accessories
+    fake_controller = await setup_platform(hass)
+
+    # Mock get_characteristics to track polling and return fresh temperature
+    async def mock_get_characteristics(
+        chars: set[tuple[int, int]], **kwargs: Any
+    ) -> dict[tuple[int, int], dict[str, Any]]:
+        """Return fresh temperature value when polled."""
+        polled_chars.extend(chars)
+        # Return fresh values for all characteristics
+        result: dict[tuple[int, int], dict[str, Any]] = {}
+        for aid, iid in chars:
+            # Find the characteristic and return appropriate value
+            for accessory in accessories:
+                if accessory.aid != aid:
+                    continue
+                for service in accessory.services:
+                    for char in service.characteristics:
+                        if char.iid != iid:
+                            continue
+                        # Return fresh temperature instead of stale fixture value
+                        if char.type == CharacteristicsTypes.TEMPERATURE_CURRENT:
+                            result[(aid, iid)] = {"value": 22.5}  # Fresh value
+                        else:
+                            result[(aid, iid)] = {"value": char.value}
+                        break
+        return result
+
+    # Add the paired device with our mock
+    await fake_controller.add_paired_device(accessories, "00:00:00:00:00:00")
+    config_entry = MockConfigEntry(
+        version=1,
+        domain="homekit_controller",
+        entry_id="TestData",
+        data={"AccessoryPairingID": "00:00:00:00:00:00"},
+        title="test",
+    )
+    config_entry.add_to_hass(hass)
+
+    # Get the pairing and patch its get_characteristics
+    pairing = fake_controller.pairings["00:00:00:00:00:00"]
+
+    with mock.patch.object(pairing, "get_characteristics", mock_get_characteristics):
+        # Set up the config entry (this should trigger poll_all=True)
+        await hass.config_entries.async_setup(config_entry.entry_id)
+        await hass.async_block_till_done()
+
+    # Verify that polling happened during setup (poll_all=True was used)
+    assert (
+        len(polled_chars) == 79
+    )  # The Ecobee fixture has exactly 79 readable characteristics
+
+    # Check that the climate entity has the fresh temperature (22.5°C) not the stale fixture value (21.8°C)
+    state = hass.states.get("climate.homew")
+    assert state is not None
+    assert state.attributes[ATTR_CURRENT_TEMPERATURE] == 22.5