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

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

@@ -1,6 +1,14 @@
 =======
 History
 =======
+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
+
+2.4.1 (2024-06-04)
+------------------
+* fix: rectify ambiguity around powerConsumption and wind sensor types
+
 2.4.0 (2024-06-03)
 ------------------
 * Fix: Refactor sensor_factory by @Pastucha in https://github.com/blebox/blebox_uniapi/pull/163

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: blebox_uniapi
-Version: 2.4.0
+Version: 2.4.2
 Summary: Python API for accessing BleBox smart home devices
 Home-page: https://github.com/blebox/blebox_uniapi
 Author: BleBox
@@ -23,20 +23,9 @@ Requires-Dist: jmespath>1.0.0
 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
 
 
@@ -60,7 +49,6 @@ 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
@@ -69,6 +57,14 @@ Credits
 =======
 History
 =======
+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
+
+2.4.1 (2024-06-04)
+------------------
+* fix: rectify ambiguity around powerConsumption and wind sensor types
+
 2.4.0 (2024-06-03)
 ------------------
 * Fix: Refactor sensor_factory by @Pastucha in https://github.com/blebox/blebox_uniapi/pull/163

{blebox_uniapi-2.4.0 → blebox_uniapi-2.4.2}/README.rst

@@ -2,20 +2,9 @@
 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
 
 
@@ -39,7 +28,6 @@ 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

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

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

{blebox_uniapi-2.4.0 → blebox_uniapi-2.4.2}/blebox_uniapi/box_types.py

