hap.py

Go to the documentation of this file.

"""Access point for the HomematicIP Cloud component."""
 
from __future__ import annotations
 
import asyncio
from collections.abc import Callable
import logging
from typing import Any
 
from homematicip.aio.auth import AsyncAuth
from homematicip.aio.home import AsyncHome
from homematicip.base.base_connection import HmipConnectionError
from homematicip.base.enums import EventType
 
from homeassistant.config_entries import ConfigEntry
from homeassistant.core import HomeAssistant, callback
from homeassistant.exceptions import ConfigEntryNotReady
from homeassistant.helpers.aiohttp_client import async_get_clientsession
 
from .const import HMIPC_AUTHTOKEN, HMIPC_HAPID, HMIPC_NAME, HMIPC_PIN, PLATFORMS
from .errors import HmipcConnectionError
 
_LOGGER = logging.getLogger(__name__)
 
 
class HomematicipAuth:
    """Manages HomematicIP client registration."""
 
    auth: AsyncAuth
 
    def __init__(self, hass: HomeAssistant, config: dict[str, str]) -> None:
        """Initialize HomematicIP Cloud client registration."""
        self.hasshass = hass
        self.configconfig = config
 
    async def async_setup(self) -> bool:
        """Connect to HomematicIP for registration."""
        try:
            self.authauth = await self.get_authget_auth(
                self.hasshass, self.configconfig.get(HMIPC_HAPID), self.configconfig.get(HMIPC_PIN)
            )
        except HmipcConnectionError:
            return False
        return self.authauth is not None
 
    async def async_checkbutton(self) -> bool:
        """Check blue butten has been pressed."""
        try:
            return await self.authauth.isRequestAcknowledged()
        except HmipConnectionError:
            return False
 
    async def async_register(self):
        """Register client at HomematicIP."""
        try:
            authtoken = await self.authauth.requestAuthToken()
            await self.authauth.confirmAuthToken(authtoken)
        except HmipConnectionError:
            return False
        return authtoken
 
    async def get_auth(self, hass: HomeAssistant, hapid, pin):
        """Create a HomematicIP access point object."""
        auth = AsyncAuth(hass.loop, async_get_clientsession(hass))
        try:
            await auth.init(hapid)
            if pin:
                auth.pin = pin
            await auth.connectionRequest("HomeAssistant")
        except HmipConnectionError:
            return None
        return auth
 
 
