#include <voice_assistant.h>

Inheritance diagram for esphome::voice_assistant::VoiceAssistant:

Public Member Functions
	VoiceAssistant ()

void	loop () override

void	setup () override

float	get_setup_priority () const override

void	start_streaming ()

void	start_streaming (struct sockaddr_storage *addr, uint16_t port)

void	failed_to_start ()

void	set_microphone_source (microphone::MicrophoneSource *mic_source)

void	set_microphone_source2 (microphone::MicrophoneSource *mic_source2)

void	set_micro_wake_word (micro_wake_word::MicroWakeWord *mww)

void	set_speaker (speaker::Speaker *speaker)

void	set_media_player (media_player::MediaPlayer *media_player)

uint32_t	get_legacy_version () const

uint32_t	get_feature_flags () const

void	request_start (bool continuous, bool silence_detection)

void	request_stop ()

void	on_event (const api::VoiceAssistantEventResponse &msg)

void	on_audio (const api::VoiceAssistantAudio &msg)

void	on_timer_event (const api::VoiceAssistantTimerEventResponse &msg)

void	on_announce (const api::VoiceAssistantAnnounceRequest &msg)

void	on_set_configuration (const std::vector< std::string > &active_wake_words)

const Configuration &	get_configuration ()

bool	is_running () const

void	set_continuous (bool continuous)

bool	is_continuous () const

void	set_use_wake_word (bool use_wake_word)

void	set_noise_suppression_level (uint8_t noise_suppression_level)

void	set_auto_gain (uint8_t auto_gain)

void	set_volume_multiplier (float volume_multiplier)

void	set_conversation_timeout (uint32_t conversation_timeout)

void	reset_conversation_id ()

Trigger *	get_intent_end_trigger ()

Trigger *	get_intent_start_trigger ()

Trigger< std::string > *	get_intent_progress_trigger ()

Trigger *	get_listening_trigger ()

Trigger *	get_end_trigger ()

Trigger *	get_start_trigger ()

Trigger *	get_stt_vad_end_trigger ()

Trigger *	get_stt_vad_start_trigger ()

Trigger *	get_tts_stream_start_trigger ()

Trigger *	get_tts_stream_end_trigger ()

Trigger *	get_wake_word_detected_trigger ()

Trigger< std::string > *	get_stt_end_trigger ()

Trigger< std::string > *	get_tts_end_trigger ()

Trigger< std::string > *	get_tts_start_trigger ()

Trigger< std::string, std::string > *	get_error_trigger ()

Trigger *	get_idle_trigger ()

Trigger *	get_client_connected_trigger ()

Trigger *	get_client_disconnected_trigger ()

void	client_subscription (api::APIConnection *client, bool subscribe)

api::APIConnection *	get_api_connection () const

void	set_wake_word (const std::string &wake_word)

Trigger< Timer > *	get_timer_started_trigger ()

Trigger< Timer > *	get_timer_updated_trigger ()

Trigger< Timer > *	get_timer_cancelled_trigger ()

Trigger< Timer > *	get_timer_finished_trigger ()

Trigger< const std::vector< Timer > & > *	get_timer_tick_trigger ()

void	set_has_timers (bool has_timers)

const std::vector< Timer > &	get_timers () const

Public Member Functions inherited from esphome::Component
virtual void	dump_config ()

float	get_actual_setup_priority () const

void	set_setup_priority (float priority)

void	call ()

virtual void	on_shutdown ()

virtual void	on_safe_shutdown ()

virtual bool	teardown ()
	Called during teardown to allow component to gracefully finish operations.

virtual void	on_powerdown ()
	Called after teardown is complete to power down hardware.

uint8_t	get_component_state () const

void	reset_to_construction_state ()
	Reset this component back to the construction state to allow setup to run again.

bool	is_in_loop_state () const
	Check if this component has completed setup and is in the loop state.

bool	is_idle () const
	Check if this component is idle.

void	mark_failed ()
	Mark this component as failed.

void	mark_failed (const LogString *message)

void	disable_loop ()
	Disable this component's loop.

void	enable_loop ()
	Enable this component's loop.

void	enable_loop_soon_any_context ()
	Thread and ISR-safe version of enable_loop() that can be called from any context.

bool	is_failed () const

bool	is_ready () const

virtual bool	can_proceed ()

bool	status_has_warning () const

bool	status_has_error () const

void	status_set_warning ()

void	status_set_warning (const char *message)

void	status_set_warning (const LogString *message)

void	status_set_error ()

void	status_set_error (const LogString *message)

void	status_clear_warning ()

void	status_clear_error ()

void	status_momentary_warning (const char *name, uint32_t length=5000)
	Set warning status flag and automatically clear it after a timeout.

void	status_momentary_error (const char *name, uint32_t length=5000)
	Set error status flag and automatically clear it after a timeout.

bool	has_overridden_loop () const

const LogString *	get_component_log_str () const ESPHOME_ALWAYS_INLINE
	Get the integration where this component was declared as a LogString for logging.

