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


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.2.25.165736.tar.gz (50.5 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.2.25.165736-py3-none-any.whl (50.9 MB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for knx_frontend-2026.2.25.165736.tar.gz
Algorithm Hash digest
SHA256 2523cb8f415a950b755bd540a81f7bd22f1e12be9985cd80b42b8eafa7ce7c8b
MD5 bbe0e734a49b947a97fe4c4e3f294981
BLAKE2b-256 04d18e1e959a582251bf55db91107385ae45ab393becf9aa117a42384691759a

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for knx_frontend-2026.2.25.165736-py3-none-any.whl
Algorithm Hash digest
SHA256 32830444edc3839d3739f84cd7f1deaae51a250bc332e46d16e4f32584883e4b
MD5 7ab1273080748bb23355d197ed0821fe
BLAKE2b-256 eaa0cea2bec05205bc35201e545a693fde56ea3ce8b972172e0da4d220f63595

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