Skip to content

Add wyoming satellite support for assist_satellite.start_conversation and assist_satellite.ask_question#149149

Closed
RemyRoux wants to merge 10 commits intohome-assistant:devfrom
RemyRoux:patch-2
Closed

Add wyoming satellite support for assist_satellite.start_conversation and assist_satellite.ask_question#149149
RemyRoux wants to merge 10 commits intohome-assistant:devfrom
RemyRoux:patch-2

Conversation

@RemyRoux
Copy link

@RemyRoux RemyRoux commented Jul 20, 2025

Proposed change

This PR introduces full AssistSatelliteEntity support for the Wyoming integration. This allows users with Wyoming-based voice satellites (like those running on a Raspberry Pi) to use the standard assist_satellite.announce, assist_satellite.start_conversation, and assist_satellite.ask_question services, bringing them to feature parity with other advanced satellite platforms.

This is achieved by creating a new WyomingAssistSatellite entity that inherits from AssistSatelliteEntity and acts as the primary entity for a Wyoming satellite device. This entity:

  • Translates pipeline events from Home Assistant into Wyoming protocol events, allowing the physical device to react to wake word detection, STT, and TTS stages.

  • Handles service calls by streaming audio via ffmpeg for announcements.

  • Remotely triggers the satellite's listening mode by sending a Detection event, which seamlessly starts the audio stream for conversations.

  • Correctly implements the ask_question service, which involves modifying the pipeline's end stage at runtime to STT and using an asyncio.Future to reliably return the transcribed text to the calling script or automation.

This change significantly enhances the capabilities of Wyoming satellites, making them first-class citizens in the Home Assistant voice ecosystem.

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

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:

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 @RemyRoux

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
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
Copy link

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

Code owner commands

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

@synesthesiam
Copy link
Contributor

Why does the PR delete a bunch of comments and whitespace?

@RemyRoux
Copy link
Author

Sorry for that, I've reverted. Let me add some unit tests as well.

preannounce_media_id=preannounce_media_id,
)

async def async_internal_ask_question(
Copy link
Member

Choose a reason for hiding this comment

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

As the name itself implies, this is an internal method and should not be overridden in subclasses.

Copy link
Author

Choose a reason for hiding this comment

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

Ah true, I was wondering about this. Do you know why it was marked as internal?

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 @wseng

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!

@vitospinelli
Copy link

Is there a tentative timeline for this?

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 @wseng

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!

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 @wseng

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!

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 @wseng

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!

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 @wseng

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!

@RemyRoux RemyRoux marked this pull request as ready for review September 12, 2025 21:24
@home-assistant home-assistant bot dismissed stale reviews from themself September 12, 2025 21:24

Stale

@arturpragacz arturpragacz moved this to Triage in Voice Sep 13, 2025
@synesthesiam synesthesiam moved this from Triage to Later in Voice Sep 17, 2025
@arturpragacz arturpragacz moved this from Later to Next in Voice Sep 23, 2025
@synesthesiam
Copy link
Contributor

I really appreciate the effort taken to make this PR. I'm hesitant to move forward with large changes to the Wyoming Satellite code given that we're moving to the Linux Voice Assistant codebase for Raspberry Pi based satellites going forward. This new codebase reuses the ESPHome message set, which means there's no longer a need to keep separate code paths in HA core for ESP and RPi satellites.

@synesthesiam synesthesiam marked this pull request as draft October 20, 2025 15:22
@synesthesiam synesthesiam moved this from Next to Done in Voice Oct 20, 2025
@RemyRoux
Copy link
Author

I agree, I've been using the LVA approach and abandoned this project. I'm closing this PR.

@RemyRoux RemyRoux closed this Oct 20, 2025
@github-actions github-actions bot locked and limited conversation to collaborators Oct 21, 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.

6 participants