Skip to content

Update "Add libraries to Arduino IDE" and "Uninstall libraries from Arduino IDE" [HC-1302] [HC-1605] #438

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.

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

Merged
merged 8 commits into from
Oct 22, 2024
Merged
Show file tree
Hide file tree
Changes from 7 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 @@ -3,22 +3,20 @@ title: "Uninstall libraries from Arduino IDE"
id: 360016077340
---

There are two ways of removing libraries:
Learn how to uninstall Arduino libraries, whether through the Library Manager for individual removals or by using your file manager for bulk deletions across all IDE versions.

* [Uninstall libraries with the Library manager (requires IDE 2)](#library-manager). Easy way to remove individual libraries.
* [Remove libraries with your file manager](#file-manager). A better option if you want to remove many libraries and it works for all versions of the IDE.
In this article:

---
* [Uninstall libraries using the Library Manager](#library-manager)
* [Remove libraries manually using the file manager](#file-manager)

<a id="library-manager"></a>
---

## Uninstall libraries with the Library manager
## Uninstall libraries using the Library Manager{#library-manager}

The Library Manager in Arduino IDE 2 can be used to uninstall individual libraries:

1. Click the ![Library Manager button](img/symbol_library.png) **Library Manager** button or select _Tools > Manage Libraries..._ in the menu bar.

![Opening the Library Manager.](img/ide2-library-manager-open.png)
1. Click the ![Library Manager button](img/symbol_library.png) **Library Manager** button in the sidebar, or select _Tools > Manage Libraries..._ in the menu bar.

2. Filter your search:

Expand All @@ -29,17 +27,16 @@ The Library Manager in Arduino IDE 2 can be used to uninstall individual librari

3. Find the library in the search results. Note that the results are listed alphabetically.

4. Put your mouse cursor over the INSTALLED label and click UNINSTALL to uninstall the library.
4. Click the **Remove** button.

![Uninstalling the ArduinoBLE library.](img/ide2-library-manager-uninstall.png)
![Uninstalling the AlPlc_Opta library.](img/ide2-library-manager-uninstall.png)

5. Confirm that you want to uninstall the library by clicking **Yes**.

---

<a id="file-manager"></a>
> [!NOTE]
> If a newer version of the library is available, the **Remove** button will be replaced by an **Update** button. To remove the library in this case, click the three dots in the top-right corner and select **Remove**.

## Remove libraries with your file manager
## Remove libraries manually using the file manager{#file-manager}

This method allows you to remove many libraries at once. It works for all types of libraries and versions of Arduino IDE.

Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file not shown.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Original file line number Diff line number Diff line change
Expand Up @@ -3,33 +3,31 @@ 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.
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 libraries to Arduino IDE.

Learn how to add libraries to Arduino IDE.
In this article:

---
- [Using the Library Manager](#library-manager)
- [Importing a .zip library](#zip-library)
- [Manual installation](#manual-installation)
- [Using installed libraries](#using-libraries)

<a id="library-manager"></a>
---

## Using the Library manager
## Using the Library Manager{#library-manager}

1. **Open the Library Manager:**
1. Do one of the following:

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

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

> IDE 1.x also has options to filter by _Type_ and _Topic_.

3. Find the library in the search results. The results are listed alphabetically, so you may need to scroll down the list.

> 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 and IDE 2.](img/add-library.png)
_The Library Manager looks slightly different depending on what version of the IDE you are using._
![Installing libraries in the Library Manager for IDE 2.](img/add-library.png)

5. Wait for the installation to complete.

Expand All @@ -38,21 +36,15 @@ Learn how to add libraries to Arduino IDE.

---

## Importing a .zip Library
## Importing a .zip library{zip-library}

1. In the menu bar, go to `Sketch > Include Library > Add .ZIP Library...`
1. In the menu bar, go to _Sketch > Include Library > Add .ZIP Library..._

2. You will be prompted to select the library you want to add. Navigate to the .zip file's location and open it.

3. If you're using Arduino IDE 2, you may need to restart it for the library to be available[^1].

[^1]: <https://github.com/arduino/arduino-ide/issues/659>

---

<a id="manual-installation"></a>

## Manual installation
## Manual installation{manual-installation}

1. Go to the directory where you have downloaded the .zip library file.

Expand All @@ -67,21 +59,23 @@ Learn how to add libraries to Arduino IDE.

---

## Using installed libraries
## Using installed libraries {#using-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\>_.
- Open any included example sketches from _File > Examples > \<Library Name\>_ in the top menu bar.

> [!NOTE]
> Some libraries don't 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)

* [Installing libraries in the Arduino IDE 1](https://docs.arduino.cc/software/ide-v1/tutorials/installing-libraries#importing-a-zip-library) on Arduino Docs
- [Uninstall a library from Arduino IDE](https://support.arduino.cc/hc/en-us/articles/360016077340-Uninstall-a-library-from-Arduino-IDE)

* [Installing libraries in the Arduino IDE 2](https://docs.arduino.cc/software/ide-v2/tutorials/ide-v2-installing-a-library) on Arduino Docs
- [Installing libraries in the Arduino IDE 2](https://docs.arduino.cc/software/ide-v2/tutorials/ide-v2-installing-a-library) on Arduino Docs

* About [#include](https://www.arduino.cc/reference/en/language/structure/further-syntax/include/)
- About [#include](https://www.arduino.cc/reference/en/language/structure/further-syntax/include/)
Binary file modified content/Software Support/Installation/img/add-library.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.