Add dynamic devices to Homee (home-assistant#151934)

Author: Taraman17

homeassistant/components/homee/alarm_control_panel.py

@@ -3,7 +3,7 @@
 from dataclasses import dataclass
 
 from pyHomee.const import AttributeChangedBy, AttributeType
-from pyHomee.model import HomeeAttribute
+from pyHomee.model import HomeeAttribute, HomeeNode
 
 from homeassistant.components.alarm_control_panel import (
     AlarmControlPanelEntity,
@@ -17,7 +17,7 @@
 
 from . import DOMAIN, HomeeConfigEntry
 from .entity import HomeeEntity
-from .helpers import get_name_for_enum
+from .helpers import get_name_for_enum, setup_homee_platform
 
 PARALLEL_UPDATES = 0
 
@@ -60,21 +60,32 @@ def get_supported_features(
     return supported_features
 
 
-async def async_setup_entry(
-    hass: HomeAssistant,
+async def add_alarm_control_panel_entities(
     config_entry: HomeeConfigEntry,
     async_add_entities: AddConfigEntryEntitiesCallback,
+    nodes: list[HomeeNode],
 ) -> None:
-    """Add the Homee platform for the alarm control panel component."""
-
+    """Add homee alarm control panel entities."""
     async_add_entities(
         HomeeAlarmPanel(attribute, config_entry, ALARM_DESCRIPTIONS[attribute.type])
-        for node in config_entry.runtime_data.nodes
+        for node in nodes
         for attribute in node.attributes
         if attribute.type in ALARM_DESCRIPTIONS and attribute.editable
     )
 
 
+async def async_setup_entry(
+    hass: HomeAssistant,
+    config_entry: HomeeConfigEntry,
+    async_add_entities: AddConfigEntryEntitiesCallback,
+) -> None:
+    """Add the homee platform for the alarm control panel component."""
+
+    await setup_homee_platform(
+        add_alarm_control_panel_entities, async_add_entities, config_entry
+    )
+
+
 class HomeeAlarmPanel(HomeeEntity, AlarmControlPanelEntity):
     """Representation of a Homee alarm control panel."""
 

homeassistant/components/homee/binary_sensor.py

@@ -1,7 +1,7 @@
 """The Homee binary sensor platform."""
 
 from pyHomee.const import AttributeType
-from pyHomee.model import HomeeAttribute
+from pyHomee.model import HomeeAttribute, HomeeNode
 
 from homeassistant.components.binary_sensor import (
     BinarySensorDeviceClass,
@@ -14,6 +14,7 @@
 
 from . import HomeeConfigEntry
 from .entity import HomeeEntity
+from .helpers import setup_homee_platform
 
 PARALLEL_UPDATES = 0
 
@@ -152,23 +153,34 @@
 }
 
 
-async def async_setup_entry(
-    hass: HomeAssistant,
+async def add_binary_sensor_entities(
     config_entry: HomeeConfigEntry,
-    async_add_devices: AddConfigEntryEntitiesCallback,
+    async_add_entities: AddConfigEntryEntitiesCallback,
+    nodes: list[HomeeNode],
 ) -> None:
-    """Add the Homee platform for the binary sensor component."""
-
-    async_add_devices(
+    """Add homee binary sensor entities."""
+    async_add_entities(
         HomeeBinarySensor(
             attribute, config_entry, BINARY_SENSOR_DESCRIPTIONS[attribute.type]
         )
-        for node in config_entry.runtime_data.nodes
+        for node in nodes
         for attribute in node.attributes
         if attribute.type in BINARY_SENSOR_DESCRIPTIONS and not attribute.editable
     )
 
 
+async def async_setup_entry(
+    hass: HomeAssistant,
+    config_entry: HomeeConfigEntry,
+    async_add_entities: AddConfigEntryEntitiesCallback,
+) -> None:
+    """Add the homee platform for the binary sensor component."""
+
+    await setup_homee_platform(
+        add_binary_sensor_entities, async_add_entities, config_entry
+    )
+
+
 class HomeeBinarySensor(HomeeEntity, BinarySensorEntity):
     """Representation of a Homee binary sensor."""
 

homeassistant/components/homee/button.py

@@ -1,7 +1,7 @@
 """The homee button platform."""
 
 from pyHomee.const import AttributeType
-from pyHomee.model import HomeeAttribute
+from pyHomee.model import HomeeAttribute, HomeeNode
 
 from homeassistant.components.button import (
     ButtonDeviceClass,
@@ -14,6 +14,7 @@
 
 from . import HomeeConfigEntry
 from .entity import HomeeEntity
+from .helpers import setup_homee_platform
 
 PARALLEL_UPDATES = 0
 
@@ -39,21 +40,30 @@
 }
 
 
-async def async_setup_entry(
-    hass: HomeAssistant,
+async def add_button_entities(
     config_entry: HomeeConfigEntry,
     async_add_entities: AddConfigEntryEntitiesCallback,
+    nodes: list[HomeeNode],
 ) -> None:
-    """Add the Homee platform for the button component."""
-
+    """Add homee button entities."""
     async_add_entities(
         HomeeButton(attribute, config_entry, BUTTON_DESCRIPTIONS[attribute.type])
-        for node in config_entry.runtime_data.nodes
+        for node in nodes
         for attribute in node.attributes
         if attribute.type in BUTTON_DESCRIPTIONS and attribute.editable
     )
 
 
+async def async_setup_entry(
+    hass: HomeAssistant,
+    config_entry: HomeeConfigEntry,
+    async_add_entities: AddConfigEntryEntitiesCallback,
+) -> None:
+    """Add the homee platform for the button component."""
+
+    await setup_homee_platform(add_button_entities, async_add_entities, config_entry)
+
+
 class HomeeButton(HomeeEntity, ButtonEntity):
     """Representation of a Homee button."""
 

homeassistant/components/homee/climate.py

@@ -21,6 +21,7 @@
 from . import HomeeConfigEntry
 from .const import CLIMATE_PROFILES, DOMAIN, HOMEE_UNIT_TO_HA_UNIT, PRESET_MANUAL
 from .entity import HomeeNodeEntity
+from .helpers import setup_homee_platform
 
 PARALLEL_UPDATES = 0
 
@@ -31,18 +32,27 @@
 }
 
 
+async def add_climate_entities(
+    config_entry: HomeeConfigEntry,
+    async_add_entities: AddConfigEntryEntitiesCallback,
+    nodes: list[HomeeNode],
+) -> None:
+    """Add homee climate entities."""
+    async_add_entities(
+        HomeeClimate(node, config_entry)
+        for node in nodes
+        if node.profile in CLIMATE_PROFILES
+    )
+
+
 async def async_setup_entry(
     hass: HomeAssistant,
     config_entry: HomeeConfigEntry,
-    async_add_devices: AddConfigEntryEntitiesCallback,
+    async_add_entities: AddConfigEntryEntitiesCallback,
 ) -> None:
     """Add the Homee platform for the climate component."""
 
-    async_add_devices(
-        HomeeClimate(node, config_entry)
-        for node in config_entry.runtime_data.nodes
-        if node.profile in CLIMATE_PROFILES
-    )
+    await setup_homee_platform(add_climate_entities, async_add_entities, config_entry)
 
 
 class HomeeClimate(HomeeNodeEntity, ClimateEntity):

homeassistant/components/homee/cover.py

@@ -18,6 +18,7 @@
 
 from . import HomeeConfigEntry
 from .entity import HomeeNodeEntity
+from .helpers import setup_homee_platform
 
 _LOGGER = logging.getLogger(__name__)
 
@@ -77,18 +78,25 @@ def get_device_class(node: HomeeNode) -> CoverDeviceClass | None:
     return COVER_DEVICE_PROFILES.get(node.profile)
 
 
+async def add_cover_entities(
+    config_entry: HomeeConfigEntry,
+    async_add_entities: AddConfigEntryEntitiesCallback,
+    nodes: list[HomeeNode],
+) -> None:
+    """Add homee cover entities."""
+    async_add_entities(
+        HomeeCover(node, config_entry) for node in nodes if is_cover_node(node)
+    )
+
+
 async def async_setup_entry(
     hass: HomeAssistant,
     config_entry: HomeeConfigEntry,
-    async_add_devices: AddConfigEntryEntitiesCallback,
+    async_add_entities: AddConfigEntryEntitiesCallback,
 ) -> None:
     """Add the homee platform for the cover integration."""
 
-    async_add_devices(
-        HomeeCover(node, config_entry)
-        for node in config_entry.runtime_data.nodes
-        if is_cover_node(node)
-    )
+    await setup_homee_platform(add_cover_entities, async_add_entities, config_entry)
 
 
 def is_cover_node(node: HomeeNode) -> bool:

homeassistant/components/homee/event.py

@@ -1,7 +1,7 @@
 """The homee event platform."""
 
 from pyHomee.const import AttributeType, NodeProfile
-from pyHomee.model import HomeeAttribute
+from pyHomee.model import HomeeAttribute, HomeeNode
 
 from homeassistant.components.event import (
     EventDeviceClass,
@@ -13,6 +13,7 @@
 
 from . import HomeeConfigEntry
 from .entity import HomeeEntity
+from .helpers import setup_homee_platform
 
 PARALLEL_UPDATES = 0
 
@@ -49,23 +50,32 @@
 }
 
 
-async def async_setup_entry(
-    hass: HomeAssistant,
+async def add_event_entities(
     config_entry: HomeeConfigEntry,
     async_add_entities: AddConfigEntryEntitiesCallback,
+    nodes: list[HomeeNode],
 ) -> None:
-    """Add event entities for homee."""
-
+    """Add homee event entities."""
     async_add_entities(
         HomeeEvent(attribute, config_entry, EVENT_DESCRIPTIONS[attribute.type])
-        for node in config_entry.runtime_data.nodes
+        for node in nodes
         for attribute in node.attributes
         if attribute.type in EVENT_DESCRIPTIONS
         and node.profile in REMOTE_PROFILES
         and not attribute.editable
     )
 
 
+async def async_setup_entry(
+    hass: HomeAssistant,
+    config_entry: HomeeConfigEntry,
+    async_add_entities: AddConfigEntryEntitiesCallback,
+) -> None:
+    """Add event entities for homee."""
+
+    await setup_homee_platform(add_event_entities, async_add_entities, config_entry)
+
+
 class HomeeEvent(HomeeEntity, EventEntity):
     """Representation of a homee event."""
 

homeassistant/components/homee/fan.py

@@ -19,22 +19,32 @@
 from . import HomeeConfigEntry
 from .const import DOMAIN, PRESET_AUTO, PRESET_MANUAL, PRESET_SUMMER
 from .entity import HomeeNodeEntity
+from .helpers import setup_homee_platform
 
 PARALLEL_UPDATES = 0
 
 
+async def add_fan_entities(
+    config_entry: HomeeConfigEntry,
+    async_add_entities: AddConfigEntryEntitiesCallback,
+    nodes: list[HomeeNode],
+) -> None:
+    """Add homee fan entities."""
+    async_add_entities(
+        HomeeFan(node, config_entry)
+        for node in nodes
+        if node.profile == NodeProfile.VENTILATION_CONTROL
+    )
+
+
 async def async_setup_entry(
     hass: HomeAssistant,
     config_entry: HomeeConfigEntry,
-    async_add_devices: AddConfigEntryEntitiesCallback,
+    async_add_entities: AddConfigEntryEntitiesCallback,
 ) -> None:
     """Set up the Homee fan platform."""
 
-    async_add_devices(
-        HomeeFan(node, config_entry)
-        for node in config_entry.runtime_data.nodes
-        if node.profile == NodeProfile.VENTILATION_CONTROL
-    )
+    await setup_homee_platform(add_fan_entities, async_add_entities, config_entry)
 
 
 class HomeeFan(HomeeNodeEntity, FanEntity):

homeassistant/components/homee/helpers.py

@@ -1,11 +1,42 @@
 """Helper functions for the homee custom component."""
 
+from collections.abc import Callable, Coroutine
 from enum import IntEnum
 import logging
+from typing import Any
+
+from pyHomee.model import HomeeNode
+
+from homeassistant.helpers.entity_platform import AddConfigEntryEntitiesCallback
+
+from . import HomeeConfigEntry
 
 _LOGGER = logging.getLogger(__name__)
 
 
+async def setup_homee_platform(
+    add_platform_entities: Callable[
+        [HomeeConfigEntry, AddConfigEntryEntitiesCallback, list[HomeeNode]],
+        Coroutine[Any, Any, None],
+    ],
+    async_add_entities: AddConfigEntryEntitiesCallback,
+    config_entry: HomeeConfigEntry,
+) -> None:
+    """Set up a homee platform."""
+    await add_platform_entities(
+        config_entry, async_add_entities, config_entry.runtime_data.nodes
+    )
+
+    async def add_device(node: HomeeNode, add: bool) -> None:
+        """Dynamically add entities."""
+        if add:
+            await add_platform_entities(config_entry, async_add_entities, [node])
+
+    config_entry.async_on_unload(
+        config_entry.runtime_data.add_nodes_listener(add_device)
+    )
+
+
 def get_name_for_enum(att_class: type[IntEnum], att_id: int) -> str | None:
     """Return the enum item name for a given integer."""
     try: