Loxone Miniserver Home Assistant Integration
This repository provides:
loxone_api: an asynchronous Python client library for communicating with a Loxone Miniserver, handling authentication via getkey2/getjwt flow, loading the LoxAPP3.json structure file, and providing methods to fetch/send control states.custom_components/loxone: a Home Assistant custom component that uses the shared client library to expose Miniserver controls as Home Assistant entities (lights, sensors, binary sensors, covers, climate controllers, scenes).loxone-api-cli: a lightweight command-line utility for testing the client library outside Home Assistant.
Installation and setup
As a Home Assistant integration
- Copy the
custom_components/loxonefolder into your Home Assistantcustom_componentsdirectory. - Restart Home Assistant and configure the integration via the UI, providing the host, credentials, and TLS options.
The integration creates entities for lights, sensors, binary sensors, covers, climate controllers, and scenes based on control types from the structure file. Additional platforms can be added by extending the platform files.
As a standalone library
Install the loxone_api package:
pip install .
Then use it in your Python code:
from loxone_api import LoxoneClient
async with LoxoneClient(host="192.168.1.110", user="admin", password="pass") as client:
# Authenticate
token = await client.authenticate()
# Load structure
structure = await client.load_structure()
controls = structure["controls"]
# Fetch/send control state
state = await client.jdev_get("sps/io/<uuid>")
Command-line testing
After installing locally, you can test the client with:
python3 -m loxone_api.cli <host> <username> [password] --no-verify-ssl --verbose
- If the password is omitted you will be prompted securely.
- Use
--no-verify-sslto skip TLS certificate verification during testing. - Use
--verboseto enable debug logging to see the full authentication flow.
Metadata
Release files for loxone-api 0.1.25
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| loxone_api-0.1.25.tar.gz | 10.8 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| loxone_api-0.1.25-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 21.2 kB
Release files / loxone_api-0.1.25.tar.gz
| Download URL | loxone_api-0.1.25.tar.gz |
|---|---|
| Size | 10.8 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
aaabdb5a4cb3e234e6efcf9d16ef22b4c5ba506f423fa74b50a823ae216e5b67
|
|
BLAKE2b-256 checksum How to use checksums |
43118f424a5414a0d7996f341511e5926ea36a5a0272ec2c6b6805c2593dc692
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.1.0 CPython/3.13.7
|
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 Dec 21, 2025.
Transparency logRelease files / loxone_api-0.1.25-py3-none-any.whl
| Download URL | loxone_api-0.1.25-py3-none-any.whl |
|---|---|
| Size | 10.4 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
5e1e6de5026a7a81e9e8f3be6c0c00af3face375a76821c8084f769af9e8b33f
|
|
BLAKE2b-256 checksum How to use checksums |
f38c12c13c27cefd3b1ba5e7f06a4f9553ade9b24ca268f880086732bf5adab6
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.1.0 CPython/3.13.7
|
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 Dec 21, 2025.
Transparency log