blebox-uniapi 2.2.2__tar.gz → 2.4.0__tar.gz

{blebox_uniapi-2.2.2 → blebox_uniapi-2.4.0}/HISTORY.rst

@@ -1,6 +1,22 @@
 =======
 History
 =======
+2.4.0 (2024-06-03)
+------------------
+* Fix: Refactor sensor_factory by @Pastucha in https://github.com/blebox/blebox_uniapi/pull/163
+* Order in BOX_TYPES by @Pastucha in https://github.com/blebox/blebox_uniapi/pull/164
+* Feature: smart meter by @swistakm in https://github.com/blebox/blebox_uniapi/pull/168
+* Smartmeter by @pvsti in https://github.com/blebox/blebox_uniapi/pull/170
+* fix: resolve regressions in cover and climate due to jmespath introduction by @swistakm in https://github.com/blebox/blebox_uniapi/pull/173
+
+2.3.0 (2024-03-13)
+------------------
+* feat: add new methods to cover feature enabling handling of tilt open/close actions by @swistakm in https://github.com/blebox/blebox_uniapi/pull/154
+* add support for flood sensing for multisensors as binary moisture sensor by @swistakm in https://github.com/blebox/blebox_uniapi/pull/153
+* feat/fix: Add Ruff and Pre-commit Configuration, Resolve Undefined Name by @Pastucha in https://github.com/blebox/blebox_uniapi/pull/158
+* gatebox and shutterbox improvements: by @swistakm in https://github.com/blebox/blebox_uniapi/pull/156
+* BleBox Multisensor Illuminance Integration by @Pastucha in https://github.com/blebox/blebox_uniapi/pull/161
+
 2.2.2 (2024-02-07)
 ------------------
 * fixed wind reading units to get proper raw m/s value (division by 10, see PR #150)

{blebox_uniapi-2.2.2 → blebox_uniapi-2.4.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: blebox_uniapi
-Version: 2.2.2
+Version: 2.4.0
 Summary: Python API for accessing BleBox smart home devices
 Home-page: https://github.com/blebox/blebox_uniapi
 Author: BleBox
@@ -14,8 +14,10 @@ Classifier: Natural Language :: English
 Classifier: Programming Language :: Python :: 3.9
 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
@@ -67,6 +69,22 @@ Credits
 =======
 History
 =======
+2.4.0 (2024-06-03)
+------------------
+* Fix: Refactor sensor_factory by @Pastucha in https://github.com/blebox/blebox_uniapi/pull/163
+* Order in BOX_TYPES by @Pastucha in https://github.com/blebox/blebox_uniapi/pull/164
+* Feature: smart meter by @swistakm in https://github.com/blebox/blebox_uniapi/pull/168
+* Smartmeter by @pvsti in https://github.com/blebox/blebox_uniapi/pull/170
+* fix: resolve regressions in cover and climate due to jmespath introduction by @swistakm in https://github.com/blebox/blebox_uniapi/pull/173
+
+2.3.0 (2024-03-13)
+------------------
+* feat: add new methods to cover feature enabling handling of tilt open/close actions by @swistakm in https://github.com/blebox/blebox_uniapi/pull/154
+* add support for flood sensing for multisensors as binary moisture sensor by @swistakm in https://github.com/blebox/blebox_uniapi/pull/153
+* feat/fix: Add Ruff and Pre-commit Configuration, Resolve Undefined Name by @Pastucha in https://github.com/blebox/blebox_uniapi/pull/158
+* gatebox and shutterbox improvements: by @swistakm in https://github.com/blebox/blebox_uniapi/pull/156
+* BleBox Multisensor Illuminance Integration by @Pastucha in https://github.com/blebox/blebox_uniapi/pull/161
+
 2.2.2 (2024-02-07)
 ------------------
 * fixed wind reading units to get proper raw m/s value (division by 10, see PR #150)

{blebox_uniapi-2.2.2 → blebox_uniapi-2.4.0}/blebox_uniapi/__init__.py

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

{blebox_uniapi-2.2.2 → blebox_uniapi-2.4.0}/blebox_uniapi/binary_sensor.py

@@ -1,7 +1,10 @@
-from typing import Union
+from typing import Union, TYPE_CHECKING
 
 from .feature import Feature
 
+if TYPE_CHECKING:
+    from .box import Box
+
 
 class BinarySensor(Feature):
     """Class representing sensor with bool state."""
@@ -13,17 +16,26 @@ class BinarySensor(Feature):
     def many_from_config(
         cls, product, box_type_config, extended_state
     ) -> list["Feature"]:
+        type_class_map = {
+            "rain": Rain,
+            "flood": Flood,
+        }
+
         output_list = list()
         sensors_list = extended_state.get("multiSensor").get("sensors", {})
         alias, methods = box_type_config[0]
+
         for sensor in sensors_list:
             sensor_type = sensor.get("type")
             sensor_id = sensor.get("id")
-            if sensor.get("type") in ("rain", "flood"):
+
+            if sensor_type in type_class_map:
+                klass = type_class_map[sensor_type]
+
                 if methods.get(sensor_type) is not None:
                     value_method = {sensor_type: methods[sensor_type](sensor_id)}
                     output_list.append(
-                        Rain(
+                        klass(
                             product=product,
                             alias=sensor_type + "_" + str(sensor_id),
                             methods=value_method,
@@ -56,3 +68,29 @@ class Rain(BinarySensor):
 
     def after_update(self) -> None:
         self._current = self._read_rain("rain")
+
+
+class Flood(BinarySensor):
+    def __init__(self, product: "Box", alias: str, methods: dict):
+        self._device_class = "moisture"
+        super().__init__(product, alias, methods)
+
+    @property
+    def state(self) -> bool:
+        return self._current > 0
+
+    @property
+    def device_class(self) -> str:
+        return self._device_class
+
+    def _read_flood(self, field: str) -> Union[float, int, None]:
+        product = self._product
+
+        if product.last_data is not None:
+            raw = self.raw_value(field)
+            if raw is not None:  # no reading
+                return self.raw_value("flood")
+        return 0
+
+    def after_update(self) -> None:
+        self._current = self._read_flood("flood")

{blebox_uniapi-2.2.2 → blebox_uniapi-2.4.0}/blebox_uniapi/box.py

@@ -1,12 +1,11 @@
 from __future__ import annotations
 
-import re
 import asyncio
 import time
 
 from typing import Optional, Any, Dict
 
-from .box_types import default_api_level, get_conf, get_conf_set
+from .box_types import _DEFAULT_API_LEVEL, get_conf, get_conf_set
 from .button import Button
 from .climate import Climate
 from .cover import Cover
@@ -19,7 +18,6 @@ from .switch import Switch
 from .error import (
     UnsupportedBoxResponse,
     UnsupportedBoxVersion,
-    JPathFailed,
     BadFieldExceedsMax,
     BadFieldLessThanMin,
     BadFieldMissing,
@@ -107,7 +105,7 @@ class Box:
                 info, f"{location} has no hardware version"
             ) from ex
 
-        level = int(info.get("apiLevel", default_api_level))
+        level = int(info.get("apiLevel", _DEFAULT_API_LEVEL))
 
         self._data_path = config["api_path"]
         self._type = type
@@ -117,21 +115,15 @@ class Box:
         self._firmware_version = firmware_version
         self._hardware_version = hardware_version
         self._api_version = level
-
         self._model = config.get("model", type)
-
         self._api = config.get("api", {})
-
         self._features = self.create_features(config, info, extended_state)
-
         self._config = config
-
-        self._update_last_data(None)
+        self._update_last_data(extended_state)
 
     def create_features(
         self, config: dict, info: dict, extended_state: Optional[dict]
     ) -> dict:
-
         features = {}
         for field, klass in {
             "covers": Cover,
@@ -185,7 +177,7 @@ class Box:
             product = device_type
         if device_type == "wLightBox" and product == "wLightBoxS":
             device_type = "wLightBoxS"
-        level = int(info.get("apiLevel", default_api_level))
+        level = int(info.get("apiLevel", _DEFAULT_API_LEVEL))
         config_set = get_conf_set(device_type)
         if not config_set:
             raise UnsupportedBoxResponse(f"{device_type} is not a supported type")
@@ -260,9 +252,9 @@ class Box:
         # Note that SwitchboxD is just an example. It is possible that APIs of other
         # box types also exhibit this kind of behavior.
         if (
-            isinstance(self._last_data, dict) and
-            isinstance(new_data, dict) and
-            self._last_data.keys() != new_data.keys()
+            isinstance(self._last_data, dict)
+            and isinstance(new_data, dict)
+            and self._last_data.keys() != new_data.keys()
         ):
             # ... In such a case we need to merge both states instead of overwriting
             # the old one as-is.
@@ -288,89 +280,6 @@ class Box:
         self._last_real_update = None  # force update
         return await self._async_api(False, method, *args)
 
-    def follow(self, data: dict, path: str) -> Any:
-        """
-        Return payload from device response json.
-        :param self:
-        :param data:
-        :param path:
-        :return:
-        """
-        if data is None:
-            raise RuntimeError(f"bad argument: data {data}")  # pragma: no cover
-
-        results = path.split("/")
-        current_tree = data
-
-        for chunk in results:
-            with_string_value = re.compile(r"^\[(.*)='(.*)']$")
-            match = with_string_value.match(chunk)
-            if match:
-                name = match.group(1)
-                value = match.group(2)
-
-                found = False
-
-                for item in current_tree:
-                    if item[name] == value:
-                        current_tree = item
-                        found = True
-                        break
-
-                if not found:
-                    raise JPathFailed(f"with: {name}={value}", path, data)
-
-                continue  # pragma: no cover
-
-            with_int_value = re.compile(r"^\[(.*)=(\d+)]$")
-            match = with_int_value.match(chunk)
-            if match:
-                name = match.group(1)
-                value = int(match.group(2))
-
-                found = False
-
-                if not isinstance(current_tree, list):
-                    raise JPathFailed(
-                        f"list expected but got {current_tree}", path, data
-                    )
-
-                for item in current_tree:
-                    if item[name] == value:
-                        current_tree = item
-                        found = True
-                        break
-
-                if not found:
-                    raise JPathFailed(f"with: {name}={value}", path, data)
-                continue  # pragma: no cover
-
-            with_index = re.compile(r"^\[(\d+)]$")
-            match = with_index.match(chunk)
-            if match:
-                index = int(match.group(1))
-                if not isinstance(current_tree, list) or index >= len(current_tree):
-                    raise JPathFailed(f"with value at index {index}", path, data)
-
-                current_tree = current_tree[index]
-                continue
-
-            if isinstance(current_tree, dict):
-                names = current_tree.keys()
-                if chunk not in names:
-                    raise JPathFailed(
-                        f"item '{chunk}' not among {list(names)}", path, data
-                    )
-
-                current_tree = current_tree[chunk]
-            else:
-                raise JPathFailed(
-                    f"unexpected item type: '{chunk}' not in: {current_tree}",
-                    path,
-                    data,
-                )
-        return current_tree
-
     def expect_int(
         self, field: str, raw_value: int, maximum: int = -1, minimum: int = 0
     ) -> int:
@@ -398,7 +307,7 @@ class Box:
         if value is None:
             raise BadFieldMissing(self.name, field)
 
-        if not type(value) is int:
+        if not isinstance(value, int):
             raise BadFieldNotANumber(self.name, field, value)
 
         return self.check_int_range(value, field, max_value, min_value)