binary_sensor.py

Go to the documentation of this file.

"""IMGW-PIB binary sensor platform."""
 
from __future__ import annotations
 
from collections.abc import Callable
from dataclasses import dataclass
 
from imgw_pib.model import HydrologicalData
 
from homeassistant.components.binary_sensor import (
    BinarySensorDeviceClass,
    BinarySensorEntity,
    BinarySensorEntityDescription,
)
from homeassistant.core import HomeAssistant
from homeassistant.helpers.entity_platform import AddEntitiesCallback
 
from . import ImgwPibConfigEntry
from .coordinator import ImgwPibDataUpdateCoordinator
from .entity import ImgwPibEntity
 
PARALLEL_UPDATES = 1
 
 
@dataclass(frozen=True, kw_only=True)
class ImgwPibBinarySensorEntityDescription(BinarySensorEntityDescription):
    """IMGW-PIB sensor entity description."""
 
    value: Callable[[HydrologicalData], bool | None]
 
 
BINARY_SENSOR_TYPES: tuple[ImgwPibBinarySensorEntityDescription, ...] = (
    ImgwPibBinarySensorEntityDescription(
        key="flood_warning",
        translation_key="flood_warning",
        device_class=BinarySensorDeviceClass.SAFETY,
        value=lambda data: data.flood_warning,
    ),
    ImgwPibBinarySensorEntityDescription(
        key="flood_alarm",
        translation_key="flood_alarm",
        device_class=BinarySensorDeviceClass.SAFETY,
        value=lambda data: data.flood_alarm,
    ),
)
 
 
async def async_setup_entry(
    hass: HomeAssistant,
    entry: ImgwPibConfigEntry,
    async_add_entities: AddEntitiesCallback,
) -> None:
    """Add a IMGW-PIB binary sensor entity from a config_entry."""
    coordinator = entry.runtime_data.coordinator
 
    async_add_entities(
        ImgwPibBinarySensorEntity(coordinator, description)
        for description in BINARY_SENSOR_TYPES
        if getattr(coordinator.data, description.key) is not None
    )
 
 
class ImgwPibBinarySensorEntity(ImgwPibEntity, BinarySensorEntity):
    """Define IMGW-PIB binary sensor entity."""
 
    entity_description: ImgwPibBinarySensorEntityDescription
 
    def __init__(
        self,
        coordinator: ImgwPibDataUpdateCoordinator,
        description: ImgwPibBinarySensorEntityDescription,
    ) -> None:
        """Initialize."""
        super().__init__(coordinator)
 
        self._attr_unique_id_attr_unique_id = f"{coordinator.station_id}_{description.key}"
        self.entity_descriptionentity_description = description
 
    @property
    def is_on(self) -> bool | None:
        """Return true if the binary sensor is on."""
        return self.entity_descriptionentity_description.value(self.coordinator.data)