+26
-7
lines changedFilter options
+26
-7
lines changed Original file line number Diff line number Diff line change
@@ -11,10 +11,8 @@ When you run [`arduino-cli board list`][arduino cli board list], your board does
11
11
12
12
FQBN stands for Fully Qualified Board Name. It has the following format:
13
13
`VENDOR:ARCHITECTURE:BOARD_ID[:MENU_ID=OPTION_ID[,MENU2_ID=OPTION_ID ...]]`, with each `MENU_ID=OPTION_ID` being an
14
-
optional key-value pair configuration. Each field accepts letters (`A-Z` or `a-z`), numbers (`0-9`), underscores (`_`),
15
-
dashes(`-`) and dots(`.`). The special character `=` is accepted in the configuration value. The `VENDOR` and
16
-
`ARCHITECTURE` parts can be empty. For a deeper understanding of how FQBN works, you should understand the [Arduino
17
-
platform specification][0].
14
+
optional key-value pair configuration. The `VENDOR` and `ARCHITECTURE` parts can be empty. For a deeper understanding of
15
+
how FQBN works, you should understand the [Arduino platform specification][0].
18
16
19
17
## How to set multiple board options?
20
18
Original file line number Diff line number Diff line change
@@ -64,6 +64,8 @@ The metadata fields are:
64
64
- `name`: the folder used for the installed cores. The
65
65
[vendor folder](platform-specification.md#hardware-folders-structure) name of the installed package is determined by
66
66
this field
67
+
- The value must not contain any characters other than the letters `A`-`Z` and `a`-`z`, numbers (`0`-`9`), underscores
68
+
(`_`), dashes (`-`), and dots (`.`).
67
69
- `maintainer`: the extended name of the vendor that is displayed on the Arduino IDE Boards Manager GUI
68
70
- `websiteURL`: the URL to the vendor's website, appears on the Arduino IDE Boards Manager as a "More info" link
69
71
- `email`: the email of the vendor/maintainer
@@ -260,6 +262,8 @@ Each PLATFORM describes a core for a specific architecture. The fields needed ar
260
262
- `name`: the extended name of the platform that is displayed on the Boards Manager GUI
261
263
- `architecture`: is the architecture of the platform (avr, sam, etc...). It must match the architecture of the core as
262
264
explained in the [Arduino platform specification](platform-specification.md#hardware-folders-structure)
265
+
- The value must not contain any characters other than the letters `A`-`Z` and `a`-`z`, numbers (`0`-`9`), underscores
266
+
(`_`), dashes (`-`), and dots (`.`).
263
267
- `version`: the version of the platform.
264
268
- `deprecated`: (optional) setting to `true` causes the platform to be moved to the bottom of all Boards Manager and
265
269
[`arduino-cli core`](https://arduino.github.io/arduino-cli/latest/commands/arduino-cli_core/) listings and marked
Original file line number Diff line number Diff line change
@@ -24,7 +24,11 @@ Alternatively, a platform may be manually installed by the user inside the Sketc
24
24
- `{directories.user}` is the user directory as specified in the
25
25
[configuration file](configuration.md#default-directories).
26
26
- `{VENDOR_NAME}` is the identifier of the vendor/maintainer of the platform.
27
+
- The name of the vendor directory must not contain any characters other than the letters `A`-`Z` and `a`-`z`, numbers
28
+
(`0`-`9`), underscores (`_`), dashes (`-`), and dots (`.`).
27
29
- `{ARCHITECTURE}` is the architecture of the CPU used in the platform.
30
+
- The name of the architecture directory must not contain any characters other than the letters `A`-`Z` and `a`-`z`,
31
+
numbers (`0`-`9`), underscores (`_`), dashes (`-`), and dots (`.`).
28
32
29
33
A vendor/maintainer may have multiple supported architectures.
30
34
@@ -534,6 +538,9 @@ This file contains definitions and metadata for the boards supported by the plat
534
538
short name, the board ID. The settings for a board are defined through a set of properties with keys having the board ID
535
539
as prefix.
536
540
541
+
The board ID must not contain any characters other than the letters `A`-`Z` and `a`-`z`, numbers (`0`-`9`), underscores
542
+
(`_`), and dashes (`-`).
543
+
537
544
For example, the board ID chosen for the Arduino Uno board is "uno". An extract of the Uno board configuration in
538
545
boards.txt looks like:
539
546
@@ -1591,8 +1598,13 @@ This board was produced in two models, one with an ATmega168 microcontroller and
1591
1598
going then to define a custom option, using the "cpu" MENU_ID, that allows the user to choose between the two different
1592
1599
microcontrollers.
1593
1600
1594
-
We must first define a set of **menu.MENU_ID=Text** properties. **Text** is what is displayed on the GUI for every
1595
-
custom menu we are going to create and must be declared at the beginning of the boards.txt file:
1601
+
We must first define a set of **menu.MENU_ID=Text** properties.
1602
+
1603
+
The menu ID must not contain any characters other than the letters `A`-`Z` and `a`-`z`, numbers (`0`-`9`), underscores
1604
+
(`_`), and dashes (`-`).
1605
+
1606
+
**Text** is what is displayed on the GUI for every custom menu we are going to create and must be declared at the
1607
+
beginning of the boards.txt file:
1596
1608
1597
1609
```
1598
1610
menu.cpu=Processor
@@ -1627,7 +1639,12 @@ duemilanove.menu.cpu.atmega168=ATmega168
1627
1639
1628
1640
We have defined two values: "atmega328" and "atmega168".<br> Note that the property keys must follow the format
1629
1641
**BOARD_ID.menu.MENU_ID.OPTION_ID=Text**, where **Text** is what is displayed under the "Processor" menu in the IDE's
1630
-
GUI.<br> Finally, the specific configuration for each option value:
1642
+
GUI.
1643
+
1644
+
The option ID must not contain any characters other than the letters `A`-`Z` and `a`-`z`, numbers (`0`-`9`), underscores
1645
+
(`_`), dashes (`-`), and equal signs (`=`).
1646
+
1647
+
Finally, the specific configuration for each option value:
1631
1648
1632
1649
```
1633
1650
[.....]
You can’t perform that action at this time.
RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4