core icon indicating copy to clipboard operation
core copied to clipboard

Add a custom panel for KNX with a group monitor

Open farmio opened this issue 1 year ago • 1 comments

Proposed change

This adds a custom panel for the KNX integrations which allows to upload a project file and offers a group monitor for bus diagnostics.

More features shall follow later - this was our idea of a MVP for a custom KNX panel.

New requirements

xknxproject - the project data parser https://github.com/XKNX/xknxproject/ knx-frontend - the package containing the panels frontend code https://github.com/XKNX/knx-frontend/

Screenshots

Project information and uploader

Bildschirmfoto 2023-05-02 um 10 45 32

Group monitor

Bildschirmfoto 2023-05-02 um 10 48 42

Type of change

  • [ ] Dependency upgrade
  • [ ] Bugfix (non-breaking change which fixes an issue)
  • [ ] New integration (thank you!)
  • [x] New feature (which adds functionality to an existing integration)
  • [ ] Deprecation (breaking change to happen in the future)
  • [ ] Breaking change (fix/feature causing existing functionality to break)
  • [ ] Code quality improvements to existing code or addition of tests

Additional information

  • This PR fixes or closes issue: fixes #
  • This PR is related to issue:
  • Link to documentation pull request:

Checklist

  • [x] The code change is tested and works locally.
  • [x] Local tests pass. Your PR cannot be merged unless tests pass
  • [x] There is no commented out code in this PR.
  • [x] I have followed the development checklist
  • [x] I have followed the perfect PR recommendations
  • [x] The code has been formatted using Black (black --fast homeassistant tests)
  • [x] Tests have been added to verify that the new code works.

If user exposed functionality or configuration variables are added/changed:

If the code communicates with devices, web services, or third-party tools:

  • [x] The manifest file has all fields filled out correctly.
    Updated and included derived files by running: python3 -m script.hassfest.
  • [x] New or updated dependencies have been added to requirements_all.txt.
    Updated by running python3 -m script.gen_requirements_all.
  • [x] For the updated dependencies - a link to the changelog, or at minimum a diff between library versions is added to the PR description.
  • [ ] Untested files have been added to .coveragerc.

To help with the load of incoming pull requests:

farmio avatar May 02 '23 08:05 farmio

Hey there @julius2342, @marvin-w, mind taking a look at this pull request as it has been labeled with an integration (knx) you are listed as a code owner for? Thanks!

Code owner commands

Code owners of knx can trigger bot actions by commenting:

  • @home-assistant close Closes the pull request.
  • @home-assistant rename Awesome new title Renames the pull request.
  • @home-assistant reopen Reopen the pull request.
  • @home-assistant unassign knx Removes the current integration label and assignees on the pull request, add the integration domain after the command.

home-assistant[bot] avatar May 02 '23 08:05 home-assistant[bot]

This is really cool and i'd love to see this in. Is panel_custom is the right way to go? Seems to be very little use of that inside HA. Panels tend to be added directly to the frontend repo.

elupus avatar May 05 '23 19:05 elupus

That was Paulus' suggestion. Afaik it's only used for Insteon currently, and there is an open PR for Dynalite doing the same.

I guess only selected / wider used integrations get to go directly into the frontend repo.

farmio avatar May 05 '23 19:05 farmio

I think this looks good. A second opinion from somebody with more knowledge of custom_panel would be good.

I built the Insteon side panel and this LGTM.

teharris1 avatar May 10 '23 19:05 teharris1

I'm gonna merge this since we have three approving reviews on this. Thank you all!

marvin-w avatar May 10 '23 22:05 marvin-w