homeassistant.components.wyoming.assist_satellite.WyomingAssistSatellite Class Reference

Inheritance diagram for homeassistant.components.wyoming.assist_satellite.WyomingAssistSatellite:

Collaboration diagram for homeassistant.components.wyoming.assist_satellite.WyomingAssistSatellite:

Public Member Functions
None	__init__ (self, HomeAssistant hass, WyomingService service, SatelliteDevice device, ConfigEntry config_entry)
None	async_added_to_hass (self)
AssistSatelliteConfiguration	async_get_configuration (self)
None	async_set_configuration (self, AssistSatelliteConfiguration config)
None	async_will_remove_from_hass (self)
None	on_muted (self)
None	on_pipeline_event (self, PipelineEvent event)
None	on_reconnect (self)
None	on_restart (self)
None	on_stopped (self)
str|None	pipeline_entity_id (self)
None	run (self)
None	start_satellite (self)
None	stop_satellite (self)
dict[str, Any]|None	tts_options (self)
str|None	vad_sensitivity_entity_id (self)
Public Member Functions inherited from homeassistant.components.wyoming.entity.WyomingSatelliteEntity
None	__init__ (self, SatelliteDevice device)
Public Member Functions inherited from homeassistant.components.assist_satellite.entity.AssistSatelliteEntity
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)
str|None	async_intercept_wake_word (self)
None	async_internal_announce (self, str|None message=None, str|None media_id=None)
str|None	state (self)
None	tts_response_finished (self)

Public Attributes
	config_entry
	device
	is_running
	service

Static Public Attributes
	entity_description = AssistSatelliteEntityDescription(key="assist_satellite")
Static Public Attributes inherited from homeassistant.components.assist_satellite.entity.AssistSatelliteEntity
	bool
	None

Private Member Functions
None	_audio_settings_changed (self)
None	_connect (self)
None	_connect_and_loop (self)
None	_disconnect (self)
None	_handle_timer (self, intent.TimerEventType event_type, intent.TimerInfo timer)
None	_muted_changed (self)
None	_pipeline_changed (self)
None	_run_pipeline_loop (self)
None	_run_pipeline_once (self, RunPipeline run_pipeline, str|None wake_word_phrase=None)
None	_send_delayed_ping (self)
None	_send_pause (self)
None	_stream_tts (self, str media_id)
AsyncGenerator[bytes]	_stt_stream (self)

Private Attributes
	_audio_queue
	_chunk_converter
	_client
	_is_pipeline_running
	_muted_changed_event
	_pipeline_ended_event

Static Private Attributes
	_attr_name = None
string	_attr_translation_key = "assist_satellite"

Detailed Description

Assist satellite for Wyoming devices.

Definition at line 80 of file assist_satellite.py.

Constructor & Destructor Documentation

__init__()

None homeassistant.components.wyoming.assist_satellite.WyomingAssistSatellite.__init__	(		self,
		HomeAssistant	hass,
		WyomingService	service,
		SatelliteDevice	device,
		ConfigEntry	config_entry
	)

Initialize an Assist satellite.

Definition at line 87 of file assist_satellite.py.

Member Function Documentation

_audio_settings_changed()

None homeassistant.components.wyoming.assist_satellite.WyomingAssistSatellite._audio_settings_changed (   self )

private

Run when device audio settings.

Definition at line 368 of file assist_satellite.py.

_connect()

None homeassistant.components.wyoming.assist_satellite.WyomingAssistSatellite._connect (   self )

private

Connect to satellite over TCP.

Definition at line 564 of file assist_satellite.py.

_connect_and_loop()

None homeassistant.components.wyoming.assist_satellite.WyomingAssistSatellite._connect_and_loop (   self )

private

Connect to satellite and run pipelines until an error occurs.

Definition at line 374 of file assist_satellite.py.

_disconnect()

None homeassistant.components.wyoming.assist_satellite.WyomingAssistSatellite._disconnect (   self )

private

Disconnect if satellite is currently connected.

Definition at line 574 of file assist_satellite.py.

_handle_timer()

None homeassistant.components.wyoming.assist_satellite.WyomingAssistSatellite._handle_timer (   self, intent.TimerEventType  event_type, intent.TimerInfo   timer  )

