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

fix(boards): Remove port property assoc. for non-unique VID/PID pairs #10271

Conversation

per1234
Copy link
Contributor

@per1234 per1234 commented Aug 31, 2024

Description of Change

The Arduino boards platform framework allows properties of a port to be associated with a board definition. The Arduino development software will identify a port having the associated properties as that board.

This should only be done for properties that are unique to the ports produced by that board model. In cases where a board model does not produce a port with properties unique to that model, it is irresponsible to associate those properties with the board definition as this will cause other models to be inappropriately identified.

The authors of these board definitions associated them with non-unique USB VID/PID pairs so those associations must be removed. The 303a:1001 VID/PID pair is of the hardware CDC serial port of the native USB ESP32 chips. The others are stock VID/PID pairs of general purpose USB to serial bridge chips that are used on many different board models.

Tests scenarios

Compile for the modified boards using the platform (at 0b8eede) with this patch (0a8c586) applied.

Related links

Originally reported at https://forum.arduino.cc/t/i-dont-have-elecrow-crowpanel-7-0p/1293026

Copy link
Contributor

github-actions bot commented Aug 31, 2024

Messages
📖 🎉 Good Job! All checks are passing!

👋 Hello per1234, 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 91f0605

The Arduino boards platform framework allows properties of a port to be associated with a board
definition. The Arduino development software will identify a port having the associated properties
as that board.

This should only be done for properties that are unique to the ports produced by that board model.
In cases where a board model does not produce a port with properties unique to that model, it is
irresponsible to associate those properties with the board definition as this will cause other
models to be inappropriately identified.

The authors of these board definitions associated them with non-unique USB VID/PID pairs so those
associations must be removed. The 303a:1001 VID/PID pair is of the hardware CDC serial port of the
native USB ESP32 chips. The others are stock VID/PID pairs of general purpose USB to serial bridge
chips that are used on many different board models.
@per1234 per1234 force-pushed the remove-generic-port-properties-association branch from 0a8c586 to 91f0605 Compare September 3, 2024 19:09
@P-R-O-C-H-Y P-R-O-C-H-Y added the Status: Pending Merge Pull Request is ready to be merged label Sep 6, 2024
@me-no-dev me-no-dev merged commit 41cdbd9 into espressif:master Sep 9, 2024
14 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Status: Pending Merge Pull Request is ready to be merged Type: 3rd party Boards
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants