ucapi 0.2.0__tar.gz → 0.3.0__tar.gz

{ucapi-0.2.0 → ucapi-0.3.0}/CHANGELOG.md

@@ -11,6 +11,13 @@ _Changes in the next release_
 
 ---
 
+## v0.3.0 - 2024-04-25
+### Added
+- New media-player attribute MEDIA_POSITION_UPDATED_AT ([feature-and-bug-tracker#443](https://github.com/unfoldedcircle/feature-and-bug-tracker/issues/443)).
+### Changed
+- Filter out base64 encoded media-player image fields in entity_states response log messages ([#22](https://github.com/unfoldedcircle/integration-python-library/issues/22)).
+- Require websockets version v14 or newer.
+
 ## v0.2.0 - 2024-04-28
 ### Added
 - New remote-entity type. Requires remote-core / Core Simulator version 0.43.0 or newer.

{ucapi-0.2.0 → ucapi-0.3.0}/CONTRIBUTING.md

@@ -25,7 +25,7 @@ We love contributions from everyone.
 Either by opening a feature request describing your proposed changes before submitting code, or by contacting us on
 one of the other [feedback channels](#feedback-speech_balloon).
 
-Since this library is being used in integration drivers running on the embedded Remote Two device,
+Since this library is being used in integration drivers running on the embedded UC Remote devices,
 we have to make sure it remains compatible with the embedded runtime environment and runs smoothly.
 
 Submitting pull requests for typos, formatting issues etc. are happily accepted and usually approved relatively quick.  
@@ -36,7 +36,8 @@ With that out of the way, here's the process of creating a pull request and maki
 
 1. Fork the repo.
 
-2. Make your changes or enhancements (preferably on a feature-branch).
+2. Make your changes or enhancements.  
+   This should be done in a dedicated branch and not on the main branch to easily submit individual pull requests.
 
    Contributed code must be licensed under the [Mozilla Public License 2.0](https://choosealicense.com/licenses/mpl-2.0/),
    or a compatible license, if existing parts of other projects are reused (e.g. MIT licensed code).  
@@ -53,13 +54,16 @@ With that out of the way, here's the process of creating a pull request and maki
 
 3. Make sure your changes follow the project's code style and the lints pass described in [Code Style](docs/code_guidelines.md).
 
-4. Push to your fork.
+4. Push to your fork.  
+   Do not include any project configuration changes in the `.idea` folder! If you are also using an IntelliJ product,
+   chances are that you're using a different IDE, version or other settings, which can cause issues.
+   For example, between IntelliJ Ultimate and PyCharm.
 
 5. Submit a pull request.
 
 At this point we will review the PR and give constructive feedback.  
 This is a time for discussion and improvements, and making the necessary changes will be required before we can
-merge the contribution.
+merge the contribution. Furthermore, all the automated checks must pass, otherwise the pull request will not be merged.
 
 ### Feedback :speech_balloon:
 

{ucapi-0.2.0/ucapi.egg-info → ucapi-0.3.0}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.4
 Name: ucapi
-Version: 0.2.0
+Version: 0.3.0
 Summary: Python wrapper for the Unfolded Circle Integration API
 Author-email: Unfolded Circle ApS <hello@unfoldedcircle.com>
 License: MPL-2.0
@@ -8,7 +8,7 @@ Project-URL: Homepage, https://www.unfoldedcircle.com/
 Project-URL: Source Code, https://github.com/unfoldedcircle/integration-python-library
 Project-URL: Bug Reports, https://github.com/unfoldedcircle/integration-python-library/issues
 Project-URL: Discord, http://unfolded.chat/
-Project-URL: Forum, http://unfolded.community/
+Project-URL: Forum, https://unfolded.community/
 Platform: any
 Classifier: Development Status :: 3 - Alpha
 Classifier: Intended Audience :: Developers
@@ -22,7 +22,7 @@ Requires-Python: >=3.10
 Description-Content-Type: text/markdown; charset=UTF-8
 License-File: LICENSE
 Requires-Dist: pyee>=9.0
-Requires-Dist: websockets>=11.0
+Requires-Dist: websockets>=14.0
 Requires-Dist: zeroconf>=0.120.0
 Provides-Extra: testing
 Requires-Dist: pylint; extra == "testing"
@@ -30,13 +30,14 @@ Requires-Dist: flake8-docstrings; extra == "testing"
 Requires-Dist: flake8; extra == "testing"
 Requires-Dist: black; extra == "testing"
 Requires-Dist: isort; extra == "testing"
+Dynamic: license-file
 
 # Python API wrapper for the UC Integration API
 [![PyPi](https://img.shields.io/pypi/v/ucapi.svg)](https://pypi.org/project/ucapi)
 [![License](https://img.shields.io/github/license/unfoldedcircle/integration-python-library.svg)](LICENSE)
 [![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
 
-This library simplifies writing Python based integrations for the [Unfolded Circle Remote Two](https://www.unfoldedcircle.com/)
+This library simplifies writing Python-based integrations for the [Unfolded Circle Remote devices](https://www.unfoldedcircle.com/)
 by wrapping the [WebSocket Integration API](https://github.com/unfoldedcircle/core-api/tree/main/integration-api).
 
 It's an alpha release (in our eyes). Breaking changes are to be expected and missing features will be continuously added.

{ucapi-0.2.0 → ucapi-0.3.0}/README.md

@@ -3,7 +3,7 @@
 [![License](https://img.shields.io/github/license/unfoldedcircle/integration-python-library.svg)](LICENSE)
 [![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
 
-This library simplifies writing Python based integrations for the [Unfolded Circle Remote Two](https://www.unfoldedcircle.com/)
+This library simplifies writing Python-based integrations for the [Unfolded Circle Remote devices](https://www.unfoldedcircle.com/)
 by wrapping the [WebSocket Integration API](https://github.com/unfoldedcircle/core-api/tree/main/integration-api).
 
 It's an alpha release (in our eyes). Breaking changes are to be expected and missing features will be continuously added.

{ucapi-0.2.0 → ucapi-0.3.0}/pyproject.toml

@@ -22,7 +22,7 @@ classifiers = [
 requires-python = ">=3.10"
 dependencies = [
     "pyee>=9.0",
-    "websockets>=11.0",
+    "websockets>=14.0",
     "zeroconf>=0.120.0",
 ]
 dynamic = ["version"]
@@ -36,7 +36,7 @@ content-type = "text/markdown; charset=UTF-8"
 "Source Code" = "https://github.com/unfoldedcircle/integration-python-library"
 "Bug Reports" = "https://github.com/unfoldedcircle/integration-python-library/issues"
 "Discord"     = "http://unfolded.chat/"
-"Forum"       = "http://unfolded.community/"
+"Forum"       = "https://unfolded.community/"
 
 [project.optional-dependencies]
 testing = [

{ucapi-0.2.0 → ucapi-0.3.0}/requirements.txt

@@ -3,5 +3,5 @@
 # Workaround: use a pre-commit hook with https://github.com/scikit-image/scikit-image/blob/main/tools/generate_requirements.py
 
 pyee>=9.0
-websockets>=11.0
+websockets>=14.0
 zeroconf>=0.120.0

{ucapi-0.2.0 → ucapi-0.3.0}/ucapi/_version.py

@@ -1,8 +1,13 @@
-# file generated by setuptools_scm
+# file generated by setuptools-scm
 # don't change, don't track in version control
+
+__all__ = ["__version__", "__version_tuple__", "version", "version_tuple"]
+
 TYPE_CHECKING = False
 if TYPE_CHECKING:
-    from typing import Tuple, Union
+    from typing import Tuple
+    from typing import Union
+
     VERSION_TUPLE = Tuple[Union[int, str], ...]
 else:
     VERSION_TUPLE = object
@@ -12,5 +17,5 @@ __version__: str
 __version_tuple__: VERSION_TUPLE
 version_tuple: VERSION_TUPLE
 
-__version__ = version = '0.2.0'
-__version_tuple__ = version_tuple = (0, 2, 0)
+__version__ = version = '0.3.0'
+__version_tuple__ = version_tuple = (0, 3, 0)

{ucapi-0.2.0 → ucapi-0.3.0}/ucapi/api.py

@@ -16,11 +16,11 @@ from typing import Any, Callable
 import websockets
 from pyee.asyncio import AsyncIOEventEmitter
 
+# Note: websockets v14 doesn't have websockets.server anymore
+from websockets import serve
+
 # workaround for pylint error: E0611: No name 'ConnectionClosedOK' in module 'websockets' (no-name-in-module)  # noqa
 from websockets.exceptions import ConnectionClosedOK
-
-# workaround for pylint error: E1101: Module 'websockets' has no 'serve' member (no-member)  # noqa
-from websockets.server import serve
 from zeroconf import IPVersion
 from zeroconf.asyncio import AsyncServiceInfo, AsyncZeroconf
 
@@ -28,6 +28,11 @@ import ucapi.api_definitions as uc
 from ucapi import media_player
 from ucapi.entities import Entities
 
+try:
+    from ._version import version as __version__
+except ImportError:
+    __version__ = "unknown"
+
 _LOG = logging.getLogger(__name__)
 _LOG.setLevel(logging.DEBUG)
 
@@ -125,9 +130,10 @@ class IntegrationAPI:
         )
 
         _LOG.info(
-            "Driver is up: %s, version: %s, listening on: %s:%d",
+            "Driver is up: %s, version: %s, api: %s, listening on: %s:%d",
             self._driver_info["driver_id"],
             self._driver_info["version"],
+            __version__,
             host,
             port,
         )
@@ -163,6 +169,7 @@ class IntegrationAPI:
             _LOG.info("WS: Connection closed")
 
         except websockets.exceptions.ConnectionClosedError as e:
+            # no idea why they made code & reason deprecated...
             _LOG.info("WS: Connection closed with error %d: %s", e.code, e.reason)
 
         except websockets.exceptions.WebSocketException as e:
@@ -210,6 +217,7 @@ class IntegrationAPI:
         """
         await self._send_ws_response(websocket, req_id, "result", msg_data, status_code)
 
+    # pylint: disable=R0917
     async def _send_ws_response(
         self,
         websocket,
@@ -240,7 +248,9 @@ class IntegrationAPI:
 
         if websocket in self._clients:
             data_dump = json.dumps(data)
-            _LOG.debug("[%s] ->: %s", websocket.remote_address, data_dump)
+            if _LOG.isEnabledFor(logging.DEBUG):
+                data_log = json.dumps(data) if filter_log_msg_data(data) else data_dump
+                _LOG.debug("[%s] ->: %s", websocket.remote_address, data_log)
             await websocket.send(data_dump)
         else:
             _LOG.error("Error sending response: connection no longer established")
@@ -261,12 +271,13 @@ class IntegrationAPI:
         data = {"kind": "event", "msg": msg, "msg_data": msg_data, "cat": category}
         data_dump = json.dumps(data)
         # filter fields
+        data_log = ""
         if _LOG.isEnabledFor(logging.DEBUG):
             data_log = json.dumps(data) if filter_log_msg_data(data) else data_dump
 
         for websocket in self._clients:
             if _LOG.isEnabledFor(logging.DEBUG):
-                _LOG.debug("[%s] ->: %s", websocket.remote_address, data_log)
+                _LOG.debug("[%s] =>: %s", websocket.remote_address, data_log)
             try:
                 await websocket.send(data_dump)
             except websockets.exceptions.WebSocketException:
@@ -469,7 +480,7 @@ class IntegrationAPI:
         self, websocket, req_id: int, msg_data: dict[str, Any] | None
     ) -> None:
         if not msg_data:
-            _LOG.warning("Ignoring _entity_command: called with empty msg_data")
+            _LOG.warning("Ignoring entity command: called with empty msg_data")
             await self.acknowledge_command(
                 websocket, req_id, uc.StatusCodes.BAD_REQUEST
             )
@@ -635,6 +646,7 @@ class IntegrationAPI:
             websocket, uc.WsMsgEvents.DRIVER_SETUP_CHANGE, data, uc.EventCategory.DEVICE
         )
 
+    # pylint: disable=R0917
     async def request_driver_setup_user_confirmation(
         self,
         websocket,
@@ -858,21 +870,41 @@ def filter_log_msg_data(data: dict[str, Any]) -> bool:
 
     Attention: the dictionary is modified!
 
-    - Attributes are filtered in `data["msg_data"]["attributes"]`
+    - Attributes are filtered in `data["msg_data"]`:
+      - dict object: key `attributes`
+      - list object: every list item `attributes`
     - Filtered attributes: `MEDIA_IMAGE_URL`
 
     :param data: the message data dict
     :return: True if a field was filtered, False otherwise
     """
     # filter out base64 encoded images in the media player's media_image_url attribute
-    if (
-        "msg_data" in data
-        and "attributes" in data["msg_data"]
-        and media_player.Attributes.MEDIA_IMAGE_URL in data["msg_data"]["attributes"]
-        and data["msg_data"]["attributes"][
-            media_player.Attributes.MEDIA_IMAGE_URL
-        ].startswith("data:")
-    ):
-        data["msg_data"]["attributes"][media_player.Attributes.MEDIA_IMAGE_URL] = "***"
-        return True
+    if "msg_data" in data:
+        if (
+            "attributes" in data["msg_data"]
+            and media_player.Attributes.MEDIA_IMAGE_URL
+            in data["msg_data"]["attributes"]
+            and data["msg_data"]["attributes"][
+                media_player.Attributes.MEDIA_IMAGE_URL
+            ].startswith("data:")
+        ):
+            data["msg_data"]["attributes"][
+                media_player.Attributes.MEDIA_IMAGE_URL
+            ] = "data:***"
+            return True
+
+        if isinstance(data["msg_data"], list):
+            for item in data["msg_data"]:
+                if (
+                    "attributes" in item
+                    and media_player.Attributes.MEDIA_IMAGE_URL in item["attributes"]
+                    and item["attributes"][
+                        media_player.Attributes.MEDIA_IMAGE_URL
+                    ].startswith("data:")
+                ):
+                    item["attributes"][
+                        media_player.Attributes.MEDIA_IMAGE_URL
+                    ] = "data:***"
+            return True
+
     return False

{ucapi-0.2.0 → ucapi-0.3.0}/ucapi/climate.py

@@ -79,8 +79,9 @@ class Climate(Entity):
 
     See https://github.com/unfoldedcircle/core-api/blob/main/doc/entities/entity_climate.md
     for more information.
-    """  # noqa
+    """
 
+    # pylint: disable=R0917
     def __init__(
         self,
         identifier: str,

{ucapi-0.2.0 → ucapi-0.3.0}/ucapi/cover.py

@@ -78,8 +78,9 @@ class Cover(Entity):
 
     See https://github.com/unfoldedcircle/core-api/blob/main/doc/entities/entity_cover.md
     for more information.
-    """  # noqa
+    """
 
+    # pylint: disable=R0917
     def __init__(
         self,
         identifier: str,

{ucapi-0.2.0 → ucapi-0.3.0}/ucapi/entity.py

@@ -36,6 +36,7 @@ class Entity:
     for more information.
     """
 
+    # pylint: disable=R0917
     def __init__(
         self,
         identifier: str,

{ucapi-0.2.0 → ucapi-0.3.0}/ucapi/light.py

@@ -65,8 +65,9 @@ class Light(Entity):
 
     See https://github.com/unfoldedcircle/core-api/blob/main/doc/entities/entity_light.md
     for more information.
-    """  # noqa
+    """
 
+    # pylint: disable=R0917
     def __init__(
         self,
         identifier: str,

{ucapi-0.2.0 → ucapi-0.3.0}/ucapi/media_player.py

@@ -78,6 +78,7 @@ class Attributes(str, Enum):
     MUTED = "muted"
     MEDIA_DURATION = "media_duration"
     MEDIA_POSITION = "media_position"
+    MEDIA_POSITION_UPDATED_AT = "media_position_updated_at"
     MEDIA_TYPE = "media_type"
     MEDIA_IMAGE_URL = "media_image_url"
     MEDIA_TITLE = "media_title"
@@ -193,8 +194,9 @@ class MediaPlayer(Entity):
 
     See https://github.com/unfoldedcircle/core-api/blob/main/doc/entities/entity_media_player.md
     for more information.
-    """  # noqa
+    """
 
+    # pylint: disable=R0917
     def __init__(
         self,
         identifier: str,

{ucapi-0.2.0 → ucapi-0.3.0}/ucapi/remote.py

@@ -119,8 +119,9 @@ class Remote(Entity):
 
     See https://github.com/unfoldedcircle/core-api/blob/main/doc/entities/entity_remote.md
     for more information.
-    """  # noqa
+    """
 
+    # pylint: disable=R0917
     def __init__(
         self,
         identifier: str,

{ucapi-0.2.0 → ucapi-0.3.0}/ucapi/sensor.py

@@ -64,8 +64,9 @@ class Sensor(Entity):
 
     See https://github.com/unfoldedcircle/core-api/blob/main/doc/entities/entity_sensor.md
     for more information.
-    """  # noqa
+    """
 
+    # pylint: disable=R0917
     def __init__(
         self,
         identifier: str,

{ucapi-0.2.0 → ucapi-0.3.0}/ucapi/switch.py

@@ -61,8 +61,9 @@ class Switch(Entity):
 
     See https://github.com/unfoldedcircle/core-api/blob/main/doc/entities/entity_switch.md
     for more information.
-    """  # noqa
+    """
 
+    # pylint: disable=R0917
     def __init__(
         self,
         identifier: str,

{ucapi-0.2.0 → ucapi-0.3.0/ucapi.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.4
 Name: ucapi
-Version: 0.2.0
+Version: 0.3.0
 Summary: Python wrapper for the Unfolded Circle Integration API
 Author-email: Unfolded Circle ApS <hello@unfoldedcircle.com>
 License: MPL-2.0
@@ -8,7 +8,7 @@ Project-URL: Homepage, https://www.unfoldedcircle.com/
 Project-URL: Source Code, https://github.com/unfoldedcircle/integration-python-library
 Project-URL: Bug Reports, https://github.com/unfoldedcircle/integration-python-library/issues
 Project-URL: Discord, http://unfolded.chat/
-Project-URL: Forum, http://unfolded.community/
+Project-URL: Forum, https://unfolded.community/
 Platform: any
 Classifier: Development Status :: 3 - Alpha
 Classifier: Intended Audience :: Developers
@@ -22,7 +22,7 @@ Requires-Python: >=3.10
 Description-Content-Type: text/markdown; charset=UTF-8
 License-File: LICENSE
 Requires-Dist: pyee>=9.0
-Requires-Dist: websockets>=11.0
+Requires-Dist: websockets>=14.0
 Requires-Dist: zeroconf>=0.120.0
 Provides-Extra: testing
 Requires-Dist: pylint; extra == "testing"
@@ -30,13 +30,14 @@ Requires-Dist: flake8-docstrings; extra == "testing"
 Requires-Dist: flake8; extra == "testing"
 Requires-Dist: black; extra == "testing"
 Requires-Dist: isort; extra == "testing"
+Dynamic: license-file
 
 # Python API wrapper for the UC Integration API
 [![PyPi](https://img.shields.io/pypi/v/ucapi.svg)](https://pypi.org/project/ucapi)
 [![License](https://img.shields.io/github/license/unfoldedcircle/integration-python-library.svg)](LICENSE)
 [![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
 
-This library simplifies writing Python based integrations for the [Unfolded Circle Remote Two](https://www.unfoldedcircle.com/)
+This library simplifies writing Python-based integrations for the [Unfolded Circle Remote devices](https://www.unfoldedcircle.com/)
 by wrapping the [WebSocket Integration API](https://github.com/unfoldedcircle/core-api/tree/main/integration-api).
 
 It's an alpha release (in our eyes). Breaking changes are to be expected and missing features will be continuously added.

{ucapi-0.2.0 → ucapi-0.3.0}/ucapi.egg-info/requires.txt

@@ -1,5 +1,5 @@
 pyee>=9.0
-websockets>=11.0
+websockets>=14.0
 zeroconf>=0.120.0
 
 [testing]