"""Support for August devices.""" from __future__ import annotations import asyncio import logging from abc import abstractmethod from collections.abc import Callable, Coroutine, Iterable, ValuesView from contextlib import suppress from datetime import datetime from enum import Enum from functools import partial from itertools import chain from typing import Any, ParamSpec, TypeVar from aiohttp import ClientError, ClientResponseError, ClientSession from .._compat import cached_property from ..activity import Activity, ActivityTypes, Source from ..backports.tasks import create_eager_task from ..const import Brand from ..doorbell import ContentTokenExpired, Doorbell, DoorbellDetail from ..exceptions import AugustApiAIOHTTPError, YaleApiError from ..lock import Lock, LockDetail, LockOperation from ..pubnub_activity import activities_from_pubnub_message from ..pubnub_async import AugustPubNub from .activity import ActivityStream from .const import MIN_TIME_BETWEEN_DETAIL_UPDATES from .exceptions import CannotConnect, YaleXSError from .gateway import Gateway from .ratelimit import _RateLimitChecker from .socketio import SocketIORunner from .subscriber import SubscriberMixin _LOGGER = logging.getLogger(__name__) API_CACHED_ATTRS = { "door_state", "door_state_datetime", "lock_status", "lock_status_datetime", } YALEXS_BLE_DOMAIN = "yalexs_ble" _R = TypeVar("_R") _P = ParamSpec("_P") class _PushUpdatesState(Enum): """Push updates connection state.""" NOT_CONNECTED = "not_connected" CONNECTED = "connected" def _save_live_attrs(lock_detail: DoorbellDetail | LockDetail) -> dict[str, Any]: """Store the attributes that the lock detail api may have an invalid cache for. Since we are connected to pubnub we may have more current data then the api so we want to restore the most current data after updating battery state etc. """ return {attr: getattr(lock_detail, attr) for attr in API_CACHED_ATTRS} def _restore_live_attrs( lock_detail: DoorbellDetail | LockDetail, attrs: dict[str, Any] ) -> None: """Restore the non-cache attributes after a cached update.""" for attr, value in attrs.items(): setattr(lock_detail, attr, value) class YaleXSData(SubscriberMixin): """YaleXS Data coordinator object.""" def __init__( self, gateway: Gateway, error_exception_class: Exception = YaleXSError ) -> None: """Init August data object.""" super().__init__(MIN_TIME_BETWEEN_DETAIL_UPDATES) self._gateway = gateway self.activity_stream: ActivityStream = None self._api = gateway.api self._device_detail_by_id: dict[str, LockDetail | DoorbellDetail] = {} self._doorbells_by_id: dict[str, Doorbell] = {} self._locks_by_id: dict[str, Lock] = {} self._house_ids: set[str] = set() self._push_unsub: Callable[[], Coroutine[Any, Any, None]] | None = None self._initial_sync_task: asyncio.Task | None = None self._error_exception_class = error_exception_class self._shutdown: bool = False # Track last known state from WebSocket messages to avoid unnecessary updates self._last_push_state: dict[str, dict[str, str]] = {} @cached_property def brand(self) -> Brand: """Return the brand of the API.""" return self._gateway.api.brand async def async_setup(self) -> None: """Async setup of august device data and activities.""" token = await self._gateway.async_get_access_token() await _RateLimitChecker.check_rate_limit(token) await _RateLimitChecker.register_wakeup(token) # This used to be a gather but it was less reliable with august's recent api changes. locks: list[Lock] = await self._api.async_get_operable_locks(token) or [] doorbells: list[Doorbell] = await self._api.async_get_doorbells(token) or [] self._doorbells_by_id = {device.device_id: device for device in doorbells} self._locks_by_id = {device.device_id: device for device in locks} self._house_ids = {device.house_id for device in chain(locks, doorbells)} await self._async_refresh_device_detail_by_ids( [device.device_id for device in chain(locks, doorbells)] ) # We remove all devices that we are missing # detail as we cannot determine if they are usable. # This also allows us to avoid checking for # detail being None all over the place self._remove_inoperative_locks() self._remove_inoperative_doorbells() # Fetch capabilities for locks (only for Yale brands) if self.brand in (Brand.YALE_GLOBAL, Brand.YALE_HOME): await self._async_fetch_lock_capabilities() await self.async_setup_activity_stream() if self._locks_by_id and self.brand is not Brand.YALE_GLOBAL: # Do not prevent setup as the sync can timeout # but it is not a fatal error as the lock # will recover automatically when it comes back online. self._initial_sync_task = create_eager_task( self._async_initial_sync(), name="august-initial-sync" ) async def async_setup_activity_stream(self) -> None: """Set up the activity stream.""" token = await self._gateway.async_get_access_token() user_data = await self._api.async_get_user(token) push: AugustPubNub | SocketIORunner if self.brand is Brand.YALE_GLOBAL: push = SocketIORunner(self._gateway) push_source = Source.WEBSOCKET else: push = AugustPubNub() push_source = Source.PUBNUB for device in self._device_detail_by_id.values(): push.register_device(device) self.activity_stream = ActivityStream( self._api, self._gateway, self._house_ids, push ) await self.activity_stream.async_setup() # Use partial to bind the source parameter push_callback = partial(self.async_push_message, source=push_source) push.subscribe(push_callback) self._push_unsub = await push.run(user_data["UserID"], self.brand) async def _async_fetch_lock_capabilities(self) -> None: """Fetch capabilities for all locks from the API.""" token = await self._gateway.async_get_access_token() # Fetch capabilities for each lock in series to keep API load low for lock_id, lock_detail in self._device_detail_by_id.items(): if lock_id not in self._locks_by_id or not isinstance( lock_detail, LockDetail ): continue # lock_id is the serial_number for locks try: capabilities = await self._api.async_get_lock_capabilities( token, lock_id ) lock_detail.set_capabilities(capabilities) _LOGGER.debug( "Fetched capabilities for lock %s: unlatch=%s", lock_detail.device_name, capabilities.get("lock", {}).get("unlatch", False), ) except YaleApiError as ex: # 409 Conflict means the API cannot determine device type from serial # 404 Not Found means device info not found # These can happen for older devices, just log debug and continue if ex.status in (404, 409): _LOGGER.debug( "Cannot fetch capabilities for lock %s (HTTP %s): %s", lock_detail.device_name, ex.status, str(ex), ) else: _LOGGER.warning( "Failed to fetch capabilities for lock %s (HTTP %s): %s", lock_detail.device_name, ex.status, str(ex), ) except (ClientError, TimeoutError) as ex: _LOGGER.warning( "Failed to fetch capabilities for lock %s: %s", lock_detail.device_name, ex, ) async def _async_initial_sync(self) -> None: """Attempt to request an initial sync.""" # We don't care if this fails because we only want to wake # locks that are actually online anyways and they will be # awake when they come back online for result in await asyncio.gather( *[ create_eager_task( self._async_status_async( device_id, bool(detail.bridge and detail.bridge.hyper_bridge) ) ) for device_id, detail in self._device_detail_by_id.items() if device_id in self._locks_by_id ], return_exceptions=True, ): if isinstance(result, Exception) and not isinstance( result, (TimeoutError, ClientResponseError, CannotConnect) ): _LOGGER.warning( "Unexpected exception during initial sync: %s", result, exc_info=result, ) def async_push_message( self, device_id: str, date_time: datetime, message: dict[str, Any], source: Source | str = "unknown", ) -> None: """Process a push message.""" try: self._async_handle_push_message(device_id, date_time, message, source) except Exception: _LOGGER.exception( "Error processing push message for device %s at %s: %s", device_id, date_time, message, ) # If we have an error, we want to continue processing other messages return def _async_handle_push_message( self, device_id: str, date_time: datetime, message: dict[str, Any], source: Source | str, ) -> None: """Handle a push message.""" _LOGGER.debug("async_push_message from %s: %s %s", source, device_id, message) if device_id not in self._device_detail_by_id: # A push message can arrive for a device we have not loaded # details for yet (e.g. setup is still running) or for a device # that has been removed from the account. Dropping the message # is safe: when the device becomes known, future refreshes will # pick up its state. Raising would put the integration into a # repeating error loop on every subsequent push for the same id. _LOGGER.debug( "Skipping push message from %s for unknown device %s: %s", source, device_id, message, ) return device = self.get_device_detail(device_id) activities = activities_from_pubnub_message(device, date_time, message, source) # Check if this is a push message with unchanged state changed = not self._is_unchanged_push_state( device_id, message, source, activities ) activity_stream = self.activity_stream _LOGGER.debug("async_push_message activities: %s for %s", activities, device_id) if activities and activity_stream.async_process_newer_device_activities( activities ): _LOGGER.debug( "async_push_message newer activities: %s for %s", device_id, activities ) self.async_signal_device_id_update(device.device_id) if not changed: _LOGGER.debug( "Skipping unchanged %s state for %s: status=%s, lockAction=%s, doorState=%s", source, device_id, message.get("status"), message.get("lockAction"), message.get("doorState"), ) return for activity in activities: # Don't trigger a house refresh if the activity is a status update # to avoid unnecessary API calls. if activity.is_status: _LOGGER.debug( "async_push_message activity: %s is status update", activity, ) continue _LOGGER.debug( "async_push_message activity triggering refresh: %s for %s", device_id, activity, ) activity_stream.async_schedule_house_id_refresh(device.house_id) break async def async_stop(self, *args: Any) -> None: """Stop the subscriptions.""" self._shutdown = True if self.activity_stream: self.activity_stream.async_stop() if self._initial_sync_task: self._initial_sync_task.cancel() with suppress(asyncio.CancelledError): await self._initial_sync_task if self._push_unsub: await self._push_unsub() @property def doorbells(self) -> ValuesView[Doorbell]: """Return a list of py-august Doorbell objects.""" return self._doorbells_by_id.values() @property def locks(self) -> ValuesView[Lock]: """Return a list of py-august Lock objects.""" return self._locks_by_id.values() def get_device_detail(self, device_id: str) -> DoorbellDetail | LockDetail: """Return the py-august LockDetail or DoorbellDetail object for a device.""" return self._device_detail_by_id[device_id] async def _async_refresh(self) -> None: """Refresh data.""" if self._shutdown: return await self._async_refresh_device_detail_by_ids(self._subscriptions.keys()) async def _async_refresh_device_detail_by_ids( self, device_ids_list: Iterable[str] ) -> None: """Refresh each device in sequence. This used to be a gather but it was less reliable with august's recent api changes. The august api has been timing out for some devices so we want the ones that it isn't timing out for to keep working. """ for device_id in device_ids_list: try: await self._async_refresh_device_detail_by_id(device_id) except TimeoutError: # noqa: PERF203 _LOGGER.warning( "Timed out calling august api during refresh of device: %s", device_id, ) except (ClientResponseError, CannotConnect) as err: _LOGGER.warning( "Error from august api during refresh of device: %s", device_id, exc_info=err, ) async def refresh_camera_by_id(self, device_id: str) -> None: """Re-fetch doorbell/camera data from API.""" await self._async_update_device_detail( self._doorbells_by_id[device_id], self._api.async_get_doorbell_detail, ) @property def push_updates_connected(self) -> bool: """Return if the push updates are connected.""" return ( self.activity_stream is not None and self.activity_stream.push_updates_connected ) async def _async_refresh_device_detail_by_id(self, device_id: str) -> None: if self._shutdown: return if device_id in self._locks_by_id: if self.activity_stream and self.push_updates_connected: saved_attrs = _save_live_attrs(self._device_detail_by_id[device_id]) await self._async_update_device_detail( self._locks_by_id[device_id], self._api.async_get_lock_detail ) if self.activity_stream and self.push_updates_connected: _restore_live_attrs(self._device_detail_by_id[device_id], saved_attrs) # keypads are always attached to locks if ( device_id in self._device_detail_by_id and self._device_detail_by_id[device_id].keypad is not None ): keypad = self._device_detail_by_id[device_id].keypad self._device_detail_by_id[keypad.device_id] = keypad elif device_id in self._doorbells_by_id: await self._async_update_device_detail( self._doorbells_by_id[device_id], self._api.async_get_doorbell_detail, ) _LOGGER.debug( "async_signal_device_id_update (from detail updates): %s", device_id ) self.async_signal_device_id_update(device_id) async def _async_update_device_detail( self, device: Doorbell | Lock, api_call: Callable[ [str, str], Coroutine[Any, Any, DoorbellDetail | LockDetail] ], ) -> None: device_id = device.device_id device_name = device.device_name _LOGGER.debug("Started retrieving detail for %s (%s)", device_name, device_id) try: detail = await api_call( await self._gateway.async_get_access_token(), device_id ) except ClientError as ex: _LOGGER.error( "Request error trying to retrieve %s details for %s. %s", device_id, device_name, ex, ) _LOGGER.debug("Completed retrieving detail for %s (%s)", device_name, device_id) # If the key changes after startup we need to trigger a # discovery to keep it up to date if isinstance(detail, LockDetail) and detail.offline_key: self.async_offline_key_discovered(detail) self._device_detail_by_id[device_id] = detail @abstractmethod def async_offline_key_discovered(self, detail: LockDetail) -> None: """Handle offline key discovery.""" def get_device(self, device_id: str) -> Doorbell | Lock | None: """Get a device by id.""" return self._locks_by_id.get(device_id) or self._doorbells_by_id.get(device_id) def _get_device_name(self, device_id: str) -> str | None: """Return doorbell or lock name as August has it stored.""" if device := self.get_device(device_id): return device.device_name return None async def async_lock(self, device_id: str) -> list[ActivityTypes]: """Lock the device.""" return await self._async_call_api_op_requires_bridge( device_id, self._api.async_lock_return_activities, await self._gateway.async_get_access_token(), device_id, ) async def async_status_async(self, device_id: str, hyper_bridge: bool) -> str: """Request status of the device but do not wait for a response since it will come via pubnub.""" token = await self._gateway.async_get_access_token() await _RateLimitChecker.check_rate_limit(token) result = await self._async_status_async(device_id, hyper_bridge) await _RateLimitChecker.register_wakeup(token) return result async def _async_status_async(self, device_id: str, hyper_bridge: bool) -> str: """Request status of the device but do not wait for a response since it will come via pubnub.""" return await self._async_call_api_op_requires_bridge( device_id, self._api.async_status_async, await self._gateway.async_get_access_token(), device_id, hyper_bridge, ) async def async_lock_async(self, device_id: str, hyper_bridge: bool) -> str: """Lock the device but do not wait for a response since it will come via pubnub.""" return await self._async_call_api_op_requires_bridge( device_id, self._api.async_lock_async, await self._gateway.async_get_access_token(), device_id, hyper_bridge, ) async def async_unlatch(self, device_id: str) -> list[ActivityTypes]: """Open/unlatch the device.""" return await self._async_call_api_op_requires_bridge( device_id, self._api.async_unlatch_return_activities, await self._gateway.async_get_access_token(), device_id, ) async def async_unlatch_async(self, device_id: str, hyper_bridge: bool) -> str: """Open/unlatch the device but do not wait for a response since it will come via pubnub.""" return await self._async_call_api_op_requires_bridge( device_id, self._api.async_unlatch_async, await self._gateway.async_get_access_token(), device_id, hyper_bridge, ) async def async_unlock(self, device_id: str) -> list[ActivityTypes]: """Unlock the device.""" return await self._async_call_api_op_requires_bridge( device_id, self._api.async_unlock_return_activities, await self._gateway.async_get_access_token(), device_id, ) async def async_unlock_async(self, device_id: str, hyper_bridge: bool) -> str: """Unlock the device but do not wait for a response since it will come via pubnub.""" return await self._async_call_api_op_requires_bridge( device_id, self._api.async_unlock_async, await self._gateway.async_get_access_token(), device_id, hyper_bridge, ) async def async_operate_lock( self, device_id: str, operation: LockOperation, push_updates_connected: bool = False, hyper_bridge: bool = True, ) -> list[ActivityTypes]: """Unified method to operate the lock (lock/unlock/open). Args: device_id: The device ID operation: The operation type (LockOperation enum) push_updates_connected: If True, use async operation that doesn't wait for response hyper_bridge: Whether to use hyper bridge for async operations Returns: Activities list when waiting for response, or empty list when using push updates Note: When unlatch is supported, unlock and open operations are swapped: - UNLOCK operation calls unlatch API - OPEN operation calls unlock API """ # Base operation map - lock is always the same operation_map = { LockOperation.LOCK: { _PushUpdatesState.NOT_CONNECTED: self.async_lock, _PushUpdatesState.CONNECTED: self.async_lock_async, }, } # Check if the device supports unlatching to determine unlock/open mapping detail = self.get_device_detail(device_id) if detail and detail.unlatch_supported: # When unlatch is supported, swap unlock and open operations operation_map[LockOperation.UNLOCK] = { _PushUpdatesState.NOT_CONNECTED: self.async_unlatch, # Swapped! _PushUpdatesState.CONNECTED: self.async_unlatch_async, } operation_map[LockOperation.OPEN] = { _PushUpdatesState.NOT_CONNECTED: self.async_unlock, # Swapped! _PushUpdatesState.CONNECTED: self.async_unlock_async, } else: # Normal mapping when unlatch is not supported operation_map[LockOperation.UNLOCK] = { _PushUpdatesState.NOT_CONNECTED: self.async_unlock, _PushUpdatesState.CONNECTED: self.async_unlock_async, } operation_map[LockOperation.OPEN] = { _PushUpdatesState.NOT_CONNECTED: self.async_unlatch, _PushUpdatesState.CONNECTED: self.async_unlatch_async, } if operation not in operation_map: raise ValueError(f"Invalid operation: {operation}") # Determine the push updates state state = ( _PushUpdatesState.CONNECTED if push_updates_connected else _PushUpdatesState.NOT_CONNECTED ) method = operation_map[operation][state] if push_updates_connected: await method(device_id, hyper_bridge) return [] return await method(device_id) async def _async_call_api_op_requires_bridge( self, device_id: str, func: Callable[_P, Coroutine[Any, Any, _R]], *args: _P.args, **kwargs: _P.kwargs, ) -> _R: """Call an API that requires the bridge to be online and will change the device state.""" try: ret = await func(*args, **kwargs) except AugustApiAIOHTTPError as err: device_name = self._get_device_name(device_id) if device_name is None: device_name = f"DeviceID: {device_id}" raise self._error_exception_class(f"{device_name}: {err}") from err return ret async def async_get_doorbell_image( self, device_id: str, aiohttp_session: ClientSession, timeout: float = 10.0, ) -> bytes: """Get the latest image from the doorbell.""" doorbell = self.get_device_detail(device_id) try: return await doorbell.async_get_doorbell_image(aiohttp_session, timeout) except ContentTokenExpired: if self.brand not in (Brand.YALE_HOME, Brand.YALE_GLOBAL): raise _LOGGER.debug( "Error fetching camera image, updating content-token from api to retry" ) await self.refresh_camera_by_id(device_id) doorbell = self.get_device_detail(device_id) return await doorbell.async_get_doorbell_image(aiohttp_session, timeout) def _remove_inoperative_doorbells(self) -> None: for doorbell in list(self.doorbells): device_id = doorbell.device_id if self._device_detail_by_id.get(device_id): continue _LOGGER.info( ( "The doorbell %s could not be setup because the system could not" " fetch details about the doorbell" ), doorbell.device_name, ) del self._doorbells_by_id[device_id] def _is_unchanged_push_state( self, device_id: str, message: dict[str, Any], source: Source | str, activities: list[Activity], ) -> bool: """Check if a push message represents unchanged state.""" # Build state key based on source - different sources track state separately state_key = f"{device_id}:{source}" # Get last known state last_state = self._last_push_state.get(state_key) # Get relevant state fields based on source if source == Source.WEBSOCKET: # WebSocket uses lockAction and doorState if "lockAction" not in message and "doorState" not in message: return False current_state = { "lock": message.get("lockAction", ""), "door": message.get("doorState", ""), } else: # PubNub # PubNub uses status and doorState if "status" not in message and "doorState" not in message: return False current_state = { "lock": message.get("status", ""), "door": message.get("doorState", ""), } # If all activities are status updates and we have a last state, # check if the state is unchanged but don't update tracking if last_state and all(activity.is_status for activity in activities): # Status update with changed state or no previous state - don't track it return last_state == current_state # If we have a previous state and it matches current state, it's unchanged if last_state and last_state == current_state: return True # Update the last known state (only for real actions, not status updates) self._last_push_state[state_key] = current_state return False def _remove_inoperative_locks(self) -> None: # Remove non-operative locks as there must # be a bridge (August Connect) for them to # be usable for lock in list(self.locks): device_id = lock.device_id lock_detail = self._device_detail_by_id.get(device_id) if lock_detail is None: _LOGGER.info( ( "The lock %s could not be setup because the system could not" " fetch details about the lock" ), lock.device_name, ) elif lock_detail.bridge is None: _LOGGER.info( ( "The lock %s could not be setup because it does not have a" " bridge (Connect)" ), lock.device_name, ) del self._device_detail_by_id[device_id] # Bridge may come back online later so we still add the device since we will # have a pubnub subscription to tell use when it recovers else: continue del self._locks_by_id[device_id]