You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/sketch-project-file.md
+8-4Lines changed: 8 additions & 4 deletions
Original file line number
Diff line number
Diff line change
@@ -10,6 +10,7 @@ multiple profiles.
10
10
Each profile will define:
11
11
12
12
- The board FQBN
13
+
- The programmer to use
13
14
- The target core platform name and version (with the 3rd party platform index URL if needed)
14
15
- A possible core platform name and version, that is a dependency of the target core platform (with the 3rd party
15
16
platform index URL if needed)
@@ -22,6 +23,7 @@ profiles:
22
23
<PROFILE_NAME>:
23
24
notes: <USER_NOTES>
24
25
fqbn: <FQBN>
26
+
programmer: <PROGRAMMER>
25
27
platforms:
26
28
- platform: <PLATFORM> (<PLATFORM_VERSION>)
27
29
platform_index_url: <3RD_PARTY_PLATFORM_URL>
@@ -50,6 +52,7 @@ otherwise below). The available fields are:
50
52
-`libraries:` is a section where the required libraries to build the project are defined. This section is optional.
51
53
-`<LIB_VERSION>` is the version required for the library, for example, `1.0.0`.
52
54
-`<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.
53
56
54
57
A complete example of a sketch project file may be the following:
55
58
@@ -134,19 +137,20 @@ The sketch project file may be used to set the default value for some command li
134
137
particular:
135
138
136
139
- 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
137
141
- The `default_port` key sets the default value for the `--port` flag
138
142
- The `default_protocol` key sets the default value for the `--protocol` flag
139
143
- The `default_profile` key sets the default value for the `--profile` flag
140
144
141
145
For example:
142
146
143
147
```
144
-
default_fqbn: arduino:avr:uno
148
+
default_fqbn: arduino:samd:mkr1000
149
+
default_programmer: atmel_ice
145
150
default_port: /dev/ttyACM0
146
151
default_protocol: serial
147
152
default_profile: myprofile
148
153
```
149
154
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), [`arduino-cli upload`](commands/arduino-cli_upload.md) or [`arduino-cli debug`](commands/arduino-cli_debug.md) commands when compiling, uploading or debugging the sketch.
0 commit comments