entity.py

Go to the documentation of this file.

"""Base entity class for Schlage."""
 
from pyschlage.lock import Lock
 
from homeassistant.helpers.device_registry import DeviceInfo
from homeassistant.helpers.update_coordinator import CoordinatorEntity
 
from .const import DOMAIN, MANUFACTURER
from .coordinator import LockData, SchlageDataUpdateCoordinator
 
 
class SchlageEntity(CoordinatorEntity[SchlageDataUpdateCoordinator]):
    """Base Schlage entity."""
 
    _attr_has_entity_name = True
 
    def __init__(
        self, coordinator: SchlageDataUpdateCoordinator, device_id: str
    ) -> None:
        """Initialize a Schlage entity."""
        super().__init__(coordinator=coordinator)
        self.device_iddevice_id = device_id
        self._attr_unique_id_attr_unique_id = device_id
        self._attr_device_info_attr_device_info = DeviceInfo(
            identifiers={(DOMAIN, device_id)},
            name=self._lock_lock.name,
            manufacturer=MANUFACTURER,
            model=self._lock_lock.model_name,
            sw_version=self._lock_lock.firmware_version,
        )
 
    @property
    def _lock_data(self) -> LockData:
        """Fetch the LockData from our coordinator."""
        return self.coordinator.data.locks[self.device_iddevice_id]
 
    @property
    def _lock(self) -> Lock:
        """Fetch the Schlage lock from our coordinator."""
        return self._lock_data_lock_data.lock
 
    @property
    def available(self) -> bool:
        """Return if entity is available."""
        return super().available and self.device_iddevice_id in self.coordinator.data.locks