blebox-uniapi 2.4.2__tar.gz → 2.5.1__tar.gz

{blebox_uniapi-2.4.2 → blebox_uniapi-2.5.1}/HISTORY.rst

@@ -1,6 +1,14 @@
 =======
 History
 =======
+2.5.1 (2026-04-21)
+------------------
+* fix: multisensor current and energy sensor scales
+
+2.5.0 (2024-08-20)
+------------------
+* feature: expose sensor_id in sensors and alias in all features by @swistakm in https://github.com/blebox/blebox_uniapi/pull/176
+
 2.4.2 (2024-06-04)
 ------------------
 * fix: add missing support for active power sensors on switchbox/switchboxd devices by @swistakm in https://github.com/blebox/blebox_uniapi/pull/175

{blebox_uniapi-2.4.2 → blebox_uniapi-2.5.1}/PKG-INFO

@@ -1,12 +1,13 @@
 Metadata-Version: 2.1
 Name: blebox_uniapi
-Version: 2.4.2
+Version: 2.5.1
 Summary: Python API for accessing BleBox smart home devices
 Home-page: https://github.com/blebox/blebox_uniapi
 Author: BleBox
 Author-email: opensource@blebox.eu
 License: Apache Software License 2.0
 Keywords: blebox_uniapi
+Platform: UNKNOWN
 Classifier: Development Status :: 2 - Pre-Alpha
 Classifier: Intended Audience :: Developers
 Classifier: License :: OSI Approved :: Apache Software License
@@ -16,8 +17,6 @@ Classifier: Programming Language :: Python :: 3.10
 Requires-Python: >=3.9
 Description-Content-Type: text/x-rst
 License-File: LICENSE
-Requires-Dist: aiohttp>=3
-Requires-Dist: jmespath>1.0.0
 
 ====================
 BleBox Python UniAPI
@@ -57,6 +56,14 @@ Credits
 =======
 History
 =======
+2.5.1 (2026-04-21)
+------------------
+* fix: multisensor current and energy sensor scales
+
+2.5.0 (2024-08-20)
+------------------
+* feature: expose sensor_id in sensors and alias in all features by @swistakm in https://github.com/blebox/blebox_uniapi/pull/176
+
 2.4.2 (2024-06-04)
 ------------------
 * fix: add missing support for active power sensors on switchbox/switchboxd devices by @swistakm in https://github.com/blebox/blebox_uniapi/pull/175
@@ -220,3 +227,5 @@ History
 ------------------
 
 * First release on PyPI.
+
+

{blebox_uniapi-2.4.2 → blebox_uniapi-2.5.1}/blebox_uniapi/__init__.py

@@ -2,4 +2,4 @@
 
 __author__ = """BleBox"""
 __email__ = "opensource@blebox.eu"
-__version__ = "2.4.2"
+__version__ = "2.5.1"

{blebox_uniapi-2.4.2 → blebox_uniapi-2.5.1}/blebox_uniapi/feature.py

@@ -42,6 +42,10 @@ class Feature:
     def product(self) -> "Box":
         return self._product
 
+    @property
+    def alias(self):
+        return self._alias
+
     # TODO: (cleanup) move to product/box ?
     def raw_value(self, name: str) -> Any:
         product = self._product

{blebox_uniapi-2.4.2 → blebox_uniapi-2.5.1}/blebox_uniapi/sensor.py

@@ -73,7 +73,10 @@ class SensorFactory:
                     }
 
                     feature = constructor(
-                        product=product, alias=alias, methods=materialized_methods
+                        product=product,
+                        alias=alias,
+                        methods=materialized_methods,
+                        sensor_id=sensor_id,
                     )
                     object_list.append(feature)
 
@@ -98,11 +101,18 @@ class BaseSensor(Feature):
     _device_class: str
     _native_value: Union[float, int, str]
     _sensor_type: Optional[str]
+    _sensor_id: Optional[int]
 
     def __init__(
-        self, product: "Box", alias: str, methods: dict, sensor_type: str = None
+        self,
+        product: "Box",
+        alias: str,
+        methods: dict,
+        sensor_type: str = None,
+        sensor_id: Optional[int] = None,
     ):
         self._sensor_type = sensor_type
+        self._sensor_id = sensor_id
         super().__init__(product, alias, methods)
 
     @property
@@ -117,6 +127,14 @@ class BaseSensor(Feature):
     def native_value(self):
         return self._native_value
 
+    @property
+    def sensor_id(self):
+        return self._sensor_id
+
+    @property
+    def probe_id(self):
+        return self.sensor_id
+
     @classmethod
     def many_from_config(cls, product, box_type_config, extended_state):
         raise NotImplementedError("Please use SensorFactory")
@@ -126,13 +144,13 @@ class BaseSensor(Feature):
 
 
 @SensorFactory.register("frequency", unit="Hz", scale=1_000)
-@SensorFactory.register("current", unit="mA", scale=1_000)
+@SensorFactory.register("current", unit="mA")
 @SensorFactory.register("voltage", unit="V", scale=10)
 @SensorFactory.register("apparentPower", unit="va")
 @SensorFactory.register("reactivePower", unit="var")
 @SensorFactory.register("activePower", unit="W")
-@SensorFactory.register("reverseActiveEnergy", unit="kWh")
-@SensorFactory.register("forwardActiveEnergy", unit="kWh")
+@SensorFactory.register("reverseActiveEnergy", unit="kWh", scale=1_000)
+@SensorFactory.register("forwardActiveEnergy", unit="kWh", scale=1_000)
 @SensorFactory.register("illuminance", unit="lx", scale=100)
 @SensorFactory.register("humidity", unit="percentage", scale=100)
 @SensorFactory.register("wind", unit="m/s", scale=10)
@@ -143,6 +161,7 @@ class GenericSensor(BaseSensor):
         product: "Box",
         alias: str,
         methods: dict,
+        sensor_id: Optional[int],
         *,
         # generalization params
         sensor_type: str,
@@ -150,7 +169,7 @@ class GenericSensor(BaseSensor):
         scale: float = 1,
         precision: Optional[int] = None,
     ):
-        super().__init__(product, alias, methods)
+        super().__init__(product, alias, methods, sensor_id=sensor_id)
         self._unit = unit
         self._scale = scale
         self._precision = precision
@@ -200,8 +219,14 @@ class PowerConsumption(GenericSensor):
 class Temperature(BaseSensor):
     _current: Union[float, int, None]
 
-    def __init__(self, product: "Box", alias: str, methods: dict):
-        super().__init__(product, alias, methods)
+    def __init__(
+        self,
+        product: "Box",
+        alias: str,
+        methods: dict,
+        sensor_id: Optional[int] = None,
+    ):
+        super().__init__(product, alias, methods, sensor_id=sensor_id)
         self._unit = "celsius"
         self._device_class = "temperature"
 
@@ -227,8 +252,14 @@ class Temperature(BaseSensor):
 class AirQuality(BaseSensor):
     _pm: Optional[int]
 
-    def __init__(self, product: "Box", alias: str, methods: dict):
-        super().__init__(product, alias, methods)
+    def __init__(
+        self,
+        product: "Box",
+        alias: str,
+        methods: dict,
+        sensor_id: Optional[str] = None,
+    ):
+        super().__init__(product, alias, methods, sensor_id)
         self._unit = "concentration_of_mp"
         self._device_class = alias
 

{blebox_uniapi-2.4.2 → blebox_uniapi-2.5.1}/blebox_uniapi.egg-info/PKG-INFO

@@ -1,12 +1,13 @@
 Metadata-Version: 2.1
-Name: blebox_uniapi
-Version: 2.4.2
+Name: blebox-uniapi
+Version: 2.5.1
 Summary: Python API for accessing BleBox smart home devices
 Home-page: https://github.com/blebox/blebox_uniapi
 Author: BleBox
 Author-email: opensource@blebox.eu
 License: Apache Software License 2.0
 Keywords: blebox_uniapi
+Platform: UNKNOWN
 Classifier: Development Status :: 2 - Pre-Alpha
 Classifier: Intended Audience :: Developers
 Classifier: License :: OSI Approved :: Apache Software License
@@ -16,8 +17,6 @@ Classifier: Programming Language :: Python :: 3.10
 Requires-Python: >=3.9
 Description-Content-Type: text/x-rst
 License-File: LICENSE
