matter-python-client 1.5.0a0.dev202610160251__tar.gz → 1.5.0a0.dev202610171259__tar.gz

{matter_python_client-1.5.0a0.dev202610160251 → matter_python_client-1.5.0a0.dev202610171259}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: matter-python-client
-Version: 1.5.0a0.dev202610160251
+Version: 1.5.0a0.dev202610171259
 Summary: Python Client for the OHF Matter Server
 Author-email: Open Home Foundation <hello@openhomefoundation.io>
 License-Expression: Apache-2.0
@@ -110,6 +110,27 @@ Beyond the `python-matter-server` API, the client exposes commands the Matter.js
   then streams the bytes to `POST /ota-upload/<upload_id>`. Raises `OtaUploadError` (code 101) for a
   corrupt image, an expired/spent id, or disabled OTA support.
 - `get_icd_state`, `register_icd`, `unregister_icd`, `resync_icd` — ICD Check-In registration
+- `read`, `subscribe`, `unsubscribe`, `enable_auto_subscription`, `disable_auto_subscription` — Matter
+  read and subscribe requests with explicit paths (schema 14+). `read` returns an `InteractionReport`,
+  `subscribe` a `SubscribeResult` (the priming report plus `subscription_id`). A subscription is named by
+  `node_id` and `subscription_id` together. Later reports arrive as `subscription_report` events
+  (`SubscriptionReportData`), an end the caller did not ask for as `subscription_ended`
+  (`SubscriptionEndedData`); both go only to the connection that subscribed and reach `node_filter`
+  subscribers. Pass `listener` to `subscribe` to get every event of that one subscription, including those
+  the server sends right behind the response. The listener gets no further calls once `unsubscribe` is
+  called. When the connection is lost or `disconnect` is called, the listener receives a
+  `subscription_ended` that the client builds itself, because the server ends the subscription without
+  sending one; `node_filter` subscribers do not get it. If a `subscribe` call is cancelled or times out
+  (for example in `asyncio.wait_for`) before it returns, the client ends that subscription with
+  `unsubscribe` and logs a failure of that call. `subscribe`, `unsubscribe` and the two auto
+  subscription methods need a server running with auto subscription disabled.
+- `commission_with_code` and `commission_on_network` take `discovery_timeout_s` (schema 14+)
+- `send_batched_device_commands` — sends `(endpoint_id, command)` pairs to one node in a single InvokeRequest and returns
+  one `BatchedCommandResult` per command (schema 14+)
+- `write_attribute` takes `*` as the endpoint to write all endpoints of the node that have the attribute, and
+  `timed_request_timeout_ms` for a timed write (schema 14+)
+- `parse_onboarding_payload` — decodes a QR code or manual pairing code without contacting a device and returns
+  `QrOnboardingPayloadResult` or `ManualOnboardingPayloadResult` (schema 14+)
 - `camera_get_capabilities`, `camera_start_stream`, `camera_provide_answer`,
   `camera_provide_ice_candidates`, `camera_stop_stream`, `camera_snapshot`, `camera_release_stream`
   — the camera API (schema 14+). `camera_get_capabilities`, `camera_start_stream`, `camera_stop_stream`

{matter_python_client-1.5.0a0.dev202610160251 → matter_python_client-1.5.0a0.dev202610171259}/README.md

@@ -78,6 +78,27 @@ Beyond the `python-matter-server` API, the client exposes commands the Matter.js
   then streams the bytes to `POST /ota-upload/<upload_id>`. Raises `OtaUploadError` (code 101) for a
   corrupt image, an expired/spent id, or disabled OTA support.
 - `get_icd_state`, `register_icd`, `unregister_icd`, `resync_icd` — ICD Check-In registration
