jeans/home-assistant.io
jeans/home-assistant.io
1
0
Fork 0
mirror of https://github.com/home-assistant/home-assistant.io.git synced 2025-07-28 11:47:00 +00:00
Code Issues Packages Projects Releases Wiki Activity

Document preannounce and preannounce_media_id (#38294)

Browse Source
This commit is contained in:
Michael Hansen 2025-03-31 13:29:19 -05:00 committed by GitHub
parent bb0fd54562
commit 60a3df2d83
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 42 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

42
source/_integrations/assist_satellite.markdown
View File

@ -44,6 +44,26 @@ target:
media_id: ITEM_ID
```
A chime is automatically played before the announcement. You can override this with your own sound by setting `preannounce_media_id`, or disable the chime entirely by setting `preannounce` to `false`.
Examples in YAML:
```yaml
action: assist_satellite.announce
target:
entity_id: assist_satellite.my_entity
message: "Dinner is ready!"
preannounce_media_id: ITEM_ID # custom chime
```
```yaml
action: assist_satellite.announce
target:
entity_id: assist_satellite.my_entity
message: "Dinner is ready!"
preannounce: false # chime disabled
```
### Action `assist_satellite.start_conversation`
The {% my developer_call_service service="assist_satellite.start_conversation" %} action first announces a message or media id on the satellite and then listens for one or more voice commands. The satellite's configured [pipeline](/voice_control/voice_remote_local_assistant/) must use a supported [conversation agent](/integrations/conversation), such as [OpenAI](/integrations/openai_conversation) or [Google Generative AI](/integrations/google_generative_ai_conversation). The builtin Assist conversation agent does not support conversations yet.
@ -70,3 +90,25 @@ target:
entity_id: assist_satellite.my_entity
start_media_id: ITEM_ID
```
A chime is automatically played before the start message or media. You can override this with your own sound by setting `preannounce_media_id`, or disable the chime entirely by setting `preannounce` to `false`.
Examples in YAML:
```yaml
action: assist_satellite.start_conversation
target:
entity_id: assist_satellite.my_entity
start_message: "You left the lights on in the living room. Turn them off?"
extra_system_prompt: "The user has left the lights on in the living room and is being asked if they'd like to turn them off."
preannounce_media_id: ITEM_ID # custom chime
```
```yaml
action: assist_satellite.start_conversation
target:
entity_id: assist_satellite.my_entity
start_message: "You left the lights on in the living room. Turn them off?"
extra_system_prompt: "The user has left the lights on in the living room and is being asked if they'd like to turn them off."
preannounce: false # chime disabled
```