switch.py

Go to the documentation of this file.

"""Platform for switch integration."""
 
import asyncio
from typing import Any
 
from smarttub import SpaPump
 
from homeassistant.components.switch import SwitchEntity
from homeassistant.config_entries import ConfigEntry
from homeassistant.core import HomeAssistant
from homeassistant.helpers.entity_platform import AddEntitiesCallback
 
from .const import API_TIMEOUT, ATTR_PUMPS, DOMAIN, SMARTTUB_CONTROLLER
from .entity import SmartTubEntity
from .helpers import get_spa_name
 
 
async def async_setup_entry(
    hass: HomeAssistant, entry: ConfigEntry, async_add_entities: AddEntitiesCallback
) -> None:
    """Set up switch entities for the pumps on the tub."""
 
    controller = hass.data[DOMAIN][entry.entry_id][SMARTTUB_CONTROLLER]
 
    entities = [
        SmartTubPump(controller.coordinator, pump)
        for spa in controller.spas
        for pump in controller.coordinator.data[spa.id][ATTR_PUMPS].values()
    ]
 
    async_add_entities(entities)
 
 
class SmartTubPump(SmartTubEntity, SwitchEntity):
    """A pump on a spa."""
 
    def __init__(self, coordinator, pump: SpaPump) -> None:
        """Initialize the entity."""
        super().__init__(coordinator, pump.spa, "pump")
        self.pump_idpump_id = pump.id
        self.pump_typepump_type = pump.type
        self._attr_unique_id_attr_unique_id_attr_unique_id = f"{super().unique_id}-{pump.id}"
 
    @property
    def pump(self) -> SpaPump:
        """Return the underlying SpaPump object for this entity."""
        return self.coordinator.data[self.spaspa.id][ATTR_PUMPS][self.pump_idpump_id]
 
    @property
    def name(self) -> str:
        """Return a name for this pump entity."""
        spa_name = get_spa_name(self.spaspa)
        if self.pump_typepump_type == SpaPump.PumpType.CIRCULATION:
            return f"{spa_name} Circulation Pump"
        if self.pump_typepump_type == SpaPump.PumpType.JET:
            return f"{spa_name} Jet {self.pump_id}"
        return f"{spa_name} pump {self.pump_id}"
 
    @property
    def is_on(self) -> bool:
        """Return True if the pump is on."""
        return self.pumppump.state != SpaPump.PumpState.OFF
 
    async def async_turn_on(self, **kwargs: Any) -> None:
        """Turn the pump on."""
 
        # the API only supports toggling
        if not self.is_onis_onis_on:
            await self.async_toggleasync_toggleasync_toggle()
 
    async def async_turn_off(self, **kwargs: Any) -> None:
        """Turn the pump off."""
 
        # the API only supports toggling
        if self.is_onis_onis_on:
            await self.async_toggleasync_toggleasync_toggle()
 
    async def async_toggle(self, **kwargs: Any) -> None:
        """Toggle the pump on or off."""
        async with asyncio.timeout(API_TIMEOUT):
            await self.pumppump.toggle()
        await self.coordinator.async_request_refresh()