mirror of https://github.com/home-assistant/core
133 lines
5.1 KiB
Python
133 lines
5.1 KiB
Python
"""DataUpdateCoordinator for Plugwise."""
|
|
|
|
from datetime import timedelta
|
|
|
|
from packaging.version import Version
|
|
from plugwise import PlugwiseData, Smile
|
|
from plugwise.exceptions import (
|
|
ConnectionFailedError,
|
|
InvalidAuthentication,
|
|
InvalidXMLError,
|
|
PlugwiseError,
|
|
ResponseError,
|
|
UnsupportedDeviceError,
|
|
)
|
|
|
|
from homeassistant.config_entries import ConfigEntry
|
|
from homeassistant.const import CONF_HOST, CONF_PASSWORD, CONF_PORT, CONF_USERNAME
|
|
from homeassistant.core import HomeAssistant
|
|
from homeassistant.exceptions import ConfigEntryError
|
|
from homeassistant.helpers import device_registry as dr
|
|
from homeassistant.helpers.aiohttp_client import async_get_clientsession
|
|
from homeassistant.helpers.debounce import Debouncer
|
|
from homeassistant.helpers.update_coordinator import DataUpdateCoordinator, UpdateFailed
|
|
|
|
from .const import DEFAULT_PORT, DEFAULT_USERNAME, DOMAIN, GATEWAY_ID, LOGGER
|
|
|
|
|
|
class PlugwiseDataUpdateCoordinator(DataUpdateCoordinator[PlugwiseData]):
|
|
"""Class to manage fetching Plugwise data from single endpoint."""
|
|
|
|
_connected: bool = False
|
|
|
|
config_entry: ConfigEntry
|
|
|
|
def __init__(self, hass: HomeAssistant) -> None:
|
|
"""Initialize the coordinator."""
|
|
super().__init__(
|
|
hass,
|
|
LOGGER,
|
|
name=DOMAIN,
|
|
update_interval=timedelta(seconds=60),
|
|
# Don't refresh immediately, give the device time to process
|
|
# the change in state before we query it.
|
|
request_refresh_debouncer=Debouncer(
|
|
hass,
|
|
LOGGER,
|
|
cooldown=1.5,
|
|
immediate=False,
|
|
),
|
|
)
|
|
|
|
self.api = Smile(
|
|
host=self.config_entry.data[CONF_HOST],
|
|
username=self.config_entry.data.get(CONF_USERNAME, DEFAULT_USERNAME),
|
|
password=self.config_entry.data[CONF_PASSWORD],
|
|
port=self.config_entry.data.get(CONF_PORT, DEFAULT_PORT),
|
|
websession=async_get_clientsession(hass, verify_ssl=False),
|
|
)
|
|
self._current_devices: set[str] = set()
|
|
self.new_devices: set[str] = set()
|
|
|
|
async def _connect(self) -> None:
|
|
"""Connect to the Plugwise Smile."""
|
|
version = await self.api.connect()
|
|
self._connected = isinstance(version, Version)
|
|
if self._connected:
|
|
self.api.get_all_devices()
|
|
|
|
async def _async_update_data(self) -> PlugwiseData:
|
|
"""Fetch data from Plugwise."""
|
|
data = PlugwiseData({}, {})
|
|
try:
|
|
if not self._connected:
|
|
await self._connect()
|
|
data = await self.api.async_update()
|
|
except ConnectionFailedError as err:
|
|
raise UpdateFailed("Failed to connect") from err
|
|
except InvalidAuthentication as err:
|
|
raise ConfigEntryError("Authentication failed") from err
|
|
except (InvalidXMLError, ResponseError) as err:
|
|
raise UpdateFailed(
|
|
"Invalid XML data, or error indication received from the Plugwise Adam/Smile/Stretch"
|
|
) from err
|
|
except PlugwiseError as err:
|
|
raise UpdateFailed("Data incomplete or missing") from err
|
|
except UnsupportedDeviceError as err:
|
|
raise ConfigEntryError("Device with unsupported firmware") from err
|
|
else:
|
|
self._async_add_remove_devices(data, self.config_entry)
|
|
|
|
return data
|
|
|
|
def _async_add_remove_devices(self, data: PlugwiseData, entry: ConfigEntry) -> None:
|
|
"""Add new Plugwise devices, remove non-existing devices."""
|
|
# Check for new or removed devices
|
|
self.new_devices = set(data.devices) - self._current_devices
|
|
removed_devices = self._current_devices - set(data.devices)
|
|
self._current_devices = set(data.devices)
|
|
|
|
if removed_devices:
|
|
self._async_remove_devices(data, entry)
|
|
|
|
def _async_remove_devices(self, data: PlugwiseData, entry: ConfigEntry) -> None:
|
|
"""Clean registries when removed devices found."""
|
|
device_reg = dr.async_get(self.hass)
|
|
device_list = dr.async_entries_for_config_entry(
|
|
device_reg, self.config_entry.entry_id
|
|
)
|
|
# First find the Plugwise via_device
|
|
gateway_device = device_reg.async_get_device(
|
|
{(DOMAIN, data.gateway[GATEWAY_ID])}
|
|
)
|
|
assert gateway_device is not None
|
|
via_device_id = gateway_device.id
|
|
|
|
# Then remove the connected orphaned device(s)
|
|
for device_entry in device_list:
|
|
for identifier in device_entry.identifiers:
|
|
if identifier[0] == DOMAIN:
|
|
if (
|
|
device_entry.via_device_id == via_device_id
|
|
and identifier[1] not in data.devices
|
|
):
|
|
device_reg.async_update_device(
|
|
device_entry.id, remove_config_entry_id=entry.entry_id
|
|
)
|
|
LOGGER.debug(
|
|
"Removed %s device %s %s from device_registry",
|
|
DOMAIN,
|
|
device_entry.model,
|
|
identifier[1],
|
|
)
|