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

Properly document Port#hardware_id in the gRPC API #2269

Open
3 tasks done
kittaakos opened this issue Aug 18, 2023 · 2 comments
Open
3 tasks done

Properly document Port#hardware_id in the gRPC API #2269

kittaakos opened this issue Aug 18, 2023 · 2 comments
Assignees
Labels
topic: code Related to content of the project itself topic: documentation Related to documentation for the project topic: gRPC Related to the gRPC interface type: enhancement Proposed improvement

Comments

@kittaakos
Copy link
Contributor

Describe the request

As described here, the hardware_id was introduced as a workaround to help CLI consumers to detect a potential port change during the upload.

Once the feature is available and the CLI can provide the new port (if it has changed) after the upload, I propose eliminating the hardwareId from the gRPC API before the 1.0 release. I do not see why this should be exposed to the public. See the downstream change at arduino/arduino-ide#1913:

From here:

This PR has been created to support the "auto-reconnecting" to a board in DFU mode, which the R4 Minima goes into during upload and reset. The primary motivation was to make IDE2 compatible with the Uno R4 board.

Related API:

// The hardware ID (serial number) of the board attached to the port
string hardware_id = 6;

I can open a separate issue if it's needed.

Describe the current behavior

The Port#hardware_id is exposed.

Arduino CLI version

38479dc

Operating system

macOS

Operating system version

13.5

Additional context

Follow-up of #2245.

Issue checklist

  • I searched for previous requests in the issue tracker
  • I verified the feature was still missing when using the nightly build
  • My request contains all necessary details
@kittaakos kittaakos added type: enhancement Proposed improvement topic: code Related to content of the project itself topic: gRPC Related to the gRPC interface labels Aug 18, 2023
@umbynos
Copy link
Contributor

umbynos commented Sep 1, 2023

This is not required anymore for detection, but could be useful in other way. For example, for grouping ports exposed by the same board (not a use case we are currently supporting, but it's a possibility for the consumers)

@kittaakos
Copy link
Contributor Author

For example, for grouping ports exposed by the same board (not a use case we are currently supporting, but it's a possibility for the consumers)

The API was added as a workaround. You don't need to keep it for made-up future use cases. If you decide to keep it, please properly document what clients are supposed to do with the Port#hardware_id for an upload request, for example.

I understand that you consider this API as something extra the CLI provides. As a consumer of the CLI, I need help understanding what to do with it.

@umbynos umbynos added the topic: documentation Related to documentation for the project label Sep 7, 2023
@umbynos umbynos changed the title Remove Port#hardware_id from the gRPC API Properly document Port#hardware_id in the gRPC API Dec 7, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
topic: code Related to content of the project itself topic: documentation Related to documentation for the project topic: gRPC Related to the gRPC interface type: enhancement Proposed improvement
Projects
None yet
Development

No branches or pull requests

3 participants