103 lines
3.3 KiB
Python
103 lines
3.3 KiB
Python
"""Support for APCUPSd via its Network Information Server (NIS)."""
|
|
from __future__ import annotations
|
|
|
|
import asyncio
|
|
from collections import OrderedDict
|
|
from datetime import timedelta
|
|
import logging
|
|
from typing import Final
|
|
|
|
from apcaccess import status
|
|
|
|
from homeassistant.config_entries import ConfigEntry
|
|
from homeassistant.core import HomeAssistant
|
|
from homeassistant.helpers.debounce import Debouncer
|
|
from homeassistant.helpers.device_registry import DeviceInfo
|
|
from homeassistant.helpers.update_coordinator import (
|
|
REQUEST_REFRESH_DEFAULT_IMMEDIATE,
|
|
DataUpdateCoordinator,
|
|
UpdateFailed,
|
|
)
|
|
|
|
from .const import DOMAIN
|
|
|
|
_LOGGER = logging.getLogger(__name__)
|
|
UPDATE_INTERVAL: Final = timedelta(seconds=60)
|
|
REQUEST_REFRESH_COOLDOWN: Final = 5
|
|
|
|
|
|
class APCUPSdCoordinator(DataUpdateCoordinator[OrderedDict[str, str]]):
|
|
"""Store and coordinate the data retrieved from APCUPSd for all sensors.
|
|
|
|
For each entity to use, acts as the single point responsible for fetching
|
|
updates from the server.
|
|
"""
|
|
|
|
config_entry: ConfigEntry
|
|
|
|
def __init__(self, hass: HomeAssistant, host: str, port: int) -> None:
|
|
"""Initialize the data object."""
|
|
super().__init__(
|
|
hass,
|
|
_LOGGER,
|
|
name=DOMAIN,
|
|
update_interval=UPDATE_INTERVAL,
|
|
request_refresh_debouncer=Debouncer(
|
|
hass,
|
|
_LOGGER,
|
|
cooldown=REQUEST_REFRESH_COOLDOWN,
|
|
immediate=REQUEST_REFRESH_DEFAULT_IMMEDIATE,
|
|
),
|
|
)
|
|
self._host = host
|
|
self._port = port
|
|
|
|
@property
|
|
def ups_name(self) -> str | None:
|
|
"""Return the name of the UPS, if available."""
|
|
return self.data.get("UPSNAME")
|
|
|
|
@property
|
|
def ups_model(self) -> str | None:
|
|
"""Return the model of the UPS, if available."""
|
|
# Different UPS models may report slightly different keys for model, here we
|
|
# try them all.
|
|
for model_key in ("APCMODEL", "MODEL"):
|
|
if model_key in self.data:
|
|
return self.data[model_key]
|
|
return None
|
|
|
|
@property
|
|
def ups_serial_no(self) -> str | None:
|
|
"""Return the unique serial number of the UPS, if available."""
|
|
return self.data.get("SERIALNO")
|
|
|
|
@property
|
|
def device_info(self) -> DeviceInfo:
|
|
"""Return the DeviceInfo of this APC UPS, if serial number is available."""
|
|
return DeviceInfo(
|
|
identifiers={(DOMAIN, self.ups_serial_no or self.config_entry.entry_id)},
|
|
model=self.ups_model,
|
|
manufacturer="APC",
|
|
name=self.ups_name if self.ups_name else "APC UPS",
|
|
hw_version=self.data.get("FIRMWARE"),
|
|
sw_version=self.data.get("VERSION"),
|
|
)
|
|
|
|
async def _async_update_data(self) -> OrderedDict[str, str]:
|
|
"""Fetch the latest status from APCUPSd.
|
|
|
|
Note that the result dict uses upper case for each resource, where our
|
|
integration uses lower cases as keys internally.
|
|
"""
|
|
|
|
async with asyncio.timeout(10):
|
|
try:
|
|
raw = await self.hass.async_add_executor_job(
|
|
status.get, self._host, self._port
|
|
)
|
|
result: OrderedDict[str, str] = status.parse(raw)
|
|
return result
|
|
except OSError as error:
|
|
raise UpdateFailed(error) from error
|