private

Forward timer events to satellite.

Definition at line 636 of file assist_satellite.py.

_muted_changed()

None homeassistant.components.wyoming.assist_satellite.WyomingAssistSatellite._muted_changed (   self )

private

Run when device muted status changes.

Definition at line 350 of file assist_satellite.py.

_pipeline_changed()

None homeassistant.components.wyoming.assist_satellite.WyomingAssistSatellite._pipeline_changed (   self )

private

Run when device pipeline changes.

Definition at line 362 of file assist_satellite.py.

_run_pipeline_loop()

None homeassistant.components.wyoming.assist_satellite.WyomingAssistSatellite._run_pipeline_loop (   self )

private

Run a pipeline one or more times.

Definition at line 401 of file assist_satellite.py.

_run_pipeline_once()

None homeassistant.components.wyoming.assist_satellite.WyomingAssistSatellite._run_pipeline_once (   self, RunPipeline  run_pipeline, str | None   wake_word_phrase = None  )

private

Run a pipeline once.

Definition at line 523 of file assist_satellite.py.

_send_delayed_ping()

None homeassistant.components.wyoming.assist_satellite.WyomingAssistSatellite._send_delayed_ping (   self )

private

Send ping to satellite after a delay.

Definition at line 554 of file assist_satellite.py.

_send_pause()

None homeassistant.components.wyoming.assist_satellite.WyomingAssistSatellite._send_pause (   self )

private

Send a pause message to satellite.

Definition at line 341 of file assist_satellite.py.

_stream_tts()

None homeassistant.components.wyoming.assist_satellite.WyomingAssistSatellite._stream_tts (   self, str  media_id  )

private

Stream TTS WAV audio to satellite in chunks.

Definition at line 583 of file assist_satellite.py.

_stt_stream()

AsyncGenerator[bytes] homeassistant.components.wyoming.assist_satellite.WyomingAssistSatellite._stt_stream (   self )

private

Yield audio chunks from a queue.

Definition at line 622 of file assist_satellite.py.

async_added_to_hass()

None homeassistant.components.wyoming.assist_satellite.WyomingAssistSatellite.async_added_to_hass

(

self

)

Run when entity about to be added to hass.

Definition at line 139 of file assist_satellite.py.

async_get_configuration()

AssistSatelliteConfiguration homeassistant.components.wyoming.assist_satellite.WyomingAssistSatellite.async_get_configuration

(

self

)

Get the current satellite configuration.

Reimplemented from homeassistant.components.assist_satellite.entity.AssistSatelliteEntity.

Definition at line 150 of file assist_satellite.py.

async_set_configuration()

None homeassistant.components.wyoming.assist_satellite.WyomingAssistSatellite.async_set_configuration	(		self,
		AssistSatelliteConfiguration	config
	)

Set the current satellite configuration.

Reimplemented from homeassistant.components.assist_satellite.entity.AssistSatelliteEntity.

Definition at line 156 of file assist_satellite.py.

async_will_remove_from_hass()

None homeassistant.components.wyoming.assist_satellite.WyomingAssistSatellite.async_will_remove_from_hass

(

self

)

Run when entity will be removed from hass.

Definition at line 144 of file assist_satellite.py.

on_muted()

None homeassistant.components.wyoming.assist_satellite.WyomingAssistSatellite.on_muted

(

self

)

Block until device may be unmuted again.

Definition at line 331 of file assist_satellite.py.

on_pipeline_event()

None homeassistant.components.wyoming.assist_satellite.WyomingAssistSatellite.on_pipeline_event	(		self,
		PipelineEvent	event
	)

Set state based on pipeline stage.

Reimplemented from homeassistant.components.assist_satellite.entity.AssistSatelliteEntity.

Definition at line 162 of file assist_satellite.py.

on_reconnect()

None homeassistant.components.wyoming.assist_satellite.WyomingAssistSatellite.on_reconnect

(

self

)

Block until a reconnection attempt should be made.

Definition at line 323 of file assist_satellite.py.

on_restart()

None homeassistant.components.wyoming.assist_satellite.WyomingAssistSatellite.on_restart

(

self

)

Block until pipeline loop will be restarted.

Definition at line 315 of file assist_satellite.py.

