blueair-api 1.9.1__py3-none-any.whl → 1.33.2__py3-none-any.whl

blueair_api/http_aws_blueair.py

@@ -1,3 +1,5 @@
+from typing import Any
+import functools
 import logging
 
 from aiohttp import ClientSession, ClientResponse, FormData
@@ -10,7 +12,8 @@ _LOGGER = logging.getLogger(__name__)
 
 
 def request_with_active_session(func):
-    async def request_with_active_session_wrapper(*args, **kwargs):
+    @functools.wraps(func)
+    async def request_with_active_session_wrapper(*args, **kwargs) -> ClientResponse:
         _LOGGER.debug("session")
         try:
             return await func(*args, **kwargs)
@@ -28,7 +31,8 @@ def request_with_active_session(func):
 
 
 def request_with_errors(func):
-    async def request_with_errors_wrapper(*args, **kwargs):
+    @functools.wraps(func)
+    async def request_with_errors_wrapper(*args, **kwargs) -> ClientResponse:
         _LOGGER.debug("checking for errors")
         response: ClientResponse = await func(*args, **kwargs)
         status_code = response.status
@@ -48,9 +52,12 @@ def request_with_errors(func):
             url = kwargs["url"]
             response_text = await response.text()
             if "accounts.login" in url:
+                _LOGGER.debug("login error")
                 raise LoginError(response_text)
             else:
+                _LOGGER.debug("session error")
                 raise SessionError(response_text)
+        raise ValueError(f"unknown status code {status_code}")
 
     return request_with_errors_wrapper
 
@@ -61,7 +68,7 @@ class HttpAwsBlueair:
         username: str,
         password: str,
         region: str = "us",
-        client_session: ClientSession = None,
+        client_session: ClientSession | None = None,
     ):
         self.username = username
         self.password = password
@@ -85,7 +92,7 @@ class HttpAwsBlueair:
     @request_with_errors
     @request_with_logging
     async def _get_request_with_logging_and_errors_raised(
-        self, url: str, headers: dict = None
+        self, url: str, headers: dict | None = None
     ) -> ClientResponse:
         return await self.api_session.get(url=url, headers=headers)
 
@@ -94,15 +101,15 @@ class HttpAwsBlueair:
     async def _post_request_with_logging_and_errors_raised(
         self,
         url: str,
-        json_body: dict = None,
-        form_data: FormData = None,
-        headers: dict = None,
+        json_body: dict | None = None,
+        form_data: FormData | None = None,
+        headers: dict | None = None,
     ) -> ClientResponse:
         return await self.api_session.post(
             url=url, data=form_data, json=json_body, headers=headers
         )
 
-    async def refresh_session(self):
+    async def refresh_session(self) -> None:
         _LOGGER.debug("refresh_session")
         url = f"https://accounts.{AWS_APIKEYS[self.region]['gigyaRegion']}.gigya.com/accounts.login"
         form_data = FormData()
@@ -119,7 +126,7 @@ class HttpAwsBlueair:
         self.session_token = response_json["sessionInfo"]["sessionToken"]
         self.session_secret = response_json["sessionInfo"]["sessionSecret"]
 
-    async def refresh_jwt(self):
+    async def refresh_jwt(self) -> None:
         _LOGGER.debug("refresh_jwt")
         if self.session_token is None or self.session_secret is None:
             await self.refresh_session()
@@ -136,7 +143,7 @@ class HttpAwsBlueair:
         response_json = await response.json(content_type="text/javascript")
         self.jwt = response_json["id_token"]
 
-    async def refresh_access_token(self):
+    async def refresh_access_token(self) -> None:
         _LOGGER.debug("refresh_access_token")
         if self.jwt is None:
             await self.refresh_jwt()
@@ -150,14 +157,15 @@ class HttpAwsBlueair:
         response_json = await response.json()
         self.access_token = response_json["access_token"]
 
-    async def get_access_token(self):
+    async def get_access_token(self) -> str:
         _LOGGER.debug("get_access_token")
         if self.access_token is None:
             await self.refresh_access_token()
+        assert self.access_token is not None
         return self.access_token
 
     @request_with_active_session
