binary_sensor.py

"""Support for binary_sensor entities."""

from __future__ import annotations

from dataclasses import dataclass, field

from gardena_bluetooth.const import AquaContour, Sensor, Valve
from gardena_bluetooth.parse import CharacteristicBool

from homeassistant.components.binary_sensor import (
    BinarySensorDeviceClass,
    BinarySensorEntity,
    BinarySensorEntityDescription,
)
from homeassistant.const import EntityCategory
from homeassistant.core import HomeAssistant
from homeassistant.helpers.entity_platform import AddConfigEntryEntitiesCallback

from .coordinator import GardenaBluetoothConfigEntry
from .entity import GardenaBluetoothDescriptorEntity


@dataclass(frozen=True)
class GardenaBluetoothBinarySensorEntityDescription(BinarySensorEntityDescription):
    """Description of entity."""

    char: CharacteristicBool = field(default_factory=lambda: CharacteristicBool(""))

    @property
    def context(self) -> set[str]:
        """Context needed for update coordinator."""
        return {self.char.uuid}


DESCRIPTIONS = (
    GardenaBluetoothBinarySensorEntityDescription(
        key=Valve.connected_state.unique_id,
        translation_key="valve_connected_state",
        device_class=BinarySensorDeviceClass.CONNECTIVITY,
        entity_category=EntityCategory.DIAGNOSTIC,
        char=Valve.connected_state,
    ),
    GardenaBluetoothBinarySensorEntityDescription(
        key=Sensor.connected_state.unique_id,
        translation_key="sensor_connected_state",
        device_class=BinarySensorDeviceClass.CONNECTIVITY,
        entity_category=EntityCategory.DIAGNOSTIC,
        char=Sensor.connected_state,
    ),
    GardenaBluetoothBinarySensorEntityDescription(
        key=AquaContour.frost_warning.unique_id,
        translation_key="frost_warning",
        device_class=BinarySensorDeviceClass.PROBLEM,
        entity_category=EntityCategory.DIAGNOSTIC,
        char=AquaContour.frost_warning,
    ),
)


async def async_setup_entry(
    hass: HomeAssistant,
    entry: GardenaBluetoothConfigEntry,
    async_add_entities: AddConfigEntryEntitiesCallback,
) -> None:
    """Set up binary sensor based on a config entry."""
    coordinator = entry.runtime_data
    entities = [
        GardenaBluetoothBinarySensor(coordinator, description, description.context)
        for description in DESCRIPTIONS
        if description.char.unique_id in coordinator.characteristics
    ]
    async_add_entities(entities)


class GardenaBluetoothBinarySensor(
    GardenaBluetoothDescriptorEntity, BinarySensorEntity
):
    """Representation of a binary sensor."""

    entity_description: GardenaBluetoothBinarySensorEntityDescription

    def _handle_coordinator_update(self) -> None:
        char = self.entity_description.char
        self._attr_is_on = self.coordinator.get_cached(char)
        super()._handle_coordinator_update()