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 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.

Guides

• Getting Started
  • Checking the IDF Component Manager Version
• Packaging ESP-IDF Components
  • Prerequisites
  • A Simple ESP-IDF Component
  • Extra Packaging Files
  • Test on Staging Registry
  • Publish the Component
  • Advanced Usages
• Partial Mirror
  • Sync from Component Registry
  • Apply to Configuration File idf_component_manager.yml
• Installing and Updating the IDF Component Manager
• Version Solver
  • Version Solving

References

• Compote CLI
  • compote
• idf_component_manager.yml Configuration File
  • Configuration File
  • URLs Precedence While Version Solving
  • Login via CLI
  • Login to Staging Registry
• Dependencies.lock File
  • Root Attributes
  • Dependency Attributes
• idf_component.yml Manifest File
  • Build-Related Attributes
  • Metadata Attributes
  • Component Dependencies
• Versioning
  • Versioning Scheme
  • Version Precedence
  • Range Specifications