coordinator.py

Go to the documentation of this file.

"""Coordinator for The Internet Printing Protocol (IPP) integration."""
 
from __future__ import annotations
 
from datetime import timedelta
import logging
 
from pyipp import IPP, IPPError, Printer as IPPPrinter
 
from homeassistant.core import HomeAssistant
from homeassistant.helpers.aiohttp_client import async_get_clientsession
from homeassistant.helpers.update_coordinator import DataUpdateCoordinator, UpdateFailed
 
from .const import DOMAIN
 
SCAN_INTERVAL = timedelta(seconds=60)
 
_LOGGER = logging.getLogger(__name__)
 
 
class IPPDataUpdateCoordinator(DataUpdateCoordinator[IPPPrinter]):
    """Class to manage fetching IPP data from single endpoint."""
 
    def __init__(
        self,
        hass: HomeAssistant,
        *,
        host: str,
        port: int,
        base_path: str,
        tls: bool,
        verify_ssl: bool,
        device_id: str,
    ) -> None:
        """Initialize global IPP data updater."""
        self.device_iddevice_id = device_id
        self.ippipp = IPP(
            host=host,
            port=port,
            base_path=base_path,
            tls=tls,
            verify_ssl=verify_ssl,
            session=async_get_clientsession(hass, verify_ssl),
        )
 
        super().__init__(
            hass,
            _LOGGER,
            name=DOMAIN,
            update_interval=SCAN_INTERVAL,
        )
 
    async def _async_update_data(self) -> IPPPrinter:
        """Fetch data from IPP."""
        try:
            return await self.ippipp.printer()
        except IPPError as error:
            raise UpdateFailed(f"Invalid response from API: {error}") from error