Skip to content

Latest commit

 

History

History
 
 

examples

README.md

Examples

This directory contains a growing number of simple example projects for ESP-ADF. These are intended to show basic esp-adf functionality, and to provide code samples you can use for your own projects.

If you are new to the esp-adf, see Getting Started documentation for step-by-step instructions on how to use examples.

Compatibility of examples with Espressif audio boards is presented in tables below.

ESP32 Usage

ESP32-S2 Usage

ESP32-S3 Usage

ESP32-C3 Usage

Compatibility of Examples with Espressif Audio Boards

No. Example Name / Board Name --> ESP32-LyraT ESP32-LyraTD-MSC ESP32-LyraT-Mini ESP32-Korvo-DU1906 1 ESP32-S2-Kaluga-1 Kit ESP32-S3-Korvo-2 ESP32-C3-Lyra
. Link to the Board Getting Started Guide --> alt text alt text alt text alt text alt text alt text alt text
. Espressif Chip installed on the Board --> ESP32 ESP32 ESP32 ESP32 ESP32-S2 ESP32-S3 ESP32-C3
1 advanced_examples/algorithm alt text alt text alt text alt text alt text alt text alt text
2 advanced_examples/dlna alt text alt text alt text alt text alt text alt text alt text
3 advanced_examples/downmix_pipeline alt text alt text alt text alt text alt text alt text alt text
4 advanced_examples/esp_dispatcher_dueros alt text alt text alt text alt text alt text alt text alt text
5 advanced_examples/flexible_pipeline alt text alt text alt text alt text alt text alt text alt text
6 advanced_examples/http_play_and_save_to_file alt text alt text alt text alt text alt text alt text alt text
7 advanced_examples/multi-room alt text alt text alt text alt text alt text alt text alt text
8 advanced_examples/nvs_dispatcher alt text alt text alt text alt text alt text alt text alt text
9 protocols/voip alt text alt text alt text alt text alt text alt text alt text
10 advanced_examples/wifi_bt_ble_coex 2 alt text alt text alt text alt text alt text alt text alt text
11 audio_processing/pipeline_alc alt text alt text alt text alt text alt text alt text alt text
12 audio_processing/pipeline_audio_forge alt text alt text alt text alt text alt text alt text alt text
13 audio_processing/pipeline_equalizer alt text alt text alt text alt text alt text alt text alt text
14 audio_processing/pipeline_passthru alt text alt text alt text alt text alt text alt text alt text
15 audio_processing/pipeline_resample alt text alt text alt text alt text alt text alt text alt text
16 audio_processing/pipeline_sonic alt text alt text alt text alt text alt text alt text alt text
17 audio_processing/pipeline_spiffs_amr_resample alt text alt text alt text alt text alt text alt text alt text
18 checks/check_board_buttons alt text alt text alt text alt text alt text alt text alt text
19 checks/check_display_led alt text alt text alt text alt text alt text alt text alt text
20 cli alt text alt text alt text alt text alt text alt text alt text
21 cloud_services/google_translate_device alt text alt text alt text alt text alt text alt text alt text
22 cloud_services/pipeline_aws_polly_mp3 alt text alt text alt text alt text alt text alt text alt text
23 cloud_services/pipeline_baidu_speech_mp3 alt text alt text alt text alt text alt text alt text alt text
24 dueros alt text alt text alt text alt text alt text alt text alt text
25 get-started/pipeline_a2dp_sink_and_hfp alt text alt text alt text alt text alt text alt text alt text
26 get-started/play_mp3_control alt text alt text alt text alt text alt text alt text alt text
27 get-started/pipeline_tcp_client alt text alt text alt text alt text alt text alt text alt text
28 ota alt text alt text alt text alt text alt text alt text alt text
29 korvo_du1906 2 alt text alt text alt text alt text alt text alt text alt text
30 player/pipeline_a2dp_sink_stream alt text alt text alt text alt text alt text alt text alt text
31 player/pipeline_a2dp_source_stream alt text alt text alt text alt text alt text alt text alt text
32 player/pipeline_bt_sink alt text alt text alt text alt text alt text alt text alt text
33 player/pipeline_bt_source alt text alt text alt text alt text alt text alt text alt text
34 player/pipeline_embed_flash_tone alt text alt text alt text alt text alt text alt text alt text
35 player/pipeline_flash_tone 3 alt text alt text alt text alt text alt text alt text alt text
36 player/pipeline_hfp_stream alt text alt text alt text alt text alt text alt text alt text
37 player/pipeline_http_mp3 3 alt text alt text alt text alt text alt text alt text alt text
38 player/pipeline_http_select_decoder alt text alt text alt text alt text alt text alt text alt text
39 player/pipeline_living_stream 3 alt text alt text alt text alt text alt text alt text alt text
40 player/pipeline_play_sdcard_music alt text alt text alt text alt text alt text alt text alt text
41 player/pipeline_sdcard_mp3_control alt text alt text alt text alt text alt text alt text alt text
42 player/pipeline_tts_stream alt text alt text alt text alt text alt text alt text alt text
43 player/pipeline_spiffs_mp3 3 alt text alt text alt text alt text alt text alt text alt text
44 player/pipeline_play_mp3_with_dac_or_pwm alt text alt text alt text alt text alt text alt text alt text
45 recorder/element_cb_sdcard_amr alt text alt text alt text alt text alt text alt text alt text
46 recorder/element_wav_amr_sdcard alt text alt text alt text alt text alt text alt text alt text
47 recorder/pipeline_raw_http alt text alt text alt text alt text alt text alt text alt text
48 recorder/pipeline_wav_amr_sdcard alt text alt text alt text alt text alt text alt text alt text
49 recorder/pipeline_recording_to_sdcard alt text alt text alt text alt text alt text alt text alt text
50 speech_recognition/wwe alt text alt text alt text alt text alt text alt text alt text
51 speech_recognition/vad alt text alt text alt text alt text alt text alt text alt text
52 system/battery alt text alt text alt text alt text alt text alt text alt text
53 system/coredump alt text alt text alt text alt text alt text alt text alt text
54 system/wpa2_enterprise alt text alt text alt text alt text alt text alt text alt text
55 display/lcd_jpeg alt text alt text alt text alt text alt text alt text alt text
56 display/music_player alt text alt text alt text alt text alt text alt text alt text
57 display/lcd_camera alt text alt text alt text alt text alt text alt text alt text
58 display/led_pixels alt text alt text alt text alt text alt text alt text alt text
59 recorder/av_muxer_sdcard alt text alt text alt text alt text alt text alt text alt text
60 protocols/rtmp alt text alt text alt text alt text alt text alt text alt text
61 protocols/esp-rtc alt text alt text alt text alt text alt text alt text alt text
62 protocols/esp-rtsp alt text alt text alt text alt text alt text alt text alt text

Note 1: The key layout of ESP32-Korvo-DU1906 is slightly different from other official audio development boards. The REC, MODE, and PLAY keys are not defined, so the examples requiring operation on these keys may not work properly.
Note 2: This example involves the coexistence of Wi-Fi, A2DP, HFP, and Bluetooth LE, so the optimized coexistence IDF branch audio/stack_on_psram_v3.3 is used in this example.
Note 3: If you use the ESP32-C3-Lyra development board to run these routines, you need to apply $ADF_PATH/idf_patches/idf_v4.4_i2s_c3_pdm_tx.patch in the $IDF_PATH directory to obtain PDM support.