# 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:
* 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.
* 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:
```shell
$ make bootstrap
...
```
### Development build (watcher)
```shell
$ make develop
...
```
### Production build
```shell
$ make build
...
```
### Update the home assistant frontend
Replace latest_tag with the current release tag.
```shell
$ 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][hassos_dev_env].
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`)
```shell
$ ln -s <knx-frontend-dir>/knx_frontend <hass-dir>/config/deps/lib/python3.xx/site-packages/
$ hass -c config
...
```
or on a venv-install
```shell
$ 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.
[hassos_dev_env]: https://developers.home-assistant.io/docs/development_environment/
On Home Assistant OS you might use https://github.com/home-assistant/addons-development/tree/master/custom_deps
Raw data
{
"_id": null,
"home_page": null,
"name": "knx-frontend",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.11.0",
"maintainer_email": null,
"keywords": "Home Assistant, KNX",
"author": null,
"author_email": "Marvin Wichmann <me@marvin-wichmann.de>, Matthias Alphart <farmio@alphart.net>",
"download_url": "https://files.pythonhosted.org/packages/21/af/40ab727b83818cd8714e562ccbe0d32dc21543dcc75a402db9e0f5792494/knx_frontend-2024.11.16.205004.tar.gz",
"platform": null,
"description": "# KNX UI\n\nThis is the KNX panel for the KNX core integration in Home Assistant. It\nprovides a user interface for interacting with the KNX integration.\n\n## Features\n\n* Info:\n \n * Get an overview of your current KNX installation state (shows if connected\n to the Bus, which XKNX version is running and the currently assigned\n Individual address)\n * Upload ETS project file (which is used in the Group Monitor to provide\n destination names and DPT interpretation) and delete it again from Home\n Assistant.\n * Get key information about the parsed ETS project which has been uploaded\n* Group Monitor: Use the interactive bus monitor to view all incoming and\n outgoing telegrams on the bus.\n \n* ETS Project: Displays the Group Addresses provided via ETS Project in a tree view\n\n## Development\n\nIf you check this repository out for the first time please run the following command to init the submodules:\n\n```shell\n$ make bootstrap\n...\n```\n\n### Development build (watcher)\n\n```shell\n$ make develop\n...\n```\n\n### Production build\n\n```shell\n$ make build\n...\n```\n\n### Update the home assistant frontend\n\nReplace latest_tag with the current release tag.\n\n```shell\n$ cd homeassistant-frontend\n$ git fetch\n...\n$ git checkout latest_tag\n...\n$ cd ..\n$ rm -f yarn.lock\n$ node ./script/merge_requirements.js\n...\n$ script/bootstrap\n...\n```\n\n### Testing the panel\n\nFirst of all we recommend to follow the instructions for\n[preparing a home assistant development environment][hassos_dev_env].\n\nYou can test the panel by symlinking the build result directory `knx_frontend`\ninto your Home Assistant configuration directory.\n\nAssuming:\n\n* The `knx-frontend` repository is located at `<knx-frontend-dir>` path\n* 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`)\n\n```shell\n$ ln -s <knx-frontend-dir>/knx_frontend <hass-dir>/config/deps/lib/python3.xx/site-packages/\n$ hass -c config\n...\n```\nor on a venv-install\n```shell\n$ cd <hass-dir>\n$ script/setup\n# Next step might be optional\n$ source venv/bin/activate\n$ export PYTHONPATH=<knx-frontend-dir>\n$ hass\n...\n```\n\nNow `hass` (Home Assistant Core) should run on your machine and the knx panel is\naccessible at http://localhost:8123/knx.\n\n[hassos_dev_env]: https://developers.home-assistant.io/docs/development_environment/\n\nOn Home Assistant OS you might use https://github.com/home-assistant/addons-development/tree/master/custom_deps\n",
"bugtrack_url": null,
"license": "MIT License",
"summary": "KNX panel for Home Assistant",
"version": "2024.11.16.205004",
"project_urls": {
"Repository": "https://github.com/XKNX/knx-frontend.git"
},
"split_keywords": [
"home assistant",
" knx"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "0389d5dba719b12d76e2c4aa9e8c56c82d7a445477d3c92d73471033434c3496",
"md5": "09be168856d28d182085bfb13ae6945a",
"sha256": "ecee397f76870dca57a0a5532f81482364fb8e55cc1cfbf1ff601c30020f9778"
},
"downloads": -1,
"filename": "knx_frontend-2024.11.16.205004-py3-none-any.whl",
"has_sig": false,
"md5_digest": "09be168856d28d182085bfb13ae6945a",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.11.0",
"size": 5920772,
"upload_time": "2024-11-16T21:05:05",
"upload_time_iso_8601": "2024-11-16T21:05:05.801929Z",
"url": "https://files.pythonhosted.org/packages/03/89/d5dba719b12d76e2c4aa9e8c56c82d7a445477d3c92d73471033434c3496/knx_frontend-2024.11.16.205004-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "21af40ab727b83818cd8714e562ccbe0d32dc21543dcc75a402db9e0f5792494",
"md5": "6b952dd26955433802c94a72d29280b8",
"sha256": "0ac2ad0932ec0695b720c4dd4fc601b2758b06dfe1b9919e8f2c819aeb13eb37"
},
"downloads": -1,
"filename": "knx_frontend-2024.11.16.205004.tar.gz",
"has_sig": false,
"md5_digest": "6b952dd26955433802c94a72d29280b8",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.11.0",
"size": 5832632,
"upload_time": "2024-11-16T21:05:07",
"upload_time_iso_8601": "2024-11-16T21:05:07.928132Z",
"url": "https://files.pythonhosted.org/packages/21/af/40ab727b83818cd8714e562ccbe0d32dc21543dcc75a402db9e0f5792494/knx_frontend-2024.11.16.205004.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-11-16 21:05:07",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "XKNX",
"github_project": "knx-frontend",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "knx-frontend"
}
JSON
