Habitron Client
An asynchronous, fully typed API client for the Habitron SmartHub, designed for integration with Home Assistant.
Features
- Non-blocking TCP communication via
asyncioStreamReader/StreamWriter. - Persistent, lock-serialised connection with automatic reconnect on errors.
- Automatic CRC16 calculation and command wrapping.
- High-level coroutines for outputs, dimmers, RGB, shutters, climate and more.
- Safe YAML parsing (
yaml.safe_load) into validatedTypedDictmodels. - Async UDP discovery of SmartHubs on the local network.
- Typed exception hierarchy and a
py.typedmarker (PEP 561 compliant).
Requirements
- Python 3.11+
Installation
pip install habitron-client
Usage
The client is async-only and is used as an async context manager:
import asyncio
from habitron_client import HabitronClient, HabitronError
async def main() -> None:
async with HabitronClient("192.0.2.10") as client:
info = await client.get_smhub_info()
print(info["software"]["version"])
await client.set_output(mod_addr=1, nmbr=2, val=True)
asyncio.run(main())
Error handling
All failures raise a typed exception:
HabitronError (root)
├── HabitronConnectionError (refused / EOF / socket lost)
├── HabitronTimeoutError (no response within the deadline)
└── HabitronProtocolError
├── HabitronChecksumError (CRC mismatch)
└── HabitronBusError (SmartHub reported an error)
Discovery
from habitron_client import discover_smarthubs
hubs = await discover_smarthubs()
Development
pip install -e ".[dev]"
ruff check .
ruff format --check .
mypy --strict src/habitron_client
pytest
1 maintainer
Metadata
1 maintainer
Release files for habitron-client 2.1.1
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 | |
|---|---|---|---|---|
| habitron_client-2.1.1.tar.gz | 86.8 kB | With provenance | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| habitron_client-2.1.1-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 135.5 kB
Release files / habitron_client-2.1.1.tar.gz
| Download URL | habitron_client-2.1.1.tar.gz |
|---|---|
| Size | 86.8 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
10acffe273b443f521dbf178b8a433bb552ebc5e5700b627ff210fbe29917ed9
|
|
BLAKE2b-256 checksum How to use checksums |
bdcbddf2b2336f89ccf394ed4242d5a8c57268e6ffad7923e1ae140f362cf0bc
|
| 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 Sep 14, 2026.
Transparency logRelease files / habitron_client-2.1.1-py3-none-any.whl
| Download URL | habitron_client-2.1.1-py3-none-any.whl |
|---|---|
| Size | 48.7 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
778e7c63e8cb56042259dc2119dbc2539a7d1d1fa61300868f6ca7fa23dc3265
|
|
BLAKE2b-256 checksum How to use checksums |
0eef7587b1ee6a16076bda8bab0776844f7165383f9fb7797f323a455357c233
|
| 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 Sep 14, 2026.
Transparency logSecurity for habitron-client 2.1.1
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 habitron_client-2.1.1.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 Sep 14, 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.
