espressif/esp-adf
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions 1
No description
2,091 commits 3 branches 15 tags 178 MiB
  • C 90.1%
  • Python 7.4%
  • CMake 1.2%
  • Shell 0.7%
  • HTML 0.3%
  • Other 0.3%
Find a file
Exact
Jason-mao 0b335632ac
Some checks failed
Push components to Espressif Component Service / upload_components (push) Has been cancelled
Details
Merge branch 'ci/persist_apps_path_json' into 'master' 
ci(ci): Persist apps_path.json and limit P4 to IDF 6.0

See merge request adf/esp-adf-internal!1576
2026-08-14 18:07:51 +08:00
.github feat(esp_media_service): Add initial version of media service 2026-07-17 10:35:57 +08:00
.gitlab/ci ci(ci): Persist apps_path.json and limit P4 to IDF 6.0 2026-08-14 16:23:27 +08:00
adf_examples ci(ci): Persist apps_path.json and limit P4 to IDF 6.0 2026-08-14 16:23:27 +08:00
components ci(ci): Persist apps_path.json and limit P4 to IDF 6.0 2026-08-14 16:23:27 +08:00
docs feat(docs): Update the ADF v3.0 readme and diagram 2025-12-18 10:33:15 +08:00
tools feat(esp_media_service): Add initial version of media service 2026-07-17 10:35:57 +08:00
.codespellrc feat(examples): Add esp_audio_analyzer_app and componentize esp_adf_examples 2026-04-17 11:42:32 +08:00
.editorconfig Init public version 2018-04-03 17:44:04 +08:00
.gitignore feat(adf_service): Add ADF service platform and first-party capabilities 2026-04-30 18:37:55 +08:00
.gitlab-ci.yml ci(.gitlab): Trigger child pipelines for different IDF versions 2026-04-28 20:30:38 +08:00
.gitmodules refactor(esp-adf): Delete the adf 2.x codes 2026-04-13 17:48:44 +08:00
.pre-commit-config.yaml feat(esp_coze): Update esp_coze version to v1.0 2026-05-12 21:34:28 +08:00
CMakeLists.txt refactor(esp-adf): Delete the adf 2.x codes 2026-04-13 17:48:44 +08:00
conftest.py ci(.gitlab): Update conftest.py for support idf_parametrize 2026-04-30 14:18:52 +08:00
LICENSE Update LICENSE 2018-04-04 23:40:09 +08:00
pytest.ini ci(.gitlab): Update conftest.py for support idf_parametrize 2026-04-30 14:18:52 +08:00
README.md feat(docs): Update the ADF v3.0 readme and diagram 2025-12-18 10:33:15 +08:00
README_CN.md feat(docs): Update the ADF v3.0 readme and diagram 2025-12-18 10:33:15 +08:00

README.md

Espressif Advanced Development Framework

中文版

⚠️ Important

The master branch contains the new features for ADF v3.0, which are actively developed and incompatible with previous versions. For the stable ADF v2.x version, please switch to the release/v2.x branch.

Overview

ESP-ADF (Espressif Advanced Development Framework) is Espressif’s official advanced application-layer development framework, designed to simplify the development of audio, video, and IoT products.

ADF v3.0 represents a major architectural upgrade, completely redesigned and incompatible with ADF v2.x. It focuses on product-oriented functionality, modular services, and low resource consumption.

ESP-ADF vs ESP-IDF

  • ESP-IDF is the base SDK for Espressif chips, offering low-level components such as OS, drivers, network stack, Bluetooth, etc.
  • ESP-ADF is built on top of ESP-IDF, providing high-level product-oriented services, such as audio/video playback, battery service, OTA, and more.

✅ ADF v3.0 Features

ADF v3.0 is a product-oriented development framework with significant architectural changes that are completely incompatible with previous ADF versions. Key features include:

  • ESP-GMF Integration: Core media pipeline restructured using ESP-GMF (General Multimedia Framework)
  • Standalone Components: Functional components such as playlist can run independently
  • Product Services: Modular services for audio playback, video playback, battery monitoring, and more
  • MCP Support: Product services are callable via Model Context Protocol (MCP)
  • Multi-Product Support: Designed for audio, video, and IoT products
  • Resource Efficient: Optimized for low memory and CPU usage
  • Multi-Language App Support: Supports development in MicroPython, Arduino, and C/C++

ADF v3.0 Block Diagram

ADF Block Diagram

Platform Requirements

  • ESP-IDF Version: v5.5.2 or later

Branch Strategy

  • release/v2.x: Legacy ADF implementation (v2). Receives only bug fixes and minor enhancements. See ADF v2.x Documentation for reference.

  • master: Development branch for ADF v3.0. Not compatible with v2.x APIs or behavior.

Documentation

  • ADF v3.0 documentation: Coming soon.
  • ADF v2.x documentation: Available at docs.espressif.com

Roadmap

  • Functional Modules: e.g., Playlist, Board Manager
  • Service Layer: e.g., Wi-Fi Service with MCP (Model Context Protocol) support
  • AI Service Integration: e.g., OpenAI, Coze, etc.
  • Expanded set of reusable product service plugins