From 60a3df2d83654d6dfa92612bc9208583d487f4e8 Mon Sep 17 00:00:00 2001 From: Michael Hansen Date: Mon, 31 Mar 2025 13:29:19 -0500 Subject: [PATCH] Document preannounce and preannounce_media_id (#38294) --- .../_integrations/assist_satellite.markdown | 42 +++++++++++++++++++ 1 file changed, 42 insertions(+) diff --git a/source/_integrations/assist_satellite.markdown b/source/_integrations/assist_satellite.markdown index 972b3edbf4e..9cdbd19935b 100644 --- a/source/_integrations/assist_satellite.markdown +++ b/source/_integrations/assist_satellite.markdown @@ -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 +```