homeassistant.components.assist_satellite.entity.AssistSatelliteEntity Class Reference

Inheritance diagram for homeassistant.components.assist_satellite.entity.AssistSatelliteEntity:

Collaboration diagram for homeassistant.components.assist_satellite.entity.AssistSatelliteEntity:

Public Member Functions
None	async_accept_pipeline_from_satellite (self, AsyncIterable[bytes] audio_stream, PipelineStage start_stage=PipelineStage.STT, PipelineStage end_stage=PipelineStage.TTS, str|None wake_word_phrase=None)
None	async_announce (self, AssistSatelliteAnnouncement announcement)
AssistSatelliteConfiguration	async_get_configuration (self)
str|None	async_intercept_wake_word (self)
None	async_internal_announce (self, str|None message=None, str|None media_id=None)
None	async_set_configuration (self, AssistSatelliteConfiguration config)
None	on_pipeline_event (self, PipelineEvent event)
str|None	pipeline_entity_id (self)
str|None	state (self)
dict[str, Any]|None	tts_options (self)
None	tts_response_finished (self)
str|None	vad_sensitivity_entity_id (self)

Static Public Attributes
	bool
	None

Private Member Functions
None	_cancel_running_pipeline (self)
None	_internal_on_pipeline_event (self, PipelineEvent event)
str|None	_resolve_pipeline (self)
float	_resolve_vad_sensitivity (self)
None	_set_state (self, AssistSatelliteState state)

Private Attributes
	_conversation_id
	_conversation_id_time
	_is_announcing
	_pipeline_task
	_run_has_tts
	_wake_word_intercept_future

Static Private Attributes
	__assist_satellite_state = AssistSatelliteState.IDLE
bool	_attr_should_poll = False
	_attr_supported_features = AssistSatelliteEntityFeature(0)
bool	_is_announcing = False

Detailed Description

Entity encapsulating the state and functionality of an Assist satellite.

Definition at line 102 of file entity.py.

Member Function Documentation

_cancel_running_pipeline()

None homeassistant.components.assist_satellite.entity.AssistSatelliteEntity._cancel_running_pipeline (   self )

private

Cancel the current pipeline if it's running.

Definition at line 349 of file entity.py.

_internal_on_pipeline_event()

None homeassistant.components.assist_satellite.entity.AssistSatelliteEntity._internal_on_pipeline_event (   self, PipelineEvent  event  )

private

Set state based on pipeline stage.

Definition at line 363 of file entity.py.

_resolve_pipeline()

str | None homeassistant.components.assist_satellite.entity.AssistSatelliteEntity._resolve_pipeline (   self )

private

Resolve pipeline from select entity to id.

Return None to make async_get_pipeline look up the preferred pipeline.

Definition at line 398 of file entity.py.

_resolve_vad_sensitivity()

float homeassistant.components.assist_satellite.entity.AssistSatelliteEntity._resolve_vad_sensitivity (   self )

private

Resolve VAD sensitivity from select entity to enum.

Definition at line 418 of file entity.py.

_set_state()

None homeassistant.components.assist_satellite.entity.AssistSatelliteEntity._set_state (   self, AssistSatelliteState  state  )

private

Set the entity's state.

Definition at line 387 of file entity.py.

async_accept_pipeline_from_satellite()

None homeassistant.components.assist_satellite.entity.AssistSatelliteEntity.async_accept_pipeline_from_satellite	(		self,
		AsyncIterable[bytes]	audio_stream,
		PipelineStage	start_stage = PipelineStage.STT,
		PipelineStage	end_stage = PipelineStage.TTS,
		str | None	wake_word_phrase = None
	)

Triggers an Assist pipeline in Home Assistant from a satellite.

Definition at line 254 of file entity.py.

async_announce()

None homeassistant.components.assist_satellite.entity.AssistSatelliteEntity.async_announce	(		self,
		AssistSatelliteAnnouncement	announcement
	)

Announce media on the satellite.

Should block until the announcement is done playing.

Definition at line 247 of file entity.py.

async_get_configuration()

AssistSatelliteConfiguration homeassistant.components.assist_satellite.entity.AssistSatelliteEntity.async_get_configuration

(

self

)

Get the current satellite configuration.

Reimplemented in homeassistant.components.wyoming.assist_satellite.WyomingAssistSatellite, homeassistant.components.voip.assist_satellite.VoipAssistSatellite, and homeassistant.components.esphome.assist_satellite.EsphomeAssistSatellite.

Definition at line 145 of file entity.py.

async_intercept_wake_word()

str | None homeassistant.components.assist_satellite.entity.AssistSatelliteEntity.async_intercept_wake_word

(

self

)

Intercept the next wake word from the satellite.

Returns the detected wake word phrase or None.

Definition at line 154 of file entity.py.

async_internal_announce()

None homeassistant.components.assist_satellite.entity.AssistSatelliteEntity.async_internal_announce	(		self,
		str | None	message = None,
		str | None	media_id = None
	)

Play and show an announcement on the satellite.

If media_id is not provided, message is synthesized to
audio with the selected pipeline.

If media_id is provided, it is played directly. It is possible
to omit the message and the satellite will not show any text.

Calls async_announce with message and media id.

Definition at line 173 of file entity.py.

async_set_configuration()

None homeassistant.components.assist_satellite.entity.AssistSatelliteEntity.async_set_configuration	(		self,
		AssistSatelliteConfiguration	config
	)

Set the current satellite configuration.

Reimplemented in homeassistant.components.wyoming.assist_satellite.WyomingAssistSatellite, and homeassistant.components.voip.assist_satellite.VoipAssistSatellite.

Definition at line 149 of file entity.py.

on_pipeline_event()

None homeassistant.components.assist_satellite.entity.AssistSatelliteEntity.on_pipeline_event	(		self,
		PipelineEvent	event
	)

Handle pipeline events.

Reimplemented in homeassistant.components.wyoming.assist_satellite.WyomingAssistSatellite, homeassistant.components.voip.assist_satellite.VoipAssistSatellite, and homeassistant.components.esphome.assist_satellite.EsphomeAssistSatellite.

Definition at line 359 of file entity.py.

pipeline_entity_id()

str | None homeassistant.components.assist_satellite.entity.AssistSatelliteEntity.pipeline_entity_id

(

self

)

Entity ID of the pipeline to use for the next conversation.

Reimplemented in homeassistant.components.wyoming.assist_satellite.WyomingAssistSatellite, homeassistant.components.voip.assist_satellite.VoipAssistSatellite, and homeassistant.components.esphome.assist_satellite.EsphomeAssistSatellite.

Definition at line 129 of file entity.py.

state()

str | None homeassistant.components.assist_satellite.entity.AssistSatelliteEntity.state

(

self

)

Return state of the entity.

Definition at line 124 of file entity.py.

tts_options()

dict[str, Any] | None homeassistant.components.assist_satellite.entity.AssistSatelliteEntity.tts_options

(

self

)

Options passed for text-to-speech.

Reimplemented in homeassistant.components.wyoming.assist_satellite.WyomingAssistSatellite, and homeassistant.components.voip.assist_satellite.VoipAssistSatellite.

Definition at line 139 of file entity.py.

tts_response_finished()

None homeassistant.components.assist_satellite.entity.AssistSatelliteEntity.tts_response_finished

(

self

)

Tell entity that the text-to-speech response has finished playing.

Definition at line 393 of file entity.py.

vad_sensitivity_entity_id()

str | None homeassistant.components.assist_satellite.entity.AssistSatelliteEntity.vad_sensitivity_entity_id

(

self

)

Entity ID of the VAD sensitivity to use for the next conversation.

Reimplemented in homeassistant.components.wyoming.assist_satellite.WyomingAssistSatellite, homeassistant.components.voip.assist_satellite.VoipAssistSatellite, and homeassistant.components.esphome.assist_satellite.EsphomeAssistSatellite.

Definition at line 134 of file entity.py.

Member Data Documentation

__assist_satellite_state

homeassistant.components.assist_satellite.entity.AssistSatelliteEntity.__assist_satellite_state = AssistSatelliteState.IDLE

staticprivate

Definition at line 120 of file entity.py.

_attr_should_poll

bool homeassistant.components.assist_satellite.entity.AssistSatelliteEntity._attr_should_poll = False

staticprivate

Definition at line 106 of file entity.py.

_attr_supported_features

homeassistant.components.assist_satellite.entity.AssistSatelliteEntity._attr_supported_features = AssistSatelliteEntityFeature(0)

staticprivate

Definition at line 107 of file entity.py.

_conversation_id

homeassistant.components.assist_satellite.entity.AssistSatelliteEntity._conversation_id

private

Definition at line 308 of file entity.py.

_conversation_id_time

homeassistant.components.assist_satellite.entity.AssistSatelliteEntity._conversation_id_time

private

Definition at line 309 of file entity.py.

_is_announcing [1/2]

bool homeassistant.components.assist_satellite.entity.AssistSatelliteEntity._is_announcing = False

staticprivate

Definition at line 115 of file entity.py.

_is_announcing [2/2]

homeassistant.components.assist_satellite.entity.AssistSatelliteEntity._is_announcing

private

Definition at line 235 of file entity.py.

_pipeline_task

homeassistant.components.assist_satellite.entity.AssistSatelliteEntity._pipeline_task

private

Definition at line 315 of file entity.py.

_run_has_tts

homeassistant.components.assist_satellite.entity.AssistSatelliteEntity._run_has_tts

private

Definition at line 312 of file entity.py.

_wake_word_intercept_future

homeassistant.components.assist_satellite.entity.AssistSatelliteEntity._wake_word_intercept_future

private

Definition at line 164 of file entity.py.

bool

homeassistant.components.assist_satellite.entity.AssistSatelliteEntity.bool

static

Definition at line 114 of file entity.py.

None

homeassistant.components.assist_satellite.entity.AssistSatelliteEntity.None

static

Definition at line 108 of file entity.py.

---

The documentation for this class was generated from the following file:

• core/homeassistant/components/assist_satellite/entity.py