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

Reload the ZBT-1 integration on USB state changes #141287

Merged
merged 9 commits into from
Mar 31, 2025

Conversation

puddly
Copy link
Contributor

@puddly puddly commented Mar 24, 2025

Proposed change

All other integrations that communicate with USB devices rely on USB serial communication to be interrupted in order for them to enter a failure state. The ZBT-1 integration does not have the capability to do this, unfortunately, because it does not communicate with any hardware by default.

To replicate this behavior and have the hardware integration match the state of the device, we subscribe to USB events directly from the usb integration and reload the ZBT-1 config entry, failing if the serial port is missing. This allows fast reactivity:

Screen.Recording.2025-03-24.at.10.13.55.AM.mp4

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

  • This PR fixes or closes issue: fixes #
  • This PR is related to issue:
  • Link to documentation pull request:
  • Link to developer documentation pull request:
  • Link to frontend 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.

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.

To help with the load of incoming pull requests:

@home-assistant
Copy link

Hey there @home-assistant/core, mind taking a look at this pull request as it has been labeled with an integration (homeassistant_yellow) you are listed as a code owner for? Thanks!

Code owner commands

Code owners of homeassistant_yellow 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 homeassistant_yellow 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.

@home-assistant
Copy link

Hey there @home-assistant/core, mind taking a look at this pull request as it has been labeled with an integration (homeassistant_sky_connect) you are listed as a code owner for? Thanks!

Code owner commands

Code owners of homeassistant_sky_connect 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 homeassistant_sky_connect 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.

@puddly puddly force-pushed the puddly/zbt1-unload-on-unplug branch 2 times, most recently from 82bb632 to 8628f3c Compare March 29, 2025 02:03
@puddly puddly marked this pull request as ready for review March 29, 2025 02:04
@puddly puddly requested a review from a team as a code owner March 29, 2025 02:04
@frenck frenck marked this pull request as draft March 29, 2025 17:14
@puddly puddly force-pushed the puddly/zbt1-unload-on-unplug branch from 8628f3c to 84939cc Compare March 31, 2025 14:32
@puddly puddly marked this pull request as ready for review March 31, 2025 14:40
@bdraco
Copy link
Member

bdraco commented Mar 31, 2025

Thanks @puddly

@bdraco bdraco merged commit b758dc2 into home-assistant:dev Mar 31, 2025
34 checks passed
@frenck frenck added this to the 2025.4.0 milestone Apr 1, 2025
frenck pushed a commit that referenced this pull request Apr 1, 2025
* Reload the config entry when the ZBT-1 is unplugged

* Register the USB event handler globally to react better to re-plugs

* Fix existing unit tests

* Add an empty `CONFIG_SCHEMA`

* Add a unit test

* Fix unit tests

* Fix unit tests for Linux

* Address most review comments

* Address remaining review comments
@github-actions github-actions bot locked and limited conversation to collaborators Apr 2, 2025
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.

3 participants