IDF Component Manager and ESP Component Registry Documentation

This documentation covers the IDF Component Manager and the ESP Component Registry.

The IDF Component Manager is a tool that helps developers easily and reliably add components—created by Espressif or the community—to their ESP-IDF-based projects. It also allows developers to create and share their own components.

The ESP Component Registry (components.espressif.com) is the central repository for these components, which are compatible with the ESP-IDF and accessible through the IDF Component Manager.

Using the Component Manager, developers can quickly install components from the registry, simplifying the process of extending project functionality.

Guides

• Getting Started
  • Checking the IDF Component Manager Version
• Packaging ESP-IDF Components
  • Prerequisites
  • Creating a Simple Component
  • Extra Packaging Files
  • Test with Staging Registry
  • Publish Your Component
  • Advanced Usages
• Partial Mirror
  • Sync from Component Registry
  • Apply to Configuration File idf_component_manager.yml
• Authorization in the ESP Component Registry
  • What Is a Namespace?
  • Namespace Roles
  • Component Roles
  • Managing Roles in the Permissions Tab
• Installing and Updating the IDF Component Manager
• Version Solver
  • Version Solving

References

• ESP Component Registry Badge Endpoint
  • Query Parameters
  • Additional Notes on Badge Display Behavior
• Compote CLI
  • compote
• idf_component_manager.yml Configuration File
  • Configuration File
  • URL Precedence During 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