#include <usb_audio_microphone.h>

Inheritance diagram for esphome::usb_audio::USBAudioMicrophone:

Public Member Functions
	USBAudioMicrophone (const audio::AudioStreamInfo &stream_info, uint32_t buffer_size)

void	setup () override

void	dump_config () override

void	loop () override

void	start () override

void	stop () override

audio::AudioStreamInfo	get_usb_stream_info () override

void	on_stream_state (StreamEvent event) override

bool	stream_idle () const override

Public Member Functions inherited from esphome::microphone::Microphone
template<typename F >
void	add_data_callback (F &&data_callback)

bool	is_running () const

bool	is_stopped () const

void	set_mute_state (bool is_muted)

bool	get_mute_state ()

audio::AudioStreamInfo	get_audio_stream_info ()

Public Member Functions inherited from esphome::Component
virtual float	get_setup_priority () const
	priority of setup().

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)

bool	status_comm_result (bool ok)
	Clears the warning when `ok`, else sets it with `message` (default "Communication failed"); returns `ok`.

bool	status_comm_result (bool ok, const LogString *message)

void	status_set_error ()

void	status_set_error (const LogString *message)

void	status_clear_warning ()

void	status_clear_error ()

	ESPDEPRECATED ("Use status_momentary_warning() without a name. Removed in 2027.5.0", "2026.11.0") void status_momentary_warning(const char *name

void	status_momentary_warning (uint32_t length=5000)
	Set warning status flag and clear it after `length` ms.

void	status_momentary_warning (const LogString *message, uint32_t length=5000)

	ESPDEPRECATED ("Use status_momentary_error() without a name. Removed in 2027.5.0", "2026.11.0") void status_momentary_error(const char *name

void	status_momentary_error (uint32_t length=5000)
	Set error status flag and clear it after `length` ms.

void	status_momentary_error (const LogString *message, uint32_t length=5000)

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)

Public Member Functions inherited from esphome::Parented< USBAudioComponent >
	Parented ()

	Parented (USBAudioComponent *parent)

USBAudioComponent *	get_parent () const
	Get the parent of this object.

void	set_parent (USBAudioComponent *parent)
	Set the parent of this object.

Public Member Functions inherited from esphome::usb_audio::USBAudioStream
	USBAudioStream (uint32_t buffer_size)

uint32_t	get_buffer_size () const

virtual void	on_transfer_taken ()
	Speaker only: the driver tried to take its next transfer from the ring buffer, which it does each time a transfer completes and on each write, and takes it only when the ring buffer holds all of it.

Protected Member Functions
void	mic_task_loop_ ()

void	request_ (uint8_t set, uint8_t clear)

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.

bool	set_error_flag_ (const LogString *message)
	Set the error flag and log it; true when it was not set before.

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_ ()

Static Protected Member Functions
static void	mic_task (void *param)

Protected Attributes
std::vector< uint8_t >	frame_

StaticTask	mic_task_

std::atomic< uint8_t >	commands_ {0}

std::atomic< uint8_t >	listeners_ {0}

std::atomic< bool >	running_ {false}

std::atomic< bool >	task_idle_ {true}

uint32_t	retry_delay_ms_ {RETRY_MIN_MS}

Protected Attributes inherited from esphome::microphone::Microphone
State	state_ {STATE_STOPPED}

bool	mute_state_ {false}

audio::AudioStreamInfo	audio_stream_info_

CallbackManager< void(const std::vector< uint8_t > &)>	data_callbacks_ {}

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_

Protected Attributes inherited from esphome::Parented< USBAudioComponent >
USBAudioComponent *	parent_

Protected Attributes inherited from esphome::usb_audio::USBAudioStream
uint32_t	buffer_size_

Static Protected Attributes
static constexpr uint8_t	COMMAND_START = 1 << 0

static constexpr uint8_t	COMMAND_STOP = 1 << 1

static constexpr uint8_t	MAX_LISTENERS = 16

static constexpr uint32_t	READ_TIMEOUT_MS = 20

static constexpr uint32_t	RETRY_MIN_MS = 1000

static constexpr uint32_t	RETRY_MAX_MS = 30000

static constexpr uint32_t	RETRY_START_ID = 0

static constexpr uint32_t	MIC_TASK_STACK_SIZE = 4096

static constexpr UBaseType_t	MIC_TASK_PRIORITY = 18

Additional Inherited Members
Data Fields inherited from esphome::Component
uint32_t	length = 5000)

Detailed Description

Definition at line 20 of file usb_audio_microphone.h.

Constructor & Destructor Documentation

◆ USBAudioMicrophone()

esphome::usb_audio::USBAudioMicrophone::USBAudioMicrophone	(	const audio::AudioStreamInfo &	stream_info,
		uint32_t	buffer_size )

inline

Definition at line 25 of file usb_audio_microphone.h.

Member Function Documentation

◆ dump_config()

void esphome::usb_audio::USBAudioMicrophone::dump_config ( )

overridevirtual

Reimplemented from esphome::Component.

Definition at line 29 of file usb_audio_microphone.cpp.

◆ get_usb_stream_info()

audio::AudioStreamInfo esphome::usb_audio::USBAudioMicrophone::get_usb_stream_info ( )

inlineoverridevirtual

Implements esphome::usb_audio::USBAudioStream.

Definition at line 37 of file usb_audio_microphone.h.

◆ loop()

void esphome::usb_audio::USBAudioMicrophone::loop ( )

overridevirtual

Reimplemented from esphome::Component.

Definition at line 40 of file usb_audio_microphone.cpp.

◆ mic_task()

void esphome::usb_audio::USBAudioMicrophone::mic_task ( void * param )

staticprotected

Definition at line 147 of file usb_audio_microphone.cpp.

◆ mic_task_loop_()

void esphome::usb_audio::USBAudioMicrophone::mic_task_loop_ ( )

protected

Definition at line 149 of file usb_audio_microphone.cpp.

◆ on_stream_state()

void esphome::usb_audio::USBAudioMicrophone::on_stream_state ( StreamEvent event )

overridevirtual

Implements esphome::usb_audio::USBAudioStream.

Definition at line 108 of file usb_audio_microphone.cpp.

◆ request_()

void esphome::usb_audio::USBAudioMicrophone::request_	(	uint8_t	set,
		uint8_t	clear )

protected

Definition at line 73 of file usb_audio_microphone.cpp.

◆ setup()

void esphome::usb_audio::USBAudioMicrophone::setup ( )

overridevirtual

Reimplemented from esphome::Component.

Definition at line 18 of file usb_audio_microphone.cpp.

◆ start()

void esphome::usb_audio::USBAudioMicrophone::start ( )

overridevirtual

Implements esphome::microphone::Microphone.

Definition at line 81 of file usb_audio_microphone.cpp.

◆ stop()

void esphome::usb_audio::USBAudioMicrophone::stop ( )

overridevirtual

Implements esphome::microphone::Microphone.

Definition at line 96 of file usb_audio_microphone.cpp.

◆ stream_idle()

bool esphome::usb_audio::USBAudioMicrophone::stream_idle ( ) const

inlineoverridevirtual

Implements esphome::usb_audio::USBAudioStream.

Definition at line 39 of file usb_audio_microphone.h.

Field Documentation

◆ COMMAND_START

uint8_t esphome::usb_audio::USBAudioMicrophone::COMMAND_START = 1 << 0

staticconstexprprotected

Definition at line 42 of file usb_audio_microphone.h.

◆ COMMAND_STOP

uint8_t esphome::usb_audio::USBAudioMicrophone::COMMAND_STOP = 1 << 1

staticconstexprprotected

Definition at line 43 of file usb_audio_microphone.h.

◆ commands_

