|
ESPHome 2026.11.0b6
|
#include <i2s_audio_microphone.h>
Public Member Functions | |
| void | setup () override |
| void | dump_config () override |
| void | start () override |
| void | stop () override |
| void | loop () override |
| void | set_correct_dc_offset (bool correct_dc_offset) |
| void | set_din_pin (int8_t pin) |
| void | set_pdm (bool pdm) |
| void | set_pdm_dsr (i2s_pdm_dsr_t pdm_dsr) |
| void | build_full_duplex_config (i2s_std_config_t &std_cfg) override |
| void | full_duplex_rx_enabling (i2s_chan_handle_t rx_handle, uint32_t dma_desc_num) override |
Public Member Functions inherited from esphome::i2s_audio::I2SAudioIn | |
Public Member Functions inherited from esphome::i2s_audio::I2SAudioBase | |
| void | set_i2s_role (i2s_role_t role) |
| void | set_slot_mode (i2s_slot_mode_t slot_mode) |
| void | set_std_slot_mask (i2s_std_slot_mask_t std_slot_mask) |
| void | set_slot_bit_width (i2s_slot_bit_width_t slot_bit_width) |
| void | set_sample_rate (uint32_t sample_rate) |
| void | set_use_apll (uint32_t use_apll) |
| void | set_mclk_multiple (i2s_mclk_multiple_t mclk_multiple) |
Public Member Functions inherited from esphome::Parented< I2SAudioComponent > | |
| Parented () | |
| Parented (I2SAudioComponent *parent) | |
| I2SAudioComponent * | get_parent () const |
| Get the parent of this object. | |
| void | set_parent (I2SAudioComponent *parent) |
| Set the parent of this object. | |
Public Member Functions inherited from esphome::microphone::Microphone | |
| template<typename F > | |
| void | add_data_callback (F &&data_callback) |
| Callbacks take (const AudioCapture &) and run on the microphone's task. | |
| 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 last before a reboot or deep sleep 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) |
| bool ESPHOME_ALWAYS_INLINE | setup_check (bool ok) |
Marks the component failed with message (default "Communication failed") unless ok; returns ok. | |
| bool ESPHOME_ALWAYS_INLINE | setup_check (bool ok, 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 | |
| void | build_std_config_ (i2s_std_config_t &std_cfg) const |
| Builds the standard (non-PDM) mode configuration from the configured settings. | |
| void | configure_stream_settings_ () |
| Starts the I2S driver. | |
Protected Member Functions inherited from esphome::i2s_audio::I2SAudioBase | |
| i2s_clock_src_t | get_clock_source_ () const |
Protected Member Functions inherited from esphome::microphone::Microphone | |
| void | publish_audio_ (std::span< uint8_t > data, const audio::AudioStreamInfo &stream_info, int64_t capture_time_us=0) |
| While muted, data is zeroed first, so it must be a buffer the platform owns. | |
| bool | has_data_callbacks_ () const |
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 *params) |
| static bool | i2s_on_recv_cb (i2s_chan_handle_t handle, i2s_event_data_t *event, void *user_ctx) |
| Records the byte count and time of each DMA buffer the driver queues for reading. | |
| static bool | i2s_on_recv_q_ovf_cb (i2s_chan_handle_t handle, i2s_event_data_t *event, void *user_ctx) |
| Counts a buffer the driver dropped because the task fell behind; it will never be read. | |
Protected Attributes | |
| SemaphoreHandle_t | active_listeners_semaphore_ {nullptr} |
| EventGroupHandle_t | event_group_ {nullptr} |
| TaskHandle_t | task_handle_ {nullptr} |
| portMUX_TYPE | dma_lock_ = portMUX_INITIALIZER_UNLOCKED |
| uint32_t | dma_bytes_received_ {0} |
| int64_t | dma_receive_time_us_ {0} |
| std::atomic< uint32_t > | dma_buffers_dropped_ {0} |
| uint32_t | dma_bytes_read_ {0} |
| size_t | dma_buffer_bytes_ {0} |
| uint32_t | dma_desc_num_ {0} |
| gpio_num_t | din_pin_ {I2S_GPIO_UNUSED} |
| i2s_chan_handle_t | rx_handle_ {nullptr} |
| i2s_pdm_dsr_t | pdm_dsr_ {I2S_PDM_DSR_8S} |
| bool | pdm_ {false} |
| bool | correct_dc_offset_ |
| bool | locked_driver_ {false} |
| DCOffsetFilter | dc_offset_filter_ |
Protected Attributes inherited from esphome::i2s_audio::I2SAudioBase | |
| i2s_role_t | i2s_role_ {} |
| i2s_slot_mode_t | slot_mode_ |
| i2s_std_slot_mask_t | std_slot_mask_ |
| i2s_slot_bit_width_t | slot_bit_width_ |
| uint32_t | sample_rate_ |
| bool | use_apll_ |
| i2s_mclk_multiple_t | mclk_multiple_ |
Protected Attributes inherited from esphome::Parented< I2SAudioComponent > | |
| I2SAudioComponent * | parent_ |
Protected Attributes inherited from esphome::microphone::Microphone | |
| State | state_ {STATE_STOPPED} |
| bool | mute_state_ {false} |
| audio::AudioStreamInfo | audio_stream_info_ |
| DataCallbackManager | data_callbacks_ {&this->audio_stream_info_, &this->mute_state_} |
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) |
Definition at line 20 of file i2s_audio_microphone.h.
|
overridevirtual |
Implements esphome::i2s_audio::I2SAudioIn.
Definition at line 134 of file i2s_audio_microphone.cpp.
|
protected |
Builds the standard (non-PDM) mode configuration from the configured settings.
Definition at line 112 of file i2s_audio_microphone.cpp.
|
protected |
Starts the I2S driver.
Updates the audio_stream_info_ member variable with the current setttings. /
/ Stops the I2S driver. void stop_driver_();
/ Registers the DMA callbacks on a disabled RX channel and restarts the capture time counts. /
/ Reads the size of one DMA buffer from a started RX channel. /
size_t read_(uint8_t *buf, size_t len, uint32_t timeout_ms);
/ Sets the Microphone audio_stream_info_ member variable to the configured I2S settings.
Definition at line 76 of file i2s_audio_microphone.cpp.
|
overridevirtual |
Reimplemented from esphome::Component.
Definition at line 67 of file i2s_audio_microphone.cpp.
|
overridevirtual |
Implements esphome::i2s_audio::I2SAudioIn.
Definition at line 136 of file i2s_audio_microphone.cpp.
|
staticprotected |
Records the byte count and time of each DMA buffer the driver queues for reading.
Definition at line 380 of file i2s_audio_microphone.cpp.
|
staticprotected |
Counts a buffer the driver dropped because the task fell behind; it will never be read.
Definition at line 390 of file i2s_audio_microphone.cpp.
|
overridevirtual |
Reimplemented from esphome::Component.
Definition at line 430 of file i2s_audio_microphone.cpp.
|
staticprotected |
Definition at line 315 of file i2s_audio_microphone.cpp.
|
inline |
Definition at line 29 of file i2s_audio_microphone.h.
|
inline |
Definition at line 31 of file i2s_audio_microphone.h.
|
inline |
Definition at line 33 of file i2s_audio_microphone.h.
|
inline |
Definition at line 36 of file i2s_audio_microphone.h.
|
overridevirtual |
Reimplemented from esphome::Component.
Definition at line 42 of file i2s_audio_microphone.cpp.
|
overridevirtual |
Implements esphome::microphone::Microphone.
Definition at line 105 of file i2s_audio_microphone.cpp.
|
overridevirtual |
Implements esphome::microphone::Microphone.
Definition at line 272 of file i2s_audio_microphone.cpp.
|
protected |
Definition at line 75 of file i2s_audio_microphone.h.
|
protected |
Definition at line 104 of file i2s_audio_microphone.h.
|
protected |
Definition at line 106 of file i2s_audio_microphone.h.
|
protected |
Definition at line 97 of file i2s_audio_microphone.h.
|
protected |
Definition at line 94 of file i2s_audio_microphone.h.
|
protected |
Definition at line 87 of file i2s_audio_microphone.h.
|
protected |
Definition at line 91 of file i2s_audio_microphone.h.
|
protected |
Definition at line 83 of file i2s_audio_microphone.h.
|
protected |
Definition at line 95 of file i2s_audio_microphone.h.
|
protected |
Definition at line 82 of file i2s_audio_microphone.h.
|
protected |
Definition at line 84 of file i2s_audio_microphone.h.
|
protected |
Definition at line 76 of file i2s_audio_microphone.h.
|
protected |
Definition at line 105 of file i2s_audio_microphone.h.
|
protected |
Definition at line 103 of file i2s_audio_microphone.h.
|
protected |
Definition at line 100 of file i2s_audio_microphone.h.
|
protected |
Definition at line 98 of file i2s_audio_microphone.h.
|
protected |
Definition at line 78 of file i2s_audio_microphone.h.