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

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: blebox_uniapi
-Version: 2.5.1
+Version: 2.5.3
 Summary: Python API for accessing BleBox smart home devices
 Home-page: https://github.com/blebox/blebox_uniapi
 Author: BleBox

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

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

{blebox_uniapi-2.5.1 → blebox_uniapi-2.5.3}/blebox_uniapi/binary_sensor.py

@@ -1,4 +1,4 @@
-from typing import Union, TYPE_CHECKING
+from typing import Union, Optional, TYPE_CHECKING
 
 from .feature import Feature
 
@@ -9,9 +9,19 @@ if TYPE_CHECKING:
 class BinarySensor(Feature):
     """Class representing sensor with bool state."""
 
-    def __init__(self, product: "Box", alias: str, methods: dict):
+    def __init__(self, product: "Box", alias: str, methods: dict, sensor_id: Optional[int] = None, name: Optional[str] = None):
+        self._sensor_id = sensor_id
+        self._name = name
         super().__init__(product, alias, methods)
 
+    @property
+    def index(self) -> Optional[int]:
+        return self._sensor_id
+
+    @property
+    def name(self) -> Optional[str]:
+        return self._name
+
     @classmethod
     def many_from_config(
         cls, product, box_type_config, extended_state
@@ -19,6 +29,8 @@ class BinarySensor(Feature):
         type_class_map = {
             "rain": Rain,
             "flood": Flood,
+            "openStatus": Open,
+            "binary": Input,
         }
 
         output_list = list()
@@ -39,6 +51,8 @@ class BinarySensor(Feature):
                             product=product,
                             alias=sensor_type + "_" + str(sensor_id),
                             methods=value_method,
+                            sensor_id=sensor_id,
+                            name=sensor.get("name"),
                         )
                     )
 
@@ -46,9 +60,9 @@ class BinarySensor(Feature):
 
 
 class Rain(BinarySensor):
-    def __init__(self, product: "Box", alias: str, methods: dict):
+    def __init__(self, product: "Box", alias: str, methods: dict, sensor_id: Optional[int] = None, name: Optional[str] = None):
         self._device_class = "moisture"
-        super().__init__(product, alias, methods)
+        super().__init__(product, alias, methods, sensor_id=sensor_id, name=name)
 
     @property
     def state(self) -> bool:
@@ -71,9 +85,9 @@ class Rain(BinarySensor):
 
 
 class Flood(BinarySensor):
-    def __init__(self, product: "Box", alias: str, methods: dict):
+    def __init__(self, product: "Box", alias: str, methods: dict, sensor_id: Optional[int] = None, name: Optional[str] = None):
         self._device_class = "moisture"
-        super().__init__(product, alias, methods)
+        super().__init__(product, alias, methods, sensor_id=sensor_id, name=name)
 
     @property
     def state(self) -> bool:
@@ -94,3 +108,47 @@ class Flood(BinarySensor):
 
     def after_update(self) -> None:
         self._current = self._read_flood("flood")
+
+
+class Open(BinarySensor):
+    def __init__(self, product: "Box", alias: str, methods: dict):
+        self._device_class = "open"
+        super().__init__(product, alias, methods)
+
+    @property
+    def state(self) -> bool:
+        return self._current != 4  # 4 = closed, 0-3 = open
+
+    def _read_input(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("openStatus")
+        return 0
+
+    def after_update(self) -> None:
+        self._current = self._read_input("openStatus")
+        
+        
+class Input(BinarySensor):
+    def __init__(self, product: "Box", alias: str, methods: dict):
+        self._device_class = "input"
+        super().__init__(product, alias, methods)
+
+    @property
+    def state(self) -> bool:
+        return self._current > 0
+
+    def _read_input(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("binary")
+        return 0
+
+    def after_update(self) -> None:
+        self._current = self._read_input("binary")

{blebox_uniapi-2.5.1 → blebox_uniapi-2.5.3}/blebox_uniapi/box_types.py

@@ -720,6 +720,7 @@ BOX_TYPE_CONF: dict[str, dict[int, dict[str, Any]]] = {
                         "temperature": lambda x: f"multiSensor.sensors[?id == `{x}`]|[?type == 'temperature']|[0]|value",
                         "wind": lambda x: f"multiSensor.sensors[?id == `{x}`]|[?type == 'wind']|[0]|value",
                         "humidity": lambda x: f"multiSensor.sensors[?id == `{x}`]|[?type == 'humidity']|[0]|value",
+                        "openStatus": lambda x: f"multiSensor.sensors[?id == `{x}`]|[?type == 'openStatus']|[0]|value",
                     },
                 ]
             ],
@@ -729,6 +730,8 @@ BOX_TYPE_CONF: dict[str, dict[int, dict[str, Any]]] = {
                     {
                         "rain": lambda x: f"multiSensor.sensors[?id == `{x}`]|[?type == 'rain']|[0]|value",
                         "flood": lambda x: f"multiSensor.sensors[?id == `{x}`]|[?type == 'flood']|[0]|value",
+                        "openStatus": lambda x: f"multiSensor.sensors[?id == `{x}`]|[?type == 'openStatus']|[0]|value",
+                        "binary": lambda x: f"multiSensor.sensors[?id == `{x}`]|[?type == 'binary']|[0]|value",
                     },
                 ]
             ],

{blebox_uniapi-2.5.1 → blebox_uniapi-2.5.3}/blebox_uniapi/cover.py

@@ -118,6 +118,11 @@ class Gate:
     def min_position(self) -> int:
         return 0
 
+    @property
+    def is_position_inverted(self) -> bool:
+        # shutterBox/gateController: % closed (0=open, 100=closed), inverted vs HA convention
+        return True
+
     @property
     def is_slider(self) -> bool:
         return True
@@ -176,6 +181,11 @@ class Shutter(Gate):
 class GateBox(Gate):
     _control_type: Optional[GateBoxControlType]
 
+    @property
+    def is_position_inverted(self) -> bool:
+        # gateBox: (0=closed, 100=open), matches HA convention
+        return False
+
     @property
     def is_slider(self) -> bool:
         return False
@@ -189,8 +199,6 @@ class GateBox(Gate):
         return "primary"
 
     def read_state(self, alias: str, raw_value: Any, product: "Box") -> int:
-        # Reinterpret state to match shutterBox
-        # NOTE: shutterBox is inverted (0 == closed), gateBox isn't
         current = raw_value("position")
         desired = raw_value("desired")
 
@@ -329,6 +337,10 @@ class Cover(Feature):
     def has_tilt(self) -> bool:
         return self._attributes.has_tilt
 
+    @property
+    def is_position_inverted(self) -> bool:
+        return self._attributes.is_position_inverted
+
     @property
     def has_stop(self) -> bool:
         return self._has_stop

{blebox_uniapi-2.5.1 → blebox_uniapi-2.5.3}/blebox_uniapi/light.py

@@ -112,8 +112,10 @@ class Light(Feature):
         color_mode,
         effect_list,
         current_effect,
+        index: Optional[int] = None,
     ) -> None:
         super().__init__(product, alias, methods)
+        self._index = index
         config = self.CONFIG[product.type]
         self.mask = mask
         self.desired_color = desired_color
@@ -187,6 +189,7 @@ class Light(Feature):
                                 product,
                                 alias=alias + "_" + indicator,
                                 mask=mask,
+                                index=i,
                                 **const_kwargs,
                             )
                         )
@@ -208,12 +211,13 @@ class Light(Feature):
                 ct = ctx2
                 if len(desired_color) > 8:
                     ct = ctx2_v3
-                for indicator, mask in ct.items():
+                for i, (indicator, mask) in enumerate(ct.items()):
                     object_list.append(
                         cls(
                             product,
                             alias=alias + "_" + indicator,
                             mask=mask,
+                            index=i,
                             **const_kwargs,
                         )
                     )
@@ -247,6 +251,10 @@ class Light(Feature):
         else:
             return None
 
+    @property
+    def index(self) -> Optional[int]:
+        return self._index
+
     @property
     def effect_list(self):
         if isinstance(self._effect_list, dict):
@@ -506,7 +514,7 @@ class Light(Feature):
                 if self.color_mode in (BleboxColorMode.RGBW, BleboxColorMode.RGBorW):
                     return 255, 255, 255, 255
                 if self.color_mode == BleboxColorMode.MONO:
-                    return 255
+                    return [255]
                 if self.color_mode in (BleboxColorMode.CT, BleboxColorMode.CTx2):
                     return 255, 255
             else:

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