class HomematicipHAP:
    """Manages HomematicIP HTTP and WebSocket connection."""
 
    home: AsyncHome
 
    def __init__(self, hass: HomeAssistant, config_entry: ConfigEntry) -> None:
        """Initialize HomematicIP Cloud connection."""
        self.hasshass = hass
        self.config_entryconfig_entry = config_entry
 
        self._ws_close_requested_ws_close_requested = False
        self._retry_task_retry_task: asyncio.Task | None = None
        self._tries_tries = 0
        self._accesspoint_connected_accesspoint_connected = True
        self.hmip_device_by_entity_idhmip_device_by_entity_id: dict[str, Any] = {}
        self.reset_connection_listener: Callable | None = None
 
    async def async_setup(self, tries: int = 0) -> bool:
        """Initialize connection."""
        try:
            self.homehome = await self.get_hapget_hap(
                self.hasshass,
                self.config_entryconfig_entry.data.get(HMIPC_HAPID),
                self.config_entryconfig_entry.data.get(HMIPC_AUTHTOKEN),
                self.config_entryconfig_entry.data.get(HMIPC_NAME),
            )
        except HmipcConnectionError as err:
            raise ConfigEntryNotReady from err
        except Exception as err:  # noqa: BLE001
            _LOGGER.error("Error connecting with HomematicIP Cloud: %s", err)
            return False
 
        _LOGGER.debug(
            "Connected to HomematicIP with HAP %s", self.config_entryconfig_entry.unique_id
        )
 
        await self.hasshass.config_entries.async_forward_entry_setups(
            self.config_entryconfig_entry, PLATFORMS
        )
 
        return True
 
    @callback
    def async_update(self, *args, **kwargs) -> None:
        """Async update the home device.
 
        Triggered when the HMIP HOME_CHANGED event has fired.
        There are several occasions for this event to happen.
        1. We are interested to check whether the access point
        is still connected. If not, entity state changes cannot
        be forwarded to hass. So if access point is disconnected all devices
        are set to unavailable.
        2. We need to update home including devices and groups after a reconnect.
        3. We need to update home without devices and groups in all other cases.
 
        """
        if not self.homehome.connected:
            _LOGGER.error("HMIP access point has lost connection with the cloud")
            self._accesspoint_connected_accesspoint_connected = False
            self.set_all_to_unavailableset_all_to_unavailable()
        elif not self._accesspoint_connected_accesspoint_connected:
            # Now the HOME_CHANGED event has fired indicating the access
            # point has reconnected to the cloud again.
            # Explicitly getting an update as entity states might have
            # changed during access point disconnect."""
 
            job = self.hasshass.async_create_task(self.get_stateget_state())
            job.add_done_callback(self.get_state_finishedget_state_finished)
            self._accesspoint_connected_accesspoint_connected = True
 
    @callback
    def async_create_entity(self, *args, **kwargs) -> None:
        """Create an entity or a group."""
        is_device = EventType(kwargs["event_type"]) == EventType.DEVICE_ADDED
        self.hasshass.async_create_task(self.async_create_entity_lazyasync_create_entity_lazy(is_device))
 
    async def async_create_entity_lazy(self, is_device=True) -> None:
        """Delay entity creation to allow the user to enter a device name."""
        if is_device:
            await asyncio.sleep(30)
        await self.hasshass.config_entries.async_reload(self.config_entryconfig_entry.entry_id)
 
    async def get_state(self) -> None:
        """Update HMIP state and tell Home Assistant."""
        await self.homehome.get_current_state()
        self.update_allupdate_all()
 
    def get_state_finished(self, future) -> None:
        """Execute when get_state coroutine has finished."""
        try:
            future.result()
        except HmipConnectionError:
            # Somehow connection could not recover. Will disconnect and
            # so reconnect loop is taking over.
            _LOGGER.error("Updating state after HMIP access point reconnect failed")
            self.hasshass.async_create_task(self.homehome.disable_events())
 
    def set_all_to_unavailable(self) -> None:
        """Set all devices to unavailable and tell Home Assistant."""
        for device in self.homehome.devices:
            device.unreach = True
        self.update_allupdate_all()
 
    def update_all(self) -> None:
        """Signal all devices to update their state."""
        for device in self.homehome.devices:
            device.fire_update_event()
 
    async def async_connect(self) -> None:
        """Start WebSocket connection."""
        tries = 0
        while True:
            retry_delay = 2 ** min(tries, 8)
 
            try:
                await self.homehome.get_current_state()
                hmip_events = await self.homehome.enable_events()
                tries = 0
                await hmip_events
            except HmipConnectionError:
                _LOGGER.error(
                    (
                        "Error connecting to HomematicIP with HAP %s. "
                        "Retrying in %d seconds"
                    ),
                    self.config_entryconfig_entry.unique_id,
                    retry_delay,
                )
 
            if self._ws_close_requested_ws_close_requested:
                break
            self._ws_close_requested_ws_close_requested = False
            tries += 1
 
            try:
                self._retry_task_retry_task = self.hasshass.async_create_task(
                    asyncio.sleep(retry_delay)
                )
                await self._retry_task_retry_task
            except asyncio.CancelledError:
                break
 
    async def async_reset(self) -> bool:
        """Close the websocket connection."""
        self._ws_close_requested_ws_close_requested = True
        if self._retry_task_retry_task is not None:
            self._retry_task_retry_task.cancel()
        await self.homehome.disable_events()
        _LOGGER.debug("Closed connection to HomematicIP cloud server")
        await self.hasshass.config_entries.async_unload_platforms(
            self.config_entryconfig_entry, PLATFORMS
        )
        self.hmip_device_by_entity_idhmip_device_by_entity_id = {}
        return True
 
    @callback
    def shutdown(self, event) -> None:
        """Wrap the call to async_reset.
 
        Used as an argument to EventBus.async_listen_once.
        """
        self.hasshass.async_create_task(self.async_resetasync_reset())
        _LOGGER.debug(
            "Reset connection to access point id %s", self.config_entryconfig_entry.unique_id
        )
 
    async def get_hap(
        self,
        hass: HomeAssistant,
        hapid: str | None,
        authtoken: str | None,
        name: str | None,
    ) -> AsyncHome:
        """Create a HomematicIP access point object."""
        home = AsyncHome(hass.loop, async_get_clientsession(hass))
 
        home.name = name
        # Use the title of the config entry as title for the home.
        home.label = self.config_entryconfig_entry.title
        home.modelType = "HomematicIP Cloud Home"
 
        home.set_auth_token(authtoken)
        try:
            await home.init(hapid)
            await home.get_current_state()
        except HmipConnectionError as err:
            raise HmipcConnectionError from err
        home.on_update(self.async_updateasync_update)
        home.on_create(self.async_create_entityasync_create_entity)
        hass.loop.create_task(self.async_connectasync_connect())
 
        return home