Add binary sensor platform to Tailwind integration (#106033)

homeassistant/components/tailwind/binary_sensor.py

@@ -0,0 +1,78 @@
+"""Binary sensor entity platform for Tailwind."""
+from __future__ import annotations
+
+from collections.abc import Callable
+from dataclasses import dataclass
+
+from gotailwind.models import TailwindDoor
+
+from homeassistant.components.binary_sensor import (
+    BinarySensorEntity,
+    BinarySensorEntityDescription,
+)
+from homeassistant.config_entries import ConfigEntry
+from homeassistant.const import EntityCategory
+from homeassistant.core import HomeAssistant
+from homeassistant.helpers.entity_platform import AddEntitiesCallback
+
+from .const import DOMAIN
+from .coordinator import TailwindDataUpdateCoordinator
+from .entity import TailwindDoorEntity
+
+
+@dataclass(kw_only=True, frozen=True)
+class TailwindDoorBinarySensorEntityDescription(BinarySensorEntityDescription):
+    """Class describing Tailwind door binary sensor entities."""
+
+    is_on_fn: Callable[[TailwindDoor], bool]
+
+
+DESCRIPTIONS: tuple[TailwindDoorBinarySensorEntityDescription, ...] = (
+    TailwindDoorBinarySensorEntityDescription(
+        key="locked_out",
+        translation_key="operational_status",
+        entity_category=EntityCategory.DIAGNOSTIC,
+        icon="mdi:garage-alert",
+        is_on_fn=lambda door: not door.locked_out,
+    ),
+)
+
+
+async def async_setup_entry(
+    hass: HomeAssistant,
+    entry: ConfigEntry,
+    async_add_entities: AddEntitiesCallback,
+) -> None:
+    """Set up Tailwind binary sensor based on a config entry."""
+    coordinator: TailwindDataUpdateCoordinator = hass.data[DOMAIN][entry.entry_id]
+    async_add_entities(
+        TailwindDoorBinarySensorEntity(coordinator, description, door_id)
+        for description in DESCRIPTIONS
+        for door_id in coordinator.data.doors
+    )
+
+
+class TailwindDoorBinarySensorEntity(TailwindDoorEntity, BinarySensorEntity):
+    """Representation of a Tailwind door binary sensor entity."""
+
+    entity_description: TailwindDoorBinarySensorEntityDescription
+
+    def __init__(
+        self,
+        coordinator: TailwindDataUpdateCoordinator,
+        description: TailwindDoorBinarySensorEntityDescription,
+        door_id: str,
+    ) -> None:
+        """Initiate Tailwind button entity."""
+        super().__init__(coordinator, door_id)
+        self.entity_description = description
+        self._attr_unique_id = (
+            f"{coordinator.data.device_id}-{door_id}-{description.key}"
+        )
+
+    @property
+    def is_on(self) -> bool | None:
+        """Return the state of the binary sensor."""
+        return self.entity_description.is_on_fn(
+            self.coordinator.data.doors[self.door_id]
+        )