1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423
|
"""Api functions common between sync and async."""
from __future__ import annotations
import datetime
import logging
from functools import cache
from typing import Any
from ._compat import cached_property
from .activity import ACTION_TO_CLASS, SOURCE_LOCK_OPERATE, SOURCE_LOG, ActivityTypes
from .alarm import Alarm, AlarmDevice, ArmState
from .const import BASE_URLS, BRAND_CONFIG, BRANDING, DEFAULT_BRAND, Brand, BrandConfig
from .doorbell import Doorbell
from .lock import Lock, LockDoorStatus, determine_door_state, door_state_to_string
from .time import parse_datetime
API_EXCEPTION_RETRY_TIME = 0.1
API_RETRY_TIME = 2.5
API_RETRY_ATTEMPTS = 10
HEADER_ACCEPT_VERSION = "Accept-Version"
HEADER_AUGUST_COUNTRY = "x-august-country"
HEADER_CONTENT_TYPE = "Content-Type"
HEADER_USER_AGENT = "User-Agent"
HEADER_VALUE_CONTENT_TYPE = "application/json; charset=UTF-8"
HEADER_VALUE_USER_AGENT = "August/Luna-22.17.0 (Android; SDK 31; gphone64_arm64)"
HEADER_VALUE_ACCEPT_VERSION = "0.0.1"
HEADER_VALUE_AUGUST_BRANDING = "august"
HEADER_VALUE_AUGUST_COUNTRY = "US"
API_GET_SESSION_URL = "/session"
API_SEND_VERIFICATION_CODE_URLS = {
"phone": "/validation/phone",
"email": "/validation/email",
}
API_VALIDATE_VERIFICATION_CODE_URLS = {
"phone": "/validate/phone",
"email": "/validate/email",
}
API_GET_HOUSE_ACTIVITIES_URL = "/houses/{house_id}/activities"
API_GET_DOORBELLS_URL = "/users/doorbells/mine"
API_GET_DOORBELL_URL = "/doorbells/{doorbell_id}"
API_WAKEUP_DOORBELL_URL = "/doorbells/{doorbell_id}/wakeup"
API_GET_HOUSES_URL = "/users/houses/mine"
API_GET_HOUSE_URL = "/houses/{house_id}"
API_GET_LOCKS_URL = "/users/locks/mine"
API_GET_LOCK_URL = "/locks/{lock_id}"
API_GET_LOCK_STATUS_URL = "/locks/{lock_id}/status"
API_GET_PINS_URL = "/locks/{lock_id}/pins"
API_LOCK_URL = "/remoteoperate/{lock_id}/lock"
API_UNLOCK_URL = "/remoteoperate/{lock_id}/unlock"
API_UNLATCH_URL = "/remoteoperate/{lock_id}/unlatch"
API_LOCK_ASYNC_URL = "/remoteoperate/{lock_id}/lock?v=2.3.1&type=async"
API_UNLOCK_ASYNC_URL = "/remoteoperate/{lock_id}/unlock?v=2.3.1&type=async"
API_UNLATCH_ASYNC_URL = "/remoteoperate/{lock_id}/unlatch?v=2.3.1&type=async"
API_STATUS_ASYNC_URL = (
"/remoteoperate/{lock_id}/status?v=2.3.1&type=async&intent=wakeup"
)
HYPER_BRIDGE_PARAM = "&connection=persistent"
API_GET_USER_URL = "/users/me"
API_WEBSOCKET_SUBSCRIBERS = "/websocket/subscribers"
API_WEBSOCKET_SUBSCRIBERS_WITH_SUBSCRIBER_ID = "/websocket/subscribers/{subscriber_id}"
API_GET_ALARMS_URL = "/users/alarms/mine"
API_GET_ALARM_DEVICES_URL = "/alarms/{alarm_id}/devices"
API_PUT_ALARM_URL = "/alarms/{alarm_id}/state/{arm_state}"
API_GET_CAPABILITIES_URL = "/devices/capabilities"
_LOGGER = logging.getLogger(__name__)
@cache
def _get_brand_config(brand: Brand) -> BrandConfig:
return BRAND_CONFIG.get(brand, BRAND_CONFIG[DEFAULT_BRAND])
def api_auth_headers(
access_token: str | None = None, brand: Brand | None = None
) -> dict[str, str]:
brand_config = _get_brand_config(brand)
base_headers = {
brand_config.api_key_header: brand_config.api_key,
brand_config.branding_header: BRANDING.get(brand, HEADER_VALUE_AUGUST_BRANDING),
}
if access_token:
base_headers[brand_config.access_token_header] = access_token
return base_headers
def _api_headers(
access_token: str | None = None, brand: Brand | None = None
) -> dict[str, str]:
headers = api_auth_headers(access_token, brand)
headers.update(
{
HEADER_ACCEPT_VERSION: HEADER_VALUE_ACCEPT_VERSION,
HEADER_CONTENT_TYPE: HEADER_VALUE_CONTENT_TYPE,
HEADER_AUGUST_COUNTRY: HEADER_VALUE_AUGUST_COUNTRY,
}
)
return headers
def _convert_lock_result_to_activities(
lock_json_dict: dict[str, Any],
) -> list[ActivityTypes]:
activities = []
lock_info_json_dict = lock_json_dict.get("info", {})
lock_id = lock_info_json_dict.get("lockID")
lock_action_text = lock_info_json_dict.get("action")
activity_epoch = _datetime_string_to_epoch(lock_info_json_dict.get("startTime"))
activity_lock_dict = _map_lock_result_to_activity(
lock_id, activity_epoch, lock_action_text
)
activities.append(activity_lock_dict)
door_state = determine_door_state(lock_json_dict.get("doorState"))
if door_state not in (LockDoorStatus.UNKNOWN, LockDoorStatus.DISABLED):
activity_door_dict = _map_lock_result_to_activity(
lock_id, activity_epoch, door_state_to_string(door_state)
)
activities.append(activity_door_dict)
return activities
def _activity_from_dict(
source: str, activity_dict: dict[str, Any], debug: bool = False
) -> ActivityTypes | None:
"""Convert an activity dict to and Activity object."""
if debug:
_LOGGER.debug("Processing activity: %s", activity_dict)
if (action := activity_dict.get("action")) and (
klass := ACTION_TO_CLASS.get(action)
):
return klass(source, activity_dict)
if debug:
_LOGGER.debug("Unknown activity: %s", activity_dict)
return None
def _map_lock_result_to_activity(
lock_id: str, activity_epoch: float, action_text: str
) -> ActivityTypes | None:
"""Create an yale access activity from a lock result."""
mapped_dict = {
"dateTime": activity_epoch,
"deviceID": lock_id,
"deviceType": "lock",
"action": action_text,
}
return _activity_from_dict(
SOURCE_LOCK_OPERATE, mapped_dict, _LOGGER.isEnabledFor(logging.DEBUG)
)
def _datetime_string_to_epoch(datetime_string: str) -> datetime.datetime:
return parse_datetime(datetime_string).timestamp() * 1000
def _process_activity_json(json_dict: dict[str, Any]) -> list[ActivityTypes]:
if "events" in json_dict:
json_dict = json_dict["events"]
debug = _LOGGER.isEnabledFor(logging.DEBUG)
return [
activity
for activity_json in json_dict
if (activity := _activity_from_dict(SOURCE_LOG, activity_json, debug))
]
def _process_doorbells_json(json_dict: dict[str, Any]) -> list[Doorbell]:
return [Doorbell(device_id, data) for device_id, data in json_dict.items()]
def _process_locks_json(json_dict: dict[str, Any]) -> list[Lock]:
return [Lock(device_id, data) for device_id, data in json_dict.items()]
def _process_alarms_json(json_dict: list[dict[str, Any]]) -> list[Alarm]:
return [Alarm(data.get("alarmID"), data) for data in json_dict]
def _process_alarm_devices_json(json_dict: list[dict[str, Any]]) -> list[AlarmDevice]:
return [AlarmDevice(data) for data in json_dict]
class ApiCommon:
"""Api dict shared between async and sync."""
def __init__(self, brand: Brand) -> None:
"""Init."""
self._base_url = BASE_URLS[brand]
self.brand = brand
self.brand_config = _get_brand_config(brand)
@cached_property
def brand_supports_doorbells(self) -> bool:
"""Return if the brand supports doorbells."""
return self.brand_config.supports_doorbells
@cached_property
def brand_supports_alarms(self) -> bool:
"""Return if the brand supports alarms."""
return self.brand_config.supports_alarms
def get_brand_url(self, url_str: str) -> str:
"""Get url."""
return f"{self._base_url}{url_str}"
def _build_get_session_request(self, install_id, identifier, password):
return {
"method": "post",
"url": self.get_brand_url(API_GET_SESSION_URL),
"json": {
"installId": install_id,
"identifier": identifier,
"password": password,
},
}
def _build_send_verification_code_request(
self, access_token, login_method, username
):
if login_method == "phone":
json = {"smsHashString": "anY0ZsRmXw+", "value": username}
else:
json = {"value": username}
return {
**self._build_base_request(access_token, "post"),
"url": self.get_brand_url(API_SEND_VERIFICATION_CODE_URLS[login_method]),
"json": json,
}
def _build_base_request(
self, access_token: str, method: str = "get"
) -> dict[str, Any]:
"""Build a base request."""
return {"method": method, "access_token": access_token}
def _build_validate_verification_code_request(
self, access_token, login_method, username, verification_code
):
return {
**self._build_base_request(access_token, "post"),
"url": self.get_brand_url(
API_VALIDATE_VERIFICATION_CODE_URLS[login_method]
),
"json": {login_method: username, "code": str(verification_code)},
}
def _build_get_doorbells_request(self, access_token: str) -> dict[str, Any]:
return {
**self._build_base_request(access_token),
"url": self.get_brand_url(API_GET_DOORBELLS_URL),
}
def _build_get_doorbell_detail_request(
self, access_token: str, doorbell_id: str
) -> dict[str, Any]:
return {
**self._build_base_request(access_token),
"url": self.get_brand_url(
API_GET_DOORBELL_URL.format(doorbell_id=doorbell_id)
),
}
def _build_wakeup_doorbell_request(
self, access_token: str, doorbell_id: str
) -> dict[str, Any]:
return {
**self._build_base_request(access_token),
"url": self.get_brand_url(
API_WAKEUP_DOORBELL_URL.format(doorbell_id=doorbell_id)
),
}
def _build_get_houses_request(self, access_token: str) -> dict[str, Any]:
return {
**self._build_base_request(access_token),
"url": self.get_brand_url(API_GET_HOUSES_URL),
}
def _build_get_house_request(self, access_token, house_id):
return {
**self._build_base_request(access_token),
"url": self.get_brand_url(API_GET_HOUSE_URL.format(house_id=house_id)),
}
def _build_get_house_activities_request(self, access_token, house_id, limit=8):
return {
**self._build_base_request(access_token),
"url": self.get_brand_url(
API_GET_HOUSE_ACTIVITIES_URL.format(house_id=house_id)
),
"version": "4.0.0",
"params": {"limit": limit},
}
def _build_get_locks_request(self, access_token: str) -> dict[str, Any]:
return {
**self._build_base_request(access_token),
"url": self.get_brand_url(API_GET_LOCKS_URL),
}
def _build_get_user_request(self, access_token: str) -> dict[str, Any]:
return {
**self._build_base_request(access_token),
"url": self.get_brand_url(API_GET_USER_URL),
}
def _build_get_lock_detail_request(
self, access_token: str, lock_id: str
) -> dict[str, Any]:
return {
**self._build_base_request(access_token),
"url": self.get_brand_url(API_GET_LOCK_URL.format(lock_id=lock_id)),
}
def _build_get_lock_status_request(
self, access_token: str, lock_id: str
) -> dict[str, Any]:
return {
**self._build_base_request(access_token),
"url": self.get_brand_url(API_GET_LOCK_STATUS_URL.format(lock_id=lock_id)),
}
def _build_get_pins_request(
self, access_token: str, lock_id: str
) -> dict[str, Any]:
return {
**self._build_base_request(access_token),
"url": self.get_brand_url(API_GET_PINS_URL.format(lock_id=lock_id)),
}
def _build_get_capabilities_request(
self, access_token: str, serial_number: str
) -> dict[str, Any]:
return {
**self._build_base_request(access_token),
"url": self.get_brand_url(API_GET_CAPABILITIES_URL),
"params": {"serialNumber": serial_number, "topLevelHost": "true"},
}
def _build_refresh_access_token_request(self, access_token: str) -> dict[str, Any]:
return {
**self._build_base_request(access_token),
"url": self.get_brand_url(API_GET_HOUSES_URL),
}
def _build_websocket_subscribe_request(self, access_token: str) -> dict[str, Any]:
return {
**self._build_base_request(access_token, "post"),
"url": self.get_brand_url(API_WEBSOCKET_SUBSCRIBERS),
"json": {
"scopes": ["lock"],
},
}
def _build_websocket_get_request(
self, access_token: str, subscriber_id: str
) -> dict[str, Any]:
return {
**self._build_base_request(access_token, "get"),
"url": self.get_brand_url(
API_WEBSOCKET_SUBSCRIBERS_WITH_SUBSCRIBER_ID.format(
subscriber_id=subscriber_id
)
),
}
def _build_websocket_delete_request(
self, access_token: str, subscriber_id: str
) -> dict[str, Any]:
return {
**self._build_base_request(access_token, "delete"),
"url": self.get_brand_url(
API_WEBSOCKET_SUBSCRIBERS_WITH_SUBSCRIBER_ID.format(
subscriber_id=subscriber_id
)
),
}
def _build_call_lock_operation_request(
self, url_str: str, access_token: str, lock_id: str, timeout
) -> dict[str, Any]:
return {
**self._build_base_request(access_token, "put"),
"url": self.get_brand_url(url_str.format(lock_id=lock_id)),
"timeout": timeout,
}
def _build_get_alarms_request(self, access_token: str) -> dict[str, Any]:
return {
**self._build_base_request(access_token),
"url": self.get_brand_url(API_GET_ALARMS_URL),
}
def _build_get_alarm_devices_request(
self, access_token: str, alarm_id: str
) -> dict[str, Any]:
return {
**self._build_base_request(access_token),
"url": self.get_brand_url(
API_GET_ALARM_DEVICES_URL.format(alarm_id=alarm_id)
),
}
def _build_call_alarm_state_request(
self, access_token: str, alarm: Alarm, arm_state: ArmState
) -> dict[str, Any]:
return {
**self._build_base_request(access_token=access_token, method="PUT"),
"url": self.get_brand_url(
API_PUT_ALARM_URL.format(alarm_id=alarm.device_id, arm_state=arm_state)
),
"json": {"areaIDs": alarm.areaIDs},
}
|