mirror of
https://github.com/home-assistant/core.git
synced 2026-08-24 10:13:52 -05:00
101 lines
3.0 KiB
Python
101 lines
3.0 KiB
Python
"""Support for Balboa Spa pumps."""
|
|
|
|
import math
|
|
from typing import Any, cast, override
|
|
|
|
from pybalboa import SpaControl
|
|
from pybalboa.enums import OffOnState, UnknownState
|
|
|
|
from homeassistant.components.fan import FanEntity, FanEntityFeature
|
|
from homeassistant.core import HomeAssistant
|
|
from homeassistant.helpers.entity_platform import AddConfigEntryEntitiesCallback
|
|
from homeassistant.util.percentage import (
|
|
percentage_to_ranged_value,
|
|
ranged_value_to_percentage,
|
|
)
|
|
|
|
from . import BalboaConfigEntry
|
|
from .entity import BalboaEntity
|
|
|
|
|
|
async def async_setup_entry(
|
|
hass: HomeAssistant,
|
|
entry: BalboaConfigEntry,
|
|
async_add_entities: AddConfigEntryEntitiesCallback,
|
|
) -> None:
|
|
"""Set up the spa's pumps."""
|
|
spa = entry.runtime_data
|
|
async_add_entities(BalboaPumpFanEntity(control) for control in spa.pumps)
|
|
|
|
|
|
class BalboaPumpFanEntity(BalboaEntity, FanEntity):
|
|
"""Representation of a Balboa Spa pump fan entity."""
|
|
|
|
_attr_supported_features = (
|
|
FanEntityFeature.SET_SPEED
|
|
| FanEntityFeature.TURN_OFF
|
|
| FanEntityFeature.TURN_ON
|
|
)
|
|
|
|
_attr_translation_key = "pump"
|
|
|
|
def __init__(self, control: SpaControl) -> None:
|
|
"""Initialize a Balboa pump fan entity."""
|
|
super().__init__(control.client, control.name)
|
|
self._control = control
|
|
self._attr_translation_placeholders = {
|
|
"index": f"{cast(int, control.index) + 1}"
|
|
}
|
|
|
|
@override
|
|
async def async_turn_off(self, **kwargs: Any) -> None:
|
|
"""Turn the pump off."""
|
|
await self._control.set_state(OffOnState.OFF)
|
|
|
|
@override
|
|
async def async_turn_on(
|
|
self,
|
|
percentage: int | None = None,
|
|
preset_mode: str | None = None,
|
|
**kwargs: Any,
|
|
) -> None:
|
|
"""Turn the pump on (by default on max speed)."""
|
|
if percentage is None:
|
|
percentage = 100
|
|
await self.async_set_percentage(percentage)
|
|
|
|
@override
|
|
async def async_set_percentage(self, percentage: int) -> None:
|
|
"""Set the speed of the pump."""
|
|
if percentage > 0:
|
|
state = math.ceil(
|
|
percentage_to_ranged_value((1, self.speed_count), percentage)
|
|
)
|
|
else:
|
|
state = OffOnState.OFF
|
|
await self._control.set_state(state)
|
|
|
|
@property
|
|
@override
|
|
def percentage(self) -> int | None:
|
|
"""Return the speed of the pump."""
|
|
if self._control.state == UnknownState.UNKNOWN:
|
|
return None
|
|
if self._control.state == OffOnState.OFF:
|
|
return 0
|
|
return ranged_value_to_percentage((1, self.speed_count), self._control.state)
|
|
|
|
@property
|
|
@override
|
|
def is_on(self) -> bool | None:
|
|
"""Return true if the pump is running."""
|
|
if self._control.state == UnknownState.UNKNOWN:
|
|
return None
|
|
return self._control.state != OffOnState.OFF
|
|
|
|
@property
|
|
@override
|
|
def speed_count(self) -> int:
|
|
"""Return the number of different speed settings the pump supports."""
|
|
return int(max(self._control.options))
|