@@ -280,7 +280,9 @@ BOX_TYPE_CONF: dict[str, dict[int, dict[str, Any]]] = {
                 [
                     "switchBox.energy",
                     {
-                        "powerMeasurement": lambda x: "powerMeasuring.powerConsumption[0]|value",
+                        # note: switchbox/switchboxD sensors are currently not indexed (singletons)
+                        "powerConsumption": lambda x: "powerMeasuring.powerConsumption[0]|value",
+                        "activePower": lambda x: "sensors[?type == 'activePower']|[0]|value",
                         "periodS": "powerMeasuring.powerConsumption[0]|periodS",
                         "measurement_enabled": "powerMeasuring.enabled",
                     },
@@ -305,7 +307,9 @@ BOX_TYPE_CONF: dict[str, dict[int, dict[str, Any]]] = {
                 [
                     "switchBox.energy",
                     {
-                        "powerMeasurement": lambda x: "powerMeasuring.powerConsumption[0]|value",
+                        # note: switchbox/switchboxD sensors are currently not indexed (singletons)
+                        "powerConsumption": lambda x: "powerMeasuring.powerConsumption[0]|value",
+                        "activePower": lambda x: "sensors[?type == 'activePower']|[0]|value",
                         "periodS": "powerMeasuring.powerConsumption[0]|periodS",
                         "measurement_enabled": "powerMeasuring.enabled",
                     },
@@ -330,7 +334,9 @@ BOX_TYPE_CONF: dict[str, dict[int, dict[str, Any]]] = {
                 [
                     "switchBox.energy",
                     {
-                        "powerMeasurement": lambda x: "powerMeasuring.powerConsumption[0]|value",
+                        # note: switchbox/switchboxD sensors are currently not indexed (singletons)
+                        "powerConsumption": lambda x: "powerMeasuring.powerConsumption[0]|value",
+                        "activePower": lambda x: "sensors[?type == 'activePower']|[0]|value",
                         "periodS": "powerMeasuring.powerConsumption[0]|periodS",
                         "measurement_enabled": "powerMeasuring.enabled",
                     },
@@ -357,7 +363,9 @@ BOX_TYPE_CONF: dict[str, dict[int, dict[str, Any]]] = {
                 [
                     "switchBox.energy",
                     {
-                        "powerMeasurement": lambda x: "powerMeasuring.powerConsumption[0]|value ",
+                        # note: switchbox/switchboxD sensors are currently not indexed (singletons)
+                        "powerConsumption": lambda x: "powerMeasuring.powerConsumption[0]|value ",
+                        "activePower": lambda x: "sensors[?type == 'activePower']|[0]|value",
                         "periodS": "powerMeasuring.powerConsumption[0]|periodS",
                         "measurement_enabled": "powerMeasuring.enabled",
                     },
@@ -392,7 +400,9 @@ BOX_TYPE_CONF: dict[str, dict[int, dict[str, Any]]] = {
                 [
                     "switchBox.energy",
                     {
-                        "powerMeasurement": lambda x: "powerMeasuring.powerConsumption[0]|value ",
+                        # note: switchbox/switchboxD sensors are currently not indexed (singletons)
+                        "powerConsumption": lambda x: "powerMeasuring.powerConsumption[0]|value ",
+                        "activePower": lambda x: "sensors[?type == 'activePower']|[0]|value",
                         "periodS": "powerMeasuring.powerConsumption[0]|periodS",
                         "measurement_enabled": "powerMeasuring.enabled",
                     },
@@ -424,7 +434,9 @@ BOX_TYPE_CONF: dict[str, dict[int, dict[str, Any]]] = {
                 [
                     "switchBox.energy",
                     {
-                        "powerMeasurement": lambda x: "powerMeasuring.powerConsumption[0]|value ",
+                        # note: switchbox/switchboxD sensors are currently not indexed (singletons)
+                        "powerConsumption": lambda x: "powerMeasuring.powerConsumption[0]|value ",
+                        "activePower": lambda x: "sensors[?type == 'activePower']|[0]|value",
                         "periodS": "powerMeasuring.powerConsumption[0]|periodS",
                         "measurement_enabled": "powerMeasuring.enabled",
                     },
@@ -456,7 +468,9 @@ BOX_TYPE_CONF: dict[str, dict[int, dict[str, Any]]] = {
                 [
                     "switchBox.energy",
                     {
-                        "powerMeasurement": lambda x: "powerMeasuring.powerConsumption[0]|value ",
+                        # note: switchbox/switchboxD sensors are currently not indexed (singletons)
+                        "powerConsumption": lambda x: "powerMeasuring.powerConsumption[0]|value ",
+                        "activePower": lambda x: "sensors[?type == 'activePower']|[0]|value",
                         "periodS": "powerMeasuring.powerConsumption[0]|periodS",
                         "measurement_enabled": "powerMeasuring.enabled",
                     },

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

@@ -35,14 +35,16 @@ class SensorFactory:
         # note: probably we should iterate extended state in future if there
         # are other api flavours other than multiSensor that provide sensors
         states = extended_state.get("multiSensor", {}).get("sensors", [])
-
+        # note: but for now we are only able to support non-multisensor devices
+        # that provide sensor data in extended data payload root
+        states.extend(extended_state.get("sensors", []))
         # note: power measuring feature predates multiSensor API, so we need a small
         # shim to adapt older shape of power measuring schema to the new sensor API
         if "powerMeasuring" in extended_state:
             power_states = extended_state["powerMeasuring"].get("powerConsumption", [])
             # note: be careful of names as this has been historically named differently
             # in home-assistant
-            states.extend({"type": "powerMeasurement", **s} for s in power_states)
+            states.extend({"type": "powerConsumption", **s} for s in power_states)
         return states
 
     @classmethod
@@ -133,6 +135,7 @@ class BaseSensor(Feature):
 @SensorFactory.register("forwardActiveEnergy", unit="kWh")
 @SensorFactory.register("illuminance", unit="lx", scale=100)
 @SensorFactory.register("humidity", unit="percentage", scale=100)
+@SensorFactory.register("wind", unit="m/s", scale=10)
 class GenericSensor(BaseSensor):
     def __init__(
         # base sensor params
@@ -173,17 +176,7 @@ class GenericSensor(BaseSensor):
         self._native_value = native
 
 
-@SensorFactory.register("wind", unit="m/s", scale=10)
-class Wind(GenericSensor):
-    @property
-    def device_class(self):
-        # compat/legacy: this sensor is advertised in homeassistant as wind speed
-        # despite different sensor-type naming. Keep it consistent until we rectiify
-        # this upstream
-        return "wind_speed"
-
-
-@SensorFactory.register("powerMeasurement", unit="kWh")
+@SensorFactory.register("powerConsumption", unit="kWh")
 class PowerConsumption(GenericSensor):
     # note: almost the same as typical generic sensor but also provides extra property
     # to read last reset value

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: blebox_uniapi
-Version: 2.4.0
+Version: 2.4.2
 Summary: Python API for accessing BleBox smart home devices
 Home-page: https://github.com/blebox/blebox_uniapi
 Author: BleBox
@@ -23,20 +23,9 @@ Requires-Dist: jmespath>1.0.0
 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
 
 
@@ -60,7 +49,6 @@ 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
@@ -69,6 +57,14 @@ Credits
 =======
 History
 =======
+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
+
+2.4.1 (2024-06-04)
+------------------
+* fix: rectify ambiguity around powerConsumption and wind sensor types
+
 2.4.0 (2024-06-03)
 ------------------
 * Fix: Refactor sensor_factory by @Pastucha in https://github.com/blebox/blebox_uniapi/pull/163

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

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

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

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