Skip to content

Commit b2378e7

Browse files
authored
Document the boards.txt vid and pid properties (#812)
1 parent 983e523 commit b2378e7

File tree

1 file changed

+16
-0
lines changed

1 file changed

+16
-0
lines changed

docs/platform-specification.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -443,6 +443,22 @@ linked with the sketch.
443443

444444
The parameter **build.variant.path** is automatically generated.
445445

446+
### Board VID/PID
447+
448+
USB vendor IDs (VID) and product IDs (PID) identify USB devices to the computer. If the board uses a unique VID/PID
449+
pair, it may be defined in boards.txt:
450+
451+
uno.vid.0=0x2341
452+
uno.pid.0=0x0043
453+
uno.vid.1=0x2341
454+
uno.pid.1=0x0001
455+
456+
The **vid** and **pid** properties end with an arbitrary number, which allows multiple VID/PID pairs to be defined for a
457+
board. The snippet above is defining the 2341:0043 and 2341:0001 pairs used by Uno boards.
458+
459+
The Arduino development software uses the **vid** and **pid** properties to automatically identify the boards connected
460+
to the computer. This convenience feature isn't available for boards that don't present a unique VID/PID pair.
461+
446462
### Hiding boards
447463

448464
Adding a **hide** property to a board definition causes it to not be shown in the Arduino IDE's **Tools > Board** menu.

0 commit comments

Comments
 (0)