Migrate attributes to sensors in Litter-Robot (#78580)

homeassistant/components/litterrobot/binary_sensor.py

@@ -0,0 +1,95 @@
+"""Support for Litter-Robot binary sensors."""
+from __future__ import annotations
+
+from collections.abc import Callable
+from dataclasses import dataclass
+from typing import Generic
+
+from pylitterbot import LitterRobot, Robot
+
+from homeassistant.components.binary_sensor import (
+    BinarySensorDeviceClass,
+    BinarySensorEntity,
+    BinarySensorEntityDescription,
+)
+from homeassistant.config_entries import ConfigEntry
+from homeassistant.core import HomeAssistant
+from homeassistant.helpers.entity import EntityCategory
+from homeassistant.helpers.entity_platform import AddEntitiesCallback
+
+from .const import DOMAIN
+from .entity import LitterRobotEntity, _RobotT
+from .hub import LitterRobotHub
+
+
+@dataclass
+class RequiredKeysMixin(Generic[_RobotT]):
+    """A class that describes robot binary sensor entity required keys."""
+
+    is_on_fn: Callable[[_RobotT], bool]
+
+
+@dataclass
+class RobotBinarySensorEntityDescription(
+    BinarySensorEntityDescription, RequiredKeysMixin[_RobotT]
+):
+    """A class that describes robot binary sensor entities."""
+
+
+class LitterRobotBinarySensorEntity(LitterRobotEntity[_RobotT], BinarySensorEntity):
+    """Litter-Robot binary sensor entity."""
+
+    entity_description: RobotBinarySensorEntityDescription[_RobotT]
+
+    @property
+    def is_on(self) -> bool:
+        """Return the state."""
+        return self.entity_description.is_on_fn(self.robot)
+
+
+BINARY_SENSOR_MAP: dict[type[Robot], tuple[RobotBinarySensorEntityDescription, ...]] = {
+    LitterRobot: (
+        RobotBinarySensorEntityDescription[LitterRobot](
+            key="sleeping",
+            name="Sleeping",
+            icon="mdi:sleep",
+            entity_category=EntityCategory.DIAGNOSTIC,
+            entity_registry_enabled_default=False,
+            is_on_fn=lambda robot: robot.is_sleeping,
+        ),
+        RobotBinarySensorEntityDescription[LitterRobot](
+            key="sleep_mode",
+            name="Sleep mode",
+            icon="mdi:sleep",
+            entity_category=EntityCategory.DIAGNOSTIC,
+            entity_registry_enabled_default=False,
+            is_on_fn=lambda robot: robot.sleep_mode_enabled,
+        ),
+    ),
+    Robot: (
+        RobotBinarySensorEntityDescription[Robot](
+            key="power_status",
+            name="Power status",
+            device_class=BinarySensorDeviceClass.PLUG,
+            entity_category=EntityCategory.DIAGNOSTIC,
+            entity_registry_enabled_default=False,
+            is_on_fn=lambda robot: robot.power_status == "AC",
+        ),
+    ),
+}
+
+
+async def async_setup_entry(
+    hass: HomeAssistant,
+    entry: ConfigEntry,
+    async_add_entities: AddEntitiesCallback,
+) -> None:
+    """Set up Litter-Robot binary sensors using config entry."""
+    hub: LitterRobotHub = hass.data[DOMAIN][entry.entry_id]
+    async_add_entities(
+        LitterRobotBinarySensorEntity(robot=robot, hub=hub, description=description)
+        for robot in hub.account.robots
+        for robot_type, entity_descriptions in BINARY_SENSOR_MAP.items()
+        if isinstance(robot, robot_type)
+        for description in entity_descriptions
+    )