entity.py

Go to the documentation of this file.

"""Base classes for Crownstone devices."""
 
from __future__ import annotations
 
from crownstone_cloud.cloud_models.crownstones import Crownstone
 
from homeassistant.helpers.device_registry import DeviceInfo
from homeassistant.helpers.entity import Entity
 
from .const import CROWNSTONE_INCLUDE_TYPES, DOMAIN
 
 
class CrownstoneEntity(Entity):
    """Base entity class for Crownstone devices."""
 
    _attr_should_poll = False
    _attr_has_entity_name = True
 
    def __init__(self, device: Crownstone) -> None:
        """Initialize the device."""
        self.devicedevice = device
 
    @property
    def cloud_id(self) -> str:
        """Return the unique identifier for this device.
 
        Used as device ID and to generate unique entity ID's.
        """
        return str(self.devicedevice.cloud_id)
 
    @property
    def device_info(self) -> DeviceInfo:
        """Return device info."""
        return DeviceInfo(
            identifiers={(DOMAIN, self.cloud_idcloud_id)},
            manufacturer="Crownstone",
            model=CROWNSTONE_INCLUDE_TYPES[self.devicedevice.type],
            name=self.devicedevice.name,
            sw_version=self.devicedevice.sw_version,
        )