Skip to content

Properly document Port#hardware_id in the gRPC API #2269

Open
@kittaakos

Description

@kittaakos

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

Metadata

Metadata

Assignees

Labels

topic: codeRelated to content of the project itselftopic: documentationRelated to documentation for the projecttopic: gRPCRelated to the gRPC interfacetype: enhancementProposed improvement

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions