jeans/developers.home-assistant
jeans/developers.home-assistant
1
0
Fork 0
mirror of https://github.com/home-assistant/developers.home-assistant.git synced 2025-07-08 18:06:29 +00:00
Code Issues Packages Projects Releases Wiki Activity

Document start conversation for Assist satellite entities (#2551)

Browse Source
This commit is contained in:
Michael Hansen 2025-01-30 15:19:52 -06:00 committed by GitHub
parent 2b2b3f5899
commit 9ec91f32d3
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 12 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
docs/core/entity/assist-satellite.md
View File

@ -39,6 +39,7 @@ and are combined using the bitwise or (`|`) operator.
| Value | Description | | Value | Description |
|------------|---------------------------------------------------| |------------|---------------------------------------------------|
| `ANNOUNCE` | Device supports remotely triggered announcements. Implement the `async_announce` method to play back the provided `media_id` from `AssistSatelliteAnnouncement`. This method should only return once the announcement has finished playing on the device. | | `ANNOUNCE` | Device supports remotely triggered announcements. Implement the `async_announce` method to play back the provided `media_id` from `AssistSatelliteAnnouncement`. This method should only return once the announcement has finished playing on the device. |
| `START_CONVERSATION` | Device supports remotely triggered conversations, which plays an announcement and then listens for one or more voices commands. Implement the `async_start_conversation` method to play back the provided `media_id` from `AssistSatelliteAnnouncement` and then listen for voice commands. This method should only return once the announcement has finished playing. |
## Methods ## Methods
@ -67,6 +68,17 @@ The `async_announce` method should only return when the announcement is finished
An [announce action](https://home-assistant.io/integrations/assist_satellite#action-assist_satelliteannounce) is available for automating announcements. An [announce action](https://home-assistant.io/integrations/assist_satellite#action-assist_satelliteannounce) is available for automating announcements.
### Start Conversation
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
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.
A [start conversation action](https://home-assistant.io/integrations/assist_satellite#action-assist_satellitestart_conversation) is available for automating conversations.
## WebSocket API ## WebSocket API
### Intercepting wake words ### Intercepting wake words