-    async def devices(self):
+    async def devices(self) -> dict[str, Any]:
         _LOGGER.debug("devices")
         url = f"https://{AWS_APIKEYS[self.region]['restApiId']}.execute-api.{AWS_APIKEYS[self.region]['awsRegion']}.amazonaws.com/prod/c/registered-devices"
         headers = {
@@ -172,15 +180,8 @@ class HttpAwsBlueair:
         return response_json["devices"]
 
     @request_with_active_session
-    async def device_info(self, device_name, device_uuid):
+    async def device_info(self, device_name, device_uuid) -> dict[str, Any]:
         _LOGGER.debug("device_info")
-        """
-        sample; [{'id': '1b41a7c6-8f02-42fa-9af8-868dad9be98a', 'configuration': {'df': {'a': 877, 'ot': 'G4Filter', 'alg': 'FilterAlg1'}, 'di': {'cfv': '2.1.1', 'cma': '3c:61:05:45:56:98', 'mt': '2', 'name': 'sage', 'sku': '105826', 'mfv': '1.0.12', 'ofv': '2.1.1', 'hw': 'high_1.5', 'ds': '110582600000110110016855'}, '_ot': 'CmConfig', '_f': False, '_it': 'urn:blueair:openapi:version:healthprotect:0.0.5', '_eid': 'f8cb142f-c77d-11eb-b045-c98ff4f5a769', '_sc': 'Instance', 'ds': {'tVOC': {'tf': 'senml+json', 'ot': 'TVOC', 'e': True, 'i': 0, 'tn': 'd/1b41a7c6-8f02-42fa-9af8-868dad9be98a/s/tVOC', 'ttl': 0, 'n': 'tVOC', 'fe': True}, 'fu0': {'tf': 'senml+json', 'ot': 'FU', 'e': False, 'i': 0, 'tn': 'd/1b41a7c6-8f02-42fa-9af8-868dad9be98a/s/fu0', 'ttl': -1, 'n': 'fu0', 'fe': True}, 'ledb': {'tf': 'senml+json', 'ot': 'Led', 'e': False, 'i': 0, 'tn': 'd/1b41a7c6-8f02-42fa-9af8-868dad9be98a/s/ledb', 'ttl': 0, 'n': 'ledb', 'fe': True}, 'co2': {'tf': 'senml+json', 'ot': 'Co2', 'e': False, 'i': 0, 'tn': 'd/1b41a7c6-8f02-42fa-9af8-868dad9be98a/s/co2', 'ttl': 0, 'n': 'co2', 'fe': True}, 'pm2_5c': {'tf': 'senml+json', 'ot': 'PMParticleCount', 'e': False, 'i': 0, 'tn': 'd/1b41a7c6-8f02-42fa-9af8-868dad9be98a/s/pm2_5c', 'ttl': 0, 'n': 'pm2_5c', 'fe': True}, 'sb': {'tf': 'senml+json', 'ot': 'Standby', 'e': True, 'i': 0, 'tn': 'd/1b41a7c6-8f02-42fa-9af8-868dad9be98a/s/sb', 'ttl': -1, 'n': 'sb', 'fe': True}, 'ss0': {'tf': 'senml+json', 'ot': 'SafetySwitch', 'e': True, 'i': 0, 'tn': 'd/1b41a7c6-8f02-42fa-9af8-868dad9be98a/s/ss0', 'ttl': -1, 'n': 'ss0', 'fe': True}, 'rt1s': {'tf': 'senml+json', 'ot': 'RT1s', 'e': True, 'i': 1000, 'tn': 'd/1b41a7c6-8f02-42fa-9af8-868dad9be98a/s/1s', 'sn': ['pm1', 'pm2_5', 'pm10', 't', 'h', 'tVOC', 'rssi'], 'ttl': 0, 'n': 'rt1s', 'fe': True}, 'rt5s': {'tf': 'senml+json', 'ot': 'RT5s', 'e': False, 'i': 0, 'tn': 'd/1b41a7c6-8f02-42fa-9af8-868dad9be98a/s/5s', 'sn': ['pm1', 'pm2_5', 'pm10', 't', 'h', 'tVOC', 'rssi'], 'ttl': -1, 'n': 'rt5s', 'fe': True}, 'pm1': {'tf': 'senml+json', 'ot': 'PM1', 'e': True, 'i': 0, 'tn': 'd/1b41a7c6-8f02-42fa-9af8-868dad9be98a/s/pm1', 'ttl': 0, 'n': 'pm1', 'fe': True}, 'pm2_5': {'tf': 'senml+json', 'ot': 'PM2_5', 'e': True, 'i': 0, 'tn': 'd/1b41a7c6-8f02-42fa-9af8-868dad9be98a/s/pm2_5', 'ttl': 0, 'n': 'pm2_5', 'fe': True}, 'pm10c': {'tf': 'senml+json', 'ot': 'PMParticleCount', 'e': False, 'i': 0, 'tn': 'd/1b41a7c6-8f02-42fa-9af8-868dad9be98a/s/pm10c', 'ttl': 0, 'n': 'pm10c', 'fe': True}, 'sp': {'tf': 'senml+json', 'ot': 'SensorBoxPresense', 'e': False, 'i': 0, 'tn': 'd/1b41a7c6-8f02-42fa-9af8-868dad9be98a/s/sp', 'ttl': -1, 'n': 'sp', 'fe': True}, 'rssi': {'tf': 'senml+json', 'ot': 'RSSI', 'e': True, 'i': 0, 'tn': 'd/1b41a7c6-8f02-42fa-9af8-868dad9be98a/s/rssi', 'ttl': 0, 'n': 'rssi', 'fe': True}, 'chl': {'tf': 'senml+json', 'ot': 'ChildLock', 'e': True, 'i': 0, 'tn': 'd/1b41a7c6-8f02-42fa-9af8-868dad9be98a/s/chl', 'ttl': -1, 'n': 'chl', 'fe': True}, 'fp0': {'tf': 'senml+json', 'ot': 'FilterPresence', 'e': False, 'i': 0, 'tn': 'd/1b41a7c6-8f02-42fa-9af8-868dad9be98a/s/fp0', 'ttl': -1, 'n': 'fp0', 'fe': True}, 'pm10': {'tf': 'senml+json', 'ot': 'PM10', 'e': True, 'i': 0, 'tn': 'd/1b41a7c6-8f02-42fa-9af8-868dad9be98a/s/pm10', 'ttl': 0, 'n': 'pm10', 'fe': True}, 'h': {'tf': 'senml+json', 'ot': 'Humidity', 'e': False, 'i': 0, 'tn': 'd/1b41a7c6-8f02-42fa-9af8-868dad9be98a/s/h', 'ttl': 0, 'n': 'h', 'fe': True}, 'is': {'tf': 'senml+json', 'ot': 'IonizerState', 'e': False, 'i': 0, 'tn': 'd/1b41a7c6-8f02-42fa-9af8-868dad9be98a/s/is', 'ttl': -1, 'n': 'is', 'fe': True}, 'gs': {'tf': 'senml+json', 'ot': 'GermShield', 'e': True, 'i': 0, 'tn': 'd/1b41a7c6-8f02-42fa-9af8-868dad9be98a/s/gs', 'ttl': -1, 'n': 'gs', 'fe': True}, 'am': {'tf': 'senml+json', 'ot': 'AutoMode', 'e': True, 'i': 0, 'tn': 'd/1b41a7c6-8f02-42fa-9af8-868dad9be98a/s/am', 'ttl': -1, 'n': 'am', 'fe': True}, 'tVOCbaseline': {'t': 0, 'e': False, 'ot': 'TVOCbaseline', 'i': 60000, 'tn': 'd/1b41a7c6-8f02-42fa-9af8-868dad9be98a/s/TVOCbaseline', 'ttl': 600, 'n': 'tVOCbaseline', 'fe': True}, 'rt5m': {'tf': 'senml+json', 'ot': 'RT5m', 'e': True, 'i': 300000, 'tn': 'd/1b41a7c6-8f02-42fa-9af8-868dad9be98a/s/5m', 'sn': ['pm1', 'pm2_5', 'pm10', 't', 'h', 'tVOC'], 'ttl': 0, 'n': 'rt5m', 'fe': True}, 't': {'tf': 'senml+json', 'ot': 'Temperature', 'e': True, 'i': 0, 'tn': 'd/1b41a7c6-8f02-42fa-9af8-868dad9be98a/s/t', 'ttl': 0, 'n': 't', 'fe': True}, 'pm1c': {'tf': 'senml+json', 'ot': 'PMParticleCount', 'e': False, 'i': 0, 'tn': 'd/1b41a7c6-8f02-42fa-9af8-868dad9be98a/s/pm1c', 'ttl': 0, 'n': 'pm1c', 'fe': True}, 'b5m': {'tf': 'senml+json', 'th': ['5kb', '4h'], 'ot': 'Batch5m', 'e': True, 'i': 300000, 'tn': '$aws/rules/telemetry_ingest_rule/d/1b41a7c6-8f02-42fa-9af8-868dad9be98a/s/batch/b5m', 'sn': ['pm1', 'pm2_5', 'pm10', 't', 'h', 'tVOC', 'fsp0'], 'ttl': -1, 'n': 'b5m', 'fe': True}, 'fsp0': {'st': 'fsp0', 'tf': 'senml+json', 't': 10, 'ot': 'Fanspeed', 'e': True, 'i': 0, 'tn': 'd/1b41a7c6-8f02-42fa-9af8-868dad9be98a/s/fsp0', 'sn': ['fsp0'], 'ttl': -1, 'n': 'fsp0', 'fe': True}, 'nm': {'tf': 'senml+json', 'ot': 'NightMode', 'e': True, 'i': 0, 'tn': 'd/1b41a7c6-8f02-42fa-9af8-868dad9be98a/s/nm', 'ttl': -1, 'n': 'nm', 'fe': True}}, '_r': 'us-east-2', '_s': {'sig': 'f812cd40acae289ad965c159051abadb28ed6c8b1eb2df917fedaa135f5a69d2', 'salg': 'SHA256'}, '_t': 'Diff', '_v': 1655924801, '_cas': 1623062101, '_id': '1b41a7c6-8f02-42fa-9af8-868dad9be98a', 'fc': {'pwd': '9102revreSyrotcaF', 'ssid': 'BAFactory', 'url': ' '}, 'da': {'reboot': {'p': False, 'a': False, 'ot': 'Reboot', 'e': True, 'tn': 'd/1b41a7c6-8f02-42fa-9af8-868dad9be98a/a/reboot', 'n': 'reboot', 'fe': True}, 'uitest': {'a': 'off', 'ot': 'UiTest', 'e': True, 'tn': 'd/1b41a7c6-8f02-42fa-9af8-868dad9be98a/a/uitest', 'n': 'uitest', 'fe': True}, 'ledb': {'p': True, 'a': 0, 'tf': 'senml+json', 'ot': 'LedBrightness', 'e': True, 'tn': 'd/1b41a7c6-8f02-42fa-9af8-868dad9be98a/a/ledb', 'n': 'ledb', 'fe': True}, 'chl': {'p': True, 'a': False, 'tf': 'senml+json', 'ot': 'ChildLock', 'e': True, 'tn': 'd/1b41a7c6-8f02-42fa-9af8-868dad9be98a/a/chl', 'n': 'chl', 'fe': True}, 'sflu': {'p': False, 'a': False, 'ot': 'SensorFlush', 'e': True, 'tn': 'd/1b41a7c6-8f02-42fa-9af8-868dad9be98a/a/sflu', 'n': 'sflu', 'fe': True}, 'buttontest': {'p': False, 'a': False, 'ot': 'ButtonTest', 'e': True, 'tn': 'd/1b41a7c6-8f02-42fa-9af8-868dad9be98a/a/buttontest', 'n': 'buttontest', 'fe': True}, 'is': {'p': True, 'a': False, 'tf': 'senml+json', 'ot': 'IonizerState', 'e': True, 'tn': 'd/1b41a7c6-8f02-42fa-9af8-868dad9be98a/a/is', 'n': 'is', 'fe': True}, 'gs': {'p': True, 'a': False, 'tf': 'senml+json', 'ot': 'GermShield', 'e': True, 'tn': 'd/1b41a7c6-8f02-42fa-9af8-868dad9be98a/a/gs', 'n': 'gs', 'fe': True}, 'am': {'p': True, 'a': False, 'tf': 'senml+json', 'ot': 'AutoMode', 'e': True, 'amt': 'PM', 'tn': 'd/1b41a7c6-8f02-42fa-9af8-868dad9be98a/a/am', 'n': 'am', 'fe': True}, 'tVOCbaseline': {'a': 0, 'ot': 'TVOCbaseline', 'e': True, 'tn': 'd/1b41a7c6-8f02-42fa-9af8-868dad9be98a/a/tVOCbaseline', 'n': 'tVOCbaseline', 'fe': True}, 'sb': {'p': True, 'a': False, 'tf': 'senml+json', 'sbt': 'sensor_on', 'ot': 'Standby', 'e': True, 'tn': 'd/1b41a7c6-8f02-42fa-9af8-868dad9be98a/a/sb', 'n': 'sb', 'fe': True}, 'fsp0': {'p': True, 'st': 'fsp0', 'a': 20, 'tf': 'senml+json', 'ot': 'Fanspeed', 'e': True, 'tn': 'd/1b41a7c6-8f02-42fa-9af8-868dad9be98a/a/fsp0', 'n': 'fsp0', 'fe': True}, 'nm': {'p': True, 'maxfsp': 25, 'a': False, 'tf': 'senml+json', 'nmt': 'PM', 'ot': 'NightMode', 'ledb': 12, 'e': True, 'tn': 'd/1b41a7c6-8f02-42fa-9af8-868dad9be98a/a/nm', 'n': 'nm', 'fe': True}}, 'dc': {'cfv': {'d': 'di.cfv', 't': 'integer', 'v': 0, 'n': 'cfv'}, 'germshield': {'a': 'gs', 's': 'gs', 't': 'boolean', 'v': False, 'n': 'germshield'}, 'filterusage': {'s': 'fu0', 't': 'integer', 'v': 0, 'n': 'filterusage'}, 'brightness': {'a': 'ledb', 's': 'ledb', 't': 'integer', 'v': 100, 'n': 'brightness'}, 'standby': {'a': 'sb', 's': 'sb', 't': 'boolean', 'v': False, 'n': 'standby'}, 'fanspeed': {'a': 'fsp0', 's': 'fsp0', 't': 'integer', 'v': 11, 'n': 'fanspeed'}, 'nightmode': {'a': 'nm', 's': 'nm', 't': 'boolean', 'v': False, 'n': 'nightmode'}, 'childlock': {'a': 'chl', 's': 'chl', 't': 'boolean', 'v': False, 'n': 'childlock'}, 'safetyswitch': {'s': 'ss0', 't': 'boolean', 'v': True, 'n': 'safetyswitch'}, 'mfv': {'d': 'di.mfv', 't': 'integer', 'v': 0, 'n': 'mfv'}, 'ofv': {'d': 'di.ofv', 't': 'integer', 'v': 0, 'n': 'ofv'}, 'automode': {'a': 'am', 's': 'am', 't': 'boolean', 'v': False, 'n': 'automode'}}}, 'alarms': [], 'events': [], 'sensordata': [{'v': '0', 'n': 'pm1', 't': 1656198091}, {'v': '0', 'n': 'pm2_5', 't': 1656198091}, {'v': '0', 'n': 'pm10', 't': 1656198091}, {'v': '23', 'n': 't', 't': 1656198091}, {'v': '45', 'n': 'h', 't': 1656198091}, {'v': '170', 'n': 'tVOC', 't': 1656198091}, {'v': '11', 'n': 'fsp0', 't': 1656198091}], 'states': [{'n': 'cfv', 'v': 33554689, 't': 1656203510}, {'n': 'germshield', 'vb': True, 't': 1656203510}, {'n': 'filterusage', 'v': 1, 't': 1656203510}, {'n': 'brightness', 'v': 0, 't': 1656203510}, {'n': 'standby', 'vb': False, 't': 1656203510}, {'n': 'fanspeed', 'v': 11, 't': 1656203510}, {'n': 'nightmode', 'vb': False, 't': 1656203510}, {'n': 'childlock', 'vb': False, 't': 1656203510}, {'n': 'safetyswitch', 'vb': True, 't': 1656203510}, {'n': 'mfv', 'v': 16777228, 't': 1656203510}, {'n': 'ofv', 'v': 33554689, 't': 1656203510}, {'n': 'automode', 'vb': False, 't': 1656203510}, {'t': 1656203510, 'vb': True, 'n': 'online'}], 'welcomehome': {'setting': []}, 'fleet_info': []}]
-
-        :param device_name:
-        :param device_uuid:
-        :return:
-        """
         url = f"https://{AWS_APIKEYS[self.region]['restApiId']}.execute-api.{AWS_APIKEYS[self.region]['awsRegion']}.amazonaws.com/prod/c/{device_name}/r/initial"
         headers = {
             "Authorization": f"Bearer {await self.get_access_token()}",
@@ -196,16 +197,7 @@ class HttpAwsBlueair:
                     },
                 },
             ],
-            "includestates": True,
-            "eventsubscription": {
-                "include": [
-                    {
-                        "filter": {
-                            "o": f"= {device_uuid}",
-                        },
-                    },
-                ],
-            },
+            "includestates": True
         }
         response: ClientResponse = (
             await self._post_request_with_logging_and_errors_raised(
@@ -218,7 +210,7 @@ class HttpAwsBlueair:
     @request_with_active_session
     async def set_device_info(
         self, device_uuid, service_name, action_verb, action_value
-    ):
+    ) -> bool:
         _LOGGER.debug("set_device_info")
         url = f"https://{AWS_APIKEYS[self.region]['restApiId']}.execute-api.{AWS_APIKEYS[self.region]['awsRegion']}.amazonaws.com/prod/c/{device_uuid}/a/{service_name}"
         headers = {

blueair_api/http_blueair.py

@@ -1,3 +1,4 @@
+from typing import Any
 import logging
 
 from aiohttp import ClientSession, ClientResponse
@@ -15,9 +16,9 @@ class HttpBlueair:
         self,
         username: str,
         password: str,
-        home_host: str = None,
-        auth_token: str = None,
-        client_session: ClientSession = None,
+        home_host: str | None = None,
+        auth_token: str | None = None,
+        client_session: ClientSession | None = None,
     ):
         self.username = username
         self.password = password
@@ -44,13 +45,13 @@ class HttpBlueair:
 
     @request_with_logging
     async def _get_request_with_logging_and_errors_raised(
-        self, url: str, headers: dict = None
+        self, url: str, headers: dict | None = None
     ) -> ClientResponse:
         return await self.api_session.get(url=url, headers=headers)
 
     @request_with_logging
     async def _post_request_with_logging_and_errors_raised(
-        self, url: str, json_body: dict, headers: dict = None
+        self, url: str, json_body: dict, headers: dict | None = None
     ) -> ClientResponse:
         return await self.api_session.post(url=url, json=json_body, headers=headers)
 
@@ -99,7 +100,7 @@ class HttpBlueair:
         else:
             raise LoginError("invalid password")
 
-    async def get_devices(self) -> list[dict[str, any]]:
+    async def get_devices(self) -> list[dict[str, Any]]:
         """
         Fetch a list of devices.
 
@@ -123,7 +124,7 @@ class HttpBlueair:
         return await response.json()
 
     # Note: refreshes every 5 minutes
-    async def get_attributes(self, device_uuid: str) -> dict[str, any]:
+    async def get_attributes(self, device_uuid: str) -> dict[str, Any]:
         """
         Fetch a list of attributes for the provided device ID.
 
@@ -154,7 +155,7 @@ class HttpBlueair:
         return attributes
 
     # Note: refreshes every 5 minutes, timestamps are in seconds
-    async def get_info(self, device_uuid: str) -> dict[str, any]:
+    async def get_info(self, device_uuid: str) -> dict[str, Any]:
         """
         Fetch device information for the provided device ID.
 
@@ -177,6 +178,53 @@ class HttpBlueair:
         )
         return await response.json()
 
+    # Note: refreshes every 5 minutes, timestamps are in seconds
+    async def get_current_data_point(self, device_uuid: str) -> dict[str, Any]:
+        """
+        Fetch device information for the provided device ID.
+
+        The return value is a dictionary containing key-value pairs for the
+        available device information.
+
+        Note: the data for this API call is only updated once every 5 minutes.
+        Calling it more often will return the same response from the server and
+        should be avoided to limit server load.
+        """
+        url = f"https://{await self.get_home_host()}/v2/device/{device_uuid}/datapoint/0/last/0/"
+        headers = {
+            "X-API-KEY-TOKEN": API_KEY,
+            "X-AUTH-TOKEN": await self.get_auth_token(),
+        }
+        response: ClientResponse = (
+            await self._get_request_with_logging_and_errors_raised(
+                url=url, headers=headers
+            )
+        )
+        return await response.json()
+
+    async def get_data_points_since(self, device_uuid: str, seconds_ago: int = 0, sample_period: int = 300) -> dict[str, Any]:
+        """
+        Fetch the list of data points between a relative timestamp (in seconds) and the current time.
+
+        An optional sample period can be provided to group data points
+        together. The minimum sample period size is 300 (5 minutes).
+
+        Note: the data for the most recent data point is only updated once
+        every 5 minutes.  Calling it more often will return the same response
+        from the server and should be avoided to limit server load.
+        """
+        url = f"https://{await self.get_home_host()}/v2/device/{device_uuid}/datapoint/{seconds_ago}/last/{sample_period}/"
+        headers = {
+            "X-API-KEY-TOKEN": API_KEY,
+            "X-AUTH-TOKEN": await self.get_auth_token(),
+        }
+        response: ClientResponse = (
+            await self._get_request_with_logging_and_errors_raised(
+                url=url, headers=headers
+            )
+        )
+        return await response.json()
+
     async def set_fan_speed(self, device_uuid, new_speed: str):
         """
         Set the fan speed per @spikeyGG comment at https://community.home-assistant.io/t/blueair-purifier-addon/154456/14
@@ -205,3 +253,64 @@ class HttpBlueair:
             )
         )
         return await response.json()
+
+    async def set_brightness(self, device_uuid, new_brightness: int):
+        if new_brightness not in [0, 1, 2, 3, 4]:
+            raise Exception("Brightness not supported")
+        url = f"https://{await self.get_home_host()}/v2/device/{device_uuid}/attribute/brightness/"
+        headers = {
+            "X-API-KEY-TOKEN": API_KEY,
+            "X-AUTH-TOKEN": await self.get_auth_token(),
+        }
+        json_body = {
+            "currentValue": new_brightness,
+            "scope": "device",
+            "name": "brightness",
+            "uuid": str(device_uuid),
+        }
+        response: ClientResponse = (
+            await self._post_request_with_logging_and_errors_raised(
+                url=url, json_body=json_body, headers=headers
+            )
+        )
+        return await response.json()
+
+    async def set_child_lock(self, device_uuid, enabled: bool):
+        url = f"https://{await self.get_home_host()}/v2/device/{device_uuid}/attribute/child_lock/"
+        new_value = "1" if enabled else "0"
+        headers = {
+            "X-API-KEY-TOKEN": API_KEY,
+            "X-AUTH-TOKEN": await self.get_auth_token(),
+        }
+        json_body = {
+            "currentValue": new_value,
+            "scope": "device",
+            "name": "child_lock",
+            "uuid": str(device_uuid),
+        }
+        response: ClientResponse = (
+            await self._post_request_with_logging_and_errors_raised(
+                url=url, json_body=json_body, headers=headers
+            )
+        )
+        return await response.json()
+
+    async def set_fan_auto_mode(self, device_uuid, auto: bool):
+        url = f"https://{await self.get_home_host()}/v2/device/{device_uuid}/attribute/mode/"
+        new_value = "auto" if auto else "manual"
+        headers = {
+            "X-API-KEY-TOKEN": API_KEY,
+            "X-AUTH-TOKEN": await self.get_auth_token(),
+        }
+        json_body = {
+            "currentValue": new_value,
+            "scope": "device",
+            "name": "mode",
+            "uuid": str(device_uuid),
+        }
+        response: ClientResponse = (
+            await self._post_request_with_logging_and_errors_raised(
+                url=url, json_body=json_body, headers=headers
+            )
+        )
+        return await response.json()

