esp-adf/examples/cli

Uart Console example

This example shows how to use periph_console to control esp_audio APIs and system APIs.

Compatibility

ESP32-LyraT	ESP32-LyraT-MSC

Usage

Prepare the audio board:

• Connect speakers or headphones to the board.
• Insert a microSD card loaded with 'test.amr', 'test.flac', 'test.ogg', 'test.opus', 'test.mp3', 'test.wav', 'test.aac', 'test.ts' and 'test.m4a' into board's slot.

Configure the example:

• Select compatible audio board in menuconfig > Audio HAL.
• Set up Wi-Fi SSID and Password by console, refer to system commands join.

Load and run the example.

If the ESP_AUDIO_AUTO_PLAY is opened, it can automatically recognize audio formats, which are added in the auto_decode list.

Supported Commands

Audio Commands

• play n: Play music with given index
• play URI: Play music by given URI, e.g. 'play file://sdcard/test.mp3'.
• pause: Pause the playing music
• resume: Resume the paused music
• stop: Stop the playing music
• setvol: Set volume
• getvol: Get volume
• getpos: Get current position in seconds

System Commands

• reboot: Restart system
• free: Get the free memory
• stat: Show the processor time amongst FreeRTOS tasks
• tasks: Get information about running tasks
• join: Connect Wi-Fi with ssid and password
• wifi: Get connected AP SSID
• led: Show some led bar patterns with ESP32-LyraT-MSC board

Note

• To run stat command, CONFIG_FREERTOS_GENERATE_RUN_TIME_STATS must be enabled in menuconfig > Component Config > FreeRTOS > Enable FreeRTOS to collect run time stats.
• To run tasklist command, CONFIG_FREERTOS_USE_TRACE_FACILITY must be enabled in menuconfig >Component Config > FreeRTOS > Enable FreeRTOS trace facility and Enable FreeRTOS stats formatting functions
• To run aac decoder, CONFIG_FREERTOS_HZ should be 1000 Hz.