entity.py

Go to the documentation of this file.

"""Generic Plugwise Entity Class."""
 
from __future__ import annotations
 
from plugwise.constants import GwEntityData
 
from homeassistant.const import ATTR_NAME, ATTR_VIA_DEVICE, CONF_HOST
from homeassistant.helpers.device_registry import (
    CONNECTION_NETWORK_MAC,
    CONNECTION_ZIGBEE,
    DeviceInfo,
)
from homeassistant.helpers.update_coordinator import CoordinatorEntity
 
from .const import DOMAIN
from .coordinator import PlugwiseDataUpdateCoordinator
 
 
class PlugwiseEntity(CoordinatorEntity[PlugwiseDataUpdateCoordinator]):
    """Represent a PlugWise Entity."""
 
    _attr_has_entity_name = True
 
    def __init__(
        self,
        coordinator: PlugwiseDataUpdateCoordinator,
        device_id: str,
    ) -> None:
        """Initialise the gateway."""
        super().__init__(coordinator)
        self._dev_id_dev_id = device_id
 
        configuration_url: str | None = None
        if entry := self.coordinator.config_entry:
            configuration_url = f"http://{entry.data[CONF_HOST]}"
 
        data = coordinator.data.devices[device_id]
        connections = set()
        if mac := data.get("mac_address"):
            connections.add((CONNECTION_NETWORK_MAC, mac))
        if mac := data.get("zigbee_mac_address"):
            connections.add((CONNECTION_ZIGBEE, mac))
 
        self._attr_device_info_attr_device_info = DeviceInfo(
            configuration_url=configuration_url,
            identifiers={(DOMAIN, device_id)},
            connections=connections,
            manufacturer=data.get("vendor"),
            model=data.get("model"),
            model_id=data.get("model_id"),
            name=coordinator.data.gateway["smile_name"],
            sw_version=data.get("firmware"),
            hw_version=data.get("hardware"),
        )
 
        if device_id != coordinator.data.gateway["gateway_id"]:
            self._attr_device_info_attr_device_info.update(
                {
                    ATTR_NAME: data.get("name"),
                    ATTR_VIA_DEVICE: (
                        DOMAIN,
                        str(self.coordinator.data.gateway["gateway_id"]),
                    ),
                }
            )
 
    @property
    def available(self) -> bool:
        """Return if entity is available."""
        return (
            self._dev_id_dev_id in self.coordinator.data.devices
            and ("available" not in self.devicedevice or self.devicedevice["available"] is True)
            and super().available
        )
 
    @property
    def device(self) -> GwEntityData:
        """Return data for this device."""
        return self.coordinator.data.devices[self._dev_id_dev_id]
 
    async def async_added_to_hass(self) -> None:
        """Subscribe to updates."""
        self._handle_coordinator_update()
        await super().async_added_to_hass()