Unverified Commit 7a4f716b authored by per1234's avatar per1234 Committed by GitHub

[skip changelog] Correct format of `upload_port` identification properties in snippet (#2655)

The platform developer can associate port properties with a board definition in order to cause Arduino CLI to identify
ports having those properties as that board.

The list format is supported for these platform properties in order to allow multiple alternative port property sets to
be associated. The platform property must have the format `upload_port.n.<property ID>` (where "n" is the array index of
the port property set).

Although the platform property format is correctly documented in the Arduino Platform Specification, an incorrect format
`upload_port.<property ID>.n` was previously used in the boards.txt snippet illustrating the use of the platform
properties.
parent 80c463f3
......@@ -547,14 +547,14 @@ will be used to identify a board by the discovery process when plugged in.
For example we could declare a series of `upload_port.vid` and `upload_port.pid` properties for the Uno like so:
```
uno.upload_port.vid.0=0x2341
uno.upload_port.pid.0=0x0043
uno.upload_port.vid.1=0x2341
uno.upload_port.pid.1=0x0001
uno.upload_port.vid.2=0x2A03
uno.upload_port.pid.2=0x0043
uno.upload_port.vid.3=0x2341
uno.upload_port.pid.3=0x0243
uno.upload_port.0.vid=0x2341
uno.upload_port.0.pid=0x0043
uno.upload_port.1.vid=0x2341
uno.upload_port.1.pid=0x0001
uno.upload_port.2.vid=0x2A03
uno.upload_port.2.pid=0x0043
uno.upload_port.3.vid=0x2341
uno.upload_port.3.pid=0x0243
```
In this case we're using the board's USB VID/PID pair to identify it but `upload_port.*` properties can be anything that
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment