Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add ZHA support for Bosch Twinguard and siren install QR codes #107460

Merged

Conversation

idstein
Copy link
Contributor

@idstein idstein commented Jan 7, 2024

These devices contain inside their QR code device specific link keys instead of installation codes. Normally, the link key is generated from the installation code, but in this case we can directly pass the provided link key from QR code to zigpy application controller.

Proposed change

Resolves feature request to support Bosch Twinguard devices via ZHA zigpy/zha-device-handlers#2561

Type of change

  • Dependency upgrade
  • Bugfix (non-breaking change which fixes an issue)
  • New integration (thank you!)
  • 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

Bosch Twinguard and Bosch Outdoor Siren supplies device specific link key instead of installation code within their QR codes.

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

Checklist

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

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

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

  • The manifest file has all fields filled out correctly.
    Updated and included derived files by running: python3 -m script.hassfest.
  • New or updated dependencies have been added to requirements_all.txt.
    Updated by running python3 -m script.gen_requirements_all.
  • 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:

Copy link

@home-assistant home-assistant bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi @idstein

It seems you haven't yet signed a CLA. Please do so here.

Once you do that we will be able to review and accept this pull request.

Thanks!

@home-assistant home-assistant bot marked this pull request as draft January 7, 2024 14:52
@home-assistant
Copy link

home-assistant bot commented Jan 7, 2024

Please take a look at the requested changes, and use the Ready for review button when you are done, thanks 👍

Learn more about our pull request process.

@home-assistant
Copy link

home-assistant bot commented Jan 7, 2024

Hey there @dmulcahey, @Adminiuga, @puddly, @TheJulianJES, mind taking a look at this pull request as it has been labeled with an integration (zha) you are listed as a code owner for? Thanks!

Code owner commands

Code owners of zha 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 zha Removes the current integration label and assignees on the pull request, add the integration domain after the command.
  • @home-assistant add-label needs-more-information Add a label (needs-more-information, problem in dependency, problem in custom component) to the pull request.
  • @home-assistant remove-label needs-more-information Remove a label (needs-more-information, problem in dependency, problem in custom component) on the pull request.

@idstein idstein marked this pull request as ready for review January 15, 2024 10:39
@idstein idstein force-pushed the bosch-twinguard-qr-code-with-link-key branch from 6327c3c to ec34a86 Compare January 15, 2024 16:28
@dmulcahey
Copy link
Contributor

There are ruff errors here. if you run the setup script at the bottom of this page: https://developers.home-assistant.io/docs/development_environment you will get a pre-commit hook that will prevent lint errors from making it to CI.

@idstein
Copy link
Contributor Author

idstein commented Jan 17, 2024

There are ruff errors here. if you run the setup script at the bottom of this page: https://developers.home-assistant.io/docs/development_environment you will get a pre-commit hook that will prevent lint errors from making it to CI.

Thx for the hint. I was running locally ruff format homeassistant tests and it was missing for some reason that file. The pre-commit hook is now installed and working.

@idstein idstein force-pushed the bosch-twinguard-qr-code-with-link-key branch from be2196f to f2ecbe5 Compare January 17, 2024 15:58
home-assistant[bot]

This comment was marked as outdated.

@home-assistant home-assistant bot marked this pull request as draft January 22, 2024 11:05
home-assistant[bot]

This comment was marked as outdated.

@idstein idstein force-pushed the bosch-twinguard-qr-code-with-link-key branch from e273abb to c6fff6c Compare January 22, 2024 11:10
@idstein idstein marked this pull request as ready for review January 22, 2024 11:11
@home-assistant home-assistant bot dismissed stale reviews from themself January 22, 2024 11:11

Stale

@TheJulianJES TheJulianJES changed the title Enable Bosch Outdoor Siren and Bosch Twinguard QR Codes Add ZHA support for Bosch Twinguard and siren install QR codes Jan 24, 2024
These devices contain inside their QR code device specific link keys instead of installation codes. Normally, the link key is generated from the installation code, but in this case we can directly pass the provided link key from QR code to zigpy application controller.
Convert installation code directly to link key
@idstein idstein force-pushed the bosch-twinguard-qr-code-with-link-key branch from e98df27 to 07c0cd3 Compare January 24, 2024 08:05
Copy link
Contributor

@puddly puddly left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks!

@puddly puddly merged commit f4a2d7c into home-assistant:dev Jan 31, 2024
23 checks passed
@idstein idstein deleted the bosch-twinguard-qr-code-with-link-key branch January 31, 2024 19:28
@github-actions github-actions bot locked and limited conversation to collaborators Feb 2, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants