ES8311-SDK-dat
Example 1: Music Playback
This example demonstrates how to play music using an ESP32-C3 development board. If you are using an ESP32-S3, you simply need to switch the target chip in the project configuration. This guide is based on modifications to the official ESP-IDF example.
1. Locate the Example
Original Path:
esp-idf-v5.4.1\examples\peripherals\i2s\i2s_codec\i2s_es8311-
Action: Copy the
i2s_es8311folder to your local working directory (e.g.,D:\esp32c3\i2s_es8311).
2. Project Setup
- Open VS Code.
- Open the
i2s_es8311project folder.
3. Hardware Pin Configuration
The ES8311 codec connects to the ESP32 via two interfaces:
- I2S: For digital audio data transmission.
- I2C: For chip configuration and control.
Open example_config.h to adjust the pin definitions (usually found between lines 24–35). These are wrapped in conditional compilation blocks depending on the ESP32 model.
For ESP32-C3:
Update the I2C pins (lines 33–34) to match your board. The example below uses GPIO 1 for SCL and GPIO 0 for SDA:
// example_config.h
#define I2C_SCL_IO (GPIO_NUM_1)
#define I2C_SDA_IO (GPIO_NUM_0)pschatzmann/arduino-audio-tools
Install both libraries: You will need both the main arduino-audio-tools and the arduino-audio-driver.
https://github.com/pschatzmann/arduino-audio-driver
https://github.com/pschatzmann/arduino-audio-tools
#include "AudioTools.h"
#include "AudioLibs/AudioBoardES8311.h"
// Define your I2S pins for ESP32-S3
// Default I2S pins for ES8311 on many boards:
// BCLK: 5, LRCK: 4, DOUT: 6, DIN: 7, MCLK: 2
#define I2S_BCLK 5
#define I2S_LRCK 4
#define I2S_DOUT 6
#define I2S_DIN 7
#define I2S_MCLK 2
// Create the driver instance
AudioBoardES8311 board;
void setup() {
Serial.begin(115200);
// Configure the board
auto cfg = board.defaultConfig(TX_MODE);
cfg.bclk = I2S_BCLK;
cfg.lrck = I2S_LRCK;
cfg.dout = I2S_DOUT;
cfg.mclk = I2S_MCLK;
board.begin(cfg);
// Now you can use the board as a stream in AudioTools
// Example: Printing status or using a generator
Serial.println("ES8311 initialized");
}
void loop() {
// Your audio processing logic using board.getI2S() or similar
}