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

Change wake word interception to a subscription #125629

Merged
merged 4 commits into from
Sep 16, 2024

Conversation

synesthesiam
Copy link
Contributor

@synesthesiam synesthesiam commented Sep 9, 2024

Breaking change

Proposed change

Modifies the assist_satellite/intercept_wake_word websocket command to be a subscription instead. This will allow it to be cancelled within the UI. Additionally, starting a second interception will cancel the first one.

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:

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

home-assistant bot commented Sep 9, 2024

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

Code owner commands

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

Copy link
Member

@MartinHjelmare MartinHjelmare left a comment

Choose a reason for hiding this comment

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

We shouldn't merge this until frontend confirms they are happy.

Also, please complete the tests.

@synesthesiam synesthesiam changed the title Allow stopping intercepting wake words Change wake word interception to a subscription Sep 9, 2024
@synesthesiam synesthesiam requested a review from balloob September 9, 2024 20:58
@synesthesiam synesthesiam marked this pull request as ready for review September 9, 2024 20:58
@synesthesiam synesthesiam requested a review from a team as a code owner September 9, 2024 20:58
@synesthesiam synesthesiam force-pushed the synesthesiam-20240909-stop-intercept-wakeword branch from bc6caf2 to e6b71e0 Compare September 10, 2024 17:42
@MartinHjelmare MartinHjelmare marked this pull request as draft September 11, 2024 06:38
@synesthesiam synesthesiam force-pushed the synesthesiam-20240909-stop-intercept-wakeword branch from 686201f to 011f875 Compare September 11, 2024 16:43
@synesthesiam synesthesiam marked this pull request as ready for review September 11, 2024 16:44
@synesthesiam
Copy link
Contributor Author

Test failure appears unrelated

Copy link
Member

@MartinHjelmare MartinHjelmare left a comment

Choose a reason for hiding this comment

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

Thanks!

Can be merged once approved by frontend.

@MartinHjelmare MartinHjelmare marked this pull request as draft September 12, 2024 11:43
@bramkragten bramkragten marked this pull request as ready for review September 16, 2024 12:50
@bramkragten bramkragten merged commit c63cab3 into dev Sep 16, 2024
43 checks passed
@bramkragten bramkragten deleted the synesthesiam-20240909-stop-intercept-wakeword branch September 16, 2024 12:50
bealex pushed a commit to DevPocket/homeassistant-core that referenced this pull request Sep 16, 2024
* Allow stopping intercepting wake words

* Make wake word interception a subscription

* Keep future

* Add test for unsub
@github-actions github-actions bot locked and limited conversation to collaborators Sep 17, 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.

4 participants