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.

Features

  • Info: Info
    • Get an overview of your current KNX installation state (shows if connected to the Bus, which XKNX version is running and the currently assigned Individual address)
    • Upload ETS project file (which is used in the Group Monitor to provide destination names and DPT interpretation) and delete it again from Home Assistant.
    • Get key information about the parsed ETS project which has been uploaded
  • Group Monitor: Use the interactive bus monitor to view all incoming and outgoing telegrams on the bus. Group Monitor
  • ETS Project: Displays the Group Addresses provided via ETS Project in a tree view

Development

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

$ make bootstrap
...

Development build (watcher)

$ make develop
...

Production build

$ make build
...

Update the home assistant frontend

Replace latest_tag with the current release tag.

$ cd homeassistant-frontend
$ git fetch
...
$ git checkout latest_tag
...
$ cd ..
$ rm -f yarn.lock
$ node ./script/merge_requirements.js
...
$ script/bootstrap
...

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-2025.8.24.205840.tar.gz (15.9 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-2025.8.24.205840-py3-none-any.whl (16.0 MB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: knx_frontend-2025.8.24.205840.tar.gz
  • Upload date:
  • Size: 15.9 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for knx_frontend-2025.8.24.205840.tar.gz
Algorithm Hash digest
SHA256 af0467ff607d1282b6169a525629f1fc8e9dfc97b5708f3d81b980ceda98ef11
MD5 b0d5c38ca8b1aae3542ec433174023a3
BLAKE2b-256 cf5101572d91a0d95f2746320e0ab7e38849b32ee3f8b2de4464e1e317c9293c

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for knx_frontend-2025.8.24.205840-py3-none-any.whl
Algorithm Hash digest
SHA256 f84bee893deaf62b441f42a49ce5a4e2058c16875b7ba2c4ec16c9cf03a8b212
MD5 a4400fdec31b81ddde351ceb4b173d3b
BLAKE2b-256 5cb537088b71fab0b0063abf750afc89b8675e732cdb777846bfff9260e75cbd

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