Skip to content

Commit e051454

Browse files
committed
Added 'name' field in hypotetical serial-discovery
1 parent 0316cb9 commit e051454

File tree

1 file changed

+9
-4
lines changed

1 file changed

+9
-4
lines changed

RFCs/0002-pluggable-discovery.md

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -167,7 +167,8 @@ To make the above more clear let’s show an example with the `serial_discovery`
167167
"properties": {
168168
"pid": "0x804e",
169169
"vid": "0x2341",
170-
"serialNumber": "EBEABFD6514D32364E202020FF10181E"
170+
"serialNumber": "EBEABFD6514D32364E202020FF10181E",
171+
"name": "ttyACM0"
171172
}
172173
}
173174
]
@@ -197,7 +198,8 @@ The `add` event looks like the following:
197198
"properties": {
198199
"pid": "0x804e",
199200
"vid": "0x2341",
200-
"serialNumber": "EBEABFD6514D32364E202020FF10181E"
201+
"serialNumber": "EBEABFD6514D32364E202020FF10181E",
202+
"name": "ttyACM0"
201203
},
202204
"protocol": "serial",
203205
"protocolLabel": "Serial Port (USB)"
@@ -306,7 +308,8 @@ Let’s see an example to clarify things a bit, let's suppose that we have the f
306308
"properties": {
307309
"pid": "0x804e",
308310
"vid": "0x2341",
309-
"serialNumber": "EBEABFD6514D32364E202020FF10181E"
311+
"serialNumber": "EBEABFD6514D32364E202020FF10181E",
312+
"name": "ttyACM0"
310313
}
311314
[...CUT...]
312315
```
@@ -458,7 +461,8 @@ For example, the following port metadata coming from a pluggable discovery:
458461
"properties": {
459462
"pid": "0x804e",
460463
"vid": "0x2341",
461-
"serialNumber": "EBEABFD6514D32364E202020FF10181E"
464+
"serialNumber": "EBEABFD6514D32364E202020FF10181E",
465+
"name": "ttyACM0"
462466
},
463467
"identificationPrefs": {
464468
"pid": "0x804e",
@@ -476,6 +480,7 @@ will be available on the recipe as the variables:
476480
{upload.port.pid} = 0x8043
477481
{upload.port.vid} = 0x2341
478482
{upload.port.serialNumber} = EBEABFD6514D32364E202020FF10181E
483+
{upload.port.name} = ttyACM0
479484
{serial.port} = ttyACM0 # for backward compatibility
480485
{serial.port.file} = /dev/ttyACM0 # only because protocol=serial
481486
```

0 commit comments

Comments
 (0)