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 208fc42

Browse filesBrowse files
cmaglieBikappa
andcommitted
Update docs/pluggable-discovery-specification.md
Co-authored-by: Luca Bianconi <71259950+Bikappa@users.noreply.github.com>
1 parent 6248d7f commit 208fc42
Copy full SHA for 208fc42

File tree

Expand file treeCollapse file tree

1 file changed

+7
-6
lines changed
Filter options
Expand file treeCollapse file tree

1 file changed

+7
-6
lines changed

‎docs/pluggable-discovery-specification.md

Copy file name to clipboardExpand all lines: docs/pluggable-discovery-specification.md
+7-6Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -127,7 +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 SAMPLE
130+
"hardwareId": <-- A STRING THAT UNIQUELY IDENTIFIES A BOARD INSTANCE
131131
"properties": {
132132
<-- A LIST OF PROPERTIES OF THE PORT
133133
}
@@ -148,10 +148,10 @@ Each port has:
148148
`SSH on 192.168.10.100`)
149149
- `protocol` is the protocol identifier (such as `serial` or `dfu` or `ssh`)
150150
- `protocolLabel` is the `protocol` in human readable form (for example `Serial port` or `DFU USB` or `Network (ssh)`)
151-
- `hardwareId` (optional) a string that uniquely identify a specific board sample (even among other boards of the same
152-
model). Different ports with the same `hardwareId` must belong to the same board sample. The identifier should be
153-
sufficiently long to uniquely identify the board sample and reduce the probability of collisions. Good examples of
154-
`hardwareId` values are: Ethernet MAC Address, USB Serial Number, CPU-ID number, etc.
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.
155155

156156
This value **should not** be used to identify the board **model** (see the
157157
[board identification](#board-identification) section for more information about identification of the board model).
@@ -185,7 +185,8 @@ In this case the serial port metadata comes from a USB serial converter. Inside
185185
properties of the port, and some of them may be useful for product identification (in this case only USB VID/PID is
186186
useful to identify the board model).
187187

188-
The `hardwareId` field is populated with the USB `serialNumber` since this value is useful to identify the board sample.
188+
The `hardwareId` field is populated with the USB `serialNumber` since this value is useful to identify the board
189+
instance.
189190

190191
The `LIST` command performs a one-shot polling of the ports. The discovery should answer as soon as reasonably possible,
191192
without any additional delay.

0 commit comments

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