Skip to content
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

Improve USBVendor Example #9349

Merged
merged 5 commits into from
Mar 11, 2024
Merged

Conversation

lucasssvaz
Copy link
Collaborator

@lucasssvaz lucasssvaz commented Mar 6, 2024

Description of Change

Improves USBVendor example by adding the flush method and adding WebUSB console hosted inside the documentation.

Tests scenarios

Tested with ESP32-S3 DevKit

Related links

Closes #8235

@lucasssvaz lucasssvaz added Type: Documentation Issue pertains to Documentation of Arduino ESP32 Type: Example Issue is related to specific example. labels Mar 6, 2024
@lucasssvaz lucasssvaz self-assigned this Mar 6, 2024
Copy link
Contributor

github-actions bot commented Mar 6, 2024

Warnings
⚠️

Some issues found for the commit messages in this PR:

  • the commit message "Add WebUSB console":
    • summary looks empty
    • type/action looks empty
  • the commit message "Add comments":
    • summary looks empty
    • type/action looks empty
  • the commit message "Add flush method":
    • summary looks empty
    • type/action looks empty
  • the commit message "Improve Console Page":
    • summary looks empty
    • type/action looks empty
  • the commit message "Improve example":
    • summary looks empty
    • type/action looks empty

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

Messages
📖 You might consider squashing your 5 commits (simplifying branch history).

👋 Hello lucasssvaz, 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.
- Addressing info messages (📖) is strongly recommended; they're less critical but valuable.
- 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 d9aeb3c

Copy link
Member

@pedrominatel pedrominatel left a comment

Choose a reason for hiding this comment

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

LGTM

@lucasssvaz lucasssvaz added the Status: Pending Merge Pull Request is ready to be merged label Mar 7, 2024
Copy link
Member

@P-R-O-C-H-Y P-R-O-C-H-Y left a comment

Choose a reason for hiding this comment

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

Looks good and working well.
@lucasssvaz Suggesting to change Button Pressed/ Released message for some 64bytes long message so it gets printed to Server immediately.
Also adding a comment to the code would be nice :)

@lucasssvaz lucasssvaz removed the Status: Pending Merge Pull Request is ready to be merged label Mar 8, 2024
@lucasssvaz lucasssvaz changed the title Add WebUSB console example Improve USBVendor Example Mar 8, 2024
@lucasssvaz lucasssvaz added the Area: Libraries Issue is related to Library support. label Mar 8, 2024
Copy link
Member

@P-R-O-C-H-Y P-R-O-C-H-Y left a comment

Choose a reason for hiding this comment

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

LGTM!

@lucasssvaz lucasssvaz added the Status: Pending Merge Pull Request is ready to be merged label Mar 8, 2024
@me-no-dev me-no-dev merged commit dce754b into espressif:master Mar 11, 2024
56 checks passed
@lucasssvaz lucasssvaz deleted the bugfix/webusb_url branch March 11, 2024 14:18
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Area: Libraries Issue is related to Library support. Status: Pending Merge Pull Request is ready to be merged Type: Documentation Issue pertains to Documentation of Arduino ESP32 Type: Example Issue is related to specific example.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

WebUSB example link broken
4 participants