Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
Original file line number Diff line number Diff line change
Expand Up @@ -58,33 +58,35 @@ Arduino IDE displays compilation messages differently depending on the version:
## Troubleshoot a specific error

<table>
<tr>
<td style="vertical-align: top;">
<h3>Common</h3>
<li><a href="#error-compiling-for-board">Error compiling for board</a></li>
<li><a href="#missing-FQBN">Compilation error: Missing FQBN (Fully Qualified Board Name)</a></li>
<li><a href="#platform-not-installed">Compilation error: Error: 2 UNKNOWN: platform not installed</a></li>
<h3>Required functions</h3>
<ul>
<li><a href="#required-functions">undefined reference to 'setup'</a></li>
<li><a href="#required-functions">undefined reference to 'loop'</a></li>
<li><a href="#required-functions">collect2: error: ld returned 1 exit status</a></li>
</ul>
<h3>Libraries</h3>
<ul>
<li><a href="#fatal-error-no-such-file-or-directory">fatal error: : No such file or directory</a></li>
</ul>
</td>
<td style="vertical-align: top;">
<h3>Syntax errors</h3>
<ul>
<li><a href="#variable-not-declared">variable was not declared in this scope</a></li>
<li><a href="#expected-unqualified-id">expected unqualified-id before numeric constant</a></li>
<li><a href="#expected-before-colon">expected ',' or ';' before ':' token</a></li>
<li><a href="#expected-bracket">'expected declaration before '}' token', or 'expected '}' at end of input'</a></li>
</ul>
</td>
</tr>
<tr>
<td style="vertical-align: top;">
<h3>Common</h3>
<ul>
<li><a href="#missing-FQBN">Compilation error: Missing FQBN (Fully Qualified Board Name)</a></li>
<li><a href="#platform-not-installed">Compilation error: Error: 2 UNKNOWN: platform not installed</a></li>
</ul>
<h3>Required functions</h3>
<ul>
<li><a href="#required-functions">undefined reference to 'setup'</a></li>
<li><a href="#required-functions">undefined reference to 'loop'</a></li>
<li><a href="#required-functions">collect2: error: ld returned 1 exit status</a></li>
</ul>
<h3>Libraries</h3>
<ul>
<li><a href="#fatal-error-no-such-file-or-directory">fatal error: : No such file or directory</a></li>
</ul>
</td>
<td style="vertical-align: top;">
<h3>Syntax errors</h3>
<ul>
<li><a href="#variable-not-declared">variable was not declared in this scope</a></li>
<li><a href="#expected-unqualified-id">expected unqualified-id before numeric constant</a></li>
<li><a href="#expected-before-colon">expected ',' or ';' before ':' token</a></li>
<li><a href="#expected-bracket">'expected declaration before '}' token', or 'expected '}' at end of
input'</a></li>
</ul>
</td>
</tr>
</table>

<!-- COMMON -->
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: "Uninstall a library from Arduino IDE"
title: "Uninstall libraries from Arduino IDE"
id: 360016077340
---

Expand All @@ -9,7 +9,7 @@ Learn how to remove IDE libraries from your computer.

## Uninstall using your file manager

Removing the library files directly is the most reliable method that will work for all IDE versions and library types.
Removing the library files directly is the most reliable method that will work for versions of Arduino IDE and library types.

### Library Manager, "Add .ZIP Library", and manual installs

Expand Down

This file was deleted.

Original file line number Diff line number Diff line change
@@ -0,0 +1,60 @@
---
title: "Add boards to Arduino IDE"
id: 360016119519
---

A **board core** (or just _board_ for short) is a collection of files needed to compile and upload sketches for a board. Cores are contained in _packages_ and can be installed using the Board Manager.

---

<a id="add-with-board-manager"></a>

## Add a board with the Boards Manager

Official Arduino cores can be conveniently installed with the Boards Manager tool.

1. In the menu bar, select _Tools > Board > Boards Manager_. In IDE 2.x you can also access it by clicking the button in the left-most sidebar.

2. Either search for the package name (e.g. "megaAVR"), or the board (e.g. "Uno", "MKR1000", or "Portenta"), by typing in the search field.

3. Find the package that includes your board.

4. Click **Install** (the latest version is selected by default).

> If the package is already installed, you will instead have the option of installing a different version.

5. Wait for the installation to complete.

<div>
<figure style="display: inline-block; margin: 0;">
<img src="img/board-manager-install-ide1.png" alt="Searching for 'Nano Every' and installing the resulting megaAVR Boards package in Board Manager in IDE 1.x."/>
<figcaption><i>Boards Manager in Arduino IDE 1.x.</i></figcaption>
</figure>
<figure style="display: inline-block; margin: 0;">
<img src="img/board-manager-install-ide2.png" alt="Searching for 'Nano Every' and installing the resulting megaAVR Boards package in Board Manager in IDE 2.x."/>
<figcaption style><i>Boards Manager in Arduino IDE 2.x.</i></figcaption>
</figure>
</div>

You can now select boards from the installed packages in the _Tools > Board_ menu:

![Selecting Arduino Nano Every from the megaAVR package in Arduino IDE.](img/ide_menu_tools_board_megaAVR_nano_every.png)

---

## Add additional packages to the Boards Manager

