entity.py

Go to the documentation of this file.

"""Support for esphome entities."""
 
from __future__ import annotations
 
from collections.abc import Awaitable, Callable, Coroutine
import functools
import math
from typing import TYPE_CHECKING, Any, Concatenate, Generic, TypeVar, cast
 
from aioesphomeapi import (
    APIConnectionError,
    EntityCategory as EsphomeEntityCategory,
    EntityInfo,
    EntityState,
    build_unique_id,
)
import voluptuous as vol
 
from homeassistant.const import EntityCategory
from homeassistant.core import HomeAssistant, callback
from homeassistant.exceptions import HomeAssistantError
from homeassistant.helpers import entity_platform
import homeassistant.helpers.config_validation as cv
import homeassistant.helpers.device_registry as dr
from homeassistant.helpers.device_registry import DeviceInfo
from homeassistant.helpers.entity import Entity
from homeassistant.helpers.entity_platform import AddEntitiesCallback
 
# Import config flow so that it's added to the registry
from .entry_data import ESPHomeConfigEntry, RuntimeEntryData
from .enum_mapper import EsphomeEnumMapper
 
_InfoT = TypeVar("_InfoT", bound=EntityInfo)
_EntityT = TypeVar("_EntityT", bound="EsphomeEntity[Any,Any]")
_StateT = TypeVar("_StateT", bound=EntityState)
 
 
@callback
def async_static_info_updated(
    hass: HomeAssistant,
    entry_data: RuntimeEntryData,
    platform: entity_platform.EntityPlatform,
    async_add_entities: AddEntitiesCallback,
    info_type: type[_InfoT],
    entity_type: type[_EntityT],
    state_type: type[_StateT],
    infos: list[EntityInfo],
) -> None:
    """Update entities of this platform when entities are listed."""
    current_infos = entry_data.info[info_type]
    new_infos: dict[int, EntityInfo] = {}
    add_entities: list[_EntityT] = []
 
    for info in infos:
        if not current_infos.pop(info.key, None):
            # Create new entity
            entity = entity_type(entry_data, platform.domain, info, state_type)
            add_entities.append(entity)
        new_infos[info.key] = info
 
    # Anything still in current_infos is now gone
    if current_infos:
        device_info = entry_data.device_info
        if TYPE_CHECKING:
            assert device_info is not None
        entry_data.async_remove_entities(
            hass, current_infos.values(), device_info.mac_address
        )
 
    # Then update the actual info
    entry_data.info[info_type] = new_infos
 
    if new_infos:
        entry_data.async_update_entity_infos(new_infos.values())
 
    if add_entities:
        # Add entities to Home Assistant
        async_add_entities(add_entities)
 
 
async def platform_async_setup_entry(
    hass: HomeAssistant,
    entry: ESPHomeConfigEntry,
    async_add_entities: AddEntitiesCallback,
    *,
    info_type: type[_InfoT],
    entity_type: type[_EntityT],
    state_type: type[_StateT],
) -> None:
    """Set up an esphome platform.
 
    This method is in charge of receiving, distributing and storing
    info and state updates.
    """
    entry_data = entry.runtime_data
    entry_data.info[info_type] = {}
    platform = entity_platform.async_get_current_platform()
    on_static_info_update = functools.partial(
        async_static_info_updated,
        hass,
        entry_data,
        platform,
        async_add_entities,
        info_type,
        entity_type,
        state_type,
    )
    entry_data.cleanup_callbacks.append(
        entry_data.async_register_static_info_callback(
            info_type,
            on_static_info_update,
        )
    )
 
 
def esphome_state_property[_R, _EntityT: EsphomeEntity[Any, Any]](
    func: Callable[[_EntityT], _R],
) -> Callable[[_EntityT], _R | None]:
    """Wrap a state property of an esphome entity.
 
    This checks if the state object in the entity is set
    and returns None if it is not set.
    """
 
    @functools.wraps(func)
    def _wrapper(self: _EntityT) -> _R | None:
        return func(self) if self._has_state else None
 
    return _wrapper
 
 
