core/homeassistant/components/aquacell/sensor.py

"""Sensors exposing properties of the softener device."""

from collections.abc import Callable
from dataclasses import dataclass
from datetime import datetime

from aioaquacell import Softener

from homeassistant.components.sensor import (
    SensorDeviceClass,
    SensorEntity,
    SensorEntityDescription,
    SensorStateClass,
)
from homeassistant.const import PERCENTAGE, UnitOfTime
from homeassistant.core import HomeAssistant
from homeassistant.helpers.entity_platform import AddConfigEntryEntitiesCallback
from homeassistant.helpers.typing import StateType

from .coordinator import AquacellConfigEntry, AquacellCoordinator
from .entity import AquacellEntity

PARALLEL_UPDATES = 1


@dataclass(frozen=True, kw_only=True)
class SoftenerSensorEntityDescription(SensorEntityDescription):
    """Describes Softener sensor entity."""

    value_fn: Callable[[Softener], StateType | datetime]


SENSORS: tuple[SoftenerSensorEntityDescription, ...] = (
    SoftenerSensorEntityDescription(
        key="salt_left_side_percentage",
        translation_key="salt_left_side_percentage",
        state_class=SensorStateClass.MEASUREMENT,
        native_unit_of_measurement=PERCENTAGE,
        value_fn=lambda softener: softener.salt.left_percent,
    ),
    SoftenerSensorEntityDescription(
        key="salt_right_side_percentage",
        translation_key="salt_right_side_percentage",
        state_class=SensorStateClass.MEASUREMENT,
        native_unit_of_measurement=PERCENTAGE,
        value_fn=lambda softener: softener.salt.right_percent,
    ),
    SoftenerSensorEntityDescription(
        key="salt_left_side_time_remaining",
        translation_key="salt_left_side_time_remaining",
        device_class=SensorDeviceClass.DURATION,
        native_unit_of_measurement=UnitOfTime.DAYS,
        value_fn=lambda softener: softener.salt.left_days,
    ),
    SoftenerSensorEntityDescription(
        key="salt_right_side_time_remaining",
        translation_key="salt_right_side_time_remaining",
        device_class=SensorDeviceClass.DURATION,
        native_unit_of_measurement=UnitOfTime.DAYS,
        value_fn=lambda softener: softener.salt.right_days,
    ),
    SoftenerSensorEntityDescription(
        key="battery",
        device_class=SensorDeviceClass.BATTERY,
        native_unit_of_measurement=PERCENTAGE,
        value_fn=lambda softener: softener.diagnostics.battery,
    ),
    SoftenerSensorEntityDescription(
        key="wi_fi_strength",
        translation_key="wi_fi_strength",
        value_fn=lambda softener: softener.diagnostics.wifi_level,
        device_class=SensorDeviceClass.ENUM,
        options=[
            "high",
            "medium",
            "low",
        ],
    ),
    SoftenerSensorEntityDescription(
        key="last_update",
        translation_key="last_update",
        device_class=SensorDeviceClass.TIMESTAMP,
        value_fn=lambda softener: softener.diagnostics.last_update,
    ),
)


async def async_setup_entry(
    hass: HomeAssistant,
    config_entry: AquacellConfigEntry,
    async_add_entities: AddConfigEntryEntitiesCallback,
) -> None:
    """Set up the sensors."""
    softeners = config_entry.runtime_data.data
    async_add_entities(
        SoftenerSensor(config_entry.runtime_data, sensor, softener_key)
        for sensor in SENSORS
        for softener_key in softeners
    )


class SoftenerSensor(AquacellEntity, SensorEntity):
    """Softener sensor."""

    entity_description: SoftenerSensorEntityDescription

    def __init__(
        self,
        coordinator: AquacellCoordinator,
        description: SoftenerSensorEntityDescription,
        softener_key: str,
    ) -> None:
        """Pass coordinator to CoordinatorEntity."""
        super().__init__(coordinator, softener_key, description.key)

        self.entity_description = description

    @property
    def native_value(self) -> StateType | datetime:
        """Return the state of the sensor."""
        return self.entity_description.value_fn(self.softener)