sensor.py

Go to the documentation of this file.

"""Support for Twente Milieu sensors."""
 
from __future__ import annotations
 
from dataclasses import dataclass
from datetime import date
 
from twentemilieu import WasteType
 
from homeassistant.components.sensor import (
    SensorDeviceClass,
    SensorEntity,
    SensorEntityDescription,
)
from homeassistant.config_entries import ConfigEntry
from homeassistant.const import CONF_ID
from homeassistant.core import HomeAssistant
from homeassistant.helpers.entity_platform import AddEntitiesCallback
 
from .const import DOMAIN
from .entity import TwenteMilieuEntity
 
 
@dataclass(frozen=True, kw_only=True)
class TwenteMilieuSensorDescription(SensorEntityDescription):
    """Describe an Twente Milieu sensor."""
 
    waste_type: WasteType
 
 
SENSORS: tuple[TwenteMilieuSensorDescription, ...] = (
    TwenteMilieuSensorDescription(
        key="tree",
        translation_key="christmas_tree_pickup",
        waste_type=WasteType.TREE,
        device_class=SensorDeviceClass.DATE,
    ),
    TwenteMilieuSensorDescription(
        key="Non-recyclable",
        translation_key="non_recyclable_waste_pickup",
        waste_type=WasteType.NON_RECYCLABLE,
        device_class=SensorDeviceClass.DATE,
    ),
    TwenteMilieuSensorDescription(
        key="Organic",
        translation_key="organic_waste_pickup",
        waste_type=WasteType.ORGANIC,
        device_class=SensorDeviceClass.DATE,
    ),
    TwenteMilieuSensorDescription(
        key="Paper",
        translation_key="paper_waste_pickup",
        waste_type=WasteType.PAPER,
        device_class=SensorDeviceClass.DATE,
    ),
    TwenteMilieuSensorDescription(
        key="Plastic",
        translation_key="packages_waste_pickup",
        waste_type=WasteType.PACKAGES,
        device_class=SensorDeviceClass.DATE,
    ),
)
 
 
async def async_setup_entry(
    hass: HomeAssistant,
    entry: ConfigEntry,
    async_add_entities: AddEntitiesCallback,
) -> None:
    """Set up Twente Milieu sensor based on a config entry."""
    async_add_entities(
        TwenteMilieuSensor(entry, description) for description in SENSORS
    )
 
 
class TwenteMilieuSensor(TwenteMilieuEntity, SensorEntity):
    """Defines a Twente Milieu sensor."""
 
    entity_description: TwenteMilieuSensorDescription
 
    def __init__(
        self,
        entry: ConfigEntry,
        description: TwenteMilieuSensorDescription,
    ) -> None:
        """Initialize the Twente Milieu entity."""
        super().__init__(entry)
        self.entity_descriptionentity_description = description
        self._attr_unique_id_attr_unique_id = f"{DOMAIN}_{entry.data[CONF_ID]}_{description.key}"
 
    @property
    def native_value(self) -> date | None:
        """Return the state of the sensor."""
        if not (dates := self.coordinator.data[self.entity_descriptionentity_description.waste_type]):
            return None
        return dates[0]