ESP-IDF Extra Components

This repository is used to maintain various extra components for ESP-IDF. These components can be installed from ESP Component Registry.

Many of the components in this repository are wrappers around third-party libraries, such as zlib, libpng, etc. There are also various components developed by Espressif which don't currently fit into another repository (like esp-protocols, esp-usb, esp-iot-solution, etc).

Related Projects

• ESP-IDF
• ESP Component Registry
• IDF Component Manager
• ESP IOT Solution
• ESP Protocols
• ESP USB

Contribution

We welcome contributions to idf-extra-components repository!

You can contribute by fixing bugs, adding features, adding documentation or reporting an issue. We accept contributions via Github Pull Requests.

Before reporting an issue, make sure you've searched for a similar one that was already created.

Build Documentation Locally

Components that ship a programming guide live in <component>/docs/ with an mdBook book.toml. Install the prerequisites first:

• Python 3.11+
• mdbook
• mdbook-mermaid (cargo install mdbook-mermaid --locked)
• doxygen
• esp-doxybook (python3 -m pip install -r .github/tools/requirements-docs.txt)

Build all component docs:

python3 .github/tools/build_docs.py --output-dir docs_build_output

The builder discovers every docs/book.toml, validates all required tools before starting (mdBook preprocessors such as mdbook-mermaid are detected from the book configuration), builds every component, and reports all failed components at the end. Output is generated under docs_build_output/. The same script is used by the Build and Deploy Programming Guides workflow.

Adding New Components

Please note that this repository is intended for components maintained by Espressif developers. If you don't work at Espressif and you'd like to publish a component to the ESP Component Registry, please set up a separate repository for your component. You can find more information about this in the IDF Component Manager documentation. You can also check out the talk about developing and publishing components from Espressif DevCon 2023. Feel free to open an issue if you encounter any problem.