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

Add #ifndef for USB_VID and USB_PID for esp32s3 board variant #10815

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

pzich
Copy link

@pzich pzich commented Jan 6, 2025

Description of Change

This adds #ifndefs for the USB_VID and USB_PID #defines for the esp32s3 board variant. By adding #ifndefs, this allows the end user to customize the Vendor ID and Product ID that the device shows up as.

Tangentially: Should this be added to other variants? To all variants? Some of the variants also define USB_MANUFACTURER, USB_PRODUCT and/or USB_SERIAL with no way to override them. Should those also get #ifndefs?

Tests scenarios

I tested this with an ESP32-S3 (supermini) by including/excluding different combinations of -DUSB_VID=0x1234 and -DUSB_PID=0x5678 build flags

@CLAassistant
Copy link

CLAassistant commented Jan 6, 2025

CLA assistant check
All committers have signed the CLA.

Copy link
Contributor

github-actions bot commented Jan 6, 2025

Messages
📖 🎉 Good Job! All checks are passing!

👋 Hello pzich, 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.
- 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 07009ed

This adds #ifndef for USB_VID and USB_PID for esp32s3 board variant,
allowing the end user to customize these values and therefore how the
device shows up when connected to USB.
@me-no-dev
Copy link
Member

It is already possible to do this in code

USB.PID(pid);
USB.VID(vid);
USB.begin();

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.

3 participants