coordinator.py

Go to the documentation of this file.

"""DataUpdateCoordinator for flipr integration."""
 
from datetime import timedelta
import logging
from typing import Any
 
from flipr_api import FliprAPIRestClient
from flipr_api.exceptions import FliprError
 
from homeassistant.config_entries import ConfigEntry
from homeassistant.core import HomeAssistant
from homeassistant.helpers.update_coordinator import DataUpdateCoordinator, UpdateFailed
 
_LOGGER = logging.getLogger(__name__)
 
 
class BaseDataUpdateCoordinator[_DataT](DataUpdateCoordinator[_DataT]):
    """Parent class to hold Flipr and Hub data retrieval."""
 
    config_entry: ConfigEntry
 
    def __init__(
        self, hass: HomeAssistant, client: FliprAPIRestClient, flipr_or_hub_id: str
    ) -> None:
        """Initialize."""
        self.device_iddevice_id = flipr_or_hub_id
        self.clientclient = client
 
        super().__init__(
            hass,
            _LOGGER,
            name=f"Flipr or Hub data measure for {self.device_id}",
            update_interval=timedelta(minutes=15),
        )
 
 
class FliprDataUpdateCoordinator(BaseDataUpdateCoordinator[dict[str, Any]]):
    """Class to hold Flipr data retrieval."""
 
    async def _async_update_data(self) -> dict[str, Any]:
        """Fetch data from API endpoint."""
        try:
            data = await self.hasshass.async_add_executor_job(
                self.clientclient.get_pool_measure_latest, self.device_iddevice_id
            )
        except FliprError as error:
            raise UpdateFailed(error) from error
 
        return data
 
 
class FliprHubDataUpdateCoordinator(BaseDataUpdateCoordinator[dict[str, Any]]):
    """Class to hold Flipr hub data retrieval."""
 
    async def _async_update_data(self) -> dict[str, Any]:
        """Fetch data from API endpoint."""
        try:
            data = await self.hasshass.async_add_executor_job(
                self.clientclient.get_hub_state, self.device_iddevice_id
            )
        except FliprError as error:
            raise UpdateFailed(error) from error
 
        return data