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

{blebox_uniapi-2.2.0 → blebox_uniapi-2.2.2}/CONTRIBUTING.rst

@@ -15,7 +15,7 @@ Types of Contributions
 Report Bugs
 ~~~~~~~~~~~
 
-Report bugs at https://github.com/gadgetmobile/blebox_uniapi/issues.
+Report bugs at https://github.com/blebox/blebox_uniapi/issues.
 
 If you are reporting a bug, please include:
 
@@ -45,7 +45,7 @@ articles, and such.
 Submit Feedback
 ~~~~~~~~~~~~~~~
 
-The best way to send feedback is to file an issue at https://github.com/gadgetmobile/blebox_uniapi/issues.
+The best way to send feedback is to file an issue at https://github.com/blebox/blebox_uniapi/issues.
 
 If you are proposing a feature:
 

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

@@ -1,6 +1,15 @@
 =======
 History
 =======
+2.2.2 (2024-02-07)
+------------------
+* fixed wind reading units to get proper raw m/s value (division by 10, see PR #150)
+
+
+2.2.1 (2024-01-26)
+------------------
+* fixed support for power measurement capabilities of switchBox and switchBoxD devices
+
 2.2.0 (2023-08-29)
 ------------------
 * added last_reset to energy sensor class

blebox_uniapi-2.2.2/PKG-INFO

@@ -0,0 +1,208 @@
+Metadata-Version: 2.1
+Name: blebox_uniapi
+Version: 2.2.2
+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
+Classifier: Development Status :: 2 - Pre-Alpha
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Natural Language :: English
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Requires-Python: >=3.9
+License-File: LICENSE
+Requires-Dist: aiohttp>=3
+
+====================
+BleBox Python UniAPI
+====================
+
+
+.. image:: https://img.shields.io/pypi/v/blebox_uniapi.svg
+        :target: https://pypi.python.org/pypi/blebox_uniapi
+
+.. image:: https://travis-ci.com/blebox/blebox_uniapi.svg?branch=master
+        :target: https://travis-ci.com/blebox/blebox_uniapi
+
+.. image:: https://readthedocs.org/projects/blebox-uniapi/badge/?version=latest
+        :target: https://blebox-uniapi.readthedocs.io/en/latest/?badge=latest
+        :alt: Documentation Status
+
+
+
+
+Python API for accessing BleBox smart home devices
+
+
+* Free software: Apache Software License 2.0
+* Documentation: https://blebox-uniapi.readthedocs.io.
+
+
+Features
+--------
+
+* supports `11 BleBox smart home devices`_
+* contains functional/integration tests
+* every device supports at least minimum functionality for most common automation needs
+* insight of integration level are accesible from file `box_types.py <blebox_uniapi/box_types.py#L43>`_
+
+  (devices with apiLevel lower than defined in BOX_TYPE_CONF will not be supported but higher will)
+
+
+Contributions are welcome!
+
+Credits
+-------
+
+
+.. _Cookiecutter: https://github.com/audreyr/cookiecutter
+.. _`audreyr/cookiecutter-pypackage`: https://github.com/audreyr/cookiecutter-pypackage
+.. _`11 BleBox smart home devices`: https://blebox.eu/produkty/?lang=en
+
+
+=======
+History
+=======
+2.2.2 (2024-02-07)
+------------------
+* fixed wind reading units to get proper raw m/s value (division by 10, see PR #150)
+
+
+2.2.1 (2024-01-26)
+------------------
+* fixed support for power measurement capabilities of switchBox and switchBoxD devices
+
+2.2.0 (2023-08-29)
+------------------
+* added last_reset to energy sensor class
+* added BasicAuth support to http client
+
+2.1.4 (2023-01-03)
+------------------
+* added tilt position support for :code:`cover.Shutter`
+* added :code:`Wind` for wind sensor of multisensors
+* added :code:`Energy` sensor class for power consumption tracking
+* implementing :code:`default_api_level` for
+   * dimmerBox
+   * wLightBox
+   * wLightBoxS
+
+2.1.3 (2022-10-27)
+------------------
+* thermoBox boost mode doesn't corrupt state
+
+2.1.2 (2022-10-17)
+------------------
+
+* fixed CCT, CCTx2 modes for wLightBox v1 & v2
+
+2.1.1 (2022-10-11)
+------------------
+* added support for thermoBox devices:
+   * added thermoBox config to :code:`BOX_TYPE_CONFIG`
+   * :code:`Climate` uses factory method implementation
+   * added test coverage
+
+
+2.1.0 (2022-08-05)
+------------------
+* added support for multiSensor API:
+   * :code:`airQuality` moved to sensor module
+   * new binary_sensor module, introducing :code:`Rain` class
+
+
+2.0.2 (2022-07-06)
+------------------
+* added :code:`query_string` property in :code:`Button` class
+* fixed test assertions after changes in error raised ValueError
+
+2.0.1 (2022-06-01)
+------------------
+* used :code:`ValueError` type instead of :code:`BadOnValueError` in methods:
+
+  * evaluate_brightness_from_rgb
+  * apply_brightness
+  * normalise_elements_of_rgb
+  * _set_last_on_value
+  * async_on
+
+2.0.0 (2022-06-21)
+------------------
+
+* extended support for color modes in wLightBox devices
+* initial support for tvLiftBox device
+* major backward-incompatible architectural changes to enable dynamic configuration of devices
+* removed products.py module and replaced with factory method on Box class
+* general overhaul of public interfaces
+
+1.3.3 (2021-05-12)
+------------------
+
+* fix support for wLightBoxS with wLightBox API
+* fix state detection in gateBox
+
+1.3.2 (2020-04-2)
+------------------
+
+* use proper module-level logger by default
+* fix formatting
+
+1.3.1 (2020-04-2)
+------------------
+
+* never skip command requests
+* improve error messages
+
+1.2.0 (2020-03-30)
+------------------
+
+* expose device info
+* always add ip/port in connection errors
+* fixed gateController support
+* support for sauna min/max temp
+
+1.1.0 (2020-03-24)
+------------------
+
+* fix bad wLightBox API path
+* wrap api calls in semaphore (to serialize reqests to each box)
+* throttle updates to 2/second (to avoid unnecessary requests)
+* rework error handling and hierarchy (for cleaner usage)
+* use actual device name (to help recognize the device)
+* handle asyncio.TimeoutError (to handle timeout-related errors nicely)
+* properly re-raise exceptions (to avoid lengthy call stacktraces)
+* rename wLightBoxS feature to "brightness"
+
+1.1.0 (2020-03-24)
+------------------
+
+* fix switchBox support
+* fix minimum position handling
+* drop Python 3.6 support (still may work)
+* misc fixes, cleanup and increased test coverage
+
+1.0.0 (2020-03-24)
+------------------
+
+* Fixed wLightBox issues
+* Fixed wLightBoxS issues
+* Fixed shutterBox issues
+* Handle unknown shutterBox position
+* Improved error handling + lots of new diagnostics
+* Increased tests and test coverage (almost 100%)
+* Lots of rework
+
+
+0.1.1 (2020-03-15)
+------------------
+
+* Fixed switchBox support (newer API versions)
+
+0.1.0 (2020-03-10)
+------------------
+
+* First release on PyPI.

{blebox_uniapi-2.2.0 → blebox_uniapi-2.2.2}/README.rst

@@ -29,17 +29,16 @@ Features
 * supports `11 BleBox smart home devices`_
 * contains functional/integration tests
 * every device supports at least minimum functionality for most common automation needs
-* insight of integration level are accesible from file `box_types.py <blebox_uniapi/box_types.py#L43>`_  
-  
-  (devices with apiLevel lower than defined in BOX_TYPE_CONF will not be supported but higher will)  
-  
+* insight of integration level are accesible from file `box_types.py <blebox_uniapi/box_types.py#L43>`_
 
-Contributions are most welcome!
+  (devices with apiLevel lower than defined in BOX_TYPE_CONF will not be supported but higher will)
+
+
+Contributions are welcome!
 
 Credits
 -------
 
-This package was created with Cookiecutter_ and the `audreyr/cookiecutter-pypackage`_ project template.
 
 .. _Cookiecutter: https://github.com/audreyr/cookiecutter
 .. _`audreyr/cookiecutter-pypackage`: https://github.com/audreyr/cookiecutter-pypackage

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

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

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

@@ -37,6 +37,8 @@ class Box:
     _name: str
     _data_path: str
     _last_real_update: Optional[float]
+    _last_data: Optional[Any]
+
     api_session: ApiHost
     info: dict
     config: dict
@@ -49,6 +51,7 @@ class Box:
         config,
         extended_state,
     ) -> None:
+        self._last_data = None
         self._last_real_update = None
         self._sem = asyncio.BoundedSemaphore()
         self._session = api_session
@@ -243,6 +246,38 @@ class Box:
         await self._async_api(True, "GET", self._data_path)
 
     def _update_last_data(self, new_data: Optional[dict]) -> None:
+        # Note: on certain more complex devices that inlcude multiple features
+        # like switches and sensors (e.g. SwitchboxD) it may happen that activating
+        # single feature would result only in partial update of the self._last_data.
+        # We can know that by comparing keys of both states.
+        #
+        # Notable example of device exhibiting this behavior is SwitchboxD (20200831)
+        # It has two relays (switches) and power measurement capabilities (sensor).
+        # Toggling the relay does return state of all relays, but does not return
+        # sensor information (partial state). Accepting the new state as-is would
+        # break the update of sensory information.
+        #
+        # 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()
+        ):
+            # ... In such a case we need to merge both states instead of overwriting
+            # the old one as-is.
+            #
+            # The only risk is that if certain features are somehow coupled inside
+            # the device, we will have inconsistent information about the device.
+            # However, this should be eventually consistent as new updates arrive.
+            # In the end, it is better to have an inconsistent state, rather than
+            # have broken one (e.g. missing keys) that results in broken features.
+            #
+            # Refs:
+            # - https://github.com/blebox/blebox_uniapi/pull/152
+            # - https://github.com/blebox/blebox_uniapi/issues/137
+            new_data = {**self._last_data, **new_data}
+
         self._last_data = new_data
         for feature_set in self._features.values():
             for feature in feature_set:
