pyloxone-api
A Python API for communicating with a Loxone Miniserver.
Low-level asynchronous client for the Loxone Miniserver WebSocket API. It handles the HTTP bootstrap, WebSocket connection, authentication (token and key exchange), commands and state events. It has no dependency on Home Assistant.
Used by the PyLoxone Home Assistant integration.
Installation
pip install pyloxone-api
Requires Python 3.14 or newer.
Usage
from pyloxone_api import LoxoneConnection, LoxoneException
connection = LoxoneConnection(host, port, username, password, ...)
The public API is exported from pyloxone_api (see __all__).
Everything else is internal and may change between releases.
Version 0.3.0 is a complete rewrite of the 0.2.x series and is not API-compatible with it.
Documentation
- Callbacks: what the library calls back into, when, and what happens on errors.
- Live web view: a developer tool that shows a Miniserver's structure and live values in the browser.
Development
We use uv for environments and builds, and pytest for tests.
uv sync --group dev # create .venv with the package and dev tools
uv run pytest # tests; online tests are skipped by default
uv run pytest -m online # online tests, need a live Miniserver
Online tests can make a Miniserver behave oddly. Run them only against a Miniserver you can afford to disturb.
Build the sdist and wheel into dist/:
./scripts/build
License
Apache-2.0, see LICENSE.
1 maintainer
Metadata
1 maintainer
Release files for pyloxone-api 0.3.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| pyloxone_api-0.3.0.tar.gz | 149.9 kB | Without provenance | Details for pyloxone_api-0.3.0.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| pyloxone_api-0.3.0-py3-none-any.whl | Python 3 | none | any | Details for pyloxone_api-0.3.0-py3-none-any.whl |
Total release size: 213.5 kB
Release files / pyloxone_api-0.3.0.tar.gz
| Download URL | pyloxone_api-0.3.0.tar.gz |
|---|---|
| Size | 149.9 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
a39abfd0787f2177aea3158e09f64d17e45e5f09bed80b901b358d12b30cbf9f
|
|
BLAKE2b-256 checksum How to use checksums |
2e0e6f79f4cb1b55fc4ddd5e772a7802296b2b8cf4f53ccfdf59bc1c09257e7c
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
uv/0.12.5 {"installer":{"name":"uv","version":"0.12.5","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Arch Linux","version":null,"id":null,"libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}
|
Release files / pyloxone_api-0.3.0-py3-none-any.whl
| Download URL | pyloxone_api-0.3.0-py3-none-any.whl |
|---|---|
| Size | 63.6 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
8d7bbb101effdc7309c7189eeeb01c7ce1c811a881d51933918fbe211ee4ac44
|
|
BLAKE2b-256 checksum How to use checksums |
0164c3ed9789d846ef5bca549eccff2b936eee9053bd615e291ebd8e5b2339f9
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
uv/0.12.5 {"installer":{"name":"uv","version":"0.12.5","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Arch Linux","version":null,"id":null,"libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}
|
Security for pyloxone-api 0.3.0
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.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.
