Skip to content

Commit efdb11c

Browse files
committed
Add upload_port properties docs in platform specification
1 parent a42e293 commit efdb11c

File tree

1 file changed

+19
-0
lines changed

1 file changed

+19
-0
lines changed

docs/platform-specification.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -430,6 +430,25 @@ following properties are automatically generated:
430430
- `{build.variant.path}`: The path to the selected board variant folder (inside the
431431
[variant platform](#platform-terminology), for example hardware/arduino/avr/variants/micro)
432432

433+
If the platform supports pluggable discovery it may also declare a set of `upload_port.*` properties, these properties
434+
will be used to identify a board by the discovery process when plugged in.
435+
436+
For example we could declare a series of `upload_port.vid` and `upload_port.pid` for the Uno like so:
437+
438+
uno.upload_port.vid.0=0x2341
439+
uno.upload_port.pid.0=0x0043
440+
uno.upload_port.vid.1=0x2341
441+
uno.upload_port.pid.1=0x0001
442+
uno.upload_port.vid.2=0x2A03
443+
uno.upload_port.pid.2=0x0043
444+
uno.upload_port.vid.3=0x2341
445+
uno.upload_port.pid.3=0x0243
446+
447+
In this case we're using the board's `vid` and `pid` to identify it but `upload_port.*` properties can be anything that
448+
can help identify a certain board. For more detailed information see the
449+
[board identification](pluggable-discovery-specification.md#board-identification) section of the pluggable discovery
450+
documentation.
451+
433452
### Cores
434453

435454
Cores are placed inside the **cores** subfolder. Many different cores can be provided within a single platform. For

0 commit comments

Comments
 (0)