entity.py

Go to the documentation of this file.

"""Base Entity for Kaleidescape."""
 
from __future__ import annotations
 
import logging
from typing import TYPE_CHECKING
 
from homeassistant.core import callback
from homeassistant.helpers.device_registry import DeviceInfo
from homeassistant.helpers.entity import Entity
 
from .const import DOMAIN as KALEIDESCAPE_DOMAIN, NAME as KALEIDESCAPE_NAME
 
if TYPE_CHECKING:
    from kaleidescape import Device as KaleidescapeDevice
 
_LOGGER = logging.getLogger(__name__)
 
 
class KaleidescapeEntity(Entity):
    """Defines a base Kaleidescape entity."""
 
    _attr_has_entity_name = True
    _attr_should_poll = False
 
    def __init__(self, device: KaleidescapeDevice) -> None:
        """Initialize entity."""
        self._device_device = device
 
        self._attr_unique_id_attr_unique_id = device.serial_number
        self._attr_device_info_attr_device_info = DeviceInfo(
            identifiers={(KALEIDESCAPE_DOMAIN, self._device_device.serial_number)},
            # Instead of setting the device name to the entity name, kaleidescape
            # should be updated to set has_entity_name = True
            name=f"{KALEIDESCAPE_NAME} {device.system.friendly_name}",
            model=self._device_device.system.type,
            manufacturer=KALEIDESCAPE_NAME,
            sw_version=f"{self._device.system.kos_version}",
            suggested_area="Theater",
            configuration_url=f"http://{self._device.host}",
        )
 
    async def async_added_to_hass(self) -> None:
        """Register update listener."""
 
        @callback
        def _update(event: str) -> None:
            """Handle device state changes."""
            self.async_write_ha_stateasync_write_ha_state()
 
        self.async_on_removeasync_on_remove(self._device_device.dispatcher.connect(_update).disconnect)