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 VAD sensitivity option to VoIP devices #94688

Merged
merged 6 commits into from Jun 24, 2023
Merged

Add VAD sensitivity option to VoIP devices #94688

merged 6 commits into from Jun 24, 2023

Conversation

synesthesiam
Copy link
Contributor

Breaking change

Proposed change

Adds a VAD sensitivity option to VoIP devices with 3 settings: default, relaxed, and aggressive. This setting translates into the number of seconds of silence after a voice command before Assist begins processing.

The previous default of 0.5 seconds is now the "aggressive" setting. The "default" and "relaxed" settings are 1 and 3 seconds, respectively.

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 (voip) you are listed as a code owner for? Thanks!

Code owner commands

Code owners of voip 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 voip 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 June 15, 2023 19:55
@synesthesiam synesthesiam requested review from balloob and removed request for balloob June 15, 2023 19:56
from homeassistant.config_entries import ConfigEntry
from homeassistant.core import Event, HomeAssistant, callback
from homeassistant.helpers import device_registry as dr, entity_registry as er

from .const import DOMAIN


class VadSensitivity(StrEnum):
Copy link
Member

Choose a reason for hiding this comment

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

This should live in assist_pipeline.vad and we should make sure it's consistent across any integration that uses VAD (so also ESPHome).

@@ -21,6 +30,7 @@ class VoIPDevice:
device_id: str
is_active: bool = False
update_listeners: list[Callable[[VoIPDevice], None]] = field(default_factory=list)
vad_sensitivity: VadSensitivity = VadSensitivity.DEFAULT
Copy link
Member

Choose a reason for hiding this comment

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

Instead of storing it on VoIPDevice, I suggest that we make it a select entity provided by assist_pipeline/select.py, just like we do for the selected pipeline. That way there is a single consistent place that we control this for all integrations that use VAD.

Copy link
Member

@balloob balloob left a comment

Choose a reason for hiding this comment

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

See comments.

@home-assistant
Copy link

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 home-assistant bot marked this pull request as draft June 16, 2023 14:27
Co-authored-by: Paulus Schoutsen <balloob@gmail.com>
@synesthesiam synesthesiam marked this pull request as ready for review June 24, 2023 02:30
@home-assistant home-assistant bot requested a review from balloob June 24, 2023 02:30
@balloob
Copy link
Member

balloob commented Jun 24, 2023

Please follow-up this PR with one for ESPHome.

@balloob balloob merged commit 65454c9 into dev Jun 24, 2023
24 of 25 checks passed
@balloob balloob deleted the voip-vad-sensitivity branch June 24, 2023 03:28
@github-actions github-actions bot locked and limited conversation to collaborators Jun 25, 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