blueair_api/intermediate_representation_aws.py

@@ -0,0 +1,183 @@
+import typing
+from typing import Any, TypeVar
+from collections.abc import Iterable
+import dataclasses
+import base64
+
+type ScalarType = str | float | bool | int | None
+type MappingType = dict[str, "ObjectType"]
+type SequenceType = list["ObjectType"]
+type ObjectType = ScalarType | MappingType | SequenceType
+
+
+def query_json(jsonobj: ObjectType, path: str) -> ObjectType:
+    value = jsonobj
+    segs = path.split(".")
+    for i, seg in enumerate(segs):
+        if isinstance(value, list):
+            value = value[int(seg)]
+        elif isinstance(value, dict):
+            if seg in value:
+                value = value[seg]
+            elif i == len(segs) - 1:
+                # last segment returns None if it is not found.
+                value = None
+            else:
+                raise KeyError(
+                    f"cannot resolve path segment on a scalar "
+                    f"when resolving segment {i}:{seg} of {path}. "
+                    f"available keys are {value.keys()}.")
+        else:
+            raise KeyError(
+                f"cannot resolve path segment on a scalar "
+                f"when resolving segment {i}:{seg} of {path}.")
+    return value
+
+def parse_json[T](kls: type[T], jsonobj: MappingType) -> dict[str, T]:
+    """Parses a json mapping object to dict.
+
+    The key is preserved. The value is parsed as dataclass type kls.
+    """
+    assert dataclasses.is_dataclass(kls)
+    result = {}
+    fields = dataclasses.fields(kls)
+
+    for key, value in jsonobj.items():
+        if not isinstance(value, dict):
+            raise TypeError("expecting mapping value to be dict.")
+        extra_fields = dict(value)  # make extra_fields copy.
+        kwargs : dict[str, Any] = {}
+        for field in fields:
+            if field.name == "extra_fields":
+                kwargs[field.name] = extra_fields
+            elif field.default is dataclasses.MISSING:
+                kwargs[field.name] = extra_fields.pop(field.name)
+            else:
+                kwargs[field.name] = extra_fields.pop(field.name, field.default)
+
+        obj = kls(**kwargs)
+        result[key] = typing.cast(T, obj)
+    return result
+
+
+########################
+# Blueair AWS API Schema.
+
+@dataclasses.dataclass
+class Attribute:
+    """DeviceAttribute(da); defines an attribute
+
+    An attribute is most likely mutable. An attribute may
+    also have alias names, likely derived from the 'dc' relation
+    e.g. a/sb, a/standby all refer to the 'sb' attribute.
+    """
+    extra_fields : MappingType
+    n: str   # name
+    a: int | bool   # default attribute value, example value?
+    e: bool     # ??? always True
+    fe:bool     # ???  always True
+    ot: str     # object type? topic type?
+    p: bool     # only false for reboot and sflu
+    tn: str   # topic name a path-like name d/????/a/{n}
+
+
+@dataclasses.dataclass
+class Sensor:
+    """DeviceSensor(ds); seems to define a sensor.
+
+    We never directly access these objects. Thos this defines
+    the schema for 'h', 't', 'pm10' etc that gets returned in
+    the sensor_data senml SensorPack.
+    """
+    extra_fields : MappingType
+    n: str    # name
+    i: int    # integration time? in millis
+    e: bool   # ???
+    fe: bool  # ??? always True.
+    ot: str   # object type / topic name
+    tn: str   # topic name a path-like name d/????/s/{n}
+    ttl: int  # only seen 0 or -1, not sure if used.
+    tf: str | None = None   # senml+json; topic format
+
+@dataclasses.dataclass
+class Control:
+    """DeviceControl (dc); seems to define a state.
+
+    The states SensorPack seem to be using fields defined
+    in dc. The only exception is 'online' which is not defined
+    here.
+    """
+    extra_fields : MappingType
+    n: str  # name
+    v: int | bool
+    a: str | None = None
+    s: str | None = None
+    d: str | None = None  # device info json path
+
+
+########################
+# SenML RFC8428
+
+@dataclasses.dataclass
+class Record:
+    """A RFC8428 SenML record, resolved to Python types."""
+    name: str
+    unit: str | None
+    value: float | bool | str | bytes
+    timestamp: float | None
+    integral: float | None
+
+
+class SensorPack(list[Record]):
+    """Represents a RFC8428 SensorPack, resolved to Python Types."""
+
+    def __init__(self, stream: Iterable[MappingType]):
+        seq = []
+        for record in stream:
+            rs = None
+            rt = None
+            rn : str
+            ru = None
+            rv : float | bool | str | bytes
+            for label, value in record.items():
+                assert isinstance(value, str | int | float | bool)
+                match label:
+                    case 'bn' | 'bt' | 'bu' | 'bv' | 'bs' | 'bver':
+                        raise ValueError("TODO: base fields not supported. c.f. RFC8428, 4.1")
+                    case 't':
+                        rt = float(value)
+                    case 's':
+                        rs = float(value)
+                    case 'v':
+                        rv = float(value)
+                    case 'vb':
+                        rv = bool(value)
+                    case 'vs':
+                        rv = str(value)
+                    case 'vd':
+                        rv = bytes(base64.b64decode(str(value)))
+                    case 'n':
+                        rn = str(value)
+                    case 'u':
+                        ru = str(value)
+            seq.append(Record(name=rn, unit=ru, value=rv, integral=rs, timestamp=rt))
+        super().__init__(seq)
+
+    def to_latest_value(self) -> dict[str, str | bool | float | bytes]:
+        return {rn : record.value for rn, record in self.to_latest().items()}
+
+    def to_latest(self) -> dict[str, Record]:
+        latest : dict[str, Record] = {}
+        for record in self:
+            rn = record.name
+            if record.name not in latest:
+                latest[rn] = record
+                continue
+            lt = latest[record.name].timestamp
+            if record.timestamp is None:
+                latest[rn] = record
+            elif lt is None:
+                latest[rn] = record
+            elif lt < record.timestamp:
+                latest[rn] = record
+        return latest

