ESPHome 2026.11.0b6
Loading...
Searching...
No Matches
esphome::tas58xx::TAS58xx Class Reference

#include <tas58xx.h>

Inheritance diagram for esphome::tas58xx::TAS58xx:
esphome::audio_dac::AudioDac esphome::PollingComponent esphome::i2c::I2CDevice esphome::Component

Public Member Functions

 TAS58xx (const ModelInfo *model)
 
void setup () override
 
void dump_config () override
 
float get_setup_priority () const override
 
void update () override
 
void activate ()
 Clear faults, leave deep sleep and switch to play; the device waits in Hi-Z until an I2S clock is present.
 
void deactivate ()
 Switch to deep sleep, the lowest power state that keeps I2C and the DSP running.
 
bool set_mute_off () override
 
bool set_mute_on () override
 
bool set_volume (float volume) override
 
bool is_muted () override
 
float volume () override
 
void on_audio_started () override
 
void set_enable_pin (GPIOPin *enable_pin)
 
void set_analog_gain (float analog_gain_db)
 
void set_dac_mode (DacMode dac_mode)
 
void set_fault_output (uint8_t pin)
 pin: 0 to 2 for GPIOn on TAS5825M, 0 for ADR on TAS5805M; leave unset for no fault output
 
void set_mixer_mode (MixerMode mixer_mode)
 
void set_modulation (Modulation modulation)
 
void set_volume_min_db (float volume_min_db)
 
void set_volume_max_db (float volume_max_db)
 
 SUB_SELECT (mixer_mode) void apply_mixer_mode(MixerMode mixer_mode)
 Change input mixer; except if invalid for dac_mode. Written immediately if playing, otherwise when audio starts.
 
 SUB_BINARY_SENSOR (have_fault) void set_fault_binary_sensor(FaultSensor fault
 
 SUB_SWITCH (activate) void set_active(bool active)
 The activate switch: on activates the amplifier (play), off puts it into deep sleep.
 
- Public Member Functions inherited from esphome::audio_dac::AudioDac
- Public Member Functions inherited from esphome::PollingComponent
 PollingComponent ()
 
 PollingComponent (uint32_t update_interval)
 Initialize this polling component with the given update interval in ms.
 
void set_update_interval (uint32_t update_interval)
 Manually set the update interval in ms for this polling object.
 
void call_setup () override
 
virtual uint32_t get_update_interval () const
 Get the update interval in ms of this sensor.
 
void start_poller ()
 
void stop_poller ()
 
- 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 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)
 
- 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 write_registers (const I2CRegValue *table, size_t count) const
 Write each register and value of table in order, stopping at the first failure.
 
template<size_t N>
bool write_registers (const I2CRegValue(&table)[N]) const
 
bool check_chip_id (Component *component, uint8_t a_register, uint8_t expected, uint8_t mask=0xFF)
 Read the 8-bit ID at a_register and accept it when it matches expected in the bits set in mask.
 
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 read_bytes_16_le (uint8_t a_register, uint16_t *data, uint8_t len)
 Read len 16-bit values stored least significant byte first; no conversion is compiled on little-endian hosts.
 
bool read_bytes_16_le (uint8_t a_register, int16_t *data, uint8_t len)
 
bool read_byte_16_le (uint8_t a_register, uint16_t *data)
 Read a 16-bit value stored least significant byte first.
 
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
 
bool write_byte_16_le (uint8_t a_register, uint16_t data) const
 Write a 16-bit value least significant byte first.
 
bool update_register (uint8_t a_register, uint8_t mask, uint8_t value)
 Read a register, replace the bits in mask with those of value and write it back.
 

Data Fields

binary_sensor::BinarySensor * sensor
 
- Data Fields inherited from esphome::Component
uint32_t length = 5000)
 

Protected Member Functions

void publish_active_ (bool active)
 Publish the activate switch state, if there is one.
 
bool select_book_page_ (uint8_t book, uint8_t page)
 
bool init_ ()
 
bool write_ctrl_state_ (uint8_t state, bool muted)
 
bool set_mute_ (bool muted)
 
bool write_volume_ ()
 
bool write_mixer_ ()
 
bool read_faults_ ()
 
bool read_power_state_ (uint8_t &power_state)
 Read POWER_STATE, masked to device state; false if read failed.
 
void write_dsp_ ()
 Write DSP settings not written since last reset; call only while DSP is writable.
 
void publish_mixer_mode_ ()
 Show current mixer mode on mixer mode select.
 
- 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.
 
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

const ModelInfo * model_
 
GPIOPin * enable_pin_ {nullptr}
 
std::array< binary_sensor::BinarySensor *, FAULT_SENSOR_COUNT > fault_binary_sensors_ {}
 
float volume_ {0}
 
float analog_gain_db_ {-15.5f}
 
float volume_min_db_ {-103.0f}
 
float volume_max_db_ {24.0f}
 
uint32_t logged_faults_ {0}
 
DacMode dac_mode_ {DAC_MODE_BTL}
 
uint8_t fault_output_pin_ {FAULT_OUTPUT_NONE}
 
MixerMode mixer_mode_ {MIXER_MODE_STEREO}
 
Modulation modulation_ {MODULATION_BD_MODE}
 
uint8_t ctrl_state_ {0}
 
uint8_t power_state_ {0xFF}
 
bool mixer_written_ {false}
 
- Protected Attributes inherited from esphome::audio_dac::AudioDac
bool is_muted_ {false}
 
- Protected Attributes inherited from esphome::PollingComponent
uint32_t update_interval_
 
- 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
I2CBus * bus_ {nullptr}
 pointer to I2CBus instance
 
uint8_t address_ {0x00}
 store the address of the device on the bus
 

Detailed Description

Definition at line 118 of file tas58xx.h.

Constructor & Destructor Documentation

◆ TAS58xx()

esphome::tas58xx::TAS58xx::TAS58xx ( const ModelInfo * model)
inlineexplicit

Definition at line 120 of file tas58xx.h.

Member Function Documentation

◆ activate()

void esphome::tas58xx::TAS58xx::activate ( )

Clear faults, leave deep sleep and switch to play; the device waits in Hi-Z until an I2S clock is present.

This is also how the output is restarted after a DC or over current fault.

Definition at line 154 of file tas58xx.cpp.

◆ deactivate()

void esphome::tas58xx::TAS58xx::deactivate ( )

Switch to deep sleep, the lowest power state that keeps I2C and the DSP running.

Definition at line 179 of file tas58xx.cpp.

◆ dump_config()

void esphome::tas58xx::TAS58xx::dump_config ( )
overridevirtual

Reimplemented from esphome::Component.

Definition at line 296 of file tas58xx.cpp.

◆ get_setup_priority()

float esphome::tas58xx::TAS58xx::get_setup_priority ( ) const
inlineoverridevirtual

Reimplemented from esphome::Component.

Definition at line 124 of file tas58xx.h.

◆ init_()

bool esphome::tas58xx::TAS58xx::init_ ( )
protected

Definition at line 107 of file tas58xx.cpp.

◆ is_muted()

bool esphome::tas58xx::TAS58xx::is_muted ( )
inlineoverridevirtual

Implements esphome::audio_dac::AudioDac.

Definition at line 137 of file tas58xx.h.

◆ on_audio_started()

void esphome::tas58xx::TAS58xx::on_audio_started ( )
overridevirtual

Reimplemented from esphome::audio_dac::AudioDac.

Definition at line 261 of file tas58xx.cpp.

◆ publish_active_()

void esphome::tas58xx::TAS58xx::publish_active_ ( bool active)
protected

Publish the activate switch state, if there is one.

Definition at line 195 of file tas58xx.cpp.

◆ publish_mixer_mode_()

void esphome::tas58xx::TAS58xx::publish_mixer_mode_ ( )
protected

Show current mixer mode on mixer mode select.

Definition at line 365 of file tas58xx.cpp.

◆ read_faults_()

bool esphome::tas58xx::TAS58xx::read_faults_ ( )
protected

Definition at line 211 of file tas58xx.cpp.

◆ read_power_state_()

bool esphome::tas58xx::TAS58xx::read_power_state_ ( uint8_t & power_state)
protected

Read POWER_STATE, masked to device state; false if read failed.

Definition at line 267 of file tas58xx.cpp.

◆ select_book_page_()

bool esphome::tas58xx::TAS58xx::select_book_page_ ( uint8_t book,
uint8_t page )
protected

Definition at line 101 of file tas58xx.cpp.

◆ set_analog_gain()

void esphome::tas58xx::TAS58xx::set_analog_gain ( float analog_gain_db)
inline

Definition at line 143 of file tas58xx.h.

◆ set_dac_mode()

void esphome::tas58xx::TAS58xx::set_dac_mode ( DacMode dac_mode)
inline

Definition at line 144 of file tas58xx.h.

◆ set_enable_pin()

void esphome::tas58xx::TAS58xx::set_enable_pin ( GPIOPin * enable_pin)
inline

Definition at line 142 of file tas58xx.h.

◆ set_fault_output()

void esphome::tas58xx::TAS58xx::set_fault_output ( uint8_t pin)
inline

pin: 0 to 2 for GPIOn on TAS5825M, 0 for ADR on TAS5805M; leave unset for no fault output

Definition at line 146 of file tas58xx.h.

◆ set_mixer_mode()

void esphome::tas58xx::TAS58xx::set_mixer_mode ( MixerMode mixer_mode)
inline

Definition at line 147 of file tas58xx.h.

◆ set_modulation()

void esphome::tas58xx::TAS58xx::set_modulation ( Modulation modulation)
inline

Definition at line 148 of file tas58xx.h.

◆ set_mute_()

bool esphome::tas58xx::TAS58xx::set_mute_ ( bool muted)
protected

Definition at line 338 of file tas58xx.cpp.

◆ set_mute_off()

bool esphome::tas58xx::TAS58xx::set_mute_off ( )
inlineoverridevirtual

Implements esphome::audio_dac::AudioDac.

Definition at line 133 of file tas58xx.h.

◆ set_mute_on()

bool esphome::tas58xx::TAS58xx::set_mute_on ( )
inlineoverridevirtual

Implements esphome::audio_dac::AudioDac.

Definition at line 134 of file tas58xx.h.

◆ set_volume()

bool esphome::tas58xx::TAS58xx::set_volume ( float volume)
overridevirtual

Implements esphome::audio_dac::AudioDac.

Definition at line 345 of file tas58xx.cpp.

◆ set_volume_max_db()

void esphome::tas58xx::TAS58xx::set_volume_max_db ( float volume_max_db)
inline

Definition at line 150 of file tas58xx.h.

◆ set_volume_min_db()

void esphome::tas58xx::TAS58xx::set_volume_min_db ( float volume_min_db)
inline

Definition at line 149 of file tas58xx.h.

◆ setup()

void esphome::tas58xx::TAS58xx::setup ( )
overridevirtual

Reimplemented from esphome::Component.

Definition at line 82 of file tas58xx.cpp.

◆ SUB_BINARY_SENSOR()

esphome::tas58xx::TAS58xx::SUB_BINARY_SENSOR ( have_fault )

◆ SUB_SELECT()

esphome::tas58xx::TAS58xx::SUB_SELECT ( mixer_mode )

Change input mixer; except if invalid for dac_mode. Written immediately if playing, otherwise when audio starts.

◆ SUB_SWITCH()

esphome::tas58xx::TAS58xx::SUB_SWITCH ( activate )
inline

The activate switch: on activates the amplifier (play), off puts it into deep sleep.

Definition at line 165 of file tas58xx.h.

◆ update()

void esphome::tas58xx::TAS58xx::update ( )
overridevirtual

Implements esphome::PollingComponent.

Definition at line 281 of file tas58xx.cpp.

◆ volume()

float esphome::tas58xx::TAS58xx::volume ( )
inlineoverridevirtual

Implements esphome::audio_dac::AudioDac.

Definition at line 138 of file tas58xx.h.

◆ write_ctrl_state_()

bool esphome::tas58xx::TAS58xx::write_ctrl_state_ ( uint8_t state,
bool muted )
protected

Definition at line 201 of file tas58xx.cpp.

◆ write_dsp_()

void esphome::tas58xx::TAS58xx::write_dsp_ ( )
protected

Write DSP settings not written since last reset; call only while DSP is writable.

Definition at line 275 of file tas58xx.cpp.

◆ write_mixer_()

bool esphome::tas58xx::TAS58xx::write_mixer_ ( )
protected

Definition at line 391 of file tas58xx.cpp.

◆ write_volume_()

bool esphome::tas58xx::TAS58xx::write_volume_ ( )
protected

Definition at line 355 of file tas58xx.cpp.

Field Documentation

◆ analog_gain_db_

float esphome::tas58xx::TAS58xx::analog_gain_db_ {-15.5f}
protected

Definition at line 201 of file tas58xx.h.

◆ ctrl_state_

uint8_t esphome::tas58xx::TAS58xx::ctrl_state_ {0}
protected

Definition at line 209 of file tas58xx.h.

◆ dac_mode_

DacMode esphome::tas58xx::TAS58xx::dac_mode_ {DAC_MODE_BTL}
protected

Definition at line 205 of file tas58xx.h.

◆ enable_pin_

GPIOPin* esphome::tas58xx::TAS58xx::enable_pin_ {nullptr}
protected

Definition at line 196 of file tas58xx.h.

◆ fault_binary_sensors_

std::array<binary_sensor::BinarySensor *, FAULT_SENSOR_COUNT> esphome::tas58xx::TAS58xx::fault_binary_sensors_ {}
protected

Definition at line 198 of file tas58xx.h.

◆ fault_output_pin_

uint8_t esphome::tas58xx::TAS58xx::fault_output_pin_ {FAULT_OUTPUT_NONE}
protected

Definition at line 206 of file tas58xx.h.

◆ logged_faults_

uint32_t esphome::tas58xx::TAS58xx::logged_faults_ {0}
protected

Definition at line 204 of file tas58xx.h.

◆ mixer_mode_

MixerMode esphome::tas58xx::TAS58xx::mixer_mode_ {MIXER_MODE_STEREO}
protected

Definition at line 207 of file tas58xx.h.

◆ mixer_written_

bool esphome::tas58xx::TAS58xx::mixer_written_ {false}
protected

Definition at line 211 of file tas58xx.h.

◆ model_

const ModelInfo* esphome::tas58xx::TAS58xx::model_
protected

Definition at line 195 of file tas58xx.h.

◆ modulation_

Modulation esphome::tas58xx::TAS58xx::modulation_ {MODULATION_BD_MODE}
protected

Definition at line 208 of file tas58xx.h.

◆ power_state_

uint8_t esphome::tas58xx::TAS58xx::power_state_ {0xFF}
protected

Definition at line 210 of file tas58xx.h.

◆ sensor

binary_sensor::BinarySensor* esphome::tas58xx::TAS58xx::sensor
Initial value:
{
binary_sensor::BinarySensor * sensor
Definition tas58xx.h:160
std::array< binary_sensor::BinarySensor *, FAULT_SENSOR_COUNT > fault_binary_sensors_
Definition tas58xx.h:198

Definition at line 160 of file tas58xx.h.

◆ volume_

float esphome::tas58xx::TAS58xx::volume_ {0}
protected

Definition at line 200 of file tas58xx.h.

◆ volume_max_db_

float esphome::tas58xx::TAS58xx::volume_max_db_ {24.0f}
protected

Definition at line 203 of file tas58xx.h.

◆ volume_min_db_

float esphome::tas58xx::TAS58xx::volume_min_db_ {-103.0f}
protected

Definition at line 202 of file tas58xx.h.


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