Skip to content

Adds HW Serial CDC as IDF component example #10262

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 14 commits into from
Sep 2, 2024
Merged

Adds HW Serial CDC as IDF component example #10262

merged 14 commits into from
Sep 2, 2024

Conversation

SuGlider
Copy link
Collaborator

Description of Change

Adds a new example for building Arduino project as IDF component using the native HW CDC port.

Tests scenarios

Tested using ESP32-C3, ESP32-C6 and ESP32-S3 - building it using Arduino as IDF Component.

Related links

None

@SuGlider
feat(hw_cdc): creates documentation for the example
bbed8d5 
Adds a README file that exaplains the example.
@SuGlider
feat(hw_cdc): create cmake config file
5077832 
Adds necessary CMakeLists.txt file to the project with the HW CDC defines that will enable it.
@SuGlider
feat(hw_cdc): create sdkconfig.defaults
03d570e 
Adds necessary and minimum sdkconfig settings in order to make Arduino run as IDF Compoenent.
@SuGlider
feat(hw_cdc): create cmake config file
ab2f540 
Create the Arduino Sketch source code CMakeLists.txt file that will include all source code files and header files in the proejct.
@SuGlider
feat(hw_cdc): create main.cpp
748d009 
Adds the minimum Arduino Sketch that will print "Hello World!" in the HW Serial USB CDC port.
@SuGlider
feat(hw_cdc): create idf_component.yml
837f904 
Adds necessary ESP32 Registry information in order to make ESP32 Arduino to be automatically included in the project as an IDF component.
@SuGlider SuGlider added the Area: Arduino as ESP-IDF component Issues about Arduino used as component in ESP-IDF label Aug 29, 2024
@SuGlider SuGlider added this to the 3.0.5 milestone Aug 29, 2024
@SuGlider SuGlider self-assigned this Aug 29, 2024
@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented Aug 29, 2024 •
edited
Loading

Warnings
⚠️

Some issues found for the commit messages in this PR:

  • the commit message "feat(hw_cdc): create cmake config file":
    • body's lines must not be longer than 100 characters
  • the commit message "feat(hw_cdc): create idf_component.yml":
    • body's lines must not be longer than 100 characters
  • the commit message "feat(hw_cdc): create main.cpp":
    • summary looks too short
  • the commit message "feat(hw_cdc): formating text code":
    • summary looks too short
  • the commit message "feat(hw_cdc): update main.cpp":
    • summary looks too short
  • the commit message "fix(chw_cdc): typo fix":
    • summary looks too short

Please fix these commit messages - here are some basic tips:

  • follow Conventional Commits style
  • correct format of commit message should be: <type/action>(<scope/component>): <summary>, for example fix(esp32): Fixed startup timeout issue
  • allowed types are: change,ci,docs,feat,fix,refactor,remove,revert,test
  • sufficiently descriptive message summary should be between 20 to 72 characters and start with upper case letter
  • avoid Jira references in commit messages (unavailable/irrelevant for our customers)

TIP: Install pre-commit hooks and run this check when committing (uses the Conventional Precommit Linter).
⚠️ Please consider squashing your 14 commits (simplifying branch history).

👋 Hello SuGlider, we appreciate your contribution to this project!

Click to see more instructions ...


This automated output is generated by the PR linter DangerJS, which checks if your Pull Request meets the project's requirements and helps you fix potential issues.

DangerJS is triggered with each push event to a Pull Request and modify the contents of this comment.

Please consider the following:
- Danger mainly focuses on the PR structure and formatting and can't understand the meaning behind your code or changes.
- Danger is not a substitute for human code reviews; it's still important to request a code review from your colleagues.
- Resolve all warnings (⚠️ ) before requesting a review from human reviewers - they will appreciate it.
- To manually retry these Danger checks, please navigate to the Actions tab and re-run last Danger workflow.

Review and merge process you can expect ...


We do welcome contributions in the form of bug reports, feature requests and pull requests.

1. An internal issue has been created for the PR, we assign it to the relevant engineer.
2. They review the PR and either approve it or ask you for changes or clarifications.
3. Once the GitHub PR is approved we do the final review, collect approvals from core owners and make sure all the automated tests are passing.
- At this point we may do some adjustments to the proposed change, or extend it by adding tests or documentation.
4. If the change is approved and passes the tests it is merged into the default branch.

Generated by 🚫 dangerJS against 688ad38

@SuGlider
feat(hw_cdc): update main.cpp
f949cd8 
adds code to wait for the user to open the Serial Monitor
@SuGlider
feat(hw_cdc): formating text code
95f95c5 
Applying Code style and formating.
@me-no-dev
Copy link
Member

One more thing. The example should be added here so it shows on the component page

@SuGlider
Copy link
Collaborator Author

One more thing. The example should be added here so it shows on the component page

done.

@me-no-dev me-no-dev added the Status: Pending Merge Pull Request is ready to be merged label Aug 31, 2024
@me-no-dev
Copy link
Member

@SuGlider some misspelled words: https://github.com/espressif/arduino-esp32/actions/runs/10646370640/job/29513128732?pr=10262#step:8:25

@SuGlider
Copy link
Collaborator Author

SuGlider commented Sep 1, 2024

@SuGlider some misspelled words: https://github.com/espressif/arduino-esp32/actions/runs/10646370640/job/29513128732?pr=10262#step:8:25

Both typos are now fixed.

@me-no-dev me-no-dev merged commit e70f4d3 into master Sep 2, 2024
21 checks passed
@me-no-dev me-no-dev deleted the hw_serial_cdc_as_component_example branch September 2, 2024 10:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@me-no-dev me-no-dev me-no-dev approved these changes

@lucasssvaz lucasssvaz lucasssvaz approved these changes

@P-R-O-C-H-Y P-R-O-C-H-Y Awaiting requested review from P-R-O-C-H-Y

Assignees

@SuGlider SuGlider

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
Projects
Arduino ESP32 Core Project Roadmap
Status: Done
Milestone
3.0.5
Development

Successfully merging this pull request may close these issues.
3 participants
@SuGlider @me-no-dev @lucasssvaz