ESPHome 2026.8.0-dev
Loading...
Searching...
No Matches
esphome::pcm5122::PCM5122 Class Referencefinal

#include <pcm5122.h>

Inheritance diagram for esphome::pcm5122::PCM5122:
esphome::audio_dac::AudioDac esphome::Component esphome::i2c::I2CDevice

Public Member Functions

void setup () override
 
void dump_config () override
 
float get_setup_priority () const override
 
void set_bits_per_sample (PCM5122BitsPerSample bits_per_sample)
 
void set_analog_gain (PCM5122AnalogGain analog_gain)
 
void set_channel_mix (PCM5122ChannelMix channel_mix)
 
void set_volume_min_db (float volume_min_db)
 
void set_volume_max_db (float volume_max_db)
 
void set_enable_pin (GPIOPin *enable_pin)
 
bool set_mute_off () override
 
bool set_mute_on () override
 
bool set_volume (float volume) override
 
bool is_muted () override
 
float volume () override
 
bool set_standby (bool enable)
 
bool set_powerdown (bool enable)
 
- Public Member Functions inherited from esphome::audio_dac::AudioDac
- Public Member Functions inherited from esphome::Component
virtual void loop ()
 This method will be called repeatedly.
 
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)
 
- Public Member Functions inherited from esphome::i2c::I2CDevice
 I2CDevice ()=default
 we use the C++ default constructor
 
void set_i2c_address (uint8_t address)
 We store the address of the device on the bus.
 
uint8_t get_i2c_address () const
 Returns the I2C address of the object.
 
void set_i2c_bus (I2CBus *bus)
 we store the pointer to the I2CBus to use
 
I2CRegister reg (uint8_t a_register)
 calls the I2CRegister constructor
 
I2CRegister16 reg16 (uint16_t a_register)
 calls the I2CRegister16 constructor
 
ErrorCode read (uint8_t *data, size_t len) const
 reads an array of bytes from the device using an I2CBus
 
ErrorCode read_register (uint8_t a_register, uint8_t *data, size_t len)
 reads an array of bytes from a specific register in the I²C device
 
ErrorCode read_register16 (uint16_t a_register, uint8_t *data, size_t len)
 reads an array of bytes from a specific register in the I²C device
 
ErrorCode write (const uint8_t *data, size_t len) const
 writes an array of bytes to a device using an I2CBus
 
ErrorCode write_read (const uint8_t *write_data, size_t write_len, uint8_t *read_data, size_t read_len) const
 writes an array of bytes to a device, then reads an array, as a single transaction
 
ErrorCode write_register (uint8_t a_register, const uint8_t *data, size_t len) const
 writes an array of bytes to a specific register in the I²C device
 
ErrorCode write_register16 (uint16_t a_register, const uint8_t *data, size_t len) const
 write an array of bytes to a specific register in the I²C device
 
bool read_bytes (uint8_t a_register, uint8_t *data, uint8_t len)
 Compat APIs All methods below have been added for compatibility reasons.
 
bool read_bytes_raw (uint8_t *data, uint8_t len) const
 
template<size_t N>
optional< std::array< uint8_t, N > > read_bytes (uint8_t a_register)
 
template<size_t N>
optional< std::array< uint8_t, N > > read_bytes_raw ()
 
bool read_bytes_16 (uint8_t a_register, uint16_t *data, uint8_t len)
 
bool read_byte (uint8_t a_register, uint8_t *data)
 
optional< uint8_t > read_byte (uint8_t a_register)
 
bool read_byte_16 (uint8_t a_register, uint16_t *data)
 
bool write_bytes (uint8_t a_register, const uint8_t *data, uint8_t len) const
 
bool write_bytes (uint8_t a_register, const std::vector< uint8_t > &data) const
 
template<size_t N>
bool write_bytes (uint8_t a_register, const std::array< uint8_t, N > &data)
 
bool write_bytes_16 (uint8_t a_register, const uint16_t *data, uint8_t len) const
 
bool write_byte (uint8_t a_register, uint8_t data) const
 
bool write_byte_16 (uint8_t a_register, uint16_t data) const
 

Protected Member Functions

bool select_page_ (uint8_t page)
 
bool write_mute_ ()
 
bool write_volume_ ()
 
bool write_analog_gain_ ()
 
bool write_channel_mix_ ()
 
bool write_power_control_ ()
 
- 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

GPIOPinenable_pin_ {nullptr}
 
float volume_ {1.0f}
 
float volume_min_db_ {-52.5f}
 
float volume_max_db_ {0.0f}
 
int16_t current_page_ {-1}
 
bool is_muted_ {false}
 
bool standby_ {false}
 
bool powerdown_ {false}
 
PCM5122BitsPerSample bits_per_sample_ {PCM5122_BITS_PER_SAMPLE_16}
 
PCM5122AnalogGain analog_gain_ {PCM5122_ANALOG_GAIN_0DB}
 
PCM5122ChannelMix channel_mix_ {PCM5122_CHANNEL_MIX_STEREO}
 
- Protected Attributes inherited from esphome::audio_dac::AudioDac
bool is_muted_ {false}
 
- 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::i2c::I2CDevice
uint8_t address_ {0x00}
 store the address of the device on the bus
 
I2CBusbus_ {nullptr}
 pointer to I2CBus instance
 

Detailed Description

Definition at line 71 of file pcm5122.h.

Member Function Documentation

◆ dump_config()

void esphome::pcm5122::PCM5122::dump_config ( )
overridevirtual

Reimplemented from esphome::Component.

Definition at line 98 of file pcm5122.cpp.

◆ get_setup_priority()

float esphome::pcm5122::PCM5122::get_setup_priority ( ) const
inlineoverridevirtual

