Skip to content

ESP-ADF Release v2.8

Latest

Choose a tag to compare

@jason-mao jason-mao released this 17 Mar 00:33
· 6 commits to release/v2.x since this release

Below is the release information for ESP-ADF v2.8. Documentation is available here. For supported IDF versions, please check here.

Changelog

This is the list of changes since release v2.7 (from commit 9cf556de500019bb79f3bb84c821fda37668c052 to current release/v2.x HEAD).

Framework

Features

  • Updated the IDF submodule to tag v5.5.3.
  • Added multiple key support for HLS in http_stream.
  • Added support for encoding zip data into gzip format in audio_stream.
  • Added support for C++ compilation (Cpp build).
  • Added Windows PowerShell script to install ESP-IDF and set environment variables.
  • Updated export script to support different shells (e.g. bash, zsh).
  • Added AEC stream and AEC stream example; added esp32_p4_function_ev_sub_board.

Bug Fixes

  • Fixed i2s_stream expansion failure on IDF 5.x.
  • Fixed I2S stream mono mode issue.
  • Fixed a bug where a single element in the pipeline was linked to an uninitialized ring buffer.
  • Fixed duplicate start/pause exception in AEC stream.
  • Fixed I2S slot_mask incorrectly set during mono recording on ESP32-LyraT-MINI.
  • Fixed memory leak in algorithm_stream.

Peripherals

Features

  • Supported ADC API of IDF 5.x in adc_button.
  • Updated WS2812 driver to use the new RMT driver.
  • Added support for ESP32-LyraT-MINI to use ES7243E ADC chip.
  • Updated Korvo-2L LCD driver.
  • Added ESP32-S3-ATOM (atoms3r) board.

Bug Fixes

  • Fixed P4 SD card mount failure.
  • Fixed codec initialization crash when PA GPIO is configured as NC (not connected).
  • Improved ES8311 I2C stability.
  • Fixed ESP32-LyraT-MINI ADC chip selection issue in Micropython.
  • Fixed esp_hosted being linked without use on ESP32-P4.

ESP Codec Device(esp_codec_dev)

Features

  • Updated esp_codec_dev to v1.3.5: added ES8389 codec; fixed I2S PDM play noise; added read/write register APIs; disabled CONFIG_CODEC_I2C_BACKWARD_COMPATIBLE by default.
  • Added support for CJC8910 codec.

Bug Fixes

  • Fixed lock issue for multiple I2S interfaces.
  • Fixed racing condition when playback/record is re-enabled while another is running.
  • Fixed name error in some macro definitions for ES7210.
  • Fixed ES8374 and ES8388 volume setting error.
  • Fixed mute wrong behavior for codec without codec_if (software volume).

ESP Audio Codec Libraries (esp-adf-libs)

Features

  • Updated esp_audio to v1.8.2.
  • Adapted media_lib_sal component.
  • Adapted media protocols component.
  • Added support for AAC splicing stream decode.
  • Updated esp_audio to v1.8.1; added resample_ch in esp_audio_cfg_t.
  • Added support for MP1 and MP2 playback; fixed m4a not checking in_el.

Bug Fixes

  • Fixed buffer overrun in audio_forge sonic module when reusing mono-channel buffer during channel switch (stereo target).
  • Fixed MP3 pause then resume error.
  • Fixed ID3 frame size not being checked.
  • Fixed esp_new_jpeg decoding error for images containing restart markers; optimized decoder error handling.
  • Fixed esp_new_jpeg inaccurate inbuf_remain in jpeg_dec_io_t after decode; fixed memory alignment and test_app bugs.
  • Fixed esp_new_jpeg memory issue.

Examples

Features

  • Added dual mic config for AEC example.
  • Supported dual eyes UI by AVI player; added dual eyes display example.
  • Added BluFi command in CLI example.
  • Added esp_coze component and coze example.
  • Updated esp_coze to v0.6.0; updated coze_ws_app (esp_coze v0.6, ESP-GMT v0.7); added support for opus, g711a/u decoding and encoding.
  • DuerOS: overwrite dueros response handler; update userAgent in profile; support voice id select.
  • Volc RTC: updated to v1.0.6; added support for ESP32-P4; added volc RTC example for ESP32/ESP32-S3; updated lib to 1.0.3 and test account.

Bug Fixes

  • Improved Kconfig descriptions in audio_mixer_tone example.
  • Corrected spelling in examples.
  • Fixed MRM crash and RTC flash tone offset; use standalone framesize enum.
  • Fixed VoIP example pop voice on mini board.
  • Fixed google translate device example.
  • Fixed coze websocket version and kconfig dependency; fixed IDF version dependency issue.
  • Fixed VolcRTC example build exception.
  • Fixed ESP-RTC example audio tone playing no sound.

Documentation

Features

  • Added codespell checker for docs.
  • Reverted title to avoid confusion with ESP-IDF for ADF v2.x (e.g. "Advanced development framework").
  • Updated quickstart and renamed to "Espressif Advanced Development Framework".
  • Added new knowledge base chapter.
  • Updated V3.1 schematic for S3-Korvo-2; updated description of ESP32-S3-Korvo.
  • Added note for ESP32-LyraT v4.3.
  • Enabled page redirection for old links.
  • Updated conf_common.py and fixed get started link.

Bug Fixes

  • Fixed incorrect fourcc code in docs.
  • Fixed equalizer docs error.
  • Fixed typo and Doxyfile issue causing newer Doxygen versions to fail.
  • Removed unnecessary software design section and files.
  • Fixed broken link in ESP32-C3-Lyra.

CI

  • Supported esp-idf v5.5 and v5.4; added esp32p4 in CI.
  • Reduced CI test time to 50% of the original duration.

Get This Release

To obtain ESP-ADF v2.8, 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.8

cd esp-adf-v2.8

git checkout v2.8

git submodule update --init --recursive

To get the programming guide for Audio Development Framework, please check here.