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.11.tar.gz (8.3 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.11-py3-none-any.whl (7.9 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: loxone_api-0.1.11.tar.gz
  • Upload date:
  • Size: 8.3 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.11.tar.gz
Algorithm Hash digest
SHA256 78b71b355bc3c6bc177212fb6ab4042f1ef6df718fb39b8cdd103e66325101a9
MD5 40fd862521851912ebe9be3308db05f6
BLAKE2b-256 21cac7e2d39af792abf6adda8e9d0f8600ecbcf2a6d01e4e31bf35e10f5ff572

See more details on using hashes here.

Provenance

The following attestation bundles were made for loxone_api-0.1.11.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.11-py3-none-any.whl.

File metadata

  • Download URL: loxone_api-0.1.11-py3-none-any.whl
  • Upload date:
  • Size: 7.9 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.11-py3-none-any.whl
Algorithm Hash digest
SHA256 5ed96ef655fb35598bb040f8995f9fbf06ef0d28d70a6e8f06c66f468e8506eb
MD5 9f4668aeec9c89bd380a51f7a939c387
BLAKE2b-256 f6f964c60b4d3f41d3b98cdad679614a8deb80d63b26c0aef060acc4e5d05ee1

See more details on using hashes here.

Provenance

The following attestation bundles were made for loxone_api-0.1.11-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