blebox-uniapi 2.5.4__tar.gz → 2.5.6__tar.gz

{blebox_uniapi-2.5.4 → blebox_uniapi-2.5.6}/CONTRIBUTING.rst

@@ -122,7 +122,11 @@ Make sure all your changes are committed (including an entry in HISTORY.rst).
 Then run::
 
 $ bump2version patch # possible: major / minor / patch
-$ git push
-$ git push --tags
-
-Travis will then deploy to PyPI if tests pass.
+$ git push --follow-tags
+
+bump2version bumps the version in setup.py, blebox_uniapi/__init__.py and
+setup.cfg, commits the change and creates a matching git tag (e.g. v2.6.0).
+Pushing the tag triggers the "Publish to PyPI" GitHub Actions workflow
+(.github/workflows/release.yml), which first runs lint + tests, then builds and
+uploads to PyPI via Trusted Publishing (OIDC) from the blebox/blebox_uniapi repo.
+The publish step only runs if the tests pass.

{blebox_uniapi-2.5.4 → blebox_uniapi-2.5.6}/MANIFEST.in

@@ -1,4 +1,3 @@
-include AUTHORS.rst
 include CONTRIBUTING.rst
 include HISTORY.rst
 include LICENSE

{blebox_uniapi-2.5.4 → blebox_uniapi-2.5.6}/PKG-INFO

@@ -1,22 +1,36 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.4
 Name: blebox_uniapi
-Version: 2.5.4
+Version: 2.5.6
 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
-Platform: UNKNOWN
 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
+Classifier: Programming Language :: Python :: 3.11
 Requires-Python: >=3.9
 Description-Content-Type: text/x-rst
 License-File: LICENSE
+Requires-Dist: aiohttp>=3
+Requires-Dist: jmespath>1.0.0
+Dynamic: author
+Dynamic: author-email
+Dynamic: classifier
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: home-page
+Dynamic: keywords
+Dynamic: license
+Dynamic: license-file
+Dynamic: requires-dist
+Dynamic: requires-python
+Dynamic: summary
 
 ====================
 BleBox Python UniAPI
@@ -227,5 +241,3 @@ History
 ------------------
 
 * First release on PyPI.
-
-

{blebox_uniapi-2.5.4 → blebox_uniapi-2.5.6}/blebox_uniapi/__init__.py

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

{blebox_uniapi-2.5.4 → blebox_uniapi-2.5.6}/blebox_uniapi/box.py

@@ -111,6 +111,7 @@ class Box:
 
         self._data_path = config["api_path"]
         self._type = type
+        self._product = product
         self._unique_id = unique_id
         self._name = name
         self._address = address
@@ -212,6 +213,11 @@ class Box:
     def type(self) -> str:
         return self._type
 
+    @property
+    def product(self) -> str:
+        """Product name for informational purpose only - do not use it in any application logic."""
+        return self._product
+
     @property
     def unique_id(self) -> Any:
         return self._unique_id

{blebox_uniapi-2.5.4 → blebox_uniapi-2.5.6}/blebox_uniapi/box_types.py

@@ -1,3 +1,4 @@
+from .button import GateBoxSecondOutput, TvLift
 from .cover import Gate, GateBox, GateBoxB, Shutter
 from typing import Union, Any
 
@@ -50,9 +51,8 @@ BOX_TYPE_CONF: dict[str, dict[int, dict[str, Any]]] = {
                 "set": lambda command: ("GET", f"/s/c/{command}")
             },  # dictionary with interaction methods
             "buttons": [
-                "tvLift",
-                {"lift": ""},
-            ],  # key used to set platform, list elements used in cls init, e.g. [<alias>, {"path": "state_value"}]
+                ["tvLift", {}, TvLift],
+            ],  # key used to set platform, list elements used in cls init, e.g. [<alias>, {"path": "state_value"}, <optional type class>]
         }
     },
     # airSensor
@@ -135,11 +135,15 @@ BOX_TYPE_CONF: dict[str, dict[int, dict[str, Any]]] = {
                     {
                         "position": "gate.currentPos",
                         "gate_type": "gate.gateType",
+                        "extra_button_type": "gate.extraButtonType",
                     },
                     "gatebox",
                     GateBoxB,
                 ]
             ],
+            "buttons": [
+                ["second_output", {}, GateBoxSecondOutput],
+            ],
         },
     },
     # gateController
@@ -380,6 +384,36 @@ BOX_TYPE_CONF: dict[str, dict[int, dict[str, Any]]] = {
                 ]
             ],
         },
+        20220505: {
+            "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}`]|[0]|state"},
+                    "relay",
+                ]
+            ],
+            "sensors": [
+                [
+                    "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",
+                        "voltage": lambda x: "sensors[?type == 'voltage']|[0]|value",
+                        "periodS": "powerMeasuring.powerConsumption[0]|periodS",
+                        "measurement_enabled": "powerMeasuring.enabled",
+                    },
+                ]
+            ],
+        },
     },
     # switchBoxD
     "switchBoxD": {
@@ -724,11 +758,15 @@ BOX_TYPE_CONF: dict[str, dict[int, dict[str, Any]]] = {
                         "reactivePower": lambda x: f"multiSensor.sensors[?id == `{x}`]|[?type == 'reactivePower']|[0]|value",
                         "reverseActiveEnergy": lambda x: f"multiSensor.sensors[?id == `{x}`]|[?type == 'reverseActiveEnergy']|[0]|value",
                         "forwardActiveEnergy": lambda x: f"multiSensor.sensors[?id == `{x}`]|[?type == 'forwardActiveEnergy']|[0]|value",
+                        "forwardReactiveEnergy": lambda x: f"multiSensor.sensors[?id == `{x}`]|[?type == 'forwardReactiveEnergy']|[0]|value",
+                        "reverseReactiveEnergy": lambda x: f"multiSensor.sensors[?id == `{x}`]|[?type == 'reverseReactiveEnergy']|[0]|value",
                         "illuminance": lambda x: f"multiSensor.sensors[?id == `{x}`]|[?type == 'illuminance']|[0]|value",
                         "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",
+                        "co2": lambda x: f"multiSensor.sensors[?id == `{x}`]|[?type == 'co2']|[0]|value",
+                        "co2Definition": lambda x: f"multiSensor.sensors[?id == `{x}`]|[?type == 'co2Definition']|[0]|value",
                     },
                 ]
             ],

blebox_uniapi-2.5.6/blebox_uniapi/button.py

