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()
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
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
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file matter_python_client-1.4.0.tar.gz.
File metadata
- Download URL: matter_python_client-1.4.0.tar.gz
- Upload date:
- Size: 203.8 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via:
twine/7.0.0 CPython/3.13.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
83c6c671bf52a7f47354324054af78fe9f9b0de636aa6a25fa39a67a3333967c
|
|
| MD5 |
a6f25a78440ddfd6bdd97b35bd0404ec
|
|
| BLAKE2b-256 |
e7b83890100b41e17375697a3e4d692984b576692669529406c3682a0fd39547
|
Provenance
The following attestation bundles were made for matter_python_client-1.4.0.tar.gz:
Publisher:
release-npm.yml on matter-js/matterjs-server
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
matter_python_client-1.4.0.tar.gz -
Subject digest:
83c6c671bf52a7f47354324054af78fe9f9b0de636aa6a25fa39a67a3333967c - Sigstore transparency entry: 2367469659
- Sigstore integration time:
-
Permalink:
matter-js/matterjs-server@995055a71e9011da3af30d1e1b851b49351cbaa8 -
Branch / Tag:
refs/pull/980/merge - Owner: https://github.com/matter-js
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
release-npm.yml@995055a71e9011da3af30d1e1b851b49351cbaa8 -
Trigger Event:
pull_request
-
Statement type:
File details
Details for the file matter_python_client-1.4.0-py3-none-any.whl.
File metadata
- Download URL: matter_python_client-1.4.0-py3-none-any.whl
- Upload date:
- Size: 325.1 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via:
twine/7.0.0 CPython/3.13.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
4faeb4aa31b41e1af7d831cf615e4d20f953c6b2fef8be77aa9ffe3d11748dc8
|
|
| MD5 |
b08c724ce1fe1d4c4c1bb2ff16f89715
|
|
| BLAKE2b-256 |
3dc832e956fc746102f7bb0da95b4a224ff142fbecae5081cf6fb2b79d846c95
|
Provenance
The following attestation bundles were made for matter_python_client-1.4.0-py3-none-any.whl:
Publisher:
release-npm.yml on matter-js/matterjs-server
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
matter_python_client-1.4.0-py3-none-any.whl -
Subject digest:
4faeb4aa31b41e1af7d831cf615e4d20f953c6b2fef8be77aa9ffe3d11748dc8 - Sigstore transparency entry: 2367470218
- Sigstore integration time:
-
Permalink:
matter-js/matterjs-server@995055a71e9011da3af30d1e1b851b49351cbaa8 -
Branch / Tag:
refs/pull/980/merge - Owner: https://github.com/matter-js
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
release-npm.yml@995055a71e9011da3af30d1e1b851b49351cbaa8 -
Trigger Event:
pull_request
-
Statement type:
