IDF Component Manager and ESP Component Registry Documentation

This documentation is for the IDF Component Manager and the ESP Component Registry. The IDF Component Manager is a tool that allows developers to easily and reliably add components developed by Espressif and the community to the projects developed with the ESP-IDF framework and create their own components for others to use.

The ESP Component Registry <https://components.espressif.com> is a central repository for components that can be used with the ESP-IDF via the IDF Component Manager.

With the IDF Component Manager, developers can easily install components from the ESP Component Registry, streamlining the process of adding new functionality to their projects.

Getting Started

• Getting Started
  • Checking the IDF Component Manager Version

Reference

• Compote CLI
  • compote
• Manifest File idf_component.yml Format Reference
  • Dependencies
  • ESP-IDF Version
  • Matches and Rules
  • Examples
  • Choosing What Files to Upload
  • Environment Variables in Manifest
  • Special Rules
• IDF Component Manager Configuration File
  • Configuration File
  • Usage
• Versioning
  • Versioning Scheme
  • Version Precedence
  • Range Specifications
  • Version Solving

Guides

• Packaging ESP-IDF Components
  • Prerequisites
  • A Simple ESP-IDF Component
  • Extra Packaging Files
  • Publish the Component
  • Advanced Usages
• Installing and Updating the IDF Component Manager