Below is the release information for ESP-ADF v2.7. Documentation is available here. For supported IDF versions, please check here.
Changelog
This is the list of changes since release v2.6:
Breaking Changes
- Changed the prototype of the audio recorder callback.
- Added breaking changes to
wifi_config_t
in theperiph_wifi_init
configuration. - Updated ESP-RTC to version
v1.2.0
with breaking changes.
Framework
Features
- Added support for ESP-IDF V5.3.
- Modified
algorithm_stream
to supportesp-sr nsnet
. - Updated
i2s_stream
to support IDF v5.x I2S APIs. - Made
user_agent
configurable inhttp_stream
. - Added support for the ESP32-S3-BOX-3 board.
- Added support for the ESP32-P4-FUNCTION-EV-BOARD.
- Added installation and export scripts to simplify the configuration of the build environment.
- Added the audio mixer component.
- Added support for getting and setting element handles in the ring buffer.
- Updated the supported MicroPython version to
5114f2c1e
. - Updated the
es7210
driver.
Bug Fixes
- Corrected the API return value descriptions for
audio_element_multi
APIs. - Fixed an issue where
PWM_stream
could cause sound loss due to early IO_DONE. - Fixed the default configuration issue for PDM RX.
- Fixed a hardcoded partition size issue in
tts_stream
. - Fixed a bug in
tcp_client_stream
that occurred when the TCP connection failed. - Fixed the
ADF_VER
error when not under the ADF subfolder.
Audio Recorder
Features
- Added a warning to indicate the deprecated state in
recorder_engine
. - Added support for multiple wakeup words.
- Introduced a new prototype for the audio recorder callback.
- Added
wakenet
index in the wakeup result. - Enhanced VAD and MN detection reporting when
WakeNet
is disabled.
Bug Fixes
- Fixed errors when building
micropython-adf
. - Fixed a crash if the WakeNet model is missing.
- Restored the ability to select the wake word at runtime.
Peripherals
Features
- Added
i2c_bus_run_cb
for i2c_bus. - Added an API for allocating peripheral IDs.
Bug Fixes
- Fixed crashes that occurred when Wi-Fi disconnected in power save mode.
- Resolved an issue where the LCD did not display properly on IDF v5.x.
- Added checks to ensure that BluFi is enabled around calls to
ble_config_start
orble_config_stop
. - Fixed an issue with ISR Level 1 being unavailable on IDF v5.2.
- Added support for I2C master mode.
- Fixed issues with SPI card and ESP actions.
- Properly handled the
WIFI_REASON_ROAMING
event. - Added
wifi_config_t
toperiph_wifi_init
configuration.
ADF Components Registry
The following components have been newly released to the Espressif Components Registry:
-
- Added
esp_audio_decoder
. - Added
esp_audio_simple_decoder
. - Updated
esp_audio_encoder
APIs.
- Added
-
- Added support for the
aw88298
audio amplifier. - Added support for
IDF v5.3
withesp_driver_i2c
.
- Added support for the
-
- Added support for CAF and OGG container
- Added RAM cache to improve write speed
- Added support for H264 frame type parsing, always write new slice at IDR frame boundary
ESP-RTC
Features
- Updated
esp_rtc
to v1.2.0. - Renamed API
esp_rtc_init/deinit
toesp_rtc_service_init/deinit
to avoid conflicts with IDF. - Enhanced DTMF send/receive logic and allowed registering callbacks to receive raw DTMF data.
- Added support for parsing large XML with UPNP.
Bug Fixes
- Fixed SIP invite response error due to missing SDP.
Services
Features
- Added a function to get the connected A2DP device.
- Updated
DuerOS
to versionv3.2
to supportWenXinYiYan
.
Bug Fixes
- Enabled or disabled AEC based on hardware design.
- Accelerated OTA upgrades using DRAM.
ESP Audio Codec Libraries
Features
- Supported MP4 playback where
mdat
precedesmoov
. - Added support for multi-track MP4 stream playback.
- Updated
esp_audio
to versionv1.8.0
.
Bug Fixes
- Fixed a bug causing stereo output when
AAC_PLUS
was enabled and AAC had SBR. - Fixed a decoding error for AAC SBR with a sample rate greater than 24kHz.
- Fixed an issue where the FLAC decoder did not add bitrate information.
- Corrected APIC comment and composer parsing for ID3.
- Resolved an issue where MP3 did not skip info tag frames and pad data.
- Fixed a bug in AAC channel parsing where the ADTS ID did not match.
- Fixed an issue where the downmixer was closed if the input and output channels were equal.
Examples
Features
- Added
audio_mixer_tone
example atexamples/advanced_examples/audio_mixer_tone
.
Bug Fixes
- Fixed exceptions caused by the new I2S API in the
www
example. - Corrected the result returned by
src_drv_adc_slide_filter()
. - Resolved partition size issues in Bluetooth examples.
- Corrected misspellings of "length" in the
google-tts
example logs. - Fixed downmix pipeline RB timeout errors.
Documentation
- Corrected typos and improved API descriptions.
- Updated the EOL boards (ESP32-LyraT, ESP32-LyraTD-MSC, ESP32-S2-Kaluga-1 Kit, and ESP32-Korvo-DU1906 have reached their end of life).
Get This Release
To obtain ESP-ADF v2.7, it is highly recommended to use the following git commands. Make sure to update the submodules as well (using git submodule update --init --recursive
) to ensure the source files work properly.
git clone https://github.com/espressif/esp-adf.git esp-adf-v2.7
cd esp-adf-v2.7
git checkout v2.7
git submodule update --init --recursive
To get the programming guide for Audio Development Framework, please check here.