Skip to content

fix(doc): clarify profile port protocol usage #3051

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

fix(doc): clarify profile port protocol usage #3051

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
9168cc5
fix(doc): clarify profile port protocol usage
dankeboy36 Nov 21, 2025
73878ce
fix(lint): :lipstick:
dankeboy36 Nov 21, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 4 additions & 1 deletion docs/sketch-project-file.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,10 @@ The following fields are available since Arduino CLI 1.1.0:
- `port_config` section with `<PORT_SETTING_NAME>` and `<PORT_SETTING_VALUE>` defines the port settings that will be
used in the `monitor` command. Typically is used to set the baudrate for the serial port (for example
`baudrate: 115200`) but any setting/value can be specified. Multiple settings can be set. These fields are optional.
- `<PORT_PROTOCOL>` is the protocol for the port used to upload and monitor the board. This field is optional.
- `<PORT_PROTOCOL>` is the protocol for the port used to upload and monitor the board. Arduino CLI ignores this value at
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 own default
(usually `serial`). This field is optional.

#### Using a system-installed platform.

Expand Down