coordinator.py

Go to the documentation of this file.

"""The QNAP QSW coordinator."""
 
from __future__ import annotations
 
import asyncio
from datetime import timedelta
import logging
from typing import Any
 
from aioqsw.exceptions import QswError
from aioqsw.localapi import QnapQswApi
 
from homeassistant.core import HomeAssistant
from homeassistant.helpers.update_coordinator import DataUpdateCoordinator, UpdateFailed
 
from .const import DOMAIN, QSW_TIMEOUT_SEC
 
DATA_SCAN_INTERVAL = timedelta(seconds=60)
FW_SCAN_INTERVAL = timedelta(hours=12)
 
_LOGGER = logging.getLogger(__name__)
 
 
class QswDataCoordinator(DataUpdateCoordinator[dict[str, Any]]):
    """Class to manage fetching data from the QNAP QSW device."""
 
    def __init__(self, hass: HomeAssistant, qsw: QnapQswApi) -> None:
        """Initialize."""
        self.qswqsw = qsw
 
        super().__init__(
            hass,
            _LOGGER,
            name=DOMAIN,
            update_interval=DATA_SCAN_INTERVAL,
        )
 
    async def _async_update_data(self) -> dict[str, Any]:
        """Update data via library."""
        async with asyncio.timeout(QSW_TIMEOUT_SEC):
            try:
                await self.qswqsw.update()
            except QswError as error:
                raise UpdateFailed(error) from error
            return self.qswqsw.data()
 
 
class QswFirmwareCoordinator(DataUpdateCoordinator[dict[str, Any]]):
    """Class to manage fetching firmware data from the QNAP QSW device."""
 
    def __init__(self, hass: HomeAssistant, qsw: QnapQswApi) -> None:
        """Initialize."""
        self.qswqsw = qsw
 
        super().__init__(
            hass,
            _LOGGER,
            name=DOMAIN,
            update_interval=FW_SCAN_INTERVAL,
        )
 
    async def _async_update_data(self) -> dict[str, Any]:
        """Update firmware data via library."""
        async with asyncio.timeout(QSW_TIMEOUT_SEC):
            try:
                await self.qswqsw.check_firmware()
            except QswError as error:
                raise UpdateFailed(error) from error
            return self.qswqsw.data()