core/homeassistant/components/balboa/binary_sensor.py

83 lines
2.5 KiB
Python

"""Support for Balboa Spa binary sensors."""
from __future__ import annotations
from collections.abc import Callable
from dataclasses import dataclass
from pybalboa import SpaClient
from homeassistant.components.binary_sensor import (
BinarySensorDeviceClass,
BinarySensorEntity,
BinarySensorEntityDescription,
)
from homeassistant.core import HomeAssistant
from homeassistant.helpers.entity_platform import AddEntitiesCallback
from . import BalboaConfigEntry
from .entity import BalboaEntity
async def async_setup_entry(
hass: HomeAssistant,
entry: BalboaConfigEntry,
async_add_entities: AddEntitiesCallback,
) -> None:
"""Set up the spa's binary sensors."""
spa = entry.runtime_data
entities = [
BalboaBinarySensorEntity(spa, description)
for description in BINARY_SENSOR_DESCRIPTIONS
]
if spa.circulation_pump is not None:
entities.append(BalboaBinarySensorEntity(spa, CIRCULATION_PUMP_DESCRIPTION))
async_add_entities(entities)
@dataclass(frozen=True, kw_only=True)
class BalboaBinarySensorEntityDescription(BinarySensorEntityDescription):
"""A class that describes Balboa binary sensor entities."""
is_on_fn: Callable[[SpaClient], bool]
BINARY_SENSOR_DESCRIPTIONS = (
BalboaBinarySensorEntityDescription(
key="Filter1",
translation_key="filter_1",
device_class=BinarySensorDeviceClass.RUNNING,
is_on_fn=lambda spa: spa.filter_cycle_1_running,
),
BalboaBinarySensorEntityDescription(
key="Filter2",
translation_key="filter_2",
device_class=BinarySensorDeviceClass.RUNNING,
is_on_fn=lambda spa: spa.filter_cycle_2_running,
),
)
CIRCULATION_PUMP_DESCRIPTION = BalboaBinarySensorEntityDescription(
key="Circ Pump",
translation_key="circ_pump",
device_class=BinarySensorDeviceClass.RUNNING,
is_on_fn=lambda spa: (pump := spa.circulation_pump) is not None and pump.state > 0,
)
class BalboaBinarySensorEntity(BalboaEntity, BinarySensorEntity):
"""Representation of a Balboa Spa binary sensor entity."""
entity_description: BalboaBinarySensorEntityDescription
def __init__(
self, spa: SpaClient, description: BalboaBinarySensorEntityDescription
) -> None:
"""Initialize a Balboa binary sensor entity."""
super().__init__(spa, description.key)
self.entity_description = description
@property
def is_on(self) -> bool:
"""Return true if the binary sensor is on."""
return self.entity_description.is_on_fn(self._client)