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 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486
|
from __future__ import annotations
import re
import json
from typing import Any, List, Literal, TypedDict
import aiohttp
from aioairq.encrypt import AESCipher
from aioairq.exceptions import (
APIAccessDenied,
APIAccessError,
InvalidAirQResponse,
InvalidIpAddress,
)
from aioairq.utils import is_valid_ipv4_address
LedThemeName = Literal[
"standard",
"standard (contrast)",
"Virus",
"Virus (contrast)",
"co2_covid19",
"CO2",
"VOC",
"Humidity",
"CO",
"NO2",
"O3",
"Oxygen",
"PM1",
"PM2.5",
"PM10",
"Noise",
"Noise (contrast)",
"Noise Average",
"Noise Average (contrast)",
]
class DeviceInfo(TypedDict):
"""Container for device information"""
id: str
name: str | None
model: str | None
suggested_area: str | None
sw_version: str | None
hw_version: str | None
class DeviceLedTheme(TypedDict, total=True):
"""Complete specification of the LED themes of a device.
Each device is described by two themes, one for each side.
"""
left: LedThemeName
right: LedThemeName
class DeviceLedThemePatch(TypedDict, total=False):
"""Potentially incomplete specification of the LED themes.
Helpful for updating the themes.
"""
left: LedThemeName
right: LedThemeName
class NightMode(TypedDict):
"""Container holding night mode configuration"""
activated: bool
"""Whether the night mode is activated"""
start_day: str
"""End time of night mode in format 'HH:mm'. Note that the time is in UTC."""
start_night: str
"""Start time of night mode in format 'HH:mm'. Note that the time is in UTC."""
brightness_day: float
"""LED brightness outside of night mode.
Note:
Official docs say valid range is 2.2 to 20.0.
The valid range seems more like 1.0 to 10.0. With 0 the LEDs can be turned off completely.
"""
brightness_night: float
"""LED brightness during night mode.
Note:
Official docs say valid range is 2.2 to 20.0.
The valid range seems more like 1.0 to 10.0. With 0 the LEDs can be turned off completely.
"""
fan_night_off: bool
"""Whether the fans are turned off during night mode.
Notes from official docs:
Turning off the fans will disable the sensors for particle pollution (PM1, PM2.5, PM10).
Fire alarm will only trigger for CO and temperature, but not for smoke."""
wifi_night_off: bool
"""Whether Wi-Fi is turned off during night mode.
Notes from official docs:
When turning off Wi-Fi with this setting and when cloud upload is enabled,
data will be cached on the SD card and uploaded eventually
when network link is available again."""
alarm_night_off: bool
"""Whether alarms are turned off during night mode.
Notes from official docs:
This setting disables acoustic warnings. Fire and gas alarm will trigger despite."""
class AirQ:
_supported_routes = ["config", "log", "data", "average", "ping"]
def __init__(
self,
address: str,
passw: str,
session: aiohttp.ClientSession,
timeout: float = 15,
):
"""Class representing the API for a single AirQ device
The class holds the AESCipher object, responsible for message decoding,
as well as the anchor of the http address to base further requests on
Parameters
----------
address : str
Either the IP address of the device, or its mDNS.
Device's IP might be a more robust option (across the variety of routers)
passw : str
Device's password
session : aiohttp.ClientSession
Session used to communicate to the device. Should be managed by the user
timeout : float
Maximum time in seconds used by `session.get` to connect to the device
before `aiohttp.ServerTimeoutError` is raised. Default: 15 seconds.
Hitting the timeout be an indication that the device and the host are not
on the same WiFi
"""
self.address = address
self.anchor = "http://" + self.address
self.aes = AESCipher(passw)
self._session = session
self._timeout = aiohttp.ClientTimeout(connect=timeout)
async def has_api_access(self) -> bool:
return (await self.get_config())["APIaccess"]
async def blink(self) -> str:
"""Let the device blink in rainbow colors for a short amount of time.
Returns the device's ID.
This function can be used to identify a device, when you have multiple devices.
"""
json_data = await self._get_json("/blink")
return json_data["id"]
async def validate(self) -> None:
"""Test if the password provided to the constructor is valid.
Raises InvalidAuth if the password is not correct.
This is merely a convenience function, relying on the exception being
raised down the stack (namely by AESCipher.decode from within self.get)
"""
await self.get("ping")
async def restart(self) -> None:
"""Restarts the device."""
post_json_data = {"reset": True}
await self._post_json_and_decode("/config", post_json_data)
async def shutdown(self) -> None:
"""Shuts the device down."""
post_json_data = {"shutdown": True}
await self._post_json_and_decode("/config", post_json_data)
def __repr__(self) -> str:
return f"{self.__class__.__name__}({self.address})"
async def fetch_device_info(self) -> DeviceInfo:
"""Fetch condensed device description"""
config: dict = await self.get("config")
room_type = config.get("RoomType")
try:
# The only required field. Should not really be missing, just a precaution
device_id = config["id"]
except KeyError as e:
raise InvalidAirQResponse from e
return DeviceInfo(
id=device_id,
name=config.get("devicename"),
model=config.get("type"),
suggested_area=room_type.replace("-", " ").title() if room_type else None,
sw_version=config.get("air-Q-Software-Version"),
hw_version=config.get("air-Q-Hardware-Version"),
)
@staticmethod
def drop_uncertainties_from_data(data: dict) -> dict:
"""Filter returned dict and substitute [value, uncertainty] with the value.
The device attempts to estimate the uncertainty, or error, of certain readings.
These readings are returned as tuples of (value, uncertainty). Often, the latter
is not desired, and this is a convenience method to homogenise the dict a little
"""
# `if v else None` is a precaution for the case of v being an empty list
# (which ought not to happen really...)
return {
k: (v[0] if v else None) if isinstance(v, (list, tuple)) else v
for k, v in data.items()
}
@staticmethod
def clip_negative_values(data: dict) -> dict:
def clip(value):
if isinstance(value, list):
return [max(0, value[0]), value[1]]
if isinstance(value, (float, int)):
return max(0, value)
return value
return {k: clip(v) for k, v in data.items()}
async def get_latest_data(
self,
return_average=True,
clip_negative_values=True,
return_uncertainties=False,
):
data = await self.get("average" if return_average else "data")
if clip_negative_values:
data = self.clip_negative_values(data)
if not return_uncertainties:
data = self.drop_uncertainties_from_data(data)
return data
async def get(self, subject: str) -> dict:
"""Return the given subject from the air-Q device.
This function only works on a limited set of subject specified in _supported_routes.
Prefer using more specialized functions."""
if subject not in self._supported_routes:
raise NotImplementedError(
"AirQ.get() is currently limited to a set of requests, returning "
f"a dict with a key 'content' (namely {self._supported_routes})."
)
return await self._get_json_and_decode("/" + subject)
async def _get_json(self, relative_url: str) -> dict:
"""Executes a GET request to the air-Q device with the configured timeout
and returns JSON data as a dictionary.
relative_url is expected to start with a slash."""
async with self._session.get(
f"{self.anchor}{relative_url}", timeout=self._timeout
) as response:
json_string = await response.text()
try:
return json.loads(json_string)
except json.JSONDecodeError as e:
raise InvalidAirQResponse(
"_get_json() must only be used to query endpoints returning JSON data. "
f"{relative_url} returned {json_string}."
) from e
async def _get_json_and_decode(self, relative_url: str) -> Any:
"""Executes a GET request to the air-Q device with the configured timeout
decodes the response and returns JSON data.
relative_url is expected to start with a slash."""
json_data = await self._get_json(relative_url)
encoded_message = json_data["content"]
decoded_json_data = self.aes.decode(encoded_message)
return json.loads(decoded_json_data)
async def _post_json_and_decode(
self, relative_url: str, post_json_data: dict
) -> Any:
"""Executes a POST request to the air-Q device with the configured timeout,
decodes the response and returns JSON data.
relative_url is expected to start with a slash."""
headers = {"Content-Type": "application/x-www-form-urlencoded"}
post_data = "request=" + self.aes.encode(json.dumps(post_json_data))
async with self._session.post(
f"{self.anchor}{relative_url}",
headers=headers,
data=post_data,
timeout=self._timeout,
) as response:
json_string = await response.text()
try:
json_data = json.loads(json_string)
except json.JSONDecodeError as e:
raise InvalidAirQResponse(
"_post_json() must only be used to query endpoints returning JSON data. "
f"{relative_url} returned {json_string}."
) from e
encoded_message = json_data["content"]
decoded_json_data = self.aes.decode(encoded_message)
response_decoded = json.loads(decoded_json_data)
if isinstance(response_decoded, str) and response_decoded.startswith("Error"):
_lookup_exception_from_firmware_response(response_decoded)
return response_decoded
@property
async def data(self):
return await self.get("data")
@property
async def average(self):
return await self.get("average")
@property
async def config(self):
"""Deprecated. Use get_config() instead."""
return await self.get("config")
async def set_ifconfig_static(self, ip: str, subnet: str, gateway: str, dns: str):
"""Configures the interface to use a static IP setup.
Notice: The air-Q only supports IPv4. After calling this function,
you should call restart() to apply the settings."""
if not is_valid_ipv4_address(ip):
raise InvalidIpAddress(f"Invalid IP address: {ip}")
if not is_valid_ipv4_address(subnet):
raise InvalidIpAddress(f"Invalid subnet address: {subnet}")
if not is_valid_ipv4_address(gateway):
raise InvalidIpAddress(f"Invalid gateway address: {gateway}")
if not is_valid_ipv4_address(dns):
raise InvalidIpAddress(f"Invalid DNS server address: {dns}")
post_json_data = {
"ifconfig": {"ip": ip, "subnet": subnet, "gateway": gateway, "dns": dns}
}
await self._post_json_and_decode("/config", post_json_data)
async def set_ifconfig_dhcp(self):
"""Configures the interface to use DHCP.
Notice: After calling this function, you should call restart() to apply the settings.
"""
post_json_data = {"DeleteKey": "ifconfig"}
await self._post_json_and_decode("/config", post_json_data)
async def get_time_server(self):
return (await self.get_config())["TimeServer"]
async def set_time_server(self, time_server):
post_json_data = {"TimeServer": time_server}
try:
return await self._post_json_and_decode("/config", post_json_data)
except APIAccessDenied:
# convert the culprit key as it is used by the firmware
# to the name of this specific class method
raise APIAccessDenied("set_time_server is only supported for air-Q Science")
async def get_device_name(self):
return (await self.get_config())["devicename"]
async def set_device_name(self, device_name):
post_json_data = {"devicename": device_name}
await self._post_json_and_decode("/config", post_json_data)
async def get_cloud_remote(self) -> bool:
return (await self._get_json_and_decode("/config"))["cloudRemote"]
async def set_cloud_remote(self, value: bool):
post_json_data = {"cloudRemote": value}
await self._post_json_and_decode("/config", post_json_data)
async def get_log(self) -> List[str]:
return await self._get_json_and_decode("/log")
async def get_config(self) -> dict:
return await self._get_json_and_decode("/config")
async def get_possible_led_themes(self) -> List[LedThemeName]:
return (await self._get_json_and_decode("/config"))["possibleLedTheme"]
async def get_led_theme(self) -> DeviceLedTheme:
led_theme = (await self._get_json_and_decode("/config"))["ledTheme"]
return DeviceLedTheme(left=led_theme["left"], right=led_theme["right"])
async def set_led_theme(self, theme: DeviceLedThemePatch | DeviceLedTheme):
# air-Q does not support setting only one side.
# If you do this, the API will answer a misleading error like
#
# ```
# Error: unsupported option for key 'ledTheme' - can be ['standard', 'standard (contrast)', ...]
# ```
#
# Therefore, we first read both sides, so we may set both sides at once.
# I am not too satisfied with the DeviceLedThemePatch|DeviceLedTheme annotation,
# necessary to pacify pyright. A better solution would be to use
# proper inheritance, I guess, to indicate that DeviceLedTheme is a
# subclass of DeviceLedThemePatch. Does not seem to work with TypedDict and
# total={True,False}. Consider switching to pydantic
if len(theme) < 2:
current_led_theme = await self.get_led_theme()
theme = current_led_theme | theme
await self._post_json_and_decode("/config", {"ledTheme": theme})
async def get_night_mode(self) -> NightMode:
night_mode = (await self.get_config())["NightMode"]
return NightMode(
activated=night_mode["Activated"],
start_day=night_mode["StartDay"],
start_night=night_mode["StartNight"],
brightness_day=night_mode["BrightnessDay"],
brightness_night=night_mode["BrightnessNight"],
fan_night_off=night_mode["FanNightOff"],
wifi_night_off=night_mode["WifiNightOff"],
alarm_night_off=night_mode["AlarmNightOff"],
)
async def set_night_mode(self, night_mode: NightMode):
post_json_data = {
"NightMode": {
"Activated": night_mode["activated"],
"StartDay": night_mode["start_day"],
"StartNight": night_mode["start_night"],
"BrightnessDay": night_mode["brightness_day"],
"BrightnessNight": night_mode["brightness_night"],
"FanNightOff": night_mode["fan_night_off"],
"WifiNightOff": night_mode["wifi_night_off"],
"AlarmNightOff": night_mode["alarm_night_off"],
}
}
await self._post_json_and_decode("/config", post_json_data)
def _lookup_exception_from_firmware_response(error_message: str):
"""Ad hoc function attempting to parse the error message.
Tries to recognise the error message and issue a specific error.
If fails, issues an unspecific APIAccessError.
"""
if m := re.match(
r"Error: (?P<message>'.*' is only available for air-Q Science)!\n",
error_message,
):
raise APIAccessDenied(m.groupdict()["message"])
else:
raise APIAccessError(error_message)
|