core/homeassistant/components/imgw_pib/sensor.py

"""IMGW-PIB sensor platform."""

from collections.abc import Callable
from dataclasses import dataclass
from typing import Any, override

from imgw_pib.const import HYDROLOGICAL_ALERTS_MAP, NO_ALERT
from imgw_pib.model import HydrologicalData

from homeassistant.components.sensor import (
    DOMAIN as SENSOR_DOMAIN,
    SensorDeviceClass,
    SensorEntity,
    SensorEntityDescription,
    SensorStateClass,
)
from homeassistant.const import (
    PERCENTAGE,
    UnitOfLength,
    UnitOfTemperature,
    UnitOfVolumeFlowRate,
)
from homeassistant.core import HomeAssistant
from homeassistant.helpers import entity_registry as er
from homeassistant.helpers.entity_platform import AddConfigEntryEntitiesCallback
from homeassistant.helpers.typing import StateType

from .const import DOMAIN
from .coordinator import ImgwPibConfigEntry, ImgwPibDataUpdateCoordinator
from .entity import ImgwPibEntity

# Coordinator is used to centralize the data updates
PARALLEL_UPDATES = 0


def gen_alert_attributes(data: HydrologicalData) -> dict[str, Any] | None:
    """Generate attributes for the alert entity."""
    if data.hydrological_alert.value == NO_ALERT:
        return None

    return {
        "level": data.hydrological_alert.level,
        "probability": data.hydrological_alert.probability,
        "valid_from": data.hydrological_alert.valid_from,
        "valid_to": data.hydrological_alert.valid_to,
    }


@dataclass(frozen=True, kw_only=True)
class ImgwPibSensorEntityDescription(SensorEntityDescription):
    """IMGW-PIB sensor entity description."""

    value: Callable[[HydrologicalData], StateType]
    attrs: Callable[[HydrologicalData], dict[str, Any] | None] | None = None


SENSOR_TYPES: tuple[ImgwPibSensorEntityDescription, ...] = (
    ImgwPibSensorEntityDescription(
        key="hydrological_alert",
        translation_key="hydrological_alert",
        device_class=SensorDeviceClass.ENUM,
        options=list(HYDROLOGICAL_ALERTS_MAP.values()),
        value=lambda data: data.hydrological_alert.value,
        attrs=gen_alert_attributes,
    ),
    ImgwPibSensorEntityDescription(
        key="ice_phenomena",
        translation_key="ice_phenomena",
        native_unit_of_measurement=PERCENTAGE,
        state_class=SensorStateClass.MEASUREMENT,
        value=lambda data: data.ice_phenomena.value,
        suggested_display_precision=0,
    ),
    ImgwPibSensorEntityDescription(
        key="water_flow",
        translation_key="water_flow",
        native_unit_of_measurement=UnitOfVolumeFlowRate.CUBIC_METERS_PER_SECOND,
        device_class=SensorDeviceClass.VOLUME_FLOW_RATE,
        state_class=SensorStateClass.MEASUREMENT,
        suggested_display_precision=1,
        value=lambda data: data.water_flow.value,
    ),
    ImgwPibSensorEntityDescription(
        key="water_level",
        translation_key="water_level",
        native_unit_of_measurement=UnitOfLength.CENTIMETERS,
        device_class=SensorDeviceClass.DISTANCE,
        state_class=SensorStateClass.MEASUREMENT,
        suggested_display_precision=0,
        value=lambda data: data.water_level.value,
    ),
    ImgwPibSensorEntityDescription(
        key="water_temperature",
        translation_key="water_temperature",
        native_unit_of_measurement=UnitOfTemperature.CELSIUS,
        device_class=SensorDeviceClass.TEMPERATURE,
        state_class=SensorStateClass.MEASUREMENT,
        suggested_display_precision=1,
        value=lambda data: data.water_temperature.value,
    ),
    ImgwPibSensorEntityDescription(
        key="submerged_vegetation_cover",
        translation_key="submerged_vegetation_cover",
        native_unit_of_measurement=PERCENTAGE,
        state_class=SensorStateClass.MEASUREMENT,
        value=lambda data: data.submerged_vegetation_cover.value,
        suggested_display_precision=0,
        entity_registry_enabled_default=False,
    ),
    ImgwPibSensorEntityDescription(
        key="floating_vegetation_cover",
        translation_key="floating_vegetation_cover",
        native_unit_of_measurement=PERCENTAGE,
        state_class=SensorStateClass.MEASUREMENT,
        value=lambda data: data.floating_vegetation_cover.value,
        suggested_display_precision=0,
        entity_registry_enabled_default=False,
    ),
    ImgwPibSensorEntityDescription(
        key="emergent_vegetation_cover",
        translation_key="emergent_vegetation_cover",
        native_unit_of_measurement=PERCENTAGE,
        state_class=SensorStateClass.MEASUREMENT,
        value=lambda data: data.emergent_vegetation_cover.value,
        suggested_display_precision=0,
        entity_registry_enabled_default=False,
    ),
)


async def async_setup_entry(
    hass: HomeAssistant,
    entry: ImgwPibConfigEntry,
    async_add_entities: AddConfigEntryEntitiesCallback,
) -> None:
    """Add a IMGW-PIB sensor entity from a config_entry."""
    coordinator = entry.runtime_data.coordinator

    # Remove entities for which the endpoint has been blocked by IMGW-PIB API
    entity_reg = er.async_get(hass)
    for key in ("flood_warning_level", "flood_alarm_level"):
        if entity_id := entity_reg.async_get_entity_id(
            SENSOR_DOMAIN, DOMAIN, f"{coordinator.station_id}_{key}"
        ):
            entity_reg.async_remove(entity_id)

    async_add_entities(
        ImgwPibSensorEntity(coordinator, description) for description in SENSOR_TYPES
    )


class ImgwPibSensorEntity(ImgwPibEntity, SensorEntity):
    """Define IMGW-PIB sensor entity."""

    entity_description: ImgwPibSensorEntityDescription

    def __init__(
        self,
        coordinator: ImgwPibDataUpdateCoordinator,
        description: ImgwPibSensorEntityDescription,
    ) -> None:
        """Initialize."""
        super().__init__(coordinator)

        self._attr_unique_id = f"{coordinator.station_id}_{description.key}"
        self.entity_description = description

    @property
    @override
    def native_value(self) -> StateType:
        """Return the value reported by the sensor."""
        return self.entity_description.value(self.coordinator.data)

    @property
    @override
    def extra_state_attributes(self) -> dict[str, Any] | None:
        """Return the state attributes."""
        if self.entity_description.attrs:
            return self.entity_description.attrs(self.coordinator.data)

        return None