Reimplemented from esphome::Component.

Definition at line 75 of file pcm5122.h.

◆ is_muted()

bool esphome::pcm5122::PCM5122::is_muted ( )
overridevirtual

Implements esphome::audio_dac::AudioDac.

Definition at line 142 of file pcm5122.cpp.

◆ select_page_()

bool esphome::pcm5122::PCM5122::select_page_ ( uint8_t page)
protected

Definition at line 146 of file pcm5122.cpp.

◆ set_analog_gain()

void esphome::pcm5122::PCM5122::set_analog_gain ( PCM5122AnalogGain analog_gain)
inline

Definition at line 78 of file pcm5122.h.

◆ set_bits_per_sample()

void esphome::pcm5122::PCM5122::set_bits_per_sample ( PCM5122BitsPerSample bits_per_sample)
inline

Definition at line 77 of file pcm5122.h.

◆ set_channel_mix()

void esphome::pcm5122::PCM5122::set_channel_mix ( PCM5122ChannelMix channel_mix)
inline

Definition at line 79 of file pcm5122.h.

◆ set_enable_pin()

void esphome::pcm5122::PCM5122::set_enable_pin ( GPIOPin * enable_pin)
inline

Definition at line 82 of file pcm5122.h.

◆ set_mute_off()

bool esphome::pcm5122::PCM5122::set_mute_off ( )
overridevirtual

Implements esphome::audio_dac::AudioDac.

Definition at line 127 of file pcm5122.cpp.

◆ set_mute_on()

bool esphome::pcm5122::PCM5122::set_mute_on ( )
overridevirtual

Implements esphome::audio_dac::AudioDac.

Definition at line 132 of file pcm5122.cpp.

◆ set_powerdown()

bool esphome::pcm5122::PCM5122::set_powerdown ( bool enable)

Definition at line 214 of file pcm5122.cpp.

◆ set_standby()

bool esphome::pcm5122::PCM5122::set_standby ( bool enable)

Definition at line 204 of file pcm5122.cpp.

◆ set_volume()

bool esphome::pcm5122::PCM5122::set_volume ( float volume)
overridevirtual

Implements esphome::audio_dac::AudioDac.

Definition at line 137 of file pcm5122.cpp.

◆ set_volume_max_db()

void esphome::pcm5122::PCM5122::set_volume_max_db ( float volume_max_db)
inline

Definition at line 81 of file pcm5122.h.

◆ set_volume_min_db()

void esphome::pcm5122::PCM5122::set_volume_min_db ( float volume_min_db)
inline

Definition at line 80 of file pcm5122.h.

◆ setup()

void esphome::pcm5122::PCM5122::setup ( )
overridevirtual

Reimplemented from esphome::Component.

Definition at line 12 of file pcm5122.cpp.

◆ volume()

float esphome::pcm5122::PCM5122::volume ( )
overridevirtual

Implements esphome::audio_dac::AudioDac.

Definition at line 144 of file pcm5122.cpp.

◆ write_analog_gain_()

bool esphome::pcm5122::PCM5122::write_analog_gain_ ( )
protected

Definition at line 186 of file pcm5122.cpp.

◆ write_channel_mix_()

bool esphome::pcm5122::PCM5122::write_channel_mix_ ( )
protected

Definition at line 195 of file pcm5122.cpp.

◆ write_mute_()

bool esphome::pcm5122::PCM5122::write_mute_ ( )
protected

Definition at line 157 of file pcm5122.cpp.

◆ write_power_control_()

bool esphome::pcm5122::PCM5122::write_power_control_ ( )
protected

Definition at line 224 of file pcm5122.cpp.

◆ write_volume_()

bool esphome::pcm5122::PCM5122::write_volume_ ( )
protected

Definition at line 166 of file pcm5122.cpp.

Field Documentation

◆ analog_gain_

PCM5122AnalogGain esphome::pcm5122::PCM5122::analog_gain_ {PCM5122_ANALOG_GAIN_0DB}
protected

Definition at line 113 of file pcm5122.h.

◆ bits_per_sample_

PCM5122BitsPerSample esphome::pcm5122::PCM5122::bits_per_sample_ {PCM5122_BITS_PER_SAMPLE_16}
protected

Definition at line 112 of file pcm5122.h.

◆ channel_mix_

PCM5122ChannelMix esphome::pcm5122::PCM5122::channel_mix_ {PCM5122_CHANNEL_MIX_STEREO}
protected

Definition at line 114 of file pcm5122.h.

◆ current_page_

int16_t esphome::pcm5122::PCM5122::current_page_ {-1}
protected

Definition at line 108 of file pcm5122.h.

◆ enable_pin_

GPIOPin* esphome::pcm5122::PCM5122::enable_pin_ {nullptr}
protected

Definition at line 104 of file pcm5122.h.

◆ is_muted_

bool esphome::pcm5122::PCM5122::is_muted_ {false}
protected

Definition at line 109 of file pcm5122.h.

◆ powerdown_

bool esphome::pcm5122::PCM5122::powerdown_ {false}
protected

Definition at line 111 of file pcm5122.h.

◆ standby_

bool esphome::pcm5122::PCM5122::standby_ {false}
protected

Definition at line 110 of file pcm5122.h.

◆ volume_

float esphome::pcm5122::PCM5122::volume_ {1.0f}
protected

Definition at line 105 of file pcm5122.h.

◆ volume_max_db_

float esphome::pcm5122::PCM5122::volume_max_db_ {0.0f}
protected

Definition at line 107 of file pcm5122.h.

◆ volume_min_db_

float esphome::pcm5122::PCM5122::volume_min_db_ {-52.5f}
protected

Definition at line 106 of file pcm5122.h.


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