#include <micro_wake_word.h>

Inheritance diagram for esphome::micro_wake_word::MicroWakeWord:

Public Member Functions
void	setup () override

void	loop () override

float	get_setup_priority () const override

void	dump_config () override

void	start ()

void	stop ()

bool	is_running () const

void	set_features_step_size (uint8_t step_size)

void	set_microphone_source (microphone::MicrophoneSource *microphone_source)

void	set_stop_after_detection (bool stop_after_detection)

Trigger< std::string > *	get_wake_word_detected_trigger () const

void	add_wake_word_model (WakeWordModel *model)

void	add_vad_model (const uint8_t *model_start, uint8_t probability_cutoff, size_t sliding_window_size, size_t tensor_arena_size)

bool	get_vad_state ()

std::vector< WakeWordModel * >	get_wake_words ()

Public Member Functions inherited from esphome::Component
float	get_actual_setup_priority () const

void	set_setup_priority (float priority)

virtual float	get_loop_priority () const
	priority of loop().

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.

virtual void	mark_failed ()
	Mark this component as failed.

void	mark_failed (const char *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 (const char *message=nullptr)

void	status_set_warning (const LogString *message)

void	status_set_error (const char *message=nullptr)

void	status_clear_warning ()

void	status_clear_error ()

void	status_momentary_warning (const std::string &name, uint32_t length=5000)

void	status_momentary_error (const std::string &name, uint32_t length=5000)

bool	has_overridden_loop () const

void	set_component_source (const LogString *source)
	Set where this component was loaded from for some debug messages.

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

bool	should_warn_of_blocking (uint32_t blocking_time)

Protected Member Functions
void	suspend_task_ ()
	Suspends the inference task.

void	resume_task_ ()
	Resumes the inference task.

void	set_state_ (State state)

size_t	generate_features_ (int16_t *audio_buffer, size_t samples_available, int8_t features_buffer[PREPROCESSOR_FEATURE_SIZE])
	Generates spectrogram features from an input buffer of audio samples.

void	process_probabilities_ ()
	Processes any new probabilities for each model.

void	unload_models_ ()
	Deletes each model's TFLite interpreters and frees tensor arena memory.

bool	update_model_probabilities_ (const int8_t audio_features[PREPROCESSOR_FEATURE_SIZE])
	Runs an inference with each model using the new spectrogram features.

Protected Member Functions inherited from esphome::Component
virtual void	call_loop ()

virtual void	call_setup ()

virtual void	call_dump_config ()

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

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

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 interval, std::function< void()> &&f)

bool	cancel_interval (const std::string &name)
	Cancel an interval function.

bool	cancel_interval (const char *name)

void	set_retry (const std::string &name, uint32_t initial_wait_time, uint8_t max_attempts, std::function< RetryResult(uint8_t)> &&f, float backoff_increase_factor=1.0f)
	Set an retry function with a unique name.

void	set_retry (uint32_t initial_wait_time, uint8_t max_attempts, std::function< RetryResult(uint8_t)> &&f, float backoff_increase_factor=1.0f)

bool	cancel_retry (const std::string &name)
	Cancel a retry function.

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

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 timeout, std::function< void()> &&f)

bool	cancel_timeout (const std::string &name)
	Cancel a timeout function.

bool	cancel_timeout (const char *name)

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

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.

bool	cancel_defer (const std::string &name)
	Cancel a defer callback using the specified name, name must not be empty.

Static Protected Member Functions
static void	inference_task (void *params)

Protected Attributes
microphone::MicrophoneSource *	microphone_source_ {nullptr}

Trigger< std::string > *	wake_word_detected_trigger_ = new Trigger<std::string>()

State	state_ {State::STOPPED}

std::weak_ptr< RingBuffer >	ring_buffer_

std::vector< WakeWordModel * >	wake_word_models_

std::unique_ptr< VADModel >	vad_model_

bool	vad_state_ {false}

bool	pending_start_ {false}

bool	pending_stop_ {false}

bool	stop_after_detection_

uint8_t	features_step_size_

struct FrontendConfig	frontend_config_

struct FrontendState	frontend_state_

EventGroupHandle_t	event_group_

QueueHandle_t	detection_queue_

TaskHandle_t	inference_task_handle_ {nullptr}

Protected Attributes inherited from esphome::Component
const LogString *	component_source_ {nullptr}

uint16_t	warn_if_blocking_over_ {WARN_IF_BLOCKING_OVER_MS}
	Warn if blocked for this many ms (max 65.5s)

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 Bits 5-7: Unused - reserved for future expansion.

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

Detailed Description

Definition at line 29 of file micro_wake_word.h.

Member Function Documentation

◆ add_vad_model()

void esphome::micro_wake_word::MicroWakeWord::add_vad_model	(	const uint8_t *	model_start,
		uint8_t	probability_cutoff,
		size_t	sliding_window_size,
		size_t	tensor_arena_size )

Definition at line 221 of file micro_wake_word.cpp.

◆ add_wake_word_model()

void esphome::micro_wake_word::MicroWakeWord::add_wake_word_model ( WakeWordModel * model )

Definition at line 218 of file micro_wake_word.cpp.

◆ dump_config()

void esphome::micro_wake_word::MicroWakeWord::dump_config ( )

overridevirtual

Reimplemented from esphome::Component.

Definition at line 64 of file micro_wake_word.cpp.

◆ generate_features_()

size_t esphome::micro_wake_word::MicroWakeWord::generate_features_	(	int16_t *	audio_buffer,
		size_t	samples_available,
		int8_t	features_buffer[PREPROCESSOR_FEATURE_SIZE] )

protected

Generates spectrogram features from an input buffer of audio samples.

Parameters

audio_buffer	(int16_t *) Buffer containing input audio samples
samples_available	(size_t) Number of samples avaiable in the input buffer
features_buffer	(int8_t *) Buffer to store generated features

Returns: (size_t) Number of samples processed from the input buffer

Definition at line 382 of file micro_wake_word.cpp.

◆ get_setup_priority()

float esphome::micro_wake_word::MicroWakeWord::get_setup_priority ( ) const

overridevirtual

Reimplemented from esphome::Component.

Definition at line 47 of file micro_wake_word.cpp.

◆ get_vad_state()

bool esphome::micro_wake_word::MicroWakeWord::get_vad_state ( )

inline

Definition at line 58 of file micro_wake_word.h.

◆ get_wake_word_detected_trigger()

Trigger< std::string > * esphome::micro_wake_word::MicroWakeWord::get_wake_word_detected_trigger ( ) const

inline

Definition at line 49 of file micro_wake_word.h.

◆ get_wake_words()

std::vector< WakeWordModel * > esphome::micro_wake_word::MicroWakeWord::get_wake_words ( )

Definition at line 208 of file micro_wake_word.cpp.

◆ inference_task()

void esphome::micro_wake_word::MicroWakeWord::inference_task ( void * params )

staticprotected

Definition at line 134 of file micro_wake_word.cpp.

◆ is_running()

bool esphome::micro_wake_word::MicroWakeWord::is_running ( ) const

inline

Definition at line 39 of file micro_wake_word.h.

◆ loop()

void esphome::micro_wake_word::MicroWakeWord::loop ( )

overridevirtual

Reimplemented from esphome::Component.

Definition at line 239 of file micro_wake_word.cpp.

◆ process_probabilities_()

void esphome::micro_wake_word::MicroWakeWord::process_probabilities_ ( )

protected

Processes any new probabilities for each model.

If any wake word is detected, it will send a DetectionEvent to the detection_queue_.

Definition at line 414 of file micro_wake_word.cpp.

◆ resume_task_()

void esphome::micro_wake_word::MicroWakeWord::resume_task_ ( )

protected

Resumes the inference task.

Definition at line 233 of file micro_wake_word.cpp.

◆ set_features_step_size()

void esphome::micro_wake_word::MicroWakeWord::set_features_step_size ( uint8_t step_size )

inline

Definition at line 41 of file micro_wake_word.h.

◆ set_microphone_source()

void esphome::micro_wake_word::MicroWakeWord::set_microphone_source ( microphone::MicrophoneSource * microphone_source )

inline

Definition at line 43 of file micro_wake_word.h.

◆ set_state_()

void esphome::micro_wake_word::MicroWakeWord::set_state_ ( State state )

protected

Definition at line 374 of file micro_wake_word.cpp.

◆ set_stop_after_detection()

void esphome::micro_wake_word::MicroWakeWord::set_stop_after_detection ( bool stop_after_detection )

inline

Definition at line 47 of file micro_wake_word.h.

◆ setup()

void esphome::micro_wake_word::MicroWakeWord::setup ( )

overridevirtual

Reimplemented from esphome::Component.

Definition at line 75 of file micro_wake_word.cpp.

◆ start()

void esphome::micro_wake_word::MicroWakeWord::start ( )

Definition at line 342 of file micro_wake_word.cpp.

◆ stop()

void esphome::micro_wake_word::MicroWakeWord::stop ( )

Definition at line 364 of file micro_wake_word.cpp.

◆ suspend_task_()

void esphome::micro_wake_word::MicroWakeWord::suspend_task_ ( )

protected

Suspends the inference task.

Definition at line 227 of file micro_wake_word.cpp.

◆ unload_models_()

void esphome::micro_wake_word::MicroWakeWord::unload_models_ ( )

protected

Deletes each model's TFLite interpreters and frees tensor arena memory.

Definition at line 448 of file micro_wake_word.cpp.

◆ update_model_probabilities_()

bool esphome::micro_wake_word::MicroWakeWord::update_model_probabilities_ ( const int8_t audio_features[PREPROCESSOR_FEATURE_SIZE] )

protected

Runs an inference with each model using the new spectrogram features.

Parameters

audio_features (int8_t *) Buffer containing new spectrogram features

Returns: True if successful, false if any errors were encountered

Definition at line 457 of file micro_wake_word.cpp.

Field Documentation

◆ detection_queue_

QueueHandle_t esphome::micro_wake_word::MicroWakeWord::detection_queue_

protected

Definition at line 93 of file micro_wake_word.h.

◆ event_group_

EventGroupHandle_t esphome::micro_wake_word::MicroWakeWord::event_group_

protected

Definition at line 90 of file micro_wake_word.h.

◆ features_step_size_

uint8_t esphome::micro_wake_word::MicroWakeWord::features_step_size_

protected

Definition at line 83 of file micro_wake_word.h.

◆ frontend_config_

struct FrontendConfig esphome::micro_wake_word::MicroWakeWord::frontend_config_

protected

Definition at line 86 of file micro_wake_word.h.

◆ frontend_state_

struct FrontendState esphome::micro_wake_word::MicroWakeWord::frontend_state_

protected

Definition at line 87 of file micro_wake_word.h.

◆ inference_task_handle_

TaskHandle_t esphome::micro_wake_word::MicroWakeWord::inference_task_handle_ {nullptr}

protected

Definition at line 96 of file micro_wake_word.h.

◆ microphone_source_

microphone::MicrophoneSource* esphome::micro_wake_word::MicroWakeWord::microphone_source_ {nullptr}

protected

Definition at line 66 of file micro_wake_word.h.

◆ pending_start_

bool esphome::micro_wake_word::MicroWakeWord::pending_start_ {false}

protected

Definition at line 78 of file micro_wake_word.h.

◆ pending_stop_

bool esphome::micro_wake_word::MicroWakeWord::pending_stop_ {false}

protected

Definition at line 79 of file micro_wake_word.h.

◆ ring_buffer_

std::weak_ptr<RingBuffer> esphome::micro_wake_word::MicroWakeWord::ring_buffer_

protected

Definition at line 70 of file micro_wake_word.h.

◆ state_

State esphome::micro_wake_word::MicroWakeWord::state_ {State::STOPPED}

protected

Definition at line 68 of file micro_wake_word.h.

◆ stop_after_detection_

bool esphome::micro_wake_word::MicroWakeWord::stop_after_detection_

protected

Definition at line 81 of file micro_wake_word.h.

◆ vad_model_

std::unique_ptr<VADModel> esphome::micro_wake_word::MicroWakeWord::vad_model_

protected

Definition at line 74 of file micro_wake_word.h.

◆ vad_state_

bool esphome::micro_wake_word::MicroWakeWord::vad_state_ {false}

protected

Definition at line 75 of file micro_wake_word.h.

◆ wake_word_detected_trigger_

Trigger<std::string>* esphome::micro_wake_word::MicroWakeWord::wake_word_detected_trigger_ = new Trigger<std::string>()

protected

Definition at line 67 of file micro_wake_word.h.

◆ wake_word_models_

std::vector<WakeWordModel *> esphome::micro_wake_word::MicroWakeWord::wake_word_models_

protected

Definition at line 71 of file micro_wake_word.h.

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

esphome/components/micro_wake_word/micro_wake_word.h
esphome/components/micro_wake_word/micro_wake_word.cpp

Public Member Functions

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Detailed Description

Member Function Documentation

◆ add_vad_model()

◆ add_wake_word_model()

◆ dump_config()

◆ generate_features_()

◆ get_setup_priority()

◆ get_vad_state()

◆ get_wake_word_detected_trigger()

◆ get_wake_words()

◆ inference_task()

◆ is_running()

◆ loop()

◆ process_probabilities_()

◆ resume_task_()

◆ set_features_step_size()

◆ set_microphone_source()

◆ set_state_()

◆ set_stop_after_detection()

◆ setup()

◆ start()

◆ stop()

◆ suspend_task_()

◆ unload_models_()

◆ update_model_probabilities_()

Field Documentation

◆ detection_queue_

◆ event_group_

◆ features_step_size_

◆ frontend_config_

◆ frontend_state_

◆ inference_task_handle_

◆ microphone_source_

◆ pending_start_

◆ pending_stop_

◆ ring_buffer_

◆ state_

◆ stop_after_detection_

◆ vad_model_

◆ vad_state_

◆ wake_word_detected_trigger_

◆ wake_word_models_