-Requires-Dist: aiohttp>=3
-Requires-Dist: jmespath>1.0.0
 
 ====================
 BleBox Python UniAPI
@@ -57,6 +56,14 @@ Credits
 =======
 History
 =======
+2.5.1 (2026-04-21)
+------------------
+* fix: multisensor current and energy sensor scales
+
+2.5.0 (2024-08-20)
+------------------
+* feature: expose sensor_id in sensors and alias in all features by @swistakm in https://github.com/blebox/blebox_uniapi/pull/176
+
 2.4.2 (2024-06-04)
 ------------------
 * fix: add missing support for active power sensors on switchbox/switchboxd devices by @swistakm in https://github.com/blebox/blebox_uniapi/pull/175
@@ -220,3 +227,5 @@ History
 ------------------
 
 * First release on PyPI.
+
+

{blebox_uniapi-2.4.2 → blebox_uniapi-2.5.1}/blebox_uniapi.egg-info/SOURCES.txt

@@ -34,15 +34,4 @@ docs/index.rst
 docs/installation.rst
 docs/make.bat
 docs/readme.rst
-docs/usage.rst
-tests/test_box.py
-tests/test_box_types.py
-tests/test_button.py
-tests/test_climate.py
-tests/test_cover.py
-tests/test_light.py
-tests/test_light_unit.py
-tests/test_sensor.py
-tests/test_session.py
-tests/test_switch.py
-tests/test_unknown.py
+docs/usage.rst

{blebox_uniapi-2.4.2 → blebox_uniapi-2.5.1}/setup.cfg

@@ -1,5 +1,5 @@
 [bumpversion]
-current_version = 2.4.2
+current_version = 2.5.1
 commit = True
 tag = True
 

{blebox_uniapi-2.4.2 → blebox_uniapi-2.5.1}/setup.py

