Skip to main content

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

Metadata

Release files for knx-frontend 2024.8.6.85349

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for knx-frontend 2024.8.6.85349
File Size Uploaded
knx_frontend-2024.8.6.85349.tar.gz 5.5 MB Details

Built distribution (wheel)

Table of built distributions (wheels) for knx-frontend 2024.8.6.85349
File Interpreter ABI Platform
knx_frontend-2024.8.6.85349-py3-none-any.whl Python 3 none any Details

Total release size: 11.1 MB

Release files / knx_frontend-2024.8.6.85349.tar.gz

Download URL knx_frontend-2024.8.6.85349.tar.gz
Size 5.5 MB
Tags Source
SHA-256 checksum
How to use checksums
72c45307073e04b8bb1a6e50084a71649d473ef29c1434aa78c3bfba824b0e28
BLAKE2b-256 checksum
How to use checksums
b77ffcded3fdc3f55cf8c8bb4f26d138bf1dd8bf54d3b5397c97e8dbde17cd36
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/5.1.1 CPython/3.12.4

Release files / knx_frontend-2024.8.6.85349-py3-none-any.whl

Download URL knx_frontend-2024.8.6.85349-py3-none-any.whl
Size 5.6 MB
Tags Python 3
SHA-256 checksum
How to use checksums
ecaff46d8f9c185383ad4777c73af1709f05ce86ec306ef70a6a8783bf632308
BLAKE2b-256 checksum
How to use checksums
f12b5238907b7c74f5a189065a04237387276a13143140905dbdd4930ff0c39e
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/5.1.1 CPython/3.12.4

Release history Release notifications | RSS feed

This release

2024.8.6.85349 This release

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page