+- `read`, `subscribe`, `unsubscribe`, `enable_auto_subscription`, `disable_auto_subscription` — Matter
+  read and subscribe requests with explicit paths (schema 14+). `read` returns an `InteractionReport`,
+  `subscribe` a `SubscribeResult` (the priming report plus `subscription_id`). A subscription is named by
+  `node_id` and `subscription_id` together. Later reports arrive as `subscription_report` events
+  (`SubscriptionReportData`), an end the caller did not ask for as `subscription_ended`
+  (`SubscriptionEndedData`); both go only to the connection that subscribed and reach `node_filter`
+  subscribers. Pass `listener` to `subscribe` to get every event of that one subscription, including those
+  the server sends right behind the response. The listener gets no further calls once `unsubscribe` is
+  called. When the connection is lost or `disconnect` is called, the listener receives a
+  `subscription_ended` that the client builds itself, because the server ends the subscription without
+  sending one; `node_filter` subscribers do not get it. If a `subscribe` call is cancelled or times out
+  (for example in `asyncio.wait_for`) before it returns, the client ends that subscription with
+  `unsubscribe` and logs a failure of that call. `subscribe`, `unsubscribe` and the two auto
+  subscription methods need a server running with auto subscription disabled.
+- `commission_with_code` and `commission_on_network` take `discovery_timeout_s` (schema 14+)
+- `send_batched_device_commands` — sends `(endpoint_id, command)` pairs to one node in a single InvokeRequest and returns
+  one `BatchedCommandResult` per command (schema 14+)
+- `write_attribute` takes `*` as the endpoint to write all endpoints of the node that have the attribute, and
+  `timed_request_timeout_ms` for a timed write (schema 14+)
+- `parse_onboarding_payload` — decodes a QR code or manual pairing code without contacting a device and returns
+  `QrOnboardingPayloadResult` or `ManualOnboardingPayloadResult` (schema 14+)
 - `camera_get_capabilities`, `camera_start_stream`, `camera_provide_answer`,
   `camera_provide_ice_candidates`, `camera_stop_stream`, `camera_snapshot`, `camera_release_stream`
   — the camera API (schema 14+). `camera_get_capabilities`, `camera_start_stream`, `camera_stop_stream`

{matter_python_client-1.5.0a0.dev202610160251 → matter_python_client-1.5.0a0.dev202610171259}/chip/clusters/Objects.py

