Async client for the Loxone Miniserver
Project description
Loxone Miniserver Home Assistant Integration
This repository provides:
loxone_api: an asynchronous Python client for communicating with a Loxone Miniserver, handling authentication, token refresh, structure parsing, and websocket event streaming.custom_components/loxone: a Home Assistant custom component that exposes Miniserver controls as entities and uses the shared client library.loxone-api-cli: a lightweight command-line shim for exercising the client outside Home Assistant and streaming events to stdout for debugging.
Home Assistant usage
- Install the Python package in your Home Assistant environment:
pip install .
- 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 currently creates entities for lights, sensors, binary sensors, covers, climate controllers, and scenes. Additional platforms can be added by extending the platform files and mapping further control types from the structure file.
Command-line shim for testing
After installing the package locally you can use the shim to connect directly to a Miniserver and view live events without Home Assistant:
python3 -m loxone_api.cli <host> <username> [password] --list-controls
- If the password is omitted you will be prompted securely.
- Use
--no-tlsto connect over HTTP/websocket and--no-verify-sslto skip TLS certificate verification during testing. - Add
--list-controlsto print the discovered controls before streaming events. - Press
Ctrl+Cto exit; the client will close the websocket and HTTP session.
Project details
Release history Release notifications | RSS feed
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 loxone_api-0.1.14.tar.gz.
File metadata
- Download URL: loxone_api-0.1.14.tar.gz
- Upload date:
- Size: 9.8 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.13.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
c4f99371fe4d241662d708721ed6fa7165560108e97af908a4ebb26e2dd8a1fd
|
|
| MD5 |
4483955724f7c14a1542a37f090a5ec3
|
|
| BLAKE2b-256 |
4220178efbe324d8a146983ca7e9200edbe0c19f8af2f8dadf263009aecbd47e
|
Provenance
The following attestation bundles were made for loxone_api-0.1.14.tar.gz:
Publisher:
publish-loxone-api.yml on grimbouk/loxws2
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
loxone_api-0.1.14.tar.gz -
Subject digest:
c4f99371fe4d241662d708721ed6fa7165560108e97af908a4ebb26e2dd8a1fd - Sigstore transparency entry: 772175598
- Sigstore integration time:
-
Permalink:
grimbouk/loxws2@697cd868ccccee3d39361628db4766b5f2012d8d -
Branch / Tag:
refs/heads/main - Owner: https://github.com/grimbouk
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
publish-loxone-api.yml@697cd868ccccee3d39361628db4766b5f2012d8d -
Trigger Event:
push
-
Statement type:
File details
Details for the file loxone_api-0.1.14-py3-none-any.whl.
File metadata
- Download URL: loxone_api-0.1.14-py3-none-any.whl
- Upload date:
- Size: 9.4 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.13.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
fdd9ae6908a395a3bd0fe3284a196c37d93fa775bdfa979046ead427d214889e
|
|
| MD5 |
37e8300d417bb29240aa21053a7fa208
|
|
| BLAKE2b-256 |
c40c49b40aaa13a8d84258ab9a5da89b2b359a5b843351c41b423d5ee4dc991e
|
Provenance
The following attestation bundles were made for loxone_api-0.1.14-py3-none-any.whl:
Publisher:
publish-loxone-api.yml on grimbouk/loxws2
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
loxone_api-0.1.14-py3-none-any.whl -
Subject digest:
fdd9ae6908a395a3bd0fe3284a196c37d93fa775bdfa979046ead427d214889e - Sigstore transparency entry: 772175607
- Sigstore integration time:
-
Permalink:
grimbouk/loxws2@697cd868ccccee3d39361628db4766b5f2012d8d -
Branch / Tag:
refs/heads/main - Owner: https://github.com/grimbouk
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
publish-loxone-api.yml@697cd868ccccee3d39361628db4766b5f2012d8d -
Trigger Event:
push
-
Statement type: