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.25.155016.tar.gz (39.2 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.25.155016-py3-none-any.whl (39.5 MB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: knx_frontend-2026.4.25.155016.tar.gz
  • Upload date:
  • Size: 39.2 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.25.155016.tar.gz
Algorithm Hash digest
SHA256 8ce847f039f20201357b53755cd2972c1b4c9b9786f8165a2c957183471292b3
MD5 db3e6eff3110d37654a58d47f5784008
BLAKE2b-256 86a80e67ebcfa3c76f36c8bb69fa7b2b68656bd0adec6723051e2ec8b06ccdf9

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for knx_frontend-2026.4.25.155016-py3-none-any.whl
Algorithm Hash digest
SHA256 2e5c843d90fe1a93c86614954e6f8b663187a58a1556ce1a337ee076c6252cad
MD5 317bcccac622091abe6139b7becfffc4
BLAKE2b-256 70d2e75420eddb42aa675545e8c9f7de0312e2fd552bc210afec855012e0cbdb

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