Merge pull request #39 from andrew-codechimp/no-device-entry

No device entry

Author: andrew-codechimp

custom_components/periodic_min_max/__init__.py

@@ -6,14 +6,21 @@
 
 from __future__ import annotations
 
+import voluptuous as vol
 from awesomeversion.awesomeversion import AwesomeVersion
 from homeassistant.config_entries import ConfigEntry
 from homeassistant.const import __version__ as HA_VERSION  # noqa: N812
-from homeassistant.core import HomeAssistant
+from homeassistant.core import HomeAssistant, callback
 from homeassistant.helpers import config_validation as cv
+from homeassistant.helpers import entity_registry as er
+from homeassistant.helpers.helper_integration import (
+    async_handle_source_entity_changes,
+    async_remove_helper_config_entry_from_source_device,
+)
 from homeassistant.helpers.typing import ConfigType
 
 from .const import (
+    CONF_ENTITY_ID,
     DOMAIN,
     LOGGER,
     MIN_HA_VERSION,
@@ -23,6 +30,19 @@
 CONFIG_SCHEMA = cv.config_entry_only_config_schema(DOMAIN)
 
 
+@callback
+def async_get_source_entity_device_id(
+    hass: HomeAssistant, entity_id: str
+) -> str | None:
+    """Get the entity device id."""
+    registry = er.async_get(hass)
+
+    if not (source_entity := registry.async_get(entity_id)):
+        return None
+
+    return source_entity.device_id
+
+
 async def async_setup(
     hass: HomeAssistant,  # pylint: disable=unused-argument
     config: ConfigType,  # pylint: disable=unused-argument
@@ -43,10 +63,46 @@ async def async_setup(
 
 async def async_setup_entry(hass: HomeAssistant, entry: ConfigEntry) -> bool:
     """Set up Min/Max from a config entry."""
-    await hass.config_entries.async_forward_entry_setups(entry, PLATFORMS)
 
+    entity_registry = er.async_get(hass)
+    try:
+        entity_id = er.async_validate_entity_id(
+            entity_registry, entry.options[CONF_ENTITY_ID]
+        )
+    except vol.Invalid:
+        # The entity is identified by an unknown entity registry ID
+        LOGGER.error(
+            "Failed to setup periodic_min_max for unknown entity %s",
+            entry.options[CONF_ENTITY_ID],
+        )
+        return False
+
+    def set_source_entity_id_or_uuid(source_entity_id: str) -> None:
+        hass.config_entries.async_update_entry(
+            entry,
+            options={**entry.options, CONF_ENTITY_ID: source_entity_id},
+        )
+
+    async def source_entity_removed() -> None:
+        # The source entity has been removed, we remove the config entry because
+        # periodic_min_max will not work without the source entity.
+        await hass.config_entries.async_remove(entry.entry_id)
+
+    entry.async_on_unload(
+        async_handle_source_entity_changes(
+            hass,
+            add_helper_config_entry_to_device=False,
+            helper_config_entry_id=entry.entry_id,
+            set_source_entity_id_or_uuid=set_source_entity_id_or_uuid,
+            source_device_id=async_get_source_entity_device_id(hass, entity_id),
+            source_entity_id_or_uuid=entry.options[CONF_ENTITY_ID],
+            source_entity_removed=source_entity_removed,
+        )
+    )
     entry.async_on_unload(entry.add_update_listener(config_entry_update_listener))
 
+    await hass.config_entries.async_forward_entry_setups(entry, PLATFORMS)
+
     return True
 
 
@@ -58,3 +114,37 @@ async def config_entry_update_listener(hass: HomeAssistant, entry: ConfigEntry)
 async def async_unload_entry(hass: HomeAssistant, entry: ConfigEntry) -> bool:
     """Unload a config entry."""
     return await hass.config_entries.async_unload_platforms(entry, PLATFORMS)
+
+
+async def async_migrate_entry(hass: HomeAssistant, config_entry: ConfigEntry) -> bool:
+    """Migrate old entry."""
+    LOGGER.debug(
+        "Migrating from version %s.%s", config_entry.version, config_entry.minor_version
+    )
+
+    if config_entry.version > 1:
+        # This means the user has downgraded from a future version
+        return False
+    if config_entry.version == 1:
+        options = {**config_entry.options}
+        if config_entry.minor_version < 2:
+            # Remove the periodic min/max config entry from the source device
+            if source_device_id := async_get_source_entity_device_id(
+                hass, options[CONF_ENTITY_ID]
+            ):
+                async_remove_helper_config_entry_from_source_device(
+                    hass,
+                    helper_config_entry_id=config_entry.entry_id,
+                    source_device_id=source_device_id,
+                )
+        hass.config_entries.async_update_entry(
+            config_entry, options=options, minor_version=2
+        )
+
+    LOGGER.debug(
+        "Migration to version %s.%s successful",
+        config_entry.version,
+        config_entry.minor_version,
+    )
+
+    return True

custom_components/periodic_min_max/config_flow.py

@@ -58,6 +58,9 @@ class ConfigFlowHandler(SchemaConfigFlowHandler, domain=DOMAIN):
     config_flow = CONFIG_FLOW
     options_flow = OPTIONS_FLOW
 
+    VERSION = 1
+    MINOR_VERSION = 2
+
     def async_config_entry_title(self, options: Mapping[str, Any]) -> str:
         """Return config entry title."""
         return cast(str, options["name"]) if "name" in options else ""

custom_components/periodic_min_max/const.py

@@ -8,7 +8,7 @@
 
 LOGGER: Logger = getLogger(__package__)
 
-MIN_HA_VERSION = "2025.3"
+MIN_HA_VERSION = "2025.8"
 
 manifestfile = Path(__file__).parent / "manifest.json"
 with open(file=manifestfile, encoding="UTF-8") as json_file:

custom_components/periodic_min_max/sensor.py

@@ -24,7 +24,6 @@
 from homeassistant.helpers import device_registry as dr
 from homeassistant.helpers import entity_platform
 from homeassistant.helpers import entity_registry as er
-from homeassistant.helpers.device import async_device_info_to_link_from_entity
 from homeassistant.helpers.entity_platform import (
     AddConfigEntryEntitiesCallback,
     AddEntitiesCallback,
@@ -62,24 +61,16 @@
 
 
 @callback
-def async_add_to_device(
-    hass: HomeAssistant, entry: ConfigEntry, entity_id: str
+def async_get_source_entity_device_id(
+    hass: HomeAssistant, entity_id: str
 ) -> str | None:
-    """Add our config entry to the tracked entity's device."""
+    """Get the entity device id."""
     registry = er.async_get(hass)
-    device_registry = dr.async_get(hass)
-    device_id = None
-
-    if (
-        not (source_device := registry.async_get(entity_id))
-        or not (device_id := source_device.device_id)
-        or not (device_registry.async_get(device_id))
-    ):
-        return device_id
 
-    device_registry.async_update_device(device_id, add_config_entry_id=entry.entry_id)
+    if not (source_entity := registry.async_get(entity_id)):
+        return None
 
-    return device_id
+    return source_entity.device_id
 
 
 async def config_entry_update_listener(hass: HomeAssistant, entry: ConfigEntry) -> None:
@@ -96,7 +87,7 @@ async def async_setup_entry(
     entity_registry = er.async_get(hass)
     device_registry = dr.async_get(hass)
     try:
-        entity_id = er.async_validate_entity_id(
+        source_entity_id = er.async_validate_entity_id(
             entity_registry, config_entry.options[CONF_ENTITY_ID]
         )
     except vol.Invalid:
@@ -107,6 +98,9 @@ async def async_setup_entry(
         )
         return False
 
+    source_entity = entity_registry.async_get(source_entity_id)
+    device_id = source_entity.device_id if source_entity else None
+
     sensor_type = config_entry.options[CONF_TYPE]
 
     async def async_registry_updated(
@@ -141,20 +135,18 @@ async def async_registry_updated(
 
     config_entry.async_on_unload(
         async_track_entity_registry_updated_event(
-            hass, entity_id, async_registry_updated
+            hass, source_entity_id, async_registry_updated
         )
     )
     config_entry.async_on_unload(
         config_entry.add_update_listener(config_entry_update_listener)
     )
 
-    device_id = async_add_to_device(hass, config_entry, entity_id)
-
     async_add_entities(
         [
             PeriodicMinMaxSensor(
                 hass,
-                entity_id,
+                source_entity_id,
                 config_entry.title,
                 sensor_type,
                 config_entry.entry_id,
@@ -180,15 +172,15 @@ async def async_setup_platform(
     discovery_info: DiscoveryInfoType | None = None,
 ) -> None:
     """Set up the periodic min/max sensor."""
-    entity_id: str = config[CONF_ENTITY_ID]
+    source_entity_id: str = config[CONF_ENTITY_ID]
     name: str | None = config.get(CONF_NAME)
     sensor_type: str = config[CONF_TYPE]
     unique_id = config.get(CONF_UNIQUE_ID)
 
     await async_setup_reload_service(hass, DOMAIN, PLATFORMS)
 
     async_add_entities(
-        [PeriodicMinMaxSensor(hass, entity_id, name, sensor_type, unique_id)]
+        [PeriodicMinMaxSensor(hass, source_entity_id, name, sensor_type, unique_id)]
     )
 
 
@@ -220,17 +212,20 @@ def __init__(
             self._attr_name = f"{sensor_type} sensor".capitalize()
         self._sensor_attr = SENSOR_TYPE_TO_ATTR[self._sensor_type]
 
-        self._attr_device_info = async_device_info_to_link_from_entity(
-            hass,
-            source_entity_id,
-        )
-
         self._unit_of_measurement: str | None = None
         self._unit_of_measurement_mismatch = False
         self.min_value: float | None = None
         self.max_value: float | None = None
         self._state: Any = None
 
+        registry = er.async_get(hass)
+        device_registry = dr.async_get(hass)
+        source_entity = registry.async_get(source_entity_id)
+        device_id = source_entity.device_id if source_entity else None
+
+        if device_id and (device := device_registry.async_get(device_id)):
+            self.device_entry = device
+
     async def async_added_to_hass(self) -> None:
         """Handle added to Hass."""
 

hacs.json

@@ -2,6 +2,6 @@
     "name": "Periodic Min/Max",
     "filename": "periodic_min_max.zip",
     "hide_default_branch": true,
-    "homeassistant": "2025.3.0",
+    "homeassistant": "2025.8.0",
     "zip_release": true
 }

requirements.txt

@@ -1,4 +1,4 @@
 colorlog==6.9.0
-homeassistant==2025.3.0
+homeassistant==2025.8.0
 pip>=21.0,<25.3
 ruff==0.11.13

tests/test_init.py

@@ -59,7 +59,7 @@ async def test_setup(
             "entity_id": "sensor.test_source",
             "type": "max",
         },
-        title=DEFAULT_NAME
+        title=DEFAULT_NAME,
     )
     periodic_min_max_config_entry.add_to_hass(hass)
     assert await hass.config_entries.async_setup(periodic_min_max_config_entry.entry_id)
@@ -74,16 +74,10 @@ async def test_setup(
     assert periodic_min_max_entity is not None
     assert periodic_min_max_entity.device_id == source_entity.device_id
 
-    # After reloading the config entry, check linked device
-    devices_after_reload = device_registry.devices.get_devices_for_config_entry_id(
+    # Remove the config entry
+    assert await hass.config_entries.async_remove(
         periodic_min_max_config_entry.entry_id
     )
-    assert len(devices_after_reload) == 1
-
-    assert devices_after_reload[0].id == source_device_entry.id
-
-    # Remove the config entry
-    assert await hass.config_entries.async_remove(periodic_min_max_config_entry.entry_id)
     await hass.async_block_till_done()
 
     # Check the state and entity registry entry are removed