Skip to content

Commit 9168cc5

Browse files
committed
fix(doc): clarify profile port protocol usage
Ref: #2717 Signed-off-by: dankeboy36 <[email protected]>
1 parent f102aad commit 9168cc5

File tree

1 file changed

+3
-1
lines changed

1 file changed

+3
-1
lines changed

docs/sketch-project-file.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -71,7 +71,9 @@ The following fields are available since Arduino CLI 1.1.0:
7171
- `port_config` section with `<PORT_SETTING_NAME>` and `<PORT_SETTING_VALUE>` defines the port settings that will be
7272
used in the `monitor` command. Typically is used to set the baudrate for the serial port (for example
7373
`baudrate: 115200`) but any setting/value can be specified. Multiple settings can be set. These fields are optional.
74-
- `<PORT_PROTOCOL>` is the protocol for the port used to upload and monitor the board. This field is optional.
74+
- `<PORT_PROTOCOL>` is the protocol for the port used to upload and monitor the board. Arduino CLI ignores this value at
75+
runtime, so write it only if an external client (for example one using the gRPC [`Port`](/rpc/commands/#port)) needs to restore the `protocol` together with the port `address`. Clients that do not set it should assume their
76+
own default (usually `serial`). This field is optional.
7577

7678
#### Using a system-installed platform.
7779

0 commit comments

Comments
 (0)