@@ -167,6 +167,7 @@ __all__ = [
     "TlsClientManagement",
     "TotalVolatileOrganicCompoundsConcentrationMeasurement",
     "UnitLocalization",
+    "UnitTestingCluster",
     "UserLabel",
     "ValveConfigurationAndControl",
     "WagoCluster",

{matter_python_client-1.5.0a0.dev202610160251 → matter_python_client-1.5.0a0.dev202610171259}/chip/clusters/cluster_defs/HeimanCluster.py

@@ -63,10 +63,30 @@ class HeimanCluster(Cluster):
             def descriptor(cls) -> ClusterObjectDescriptor:
                 return ClusterObjectDescriptor(
                     Fields=[
-                        ClusterObjectFieldDescriptor(Label="mutingTime", Tag=0, Type=typing.Optional[uint]),
+                        ClusterObjectFieldDescriptor(Label="mutingTime", Tag=0, Type=uint),
                     ])
 
-            mutingTime: typing.Optional[uint] = None
+            mutingTime: uint = 0
+
+        @dataclass
+        class SirenActivate(ClusterCommand):
+            cluster_id: typing.ClassVar[int] = 0x120BFC01
+            command_id: typing.ClassVar[int] = 0x00000001
+            is_client: typing.ClassVar[bool] = True
+            response_type: typing.ClassVar[typing.Optional[str]] = None
+
+            @ChipUtility.classproperty
+            def descriptor(cls) -> ClusterObjectDescriptor:
+                return ClusterObjectDescriptor(
+                    Fields=[
+                        ClusterObjectFieldDescriptor(Label="sirenType", Tag=0, Type=uint),
+                        ClusterObjectFieldDescriptor(Label="volume", Tag=1, Type=uint),
+                        ClusterObjectFieldDescriptor(Label="duration", Tag=2, Type=uint),
+                    ])
+
+            sirenType: uint = 0
+            volume: uint = 0
+            duration: uint = 0
 
     class Attributes:
         @dataclass

matter_python_client-1.5.0a0.dev202610171259/chip/clusters/cluster_defs/UnitTestingCluster.py

@@ -0,0 +1,245 @@
+"""UnitTestingCluster cluster definition (auto-generated, DO NOT edit)."""
+
+from __future__ import annotations
+
+import typing
+from dataclasses import dataclass, field
+from enum import IntFlag
+
+from ... import ChipUtility
+from ...clusters.enum import MatterIntEnum
+from ...tlv import float32, uint
+from ..ClusterObjects import (Cluster, ClusterAttributeDescriptor, ClusterCommand, ClusterEvent, ClusterObject,
+                              ClusterObjectDescriptor, ClusterObjectFieldDescriptor)
+from ..Types import Nullable, NullValue
+
+
+@dataclass
+class UnitTestingCluster(Cluster):
+    id: typing.ClassVar[int] = 0xFFF1FC05
+
+    @ChipUtility.classproperty
+    def descriptor(cls) -> ClusterObjectDescriptor:
+        return ClusterObjectDescriptor(
+            Fields=[
+                ClusterObjectFieldDescriptor(Label="floatSingle", Tag=0x00000017, Type=typing.Optional[float32]),
+                ClusterObjectFieldDescriptor(Label="octetString", Tag=0x00000019, Type=typing.Optional[bytes]),
+                ClusterObjectFieldDescriptor(Label="structAttr", Tag=0x00000025, Type=typing.Optional[UnitTestingCluster.Structs.UnitTestingSimpleStruct]),
+                ClusterObjectFieldDescriptor(Label="listLongOctetString", Tag=0x0000002A, Type=typing.Optional[typing.List[bytes]]),
+                ClusterObjectFieldDescriptor(Label="generatedCommandList", Tag=0x0000FFF8, Type=typing.List[uint]),
+                ClusterObjectFieldDescriptor(Label="acceptedCommandList", Tag=0x0000FFF9, Type=typing.List[uint]),
+                ClusterObjectFieldDescriptor(Label="attributeList", Tag=0x0000FFFB, Type=typing.List[uint]),
+                ClusterObjectFieldDescriptor(Label="featureMap", Tag=0x0000FFFC, Type=uint),
+                ClusterObjectFieldDescriptor(Label="clusterRevision", Tag=0x0000FFFD, Type=uint),
+            ])
+
+    floatSingle: typing.Optional[float32] = None
+    octetString: typing.Optional[bytes] = None
+    structAttr: typing.Optional[UnitTestingCluster.Structs.UnitTestingSimpleStruct] = None
+    listLongOctetString: typing.Optional[typing.List[bytes]] = None
+    generatedCommandList: typing.List[uint] = field(default_factory=lambda: [])
+    acceptedCommandList: typing.List[uint] = field(default_factory=lambda: [])
+    attributeList: typing.List[uint] = field(default_factory=lambda: [])
+    featureMap: uint = 0
+    clusterRevision: uint = 0
+
+    class Enums:
+        class SimpleEnum(MatterIntEnum):
+            kUnspecified = 0x00
+            kValueA = 0x01
+            kValueB = 0x02
+            kValueC = 0x03
+            # All received enum values that are not listed above will be mapped
+            # to kUnknownEnumValue. This is a helper enum value that should only
+            # be used by code to process how it handles receiving an unknown
+            # enum value. This specific value should never be transmitted.
+            kUnknownEnumValue = 4
+
+        class TestGlobalEnum(MatterIntEnum):
+            kSomeValue = 0x00
+            kSomeOtherValue = 0x01
+            kFinalValue = 0x02
+            # All received enum values that are not listed above will be mapped
+            # to kUnknownEnumValue. This is a helper enum value that should only
+            # be used by code to process how it handles receiving an unknown
+            # enum value. This specific value should never be transmitted.
+            kUnknownEnumValue = 3
+
+    class Bitmaps:
+        class SimpleBitmap(IntFlag):
+            kValueA = 0x1
+            kValueB = 0x2
+            kValueC = 0x4
+
+    class Structs:
+        @dataclass
+        class UnitTestingSimpleStruct(ClusterObject):
+            @ChipUtility.classproperty
+            def descriptor(cls) -> ClusterObjectDescriptor:
+                return ClusterObjectDescriptor(
+                    Fields=[
+                        ClusterObjectFieldDescriptor(Label="a", Tag=0, Type=uint),
+                        ClusterObjectFieldDescriptor(Label="b", Tag=1, Type=bool),
+                        ClusterObjectFieldDescriptor(Label="c", Tag=2, Type=UnitTestingCluster.Enums.SimpleEnum),
+                        ClusterObjectFieldDescriptor(Label="d", Tag=3, Type=bytes),
+                        ClusterObjectFieldDescriptor(Label="e", Tag=4, Type=str),
+                        ClusterObjectFieldDescriptor(Label="f", Tag=5, Type=UnitTestingCluster.Bitmaps.SimpleBitmap),
+                        ClusterObjectFieldDescriptor(Label="g", Tag=6, Type=float32),
+                        ClusterObjectFieldDescriptor(Label="h", Tag=7, Type=float),
+                        ClusterObjectFieldDescriptor(Label="i", Tag=8, Type=typing.Optional[UnitTestingCluster.Enums.TestGlobalEnum]),
+                    ])
+
+            a: uint = 0
+            b: bool = False
+            c: UnitTestingCluster.Enums.SimpleEnum = 0
+            d: bytes = b""
+            e: str = ""
+            f: UnitTestingCluster.Bitmaps.SimpleBitmap = 0
+            g: float32 = 0.0
+            h: float = 0.0
+            i: typing.Optional[UnitTestingCluster.Enums.TestGlobalEnum] = None
+
+    class Attributes:
+        @dataclass
+        class FloatSingle(ClusterAttributeDescriptor):
+            @ChipUtility.classproperty
+            def cluster_id(cls) -> int:
+                return 0xFFF1FC05
+
+            @ChipUtility.classproperty
+            def attribute_id(cls) -> int:
+                return 0x00000017
+
+            @ChipUtility.classproperty
+            def attribute_type(cls) -> ClusterObjectFieldDescriptor:
+                return ClusterObjectFieldDescriptor(Type=typing.Optional[float32])
+
+            value: typing.Optional[float32] = None
+
+        @dataclass
+        class OctetString(ClusterAttributeDescriptor):
+            @ChipUtility.classproperty
+            def cluster_id(cls) -> int:
+                return 0xFFF1FC05
+
+            @ChipUtility.classproperty
+            def attribute_id(cls) -> int:
+                return 0x00000019
+
+            @ChipUtility.classproperty
+            def attribute_type(cls) -> ClusterObjectFieldDescriptor:
+                return ClusterObjectFieldDescriptor(Type=typing.Optional[bytes])
+
+            value: typing.Optional[bytes] = None
+
+        @dataclass
+        class StructAttr(ClusterAttributeDescriptor):
+            @ChipUtility.classproperty
+            def cluster_id(cls) -> int:
+                return 0xFFF1FC05
+
+            @ChipUtility.classproperty
+            def attribute_id(cls) -> int:
+                return 0x00000025
+
+            @ChipUtility.classproperty
+            def attribute_type(cls) -> ClusterObjectFieldDescriptor:
+                return ClusterObjectFieldDescriptor(Type=typing.Optional[UnitTestingCluster.Structs.UnitTestingSimpleStruct])
+
+            value: typing.Optional[UnitTestingCluster.Structs.UnitTestingSimpleStruct] = None
+
+        @dataclass
+        class ListLongOctetString(ClusterAttributeDescriptor):
+            @ChipUtility.classproperty
+            def cluster_id(cls) -> int:
+                return 0xFFF1FC05
+
+            @ChipUtility.classproperty
+            def attribute_id(cls) -> int:
+                return 0x0000002A
+
+            @ChipUtility.classproperty
+            def attribute_type(cls) -> ClusterObjectFieldDescriptor:
+                return ClusterObjectFieldDescriptor(Type=typing.Optional[typing.List[bytes]])
+
+            value: typing.Optional[typing.List[bytes]] = None
+
+        @dataclass
+        class GeneratedCommandList(ClusterAttributeDescriptor):
+            @ChipUtility.classproperty
+            def cluster_id(cls) -> int:
+                return 0xFFF1FC05
+
+            @ChipUtility.classproperty
+            def attribute_id(cls) -> int:
+                return 0x0000FFF8
+
+            @ChipUtility.classproperty
+            def attribute_type(cls) -> ClusterObjectFieldDescriptor:
+                return ClusterObjectFieldDescriptor(Type=typing.List[uint])
+
+            value: typing.List[uint] = field(default_factory=lambda: [])
+
+        @dataclass
+        class AcceptedCommandList(ClusterAttributeDescriptor):
+            @ChipUtility.classproperty
+            def cluster_id(cls) -> int:
+                return 0xFFF1FC05
+
+            @ChipUtility.classproperty
+            def attribute_id(cls) -> int:
+                return 0x0000FFF9
+
+            @ChipUtility.classproperty
+            def attribute_type(cls) -> ClusterObjectFieldDescriptor:
+                return ClusterObjectFieldDescriptor(Type=typing.List[uint])
+
+            value: typing.List[uint] = field(default_factory=lambda: [])
+
+        @dataclass
+        class AttributeList(ClusterAttributeDescriptor):
+            @ChipUtility.classproperty
+            def cluster_id(cls) -> int:
+                return 0xFFF1FC05
+
+            @ChipUtility.classproperty
+            def attribute_id(cls) -> int:
+                return 0x0000FFFB
+
+            @ChipUtility.classproperty
+            def attribute_type(cls) -> ClusterObjectFieldDescriptor:
+                return ClusterObjectFieldDescriptor(Type=typing.List[uint])
+
+            value: typing.List[uint] = field(default_factory=lambda: [])
+
+        @dataclass
+        class FeatureMap(ClusterAttributeDescriptor):
+            @ChipUtility.classproperty
+            def cluster_id(cls) -> int:
+                return 0xFFF1FC05
+
+            @ChipUtility.classproperty
+            def attribute_id(cls) -> int:
+                return 0x0000FFFC
+
+            @ChipUtility.classproperty
+            def attribute_type(cls) -> ClusterObjectFieldDescriptor:
+                return ClusterObjectFieldDescriptor(Type=uint)
+
+            value: uint = 0
+
+        @dataclass
+        class ClusterRevision(ClusterAttributeDescriptor):
+            @ChipUtility.classproperty
+            def cluster_id(cls) -> int:
+                return 0xFFF1FC05
+
+            @ChipUtility.classproperty
+            def attribute_id(cls) -> int:
+                return 0x0000FFFD
+
+            @ChipUtility.classproperty
+            def attribute_type(cls) -> ClusterObjectFieldDescriptor:
+                return ClusterObjectFieldDescriptor(Type=uint)
+
+            value: uint = 0

{matter_python_client-1.5.0a0.dev202610160251 → matter_python_client-1.5.0a0.dev202610171259}/chip/clusters/cluster_defs/__init__.py

@@ -135,6 +135,7 @@ from .TlsCertificateManagement import TlsCertificateManagement
 from .TlsClientManagement import TlsClientManagement
 from .TotalVolatileOrganicCompoundsConcentrationMeasurement import TotalVolatileOrganicCompoundsConcentrationMeasurement
 from .UnitLocalization import UnitLocalization
+from .UnitTestingCluster import UnitTestingCluster
 from .UserLabel import UserLabel
 from .ValveConfigurationAndControl import ValveConfigurationAndControl
 from .WagoCluster import WagoCluster
@@ -286,6 +287,7 @@ __all__ = [
     "TlsClientManagement",
     "TotalVolatileOrganicCompoundsConcentrationMeasurement",
     "UnitLocalization",
+    "UnitTestingCluster",
     "UserLabel",
     "ValveConfigurationAndControl",
     "WagoCluster",

{matter_python_client-1.5.0a0.dev202610160251 → matter_python_client-1.5.0a0.dev202610171259}/matter_python_client.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: matter-python-client
-Version: 1.5.0a0.dev202610160251
+Version: 1.5.0a0.dev202610171259
 Summary: Python Client for the OHF Matter Server
 Author-email: Open Home Foundation <hello@openhomefoundation.io>
 License-Expression: Apache-2.0
@@ -110,6 +110,27 @@ Beyond the `python-matter-server` API, the client exposes commands the Matter.js
   then streams the bytes to `POST /ota-upload/<upload_id>`. Raises `OtaUploadError` (code 101) for a
   corrupt image, an expired/spent id, or disabled OTA support.
 - `get_icd_state`, `register_icd`, `unregister_icd`, `resync_icd` — ICD Check-In registration
+- `read`, `subscribe`, `unsubscribe`, `enable_auto_subscription`, `disable_auto_subscription` — Matter
+  read and subscribe requests with explicit paths (schema 14+). `read` returns an `InteractionReport`,
+  `subscribe` a `SubscribeResult` (the priming report plus `subscription_id`). A subscription is named by
+  `node_id` and `subscription_id` together. Later reports arrive as `subscription_report` events
+  (`SubscriptionReportData`), an end the caller did not ask for as `subscription_ended`
+  (`SubscriptionEndedData`); both go only to the connection that subscribed and reach `node_filter`
+  subscribers. Pass `listener` to `subscribe` to get every event of that one subscription, including those
+  the server sends right behind the response. The listener gets no further calls once `unsubscribe` is
+  called. When the connection is lost or `disconnect` is called, the listener receives a
+  `subscription_ended` that the client builds itself, because the server ends the subscription without
+  sending one; `node_filter` subscribers do not get it. If a `subscribe` call is cancelled or times out
+  (for example in `asyncio.wait_for`) before it returns, the client ends that subscription with
+  `unsubscribe` and logs a failure of that call. `subscribe`, `unsubscribe` and the two auto
+  subscription methods need a server running with auto subscription disabled.
+- `commission_with_code` and `commission_on_network` take `discovery_timeout_s` (schema 14+)
+- `send_batched_device_commands` — sends `(endpoint_id, command)` pairs to one node in a single InvokeRequest and returns
+  one `BatchedCommandResult` per command (schema 14+)
+- `write_attribute` takes `*` as the endpoint to write all endpoints of the node that have the attribute, and
+  `timed_request_timeout_ms` for a timed write (schema 14+)
+- `parse_onboarding_payload` — decodes a QR code or manual pairing code without contacting a device and returns
+  `QrOnboardingPayloadResult` or `ManualOnboardingPayloadResult` (schema 14+)
 - `camera_get_capabilities`, `camera_start_stream`, `camera_provide_answer`,
   `camera_provide_ice_candidates`, `camera_stop_stream`, `camera_snapshot`, `camera_release_stream`
   — the camera API (schema 14+). `camera_get_capabilities`, `camera_start_stream`, `camera_stop_stream`

{matter_python_client-1.5.0a0.dev202610160251 → matter_python_client-1.5.0a0.dev202610171259}/matter_python_client.egg-info/SOURCES.txt

@@ -142,6 +142,7 @@ chip/clusters/cluster_defs/TlsCertificateManagement.py
 chip/clusters/cluster_defs/TlsClientManagement.py
 chip/clusters/cluster_defs/TotalVolatileOrganicCompoundsConcentrationMeasurement.py
 chip/clusters/cluster_defs/UnitLocalization.py
+chip/clusters/cluster_defs/UnitTestingCluster.py
 chip/clusters/cluster_defs/UserLabel.py
 chip/clusters/cluster_defs/ValveConfigurationAndControl.py
 chip/clusters/cluster_defs/WagoCluster.py
@@ -194,6 +195,7 @@ tests/test_event_dispatch.py
 tests/test_icd.py
 tests/test_imports.py
 tests/test_integration.py
+tests/test_interaction.py
 tests/test_network_topology.py
 tests/test_ota_upload.py
 tests/test_unix_socket.py