Espressif Audio Development Framework
Switch branches/tags
Nothing to show
Clone or download
jason-mao Merge branch 'feature/docs_microsemi_driver' into 'master'
Include Microsemi ZL38063 driver in documentation

See merge request adf/esp-adf-internal!211
Latest commit 5d73886 Nov 14, 2018

README.md

Espressif Audio Development Framework

Documentation Status

Espressif Systems Audio Development Framework (ESP-ADF) is the official audio development framework for the ESP32 chip.

Overview

ESP-ADF supports development of audio applications for the Espressif Systems ESP32 chip in the most comprehensive way. With ESP-ADF, you can easily add features, develop audio applications from simple to complex:

  • Music player or recorder supports audio formats such as MP3, AAC, WAV, OGG, AMR, TS, SPEEX ...
  • Play music from sources: HTTP, HLS(HTTP Live Streaming), SDCARD, Bluetooth A2DP/HFP
  • Integrate Media services such as: DLNA, WeChat ...
  • Internet Radio
  • Voice recognition and integration with online services such as Alexa, DuerOS, ...

As a general, the ESP-ADF features will be supported as shown below:

ADF Block diagram

Developing with the ESP-ADF

Quick Start

You need the ESP32 LyraT board and headphone connected, make sure you clone the project recursive:

git clone --recursive https://github.com/espressif/esp-adf.git 
cd esp-adf/examples/get-started/play_mp3
make menuconfig
make flash monitor

If you clone project without --recursive flag, please goto the esp-adf directory and run command git submodule update --init before doing anything.

Hardware

Espressif Systems has released a number of support boards for ESP-ADF to develop ESP32 audio applications, including:

ESP32-Lyrat

ESP32 LyraT Getting Started Guide

Block diagram

ESP32-Lyrat-V4.2

ESP-IDF

ESP-ADF is based on the application layer of ESP-IDF (Espressif IoT Development Framework). The git clone command, described under Quick Start above, automatically downloads specific version of the ESP-IDF alongside with ESP-ADF. Please take a look at Get Started

Examples

Check folder examples that contains sample applications to demonstrate API features of the ESP-ADF.

Resources