@@ -255,7 +290,7 @@ class Box:
 
     def follow(self, data: dict, path: str) -> Any:
         """
-        Return payloadu from device response json.
+        Return payload from device response json.
         :param self:
         :param data:
         :param path:
@@ -268,8 +303,7 @@ class Box:
         current_tree = data
 
         for chunk in results:
-            with_string_value = re.compile("^\\[(.*)='(.*)'\\]$")
-
+            with_string_value = re.compile(r"^\[(.*)='(.*)']$")
             match = with_string_value.match(chunk)
             if match:
                 name = match.group(1)
@@ -288,7 +322,7 @@ class Box:
 
                 continue  # pragma: no cover
 
-            with_int_value = re.compile("^\\[(.*)=(\\d+)\\]$")
+            with_int_value = re.compile(r"^\[(.*)=(\d+)]$")
             match = with_int_value.match(chunk)
             if match:
                 name = match.group(1)
@@ -311,7 +345,7 @@ class Box:
                     raise JPathFailed(f"with: {name}={value}", path, data)
                 continue  # pragma: no cover
 
-            with_index = re.compile("^\\[(\\d+)\\]$")
+            with_index = re.compile(r"^\[(\d+)]$")
             match = with_index.match(chunk)
             if match:
                 index = int(match.group(1))

{blebox_uniapi-2.2.0 → blebox_uniapi-2.2.2}/blebox_uniapi/box_types.py

@@ -245,17 +245,6 @@ BOX_TYPE_CONF: dict[str, dict[int, dict[str, Any]]] = {
         }
     },
     "switchBox": {
-        20220114: {
-            "api_path": "/state",
-            "extended_state_path": "/state/extended",
-            "api": {
-                "on": lambda x=None: ("GET", f"/s/{x}/1", None),
-                "off": lambda x=None: ("GET", f"/s/{x}/0", None),
-            },
-            "switches": [
-                ["relay", {"state": lambda x: f"relays/[relay={x}]/state"}, "relay"]
-            ],
-        },
         20180604: {
             "model": "switchBox",
             "api_path": "/api/relay/state",
@@ -265,6 +254,7 @@ BOX_TYPE_CONF: dict[str, dict[int, dict[str, Any]]] = {
                 "off": lambda x=None: ("GET", "/s/0", None),
             },
             "switches": [["0.relay", {"state": "[relay=0]/state"}, "relay"]],
+            # note: does not support power measurement
         },
         20190808: {
             "api_path": "/api/relay/extended/state",
@@ -287,11 +277,107 @@ BOX_TYPE_CONF: dict[str, dict[int, dict[str, Any]]] = {
                 ]
             ],
         },
+        20200229: {
+            "extended_state_path": "/state/extended",
+            "api_path": "/state/extended",
+            "api": {
+                "on": lambda x=None: ("GET", "/s/1", None),
+                "off": lambda x=None: ("GET", "/s/0", None),
+            },
+            "switches": [
+                ["0.relay", {"state": lambda x: f"relays/[relay={x}]/state"}, "relay"]
+            ],
+            "sensors": [
+                [
+                    "switchBox.energy",
+                    {
+                        "energy": "powerMeasuring/powerConsumption/[0]/value",
+                        "periodS": "powerMeasuring/powerConsumption/[0]/periodS",
+                        "measurment_enabled": "powerMeasuring/enabled",
+                    },
+                ]
+            ],
+        },
+        20200831: {
+            "extended_state_path": "/state/extended",
+            "api_path": "/state/extended",
+            "api": {
+                "on": lambda x=None: ("GET", "/s/1", None),
+                "off": lambda x=None: ("GET", "/s/0", None),
+            },
+            "switches": [
+                ["0.relay", {"state": lambda x: f"relays/[relay={x}]/state"}, "relay"]
+            ],
+            "sensors": [
+                [
+                    "switchBox.energy",
+                    {
+                        "energy": "powerMeasuring/powerConsumption/[0]/value",
+                        "periodS": "powerMeasuring/powerConsumption/[0]/periodS",
+                        "measurment_enabled": "powerMeasuring/enabled",
+                    },
+                ]
+            ],
+        },
+        20220114: {
+            "api_path": "/state/extended",
+            "extended_state_path": "/state/extended",
+            "api": {
+                # note: old control api (i.e. /s/0, /s/1, /s/2) still supported but
+                # now deprecated. switchBox has now API consistent with switchBoxD
+                "on": lambda x=None: ("GET", f"/s/{x}/1", None),
+                "off": lambda x=None: ("GET", f"/s/{x}/0", None),
+            },
+            "switches": [
+                ["relay", {"state": lambda x: f"relays/[relay={x}]/state"}, "relay"]
+            ],
+            "sensors": [
+                [
+                    "switchBox.energy",
+                    {
+                        "energy": "powerMeasuring/powerConsumption/[0]/value",
+                        "periodS": "powerMeasuring/powerConsumption/[0]/periodS",
+                        "measurment_enabled": "powerMeasuring/enabled",
+                    },
+                ]
+            ],
+        },
     },
-    # switchBoxD
     "switchBoxD": {
         20190808: {
-            "extended_state_path": "/state/extended",  # tylko dla testów do usunięcia nie w tym api
+            "extended_state_path": "/api/relay/extended/state",
+            "api_path": "/api/relay/extended/state",
+            "api": {
+                "on": lambda x: ("GET", f"/s/{int(x)}/1", None),
+                "off": lambda x=None: ("GET", f"/s/{int(x)}/0", None),
+            },
+            "switches": [
+                [
+                    "0.relay",
+                    {"state": lambda x: f"relays/[relay={x}]/state"},
+                    "relay",
+                    0,
+                ],
+                [
+                    "1.relay",
+                    {"state": lambda x: f"relays/[relay={x}]/state"},
+                    "relay",
+                    1,
+                ],
+            ],
+            "sensors": [
+                [
+                    "switchBox.energy",
+                    {
+                        "energy": "powerMeasuring/powerConsumption/[0]/value",
+                        "periodS": "powerMeasuring/powerConsumption/[0]/periodS",
+                        "measurment_enabled": "powerMeasuring/enabled",
+                    },
+                ]
+            ],
+        },
+        20200229: {
+            "extended_state_path": "/state/extended",
             "api_path": "/state/extended",
             "api": {
                 "on": lambda x: ("GET", f"/s/{int(x)}/1", None),
@@ -321,7 +407,39 @@ BOX_TYPE_CONF: dict[str, dict[int, dict[str, Any]]] = {
                     },
                 ]
             ],
-        }
+        },
+        20200831: {
+            "extended_state_path": "/state/extended",
+            "api_path": "/state/extended",
+            "api": {
+                "on": lambda x: ("GET", f"/s/{int(x)}/1", None),
+                "off": lambda x=None: ("GET", f"/s/{int(x)}/0", None),
+            },
+            "switches": [
+                [
+                    "0.relay",
+                    {"state": lambda x: f"relays/[relay={x}]/state"},
+                    "relay",
+                    0,
+                ],
+                [
+                    "1.relay",
+                    {"state": lambda x: f"relays/[relay={x}]/state"},
+                    "relay",
+                    1,
+                ],
+            ],
+            "sensors": [
+                [
+                    "switchBox.energy",
+                    {
+                        "energy": "powerMeasuring/powerConsumption/[0]/value",
+                        "periodS": "powerMeasuring/powerConsumption/[0]/periodS",
+                        "measurment_enabled": "powerMeasuring/enabled",
+                    },
+                ]
+            ],
+        },
     },
     # tempSensor
     "tempSensor": {

{blebox_uniapi-2.2.0 → blebox_uniapi-2.2.2}/blebox_uniapi/sensor.py

@@ -140,7 +140,13 @@ class Wind(BaseSensor):
     def _read_wind_speed(self):
         product = self._product
         if product.last_data is not None:
-            return self.raw_value("wind")
+            raw = self.raw_value("wind")
+            if raw is not None:
+                alias = self._alias
+                # wind value unit in API is "0.1 m/s" so to get m/s we need to divide by 10
+                # min value = 0, max value for sure not bigger than 200km/h so about 60m/s so 600 in API
+                return round(product.expect_int(alias, raw, 600, 0) / 10.0, 1)
+        return None
 
     def after_update(self) -> None:
         self._native_value = self._read_wind_speed()