@@ -23,7 +23,7 @@ test_requirements = [
 ]
 
 setup(
-    version="2.4.2",
+    version="2.5.1",
     author="BleBox",
     author_email="opensource@blebox.eu",
     python_requires=">=3.9",

blebox_uniapi-2.4.2/tests/test_box.py

@@ -1,169 +0,0 @@
-import pytest
-from unittest import mock
-from blebox_uniapi.box import Box
-from blebox_uniapi import error
-from blebox_uniapi.jfollow import follow
-
-pytestmark = pytest.mark.asyncio
-
-
-@pytest.fixture
-def mock_session():
-    return mock.MagicMock(host="172.1.2.3", port=80)
-
-
-@pytest.fixture
-def sample_data():
-    return {
-        "id": "abcd1234ef",
-        "type": "airSensor",
-        "deviceName": "foobar",
-        "fv": "1.23",
-        "hv": "4.56",
-        "apiLevel": "20180403",
-    }
-
-
-@pytest.fixture
-def config(sample_data):
-    return Box._match_device_config(sample_data)
-
-
-async def test_without_type(mock_session, sample_data, config):
-    del sample_data["type"]
-
-    with pytest.raises(error.UnsupportedBoxResponse, match="has no type"):
-        Box(mock_session, sample_data, config, None)
-
-
-async def test_with_unknown_type(mock_session, sample_data):
-    sample_data["type"] = "unknownBox"
-
-    with pytest.raises(error.UnsupportedBoxResponse, match="not a supported type"):
-        Box._match_device_config(sample_data)
-
-
-async def test_without_name(mock_session, sample_data, config):
-    del sample_data["deviceName"]
-
-    with pytest.raises(error.UnsupportedBoxResponse, match="has no name"):
-        Box(mock_session, sample_data, config, None)
-
-
-async def test_without_firmware_version(mock_session, sample_data, config):
-    del sample_data["fv"]
-
-    with pytest.raises(error.UnsupportedBoxResponse, match="has no firmware version"):
-        Box(mock_session, sample_data, config, None)
-
-
-async def test_without_hardware_version(mock_session, sample_data, config):
-    del sample_data["hv"]
-
-    with pytest.raises(error.UnsupportedBoxResponse, match="has no hardware version"):
-        Box(mock_session, sample_data, config, None)
-
-
-async def test_without_api_level(mock_session, sample_data, config):
-    del sample_data["apiLevel"]
-
-    with pytest.raises(error.UnsupportedBoxVersion, match=r"unsupported version"):
-        Box._match_device_config(sample_data)
-
-
-async def test_json_path_extraction(mock_session, sample_data, config):
-    # note: follow is thin wrapper over jmespath so there's no real reason to test it.
-    # However, this tests makes sure we understand the syntax and know how it works.
-    # We can also use it as a canary for any unexpected change in syntax that may come
-    # in newer version.
-
-    # succesfull extraction
-    assert follow(["foo"], "[0]") == "foo"
-    assert follow([{"foo": "3", "value": 4}], "[?foo=='3'].value") == [4]
-
-    # "dud" extraction
-    assert follow([{"foo": "ab", "value": 4}], "[?foo=='bc'].value") == []
-    assert follow([{"value": 4}], "[1].value") is None
-    assert follow({"value": 4}, "foo") is None
-    assert follow({"foo": [4]}, "[?bar==`0`].value") is None
-
-
-async def test_missing_device_id(mock_session, sample_data, config):
-    del sample_data["id"]
-    with pytest.raises(error.UnsupportedBoxResponse, match="has no id"):
-        Box(mock_session, sample_data, config, None)
-
-
-# Add more test cases for other missing fields (type, name, versions, etc.)
-
-
-async def test_invalid_init(mock_session, sample_data, config):
-    with mock.patch(
-        "blebox_uniapi.sensor.SensorFactory.many_from_config",
-        spec_set=True,
-        autospec=True,
-    ) as mock_sensor:
-        mock_sensor.side_effect = KeyError
-        with pytest.raises(
-            error.UnsupportedBoxResponse, match=r"Failed to initialize:"
-        ):
-            Box(mock_session, sample_data, config, None)
-
-
-async def test_properties(mock_session, sample_data, config):
-    box = Box(mock_session, sample_data, config, None)
-    assert box.name == "foobar"
-    assert box.last_data is None
-    assert box.type == "airSensor"
-    assert box.model == "airSensor"
-    assert box.unique_id == "abcd1234ef"
-    assert box.firmware_version == "1.23"
-    assert box.hardware_version == "4.56"
-    assert box.brand == "BleBox"
-    assert box.api_version == 20180403
-    assert box.address == "172.1.2.3:80"
-
-
-async def test_field_validations(mock_session, sample_data, config):
-    box = Box(mock_session, sample_data, config, None)
-
-    with pytest.raises(
-        error.BadFieldExceedsMax,
-        match=r"foobar.field1 is 123 which exceeds max \(100\)",
-    ):
-        box.check_int_range(123, "field1", 100, 0)
-
-    with pytest.raises(
-        error.BadFieldLessThanMin,
-        match=r"foobar.field1 is 123 which is less than minimum \(200\)",
-    ):
-        box.check_int_range(123, "field1", 300, 200)
-
-    with pytest.raises(error.BadFieldMissing, match=r"foobar.field1 is missing"):
-        box.check_int(None, "field1", 300, 200)
-
-    with pytest.raises(
-        error.BadFieldNotANumber, match=r"foobar.field1 is '123' which is not a number"
-    ):
-        box.check_int("123", "field1", 300, 200)
-
-    with pytest.raises(error.BadFieldMissing, match=r"foobar.field1 is missing"):
-        box.check_hex_str(None, "field1", 300, 200)
-
-    with pytest.raises(
-        error.BadFieldNotAString, match=r"foobar.field1 is 123 which is not a string"
-    ):
-        box.check_hex_str(123, "field1", 300, 200)
-
-    with pytest.raises(error.BadFieldMissing, match=r"foobar.field1 is missing"):
-        box.check_rgbw(None, "field1")
-
-    with pytest.raises(
-        error.BadFieldNotAString, match=r"foobar.field1 is 123 which is not a string"
-    ):
-        box.check_rgbw(123, "field1")
-
-    with pytest.raises(
-        error.BadFieldNotRGBW, match=r"foobar.field1 is 123 which is not a rgbw string"
-    ):
-        box.check_rgbw("123", "field1")

blebox_uniapi-2.4.2/tests/test_box_types.py

@@ -1,80 +0,0 @@
-from random import choice
-
-from blebox_uniapi.box_types import (
-    BOX_TYPE_CONF,
-    get_conf,
-    get_conf_set,
-    get_latest_api_level,
-    get_latest_conf,
-)
-
-
-class TestBoxTypesOrder:
-    def test_conf_order(self):
-        for device_type, conf_set in BOX_TYPE_CONF.items():
-            api_levels = list(conf_set.keys())
-            sorted_api_levels = sorted(api_levels)
-
-            assert (
-                api_levels == sorted_api_levels
-            ), f"Entries for '{device_type}' are not ordered by API level."
-
-
-class TestBoxTypes:
-    box_types = tuple(BOX_TYPE_CONF.keys())
-    simple_conf_set = {5: {"tag": "first_entry"}, 10: {"tag": "second_entry"}}
-
-    async def test_get_conf_set_valid(self):
-        conf_set = get_conf_set(choice(self.box_types))
-
-        assert isinstance(conf_set, dict)
-        assert conf_set != {}
-
-    async def test_get_conf_set_invalid(self):
-        conf_set = get_conf_set("nonexistent_type")
-
-        assert isinstance(conf_set, dict)
-        assert conf_set == {}
-
-    async def test_get_conf_valid(self):
-        """Test choosing functionality of get_conf function on exemplary conf_set."""
-        for api_level, tag_value in (
-            (5, "first_entry"),  # a marginal example
-            (7, "first_entry"),  # 'in between' example
-            (10, "second_entry"),  # a marginal example
-            (17, "second_entry"),  # future example
-        ):
-            conf = get_conf(api_level, self.simple_conf_set)
-
-            assert isinstance(conf, dict)
-            assert conf["tag"] == tag_value
-
-    async def test_get_conf_invalid(self):
-        conf = get_conf(3, self.simple_conf_set)  # not supported example
-
-        assert isinstance(conf, dict)
-        assert conf == {}
-
-    async def test_get_latest_conf_valid(self):
-        conf = get_latest_conf(choice(self.box_types))
-
-        assert isinstance(conf, dict)
-        assert conf != {}
-
-    async def test_get_latest_conf_invalid(self):
-        conf = get_latest_conf("nonexistent_type")
-
-        assert isinstance(conf, dict)
-        assert conf == {}
-
-    async def test_get_latest_api_level_valid(self):
-        api_level = get_latest_api_level(choice(self.box_types))
-
-        assert isinstance(api_level, int)
-        assert api_level
-
-    async def test_get_latest_api_level_invalid(self):
-        api_level = get_latest_api_level("nonexistent_type")
-
-        assert isinstance(api_level, int)
-        assert not api_level

blebox_uniapi-2.4.2/tests/test_button.py

@@ -1,49 +0,0 @@
-from unittest.mock import Mock
-import pytest
-
-from blebox_uniapi.button import Button
-from blebox_uniapi.box import Box
-from blebox_uniapi.box_types import BOX_TYPE_CONF
-
-
-@pytest.fixture
-def product():
-    return Mock(spec=Box)
-
-
-@pytest.fixture
-def tv_lift_box_0(product):
-    product.type = "tvLiftBox"
-    extended_state = {"tvLift": {"controlType": 4}}
-    many = Button.many_from_config(
-        product,
-        BOX_TYPE_CONF["tvLiftBox"][20200518]["buttons"],
-        extended_state=extended_state,
-    )
-    assert len(many) == 3
-    return many[0]
-
-
-@pytest.fixture
-def tv_lift_box_1(product):
-    product.type = "tvLiftBox"
-    extended_state = {"tvLift": {"controlType": 4}}
-    many = Button.many_from_config(
-        product,
-        BOX_TYPE_CONF["tvLiftBox"][20200518]["buttons"],
-        extended_state=extended_state,
-    )
-    assert len(many) == 3
-    return many[1]
-
-
-async def test_tv_lift_0_box_pressed(tv_lift_box_0: Button, product: Box):
-    await tv_lift_box_0.set()
-    product.async_api_command.assert_called_with("set", "open_or_stop")
-    assert tv_lift_box_0.control_type
-
-
-async def test_tv_lift_1_box_pressed(tv_lift_box_1: Button, product: Box):
-    await tv_lift_box_1.set()
-    product.async_api_command.assert_called_with("set", "close_or_stop")
-    assert tv_lift_box_1.control_type