@@ -127,7 +127,7 @@ call. The format of the response is the following:
127
127
"label": <-- HOW THE PORT IS DISPLAYED ON THE GUI
128
128
"protocol": <-- THE PROTOCOL USED BY THE BOARD
129
129
"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
131
131
"properties": {
132
132
<-- A LIST OF PROPERTIES OF THE PORT
133
133
}
@@ -148,10 +148,10 @@ Each port has:
148
148
` SSH on 192.168.10.100 ` )
149
149
- ` protocol ` is the protocol identifier (such as ` serial ` or ` dfu ` or ` ssh ` )
150
150
- ` 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.
155
155
156
156
This value ** should not** be used to identify the board ** model** (see the
157
157
[ 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
185
185
properties of the port, and some of them may be useful for product identification (in this case only USB VID/PID is
186
186
useful to identify the board model).
187
187
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.
189
190
190
191
The ` LIST ` command performs a one-shot polling of the ports. The discovery should answer as soon as reasonably possible,
191
192
without any additional delay.
0 commit comments