entity.py

Go to the documentation of this file.

"""Generic entity for the WMS WebControl pro API integration."""
 
from __future__ import annotations
 
from wmspro.destination import Destination
 
from homeassistant.helpers.device_registry import DeviceInfo
from homeassistant.helpers.entity import Entity
 
from .const import ATTRIBUTION, DOMAIN, MANUFACTURER
 
 
class WebControlProGenericEntity(Entity):
    """Foundation of all WMS based entities."""
 
    _attr_attribution = ATTRIBUTION
    _attr_has_entity_name = True
    _attr_name = None
 
    def __init__(self, config_entry_id: str, dest: Destination) -> None:
        """Initialize the entity with destination channel."""
        dest_id_str = str(dest.id)
        self._dest_dest = dest
        self._attr_unique_id_attr_unique_id = dest_id_str
        self._attr_device_info_attr_device_info = DeviceInfo(
            identifiers={(DOMAIN, dest_id_str)},
            manufacturer=MANUFACTURER,
            model=dest.animationType.name,
            name=dest.name,
            serial_number=dest_id_str,
            suggested_area=dest.room.name,
            via_device=(DOMAIN, config_entry_id),
            configuration_url=f"http://{dest.host}/control",
        )
 
    async def async_update(self) -> None:
        """Update the entity."""
        await self._dest_dest.refresh()
 
    @property
    def available(self) -> bool:
        """Return if entity is available."""
        return self._dest_dest.available