blueair_api/model_enum.py

@@ -0,0 +1,90 @@
+from enum import Enum, StrEnum
+
+
+class FeatureEnum(StrEnum):
+    TEMPERATURE = "Temperature"
+    HUMIDITY = "Humidity"
+    VOC = "VOC"
+    PM1 = "PM1"
+    PM10 = "PM10"
+    PM25 = "PM25"
+    WATER_SHORTAGE = "Water Shortage"
+    FILTER_EXPIRED = "Filter Expired"
+    CHILD_LOCK = "Child Lock"
+
+
+class ModelEnum(Enum):
+    def __new__(cls, *args, **kwds):
+        value = len(cls.__members__) + 1
+        obj = object.__new__(cls)
+        obj._value_ = value
+        return obj
+
+    def __init__(self,
+                 name,
+                 supported_features):
+        self.model_name = name
+        self.supported_features = supported_features
+
+    def supports_feature(self, supported_features) -> bool:
+        return supported_features in self.supported_features
+
+    UNKNOWN = "Unknown", [
+        FeatureEnum.TEMPERATURE,
+        FeatureEnum.HUMIDITY,
+        FeatureEnum.WATER_SHORTAGE,
+        FeatureEnum.VOC,
+        FeatureEnum.PM1,
+        FeatureEnum.PM10,
+        FeatureEnum.PM25,
+        FeatureEnum.FILTER_EXPIRED,
+        FeatureEnum.CHILD_LOCK,
+    ]
+    HUMIDIFIER_H35I = "Blueair Humidifier H35i", [
+        FeatureEnum.TEMPERATURE,
+        FeatureEnum.HUMIDITY,
+        FeatureEnum.WATER_SHORTAGE,
+    ]
+    PROTECT_7440I = "Blueair Protect 7440i", [
+        FeatureEnum.TEMPERATURE,
+        FeatureEnum.HUMIDITY,
+        FeatureEnum.VOC,
+        FeatureEnum.PM1,
+        FeatureEnum.PM10,
+        FeatureEnum.PM25,
+        FeatureEnum.FILTER_EXPIRED,
+        FeatureEnum.CHILD_LOCK,
+    ]
+    PROTECT_7470I = "Blueair Protect 7470i", [
+        FeatureEnum.TEMPERATURE,
+        FeatureEnum.HUMIDITY,
+        FeatureEnum.VOC,
+        FeatureEnum.PM1,
+        FeatureEnum.PM10,
+        FeatureEnum.PM25,
+        FeatureEnum.FILTER_EXPIRED,
+        FeatureEnum.CHILD_LOCK,
+    ]
+    MAX_211I = "Blueair Blue Pure 211i Max", [
+        FeatureEnum.PM1,
+        FeatureEnum.PM10,
+        FeatureEnum.PM25,
+        FeatureEnum.FILTER_EXPIRED,
+        FeatureEnum.CHILD_LOCK,
+    ]
+    MAX_311I = "Blueair Blue Pure 311i Max", [
+        FeatureEnum.PM25,
+        FeatureEnum.FILTER_EXPIRED,
+        FeatureEnum.CHILD_LOCK,
+    ]
+    MAX_411I = "Blueair Blue Pure 411i Max", [
+        FeatureEnum.PM25,
+        FeatureEnum.FILTER_EXPIRED,
+        FeatureEnum.CHILD_LOCK,
+    ]
+    T10I = "T10i ComfortPure 3-in-1 Filter/Heater/Fan", [
+        FeatureEnum.TEMPERATURE,
+        FeatureEnum.HUMIDITY,
+        FeatureEnum.PM25,
+        FeatureEnum.FILTER_EXPIRED,
+    ]

blueair_api/stub.py

@@ -1,17 +1,14 @@
 # run with "python3 src/blueair_api/stub.py"
 import logging
 import asyncio
-from threading import Event
 
 from getpass import getpass
 from pathlib import Path
 import sys
 
-# import blueair_api
-
 path_root = Path(__file__).parents[2]
 sys.path.append(str(path_root))
-from src.blueair_api import get_devices, get_aws_devices
+from src.blueair_api import get_devices, get_aws_devices, DeviceAws
 
 
 logger = logging.getLogger("src.blueair_api")
@@ -28,16 +25,15 @@ async def testing():
     password = getpass()
     try:
         api, devices = await get_aws_devices(username=username, password=password)
-        await devices[0].refresh()
-        await devices[0].set_child_lock(True)
-        logger.debug(devices[0])
+        for device in devices:
+            await device.refresh()
+            logger.debug(device)
     finally:
         if api:
             await api.cleanup_client_session()
     try:
         api, devices = await get_devices(username=username, password=password)
         for device in devices:
-            await device.init()
             await device.refresh()
             logger.debug(device)
     finally: