Skip to main content

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

  1. Install the Python package in your Home Assistant environment:
pip install .
  1. Copy the custom_components/loxone folder into your Home Assistant custom_components directory.
  2. 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-tls to connect over HTTP/websocket and --no-verify-ssl to skip TLS certificate verification during testing.
  • Add --list-controls to print the discovered controls before streaming events.
  • Press Ctrl+C to exit; the client will close the websocket and HTTP session.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

loxone_api-0.1.17.tar.gz (9.9 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

loxone_api-0.1.17-py3-none-any.whl (9.4 kB view details)

Uploaded Python 3

File details

Details for the file loxone_api-0.1.17.tar.gz.

File metadata

  • Download URL: loxone_api-0.1.17.tar.gz
  • Upload date:
  • Size: 9.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for loxone_api-0.1.17.tar.gz
Algorithm Hash digest
SHA256 db594de3a2f9738a4cdbb67b09d5db73d3ab5c80ecd54b10582f6dabdac5a32b
MD5 f723429e50ff89594934b4e23750b016
BLAKE2b-256 c80887766cbec7a2c5645b9b7a2d8f8aeb4e29bfbd592ea42573f63d6f7faaaa

See more details on using hashes here.

Provenance

The following attestation bundles were made for loxone_api-0.1.17.tar.gz:

Publisher: publish-loxone-api.yml on grimbouk/loxws2

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file loxone_api-0.1.17-py3-none-any.whl.

File metadata

  • Download URL: loxone_api-0.1.17-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

Hashes for loxone_api-0.1.17-py3-none-any.whl
Algorithm Hash digest
SHA256 92b6d16e4c90ba8027d4e3f1e0bf829ac20837f12ba6f70aed62ecb6583b6c40
MD5 044a43d61515e0639e138404be9f4e6b
BLAKE2b-256 76f02d79083732b536fb1fa769d547d4ea02b42a6b1085e98d5e5313f6bdb3b9

See more details on using hashes here.

Provenance

The following attestation bundles were made for loxone_api-0.1.17-py3-none-any.whl:

Publisher: publish-loxone-api.yml on grimbouk/loxws2

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page