std::atomic<uint8_t> esphome::usb_audio::USBAudioMicrophone::commands_ {0}

protected

Definition at line 65 of file usb_audio_microphone.h.

◆ frame_

std::vector<uint8_t> esphome::usb_audio::USBAudioMicrophone::frame_

protected

Definition at line 62 of file usb_audio_microphone.h.

◆ listeners_

std::atomic<uint8_t> esphome::usb_audio::USBAudioMicrophone::listeners_ {0}

protected

Definition at line 67 of file usb_audio_microphone.h.

◆ MAX_LISTENERS

uint8_t esphome::usb_audio::USBAudioMicrophone::MAX_LISTENERS = 16

staticconstexprprotected

Definition at line 45 of file usb_audio_microphone.h.

◆ mic_task_

StaticTask esphome::usb_audio::USBAudioMicrophone::mic_task_

protected

Definition at line 64 of file usb_audio_microphone.h.

◆ MIC_TASK_PRIORITY

UBaseType_t esphome::usb_audio::USBAudioMicrophone::MIC_TASK_PRIORITY = 18

staticconstexprprotected

Definition at line 54 of file usb_audio_microphone.h.

◆ MIC_TASK_STACK_SIZE

uint32_t esphome::usb_audio::USBAudioMicrophone::MIC_TASK_STACK_SIZE = 4096

staticconstexprprotected

Definition at line 53 of file usb_audio_microphone.h.

◆ READ_TIMEOUT_MS

uint32_t esphome::usb_audio::USBAudioMicrophone::READ_TIMEOUT_MS = 20

staticconstexprprotected

Definition at line 46 of file usb_audio_microphone.h.

◆ retry_delay_ms_

uint32_t esphome::usb_audio::USBAudioMicrophone::retry_delay_ms_ {RETRY_MIN_MS}

protected

Definition at line 71 of file usb_audio_microphone.h.

◆ RETRY_MAX_MS

uint32_t esphome::usb_audio::USBAudioMicrophone::RETRY_MAX_MS = 30000

staticconstexprprotected

Definition at line 50 of file usb_audio_microphone.h.

◆ RETRY_MIN_MS

uint32_t esphome::usb_audio::USBAudioMicrophone::RETRY_MIN_MS = 1000

staticconstexprprotected

Definition at line 49 of file usb_audio_microphone.h.

◆ RETRY_START_ID

uint32_t esphome::usb_audio::USBAudioMicrophone::RETRY_START_ID = 0

staticconstexprprotected

Definition at line 52 of file usb_audio_microphone.h.

◆ running_

std::atomic<bool> esphome::usb_audio::USBAudioMicrophone::running_ {false}

protected

Definition at line 68 of file usb_audio_microphone.h.

◆ task_idle_

std::atomic<bool> esphome::usb_audio::USBAudioMicrophone::task_idle_ {true}

protected

Definition at line 69 of file usb_audio_microphone.h.

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

esphome/components/usb_audio/microphone/usb_audio_microphone.h
esphome/components/usb_audio/microphone/usb_audio_microphone.cpp

Public Member Functions

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Static Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ USBAudioMicrophone()

Member Function Documentation

◆ dump_config()

◆ get_usb_stream_info()

◆ loop()

◆ mic_task()

◆ mic_task_loop_()

◆ on_stream_state()

◆ request_()

◆ setup()

◆ start()

◆ stop()

◆ stream_idle()

Field Documentation

◆ COMMAND_START

◆ COMMAND_STOP

◆ commands_

◆ frame_

◆ listeners_

◆ MAX_LISTENERS

◆ mic_task_

◆ MIC_TASK_PRIORITY

◆ MIC_TASK_STACK_SIZE

◆ READ_TIMEOUT_MS

◆ retry_delay_ms_

◆ RETRY_MAX_MS

◆ RETRY_MIN_MS

◆ RETRY_START_ID

◆ running_

◆ task_idle_