Add group entity support to ZHA (#33196)
* split entity into base and entity * add initial light group support * add dispatching of groups to light * added zha group object * add group event listener * add and remove group members * get group by name * fix rebase * fix rebase * use group_id for unique_id * get entities from registry * use group name * update entity domain * update zha storage to handle groups * dispatch group entities * update light group * fix group remove and dispatch light group entities * allow picking the domain for group entities * beginning - auto determine entity domain * move methods to helpers so they can be shared * fix rebase * remove double init groups... again * cleanup startup * use asyncio create task * group entity discovery * add logging and fix group name * add logging and update group after probe if needed * test add group via gateway * add method to get group entity ids * update storage * test get group by name * update storage on remove * test group with single member * add light group tests * test some light group logic * type hints * fix tests and cleanup * revert init changes except for create task * remove group entity domain changing for now * add missing import * tricky code saving * review comments * clean up class defs * cleanup * fix rebase because I cant read * make pylint happy
This commit is contained in:
1 parent
3ee05ad4bb
commit
2a3c94bad0
16 files changed
+1084
-257
No files matched your search
@@ -3,6 +3,7 @@
|
||||
import asyncio
|
||||
import logging
|
||||
import time
|
||||
from typing import Any, Awaitable, Dict, List
|
||||
|
||||
from homeassistant.core import callback
|
||||
from homeassistant.helpers import entity
|
||||
@@ -20,6 +21,7 @@ from .core.const import (
|
||||
SIGNAL_REMOVE,
|
||||
)
|
||||
from .core.helpers import LogMixin
|
||||
from .core.typing import CALLABLE_T, ChannelsType, ChannelType, ZhaDeviceType
|
||||
|
||||
_LOGGER = logging.getLogger(__name__)
|
||||
|
||||
@@ -27,30 +29,24 @@ ENTITY_SUFFIX = "entity_suffix"
|
||||
RESTART_GRACE_PERIOD = 7200 # 2 hours
|
||||
|
||||
|
||||
class ZhaEntity(RestoreEntity, LogMixin, entity.Entity):
|
||||
class BaseZhaEntity(RestoreEntity, LogMixin, entity.Entity):
|
||||
"""A base class for ZHA entities."""
|
||||
|
||||
def __init__(self, unique_id, zha_device, channels, skip_entity_id=False, **kwargs):
|
||||
def __init__(self, unique_id: str, zha_device: ZhaDeviceType, **kwargs):
|
||||
"""Init ZHA entity."""
|
||||
self._force_update = False
|
||||
self._should_poll = False
|
||||
self._unique_id = unique_id
|
||||
ieeetail = "".join([f"{o:02x}" for o in zha_device.ieee[:4]])
|
||||
ch_names = [ch.cluster.ep_attribute for ch in channels]
|
||||
ch_names = ", ".join(sorted(ch_names))
|
||||
self._name = f"{zha_device.name} {ieeetail} {ch_names}"
|
||||
self._state = None
|
||||
self._device_state_attributes = {}
|
||||
self._zha_device = zha_device
|
||||
self.cluster_channels = {}
|
||||
self._available = False
|
||||
self._unsubs = []
|
||||
self.remove_future = None
|
||||
for channel in channels:
|
||||
self.cluster_channels[channel.name] = channel
|
||||
self._name: str = ""
|
||||
self._force_update: bool = False
|
||||
self._should_poll: bool = False
|
||||
self._unique_id: str = unique_id
|
||||
self._state: Any = None
|
||||
self._device_state_attributes: Dict[str, Any] = {}
|
||||
self._zha_device: ZhaDeviceType = zha_device
|
||||
self._available: bool = False
|
||||
self._unsubs: List[CALLABLE_T] = []
|
||||
self.remove_future: Awaitable[None] = None
|
||||
|
||||
@property
|
||||
def name(self):
|
||||
def name(self) -> str:
|
||||
"""Return Entity's default name."""
|
||||
return self._name
|
||||
|
||||
@@ -60,12 +56,12 @@ class ZhaEntity(RestoreEntity, LogMixin, entity.Entity):
|
||||
return self._unique_id
|
||||
|
||||
@property
|
||||
def zha_device(self):
|
||||
def zha_device(self) -> ZhaDeviceType:
|
||||
"""Return the zha device this entity is attached to."""
|
||||
return self._zha_device
|
||||
|
||||
@property
|
||||
def device_state_attributes(self):
|
||||
def device_state_attributes(self) -> Dict[str, Any]:
|
||||
"""Return device specific state attributes."""
|
||||
return self._device_state_attributes
|
||||
|
||||
@@ -80,7 +76,7 @@ class ZhaEntity(RestoreEntity, LogMixin, entity.Entity):
|
||||
return self._should_poll
|
||||
|
||||
@property
|
||||
def device_info(self):
|
||||
def device_info(self) -> Dict[str, Any]:
|
||||
"""Return a device description for device registry."""
|
||||
zha_device_info = self._zha_device.device_info
|
||||
ieee = zha_device_info["ieee"]
|
||||
@@ -94,31 +90,94 @@ class ZhaEntity(RestoreEntity, LogMixin, entity.Entity):
|
||||
}
|
||||
|
||||
@property
|
||||
def available(self):
|
||||
def available(self) -> bool:
|
||||
"""Return entity availability."""
|
||||
return self._available
|
||||
|
||||
@callback
|
||||
def async_set_available(self, available):
|
||||
def async_set_available(self, available: bool) -> None:
|
||||
"""Set entity availability."""
|
||||
self._available = available
|
||||
self.async_write_ha_state()
|
||||
|
||||
@callback
|
||||
def async_update_state_attribute(self, key, value):
|
||||
def async_update_state_attribute(self, key: str, value: Any) -> None:
|
||||
"""Update a single device state attribute."""
|
||||
self._device_state_attributes.update({key: value})
|
||||
self.async_write_ha_state()
|
||||
|
||||
@callback
|
||||
def async_set_state(self, attr_id, attr_name, value):
|
||||
def async_set_state(self, attr_id: int, attr_name: str, value: Any) -> None:
|
||||
"""Set the entity state."""
|
||||
pass
|
||||
|
||||
async def async_added_to_hass(self):
|
||||
async def async_added_to_hass(self) -> None:
|
||||
"""Run when about to be added to hass."""
|
||||
await super().async_added_to_hass()
|
||||
self.remove_future = asyncio.Future()
|
||||
await self.async_accept_signal(
|
||||
None,
|
||||
"{}_{}".format(SIGNAL_REMOVE, str(self.zha_device.ieee)),
|
||||
self.async_remove,
|
||||
signal_override=True,
|
||||
)
|
||||
|
||||
async def async_will_remove_from_hass(self) -> None:
|
||||
"""Disconnect entity object when removed."""
|
||||
for unsub in self._unsubs[:]:
|
||||
unsub()
|
||||
self._unsubs.remove(unsub)
|
||||
self.zha_device.gateway.remove_entity_reference(self)
|
||||
self.remove_future.set_result(True)
|
||||
|
||||
@callback
|
||||
def async_restore_last_state(self, last_state) -> None:
|
||||
"""Restore previous state."""
|
||||
pass
|
||||
|
||||
async def async_accept_signal(
|
||||
self, channel: ChannelType, signal: str, func: CALLABLE_T, signal_override=False
|
||||
):
|
||||
"""Accept a signal from a channel."""
|
||||
unsub = None
|
||||
if signal_override:
|
||||
unsub = async_dispatcher_connect(self.hass, signal, func)
|
||||
else:
|
||||
unsub = async_dispatcher_connect(
|
||||
self.hass, f"{channel.unique_id}_{signal}", func
|
||||
)
|
||||
self._unsubs.append(unsub)
|
||||
|
||||
def log(self, level: int, msg: str, *args):
|
||||
"""Log a message."""
|
||||
msg = f"%s: {msg}"
|
||||
args = (self.entity_id,) + args
|
||||
_LOGGER.log(level, msg, *args)
|
||||
|
||||
|
||||
class ZhaEntity(BaseZhaEntity):
|
||||
"""A base class for non group ZHA entities."""
|
||||
|
||||
def __init__(
|
||||
self,
|
||||
unique_id: str,
|
||||
zha_device: ZhaDeviceType,
|
||||
channels: ChannelsType,
|
||||
**kwargs,
|
||||
):
|
||||
"""Init ZHA entity."""
|
||||
super().__init__(unique_id, zha_device, **kwargs)
|
||||
ieeetail = "".join([f"{o:02x}" for o in zha_device.ieee[:4]])
|
||||
ch_names = [ch.cluster.ep_attribute for ch in channels]
|
||||
ch_names = ", ".join(sorted(ch_names))
|
||||
self._name: str = f"{zha_device.name} {ieeetail} {ch_names}"
|
||||
self.cluster_channels: Dict[str, ChannelType] = {}
|
||||
for channel in channels:
|
||||
self.cluster_channels[channel.name] = channel
|
||||
|
||||
async def async_added_to_hass(self) -> None:
|
||||
"""Run when about to be added to hass."""
|
||||
await super().async_added_to_hass()
|
||||
await self.async_check_recently_seen()
|
||||
await self.async_accept_signal(
|
||||
None,
|
||||
@@ -126,12 +185,6 @@ class ZhaEntity(RestoreEntity, LogMixin, entity.Entity):
|
||||
self.async_set_available,
|
||||
signal_override=True,
|
||||
)
|
||||
await self.async_accept_signal(
|
||||
None,
|
||||
"{}_{}".format(SIGNAL_REMOVE, str(self.zha_device.ieee)),
|
||||
self.async_remove,
|
||||
signal_override=True,
|
||||
)
|
||||
self._zha_device.gateway.register_entity_reference(
|
||||
self._zha_device.ieee,
|
||||
self.entity_id,
|
||||
@@ -141,7 +194,7 @@ class ZhaEntity(RestoreEntity, LogMixin, entity.Entity):
|
||||
self.remove_future,
|
||||
)
|
||||
|
||||
async def async_check_recently_seen(self):
|
||||
async def async_check_recently_seen(self) -> None:
|
||||
"""Check if the device was seen within the last 2 hours."""
|
||||
last_state = await self.async_get_last_state()
|
||||
if (
|
||||
@@ -155,38 +208,8 @@ class ZhaEntity(RestoreEntity, LogMixin, entity.Entity):
|
||||
self.async_restore_last_state(last_state)
|
||||
self._zha_device.set_available(True)
|
||||
|
||||
async def async_will_remove_from_hass(self) -> None:
|
||||
"""Disconnect entity object when removed."""
|
||||
for unsub in self._unsubs[:]:
|
||||
unsub()
|
||||
self._unsubs.remove(unsub)
|
||||
self.zha_device.gateway.remove_entity_reference(self)
|
||||
self.remove_future.set_result(True)
|
||||
|
||||
@callback
|
||||
def async_restore_last_state(self, last_state):
|
||||
"""Restore previous state."""
|
||||
pass
|
||||
|
||||
async def async_update(self):
|
||||
async def async_update(self) -> None:
|
||||
"""Retrieve latest state."""
|
||||
for channel in self.cluster_channels.values():
|
||||
if hasattr(channel, "async_update"):
|
||||
await channel.async_update()
|
||||
|
||||
async def async_accept_signal(self, channel, signal, func, signal_override=False):
|
||||
"""Accept a signal from a channel."""
|
||||
unsub = None
|
||||
if signal_override:
|
||||
unsub = async_dispatcher_connect(self.hass, signal, func)
|
||||
else:
|
||||
unsub = async_dispatcher_connect(
|
||||
self.hass, f"{channel.unique_id}_{signal}", func
|
||||
)
|
||||
self._unsubs.append(unsub)
|
||||
|
||||
def log(self, level, msg, *args):
|
||||
"""Log a message."""
|
||||
msg = f"%s: {msg}"
|
||||
args = (self.entity_id,) + args
|
||||
_LOGGER.log(level, msg, *args)
|
||||
Reference in new issue
Block a user