Commit 7a4f716

authored

[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.

1 parent 80c463f commit 7a4f716Copy full SHA for 7a4f716

File tree

1 file changed

-8

lines changed

docs
- platform-specification.md

1 file changed

-8

lines changed

`‎docs/platform-specification.md‎`

Lines changed: 8 additions & 8 deletions

Original file line number	Diff line number	Diff line change
`@@ -547,14 +547,14 @@ will be used to identify a board by the discovery process when plugged in.`
`547`	`547`	For example we could declare a series of `upload_port.vid` and `upload_port.pid` properties for the Uno like so:
`548`	`548`
`549`	`549`	```
`550`		`-uno.upload_port.vid.0=0x2341`
`551`		`-uno.upload_port.pid.0=0x0043`
`552`		`-uno.upload_port.vid.1=0x2341`
`553`		`-uno.upload_port.pid.1=0x0001`
`554`		`-uno.upload_port.vid.2=0x2A03`
`555`		`-uno.upload_port.pid.2=0x0043`
`556`		`-uno.upload_port.vid.3=0x2341`
`557`		`-uno.upload_port.pid.3=0x0243`
	`550`	`+uno.upload_port.0.vid=0x2341`
	`551`	`+uno.upload_port.0.pid=0x0043`
	`552`	`+uno.upload_port.1.vid=0x2341`
	`553`	`+uno.upload_port.1.pid=0x0001`
	`554`	`+uno.upload_port.2.vid=0x2A03`
	`555`	`+uno.upload_port.2.pid=0x0043`
	`556`	`+uno.upload_port.3.vid=0x2341`
	`557`	`+uno.upload_port.3.pid=0x0243`
`558`	`558`	```
`559`	`559`
`560`	`560`	In this case we're using the board's USB VID/PID pair to identify it but `upload_port.*` properties can be anything that

0 commit comments

Comments

(0)

Navigation Menu

Search code, repositories, users, issues, pull requests...

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

Commit 7a4f716

File tree

1 file changed

1 file changed

`‎docs/platform-specification.md‎`

0 commit comments