sensor.py

Go to the documentation of this file.

"""Representation of Idasen Desk sensors."""
 
from __future__ import annotations
 
from collections.abc import Callable
from dataclasses import dataclass
from typing import Any
 
from homeassistant import config_entries
from homeassistant.components.sensor import (
    SensorDeviceClass,
    SensorEntity,
    SensorEntityDescription,
    SensorStateClass,
)
from homeassistant.const import UnitOfLength
from homeassistant.core import HomeAssistant, callback
from homeassistant.helpers.device_registry import DeviceInfo
from homeassistant.helpers.entity_platform import AddEntitiesCallback
from homeassistant.helpers.update_coordinator import CoordinatorEntity
 
from . import DeskData, IdasenDeskCoordinator
from .const import DOMAIN
 
 
@dataclass(frozen=True, kw_only=True)
class IdasenDeskSensorDescription(SensorEntityDescription):
    """Class describing IdasenDesk sensor entities."""
 
    value_fn: Callable[[IdasenDeskCoordinator], float | None]
 
 
SENSORS = (
    IdasenDeskSensorDescription(
        key="height",
        translation_key="height",
        native_unit_of_measurement=UnitOfLength.METERS,
        device_class=SensorDeviceClass.DISTANCE,
        state_class=SensorStateClass.MEASUREMENT,
        entity_registry_enabled_default=False,
        suggested_display_precision=3,
        value_fn=lambda coordinator: coordinator.desk.height,
    ),
)
 
 
async def async_setup_entry(
    hass: HomeAssistant,
    entry: config_entries.ConfigEntry,
    async_add_entities: AddEntitiesCallback,
) -> None:
    """Set up Idasen Desk sensors."""
    data: DeskData = hass.data[DOMAIN][entry.entry_id]
    async_add_entities(
        IdasenDeskSensor(
            data.address, data.device_info, data.coordinator, sensor_description
        )
        for sensor_description in SENSORS
    )
 
 
class IdasenDeskSensor(CoordinatorEntity[IdasenDeskCoordinator], SensorEntity):
    """IdasenDesk sensor."""
 
    entity_description: IdasenDeskSensorDescription
    _attr_has_entity_name = True
 
    def __init__(
        self,
        address: str,
        device_info: DeviceInfo,
        coordinator: IdasenDeskCoordinator,
        description: IdasenDeskSensorDescription,
    ) -> None:
        """Initialize the IdasenDesk sensor entity."""
        super().__init__(coordinator)
        self.entity_descriptionentity_description = description
 
        self._attr_unique_id_attr_unique_id = f"{description.key}-{address}"
        self._attr_device_info_attr_device_info = device_info
        self._address_address = address
        self._desk_desk = coordinator.desk
 
    async def async_added_to_hass(self) -> None:
        """When entity is added to hass."""
        await super().async_added_to_hass()
        self._update_native_value_update_native_value()
 
    @property
    def available(self) -> bool:
        """Return True if entity is available."""
        return super().available and self._desk_desk.is_connected is True
 
    @callback
    def _handle_coordinator_update(self, *args: Any) -> None:
        """Handle data update."""
        self._update_native_value_update_native_value()
        super()._handle_coordinator_update()
 
    def _update_native_value(self) -> None:
        """Update the native value attribute."""
        self._attr_native_value_attr_native_value = self.entity_descriptionentity_description.value_fn(self.coordinator)