Skip to content

Added: ESP-IDF Component support #25

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 4 commits into
base: master
Choose a base branch
from

Conversation

haruny
Copy link
Contributor

@haruny haruny commented May 7, 2025

Support for ESP-IDF components
I added idf_components.yml and refactored CMakeLists.txt. These changes will allow entire repo to be directly pulled into any esp-idf as component.

Why an ESP Component?
ESP-IDF has it's own component and build system. Without these changes, users will need to depend on eez-studio to create the eez-flow library files file. This is undesirable if you like to change/patch/debug certain parts of the eez-flow library - because you have a crash for some reason. Your changes will be overwritten everytime you generate the project files within the eezstudio.

If these changes pulled in, user can just add the following lines to their idf_component.yml which will automatically pull in eez-open/eez-framework to their project. Should the user prefer, they can branch off-of eez-open/eez-framework and create their own "staged" component too. In my opinion this is a better separation of framework duties and project file duties.

How use eez-framework as an ESP component?

  eez-framework:
    version: * 
    git: https://github.com/eez-open/eez-framework.git

I branched off from your master and added these files so I can pull eez-framwork as a component:

  eez-framework:
    version: esp-idf 
    git: https://github.com/haruny/eez-framework.git

Tested with ESP-IDF 5.4.1. Works out of the box.

I also submitted an ESP Component to the official repository from my branch : https://components.espressif.com/components/haruny/eez-framework/versions/0.0.1

This allows CLI support and better discovery of eez-framework (it was really buried within the links if you're an esp-idf user).

However, if you prefer to have your own official ESP Component, I can delete mine so that you can submit an official one.
Should you need, happy to help create your esp component as well.

One side benefit, previous commits on CMakeLists.txt was broken for esp-idf use. This change fixes it. All other esp-component benefits come from the idf_component.yml file.

haruny added 4 commits May 7, 2025 06:55
… dependency instructions, and add idf_component.yml for project metadata
correcting the URL for pull request.
correcting the URL for pull request.
please revert these lines if you are submitting your own repository
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant