entity.py

Go to the documentation of this file.

"""Home Connect entity base class."""
 
import logging
 
from homeassistant.core import callback
from homeassistant.helpers.device_registry import DeviceInfo
from homeassistant.helpers.dispatcher import async_dispatcher_connect
from homeassistant.helpers.entity import Entity, EntityDescription
 
from .api import HomeConnectDevice
from .const import DOMAIN, SIGNAL_UPDATE_ENTITIES
 
_LOGGER = logging.getLogger(__name__)
 
 
class HomeConnectEntity(Entity):
    """Generic Home Connect entity (base class)."""
 
    _attr_should_poll = False
    _attr_has_entity_name = True
 
    def __init__(self, device: HomeConnectDevice, desc: EntityDescription) -> None:
        """Initialize the entity."""
        self.devicedevice = device
        self.entity_descriptionentity_description = desc
        self._attr_unique_id_attr_unique_id = f"{device.appliance.haId}-{self.bsh_key}"
        self._attr_device_info_attr_device_info = DeviceInfo(
            identifiers={(DOMAIN, device.appliance.haId)},
            manufacturer=device.appliance.brand,
            model=device.appliance.vib,
            name=device.appliance.name,
        )
 
    async def async_added_to_hass(self) -> None:
        """Register callbacks."""
        self.async_on_removeasync_on_remove(
            async_dispatcher_connect(
                self.hasshass, SIGNAL_UPDATE_ENTITIES, self._update_callback_update_callback
            )
        )
 
    @callback
    def _update_callback(self, ha_id: str) -> None:
        """Update data."""
        if ha_id == self.devicedevice.appliance.haId:
            self.async_entity_updateasync_entity_update()
 
    @callback
    def async_entity_update(self) -> None:
        """Update the entity."""
        _LOGGER.debug("Entity update triggered on %s", self)
        self.async_schedule_update_ha_stateasync_schedule_update_ha_state(True)
 
    @property
    def bsh_key(self) -> str:
        """Return the BSH key."""
        return self.entity_descriptionentity_description.key