Public Member Functions
str\|None	get_assist_in_progress_entity_id (self, HomeAssistant hass)

str\|None	get_auto_gain_entity_id (self, HomeAssistant hass)

str\|None	get_muted_entity_id (self, HomeAssistant hass)

str\|None	get_noise_suppression_level_entity_id (self, HomeAssistant hass)

str\|None	get_pipeline_entity_id (self, HomeAssistant hass)

str\|None	get_vad_sensitivity_entity_id (self, HomeAssistant hass)

str\|None	get_volume_multiplier_entity_id (self, HomeAssistant hass)

None	set_audio_settings_listener (self, Callable[[], None] audio_settings_listener)

None	set_auto_gain (self, int auto_gain)

None	set_is_active (self, bool active)

None	set_is_active_listener (self, Callable[[], None] is_active_listener)

None	set_is_muted (self, bool muted)

None	set_is_muted_listener (self, Callable[[], None] is_muted_listener)

None	set_noise_suppression_level (self, int noise_suppression_level)

None	set_pipeline_listener (self, Callable[[], None] pipeline_listener)

None	set_pipeline_name (self, str pipeline_name)

None	set_vad_sensitivity (self, VadSensitivity vad_sensitivity)

None	set_volume_multiplier (self, float volume_multiplier)

Public Attributes
	auto_gain

	is_active

	is_muted

	noise_suppression_level

	pipeline_name

	vad_sensitivity

	volume_multiplier

Static Public Attributes
	bool

	float

	int

	None

	VadSensitivity

Private Attributes
	_audio_settings_listener

	_is_active_listener

	_is_muted_listener

	_pipeline_listener

Detailed Description

Class to store device.

Definition at line 16 of file devices.py.

Member Function Documentation

◆ get_assist_in_progress_entity_id()

str \| None homeassistant.components.wyoming.devices.SatelliteDevice.get_assist_in_progress_entity_id	(		self,
		HomeAssistant	hass
	)

Return entity id for assist in progress binary sensor.

Definition at line 112 of file devices.py.

◆ get_auto_gain_entity_id()

str \| None homeassistant.components.wyoming.devices.SatelliteDevice.get_auto_gain_entity_id	(		self,
		HomeAssistant	hass
	)

Return entity id for auto gain amount.

Definition at line 140 of file devices.py.

◆ get_muted_entity_id()

str \| None homeassistant.components.wyoming.devices.SatelliteDevice.get_muted_entity_id	(		self,
		HomeAssistant	hass
	)

Return entity id for satellite muted switch.

Definition at line 119 of file devices.py.

◆ get_noise_suppression_level_entity_id()

str \| None homeassistant.components.wyoming.devices.SatelliteDevice.get_noise_suppression_level_entity_id	(		self,
		HomeAssistant	hass
	)

Return entity id for noise suppression select.

Definition at line 133 of file devices.py.

◆ get_pipeline_entity_id()

str \| None homeassistant.components.wyoming.devices.SatelliteDevice.get_pipeline_entity_id	(		self,
		HomeAssistant	hass
	)

Return entity id for pipeline select.

Definition at line 126 of file devices.py.

◆ get_vad_sensitivity_entity_id()

str \| None homeassistant.components.wyoming.devices.SatelliteDevice.get_vad_sensitivity_entity_id	(		self,
		HomeAssistant	hass
	)

Return entity id for VAD sensitivity.

Definition at line 154 of file devices.py.

◆ get_volume_multiplier_entity_id()

str \| None homeassistant.components.wyoming.devices.SatelliteDevice.get_volume_multiplier_entity_id	(		self,
		HomeAssistant	hass
	)

Return entity id for microphone volume multiplier.

Definition at line 147 of file devices.py.

◆ set_audio_settings_listener()

None homeassistant.components.wyoming.devices.SatelliteDevice.set_audio_settings_listener	(		self,
		Callable[[], None]	audio_settings_listener
	)

Listen for updates to audio settings.

Definition at line 106 of file devices.py.

◆ set_auto_gain()

None homeassistant.components.wyoming.devices.SatelliteDevice.set_auto_gain	(		self,
		int	auto_gain
	)

Set auto gain amount.

Definition at line 67 of file devices.py.

◆ set_is_active()

None homeassistant.components.wyoming.devices.SatelliteDevice.set_is_active	(		self,
		bool	active
	)

Set active state.

Definition at line 35 of file devices.py.

◆ set_is_active_listener()

None homeassistant.components.wyoming.devices.SatelliteDevice.set_is_active_listener	(		self,
		Callable[[], None]	is_active_listener
	)

Listen for updates to is_active.

Definition at line 91 of file devices.py.

◆ set_is_muted()

None homeassistant.components.wyoming.devices.SatelliteDevice.set_is_muted	(		self,
		bool	muted
	)

Set muted state.

Definition at line 43 of file devices.py.

◆ set_is_muted_listener()

None homeassistant.components.wyoming.devices.SatelliteDevice.set_is_muted_listener	(		self,
		Callable[[], None]	is_muted_listener
	)

