Skip to main content

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

  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 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-ssl to skip TLS certificate verification during testing.
  • Use --verbose to 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)

Source distribution for loxone-api 0.1.25
File Size Uploaded
loxone_api-0.1.25.tar.gz 10.8 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for loxone-api 0.1.25
File Interpreter ABI Platform
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 log

Release 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

Release history Release notifications | RSS feed

This release

0.1.25 This release

2 release files

0.1.24

2 release files

0.1.23

2 release files

0.1.22

2 release files

0.1.21

2 release files

0.1.20

2 release files

0.1.19

2 release files

0.1.18

2 release files

0.1.17

2 release files

0.1.16

2 release files

0.1.15

2 release files

0.1.14

2 release files

0.1.13

2 release files

0.1.12

2 release files

0.1.11

2 release files

0.1.10

2 release files

0.1.9

2 release files

0.1.8

2 release files

0.1.7

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page