def esphome_float_state_property[_EntityT: EsphomeEntity[Any, Any]](
    func: Callable[[_EntityT], float | None],
) -> Callable[[_EntityT], float | None]:
    """Wrap a state property of an esphome entity that returns a float.
 
    This checks if the state object in the entity is set, and returns
    None if its not set. If also prevents writing NAN values to the
    Home Assistant state machine.
    """
 
    @functools.wraps(func)
    def _wrapper(self: _EntityT) -> float | None:
        if not self._has_state:
            return None
        val = func(self)
        # Home Assistant doesn't use NaN or inf values in state machine
        # (not JSON serializable)
        return None if val is None or not math.isfinite(val) else val
 
    return _wrapper
 
 
def convert_api_error_ha_error[**_P, _R, _EntityT: EsphomeEntity[Any, Any]](
    func: Callable[Concatenate[_EntityT, _P], Awaitable[None]],
) -> Callable[Concatenate[_EntityT, _P], Coroutine[Any, Any, None]]:
    """Decorate ESPHome command calls that send commands/make changes to the device.
 
    A decorator that wraps the passed in function, catches APIConnectionError errors,
    and raises a HomeAssistant error instead.
    """
 
    async def handler(self: _EntityT, *args: _P.args, **kwargs: _P.kwargs) -> None:
        try:
            return await func(self, *args, **kwargs)
        except APIConnectionError as error:
            raise HomeAssistantError(
                f"Error communicating with device: {error}"
            ) from error
 
    return handler
 
 
