TAS58xx

The tas58xx platform allows your ESPHome devices to use the Texas Instruments TAS58xx family of stereo Class-D audio amplifiers with digital (I²S) input. This allows the playback of audio via the microcontroller from a range of sources via Speaker or Media Player.

Supported models:

tas5805m: TAS5805M

The I²C bus is required in your configuration as this is used to configure the amplifier and read its fault status. Audio data is delivered via I²S, for example with the I²S Audio Speaker.

# Example configuration entry
audio_dac:
  - platform: tas58xx
    model: tas5805m
    id: amp

Configuration Variables

model (Required, enum): The amplifier model. One of the supported models listed above.
enable_pin (Optional, Pin): The pin connected to the PDN (power down) pin of the amplifier. During setup the pin is briefly driven low and then high to power up the amplifier cleanly. Omit if PDN is hardwired high. Without this pin, and with PDN not pulled high, the amplifier does not respond on I²C and setup fails.
ignore_enable_pin_warning (Optional, boolean): Set to true to hide the config validation warning shown when enable_pin is not set. Use this when PDN is hardwired high. Cannot be used together with enable_pin. Defaults to false.
analog_gain (Optional, dB): The analog gain of the output stage, in 0.5dB steps. Use it to match the output swing to the supply voltage. Range: -15.5dB to 0dB. Defaults to -15.5dB, the lowest gain.
dac_mode (Optional, enum): How the output stage drives the speakers. Defaults to btl.
- btl: Bridge tied load, two speakers (stereo).
- pbtl: Parallel bridge tied load, one speaker driven by both output channels. Requires mixer_mode to be mono, left or right.
mixer_mode (Optional, enum): How the left and right input channels are routed to the outputs. Defaults to stereo.
- stereo: Left input to the left output, right input to the right output.
- stereo_inverse: Left and right swapped.
- mono: Left and right mixed (each at -6 dB) to both outputs.
- left: Left input to both outputs.
- right: Right input to both outputs.
volume_min_db (Optional, dB): The digital volume that maps to the minimum volume (0%). Must be less than volume_max_db. Range: -103dB to 24dB. Defaults to -103dB.
volume_max_db (Optional, dB): The digital volume that maps to the maximum volume (100%). Must be greater than volume_min_db. Range: -103dB to 24dB. Defaults to 24dB.
address (Optional, int): The I²C address of the amplifier. The address is selected with a resistor on the ADR pin (see the datasheet). Defaults to 0x2D.
update_interval (Optional, Time): How often the fault and power state registers are read. Defaults to 1s.
i2c_id (Optional, ID): The ID of the I²C bus the amplifier is connected to.
All other options from Audio DAC.

The volume is mapped linearly in dB between volume_min_db and volume_max_db, in 0.5dB steps. A volume of 0% is not silent unless volume_min_db is -103dB; use the Audio DAC mute actions to silence the output.

TIP

Digital volume above 0dB can clip full-scale audio. Set volume_max_db to 0dB or lower when the source plays at full scale, and use analog_gain to set the maximum output level.

Several amplifiers, of the same or different models, can be used in one configuration. Log messages for faults and power state changes start with the I²C address of the amplifier.

Operation

The amplifier enters play mode after setup. It stays in Hi-Z (outputs off) until an I²S clock is present, and the mixer settings from mixer_mode are written each time the device enters play mode.

The fault registers are read every update_interval, and a log message is written each time a fault appears or clears. Faults that only report a past event are cleared automatically, so the fault state follows the current condition. The ADR pin is configured as a fault output after startup, since the I²C address is only latched at power up.

IMPORTANT

DC and over current faults are not cleared automatically. After one of these faults the output stays off until tas58xx.activate is called or the amplifier is power cycled. Fix the cause of the fault first.

Automations

`tas58xx.activate` Action

Clears faults, wakes the amplifier from deep sleep and switches it to play mode. The device waits in Hi-Z until an I²S clock is present. This action also restarts the output after a DC or over current fault.

on_...:
  - tas58xx.activate: amp

Configuration variables:

id (Required, ID): The ID of the tas58xx platform.

`tas58xx.deactivate` Action

Puts the amplifier into deep sleep, its lowest power state that keeps the I²C interface and DSP running. Settings are kept, and tas58xx.activate resumes playback.

on_...:
  - tas58xx.deactivate: amp

Configuration variables:

id (Required, ID): The ID of the tas58xx platform.

All Audio DAC Automations are supported by this platform as well.

Binary Sensor

The tas58xx binary sensor platform exposes the fault status of the amplifier. Each sensor is ON while the fault is present and is updated every update_interval of the tas58xx platform.

binary_sensor:
  - platform: tas58xx
    have_fault:
      name: "Amplifier Fault"

Binary Sensor Configuration Variables

tas58xx_id (Optional, ID): The ID of the tas58xx platform. Required when more than one amplifier is configured.
have_fault (Optional): ON when any of the faults below is present, except clock_fault and over_temp_warning.
left_channel_dc_fault (Optional): DC offset detected on the left output.
right_channel_dc_fault (Optional): DC offset detected on the right output.
left_channel_over_current (Optional): Over current on the left output.
right_channel_over_current (Optional): Over current on the right output.
pvdd_over_voltage (Optional): PVDD supply voltage too high.
pvdd_under_voltage (Optional): PVDD supply voltage too low.
over_temp_shutdown (Optional): The device shut down because it is too hot.
over_temp_warning (Optional): The device temperature is close to the shutdown threshold. Logged as a warning.
otp_crc_check (Optional): The CRC check of the internal OTP memory failed.
bq_write_failed (Optional): Writing the biquad filter coefficients failed.
clock_fault (Optional): The I²S clock is missing or invalid. This is normal whenever no audio is playing, so it is not logged and not included in have_fault.

All sensors accept the options from Binary Sensor. They default to the problem device class and the diagnostic entity category.

Configuration Examples

Stereo Speakers

i2c:
  sda: GPIOXX
  scl: GPIOXX

i2s_audio:
  - id: i2s_output
    i2s_lrclk_pin: GPIOXX
    i2s_bclk_pin: GPIOXX

audio_dac:
  - platform: tas58xx
    model: tas5805m
    id: amp
    enable_pin: GPIOXX
    volume_max_db: 0dB

speaker:
  - platform: i2s_audio
    id: amp_speaker
    i2s_audio_id: i2s_output
    i2s_dout_pin: GPIOXX
    dac_type: external
    channel: stereo
    audio_dac: amp

Single Speaker (PBTL)

audio_dac:
  - platform: tas58xx
    model: tas5805m
    id: amp
    dac_mode: pbtl
    mixer_mode: mono

Deep Sleep When Idle

media_player:
  - platform: speaker
    # ...
    on_play:
      - tas58xx.activate: amp
    on_idle:
      - tas58xx.deactivate: amp