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.13.222258.tar.gz (51.0 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.13.222258-py3-none-any.whl (51.2 MB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for knx_frontend-2026.2.13.222258.tar.gz
Algorithm Hash digest
SHA256 1b2a56342193ccfecb622955459fff12ed0ff118c727de3a0b345797ae262124
MD5 256cb9e588bf254114f729ce7ae69247
BLAKE2b-256 93cdcec77ab8f1b1e4c3cd5a215bd864da056e6971621296762ecb65df8059e4

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for knx_frontend-2026.2.13.222258-py3-none-any.whl
Algorithm Hash digest
SHA256 b638ac9b0202974e87215be2c598ec0485ca1aad75cc0586985e0d7f6a1fcff4
MD5 7b9ba964becd2315dbdd6b4f7580594a
BLAKE2b-256 233d02c1378ad1a69d48ba0a9a8a2eb4c9a922ff4be0a467cae81c0e56b33689

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