Assist Satellite
This is an integrationIntegrations connect and integrate Home Assistant with your devices, services, and more. [Learn more] for remote satellites that use Assist to control and interact with Home Assistant. This allows other integrations to represent these satellites in a consistent manner.
Building block integration
This assist satellite is a building block integration that cannot be added to your Home Assistant directly but is used and provided by other integrations.
A building block integration differs from the typical integration that connects to a device or service. Instead, other integrations that do integrate a device or service into Home Assistant use this assist satellite building block to provide entities, services, and other functionality that you can use in your automations or dashboards.
If one of your integrations features this building block, this page documents the functionality the assist satellite building block offers.
Actions
An Assist satellite entity exposes additional actions to remotely control the satellite in automations or scripts. These actions can be created via the UI, but are also available in YAML (examples below).
Action assist_satellite.announce
The assist_satellite.announce
action announces a message or media id on the satellite. If a message is to be announced, it will first be converted to a media id using the text-to-speech system of the satellite’s configured pipeline.
Examples in YAML:
action: assist_satellite.announce
target:
entity_id: assist_satellite.my_entity
message: "Dinner is ready!"
action: assist_satellite.announce
target:
entity_id: assist_satellite.my_entity
media_id: ITEM_ID
Action assist_satellite.start_conversation
The 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 must use a supported conversation agent, such as OpenAI or Google Generative AI. The builtin Assist conversation agent does not support conversations yet.
If a message is to be announced, it will first be converted to a media id using the text-to-speech system of the satellite’s configured pipeline.
The extra_system_prompt
is passed to the conversation agent of the satellite’s configured pipeline. For large language models (LLMs) this will be appended to the prompt given to the model, allowing the LLM to understand the context of a response like “yes” or “no”.
Examples in 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."
action: assist_satellite.start_conversation
target:
entity_id: assist_satellite.my_entity
start_media_id: ITEM_ID