Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Appearance settings

Commit 396718f

Browse filesBrowse files
cmaglieBikappa
andauthored
Added 'hardwareId' support to pluggable discovery (#2065)
* Added 'hardwareId' support to pluggable discovery * Added hardwareId output in 'board list -w' too * Update docs/pluggable-discovery-specification.md Co-authored-by: Luca Bianconi <71259950+Bikappa@users.noreply.github.com> --------- Co-authored-by: Luca Bianconi <71259950+Bikappa@users.noreply.github.com>
1 parent 6bf2c23 commit 396718f
Copy full SHA for 396718f

File tree

Expand file treeCollapse file tree

5 files changed

+43
-12
lines changed
Filter options
Expand file treeCollapse file tree

5 files changed

+43
-12
lines changed

‎arduino/discovery/discovery.go

Copy file name to clipboardExpand all lines: arduino/discovery/discovery.go
+2Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -91,6 +91,7 @@ type Port struct {
9191
AddressLabel string `json:"label"`
9292
Protocol string `json:"protocol"`
9393
ProtocolLabel string `json:"protocolLabel"`
94+
HardwareID string `json:"hardwareId,omitempty"`
9495
Properties *properties.Map `json:"properties"`
9596
}
9697

@@ -107,6 +108,7 @@ func (p *Port) ToRPC() *rpc.Port {
107108
Label: p.AddressLabel,
108109
Protocol: p.Protocol,
109110
ProtocolLabel: p.ProtocolLabel,
111+
HardwareId: p.HardwareID,
110112
Properties: props.AsMap(),
111113
}
112114
}

‎docs/pluggable-discovery-specification.md

Copy file name to clipboardExpand all lines: docs/pluggable-discovery-specification.md
+15-1Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -127,6 +127,7 @@ call. The format of the response is the following:
127127
"label": <-- HOW THE PORT IS DISPLAYED ON THE GUI
128128
"protocol": <-- THE PROTOCOL USED BY THE BOARD
129129
"protocolLabel": <-- HOW THE PROTOCOL IS DISPLAYED ON THE GUI
130+
"hardwareId": <-- A STRING THAT UNIQUELY IDENTIFIES A BOARD INSTANCE
130131
"properties": {
131132
<-- A LIST OF PROPERTIES OF THE PORT
132133
}
@@ -147,7 +148,15 @@ Each port has:
147148
`SSH on 192.168.10.100`)
148149
- `protocol` is the protocol identifier (such as `serial` or `dfu` or `ssh`)
149150
- `protocolLabel` is the `protocol` in human readable form (for example `Serial port` or `DFU USB` or `Network (ssh)`)
150-
- `properties` is a list of key/value pairs that represent information relative to the specific port
151+
- `hardwareId` (optional) a string that uniquely identifies a specific board instance (even among other boards of the
152+
same model). Different ports with the same `hardwareId` must belong to the same board instance. The identifier should
153+
be sufficiently long to uniquely identify the board instance and reduce the probability of collisions. Good examples
154+
of `hardwareId` values are: Ethernet MAC Address, USB Serial Number, CPU-ID number, etc.
155+
156+
This value **should not** be used to identify the board **model** (see the
157+
[board identification](#board-identification) section for more information about identification of the board model).
158+
159+
- `properties` is a list of key/value pairs that represent information relative to the specific port.
151160

152161
To make the above more clear let's show an example output from the `serial-discovery` builtin in the Arduino CLI:
153162

@@ -160,6 +169,7 @@ To make the above more clear let's show an example output from the `serial-disco
160169
"label": "ttyACM0",
161170
"protocol": "serial",
162171
"protocolLabel": "Serial Port (USB)",
172+
"hardwareId": "EBEABFD6514D32364E202020FF10181E",
163173
"properties": {
164174
"pid": "0x804e",
165175
"vid": "0x2341",
@@ -175,6 +185,9 @@ In this case the serial port metadata comes from a USB serial converter. Inside
175185
properties of the port, and some of them may be useful for product identification (in this case only USB VID/PID is
176186
useful to identify the board model).
177187

188+
The `hardwareId` field is populated with the USB `serialNumber` since this value is useful to identify the board
189+
instance.
190+
178191
The `LIST` command performs a one-shot polling of the ports. The discovery should answer as soon as reasonably possible,
179192
without any additional delay.
180193

@@ -231,6 +244,7 @@ The `add` event looks like the following:
231244
"port": {
232245
"address": "/dev/ttyACM0",
233246
"label": "ttyACM0",
247+
"hardwareId": "EBEABFD6514D32364E202020FF10181E",
234248
"properties": {
235249
"pid": "0x804e",
236250
"vid": "0x2341",

‎internal/cli/board/list.go

Copy file name to clipboardExpand all lines: internal/cli/board/list.go
+2Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -105,6 +105,7 @@ func watchList(cmd *cobra.Command, inst *rpc.Instance) {
105105
Address: event.Port.Port.Address,
106106
Protocol: event.Port.Port.Protocol,
107107
ProtocolLabel: event.Port.Port.ProtocolLabel,
108+
HardwareID: event.Port.Port.HardwareId,
108109
Properties: event.Port.Port.Properties,
109110
Boards: event.Port.MatchingBoards,
110111
Error: event.Error,
@@ -181,6 +182,7 @@ type watchEvent struct {
181182
Label string `json:"label,omitempty"`
182183
Protocol string `json:"protocol,omitempty"`
183184
ProtocolLabel string `json:"protocol_label,omitempty"`
185+
HardwareID string `json:"hardwareId,omitempty"`
184186
Properties map[string]string `json:"properties"`
185187
Boards []*rpc.BoardListItem `json:"boards,omitempty"`
186188
Error string `json:"error,omitempty"`

‎rpc/cc/arduino/cli/commands/v1/port.pb.go

Copy file name to clipboardExpand all lines: rpc/cc/arduino/cli/commands/v1/port.pb.go
+22-11Lines changed: 22 additions & 11 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎rpc/cc/arduino/cli/commands/v1/port.proto

Copy file name to clipboardExpand all lines: rpc/cc/arduino/cli/commands/v1/port.proto
+2Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,4 +31,6 @@ message Port {
3131
string protocol_label = 4;
3232
// A set of properties of the port
3333
map<string, string> properties = 5;
34+
// The hardware ID (serial number) of the board attached to the port
35+
string hardware_id = 6;
3436
}

0 commit comments

Comments
0 (0)
Morty Proxy This is a proxified and sanitized view of the page, visit original site.