Skip to content

ESP-ADF Release v2.1

Compare
Choose a tag to compare
@jason-mao jason-mao released this 24 Jul 03:34
· 1067 commits to master since this release

Below is the release information of ESP-ADF v2.1, and its documentation is available here.

Changes since v2.0

Major New Features

Pipeline Framework

New Features

  • Added esp_event_cast for event broadcasting
  • Added audio_thread to support stack on external memory

Bugfix

  • Fixed the issue that audio_element_run return value is overridden
  • Fixed the bug that space is encoded as a wrong character in URL
  • Fixed the bug that the stop opening element gets status incorrectly
  • Fixed the bug that element is_open flag is cleared on the AEL_STATE_INIT state
  • Fixed the thread safe issue in the audio element APIs
  • Cleared the dead code in audio_pipeline_stop
  • Fixed the audio pipeline failure when compiled with cpp

Playlist

New Features

  • Added the get_url_id API
  • Added the reset API
  • Added the exit API
  • Added the remove_by_url API
  • Added the remove_by_id API

Service Framework

New Features

  • Added the Wi-Fi SSID and Password manager
  • Added the OTA service
    • Support event callback
    • Support comparison between binary versions
  • Added a battery service for monitoring the battery voltage
  • Added a coredump service to trace the crash reason
  • Added the aw2013 driver to display service
  • Added support for wifi_service reconnect infinite times

Bugfix

  • Fixed the issue that the wifi_service cannot reconnect automatically
  • Fixed the failure that occurs when the wifi_service_ destroy API is called for more than once

ESP Peripherals

New Features

  • Added wpa2 in periph_wifi
  • Replaced malloc, calloc and free APIs with audio_malloc, audio_ calloc and audio_ free APIs

Bugfix

  • Fixed a bug that periph_led can't work with multi-LED

Support New Development Board

Audio Stream

New Features

  • Added TCP stream
  • Added PWM stream
  • Added a version field in the tone stream

Bugfix

  • Fixed a bug that m3u8 stream is blocked

ESP Codec and Filter Libraries

You can find the released codec and filter libraries here.

New Features

  • Added G711 encoder and decorder

Bugfix

  • Fixed a bug that esp_processing gets pop noise when the complexity is greater than 1

ESP Audio

Bugfix

  • Improved the esp_audio_stop response time
  • Fixed an issue that raw URL play is blocked

ADF Micropython

Bugfix

  • Fixed a bug that micropython build error occurs with the latest ADF

Audio Protocol

New Features

  • SIP
    • Added support for SIP UPDATE
    • Added support to use RANDOM RTP/SIP port
    • Added support for custom headers
    • Added support to send the OPTION NAT method packet on call
    • Added support to retransmit for register failure
  • DLNA
    • Added support for customized devicelist and notify

Bugfix

  • Fixed an issue that SIP drops non-current session method
  • Fixed the UPNP notify heap corrupt issue
  • Improved to reduce DLNA memory

Docs

  • Updated ESP-ADF readme to support multi-chips
  • Added the esp32-korvo-du1906 board readme
  • Added the Chinese translation for LyraT user guide

New Examples of ESP-ADF

Below are the added examples that demonstrate the usage of ESP-ADF components:

Get This Release

Using git commands below to obtain ESP-ADF v2.1 is highly recommended. Note that the submodules should also be updated (using git submodule update --init --recursive). Otherwise, the source files may be not working properly.

git clone https://github.com/espressif/esp-adf.git esp-adf-v2.1
cd esp-adf-v2.1/
git checkout v2.1
git submodule update --init --recursive

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