See [Add or remove third-party boards in Boards Manager](https://support.arduino.cc/hc/en-us/articles/360016466340-Add-or-remove-third-party-boards-in-Boards-Manager).

---

## Install a board manually

Cores can also be added directly to the file system. See [Find sketches, libraries, board cores, and other files on your computer](https://support.arduino.cc/hc/en-us/articles/4415103213714-Find-sketches-libraries-board-cores-and-other-files-on-your-computer#boards).

---

## Further reading

* [Add or remove third-party boards in Boards Manager](https://support.arduino.cc/hc/en-us/articles/360016466340-Add-or-remove-third-party-boards-in-Boards-Manager)
* [Uninstall boards using the Boards Manager](https://support.arduino.cc/hc/en-us/articles/4407225360018-Uninstall-boards-using-the-Boards-Manager)
Original file line number Diff line number Diff line change
@@ -1,30 +1,38 @@
---
title: "Add a library to Arduino IDE"
title: "Add libraries to Arduino IDE"
id: 5145457742236
---

Libraries are a collection of code that provide extra functionality for use in sketches, for example when working with hardware or manipulating data.

Learn how to add a library to Arduino IDE.
Learn how to add libraries to Arduino IDE.

---

## Using the Library manager

1. In the menu bar, go to `Tools > Manage Libraries...` (In IDE 2, you can also click on the Library Manager icon on the left).
1. **Open the Library Manager:**

2. Search for the library you want to install.
* In the menu bar, select _Tools > Manage Libraries..._
* In IDE 2.x, you can also click on the ![Library Manager icon](img/symbol_library.png) button in the sidebar.

3. Find the library in the search results.
2. Filter the available libraries by typing something (such as a library name) in the text field above the listed libraries.

4. Click on the INSTALL button.
> IDE 1.x also has options to filter by _Type_ and _Topic_.

![IDE 1 Library Manager with search box and Install button highlighted](img/LibraryManager_InstallingLibrary_IDE1.png)
3. Find the library in the search results. The results are listed alphabetically, so you may need to scroll down the list.

![IDE 2 Library Manager Icon, search box, and Install button highlighted](img/LibraryManager_InstallingLibrary_IDE2.png)
> To find more information about the library, click **More info**. This will usually take you to a reference page or repository for the library

4. Find a library you want to install. You can review the description and author. When you've found a library you want to install, click **Install**. The latest version is selected by default.

![Installing libraries in the Library Manager for IDE 1.x and 2.x.](img/add-library.png)
_The Library Manager looks slightly different depending on what version of the IDE you are using._

5. Wait for the installation to complete.

> To find more information about the library, click **More info**. This will usually take you to a reference page or repository for the library

---

## Importing a .zip Library
Expand Down Expand Up @@ -55,6 +63,15 @@ Learn how to add a library to Arduino IDE.

---

## Using installed libraries

When the library has been installed you can do the following:

* Open any included example sketches from _File > Examples > \<Library Name\>_ in the top menu bar. Note that all libraries do not come with examples.
* Include the library in your sketch by selecting _Sketch > Include Library > \<Library Name\>_.

---

## Further reading

* [Uninstall a library from Arduino IDE](https://support.arduino.cc/hc/en-us/articles/360016077340-Uninstall-a-library-from-Arduino-IDE)
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,62 @@
---
title: "Uninstall boards from Arduino IDE"
id: 4407225360018
---

The Boards Manager provides the most convenient way to remove unwanted or unused boards. The location of the installed cores can be found [here](https://support.arduino.cc/hc/en-us/articles/4415103213714#boards).

The following instructions to uninstall is not limited to the core in this example; it equally would be applicable to both official Arduino and third party cores.

---

## Uninstall using the Boards Manager

> **Note:** In Arduino IDE 1.x, the "Arduino AVR Boards" package is bundled with [the application files](https://support.arduino.cc/hc/en-us/articles/4412943340178-Open-the-Arduino-IDE-installation-folder) and cannot be uninstalled using the Boards Manager.

The Boards Manager provides the most convenient way to remove unwanted or unused boards.

1. **Open the Boards Manager:**

* In the menu bar, select _Tools > Board > Boards Manager..._
* In IDE 2.x, you can also click on the ![Boards Manager icon](img/symbol_board.png) button in the sidebar.

2. Filter the results by typing in the text field, and find the board package you want to uninstall.

3. **Uninstall the library:**

* In Arduino IDE 1.x, click the **Remove** button.

* In Arduino IDE 2.x, hover over the "Installed" label to reveal the **Uninstall** button, and click it.

![Uninstalling the SAMD package in Arduino IDE 1.x and 2.x.](img/uninstall-board.png)
_The Library Manager looks slightly different depending on what version of the IDE you are using._

4. Confirm that you want to uninstall the board package.

5. Wait while Arduino IDE uninstalls the board package.

If you want to remove many packages, or are unsure which packages are installed, it will be more efficient to [delete the files directly](#delete-files).

---

<a id="delete-files"></a>

## Uninstall by directly deleting files

The files can also be removed directly with your system's file manager application:

1. [Open the Arduino15 folder](https://support.arduino.cc/hc/en-us/articles/360018448279-Open-the-Arduino15-folder).

2. Open the `packages` subfolder.

3. Open the package vendor's subfolder, e.g. `arduino`, or `adafruit`.

4. Open the `hardware` subfolder. This folder contains the board packages.

5. Remove any/all folders within.

---

## Further reading

* [Add boards to Arduino IDE](https://support.arduino.cc/hc/en-us/articles/360016119519)

This file was deleted.

Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.