Skip to main content

KNX panel for Home Assistant

Project description

KNX UI

This is the KNX panel for the KNX core integration in Home Assistant. It provides a user interface for interacting with the KNX integration.

Development

If you check out this repository for the first time please run the following command to init the submodules:

$ nvm use
$ script/bootstrap
...

Development build (watcher)

$ script/develop
...

Production build

$ script/build
...

Update the home assistant frontend

Get the latest release tag.

$ script/upgrade-frontend
...

Or get a specific tag or sha.

$ script/upgrade-frontend <tag-or-sha>
...

Testing the panel

First of all we recommend to follow the instructions for preparing a home assistant development environment.

You can test the panel by symlinking the build result directory knx_frontend into your Home Assistant configuration directory.

Assuming:

  • The knx-frontend repository is located at <knx-frontend-dir> path
  • The home-assistant-core repository is located at <hass-dir> path (Remark: per default the Home Assistant configuration directory will be created within <hass-dir>/config)
$ ln -s <knx-frontend-dir>/knx_frontend <hass-dir>/config/deps/lib/python3.xx/site-packages/
$ hass -c config
...

Or on a venv-install

$ cd <hass-dir>
$ script/setup
# Next step might be optional
$ source .venv/bin/activate
$ export PYTHONPATH=<knx-frontend-dir>
$ hass
...

Now hass (Home Assistant Core) should run on your machine and the knx panel is accessible at http://localhost:8123/knx.

On Home Assistant OS you might use https://github.com/home-assistant/addons-development/tree/master/custom_deps

AI Agent Support

This repository ships a set of instructions for AI coding agents.

  • GitHub Copilot comes pre-configured — its guidance lives in .github/copilot-instructions.md.

  • For other agents, you can easy symlink the Copilot instructions with:

    yarn agent:claude   # Creates CLAUDE.md
    yarn agent:gemini   # Creates GEMINI.md  
    yarn agent:codex    # Creates AGENTS.md
    

Project details


Release history Release notifications | RSS feed

Download files

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

Source Distribution

knx_frontend-2026.4.19.175239.tar.gz (39.1 MB view details)

Uploaded Source

Built Distribution

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

knx_frontend-2026.4.19.175239-py3-none-any.whl (39.3 MB view details)

Uploaded Python 3

File details

Details for the file knx_frontend-2026.4.19.175239.tar.gz.

File metadata

  • Download URL: knx_frontend-2026.4.19.175239.tar.gz
  • Upload date:
  • Size: 39.1 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.14.4

File hashes

Hashes for knx_frontend-2026.4.19.175239.tar.gz
Algorithm Hash digest
SHA256 8501a0feb01bb344253f566ae41c493a2ebac86fb1556abe4997a269b45b1a0b
MD5 60e5c71cb20c5e38e60a90489d46ce6b
BLAKE2b-256 946a81410e2479e869de239abf632102c81a1805f8d46ece2c71bbf47ed3148c

See more details on using hashes here.

File details

Details for the file knx_frontend-2026.4.19.175239-py3-none-any.whl.

File metadata

File hashes

Hashes for knx_frontend-2026.4.19.175239-py3-none-any.whl
Algorithm Hash digest
SHA256 e6cfd8b081476129c0cfaa197d95d2982dbc5fef1161af6c821a8ba51ecb2b9b
MD5 60b4db7da1c6a93d3a7afe7dbbb37a36
BLAKE2b-256 9663ed2d77d03ce1e8bed25668be778dd81a5f0ae1b42a6e949e2e826ca26f42

See more details on using hashes here.

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