@@ -0,0 +1,141 @@
+from .cover import GateBoxControlType, GateBoxExtraButtonType
+from .feature import Feature
+from typing import TYPE_CHECKING, Any, Optional, Type
+
+from enum import Enum, auto
+
+if TYPE_CHECKING:
+    from .box import Box
+
+TV_LIFT_CONTROL_TYPES_API = {
+    0: {"1": "open_or_stop", "2": "close_or_stop"},
+    1: {"1": "up_or_stop", "2": "down_or_stop"},
+    2: {"1": "up_or_stop", "2": "down_or_stop"},
+    3: {"1": "up_or_stop", "2": "down_or_stop"},
+    4: {"1": "open_or_stop", "2": "close_or_stop", "3": "to_fav"},
+}
+
+
+class ControlType(Enum):
+    UP = auto()
+    DOWN = auto()
+    FAVORITE = auto()
+    OPEN = auto()
+    CLOSE = auto()
+
+
+class Buttons:
+    """Buttons defines how a product derives its buttons from extended state."""
+
+    @staticmethod
+    def many_from_extended_state(
+        button_cls: Type["Button"],
+        product: "Box",
+        alias: str,
+        methods: dict,
+        extended_state: dict,
+    ) -> list["Button"]:
+        raise NotImplementedError  # pragma: no cover
+
+
+class TvLift(Buttons):
+    @staticmethod
+    def many_from_extended_state(
+        button_cls: Type["Button"],
+        product: "Box",
+        alias: str,
+        methods: dict,
+        extended_state: dict,
+    ) -> list["Button"]:
+        control_type = extended_state.get("tvLift", {}).get("controlType")
+        endpoints = TV_LIFT_CONTROL_TYPES_API.get(control_type, {})
+        return [
+            button_cls(product, f"{alias}_{endpoint}", methods, endpoint)
+            for endpoint in endpoints.values()
+        ]
+
+
+class GateBoxSecondOutput(Buttons):
+    """GateBoxSecondOutput exposes the gateBox extra button output as a button.
+
+    WALK_IN and OTHER share one button name because what the output does is a
+    device setting the user can change at any time, not a hardware trait.
+    """
+
+    @staticmethod
+    def many_from_extended_state(
+        button_cls: Type["Button"],
+        product: "Box",
+        alias: str,
+        methods: dict,
+        extended_state: dict,
+    ) -> list["Button"]:
+        gate = extended_state.get("gate", {})
+        if gate.get("extraButtonType") not in (
+            GateBoxExtraButtonType.WALK_IN,
+            GateBoxExtraButtonType.OTHER,
+        ):
+            return []
+
+        # Api levels below 20230102 report no mode and cannot be wired that way.
+        if gate.get("openCloseMode") == GateBoxControlType.OPEN_CLOSE:
+            return []
+
+        return [button_cls(product, alias, methods, "second_output", "secondary")]
+
+
+class Button(Feature):
+    def __init__(
+        self,
+        product: "Box",
+        alias: str,
+        methods: dict,
+        query_string: str,
+        api_command: str = "set",
+    ) -> None:
+        super().__init__(product, alias, methods)
+        self._device_class = "UPDATE"
+        self._query_string: str = query_string
+        self._api_command: str = api_command
+
+    @classmethod
+    def many_from_config(
+        cls, product: "Box", box_type_config: list, extended_state: Any
+    ) -> list["Button"]:
+        if not isinstance(extended_state, dict):
+            return []
+
+        features: list[Button] = []
+        for alias, methods, buttons in box_type_config:
+            features.extend(
+                buttons.many_from_extended_state(
+                    cls, product, alias, methods, extended_state
+                )
+            )
+        return features
+
+    async def set(self) -> None:
+        await self.async_api_command(self._api_command, self.query_string)
+
+    def after_update(self) -> None:
+        pass
+
+    @property
+    def control_type(self) -> Optional[ControlType]:
+        """Return icon for endpoint."""
+        if "up" in self.query_string:
+            return ControlType.UP
+        elif "down" in self.query_string:
+            return ControlType.DOWN
+        elif "fav" in self.query_string:
+            return ControlType.FAVORITE
+        elif "open" in self.query_string:
+            return ControlType.OPEN
+        elif "close" in self.query_string:
+            return ControlType.CLOSE
+        else:
+            return None
+
+    @property
+    def query_string(self) -> str:
+        return self._query_string

{blebox_uniapi-2.5.4 → blebox_uniapi-2.5.6}/blebox_uniapi/cover.py

@@ -65,6 +65,19 @@ class GateBoxControlType(IntEnum):
     OPEN_CLOSE = 2
 
 
+class GateBoxExtraButtonType(IntEnum):
+    """GateBoxExtraButtonType defines gateBox extra button semantics.
+
+    Only meaningful outside OPEN_CLOSE mode, which takes the extra button output
+    for the close action and leaves this field unused.
+    """
+
+    DISABLED = 0
+    STOP = 1
+    WALK_IN = 2
+    OTHER = 3
+
+
 class GateBoxGateType(IntEnum):
     """GateBoxGateType defines possible gate/cover types reported by gateBox"""
 
@@ -101,7 +114,7 @@ class UnifiedCoverType(IntEnum):
 class Gate:
     _control_type: Optional[int]
 
-    def __init__(self, control_type: int):
+    def __init__(self, control_type: int, is_calibrated: bool = False):
         self._control_type = control_type
 
     def read_state(self, alias: str, raw_value: Any, product: "Box") -> int:
@@ -148,6 +161,10 @@ class Gate:
     def close_command(self) -> str:
         return "close"
 
+    @property
+    def is_calibrated(self) -> None:
+        return None
+
     def stop_command(self, has_stop: bool) -> str:
         return "stop"
 
@@ -157,6 +174,11 @@ class Gate:
 
 class Shutter(Gate):
     _control_type: Optional[ShutterBoxControlType]
+    _is_calibrated: bool
+
+    def __init__(self, control_type: int, is_calibrated: bool = False):
+        super().__init__(control_type)
+        self._is_calibrated = is_calibrated
 
     @property
     def min_position(self) -> int:
@@ -185,14 +207,22 @@ class Shutter(Gate):
 
     @property
     def is_slider(self) -> bool:
-        return self._control_type not in (
-            ShutterBoxControlType.NO_CALIBRATION,
-            ShutterBoxControlType.CURTAIN,
-            ShutterBoxControlType.TILT_ONLY,
-            ShutterBoxControlType.PERGOLA_ROOF_TILT_ONLY,
-            ShutterBoxControlType.TILT_SHUTTER_WITHOUT_POSITIONING,
+        return (
+            self._control_type
+            not in (
+                ShutterBoxControlType.NO_CALIBRATION,
+                ShutterBoxControlType.CURTAIN,
+                ShutterBoxControlType.TILT_ONLY,
+                ShutterBoxControlType.PERGOLA_ROOF_TILT_ONLY,
+                ShutterBoxControlType.TILT_SHUTTER_WITHOUT_POSITIONING,
+            )
+            and self.is_calibrated is True
         )
 
+    @property
+    def is_calibrated(self) -> bool:
+        return self._is_calibrated
+
     def read_cover_type(
         self, alias: str, raw_value: Any, product: "Box"
     ) -> UnifiedCoverType:
@@ -288,7 +318,7 @@ class GateBox(Gate):
         if button_type is None:
             return False
 
-        return button_type == 1
+        return button_type == GateBoxExtraButtonType.STOP
 
 
 class GateBoxB(GateBox):
@@ -311,9 +341,23 @@ class GateBoxB(GateBox):
         return raw_value("position")
 
     def read_has_stop(self, alias: str, raw_value: Any, product: "Box") -> bool:
+        if product.last_data is None:
+            return False
+
         # note: if control type is unknown we assume it is not open/close
         #       and has the stop feature via secondary button command.
-        return self._control_type != GateBoxControlType.OPEN_CLOSE
+        if self._control_type == GateBoxControlType.OPEN_CLOSE:
+            return False
+
+        # stop_command issues the same secondary command as the second_output button.
+        extra_button_type = raw_value("extra_button_type")
+        if extra_button_type in (
+            GateBoxExtraButtonType.WALK_IN,
+            GateBoxExtraButtonType.OTHER,
+        ):
+            return False
+
+        return True
 
     def read_cover_type(
         self, alias: str, raw_value: Any, product: "Box"
@@ -355,13 +399,20 @@ class Cover(Feature):
         extended_state: dict,
     ) -> None:
         control_type = None
+        is_calibrated: bool = False
         if extended_state and issubclass(subclass, Shutter):
             control_type = extended_state.get("shutter", {}).get("controlType", None)
+            is_calibrated = bool(
+                extended_state.get("shutter", {})
+                .get("calibrationParameters", {})
+                .get("isCalibrated", False)
+            )
+
         elif extended_state and issubclass(subclass, GateBoxB):
             control_type = extended_state.get("gate", {}).get("openCloseMode", None)
 
         self._device_class = dev_class
-        self._attributes: GateT = subclass(control_type)
+        self._attributes: GateT = subclass(control_type, is_calibrated)
         self._tilt_current = None
         super().__init__(product, alias, methods)
 
@@ -383,6 +434,10 @@ class Cover(Feature):
     def tilt_current(self):
         return self._tilt_current
 
+    @property
+    def is_calibrated(self) -> Optional[bool]:
+        return self._attributes.is_calibrated
+
     @property
     def is_slider(self) -> Any:
         return self._attributes.is_slider

{blebox_uniapi-2.5.4 → blebox_uniapi-2.5.6}/blebox_uniapi/error.py

@@ -39,7 +39,6 @@ class UnsupportedBoxVersion(BoxError):
     pass
 
 
-
 class BadFieldExceedsMax(BoxError):
     def __init__(self, dev_name: str, field: str, value: int, max_value: int):
         self._dev_name = dev_name
@@ -103,7 +102,6 @@ class BadFieldNotRGBW(BoxError):
         return f"{self._dev_name}.{self._field} is {self._value} which is not a rgbw string"
 
 
-
 # misc errors
 
 

{blebox_uniapi-2.5.4 → blebox_uniapi-2.5.6}/blebox_uniapi/sensor.py

@@ -160,12 +160,16 @@ class BaseSensor(Feature):
 @SensorFactory.register("apparentPower", unit="va")
 @SensorFactory.register("reactivePower", unit="var")
 @SensorFactory.register("activePower", unit="W")
+@SensorFactory.register("reverseReactiveEnergy", unit="kvarh", scale=1_000)
+@SensorFactory.register("forwardReactiveEnergy", unit="kvarh", scale=1_000)
 @SensorFactory.register("reverseActiveEnergy", unit="kWh", scale=1_000)
 @SensorFactory.register("forwardActiveEnergy", unit="kWh", scale=1_000)
 @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="")
+@SensorFactory.register("co2", unit="ppm")
+@SensorFactory.register("co2Definition", unit="")
 class GenericSensor(BaseSensor):
     def __init__(
         # base sensor params

{blebox_uniapi-2.5.4 → blebox_uniapi-2.5.6}/blebox_uniapi/session.py

@@ -98,7 +98,7 @@ class ApiHost:
         try:
             return await self.async_request(path, self._session.get)
         except Exception as ex:
-            logger.error(f"EXCEPTION DURING API CALL: {ex}")
+            logger.debug(f"EXCEPTION DURING API CALL: {ex}")
             raise ex
 
     async def async_api_get_ota(self, path: str) -> Optional[dict]:
@@ -107,7 +107,7 @@ class ApiHost:
                 path, self._session.get, allow_ota_check_response=True
             )
         except Exception as ex:
-            logger.error(f"EXCEPTION DURING API CALL: {ex}")
+            logger.debug(f"EXCEPTION DURING API CALL: {ex}")
             raise ex
 
     async def async_api_post(

{blebox_uniapi-2.5.4 → blebox_uniapi-2.5.6}/blebox_uniapi.egg-info/PKG-INFO

@@ -1,22 +1,36 @@
-Metadata-Version: 2.1
-Name: blebox-uniapi
-Version: 2.5.4
+Metadata-Version: 2.4
+Name: blebox_uniapi
+Version: 2.5.6
 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
-Platform: UNKNOWN
 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
+Classifier: Programming Language :: Python :: 3.11
 Requires-Python: >=3.9
 Description-Content-Type: text/x-rst
 License-File: LICENSE
+Requires-Dist: aiohttp>=3
+Requires-Dist: jmespath>1.0.0
+Dynamic: author
+Dynamic: author-email
+Dynamic: classifier
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: home-page
+Dynamic: keywords
+Dynamic: license
+Dynamic: license-file
+Dynamic: requires-dist
+Dynamic: requires-python
+Dynamic: summary
 
 ====================
 BleBox Python UniAPI
@@ -227,5 +241,3 @@ History
 ------------------
 
 * First release on PyPI.
-
-

{blebox_uniapi-2.5.4 → blebox_uniapi-2.5.6}/blebox_uniapi.egg-info/SOURCES.txt

@@ -35,4 +35,16 @@ docs/index.rst
 docs/installation.rst
 docs/make.bat
 docs/readme.rst
-docs/usage.rst
+docs/usage.rst
+tests/test_box.py
+tests/test_box_types.py
+tests/test_button.py
+tests/test_climate.py
+tests/test_cover.py
+tests/test_light.py
+tests/test_light_unit.py
+tests/test_sensor.py
+tests/test_session.py
+tests/test_switch.py
+tests/test_unknown.py
+tests/test_update.py

{blebox_uniapi-2.5.4 → blebox_uniapi-2.5.6}/setup.cfg

@@ -1,7 +1,8 @@
 [bumpversion]
-current_version = 2.5.4
+current_version = 2.5.6
 commit = True
 tag = True
+tag_name = v{new_version}
 
 [bumpversion:file:setup.py]
 search = version="{current_version}"

{blebox_uniapi-2.5.4 → blebox_uniapi-2.5.6}/setup.py

@@ -23,7 +23,7 @@ test_requirements = [
 ]
 
 setup(
-    version="2.5.4",
+    version="2.5.6",
     author="BleBox",
     author_email="opensource@blebox.eu",
     python_requires=">=3.9",
@@ -34,6 +34,7 @@ setup(
         "Natural Language :: English",
         "Programming Language :: Python :: 3.9",
         "Programming Language :: Python :: 3.10",
+        "Programming Language :: Python :: 3.11",
     ],
     description="Python API for accessing BleBox smart home devices",
     install_requires=requirements,