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


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.10.9.185845.tar.gz (16.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-2025.10.9.185845-py3-none-any.whl (16.3 MB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for knx_frontend-2025.10.9.185845.tar.gz
Algorithm Hash digest
SHA256 872d7475faecb6d21a22565180e80d5f04d6b419d5def3863a6b29903a614789
MD5 3597845476f046b8604882bc3521fd39
BLAKE2b-256 4a36836da6239478cab7e903292aefa08736ec59069dde3c5a99defa88672047

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for knx_frontend-2025.10.9.185845-py3-none-any.whl
Algorithm Hash digest
SHA256 4489c5c4c5ebc6b7c69665c58b19021408edb82deec87bfa7c9110010acad70a
MD5 1cced3444c8e6b19508e01d0286f983b
BLAKE2b-256 e33a5bb96080a1de0dc9a04815bcd0a6b6b4fecf67bf0fc4da8d9ada4d102696

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