hub.py

Go to the documentation of this file.

"""A wrapper 'hub' for the Litter-Robot API."""
 
from __future__ import annotations
 
from collections.abc import Generator, Mapping
from datetime import timedelta
import logging
from typing import Any
 
from pylitterbot import Account, FeederRobot, LitterRobot
from pylitterbot.exceptions import LitterRobotException, LitterRobotLoginException
 
from homeassistant.const import CONF_PASSWORD, CONF_USERNAME
from homeassistant.core import HomeAssistant
from homeassistant.exceptions import ConfigEntryAuthFailed, ConfigEntryNotReady
from homeassistant.helpers.aiohttp_client import async_get_clientsession
from homeassistant.helpers.update_coordinator import DataUpdateCoordinator
 
from .const import DOMAIN
 
_LOGGER = logging.getLogger(__name__)
 
UPDATE_INTERVAL_SECONDS = 60 * 5
 
 
class LitterRobotHub:
    """A Litter-Robot hub wrapper class."""
 
    def __init__(self, hass: HomeAssistant, data: Mapping[str, Any]) -> None:
        """Initialize the Litter-Robot hub."""
        self._data_data = data
        self.accountaccount = Account(websession=async_get_clientsession(hass))
 
        async def _async_update_data() -> bool:
            """Update all device states from the Litter-Robot API."""
            await self.accountaccount.refresh_robots()
            return True
 
        self.coordinatorcoordinator = DataUpdateCoordinator(
            hass,
            _LOGGER,
            name=DOMAIN,
            update_method=_async_update_data,
            update_interval=timedelta(seconds=UPDATE_INTERVAL_SECONDS),
        )
 
    async def login(
        self, load_robots: bool = False, subscribe_for_updates: bool = False
    ) -> None:
        """Login to Litter-Robot."""
        try:
            await self.accountaccount.connect(
                username=self._data_data[CONF_USERNAME],
                password=self._data_data[CONF_PASSWORD],
                load_robots=load_robots,
                subscribe_for_updates=subscribe_for_updates,
            )
        except LitterRobotLoginException as ex:
            raise ConfigEntryAuthFailed("Invalid credentials") from ex
        except LitterRobotException as ex:
            raise ConfigEntryNotReady("Unable to connect to Litter-Robot API") from ex
 
    def litter_robots(self) -> Generator[LitterRobot]:
        """Get Litter-Robots from the account."""
        return (
            robot for robot in self.accountaccount.robots if isinstance(robot, LitterRobot)
        )
 
    def feeder_robots(self) -> Generator[FeederRobot]:
        """Get Feeder-Robots from the account."""
        return (
            robot for robot in self.accountaccount.robots if isinstance(robot, FeederRobot)
        )