Skip to content

Commit db8bed0

Browse files
Update docs
1 parent c7cda03 commit db8bed0

File tree

1 file changed

+10
-4
lines changed

1 file changed

+10
-4
lines changed

Diff for: docs/sketch-project-file.md

+10-4
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@ multiple profiles.
1010
Each profile will define:
1111

1212
- The board FQBN
13+
- The programmer to use
1314
- The target core platform name and version (with the 3rd party platform index URL if needed)
1415
- A possible core platform name and version, that is a dependency of the target core platform (with the 3rd party
1516
platform index URL if needed)
@@ -22,6 +23,7 @@ profiles:
2223
<PROFILE_NAME>:
2324
notes: <USER_NOTES>
2425
fqbn: <FQBN>
26+
programmer: <PROGRAMMER>
2527
platforms:
2628
- platform: <PLATFORM> (<PLATFORM_VERSION>)
2729
platform_index_url: <3RD_PARTY_PLATFORM_URL>
@@ -50,6 +52,7 @@ otherwise below). The available fields are:
5052
- `libraries:` is a section where the required libraries to build the project are defined. This section is optional.
5153
- `<LIB_VERSION>` is the version required for the library, for example, `1.0.0`.
5254
- `<USER_NOTES>` is a free text string available to the developer to add comments. This field is optional.
55+
- `<PROGRAMMER>` is the programmer that will be used. This field is optional.
5356

5457
A complete example of a sketch project file may be the following:
5558

@@ -134,19 +137,22 @@ The sketch project file may be used to set the default value for some command li
134137
particular:
135138

136139
- The `default_fqbn` key sets the default value for the `--fqbn` flag
140+
- The `default_programmer` key sets the default value for the `--programmer` flag
137141
- The `default_port` key sets the default value for the `--port` flag
138142
- The `default_protocol` key sets the default value for the `--protocol` flag
139143
- The `default_profile` key sets the default value for the `--profile` flag
140144

141145
For example:
142146

143147
```
144-
default_fqbn: arduino:avr:uno
148+
default_fqbn: arduino:samd:mkr1000
149+
default_programmer: atmel_ice
145150
default_port: /dev/ttyACM0
146151
default_protocol: serial
147152
default_profile: myprofile
148153
```
149154

150-
With this configuration set, it is not necessary to specify the `--fqbn`, `--port`, `--protocol` or `--profile` flags to
151-
the [`arduino-cli compile`](commands/arduino-cli_compile.md) or [`arduino-cli upload`](commands/arduino-cli_upload.md)
152-
commands when compiling or uploading the sketch.
155+
With this configuration set, it is not necessary to specify the `--fqbn`, `--programmer`, `--port`, `--protocol` or
156+
`--profile` flags to the [`arduino-cli compile`](commands/arduino-cli_compile.md),
157+
[`arduino-cli upload`](commands/arduino-cli_upload.md) or [`arduino-cli debug`](commands/arduino-cli_debug.md) commands
158+
when compiling, uploading or debugging the sketch.

0 commit comments

Comments
 (0)