entity.py

Go to the documentation of this file.

"""Base class for the La Marzocco entities."""
 
from collections.abc import Callable
from dataclasses import dataclass
 
from pylamarzocco.const import FirmwareType
from pylamarzocco.lm_machine import LaMarzoccoMachine
 
from homeassistant.const import CONF_ADDRESS
from homeassistant.helpers.device_registry import CONNECTION_NETWORK_MAC, DeviceInfo
from homeassistant.helpers.entity import EntityDescription
from homeassistant.helpers.update_coordinator import CoordinatorEntity
 
from .const import DOMAIN
from .coordinator import LaMarzoccoUpdateCoordinator
 
 
@dataclass(frozen=True, kw_only=True)
class LaMarzoccoEntityDescription(EntityDescription):
    """Description for all LM entities."""
 
    available_fn: Callable[[LaMarzoccoMachine], bool] = lambda _: True
    supported_fn: Callable[[LaMarzoccoUpdateCoordinator], bool] = lambda _: True
 
 
class LaMarzoccoBaseEntity(
    CoordinatorEntity[LaMarzoccoUpdateCoordinator],
):
    """Common elements for all entities."""
 
    _attr_has_entity_name = True
 
    def __init__(
        self,
        coordinator: LaMarzoccoUpdateCoordinator,
        key: str,
    ) -> None:
        """Initialize the entity."""
        super().__init__(coordinator)
        device = coordinator.device
        self._attr_unique_id_attr_unique_id = f"{device.serial_number}_{key}"
        self._attr_device_info_attr_device_info = DeviceInfo(
            identifiers={(DOMAIN, device.serial_number)},
            name=device.name,
            manufacturer="La Marzocco",
            model=device.full_model_name,
            model_id=device.model,
            serial_number=device.serial_number,
            sw_version=device.firmware[FirmwareType.MACHINE].current_version,
        )
        if coordinator.config_entry.data.get(CONF_ADDRESS):
            self._attr_device_info_attr_device_info.update(
                DeviceInfo(
                    connections={
                        (
                            CONNECTION_NETWORK_MAC,
                            coordinator.config_entry.data[CONF_ADDRESS],
                        )
                    }
                )
            )
 
 
class LaMarzoccoEntity(LaMarzoccoBaseEntity):
    """Common elements for all entities."""
 
    entity_description: LaMarzoccoEntityDescription
 
    @property
    def available(self) -> bool:
        """Return True if entity is available."""
        if super().available:
            return self.entity_descriptionentity_description.available_fn(self.coordinator.device)
        return False
 
    def __init__(
        self,
        coordinator: LaMarzoccoUpdateCoordinator,
        entity_description: LaMarzoccoEntityDescription,
    ) -> None:
        """Initialize the entity."""
        super().__init__(coordinator, entity_description.key)
        self.entity_descriptionentity_description = entity_description