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.20.tar.gz (10.1 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.20-py3-none-any.whl (9.6 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: loxone_api-0.1.20.tar.gz
  • Upload date:
  • Size: 10.1 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.20.tar.gz
Algorithm Hash digest
SHA256 d2ffbf1562b7da805ae15227ee80b27d6bd05df064e00f28c0900a311001fc8f
MD5 b9fa1803d5ebb9382c23f90e960f66ea
BLAKE2b-256 042e4898771e54bb1a6a0bee13da4ca2a44934e4f6a5b06210616f0fd8a30902

See more details on using hashes here.

Provenance

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

File metadata

  • Download URL: loxone_api-0.1.20-py3-none-any.whl
  • Upload date:
  • Size: 9.6 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.20-py3-none-any.whl
Algorithm Hash digest
SHA256 70a8d376c8aa4639e617a9ff5f53d5a0afdc84c8c039cf0a4def1b3ed3d2e253
MD5 fe082366ce99af2630b828be16f2c6e2
BLAKE2b-256 dbdf9f8fe001524bfd7e67db9c611d973fc34fa1c229aec3bde10e24751c21d3

See more details on using hashes here.

Provenance

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