ucapi 0.5.0__tar.gz → 0.5.2__tar.gz

{ucapi-0.5.0 → ucapi-0.5.2}/CHANGELOG.md

@@ -11,6 +11,18 @@ _Changes in the next release_
 
 ---
 
+## v0.5.2 - 2026-01-30
+### Added
+- Add Select Entity support by @JackJPowell ([#44](https://github.com/unfoldedcircle/integration-python-library/pull/44)).
+- Add IR Emitter Entity support by @JackJPowell ([#45](https://github.com/unfoldedcircle/integration-python-library/pull/45)).
+
+## v0.5.1 - 2025-12-19
+### Added
+- Add binary sensor device class and common entity states enum ([#40](https://github.com/unfoldedcircle/integration-python-library/pull/40)).
+
+### Changed
+- Optional event loop argument in IntegrationAPI constructor ([#41](https://github.com/unfoldedcircle/integration-python-library/pull/41)).
+
 ## v0.5.0 - 2025-12-17
 ### Breaking Changes
 - Enhance entity command handler with WS client connection parameter in `CommandHandler` callback and `Entity.command`

{ucapi-0.5.0/ucapi.egg-info → ucapi-0.5.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: ucapi
-Version: 0.5.0
+Version: 0.5.2
 Summary: Python wrapper for the Unfolded Circle Integration API
 Author-email: Unfolded Circle ApS <hello@unfoldedcircle.com>
 License: MPL-2.0

{ucapi-0.5.0 → ucapi-0.5.2}/examples/hello_integration.py

@@ -1,5 +1,6 @@
 #!/usr/bin/env python3
 """Hello world integration example. Bare minimum of an integration driver."""
+
 import asyncio
 import logging
 from typing import Any

{ucapi-0.5.0 → ucapi-0.5.2}/examples/remote.py

@@ -1,5 +1,6 @@
 #!/usr/bin/env python3
 """Remote entity integration example. Bare minimum of an integration driver."""
+
 import asyncio
 import json
 import logging

{ucapi-0.5.0 → ucapi-0.5.2}/examples/setup_flow.py

@@ -1,5 +1,6 @@
 #!/usr/bin/env python3
 """Integration setup flow example."""
+
 import asyncio
 import logging
 from typing import Any

{ucapi-0.5.0 → ucapi-0.5.2}/ucapi/__init__.py

@@ -44,6 +44,7 @@ from .cover import Cover  # noqa: F401
 from .light import Light  # noqa: F401
 from .media_player import MediaPlayer  # noqa: F401
 from .remote import Remote  # noqa: F401
+from .select import Select  # noqa: F401
 from .sensor import Sensor  # noqa: F401
 from .switch import Switch  # noqa: F401
 from .voice_assistant import VoiceAssistant  # noqa: F401

{ucapi-0.5.0 → ucapi-0.5.2}/ucapi/_version.py

@@ -28,7 +28,7 @@ version_tuple: VERSION_TUPLE
 commit_id: COMMIT_ID
 __commit_id__: COMMIT_ID
 
-__version__ = version = '0.5.0'
-__version_tuple__ = version_tuple = (0, 5, 0)
+__version__ = version = '0.5.2'
+__version_tuple__ = version_tuple = (0, 5, 2)
 
-__commit_id__ = commit_id = 'gdf689d991'
+__commit_id__ = commit_id = 'g08c18e023'

{ucapi-0.5.0 → ucapi-0.5.2}/ucapi/api.py

@@ -75,13 +75,14 @@ class IntegrationAPI:
 
     DEFAULT_VOICE_SESSION_TIMEOUT_S: int = 30
 
-    def __init__(self, loop: AbstractEventLoop):
+    def __init__(self, loop: AbstractEventLoop | None = None):
         """
         Create an integration driver API instance.
 
-        :param loop: event loop
+        :param loop: optional event loop. The currently running event loop is used if
+                     not provided.
         """
-        self._loop = loop
+        self._loop = loop if loop else asyncio.get_event_loop()
         self._events = AsyncIOEventEmitter(self._loop)
 
         self._setup_handler: uc.SetupHandler | None = None

{ucapi-0.5.0 → ucapi-0.5.2}/ucapi/entity.py

@@ -25,12 +25,23 @@ class EntityTypes(str, Enum):
     LIGHT = "light"
     MEDIA_PLAYER = "media_player"
     REMOTE = "remote"
+    SELECT = "select"
     SENSOR = "sensor"
     SWITCH = "switch"
     IR_EMITTER = "ir_emitter"
     VOICE_ASSISTANT = "voice_assistant"
 
 
+class CommonStates(str, Enum):
+    """Common entity states available in all entities."""
+
+    UNAVAILABLE = "UNAVAILABLE"
+    """The entity is currently not available.
+    The UI will render the entity as inactive until the entity becomes active again."""
+    UNKNOWN = "UNKNOWN"
+    """The entity is available but the current state is unknown."""
+
+
 class Entity:
     """
     Entity base class.

ucapi-0.5.2/ucapi/ir_emitter.py

@@ -0,0 +1,93 @@
+"""
+IR Emitter entity definitions.
+
+:copyright: (c) 2023 by Unfolded Circle ApS.
+:license: MPL-2.0, see LICENSE for more details.
+"""
+
+from enum import Enum
+from typing import Any
+
+from .api_definitions import CommandHandler
+from .entity import Entity, EntityTypes
+
+
+class States(str, Enum):
+    """IR Emitter entity states."""
+
+    UNAVAILABLE = "UNAVAILABLE"
+    UNKNOWN = "UNKNOWN"
+    ON = "ON"
+
+
+class Features(str, Enum):
+    """IR Emitter entity features."""
+
+    SEND_IR = "send_ir"
+
+
+class Attributes(str, Enum):
+    """IR Emitter entity attributes."""
+
+    STATE = "state"
+
+
+class Commands(str, Enum):
+    """IR Emitter entity commands."""
+
+    SEND_IR = "send_ir"
+    STOP_IR = "stop_ir"
+
+
+class DeviceClasses(str, Enum):
+    """IR Emitter entity device classes."""
+
+
+class Options(str, Enum):
+    """IR Emitter entity options."""
+
+    PORTS = "ports"
+    IR_FORMATS = "ir_formats"
+
+
+class IREmitter(Entity):
+    """
+    IR Emitter entity class.
+
+    See https://github.com/unfoldedcircle/core-api/blob/main/doc/entities/entity_ir_emitter.md
+    for more information.
+    """
+
+    # pylint: disable=R0917
+    def __init__(
+        self,
+        identifier: str,
+        name: str | dict[str, str],
+        features: list[Features],
+        attributes: dict[str, Any],
+        *,
+        options: dict[str, Any] | None = None,
+        area: str | None = None,
+        cmd_handler: CommandHandler = None,
+    ):
+        """
+        Create IR Emitter instance.
+
+        :param identifier: entity identifier
+        :param name: friendly name
+        :param features: IR Emitter features
+        :param attributes: IR Emitter attributes
+        :param options: IR Emitter options
+        :param area: optional area
+        :param cmd_handler: handler for entity commands
+        """
+        super().__init__(
+            identifier,
+            name,
+            EntityTypes.IR_EMITTER,
+            features,
+            attributes,
+            options=options,
+            area=area,
+            cmd_handler=cmd_handler,
+        )

ucapi-0.5.2/ucapi/select.py

@@ -0,0 +1,88 @@
+"""
+Switch entity definitions.
+
+:copyright: (c) 2023 by Unfolded Circle ApS.
+:license: MPL-2.0, see LICENSE for more details.
+"""
+
+from enum import Enum
+from typing import Any
+
+from .api_definitions import CommandHandler
+from .entity import Entity, EntityTypes
+
+
+class States(str, Enum):
+    """Select entity states."""
+
+    UNAVAILABLE = "UNAVAILABLE"
+    UNKNOWN = "UNKNOWN"
+    ON = "ON"
+
+
+class Features(str, Enum):
+    """Select entity features."""
+
+
+class Attributes(str, Enum):
+    """Select entity attributes."""
+
+    STATE = "state"
+    CURRENT_OPTION = "current_option"
+    OPTIONS = "options"
+
+
+class Commands(str, Enum):
+    """Select entity commands."""
+
+    SELECT_OPTION = "select_option"
+    SELECT_FIRST = "select_first"
+    SELECT_LAST = "select_last"
+    SELECT_NEXT = "select_next"
+    SELECT_PREVIOUS = "select_previous"
+
+
+class DeviceClasses(str, Enum):
+    """Select entity device classes."""
+
+
+class Options(str, Enum):
+    """Select entity options."""
+
+
+class Select(Entity):
+    """
+    Select entity class.
+
+    See https://github.com/unfoldedcircle/core-api/blob/main/doc/entities/entity_select.md
+    for more information.
+    """
+
+    # pylint: disable=R0917
+    def __init__(
+        self,
+        identifier: str,
+        name: str | dict[str, str],
+        attributes: dict[str, Any],
+        *,
+        area: str | None = None,
+        cmd_handler: CommandHandler = None,
+    ):
+        """
+        Create select-entity instance.
+
+        :param identifier: entity identifier
+        :param name: friendly name
+        :param attributes: select attributes
+        :param area: optional area
+        :param cmd_handler: handler for entity commands
+        """
+        super().__init__(
+            identifier,
+            name,
+            EntityTypes.SELECT,
+            [],
+            attributes,
+            area=area,
+            cmd_handler=cmd_handler,
+        )

{ucapi-0.5.0 → ucapi-0.5.2}/ucapi/sensor.py

@@ -15,8 +15,12 @@ class States(str, Enum):
     """Sensor entity states."""
 
     UNAVAILABLE = "UNAVAILABLE"
+    """The sensor is currently not available.
+    The UI will render the sensor as inactive until the sensor becomes active again."""
     UNKNOWN = "UNKNOWN"
+    """The sensor is available but the current state is unknown."""
     ON = "ON"
+    """The sensor is available and providing measurements."""
 
 
 class Features(str, Enum):
@@ -27,8 +31,11 @@ class Attributes(str, Enum):
     """Sensor entity attributes."""
 
     STATE = "state"
+    """Optional state of the sensor."""
     VALUE = "value"
+    """The native measurement value of the sensor."""
     UNIT = "unit"
+    """Optional unit of the ``value`` if no default unit is set."""
 
 
 class Commands(str, Enum):
@@ -36,33 +43,61 @@ class Commands(str, Enum):
 
 
 class DeviceClasses(str, Enum):
-    """Sensor entity device classes."""
+    """Sensor entity device classes.
+
+    See https://unfoldedcircle.github.io/core-api/entities/entity_sensor.html
+    for more information about binary sensors.
+    """
 
     CUSTOM = "custom"
+    """Generic sensor with custom unit"""
     BATTERY = "battery"
+    """Battery charge in %"""
     CURRENT = "current"
+    """Electrical current in ampere"""
     ENERGY = "energy"
+    """Energy in kilowatt-hour"""
     HUMIDITY = "humidity"
+    """Humidity in %"""
     POWER = "power"
+    """Power in watt or kilowatt"""
     TEMPERATURE = "temperature"
     VOLTAGE = "voltage"
+    """Voltage in volt"""
+    BINARY = "binary"
+    """Binary sensor.
+     The binary specific device class is stored in the ``unit`` attribute."""
 
 
 class Options(str, Enum):
     """Sensor entity options."""
 
     CUSTOM_UNIT = "custom_unit"
+    """Unit label for a custom sensor if device_class is not specified or to override
+     a default unit."""
     NATIVE_UNIT = "native_unit"
+    """The sensor's native unit of measurement to perform automatic conversion.
+     Applicable to device classes: ``temperature``."""
     DECIMALS = "decimals"
+    """Number of decimal places to show in the UI if the sensor provides the measurement
+     as a number. Not applicable to string values."""
     MIN_VALUE = "min_value"
+    """Not yet supported.
+
+    Optional minimum value of the sensor output. This can be used in the UI for graphs
+    or gauges."""
     MAX_VALUE = "max_value"
+    """Not yet supported.
+
+    Optional maximum value of the sensor output. This can be used in the UI for graphs
+    or gauges."""
 
 
 class Sensor(Entity):
     """
     Sensor entity class.
 
-    See https://github.com/unfoldedcircle/core-api/blob/main/doc/entities/entity_sensor.md
+    See https://unfoldedcircle.github.io/core-api/entities/entity_sensor.html
     for more information.
     """
 
@@ -78,7 +113,7 @@ class Sensor(Entity):
         area: str | None = None,
     ):
         """
-        Create sensor-entity instance.
+        Create a sensor-entity instance.
 
         :param identifier: entity identifier
         :param name: friendly name

{ucapi-0.5.0 → ucapi-0.5.2/ucapi.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: ucapi
-Version: 0.5.0
+Version: 0.5.2
 Summary: Python wrapper for the Unfolded Circle Integration API
 Author-email: Unfolded Circle ApS <hello@unfoldedcircle.com>
 License: MPL-2.0

{ucapi-0.5.0 → ucapi-0.5.2}/ucapi.egg-info/SOURCES.txt

@@ -30,9 +30,11 @@ ucapi/climate.py
 ucapi/cover.py
 ucapi/entities.py
 ucapi/entity.py
+ucapi/ir_emitter.py
 ucapi/light.py
 ucapi/media_player.py
 ucapi/remote.py
+ucapi/select.py
 ucapi/sensor.py
 ucapi/switch.py
 ucapi/ui.py