This release is a pre-release and may not be stable for production use.
Python Client for the OHF Matter Server
A PyPI package (matter-python-client) providing Python bindings for the OHF Matter Server. This is a drop-in replacement for the client portion of python-matter-server, with custom cluster definitions updated to match the Matter.js server.
Origin
The client and common modules were copied from python-matter-server v8.1.2 and modified:
- Source:
matter_server/client/andmatter_server/common/from python-matter-server - Modified:
matter_server/common/custom_clusters.py— updated to match the JS server's cluster definitions - Excluded:
matter_server/server/(the JS server replaces it),common/helpers/logger.py(depends oncoloredlogs, a server-only dependency)
Custom Cluster Changes
| Cluster | Change |
|---|---|
| EveCluster | +8 attributes (getConfig, setConfig, loggingMetadata, loggingData, lastEventTime, statusFault, childLock, rloc16), wattAccumulatedControlPoint type fixed |
| HeimanCluster | Attribute IDs shortened to match JS server |
| NeoCluster | Types changed from float32 to uint |
| Polling | Removed (JS server handles polling natively) |
Package
- PyPI name:
matter-python-client - Python module:
matter_server(same import path aspython-matter-server) - Python: >= 3.12
- Dependencies:
aiohttp,orjson,home-assistant-chip-clusters
npm Scripts (from monorepo root)
# First-time setup: create venv and install with test dependencies
npm run python:install
# Run unit + mock server tests (fast, ~1s)
npm run python:test
# Run full integration tests against real Matter.js server + test device (~40s)
npm run python:test-integration
# Run all Python tests
npm run python:test-all
# Build the PyPI package (.tar.gz + .whl)
npm run python:build
Usage
The package provides the same matter_server.client API as python-matter-server:
import aiohttp
from matter_server.client import MatterClient
async with aiohttp.ClientSession() as session:
client = MatterClient("ws://localhost:5580/ws", session)
await client.connect()
init_ready = asyncio.Event()
listen_task = asyncio.create_task(client.start_listening(init_ready))
await init_ready.wait()
nodes = client.get_nodes()
To reach a server that listens on a unix socket (--listen-address /path/to/socket), pass
unix:///path/to/socket as the server URL. The client then opens its own session on that socket
for the WebSocket and the OTA upload, and the session passed in stays unused.
OHF-only extensions
Beyond the python-matter-server API, the client exposes commands the Matter.js server adds:
-
get_network_topology(refresh=False)— the Thread/Wi-Fi network as a graph (schema 13+) -
upload_ota_file(image)— store a local.otafirmware image in the server's OTA image store (schema 13+). Takes the raw bytes or a path; reserves an upload id over the WebSocket session, then streams the bytes toPOST /ota-upload/<upload_id>. RaisesOtaUploadError(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+).readreturns anInteractionReport,subscribeaSubscribeResult(the priming report plussubscription_id). A subscription is named bynode_idandsubscription_idtogether. Later reports arrive assubscription_reportevents (SubscriptionReportData), an end the caller did not ask for assubscription_ended(SubscriptionEndedData); both go only to the connection that subscribed and reachnode_filtersubscribers. Passlistenertosubscribeto get every event of that one subscription, including those the server sends right behind the response. The listener gets no further calls onceunsubscribeis called. When the connection is lost ordisconnectis called, the listener receives asubscription_endedthat the client builds itself, because the server ends the subscription without sending one;node_filtersubscribers do not get it. If asubscribecall is cancelled or times out (for example inasyncio.wait_for) before it returns, the client ends that subscription withunsubscribeand logs a failure of that call.subscribe,unsubscribeand the two auto subscription methods need a server running with auto subscription disabled. -
commission_with_codeandcommission_on_networktakediscovery_timeout_s(schema 14+) -
send_batched_device_commands— sends(endpoint_id, command)pairs to one node in a single InvokeRequest and returns oneBatchedCommandResultper command (schema 14+) -
write_attributetakes*as the endpoint to write all endpoints of the node that have the attribute, andtimed_request_timeout_msfor a timed write (schema 14+) -
parse_onboarding_payload— decodes a QR code or manual pairing code without contacting a device and returnsQrOnboardingPayloadResultorManualOnboardingPayloadResult(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_streamandcamera_snapshotreturn dataclasses frommatter_server.common.models; the other three returnNone.camera_start_stream'svideo/audiotakeNone(the server decides), aCameraVideoHints/CameraAudioHintsdict, orFalse(no such track).talkback=Truelets the offer ask the camera to play your audio; without it the server makes the offer's audio sections not send, so a browser-stylesendrecvaudio offer goes to the camera asrecvonly.camera_session_endedandcamera_stream_evictedevents arrive asCameraSessionEndedData/CameraStreamEvictedData;webrtc_callbackstays a dict. Errors 102 to 106 (CameraStreamIncompatible, ...) expose their details as attributes, e.g.err.reasonanderr.boundonCameraStreamIncompatibleThe minimal
camera_start_streamcall isnode_id,endpoint_id,stream_usageand your SDP offer: the server reuses or allocates the best stream the camera can serve that still fits what the offer can decode, and adds audio when it can. Passvideo/audiohints only to set hard bounds. A session opened this way is driven withcamera_provide_answer,camera_provide_ice_candidatesandcamera_stop_streamonly, not withsend_webrtc_provider_commandor asend_device_commandEndSession: the server tracks the session and its streams, and only thecamera_*methods keep that record correct. The exception is a re-offer (ICE restart), which goes throughsend_webrtc_provider_command. Seedocs/websockets_api.mdfor the flow and every option.
try:
result = await client.camera_start_stream(node_id, 1, "LiveView", sdp=offer)
except CameraStreamIncompatible as err:
print(err.reason, err.bound)
else:
# The camera's answer arrives as a webrtc_callback "answer" event for this session.
print(result.webrtc_session_id, result.video.codec if result.video else None)
version = await client.upload_ota_file("/path/to/firmware.ota")
print(version.vid, version.pid, version.software_version)
To use this package instead of python-matter-server in the Home Assistant Matter integration, change manifest.json:
- "requirements": ["python-matter-server==8.1.2"],
+ "requirements": ["matter-python-client==1.0.0"],
Testing
The test suite has three layers:
- Import smoke tests (8 tests) — verify all HA integration imports resolve
- Mock server tests (4 tests) — Python client against JS MockMatterServer subprocess
- Integration tests (63 tests) — Python client against real Matter.js server + test device, mirroring the JS
IntegrationTest.ts
1 maintainer
Metadata
1 maintainer
Release files for matter-python-client 1.5.0a0.dev202610200302
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | |
|---|---|---|---|---|
| matter_python_client-1.5.0a0.dev202610200302.tar.gz | 255.6 kB | With provenance | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| matter_python_client-1.5.0a0.dev202610200302-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 603.9 kB
Release files / matter_python_client-1.5.0a0.dev202610200302.tar.gz
| Download URL | matter_python_client-1.5.0a0.dev202610200302.tar.gz |
|---|---|
| Size | 255.6 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
6d146278891f32a2035bf27b02f822534824db0c9303cc4bdf6bc32ae3a8821f
|
|
BLAKE2b-256 checksum How to use checksums |
17480e6ceeaf493dd6fef817e891ce84121fd3fd22f8123230088fd0ea25770c
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Oct 20, 2026.
Transparency logRelease files / matter_python_client-1.5.0a0.dev202610200302-py3-none-any.whl
| Download URL | matter_python_client-1.5.0a0.dev202610200302-py3-none-any.whl |
|---|---|
| Size | 348.3 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
7581404cdf560dea7e6eb11aa57ee854c8b04f771188f08247947da3747a5410
|
|
BLAKE2b-256 checksum How to use checksums |
cc3bcfc71c634fc3725f92fb70c78c661408c5a611a7734fe92763bc68b79afb
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Oct 20, 2026.
Transparency logSecurity for matter-python-client 1.5.0a0.dev202610200302
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
Full provenance
All 2 files in this release have been uploaded with provenance metadata.
Attestation for matter_python_client-1.5.0a0.dev202610200302.tar.gz
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Oct 20, 2026.
Transparency logA note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.
