ucapi 0.3.1__tar.gz → 0.4.0__tar.gz

{ucapi-0.3.1 → ucapi-0.4.0}/CHANGELOG.md

@@ -11,11 +11,28 @@ _Changes in the next release_
 
 ---
 
-## v0.3.1 - 2024-05-14
+## v0.4.0 - 2025-11-24
+### Breaking Changes
+- A WebSocket disconnection no longer emits the `DISCONNECT` event, but the new `CLIENT_DISCONNECTED` event ([#35](https://github.com/unfoldedcircle/integration-python-library/pull/35)).
+
+### Added
+- New `CLIENT_CONNECTED` event is emitted when a WebSocket client connects ([#35](https://github.com/unfoldedcircle/integration-python-library/pull/35)).
+- WebSocket client identification in disconnect log statements.
+
+### Fixed
+- Null reference exception in log filter ([#33](https://github.com/unfoldedcircle/integration-python-library/pull/33)).
+- Set changed size during iteration for WS broadcast ([#36](https://github.com/unfoldedcircle/integration-python-library/pull/36)).
+
+## v0.3.2 - 2025-09-17
+### Changed
+- Add support for IR Emitter EntityType ([#31](https://github.com/unfoldedcircle/integration-python-library/pull/31)).
+- Add stop, record and menu for remote entity buttons ([#32](https://github.com/unfoldedcircle/integration-python-library/pull/32)).
+
+## v0.3.1 - 2025-05-14
 ### Fixed
 - Filtered log messages may not modify original data. This sporadically removed media artwork URLs ([#27](https://github.com/unfoldedcircle/integration-python-library/pull/27)).
 
-## v0.3.0 - 2024-04-25
+## v0.3.0 - 2025-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

{ucapi-0.3.1/ucapi.egg-info → ucapi-0.4.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: ucapi
-Version: 0.3.1
+Version: 0.4.0
 Summary: Python wrapper for the Unfolded Circle Integration API
 Author-email: Unfolded Circle ApS <hello@unfoldedcircle.com>
 License: MPL-2.0
@@ -10,7 +10,7 @@ Project-URL: Bug Reports, https://github.com/unfoldedcircle/integration-python-l
 Project-URL: Discord, http://unfolded.chat/
 Project-URL: Forum, https://unfolded.community/
 Platform: any
-Classifier: Development Status :: 3 - Alpha
+Classifier: Development Status :: 4 - Beta
 Classifier: Intended Audience :: Developers
 Classifier: License :: OSI Approved :: Mozilla Public License 2.0 (MPL 2.0)
 Classifier: Operating System :: OS Independent

{ucapi-0.3.1 → ucapi-0.4.0}/pyproject.toml

@@ -10,7 +10,7 @@ authors = [
 license = {text = "MPL-2.0"}
 description = "Python wrapper for the Unfolded Circle Integration API"
 classifiers = [
-    "Development Status :: 3 - Alpha",
+    "Development Status :: 4 - Beta",
     "Intended Audience :: Developers",
     "License :: OSI Approved :: Mozilla Public License 2.0 (MPL 2.0)",
     "Operating System :: OS Independent",

{ucapi-0.3.1 → ucapi-0.4.0}/ucapi/_version.py

@@ -1,7 +1,14 @@
 # file generated by setuptools-scm
 # don't change, don't track in version control
 
-__all__ = ["__version__", "__version_tuple__", "version", "version_tuple"]
+__all__ = [
+    "__version__",
+    "__version_tuple__",
+    "version",
+    "version_tuple",
+    "__commit_id__",
+    "commit_id",
+]
 
 TYPE_CHECKING = False
 if TYPE_CHECKING:
@@ -9,13 +16,19 @@ if TYPE_CHECKING:
     from typing import Union
 
     VERSION_TUPLE = Tuple[Union[int, str], ...]
+    COMMIT_ID = Union[str, None]
 else:
     VERSION_TUPLE = object
+    COMMIT_ID = object
 
 version: str
 __version__: str
 __version_tuple__: VERSION_TUPLE
 version_tuple: VERSION_TUPLE
+commit_id: COMMIT_ID
+__commit_id__: COMMIT_ID
 
-__version__ = version = '0.3.1'
-__version_tuple__ = version_tuple = (0, 3, 1)
+__version__ = version = '0.4.0'
+__version_tuple__ = version_tuple = (0, 4, 0)
+
+__commit_id__ = commit_id = 'gca3836121'

{ucapi-0.3.1 → ucapi-0.4.0}/ucapi/api.py

@@ -162,24 +162,35 @@ class IntegrationAPI:
             # authenticate on connection
             await self._authenticate(websocket, True)
 
+            self._events.emit(uc.Events.CLIENT_CONNECTED)
+
             async for message in websocket:
                 # process message
                 await self._process_ws_message(websocket, message)
 
         except ConnectionClosedOK:
-            _LOG.info("WS: Connection closed")
+            _LOG.info("[%s] WS: Connection closed", websocket.remote_address)
 
         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)
+            _LOG.info(
+                "[%s] WS: Connection closed with error %d: %s",
+                websocket.remote_address,
+                e.code,
+                e.reason,
+            )
 
         except websockets.exceptions.WebSocketException as e:
-            _LOG.error("WS: Connection closed due to processing error: %s", e)
+            _LOG.error(
+                "[%s] WS: Connection closed due to processing error: %s",
+                websocket.remote_address,
+                e,
+            )
 
         finally:
             self._clients.remove(websocket)
-            _LOG.info("WS: Client removed")
-            self._events.emit(uc.Events.DISCONNECT)
+            _LOG.info("[%s] WS: Client removed", websocket.remote_address)
+            self._events.emit(uc.Events.CLIENT_DISCONNECTED)
 
     async def _send_ok_result(
         self, websocket, req_id: int, msg_data: dict[str, Any] | list | None = None
@@ -273,7 +284,7 @@ class IntegrationAPI:
         data = {"kind": "event", "msg": msg, "msg_data": msg_data, "cat": category}
         data_dump = json.dumps(data)
 
-        for websocket in self._clients:
+        for websocket in self._clients.copy():
             if _LOG.isEnabledFor(logging.DEBUG):
                 _LOG.debug(
                     "[%s] =>: %s", websocket.remote_address, filter_log_msg_data(data)
@@ -763,6 +774,11 @@ class IntegrationAPI:
     # Properties #
     ##############
 
+    @property
+    def client_count(self) -> int:
+        """Return number of WebSocket clients."""
+        return len(self._clients)
+
     @property
     def device_state(self) -> uc.DeviceStates:
         """
@@ -887,9 +903,12 @@ def filter_log_msg_data(data: dict[str, Any]) -> dict[str, Any]:
         if (
             "attributes" in log_upd["msg_data"]
             and MediaAttr.MEDIA_IMAGE_URL in log_upd["msg_data"]["attributes"]
-            and log_upd["msg_data"]["attributes"][MediaAttr.MEDIA_IMAGE_URL].startswith(
-                "data:"
+            and (
+                media_image_url := log_upd["msg_data"]["attributes"][
+                    MediaAttr.MEDIA_IMAGE_URL
+                ]
             )
+            and media_image_url.startswith("data:")
         ):
             log_upd["msg_data"]["attributes"][MediaAttr.MEDIA_IMAGE_URL] = "data:***"
         elif isinstance(log_upd["msg_data"], list):
@@ -897,9 +916,10 @@ def filter_log_msg_data(data: dict[str, Any]) -> dict[str, Any]:
                 if (
                     "attributes" in item
                     and MediaAttr.MEDIA_IMAGE_URL in item["attributes"]
-                    and item["attributes"][MediaAttr.MEDIA_IMAGE_URL].startswith(
-                        "data:"
+                    and (
+                        media_image_url := item["attributes"][MediaAttr.MEDIA_IMAGE_URL]
                     )
+                    and media_image_url.startswith("data:")
                 ):
                     item["attributes"][MediaAttr.MEDIA_IMAGE_URL] = "data:***"
 

{ucapi-0.3.1 → ucapi-0.4.0}/ucapi/api_definitions.py

@@ -82,13 +82,23 @@ class WsMsgEvents(str, Enum):
 class Events(str, Enum):
     """Internal library events."""
 
+    CLIENT_CONNECTED = "client_connected"
+    """WebSocket client connected."""
+    CLIENT_DISCONNECTED = "client_disconnected"
+    """WebSocket client disconnected."""
     ENTITY_ATTRIBUTES_UPDATED = "entity_attributes_updated"
     SUBSCRIBE_ENTITIES = "subscribe_entities"
+    """Integration API `subscribe_events` message."""
     UNSUBSCRIBE_ENTITIES = "unsubscribe_entities"
+    """Integration API `unsubscribe_events` message."""
     CONNECT = "connect"
+    """Integration-API `connect` event message."""
     DISCONNECT = "disconnect"
+    """Integration-API `disconnect` event message."""
     ENTER_STANDBY = "enter_standby"
+    """Integration-API `enter_standby` event message."""
     EXIT_STANDBY = "exit_standby"
+    """Integration-API `exit_standby` event message."""
 
 
 # Does EventCategory need to be public?

{ucapi-0.3.1 → ucapi-0.4.0}/ucapi/entity.py

@@ -26,6 +26,7 @@ class EntityTypes(str, Enum):
     REMOTE = "remote"
     SENSOR = "sensor"
     SWITCH = "switch"
+    IR_EMITTER = "ir_emitter"
 
 
 class Entity:

{ucapi-0.3.1 → ucapi-0.4.0}/ucapi/ui.py

@@ -41,6 +41,9 @@ class Buttons(str, Enum):
     PLAY = "PLAY"
     NEXT = "NEXT"
     POWER = "POWER"
+    STOP = "STOP"
+    RECORD = "RECORD"
+    MENU = "MENU"
 
 
 @dataclass

{ucapi-0.3.1 → ucapi-0.4.0/ucapi.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: ucapi
-Version: 0.3.1
+Version: 0.4.0
 Summary: Python wrapper for the Unfolded Circle Integration API
 Author-email: Unfolded Circle ApS <hello@unfoldedcircle.com>
 License: MPL-2.0
@@ -10,7 +10,7 @@ Project-URL: Bug Reports, https://github.com/unfoldedcircle/integration-python-l
 Project-URL: Discord, http://unfolded.chat/
 Project-URL: Forum, https://unfolded.community/
 Platform: any
-Classifier: Development Status :: 3 - Alpha
+Classifier: Development Status :: 4 - Beta
 Classifier: Intended Audience :: Developers
 Classifier: License :: OSI Approved :: Mozilla Public License 2.0 (MPL 2.0)
 Classifier: Operating System :: OS Independent