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 websocket command to capture audio from a device #103936

Merged
merged 7 commits into from Nov 16, 2023

Conversation

synesthesiam
Copy link
Contributor

Breaking change

Proposed change

Intended for discussion; tests have not yet been written.

This PR adds a new websocket command: assist_pipeline/device/capture that causes all audio sent to HA from a specific device_id to be forwarded to the websocket client. Limitations are in place to prevent abuse of this command:

  • Admin privileges are required
  • A maximum of 30 seconds can be recorded at a time
  • Only a single capture per device is allowed

With the assist_pipeline/device/capture command, the frontend device page for voice satellites could be extended to include a button to capture audio and play it back. This would make checking audio settings significantly easier than turning on the assist pipeline debug recording feature, which requires restarting HA and is not intended to be left on.

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 Black (black --fast 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.
  • Untested files have been added to .coveragerc.

To help with the load of incoming pull requests:

@home-assistant
Copy link

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

Code owner commands

Code owners of assist_pipeline 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_pipeline Removes the current integration label and assignees on the pull request, add the integration domain after the command.

@synesthesiam synesthesiam marked this pull request as ready for review November 14, 2023 16:32
@synesthesiam synesthesiam force-pushed the synesthesiam-20231113-device-capture branch from 80f89ba to 90d8948 Compare November 15, 2023 20:18
@synesthesiam synesthesiam merged commit b3e247d into dev Nov 16, 2023
49 checks passed
@synesthesiam synesthesiam deleted the synesthesiam-20231113-device-capture branch November 16, 2023 16:28
@github-actions github-actions bot locked and limited conversation to collaborators Nov 17, 2023
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.

None yet

2 participants