Listen for updates to muted status.

Definition at line 96 of file devices.py.

◆ set_noise_suppression_level()

None homeassistant.components.wyoming.devices.SatelliteDevice.set_noise_suppression_level	(		self,
		int	noise_suppression_level
	)

Set noise suppression level.

Definition at line 59 of file devices.py.

◆ set_pipeline_listener()

None homeassistant.components.wyoming.devices.SatelliteDevice.set_pipeline_listener	(		self,
		Callable[[], None]	pipeline_listener
	)

Listen for updates to pipeline.

Definition at line 101 of file devices.py.

◆ set_pipeline_name()

None homeassistant.components.wyoming.devices.SatelliteDevice.set_pipeline_name	(		self,
		str	pipeline_name
	)

Inform listeners that pipeline selection has changed.

Definition at line 51 of file devices.py.

◆ set_vad_sensitivity()

None homeassistant.components.wyoming.devices.SatelliteDevice.set_vad_sensitivity	(		self,
		VadSensitivity	vad_sensitivity
	)

Set VAD sensitivity.

Definition at line 83 of file devices.py.

◆ set_volume_multiplier()

None homeassistant.components.wyoming.devices.SatelliteDevice.set_volume_multiplier	(		self,
		float	volume_multiplier
	)

Set auto gain amount.

Definition at line 75 of file devices.py.

Member Data Documentation

◆ _audio_settings_listener

homeassistant.components.wyoming.devices.SatelliteDevice._audio_settings_listener

private

Definition at line 110 of file devices.py.

◆ _is_active_listener

homeassistant.components.wyoming.devices.SatelliteDevice._is_active_listener

private

Definition at line 93 of file devices.py.

◆ _is_muted_listener

homeassistant.components.wyoming.devices.SatelliteDevice._is_muted_listener

private

Definition at line 98 of file devices.py.

◆ _pipeline_listener

homeassistant.components.wyoming.devices.SatelliteDevice._pipeline_listener

private

Definition at line 103 of file devices.py.

◆ auto_gain

homeassistant.components.wyoming.devices.SatelliteDevice.auto_gain

Definition at line 70 of file devices.py.

◆ bool

homeassistant.components.wyoming.devices.SatelliteDevice.bool

static

Definition at line 21 of file devices.py.

◆ float

homeassistant.components.wyoming.devices.SatelliteDevice.float

static

Definition at line 26 of file devices.py.

◆ int

homeassistant.components.wyoming.devices.SatelliteDevice.int

static

Definition at line 24 of file devices.py.

◆ is_active

homeassistant.components.wyoming.devices.SatelliteDevice.is_active

Definition at line 38 of file devices.py.

◆ is_muted

homeassistant.components.wyoming.devices.SatelliteDevice.is_muted

Definition at line 46 of file devices.py.

◆ noise_suppression_level

homeassistant.components.wyoming.devices.SatelliteDevice.noise_suppression_level

Definition at line 62 of file devices.py.

◆ None

homeassistant.components.wyoming.devices.SatelliteDevice.None

static

Definition at line 23 of file devices.py.

◆ pipeline_name

homeassistant.components.wyoming.devices.SatelliteDevice.pipeline_name

Definition at line 54 of file devices.py.

◆ vad_sensitivity

homeassistant.components.wyoming.devices.SatelliteDevice.vad_sensitivity

Definition at line 86 of file devices.py.

◆ VadSensitivity

homeassistant.components.wyoming.devices.SatelliteDevice.VadSensitivity

static

Definition at line 27 of file devices.py.

◆ volume_multiplier

homeassistant.components.wyoming.devices.SatelliteDevice.volume_multiplier

Definition at line 78 of file devices.py.

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

core/homeassistant/components/wyoming/devices.py

Home Assistant Unofficial Reference 2024.12.1

Public Member Functions

Public Attributes

Static Public Attributes

Private Attributes

Detailed Description

Member Function Documentation

◆ get_assist_in_progress_entity_id()

◆ get_auto_gain_entity_id()

◆ get_muted_entity_id()

◆ get_noise_suppression_level_entity_id()

◆ get_pipeline_entity_id()

◆ get_vad_sensitivity_entity_id()

◆ get_volume_multiplier_entity_id()

◆ set_audio_settings_listener()

◆ set_auto_gain()

◆ set_is_active()

◆ set_is_active_listener()

◆ set_is_muted()

◆ set_is_muted_listener()

◆ set_noise_suppression_level()

◆ set_pipeline_listener()

◆ set_pipeline_name()

◆ set_vad_sensitivity()

◆ set_volume_multiplier()

Member Data Documentation

◆ _audio_settings_listener

◆ _is_active_listener

◆ _is_muted_listener

◆ _pipeline_listener

◆ auto_gain

◆ bool

◆ float

◆ int

◆ is_active

◆ is_muted

◆ noise_suppression_level

◆ None

◆ pipeline_name

◆ vad_sensitivity

◆ VadSensitivity

◆ volume_multiplier