Skip to content

Add Arduino as Component examples #8878

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

Merged
merged 11 commits into from
Nov 29, 2023

Conversation

P-R-O-C-H-Y
Copy link
Member

Description of Change

Added new folder to the repository containing examples for running Arduino as an ESP-IDF component.
The examples will be also visible on ESP Registry and would be easy to set up the project with just one idf.py command to get all dependencies and have the proper SDK Config changes.

Tests scenarios

Tested locally on all SOCs.

Related links

@P-R-O-C-H-Y P-R-O-C-H-Y self-assigned this Nov 13, 2023
@P-R-O-C-H-Y P-R-O-C-H-Y added this to the 3.0.0 milestone Nov 13, 2023
@P-R-O-C-H-Y P-R-O-C-H-Y added the Area: Arduino as ESP-IDF component Issues about Arduino used as component in ESP-IDF label Nov 13, 2023
@VojtechBartoska VojtechBartoska added the Type: Example Issue is related to specific example. label Nov 20, 2023

If you want to use cloned Arduino-esp32 repository, you can build this example directly.
Go to the example folder `arduino-esp32/idf_component_examples/Hello_world`.
First you need to comment line 6 `pre_release: true` in examples `/main/idf_component.yml`.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I just tested it in a separated folder.
It is also necessary to comment out the line 5 override_path: '../../../' as it may not exist.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actually, it should be removed by the ESP Registry so if you get it from there as an example, this won't exist. On other components it is done same way, for development purposes. If I understood correctly :)

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I didn't test it using the ESP component registry, but just copying it to my ~userName folder and then running it from idf.py flash.
Let's publish it and then we can test it with the ESP Registry tool. As you said it should work fine.
Some users may try it doing the same I did. This is the reason for the comment.

@SuGlider SuGlider self-requested a review November 24, 2023 15:13
Copy link
Collaborator

@SuGlider SuGlider left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good work! Just check the comment I made. I could be included in the README.md.

@Jason2866
Copy link
Collaborator

Can you add an example where PSRAM is used? There will be probably an include error for esp_psram.h

@SuGlider SuGlider added the Status: Pending Merge Pull Request is ready to be merged label Nov 27, 2023
@SuGlider SuGlider self-requested a review November 27, 2023 15:01
Copy link
Collaborator

@SuGlider SuGlider left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@VojtechBartoska VojtechBartoska modified the milestones: 3.0.0, 3.0.0-Aplha3 Nov 28, 2023
@me-no-dev me-no-dev merged commit 00a9579 into espressif:master Nov 29, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Area: Arduino as ESP-IDF component Issues about Arduino used as component in ESP-IDF Status: Pending Merge Pull Request is ready to be merged Type: Example Issue is related to specific example.
Projects
Development

Successfully merging this pull request may close these issues.

5 participants