#include <i2s_audio.h>

Inheritance diagram for esphome::i2s_audio::I2SAudioComponent:

Public Member Functions
void	setup () override

void	set_audio_in (I2SAudioIn *audio_in)

void	set_audio_out (I2SAudioOut *audio_out)

bool	is_full_duplex () const
	True when a microphone and a speaker share this bus at the same time.

i2s_chan_handle_t	acquire_rx_channel ()
	Enables the full duplex RX channel.

void	release_rx_channel ()
	Releases the RX channel; it keeps running while the TX side needs its clocks. Main loop only.

i2s_chan_handle_t	acquire_tx_channel ()
	Starts the shared clocks and hands over the full duplex TX channel, still disabled, so the caller can register callbacks and preload data before enabling it.

void	release_tx_channel ()
	Disables the TX channel and stops the shared clocks if the RX side is idle.

bool	is_tx_in_use () const
	True while another speaker holds the full duplex TX channel.

i2s_std_gpio_config_t	get_pin_config () const

void	set_mclk_pin (int pin)

void	set_bclk_pin (int pin)

void	set_lrclk_pin (int pin)

void	set_port (int port)

int	get_port () const

i2s_port_t	get_port () const

void	lock ()

bool	try_lock ()

void	unlock ()

Public Member Functions inherited from esphome::Component
virtual void	loop ()
	This method will be called repeatedly.

virtual void	dump_config ()

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)

Protected Member Functions
i2s_chan_handle_t	acquire_ (bool &in_use, i2s_chan_handle_t handle)
	Marks one side active and brings the shared clocks up; undoes the mark if that fails.

bool	update_rx_channel_ ()
	Enables the RX channel while either side is active, since it drives the shared clocks.

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

Protected Attributes
Mutex	lock_

I2SAudioIn *	audio_in_ {nullptr}

I2SAudioOut *	audio_out_ {nullptr}

i2s_chan_handle_t	rx_handle_ {nullptr}

i2s_chan_handle_t	tx_handle_ {nullptr}

bool	rx_in_use_ {false}

bool	tx_in_use_ {false}

bool	rx_enabled_ {false}

int	mclk_pin_ {I2S_GPIO_UNUSED}

int	bclk_pin_ {I2S_GPIO_UNUSED}

int	lrclk_pin_

int	port_ {}

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_

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

Detailed Description

Definition at line 62 of file i2s_audio.h.

Member Function Documentation

◆ acquire_()

i2s_chan_handle_t esphome::i2s_audio::I2SAudioComponent::acquire_	(	bool &	in_use,
		i2s_chan_handle_t	handle )

protected

Marks one side active and brings the shared clocks up; undoes the mark if that fails.

Definition at line 45 of file i2s_audio.cpp.

◆ acquire_rx_channel()

i2s_chan_handle_t esphome::i2s_audio::I2SAudioComponent::acquire_rx_channel ( )

Enables the full duplex RX channel.

Main loop only.

Returns: The enabled RX handle, or nullptr if the channel pair is unavailable

Definition at line 56 of file i2s_audio.cpp.

◆ acquire_tx_channel()

i2s_chan_handle_t esphome::i2s_audio::I2SAudioComponent::acquire_tx_channel ( )

Starts the shared clocks and hands over the full duplex TX channel, still disabled, so the caller can register callbacks and preload data before enabling it.

Main loop only.

Returns: The TX handle, or nullptr if the channel pair is unavailable or another speaker holds it

Definition at line 63 of file i2s_audio.cpp.

◆ get_pin_config()

i2s_std_gpio_config_t esphome::i2s_audio::I2SAudioComponent::get_pin_config ( ) const

inline

Definition at line 89 of file i2s_audio.h.

◆ get_port() [1/2]

int esphome::i2s_audio::I2SAudioComponent::get_port ( ) const

inline

Definition at line 107 of file i2s_audio.h.

◆ get_port() [2/2]

i2s_port_t esphome::i2s_audio::I2SAudioComponent::get_port ( ) const

inline

Definition at line 109 of file i2s_audio.h.

◆ is_full_duplex()

bool esphome::i2s_audio::I2SAudioComponent::is_full_duplex ( ) const

inline

True when a microphone and a speaker share this bus at the same time.

Definition at line 71 of file i2s_audio.h.

◆ is_tx_in_use()

bool esphome::i2s_audio::I2SAudioComponent::is_tx_in_use ( ) const

inline

True while another speaker holds the full duplex TX channel.

Definition at line 87 of file i2s_audio.h.

◆ lock()

void esphome::i2s_audio::I2SAudioComponent::lock ( )

inline

Definition at line 112 of file i2s_audio.h.

◆ release_rx_channel()

void esphome::i2s_audio::I2SAudioComponent::release_rx_channel ( )

Releases the RX channel; it keeps running while the TX side needs its clocks. Main loop only.

Definition at line 58 of file i2s_audio.cpp.

◆ release_tx_channel()

void esphome::i2s_audio::I2SAudioComponent::release_tx_channel ( )

Disables the TX channel and stops the shared clocks if the RX side is idle.

Only the speaker that acquired the channel may call this. Main loop only.

Definition at line 70 of file i2s_audio.cpp.

◆ set_audio_in()

void esphome::i2s_audio::I2SAudioComponent::set_audio_in ( I2SAudioIn * audio_in )

inline

Definition at line 67 of file i2s_audio.h.

◆ set_audio_out()

void esphome::i2s_audio::I2SAudioComponent::set_audio_out ( I2SAudioOut * audio_out )

inline

Definition at line 68 of file i2s_audio.h.

◆ set_bclk_pin()

void esphome::i2s_audio::I2SAudioComponent::set_bclk_pin ( int pin )

inline

Definition at line 103 of file i2s_audio.h.

◆ set_lrclk_pin()

void esphome::i2s_audio::I2SAudioComponent::set_lrclk_pin ( int pin )

inline

Definition at line 104 of file i2s_audio.h.

◆ set_mclk_pin()

void esphome::i2s_audio::I2SAudioComponent::set_mclk_pin ( int pin )

inline

Definition at line 102 of file i2s_audio.h.

◆ set_port()

void esphome::i2s_audio::I2SAudioComponent::set_port ( int port )

inline

Definition at line 105 of file i2s_audio.h.

◆ setup()

void esphome::i2s_audio::I2SAudioComponent::setup ( )

overridevirtual

Reimplemented from esphome::Component.

Definition at line 11 of file i2s_audio.cpp.

◆ try_lock()

bool esphome::i2s_audio::I2SAudioComponent::try_lock ( )

inline

Definition at line 113 of file i2s_audio.h.

◆ unlock()

void esphome::i2s_audio::I2SAudioComponent::unlock ( )

inline

Definition at line 114 of file i2s_audio.h.

◆ update_rx_channel_()

bool esphome::i2s_audio::I2SAudioComponent::update_rx_channel_ ( )

protected

Enables the RX channel while either side is active, since it drives the shared clocks.

Definition at line 77 of file i2s_audio.cpp.

Field Documentation

◆ audio_in_

I2SAudioIn* esphome::i2s_audio::I2SAudioComponent::audio_in_ {nullptr}

protected

Definition at line 125 of file i2s_audio.h.

◆ audio_out_

I2SAudioOut* esphome::i2s_audio::I2SAudioComponent::audio_out_ {nullptr}

protected

Definition at line 126 of file i2s_audio.h.

◆ bclk_pin_

int esphome::i2s_audio::I2SAudioComponent::bclk_pin_ {I2S_GPIO_UNUSED}

protected

Definition at line 134 of file i2s_audio.h.

◆ lock_

Mutex esphome::i2s_audio::I2SAudioComponent::lock_

protected

Definition at line 117 of file i2s_audio.h.

◆ lrclk_pin_

int esphome::i2s_audio::I2SAudioComponent::lrclk_pin_

protected

Definition at line 135 of file i2s_audio.h.

◆ mclk_pin_

int esphome::i2s_audio::I2SAudioComponent::mclk_pin_ {I2S_GPIO_UNUSED}

protected

Definition at line 133 of file i2s_audio.h.

◆ port_

int esphome::i2s_audio::I2SAudioComponent::port_ {}

protected

Definition at line 136 of file i2s_audio.h.

◆ rx_enabled_

bool esphome::i2s_audio::I2SAudioComponent::rx_enabled_ {false}

protected

Definition at line 131 of file i2s_audio.h.

◆ rx_handle_

i2s_chan_handle_t esphome::i2s_audio::I2SAudioComponent::rx_handle_ {nullptr}

protected

Definition at line 127 of file i2s_audio.h.

◆ rx_in_use_

bool esphome::i2s_audio::I2SAudioComponent::rx_in_use_ {false}

protected

Definition at line 129 of file i2s_audio.h.

◆ tx_handle_

i2s_chan_handle_t esphome::i2s_audio::I2SAudioComponent::tx_handle_ {nullptr}

protected

Definition at line 128 of file i2s_audio.h.

◆ tx_in_use_

bool esphome::i2s_audio::I2SAudioComponent::tx_in_use_ {false}

protected

Definition at line 130 of file i2s_audio.h.

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

esphome/components/i2s_audio/i2s_audio.h
esphome/components/i2s_audio/i2s_audio.cpp

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ acquire_()

◆ acquire_rx_channel()

◆ acquire_tx_channel()

◆ get_pin_config()

◆ get_port() [1/2]

◆ get_port() [2/2]

◆ is_full_duplex()

◆ is_tx_in_use()

◆ lock()

◆ release_rx_channel()

◆ release_tx_channel()

◆ set_audio_in()

◆ set_audio_out()

◆ set_bclk_pin()

◆ set_lrclk_pin()

◆ set_mclk_pin()

◆ set_port()

◆ setup()

◆ try_lock()

◆ unlock()

◆ update_rx_channel_()

Field Documentation

◆ audio_in_

◆ audio_out_

◆ bclk_pin_

◆ lock_

◆ lrclk_pin_

◆ mclk_pin_

◆ port_

◆ rx_enabled_

◆ rx_handle_

◆ rx_in_use_

◆ tx_handle_

◆ tx_in_use_