ICON_SCHEMA = vol.Schema(cv.icon)
 
 
ENTITY_CATEGORIES: EsphomeEnumMapper[EsphomeEntityCategory, EntityCategory | None] = (
    EsphomeEnumMapper(
        {
            EsphomeEntityCategory.NONE: None,
            EsphomeEntityCategory.CONFIG: EntityCategory.CONFIG,
            EsphomeEntityCategory.DIAGNOSTIC: EntityCategory.DIAGNOSTIC,
        }
    )
)
 
 
class EsphomeEntity(Entity, Generic[_InfoT, _StateT]):
    """Define a base esphome entity."""
 
    _attr_should_poll = False
    _static_info: _InfoT
    _state: _StateT
    _has_state: bool
 
    def __init__(
        self,
        entry_data: RuntimeEntryData,
        domain: str,
        entity_info: EntityInfo,
        state_type: type[_StateT],
    ) -> None:
        """Initialize."""
        self._entry_data_entry_data = entry_data
        self._states_states = cast(dict[int, _StateT], entry_data.state[state_type])
        assert entry_data.device_info is not None
        device_info = entry_data.device_info
        self._device_info_device_info = device_info
        self._on_entry_data_changed_on_entry_data_changed()
        self._key_key = entity_info.key
        self._state_type_state_type = state_type
        self._on_static_info_update_on_static_info_update(entity_info)
        self._attr_device_info_attr_device_info = DeviceInfo(
            connections={(dr.CONNECTION_NETWORK_MAC, device_info.mac_address)}
        )
        #
        # If `friendly_name` is set, we use the Friendly naming rules, if
        # `friendly_name` is not set we make an exception to the naming rules for
        # backwards compatibility and use the Legacy naming rules.
        #
        # Friendly naming
        # - Friendly name is prepended to entity names
        # - Device Name is prepended to entity ids
        # - Entity id is constructed from device name and object id
        #
        # Legacy naming
        # - Device name is not prepended to entity names
        # - Device name is not prepended to entity ids
        # - Entity id is constructed from entity name
        #
        if not device_info.friendly_name:
            return
        self._attr_has_entity_name_attr_has_entity_name = True
        self.entity_identity_identity_id = f"{domain}.{device_info.name}_{entity_info.object_id}"
 
    async def async_added_to_hass(self) -> None:
        """Register callbacks."""
        entry_data = self._entry_data_entry_data
        self.async_on_removeasync_on_remove(
            entry_data.async_subscribe_device_updated(
                self._on_device_update_on_device_update,
            )
        )
        self.async_on_removeasync_on_remove(
            entry_data.async_subscribe_state_update(
                self._state_type_state_type, self._key_key, self._on_state_update_on_state_update
            )
        )
        self.async_on_removeasync_on_remove(
            entry_data.async_register_key_static_info_updated_callback(
                self._static_info_static_info, self._on_static_info_update_on_static_info_update
            )
        )
        self._update_state_from_entry_data_update_state_from_entry_data()
 
    @callback
    def _on_static_info_update(self, static_info: EntityInfo) -> None:
        """Save the static info for this entity when it changes.
 
        This method can be overridden in child classes to know
        when the static info changes.
        """
        device_info = self._entry_data_entry_data.device_info
        if TYPE_CHECKING:
            static_info = cast(_InfoT, static_info)
            assert device_info
        self._static_info_static_info = static_info
        self._attr_unique_id_attr_unique_id = build_unique_id(device_info.mac_address, static_info)
        self._attr_entity_registry_enabled_default_attr_entity_registry_enabled_default = not static_info.disabled_by_default
        self._attr_name_attr_name = static_info.name
        if entity_category := static_info.entity_category:
            self._attr_entity_category_attr_entity_category = ENTITY_CATEGORIES.from_esphome(entity_category)
        else:
            self._attr_entity_category_attr_entity_category = None
        if icon := static_info.icon:
            self._attr_icon_attr_icon = cast(str, ICON_SCHEMA(icon))
        else:
            self._attr_icon_attr_icon = None
 
    @callback
    def _update_state_from_entry_data(self) -> None:
        """Update state from entry data."""
        key = self._key_key
        if has_state := key in self._states_states:
            self._state_state = self._states_states[key]
        self._has_state_has_state = has_state
 
    @callback
    def _on_state_update(self) -> None:
        """Call when state changed.
 
        Behavior can be changed in child classes
        """
        self._update_state_from_entry_data_update_state_from_entry_data()
        self.async_write_ha_stateasync_write_ha_state()
 
    @callback
    def _on_entry_data_changed(self) -> None:
        entry_data = self._entry_data_entry_data
        self._api_version_api_version = entry_data.api_version
        self._client_client = entry_data.client
        if self._device_info_device_info.has_deep_sleep:
            # During deep sleep the ESP will not be connectable (by design)
            # For these cases, show it as available
            self._attr_available_attr_available = entry_data.expected_disconnect
        else:
            self._attr_available_attr_available = entry_data.available
 
    @callback
    def _on_device_update(self) -> None:
        """Call when device updates or entry data changes."""
        self._on_entry_data_changed_on_entry_data_changed()
        if not self._entry_data_entry_data.available:
            # Only write state if the device has gone unavailable
            # since _on_state_update will be called if the device
            # is available when the full state arrives
            # through the next entity state packet.
            self.async_write_ha_stateasync_write_ha_state()
 
 
class EsphomeAssistEntity(Entity):
    """Define a base entity for Assist Pipeline entities."""
 
    _attr_has_entity_name = True
    _attr_should_poll = False
 
    def __init__(self, entry_data: RuntimeEntryData) -> None:
        """Initialize the binary sensor."""
        self._entry_data: RuntimeEntryData = entry_data
        assert entry_data.device_info is not None
        device_info = entry_data.device_info
        self._device_info_device_info = device_info
        self._attr_unique_id_attr_unique_id = (
            f"{device_info.mac_address}-{self.entity_description.key}"
        )
        self._attr_device_info_attr_device_info = DeviceInfo(
            connections={(dr.CONNECTION_NETWORK_MAC, device_info.mac_address)}
        )
 
    async def async_added_to_hass(self) -> None:
        """Register update callback."""
        await super().async_added_to_hass()
        self.async_on_removeasync_on_remove(
            self._entry_data.async_subscribe_assist_pipeline_update(
                self.async_write_ha_stateasync_write_ha_state
            )
        )