on_stopped()

None homeassistant.components.wyoming.assist_satellite.WyomingAssistSatellite.on_stopped

(

self

)

Run when run() has fully stopped.

Definition at line 335 of file assist_satellite.py.

pipeline_entity_id()

str | None homeassistant.components.wyoming.assist_satellite.WyomingAssistSatellite.pipeline_entity_id

(

self

)

Return the entity ID of the pipeline to use for the next conversation.

Reimplemented from homeassistant.components.assist_satellite.entity.AssistSatelliteEntity.

Definition at line 120 of file assist_satellite.py.

run()

None homeassistant.components.wyoming.assist_satellite.WyomingAssistSatellite.run

(

self

)

Run and maintain a connection to satellite.

Definition at line 273 of file assist_satellite.py.

start_satellite()

None homeassistant.components.wyoming.assist_satellite.WyomingAssistSatellite.start_satellite

(

self

)

Start satellite task.

Definition at line 249 of file assist_satellite.py.

stop_satellite()

None homeassistant.components.wyoming.assist_satellite.WyomingAssistSatellite.stop_satellite

(

self

)

Signal satellite task to stop running.

Definition at line 257 of file assist_satellite.py.

tts_options()

dict[str, Any] | None homeassistant.components.wyoming.assist_satellite.WyomingAssistSatellite.tts_options

(

self

)

Options passed for text-to-speech.

Reimplemented from homeassistant.components.assist_satellite.entity.AssistSatelliteEntity.

Definition at line 130 of file assist_satellite.py.

vad_sensitivity_entity_id()

str | None homeassistant.components.wyoming.assist_satellite.WyomingAssistSatellite.vad_sensitivity_entity_id

(

self

)

Return the entity ID of the VAD sensitivity to use for the next conversation.

Reimplemented from homeassistant.components.assist_satellite.entity.AssistSatelliteEntity.

Definition at line 125 of file assist_satellite.py.

Member Data Documentation

_attr_name

homeassistant.components.wyoming.assist_satellite.WyomingAssistSatellite._attr_name = None

staticprivate

Definition at line 85 of file assist_satellite.py.

_attr_translation_key

string homeassistant.components.wyoming.assist_satellite.WyomingAssistSatellite._attr_translation_key = "assist_satellite"

staticprivate

Definition at line 84 of file assist_satellite.py.

_audio_queue

homeassistant.components.wyoming.assist_satellite.WyomingAssistSatellite._audio_queue

private

Definition at line 539 of file assist_satellite.py.

_chunk_converter

homeassistant.components.wyoming.assist_satellite.WyomingAssistSatellite._chunk_converter

private

Definition at line 105 of file assist_satellite.py.

_client

homeassistant.components.wyoming.assist_satellite.WyomingAssistSatellite._client

private

Definition at line 381 of file assist_satellite.py.

_is_pipeline_running

homeassistant.components.wyoming.assist_satellite.WyomingAssistSatellite._is_pipeline_running

private

Definition at line 106 of file assist_satellite.py.

_muted_changed_event

homeassistant.components.wyoming.assist_satellite.WyomingAssistSatellite._muted_changed_event

private

Definition at line 110 of file assist_satellite.py.

_pipeline_ended_event

homeassistant.components.wyoming.assist_satellite.WyomingAssistSatellite._pipeline_ended_event

private

Definition at line 107 of file assist_satellite.py.

config_entry

homeassistant.components.wyoming.assist_satellite.WyomingAssistSatellite.config_entry

Definition at line 100 of file assist_satellite.py.

device

homeassistant.components.wyoming.assist_satellite.WyomingAssistSatellite.device

Definition at line 99 of file assist_satellite.py.

entity_description

homeassistant.components.wyoming.assist_satellite.WyomingAssistSatellite.entity_description = AssistSatelliteEntityDescription(key="assist_satellite")

static

Definition at line 83 of file assist_satellite.py.

is_running

homeassistant.components.wyoming.assist_satellite.WyomingAssistSatellite.is_running

Definition at line 102 of file assist_satellite.py.

service

homeassistant.components.wyoming.assist_satellite.WyomingAssistSatellite.service

Definition at line 98 of file assist_satellite.py.

---

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

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