@@ -77,6 +77,7 @@ class SensorFactory:
                         alias=alias,
                         methods=materialized_methods,
                         sensor_id=sensor_id,
+                        name=sensor.get("name"),
                     )
                     object_list.append(feature)
 
@@ -110,9 +111,11 @@ class BaseSensor(Feature):
         methods: dict,
         sensor_type: str = None,
         sensor_id: Optional[int] = None,
+        name: Optional[str] = None,
     ):
         self._sensor_type = sensor_type
         self._sensor_id = sensor_id
+        self._name = name
         super().__init__(product, alias, methods)
 
     @property
@@ -135,6 +138,14 @@ class BaseSensor(Feature):
     def probe_id(self):
         return self.sensor_id
 
+    @property
+    def index(self) -> Optional[int]:
+        return self._sensor_id
+
+    @property
+    def name(self) -> Optional[str]:
+        return self._name
+
     @classmethod
     def many_from_config(cls, product, box_type_config, extended_state):
         raise NotImplementedError("Please use SensorFactory")
@@ -154,6 +165,7 @@ class BaseSensor(Feature):
 @SensorFactory.register("illuminance", unit="lx", scale=100)
 @SensorFactory.register("humidity", unit="percentage", scale=100)
 @SensorFactory.register("wind", unit="m/s", scale=10)
+@SensorFactory.register("openStatus", unit="")
 class GenericSensor(BaseSensor):
     def __init__(
         # base sensor params
@@ -162,6 +174,7 @@ class GenericSensor(BaseSensor):
         alias: str,
         methods: dict,
         sensor_id: Optional[int],
+        name: Optional[str] = None,
         *,
         # generalization params
         sensor_type: str,
@@ -169,7 +182,7 @@ class GenericSensor(BaseSensor):
         scale: float = 1,
         precision: Optional[int] = None,
     ):
-        super().__init__(product, alias, methods, sensor_id=sensor_id)
+        super().__init__(product, alias, methods, sensor_id=sensor_id, name=name)
         self._unit = unit
         self._scale = scale
         self._precision = precision
@@ -225,8 +238,9 @@ class Temperature(BaseSensor):
         alias: str,
         methods: dict,
         sensor_id: Optional[int] = None,
+        name: Optional[str] = None,
     ):
-        super().__init__(product, alias, methods, sensor_id=sensor_id)
+        super().__init__(product, alias, methods, sensor_id=sensor_id, name=name)
         self._unit = "celsius"
         self._device_class = "temperature"
 
@@ -258,8 +272,9 @@ class AirQuality(BaseSensor):
         alias: str,
         methods: dict,
         sensor_id: Optional[str] = None,
+        name: Optional[str] = None,
     ):
-        super().__init__(product, alias, methods, sensor_id)
+        super().__init__(product, alias, methods, sensor_id, name=name)
         self._unit = "concentration_of_mp"
         self._device_class = alias
 

{blebox_uniapi-2.5.1 → blebox_uniapi-2.5.3}/blebox_uniapi/switch.py

@@ -15,11 +15,13 @@ class Switch(Feature):
         methods: dict,
         dev_class: str,
         unit_id: Union[str, int, None] = 0,
+        name: Optional[str] = None,
     ):
         methods = self.resolve_access_method_paths(methods, str(unit_id))
         super().__init__(product, alias, methods)
         self._device_class = dev_class
         self._unit_id = unit_id
+        self._name = name
 
     @classmethod
     def many_from_config(
@@ -46,6 +48,7 @@ class Switch(Feature):
                         methods,
                         relay_type,
                         relay_id,
+                        name=relay.get("name"),
                     )
                 )
 
@@ -74,6 +77,14 @@ class Switch(Feature):
         unit = self._unit_id
         return [] if unit is None else [unit]
 
+    @property
+    def index(self) -> Optional[int]:
+        return self._unit_id
+
+    @property
+    def name(self) -> Optional[str]:
+        return self._name
+
     async def async_turn_on(self, **kwargs: Any) -> None:
         await self.async_api_command("on", *self._unit_args)
 

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: blebox-uniapi
-Version: 2.5.1
+Version: 2.5.3
 Summary: Python API for accessing BleBox smart home devices
 Home-page: https://github.com/blebox/blebox_uniapi
 Author: BleBox

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

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

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

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