blebox-uniapi 2.4.1__tar.gz → 2.5.0__tar.gz

{blebox_uniapi-2.4.1 → blebox_uniapi-2.5.0}/HISTORY.rst

@@ -1,6 +1,14 @@
 =======
 History
 =======
+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
+
 2.4.1 (2024-06-04)
 ------------------
 * fix: rectify ambiguity around powerConsumption and wind sensor types

{blebox_uniapi-2.4.1 → blebox_uniapi-2.5.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: blebox_uniapi
-Version: 2.4.1
+Version: 2.5.0
 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.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
+
 2.4.1 (2024-06-04)
 ------------------
 * fix: rectify ambiguity around powerConsumption and wind sensor types

{blebox_uniapi-2.4.1 → blebox_uniapi-2.5.0}/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.1 → blebox_uniapi-2.5.0}/blebox_uniapi/__init__.py

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

{blebox_uniapi-2.4.1 → blebox_uniapi-2.5.0}/blebox_uniapi/box_types.py

@@ -280,7 +280,9 @@ BOX_TYPE_CONF: dict[str, dict[int, dict[str, Any]]] = {
                 [
                     "switchBox.energy",
                     {
+                        # 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",
                     {
+                        # 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",
                     {
+                        # 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",
                     {
+                        # 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",
                     {
+                        # 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",
                     {
+                        # 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",
                     {
+                        # 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.1 → blebox_uniapi-2.5.0}/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.1 → blebox_uniapi-2.5.0}/blebox_uniapi/sensor.py

@@ -35,7 +35,9 @@ 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:
@@ -71,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)
 
@@ -96,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
@@ -115,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")
@@ -141,6 +161,7 @@ class GenericSensor(BaseSensor):
         product: "Box",
         alias: str,
         methods: dict,
+        sensor_id: Optional[int],
         *,
         # generalization params
         sensor_type: str,
@@ -148,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
@@ -198,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"
 
@@ -225,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.1 → blebox_uniapi-2.5.0}/blebox_uniapi.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: blebox_uniapi
-Version: 2.4.1
+Version: 2.5.0
 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.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
+
 2.4.1 (2024-06-04)
 ------------------
 * fix: rectify ambiguity around powerConsumption and wind sensor types

{blebox_uniapi-2.4.1 → blebox_uniapi-2.5.0}/setup.cfg

@@ -1,5 +1,5 @@
 [bumpversion]
-current_version = 2.4.1
+current_version = 2.5.0
 commit = True
 tag = True
 

{blebox_uniapi-2.4.1 → blebox_uniapi-2.5.0}/setup.py

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