Skip to content

Document pre-announcement #2620

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

Merged
merged 1 commit into from
Apr 1, 2025
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 4 additions & 3 deletions docs/core/entity/assist-satellite.md
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@ A [websocket command](#setting-the-active-wake-words) is available for setting t

### Announcements

If the device has the `ANNOUNCE` [supported feature](#supported-features), then the `async_announce` method should be implemented to announce the provided `media_id` within `AssistSatelliteAnnouncement`.
If the device has the `ANNOUNCE` [supported feature](#supported-features), then the `async_announce` method should be implemented to announce the provided `media_id` within `AssistSatelliteAnnouncement`. If `preannouncement_media_id` is provided, it should be played before the `media_id`.
The `async_announce` method should only return when the announcement is finished playing on the device.

An [announce action](https://home-assistant.io/integrations/assist_satellite#action-assist_satelliteannounce) is available for automating announcements.
Expand All @@ -72,8 +72,9 @@ An [announce action](https://home-assistant.io/integrations/assist_satellite#act

If the device has the `START_CONVERSATION` [supported feature](#supported-features), then the `async_start_conversation` method should be implemented to:

1. Announce the provided `media_id` within `AssistSatelliteAnnouncement`, then
2. Listen for one or more follow-up voice commands
1. Announce `preannouncement_media_id` within `AssistSatelliteAnnouncement`, if provided
2. Announce the provided `media_id` within `AssistSatelliteAnnouncement`, then
3. Listen for one or more follow-up voice commands

The `async_start_conversation` method should only return when the announcement is finished playing on the device. The conversation will continue between the user and the satellite.

Expand Down