bool	should_warn_of_blocking (uint32_t blocking_time, uint32_t &threshold_ms_out)

Protected Member Functions
bool	allocate_buffers_ ()

void	clear_buffers_ ()

void	deallocate_buffers_ ()

void	set_state_ (State state)

void	set_state_ (State state, State desired_state)

void	signal_stop_ ()

void	start_playback_timeout_ ()

void	stream_api_audio_ ()

void	handle_channel_stall_ (size_t available, size_t available2)

void	timer_tick_ ()

void	write_speaker_ ()

bool	start_udp_socket_ ()

Protected Member Functions inherited from esphome::Component
friend	void::setup ()

friend	void::original_setup ()

void	set_component_source_ (uint8_t index)
	Set where this component was loaded from for some debug messages.

virtual void	call_setup ()

void	call_dump_config_ ()

void	enable_loop_slow_path_ ()

void	set_component_state_ (uint8_t state)
	Helper to set component state (clears state bits and sets new state)

bool	set_status_flag_ (uint8_t flag)
	Helper to set a status LED flag on both this component and the app.

void	set_interval (const char *name, uint32_t interval, std::function< void()> &&f)
	Set an interval function with a const char* name.

void	set_interval (uint32_t id, uint32_t interval, std::function< void()> &&f)
	Set an interval function with a numeric ID (zero heap allocation).

void	set_interval (InternalSchedulerID id, uint32_t interval, std::function< void()> &&f)

void	set_interval (uint32_t interval, std::function< void()> &&f)

bool	cancel_interval (const char *name)
	Cancel an interval function.

bool	cancel_interval (uint32_t id)

bool	cancel_interval (InternalSchedulerID id)

void	set_timeout (const char *name, uint32_t timeout, std::function< void()> &&f)
	Set a timeout function with a const char* name.

void	set_timeout (uint32_t id, uint32_t timeout, std::function< void()> &&f)
	Set a timeout function with a numeric ID (zero heap allocation).

void	set_timeout (InternalSchedulerID id, uint32_t timeout, std::function< void()> &&f)

void	set_timeout (uint32_t timeout, std::function< void()> &&f)

bool	cancel_timeout (const char *name)
	Cancel a timeout function.

bool	cancel_timeout (uint32_t id)

bool	cancel_timeout (InternalSchedulerID id)

void	defer (const char *name, std::function< void()> &&f)
	Defer a callback to the next loop() call with a const char* name.

void	defer (std::function< void()> &&f)
	Defer a callback to the next loop() call.

void	defer (uint32_t id, std::function< void()> &&f)
	Defer a callback with a numeric ID (zero heap allocation)

bool	cancel_defer (const char *name)
	Cancel a defer callback using the specified name, name must not be empty.

bool	cancel_defer (uint32_t id)

void	status_clear_warning_slow_path_ ()

void	status_clear_error_slow_path_ ()

Protected Attributes
std::unique_ptr< socket::Socket >	socket_ = nullptr

struct sockaddr_storage	dest_addr_

Trigger	intent_end_trigger_

Trigger	intent_start_trigger_

Trigger	listening_trigger_

Trigger	end_trigger_

Trigger	start_trigger_

Trigger	stt_vad_start_trigger_

Trigger	stt_vad_end_trigger_

Trigger	tts_stream_start_trigger_

Trigger	tts_stream_end_trigger_

Trigger< std::string >	intent_progress_trigger_

Trigger	wake_word_detected_trigger_

Trigger< std::string >	stt_end_trigger_

Trigger< std::string >	tts_end_trigger_

Trigger< std::string >	tts_start_trigger_

Trigger< std::string, std::string >	error_trigger_

Trigger	idle_trigger_

Trigger	client_connected_trigger_

Trigger	client_disconnected_trigger_

api::APIConnection *	api_client_ {nullptr}

std::vector< Timer >	timers_

Trigger< Timer >	timer_started_trigger_

Trigger< Timer >	timer_finished_trigger_

Trigger< Timer >	timer_updated_trigger_

Trigger< Timer >	timer_cancelled_trigger_

Trigger< const std::vector< Timer > & >	timer_tick_trigger_

bool	has_timers_ {false}

bool	timer_tick_running_ {false}

microphone::MicrophoneSource *	mic_source_ {nullptr}

microphone::MicrophoneSource *	mic_source2_ {nullptr}

speaker::Speaker *	speaker_ {nullptr}

uint8_t *	speaker_buffer_ {nullptr}

size_t	speaker_buffer_index_ {0}

size_t	speaker_buffer_size_ {0}

size_t	speaker_bytes_received_ {0}

bool	wait_for_stream_end_ {false}

bool	stream_ended_ {false}

media_player::MediaPlayer *	media_player_ {nullptr}

std::string	tts_response_url_

bool	started_streaming_tts_ {false}

MediaPlayerResponseState	media_player_response_state_ {MediaPlayerResponseState::IDLE}

bool	local_output_ {false}

std::string	conversation_id_

std::string	wake_word_

