binary_sensor.py

Go to the documentation of this file.

"""Binary Sensor for SimpleFin."""
 
from collections.abc import Callable
from dataclasses import dataclass
 
from simplefin4py import Account
 
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 AddEntitiesCallback
 
from . import SimpleFinConfigEntry
from .entity import SimpleFinEntity
 
 
@dataclass(frozen=True, kw_only=True)
class SimpleFinBinarySensorEntityDescription(BinarySensorEntityDescription):
    """Describes a sensor entity."""
 
    value_fn: Callable[[Account], bool]
 
 
SIMPLEFIN_BINARY_SENSORS: tuple[SimpleFinBinarySensorEntityDescription, ...] = (
    SimpleFinBinarySensorEntityDescription(
        key="possible_error",
        translation_key="possible_error",
        device_class=BinarySensorDeviceClass.PROBLEM,
        entity_category=EntityCategory.DIAGNOSTIC,
        value_fn=lambda account: account.possible_error,
    ),
)
 
 
async def async_setup_entry(
    hass: HomeAssistant,
    config_entry: SimpleFinConfigEntry,
    async_add_entities: AddEntitiesCallback,
) -> None:
    """Set up SimpleFIN sensors for config entries."""
 
    sf_coordinator = config_entry.runtime_data
    accounts = sf_coordinator.data.accounts
 
    async_add_entities(
        SimpleFinBinarySensor(
            sf_coordinator,
            sensor_description,
            account,
        )
        for account in accounts
        for sensor_description in SIMPLEFIN_BINARY_SENSORS
    )
 
 
class SimpleFinBinarySensor(SimpleFinEntity, BinarySensorEntity):
    """Extends IntellifireEntity with Binary Sensor specific logic."""
 
    entity_description: SimpleFinBinarySensorEntityDescription
 
    @property
    def is_on(self) -> bool:
        """Use this to get the correct value."""
        return self.entity_descriptionentity_description.value_fn(self.account_dataaccount_data)