blueair-api 1.24.1__tar.gz → 1.25.0__tar.gz

{blueair_api-1.24.1 → blueair_api-1.25.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: blueair_api
-Version: 1.24.1
+Version: 1.25.0
 Summary: Blueair Api Wrapper
 Author-email: Brendan Dahl <dahl.brendan@gmail.com>
 Project-URL: Homepage, https://github.com/dahlb/blueair_api

{blueair_api-1.24.1 → blueair_api-1.25.0}/pyproject.toml

@@ -8,7 +8,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "blueair_api"
-version = "1.24.1"
+version = "1.25.0"
 authors = [
   { name="Brendan Dahl", email="dahl.brendan@gmail.com" },
 ]

{blueair_api-1.24.1 → blueair_api-1.25.0}/src/blueair_api/device_aws.py

@@ -1,5 +1,6 @@
 import dataclasses
 import logging
+from json import dumps
 
 from .callbacks import CallbacksMixin
 from .http_aws_blueair import HttpAwsBlueair
@@ -64,6 +65,7 @@ class DeviceAws(CallbacksMixin):
     async def refresh(self):
         _LOGGER.debug(f"refreshing blueair device aws: {self}")
         info = await self.api.device_info(self.name_api, self.uuid)
+        _LOGGER.debug(dumps(info, indent=2))
         sensor_data = convert_api_array_to_dict(info["sensordata"])
         self.pm1 = safely_get_json_value(sensor_data, "pm1", int)
         self.pm2_5 = safely_get_json_value(sensor_data, "pm2_5", int)

{blueair_api-1.24.1 → blueair_api-1.25.0}/src/blueair_api.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: blueair_api
-Version: 1.24.1
+Version: 1.25.0
 Summary: Blueair Api Wrapper
 Author-email: Brendan Dahl <dahl.brendan@gmail.com>
 Project-URL: Homepage, https://github.com/dahlb/blueair_api

{blueair_api-1.24.1 → blueair_api-1.25.0}/src/blueair_api.egg-info/SOURCES.txt

@@ -18,4 +18,5 @@ src/blueair_api.egg-info/PKG-INFO
 src/blueair_api.egg-info/SOURCES.txt
 src/blueair_api.egg-info/dependency_links.txt
 src/blueair_api.egg-info/requires.txt
-src/blueair_api.egg-info/top_level.txt
+src/blueair_api.egg-info/top_level.txt
+tests/test_device_aws.py

blueair_api-1.25.0/tests/test_device_aws.py

@@ -0,0 +1,295 @@
+"""Tests for DeviceAws.
+
+Here is one way to run it:
+
+First install the package in developer mode
+
+    $ pip install -e .
+
+Then use pytest to drive the tests
+
+    $ pytest tests
+"""
+
+from typing import Any
+
+from importlib import resources
+from unittest import mock
+from unittest import IsolatedAsyncioTestCase
+
+import pytest
+
+from blueair_api.device_aws import DeviceAws
+from blueair_api.model_enum import ModelEnum
+from blueair_api import http_aws_blueair
+
+class FakeDeviceInfoHelper:
+    """Fake for the 'device info' interface of HttpAwsBlueAir class."""
+    def __init__(self, info: dict[str, Any]):
+        self.info = info
+
+    async def device_info(self, *args, **kwargs):
+        return self.info
+
+    async def set_device_info(self, device_uuid, service_name, action_verb, action_value):
+        # this function seems to be only updating the states consider rename the method.
+        # action_verb seems to be a type annotation:
+        # c.f. senml: https://www.rfc-editor.org/rfc/rfc8428.html#section-5
+        # the senml parsing library (utils.py) could use some additional love.
+        # to make it more conformal to the RFC standard.
+        for state in self.info['states']:
+            if state['n'] == service_name:
+                break
+        else:
+            state = {'n': service_name}
+            self.info['states'].append(state)
+        # Watch out: mutate after append produces desired mutation to info.
+        state[action_verb] = action_value
+
+class DeviceAwsTestBase(IsolatedAsyncioTestCase):
+
+    def setUp(self):
+
+        patcher = mock.patch('blueair_api.http_aws_blueair.HttpAwsBlueair', autospec=True)
+        self.api_class = patcher.start()
+        self.addCleanup(patcher.stop)
+        self.api = self.api_class(username="fake-username", password="fake-password")
+
+        self.device = DeviceAws(self.api, name_api="fake-name-api", uuid="fake-uuid", name="fake-name",
+mac="fake-mac", type_name='fake-type-name')
+
+        self.device_info_helper = FakeDeviceInfoHelper({"sensordata": {}, "states": []})
+
+        self.api.device_info.side_effect = self.device_info_helper.device_info
+        self.api.set_device_info.side_effect = self.device_info_helper.set_device_info
+
+
+class DeviceAwsSetterTest(DeviceAwsTestBase):
+    """Tests for all of the setters."""
+
+    async def test_brightness(self):
+        # test cache works
+        self.device.brightness = None
+        await self.device.set_brightness(1)
+        assert self.device.brightness == 1
+
+        # test refresh works
+        await self.device.set_brightness(2)
+        self.device.brightness = None
+        await self.device.refresh()
+        assert self.device.brightness == 2
+
+    async def test_fan_speed(self):
+        # test cache works
+        self.device.fan_speed = None
+        await self.device.set_fan_speed(1)
+        assert self.device.fan_speed == 1
+
+        # test refresh works
+        await self.device.set_fan_speed(2)
+        self.device.fan_speed = None
+        await self.device.refresh()
+        assert self.device.fan_speed == 2
+
+    async def test_running(self):
+        # test cache works
+        self.device.running = None
+        await self.device.set_running(False)
+        assert self.device.running is False
+
+        # test refresh works
+        await self.device.set_running(True)
+        self.device.running = None
+        await self.device.refresh()
+        assert self.device.running is True
+
+    async def test_fan_auto_mode(self):
+        # test cache works
+        self.device.fan_auto_mode = None
+        await self.device.set_fan_auto_mode(False)
+        assert self.device.fan_auto_mode is False
+
+        # test refresh works
+        await self.device.set_fan_auto_mode(True)
+        self.device.fan_auto_mode = None
+        await self.device.refresh()
+        assert self.device.fan_auto_mode is True
+
+    async def test_auto_regulated_humidity(self):
+        # test cache works
+        self.device.auto_regulated_humidity = None
+        await self.device.set_auto_regulated_humidity(1)
+        assert self.device.auto_regulated_humidity == 1
+
+        # test refresh works
+        await self.device.set_auto_regulated_humidity(2)
+        self.device.auto_regulated_humidity = None
+        await self.device.refresh()
+        assert self.device.auto_regulated_humidity == 2
+
+    async def test_child_lock(self):
+        # test cache works
+        self.device.child_lock = None
+        await self.device.set_child_lock(False)
+        assert self.device.child_lock is False
+
+        # test refresh works
+        await self.device.set_child_lock(True)
+        self.device.child_lock = None
+        await self.device.refresh()
+        assert self.device.child_lock is True
+
+    async def test_night_mode(self):
+        # test cache works
+        self.device.night_mode = None
+        await self.device.set_night_mode(False)
+        assert self.device.night_mode is False
+
+        # test refresh works
+        await self.device.set_night_mode(True)
+        self.device.night_mode = None
+        await self.device.refresh()
+        assert self.device.night_mode is True
+
+    async def test_wick_dry_mode(self):
+        # test cache works
+        self.device.wick_dry_mode = None
+        await self.device.set_wick_dry_mode(False)
+        assert self.device.wick_dry_mode is False
+
+        # test refresh works
+        await self.device.set_wick_dry_mode(True)
+        self.device.wick_dry_mode = None
+        await self.device.refresh()
+        assert self.device.wick_dry_mode is True
+
+
+class UnavailableDeviceAwsTest(DeviceAwsTestBase):
+    """Tests for a fake device.
+
+    For this fake device, all attrs are unavailable.
+
+    Other device types shall override setUp and populate self.info with the
+    golden dataset.
+    """
+
+    async def test_attributes(self):
+
+        await self.device.refresh()
+        self.api.device_info.assert_awaited_with("fake-name-api", "fake-uuid")
+
+        device = self.device
+
+        assert device.model == ModelEnum.UNKNOWN
+
+        assert device.pm1 is None
+        assert device.pm2_5 is None
+        assert device.pm10 is None
+        assert device.tVOC is None
+        assert device.temperature is None
+        assert device.humidity is None
+        assert device.name is None
+        assert device.firmware is None
+        assert device.mcu_firmware is None
+        assert device.serial_number is None
+        assert device.sku is None
+
+        assert device.running is False
+        assert device.night_mode is None
+        assert device.germ_shield is None
+        assert device.brightness is None
+        assert device.child_lock is None
+        assert device.fan_speed is None
+        assert device.fan_auto_mode is None
+        assert device.filter_usage is None
+        assert device.wifi_working is None
+        assert device.wick_usage is None
+        assert device.auto_regulated_humidity is None
+        assert device.water_shortage is None
+
+
+class H35iTest(DeviceAwsTestBase):
+    """Tests for H35i."""
+
+    def setUp(self):
+        super().setUp()
+        info = eval(resources.files().joinpath('device_info/H35i.txt').read_text())
+        self.device_info_helper.info.update(info)
+
+    async def test_attributes(self):
+
+        await self.device.refresh()
+        self.api.device_info.assert_awaited_with("fake-name-api", "fake-uuid")
+
+        device = self.device
+
+        assert device.model == ModelEnum.HUMIDIFIER_H35I
+
+        assert device.pm1 is None
+        assert device.pm2_5 is None
+        assert device.pm10 is None
+        assert device.tVOC is None
+        assert device.temperature == 19
+        assert device.humidity == 50
+        assert device.name == "Bedroom"
+        assert device.firmware == "1.0.1"
+        assert device.mcu_firmware == "1.0.1"
+        assert device.serial_number == "111163300201110210004036"
+        assert device.sku == "111633"
+
+        assert device.running is True
+        assert device.night_mode is False
+        assert device.germ_shield is None
+        assert device.brightness == 49
+        assert device.child_lock is False
+        assert device.fan_speed == 24
+        assert device.fan_auto_mode is False
+        assert device.filter_usage is None
+        assert device.wifi_working is True
+        assert device.wick_usage == 13
+        assert device.auto_regulated_humidity == 50
+        assert device.water_shortage is False
+
+
+class T10iTest(DeviceAwsTestBase):
+    """Tests for T10i."""
+
+    def setUp(self):
+        super().setUp()
+        info = eval(resources.files().joinpath('device_info/T10i.txt').read_text())
+        self.device_info_helper.info.update(info)
+
+    async def test_attributes(self):
+
+        await self.device.refresh()
+        self.api.device_info.assert_awaited_with("fake-name-api", "fake-uuid")
+
+        device = self.device
+
+        assert device.model == ModelEnum.T10I
+
+        assert device.pm1 is None
+        assert device.pm2_5 == 0
+        assert device.pm10 is None
+        assert device.tVOC is None
+        assert device.temperature == 18
+        assert device.humidity == 28
+        assert device.name == "Allen's Office"
+        assert device.firmware == "1.0.4"
+        assert device.mcu_firmware == "1.0.4"
+        assert device.serial_number == "111212400002313210001961"
+        assert device.sku == "112124"
+
+        assert device.running is True
+        assert device.night_mode is None
+        assert device.germ_shield is None
+        assert device.brightness == 100
+        assert device.child_lock is False
+        assert device.fan_speed is None
+        assert device.fan_auto_mode is None
+        assert device.filter_usage == 0
+        assert device.wifi_working is True
+        assert device.wick_usage is None
+        assert device.auto_regulated_humidity is None
+        assert device.water_shortage is None
+