177 lines
6.6 KiB
Python
177 lines
6.6 KiB
Python
"""Data update coordinator for AVM FRITZ!SmartHome devices."""
|
|
|
|
from __future__ import annotations
|
|
|
|
from dataclasses import dataclass
|
|
from datetime import timedelta
|
|
|
|
from pyfritzhome import Fritzhome, FritzhomeDevice, LoginError
|
|
from pyfritzhome.devicetypes import FritzhomeTemplate
|
|
from requests.exceptions import ConnectionError as RequestConnectionError, HTTPError
|
|
|
|
from homeassistant.config_entries import ConfigEntry
|
|
from homeassistant.const import CONF_HOST, CONF_PASSWORD, CONF_USERNAME
|
|
from homeassistant.core import HomeAssistant
|
|
from homeassistant.exceptions import ConfigEntryAuthFailed, ConfigEntryNotReady
|
|
from homeassistant.helpers import device_registry as dr, entity_registry as er
|
|
from homeassistant.helpers.update_coordinator import DataUpdateCoordinator, UpdateFailed
|
|
|
|
from .const import DOMAIN, LOGGER
|
|
|
|
type FritzboxConfigEntry = ConfigEntry[FritzboxDataUpdateCoordinator]
|
|
|
|
|
|
@dataclass
|
|
class FritzboxCoordinatorData:
|
|
"""Data Type of FritzboxDataUpdateCoordinator's data."""
|
|
|
|
devices: dict[str, FritzhomeDevice]
|
|
templates: dict[str, FritzhomeTemplate]
|
|
supported_color_properties: dict[str, tuple[dict, list]]
|
|
|
|
|
|
class FritzboxDataUpdateCoordinator(DataUpdateCoordinator[FritzboxCoordinatorData]):
|
|
"""Fritzbox Smarthome device data update coordinator."""
|
|
|
|
config_entry: FritzboxConfigEntry
|
|
configuration_url: str
|
|
fritz: Fritzhome
|
|
has_templates: bool
|
|
|
|
def __init__(self, hass: HomeAssistant, config_entry: FritzboxConfigEntry) -> None:
|
|
"""Initialize the Fritzbox Smarthome device coordinator."""
|
|
super().__init__(
|
|
hass,
|
|
LOGGER,
|
|
config_entry=config_entry,
|
|
name=config_entry.entry_id,
|
|
update_interval=timedelta(seconds=30),
|
|
)
|
|
|
|
self.new_devices: set[str] = set()
|
|
self.new_templates: set[str] = set()
|
|
|
|
self.data = FritzboxCoordinatorData({}, {}, {})
|
|
|
|
async def async_setup(self) -> None:
|
|
"""Set up the coordinator."""
|
|
|
|
self.fritz = Fritzhome(
|
|
host=self.config_entry.data[CONF_HOST],
|
|
user=self.config_entry.data[CONF_USERNAME],
|
|
password=self.config_entry.data[CONF_PASSWORD],
|
|
)
|
|
|
|
try:
|
|
await self.hass.async_add_executor_job(self.fritz.login)
|
|
except RequestConnectionError as err:
|
|
raise ConfigEntryNotReady from err
|
|
except LoginError as err:
|
|
raise ConfigEntryAuthFailed from err
|
|
|
|
self.has_templates = await self.hass.async_add_executor_job(
|
|
self.fritz.has_templates
|
|
)
|
|
LOGGER.debug("enable smarthome templates: %s", self.has_templates)
|
|
|
|
self.configuration_url = self.fritz.get_prefixed_host()
|
|
|
|
await self.async_config_entry_first_refresh()
|
|
self.cleanup_removed_devices(
|
|
list(self.data.devices) + list(self.data.templates)
|
|
)
|
|
|
|
def cleanup_removed_devices(self, available_ains: list[str]) -> None:
|
|
"""Cleanup entity and device registry from removed devices."""
|
|
entity_reg = er.async_get(self.hass)
|
|
for entity in er.async_entries_for_config_entry(
|
|
entity_reg, self.config_entry.entry_id
|
|
):
|
|
if entity.unique_id.split("_")[0] not in available_ains:
|
|
LOGGER.debug("Removing obsolete entity entry %s", entity.entity_id)
|
|
entity_reg.async_remove(entity.entity_id)
|
|
|
|
device_reg = dr.async_get(self.hass)
|
|
identifiers = {(DOMAIN, ain) for ain in available_ains}
|
|
for device in dr.async_entries_for_config_entry(
|
|
device_reg, self.config_entry.entry_id
|
|
):
|
|
if not set(device.identifiers) & identifiers:
|
|
LOGGER.debug("Removing obsolete device entry %s", device.name)
|
|
device_reg.async_update_device(
|
|
device.id, remove_config_entry_id=self.config_entry.entry_id
|
|
)
|
|
|
|
def _update_fritz_devices(self) -> FritzboxCoordinatorData:
|
|
"""Update all fritzbox device data."""
|
|
try:
|
|
self.fritz.update_devices(ignore_removed=False)
|
|
if self.has_templates:
|
|
self.fritz.update_templates(ignore_removed=False)
|
|
except RequestConnectionError as ex:
|
|
raise UpdateFailed from ex
|
|
except HTTPError:
|
|
# If the device rebooted, login again
|
|
try:
|
|
self.fritz.login()
|
|
except LoginError as ex:
|
|
raise ConfigEntryAuthFailed from ex
|
|
self.fritz.update_devices(ignore_removed=False)
|
|
if self.has_templates:
|
|
self.fritz.update_templates(ignore_removed=False)
|
|
|
|
devices = self.fritz.get_devices()
|
|
device_data = {}
|
|
supported_color_properties = self.data.supported_color_properties
|
|
for device in devices:
|
|
# assume device as unavailable, see #55799
|
|
if (
|
|
device.has_powermeter
|
|
and device.present
|
|
and isinstance(device.voltage, int)
|
|
and device.voltage <= 0
|
|
and isinstance(device.power, int)
|
|
and device.power <= 0
|
|
and device.energy <= 0
|
|
):
|
|
LOGGER.debug("Assume device %s as unavailable", device.name)
|
|
device.present = False
|
|
|
|
device_data[device.ain] = device
|
|
|
|
# pre-load supported colors and color temps for new devices
|
|
if device.has_color and device.ain not in supported_color_properties:
|
|
supported_color_properties[device.ain] = (
|
|
device.get_colors(),
|
|
device.get_color_temps(),
|
|
)
|
|
|
|
template_data = {}
|
|
if self.has_templates:
|
|
templates = self.fritz.get_templates()
|
|
for template in templates:
|
|
template_data[template.ain] = template
|
|
|
|
self.new_devices = device_data.keys() - self.data.devices.keys()
|
|
self.new_templates = template_data.keys() - self.data.templates.keys()
|
|
|
|
return FritzboxCoordinatorData(
|
|
devices=device_data,
|
|
templates=template_data,
|
|
supported_color_properties=supported_color_properties,
|
|
)
|
|
|
|
async def _async_update_data(self) -> FritzboxCoordinatorData:
|
|
"""Fetch all device data."""
|
|
new_data = await self.hass.async_add_executor_job(self._update_fritz_devices)
|
|
|
|
if (
|
|
self.data.devices.keys() - new_data.devices.keys()
|
|
or self.data.templates.keys() - new_data.templates.keys()
|
|
):
|
|
self.cleanup_removed_devices(
|
|
list(new_data.devices) + list(new_data.templates)
|
|
)
|
|
|
|
return new_data
|