binary_sensor.py

Go to the documentation of this file.

"""Binary sensor platform for Habitica integration."""
 
from __future__ import annotations
 
from collections.abc import Callable
from dataclasses import dataclass
from enum import StrEnum
from typing import Any
 
from homeassistant.components.binary_sensor import (
    BinarySensorEntity,
    BinarySensorEntityDescription,
)
from homeassistant.core import HomeAssistant
from homeassistant.helpers.entity_platform import AddEntitiesCallback
 
from .const import ASSETS_URL
from .entity import HabiticaBase
from .types import HabiticaConfigEntry
 
 
@dataclass(kw_only=True, frozen=True)
class HabiticaBinarySensorEntityDescription(BinarySensorEntityDescription):
    """Habitica Binary Sensor Description."""
 
    value_fn: Callable[[dict[str, Any]], bool | None]
    entity_picture: Callable[[dict[str, Any]], str | None]
 
 
class HabiticaBinarySensor(StrEnum):
    """Habitica Entities."""
 
    PENDING_QUEST = "pending_quest"
 
 
def get_scroll_image_for_pending_quest_invitation(user: dict[str, Any]) -> str | None:
    """Entity picture for pending quest invitation."""
    if user["party"]["quest"].get("key") and user["party"]["quest"]["RSVPNeeded"]:
        return f"inventory_quest_scroll_{user["party"]["quest"]["key"]}.png"
    return None
 
 
BINARY_SENSOR_DESCRIPTIONS: tuple[HabiticaBinarySensorEntityDescription, ...] = (
    HabiticaBinarySensorEntityDescription(
        key=HabiticaBinarySensor.PENDING_QUEST,
        translation_key=HabiticaBinarySensor.PENDING_QUEST,
        value_fn=lambda user: user["party"]["quest"]["RSVPNeeded"],
        entity_picture=get_scroll_image_for_pending_quest_invitation,
    ),
)
 
 
async def async_setup_entry(
    hass: HomeAssistant,
    config_entry: HabiticaConfigEntry,
    async_add_entities: AddEntitiesCallback,
) -> None:
    """Set up the habitica binary sensors."""
 
    coordinator = config_entry.runtime_data
 
    async_add_entities(
        HabiticaBinarySensorEntity(coordinator, description)
        for description in BINARY_SENSOR_DESCRIPTIONS
    )
 
 
class HabiticaBinarySensorEntity(HabiticaBase, BinarySensorEntity):
    """Representation of a Habitica binary sensor."""
 
    entity_description: HabiticaBinarySensorEntityDescription
 
    @property
    def is_on(self) -> bool | None:
        """If the binary sensor is on."""
        return self.entity_descriptionentity_description.value_fn(self.coordinator.data.user)
 
    @property
    def entity_picture(self) -> str | None:
        """Return the entity picture to use in the frontend, if any."""
        if entity_picture := self.entity_descriptionentity_description.entity_picture(
            self.coordinator.data.user
        ):
            return f"{ASSETS_URL}{entity_picture}"
        return None