std::unique_ptr< audio::RingBufferAudioSource >	audio_source_

std::unique_ptr< audio::RingBufferAudioSource >	audio_source2_

std::weak_ptr< ring_buffer::RingBuffer >	ring_buffer_

std::weak_ptr< ring_buffer::RingBuffer >	ring_buffer2_

uint32_t	audio_channel_stall_start_ {0}

bool	use_wake_word_

uint8_t	noise_suppression_level_

uint8_t	auto_gain_

float	volume_multiplier_

uint32_t	conversation_timeout_

bool	continuous_ {false}

bool	silence_detection_

bool	continue_conversation_ {false}

State	state_ {State::IDLE}

State	desired_state_ {State::IDLE}

AudioMode	audio_mode_ {AUDIO_MODE_UDP}

bool	udp_socket_running_ {false}

Configuration	config_ {}

micro_wake_word::MicroWakeWord *	micro_wake_word_ {nullptr}

Protected Attributes inherited from esphome::Component
uint8_t	component_source_index_ {0}
	Index into component source PROGMEM lookup table (0 = not set)

uint8_t	warn_if_blocking_over_ {WARN_IF_BLOCKING_OVER_CS}
	Warn threshold in centiseconds (max 2550ms)

uint8_t	component_state_ {0x00}
	State of this component - each bit has a purpose: Bits 0-2: Component state (0x00=CONSTRUCTION, 0x01=SETUP, 0x02=LOOP, 0x03=FAILED, 0x04=LOOP_DONE) Bit 3: STATUS_LED_WARNING Bit 4: STATUS_LED_ERROR Bit 5: Has overridden loop() (set at registration time) Bits 6-7: Unused - reserved for future expansion.

volatile bool	pending_enable_loop_ {false}
	ISR-safe flag for enable_loop_soon_any_context.

ComponentRuntimeStats	runtime_stats_

Detailed Description

Definition at line 107 of file voice_assistant.h.

Constructor & Destructor Documentation

◆ VoiceAssistant()

esphome::voice_assistant::VoiceAssistant::VoiceAssistant ( )

Definition at line 35 of file voice_assistant.cpp.

Member Function Documentation

◆ allocate_buffers_()

bool esphome::voice_assistant::VoiceAssistant::allocate_buffers_ ( )

protected

Definition at line 122 of file voice_assistant.cpp.

◆ clear_buffers_()

void esphome::voice_assistant::VoiceAssistant::clear_buffers_ ( )

protected

Definition at line 167 of file voice_assistant.cpp.

◆ client_subscription()

void esphome::voice_assistant::VoiceAssistant::client_subscription	(	api::APIConnection *	client,
		bool	subscribe )

Definition at line 544 of file voice_assistant.cpp.

◆ deallocate_buffers_()

void esphome::voice_assistant::VoiceAssistant::deallocate_buffers_ ( )

protected

Definition at line 191 of file voice_assistant.cpp.

◆ failed_to_start()

void esphome::voice_assistant::VoiceAssistant::failed_to_start ( )

Definition at line 617 of file voice_assistant.cpp.

◆ get_api_connection()

api::APIConnection * esphome::voice_assistant::VoiceAssistant::get_api_connection ( ) const

inline

Definition at line 219 of file voice_assistant.h.

◆ get_client_connected_trigger()

Trigger * esphome::voice_assistant::VoiceAssistant::get_client_connected_trigger ( )

inline

Definition at line 215 of file voice_assistant.h.

◆ get_client_disconnected_trigger()

Trigger * esphome::voice_assistant::VoiceAssistant::get_client_disconnected_trigger ( )

inline

Definition at line 216 of file voice_assistant.h.

◆ get_configuration()

const Configuration & esphome::voice_assistant::VoiceAssistant::get_configuration ( )

Definition at line 1106 of file voice_assistant.cpp.

◆ get_end_trigger()

Trigger * esphome::voice_assistant::VoiceAssistant::get_end_trigger ( )

inline

Definition at line 200 of file voice_assistant.h.

◆ get_error_trigger()

Trigger< std::string, std::string > * esphome::voice_assistant::VoiceAssistant::get_error_trigger ( )

inline

Definition at line 212 of file voice_assistant.h.

◆ get_feature_flags()

uint32_t esphome::voice_assistant::VoiceAssistant::get_feature_flags ( ) const

inline

Definition at line 145 of file voice_assistant.h.

◆ get_idle_trigger()

Trigger * esphome::voice_assistant::VoiceAssistant::get_idle_trigger ( )

inline

Definition at line 213 of file voice_assistant.h.

◆ get_intent_end_trigger()

Trigger * esphome::voice_assistant::VoiceAssistant::get_intent_end_trigger ( )

inline

Definition at line 196 of file voice_assistant.h.

◆ get_intent_progress_trigger()

Trigger< std::string > * esphome::voice_assistant::VoiceAssistant::get_intent_progress_trigger ( )

inline

Definition at line 198 of file voice_assistant.h.

◆ get_intent_start_trigger()

Trigger * esphome::voice_assistant::VoiceAssistant::get_intent_start_trigger ( )

inline

Definition at line 197 of file voice_assistant.h.

◆ get_legacy_version()

uint32_t esphome::voice_assistant::VoiceAssistant::get_legacy_version ( ) const

inline

Definition at line 136 of file voice_assistant.h.

◆ get_listening_trigger()

Trigger * esphome::voice_assistant::VoiceAssistant::get_listening_trigger ( )

inline

Definition at line 199 of file voice_assistant.h.

◆ get_setup_priority()

float esphome::voice_assistant::VoiceAssistant::get_setup_priority ( ) const

overridevirtual

Reimplemented from esphome::Component.

Definition at line 77 of file voice_assistant.cpp.

◆ get_start_trigger()

Trigger * esphome::voice_assistant::VoiceAssistant::get_start_trigger ( )

inline

Definition at line 201 of file voice_assistant.h.

◆ get_stt_end_trigger()

Trigger< std::string > * esphome::voice_assistant::VoiceAssistant::get_stt_end_trigger ( )

inline

Definition at line 209 of file voice_assistant.h.

◆ get_stt_vad_end_trigger()

Trigger * esphome::voice_assistant::VoiceAssistant::get_stt_vad_end_trigger ( )

inline

Definition at line 202 of file voice_assistant.h.

◆ get_stt_vad_start_trigger()

Trigger * esphome::voice_assistant::VoiceAssistant::get_stt_vad_start_trigger ( )

inline

Definition at line 203 of file voice_assistant.h.

◆ get_timer_cancelled_trigger()

Trigger< Timer > * esphome::voice_assistant::VoiceAssistant::get_timer_cancelled_trigger ( )

inline

Definition at line 225 of file voice_assistant.h.

◆ get_timer_finished_trigger()

Trigger< Timer > * esphome::voice_assistant::VoiceAssistant::get_timer_finished_trigger ( )

inline

Definition at line 226 of file voice_assistant.h.

◆ get_timer_started_trigger()

Trigger< Timer > * esphome::voice_assistant::VoiceAssistant::get_timer_started_trigger ( )

inline

Definition at line 223 of file voice_assistant.h.

◆ get_timer_tick_trigger()

Trigger< const std::vector< Timer > & > * esphome::voice_assistant::VoiceAssistant::get_timer_tick_trigger ( )

inline

Definition at line 227 of file voice_assistant.h.

◆ get_timer_updated_trigger()

Trigger< Timer > * esphome::voice_assistant::VoiceAssistant::get_timer_updated_trigger ( )

inline

Definition at line 224 of file voice_assistant.h.

◆ get_timers()

const std::vector< Timer > & esphome::voice_assistant::VoiceAssistant::get_timers ( ) const

inline

Definition at line 229 of file voice_assistant.h.

◆ get_tts_end_trigger()

Trigger< std::string > * esphome::voice_assistant::VoiceAssistant::get_tts_end_trigger ( )

inline

Definition at line 210 of file voice_assistant.h.

◆ get_tts_start_trigger()

Trigger< std::string > * esphome::voice_assistant::VoiceAssistant::get_tts_start_trigger ( )

inline

Definition at line 211 of file voice_assistant.h.

◆ get_tts_stream_end_trigger()

Trigger * esphome::voice_assistant::VoiceAssistant::get_tts_stream_end_trigger ( )

inline

Definition at line 206 of file voice_assistant.h.

◆ get_tts_stream_start_trigger()

Trigger * esphome::voice_assistant::VoiceAssistant::get_tts_stream_start_trigger ( )

inline

Definition at line 205 of file voice_assistant.h.

◆ get_wake_word_detected_trigger()

Trigger * esphome::voice_assistant::VoiceAssistant::get_wake_word_detected_trigger ( )

inline

Definition at line 208 of file voice_assistant.h.

◆ handle_channel_stall_()

void esphome::voice_assistant::VoiceAssistant::handle_channel_stall_	(	size_t	available,
		size_t	available2 )

protected

Definition at line 260 of file voice_assistant.cpp.

◆ is_continuous()

bool esphome::voice_assistant::VoiceAssistant::is_continuous ( ) const

inline

Definition at line 184 of file voice_assistant.h.

◆ is_running()

bool esphome::voice_assistant::VoiceAssistant::is_running ( ) const

inline

Definition at line 182 of file voice_assistant.h.

◆ loop()

void esphome::voice_assistant::VoiceAssistant::loop ( )

overridevirtual

Reimplemented from esphome::Component.

Definition at line 285 of file voice_assistant.cpp.

◆ on_announce()

void esphome::voice_assistant::VoiceAssistant::on_announce ( const api::VoiceAssistantAnnounceRequest & msg )

Definition at line 1053 of file voice_assistant.cpp.

◆ on_audio()

void esphome::voice_assistant::VoiceAssistant::on_audio ( const api::VoiceAssistantAudio & msg )

Definition at line 978 of file voice_assistant.cpp.

◆ on_event()

void esphome::voice_assistant::VoiceAssistant::on_event ( const api::VoiceAssistantEventResponse & msg )

Definition at line 760 of file voice_assistant.cpp.

◆ on_set_configuration()

void esphome::voice_assistant::VoiceAssistant::on_set_configuration ( const std::vector< std::string > & active_wake_words )

Definition at line 1085 of file voice_assistant.cpp.

◆ on_timer_event()

void esphome::voice_assistant::VoiceAssistant::on_timer_event ( const api::VoiceAssistantTimerEventResponse & msg )

Definition at line 994 of file voice_assistant.cpp.

◆ request_start()

void esphome::voice_assistant::VoiceAssistant::request_start	(	bool	continuous,
		bool	silence_detection )

Definition at line 675 of file voice_assistant.cpp.

◆ request_stop()

void esphome::voice_assistant::VoiceAssistant::request_stop ( )

Definition at line 690 of file voice_assistant.cpp.

◆ reset_conversation_id()

void esphome::voice_assistant::VoiceAssistant::reset_conversation_id ( )

Definition at line 207 of file voice_assistant.cpp.

◆ set_auto_gain()

void esphome::voice_assistant::VoiceAssistant::set_auto_gain ( uint8_t auto_gain )

inline

Definition at line 191 of file voice_assistant.h.

◆ set_continuous()

void esphome::voice_assistant::VoiceAssistant::set_continuous ( bool continuous )

inline

Definition at line 183 of file voice_assistant.h.

◆ set_conversation_timeout()

void esphome::voice_assistant::VoiceAssistant::set_conversation_timeout ( uint32_t conversation_timeout )

inline

Definition at line 193 of file voice_assistant.h.

◆ set_has_timers()

void esphome::voice_assistant::VoiceAssistant::set_has_timers ( bool has_timers )

inline

Definition at line 228 of file voice_assistant.h.

◆ set_media_player()

void esphome::voice_assistant::VoiceAssistant::set_media_player ( media_player::MediaPlayer * media_player )

inline

Definition at line 130 of file voice_assistant.h.

◆ set_micro_wake_word()

void esphome::voice_assistant::VoiceAssistant::set_micro_wake_word ( micro_wake_word::MicroWakeWord * mww )

inline

Definition at line 121 of file voice_assistant.h.

◆ set_microphone_source()

void esphome::voice_assistant::VoiceAssistant::set_microphone_source ( microphone::MicrophoneSource * mic_source )

inline

Definition at line 118 of file voice_assistant.h.

◆ set_microphone_source2()

void esphome::voice_assistant::VoiceAssistant::set_microphone_source2 ( microphone::MicrophoneSource * mic_source2 )

inline

Definition at line 119 of file voice_assistant.h.

◆ set_noise_suppression_level()

void esphome::voice_assistant::VoiceAssistant::set_noise_suppression_level ( uint8_t noise_suppression_level )

inline

Definition at line 188 of file voice_assistant.h.

◆ set_speaker()

void esphome::voice_assistant::VoiceAssistant::set_speaker ( speaker::Speaker * speaker )

inline

Definition at line 124 of file voice_assistant.h.

◆ set_state_() [1/2]

void esphome::voice_assistant::VoiceAssistant::set_state_ ( State state )

protected

Definition at line 604 of file voice_assistant.cpp.

◆ set_state_() [2/2]

void esphome::voice_assistant::VoiceAssistant::set_state_	(	State	state,
		State	desired_state )

protected

Definition at line 611 of file voice_assistant.cpp.

◆ set_use_wake_word()

void esphome::voice_assistant::VoiceAssistant::set_use_wake_word ( bool use_wake_word )

inline

Definition at line 186 of file voice_assistant.h.

◆ set_volume_multiplier()

void esphome::voice_assistant::VoiceAssistant::set_volume_multiplier ( float volume_multiplier )

inline

Definition at line 192 of file voice_assistant.h.

◆ set_wake_word()

void esphome::voice_assistant::VoiceAssistant::set_wake_word ( const std::string & wake_word )

inline

Definition at line 221 of file voice_assistant.h.

◆ setup()

void esphome::voice_assistant::VoiceAssistant::setup ( )

overridevirtual

Reimplemented from esphome::Component.

Definition at line 37 of file voice_assistant.cpp.

◆ signal_stop_()

void esphome::voice_assistant::VoiceAssistant::signal_stop_ ( )

protected

Definition at line 736 of file voice_assistant.cpp.

◆ start_playback_timeout_()

void esphome::voice_assistant::VoiceAssistant::start_playback_timeout_ ( )

protected

Definition at line 747 of file voice_assistant.cpp.

◆ start_streaming() [1/2]

void esphome::voice_assistant::VoiceAssistant::start_streaming ( )

Definition at line 623 of file voice_assistant.cpp.

◆ start_streaming() [2/2]

void esphome::voice_assistant::VoiceAssistant::start_streaming	(	struct sockaddr_storage *	addr,
		uint16_t	port )

Definition at line 640 of file voice_assistant.cpp.

◆ start_udp_socket_()

bool esphome::voice_assistant::VoiceAssistant::start_udp_socket_ ( )

protected

Definition at line 79 of file voice_assistant.cpp.

◆ stream_api_audio_()

void esphome::voice_assistant::VoiceAssistant::stream_api_audio_ ( )

protected

Definition at line 212 of file voice_assistant.cpp.

◆ timer_tick_()

void esphome::voice_assistant::VoiceAssistant::timer_tick_ ( )

protected

Definition at line 1044 of file voice_assistant.cpp.

◆ write_speaker_()

void esphome::voice_assistant::VoiceAssistant::write_speaker_ ( )

protected

Definition at line 526 of file voice_assistant.cpp.

Field Documentation

◆ api_client_

api::APIConnection* esphome::voice_assistant::VoiceAssistant::api_client_ {nullptr}

protected

Definition at line 272 of file voice_assistant.h.

◆ audio_channel_stall_start_

uint32_t esphome::voice_assistant::VoiceAssistant::audio_channel_stall_start_ {0}

protected

Definition at line 323 of file voice_assistant.h.

◆ audio_mode_

AudioMode esphome::voice_assistant::VoiceAssistant::audio_mode_ {AUDIO_MODE_UDP}

protected

Definition at line 339 of file voice_assistant.h.

◆ audio_source2_

std::unique_ptr<audio::RingBufferAudioSource> esphome::voice_assistant::VoiceAssistant::audio_source2_

protected

Definition at line 314 of file voice_assistant.h.

◆ audio_source_

std::unique_ptr<audio::RingBufferAudioSource> esphome::voice_assistant::VoiceAssistant::audio_source_

protected

Definition at line 313 of file voice_assistant.h.

◆ auto_gain_

uint8_t esphome::voice_assistant::VoiceAssistant::auto_gain_

protected

Definition at line 327 of file voice_assistant.h.

◆ client_connected_trigger_

Trigger esphome::voice_assistant::VoiceAssistant::client_connected_trigger_

protected

Definition at line 269 of file voice_assistant.h.

◆ client_disconnected_trigger_

Trigger esphome::voice_assistant::VoiceAssistant::client_disconnected_trigger_

protected

Definition at line 270 of file voice_assistant.h.

◆ config_

Configuration esphome::voice_assistant::VoiceAssistant::config_ {}

protected

Definition at line 343 of file voice_assistant.h.

◆ continue_conversation_

bool esphome::voice_assistant::VoiceAssistant::continue_conversation_ {false}

protected

Definition at line 334 of file voice_assistant.h.

◆ continuous_

bool esphome::voice_assistant::VoiceAssistant::continuous_ {false}

protected

Definition at line 331 of file voice_assistant.h.

◆ conversation_id_

std::string esphome::voice_assistant::VoiceAssistant::conversation_id_

protected

Definition at line 306 of file voice_assistant.h.

◆ conversation_timeout_

uint32_t esphome::voice_assistant::VoiceAssistant::conversation_timeout_

protected

Definition at line 329 of file voice_assistant.h.

◆ desired_state_

State esphome::voice_assistant::VoiceAssistant::desired_state_ {State::IDLE}

protected

Definition at line 337 of file voice_assistant.h.

◆ dest_addr_

struct sockaddr_storage esphome::voice_assistant::VoiceAssistant::dest_addr_

protected

Definition at line 248 of file voice_assistant.h.

◆ end_trigger_

Trigger esphome::voice_assistant::VoiceAssistant::end_trigger_

protected

Definition at line 253 of file voice_assistant.h.

◆ error_trigger_

Trigger<std::string, std::string> esphome::voice_assistant::VoiceAssistant::error_trigger_

protected

Definition at line 266 of file voice_assistant.h.

◆ has_timers_

bool esphome::voice_assistant::VoiceAssistant::has_timers_ {false}

protected

Definition at line 281 of file voice_assistant.h.

◆ idle_trigger_

Trigger esphome::voice_assistant::VoiceAssistant::idle_trigger_

protected

Definition at line 267 of file voice_assistant.h.

◆ intent_end_trigger_

Trigger esphome::voice_assistant::VoiceAssistant::intent_end_trigger_

protected

Definition at line 250 of file voice_assistant.h.

◆ intent_progress_trigger_

Trigger<std::string> esphome::voice_assistant::VoiceAssistant::intent_progress_trigger_

protected

Definition at line 261 of file voice_assistant.h.

◆ intent_start_trigger_

Trigger esphome::voice_assistant::VoiceAssistant::intent_start_trigger_

protected

Definition at line 251 of file voice_assistant.h.

◆ listening_trigger_

Trigger esphome::voice_assistant::VoiceAssistant::listening_trigger_

protected

Definition at line 252 of file voice_assistant.h.

◆ local_output_

bool esphome::voice_assistant::VoiceAssistant::local_output_ {false}

protected

Definition at line 304 of file voice_assistant.h.

◆ media_player_

media_player::MediaPlayer* esphome::voice_assistant::VoiceAssistant::media_player_ {nullptr}

protected

Definition at line 297 of file voice_assistant.h.

◆ media_player_response_state_

MediaPlayerResponseState esphome::voice_assistant::VoiceAssistant::media_player_response_state_ {MediaPlayerResponseState::IDLE}

protected

Definition at line 301 of file voice_assistant.h.

◆ mic_source2_

microphone::MicrophoneSource* esphome::voice_assistant::VoiceAssistant::mic_source2_ {nullptr}

protected

Definition at line 285 of file voice_assistant.h.

◆ mic_source_

microphone::MicrophoneSource* esphome::voice_assistant::VoiceAssistant::mic_source_ {nullptr}

protected

Definition at line 284 of file voice_assistant.h.

◆ micro_wake_word_

micro_wake_word::MicroWakeWord* esphome::voice_assistant::VoiceAssistant::micro_wake_word_ {nullptr}

protected

Definition at line 346 of file voice_assistant.h.

◆ noise_suppression_level_

uint8_t esphome::voice_assistant::VoiceAssistant::noise_suppression_level_

protected

Definition at line 326 of file voice_assistant.h.

◆ ring_buffer2_

std::weak_ptr<ring_buffer::RingBuffer> esphome::voice_assistant::VoiceAssistant::ring_buffer2_

protected

Definition at line 316 of file voice_assistant.h.

◆ ring_buffer_

std::weak_ptr<ring_buffer::RingBuffer> esphome::voice_assistant::VoiceAssistant::ring_buffer_

protected

Definition at line 315 of file voice_assistant.h.

◆ silence_detection_

bool esphome::voice_assistant::VoiceAssistant::silence_detection_

protected

Definition at line 332 of file voice_assistant.h.

◆ socket_

std::unique_ptr<socket::Socket> esphome::voice_assistant::VoiceAssistant::socket_ = nullptr

protected

Definition at line 247 of file voice_assistant.h.

◆ speaker_

speaker::Speaker* esphome::voice_assistant::VoiceAssistant::speaker_ {nullptr}

protected

Definition at line 288 of file voice_assistant.h.

◆ speaker_buffer_

uint8_t* esphome::voice_assistant::VoiceAssistant::speaker_buffer_ {nullptr}

protected

Definition at line 289 of file voice_assistant.h.

◆ speaker_buffer_index_

size_t esphome::voice_assistant::VoiceAssistant::speaker_buffer_index_ {0}

protected

Definition at line 290 of file voice_assistant.h.

◆ speaker_buffer_size_

size_t esphome::voice_assistant::VoiceAssistant::speaker_buffer_size_ {0}

protected

Definition at line 291 of file voice_assistant.h.

◆ speaker_bytes_received_

size_t esphome::voice_assistant::VoiceAssistant::speaker_bytes_received_ {0}

protected

Definition at line 292 of file voice_assistant.h.

◆ start_trigger_

Trigger esphome::voice_assistant::VoiceAssistant::start_trigger_

protected

Definition at line 254 of file voice_assistant.h.

◆ started_streaming_tts_

bool esphome::voice_assistant::VoiceAssistant::started_streaming_tts_ {false}

protected

Definition at line 299 of file voice_assistant.h.

◆ state_

State esphome::voice_assistant::VoiceAssistant::state_ {State::IDLE}

protected

Definition at line 336 of file voice_assistant.h.

◆ stream_ended_

bool esphome::voice_assistant::VoiceAssistant::stream_ended_ {false}

protected

Definition at line 294 of file voice_assistant.h.

◆ stt_end_trigger_

Trigger<std::string> esphome::voice_assistant::VoiceAssistant::stt_end_trigger_

protected

Definition at line 263 of file voice_assistant.h.

◆ stt_vad_end_trigger_

Trigger esphome::voice_assistant::VoiceAssistant::stt_vad_end_trigger_

protected

Definition at line 256 of file voice_assistant.h.

◆ stt_vad_start_trigger_

Trigger esphome::voice_assistant::VoiceAssistant::stt_vad_start_trigger_

protected

Definition at line 255 of file voice_assistant.h.

◆ timer_cancelled_trigger_

Trigger<Timer> esphome::voice_assistant::VoiceAssistant::timer_cancelled_trigger_

protected

Definition at line 279 of file voice_assistant.h.

◆ timer_finished_trigger_

Trigger<Timer> esphome::voice_assistant::VoiceAssistant::timer_finished_trigger_

protected

Definition at line 277 of file voice_assistant.h.

◆ timer_started_trigger_

Trigger<Timer> esphome::voice_assistant::VoiceAssistant::timer_started_trigger_

protected

Definition at line 276 of file voice_assistant.h.

◆ timer_tick_running_

bool esphome::voice_assistant::VoiceAssistant::timer_tick_running_ {false}

protected

Definition at line 282 of file voice_assistant.h.

◆ timer_tick_trigger_

Trigger<const std::vector<Timer> &> esphome::voice_assistant::VoiceAssistant::timer_tick_trigger_

protected

Definition at line 280 of file voice_assistant.h.

◆ timer_updated_trigger_

Trigger<Timer> esphome::voice_assistant::VoiceAssistant::timer_updated_trigger_

protected

Definition at line 278 of file voice_assistant.h.

◆ timers_

std::vector<Timer> esphome::voice_assistant::VoiceAssistant::timers_

protected

Definition at line 274 of file voice_assistant.h.

◆ tts_end_trigger_

Trigger<std::string> esphome::voice_assistant::VoiceAssistant::tts_end_trigger_

protected

Definition at line 264 of file voice_assistant.h.

◆ tts_response_url_

std::string esphome::voice_assistant::VoiceAssistant::tts_response_url_

protected

Definition at line 298 of file voice_assistant.h.

◆ tts_start_trigger_

Trigger<std::string> esphome::voice_assistant::VoiceAssistant::tts_start_trigger_

protected

Definition at line 265 of file voice_assistant.h.

◆ tts_stream_end_trigger_

Trigger esphome::voice_assistant::VoiceAssistant::tts_stream_end_trigger_

protected

Definition at line 259 of file voice_assistant.h.

◆ tts_stream_start_trigger_

Trigger esphome::voice_assistant::VoiceAssistant::tts_stream_start_trigger_

protected

Definition at line 258 of file voice_assistant.h.

◆ udp_socket_running_

bool esphome::voice_assistant::VoiceAssistant::udp_socket_running_ {false}

protected

Definition at line 340 of file voice_assistant.h.

◆ use_wake_word_

bool esphome::voice_assistant::VoiceAssistant::use_wake_word_

protected

Definition at line 325 of file voice_assistant.h.

◆ volume_multiplier_

float esphome::voice_assistant::VoiceAssistant::volume_multiplier_

protected

Definition at line 328 of file voice_assistant.h.

◆ wait_for_stream_end_

bool esphome::voice_assistant::VoiceAssistant::wait_for_stream_end_ {false}

protected

Definition at line 293 of file voice_assistant.h.

◆ wake_word_

std::string esphome::voice_assistant::VoiceAssistant::wake_word_

protected

Definition at line 308 of file voice_assistant.h.

◆ wake_word_detected_trigger_

Trigger esphome::voice_assistant::VoiceAssistant::wake_word_detected_trigger_

protected

Definition at line 262 of file voice_assistant.h.

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

esphome/components/voice_assistant/voice_assistant.h
esphome/components/voice_assistant/voice_assistant.cpp

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ VoiceAssistant()

Member Function Documentation

◆ allocate_buffers_()

◆ clear_buffers_()

◆ client_subscription()

◆ deallocate_buffers_()

◆ failed_to_start()

◆ get_api_connection()

◆ get_client_connected_trigger()

◆ get_client_disconnected_trigger()

◆ get_configuration()

◆ get_end_trigger()

◆ get_error_trigger()

◆ get_feature_flags()

◆ get_idle_trigger()

◆ get_intent_end_trigger()

◆ get_intent_progress_trigger()

◆ get_intent_start_trigger()

◆ get_legacy_version()

◆ get_listening_trigger()

◆ get_setup_priority()

◆ get_start_trigger()

◆ get_stt_end_trigger()

◆ get_stt_vad_end_trigger()

◆ get_stt_vad_start_trigger()

◆ get_timer_cancelled_trigger()

◆ get_timer_finished_trigger()

◆ get_timer_started_trigger()

◆ get_timer_tick_trigger()

◆ get_timer_updated_trigger()

◆ get_timers()

◆ get_tts_end_trigger()

◆ get_tts_start_trigger()

◆ get_tts_stream_end_trigger()

◆ get_tts_stream_start_trigger()

◆ get_wake_word_detected_trigger()

◆ handle_channel_stall_()

◆ is_continuous()

◆ is_running()

◆ loop()

◆ on_announce()

◆ on_audio()

◆ on_event()

◆ on_set_configuration()

◆ on_timer_event()

◆ request_start()

◆ request_stop()

◆ reset_conversation_id()

◆ set_auto_gain()

◆ set_continuous()

◆ set_conversation_timeout()

◆ set_has_timers()

◆ set_media_player()

◆ set_micro_wake_word()

◆ set_microphone_source()

◆ set_microphone_source2()

◆ set_noise_suppression_level()

◆ set_speaker()

◆ set_state_() [1/2]

◆ set_state_() [2/2]

◆ set_use_wake_word()

◆ set_volume_multiplier()

◆ set_wake_word()

◆ setup()

◆ signal_stop_()

◆ start_playback_timeout_()

◆ start_streaming() [1/2]

◆ start_streaming() [2/2]

◆ start_udp_socket_()

◆ stream_api_audio_()

◆ timer_tick_()

◆ write_speaker_()

Field Documentation

◆ api_client_

◆ audio_channel_stall_start_