Update Site Installation Guide

The Espressif-IDE Eclipse Plugin can be installed using the update site URL, Eclipse Marketplace, or a local archive. This guide provides instructions for each method.

• Installing IDF Plugin using update site URL

• Installing IDF Eclipse Plugin from Eclipse Marketplace

• Installing IDF Eclipse Plugin from Local Archive

• How do I upgrade my existing IDF Eclipse Plugin?

• Upgrading from Espressif-IDE 3.3.0 to 3.4.0

Installing IDF Plugin using update site URL

You can install the IDF Eclipse plugin into an existing Eclipse CDT/Espressif-IDE using the update site URL. First, add the release repository URL as follows:

1. Go to Help > Install New Software.

2. Click Add…, and in the pop-up window:

   • Enter Name as Espressif IDF Plugin for Eclipse.

   • Enter Location of the repository

     • For the stable release: https://dl.espressif.com/dl/idf-eclipse-plugin/updates/latest/.

   • Click Add.

3. Select all from the list and proceed with the installation.

For adding beta and nightly builds, you can use the following update site URLs:

• For Beta version: https://dl.espressif.com/dl/idf-eclipse-plugin/updates/beta/.

• For Nightly build: https://dl.espressif.com/dl/idf-eclipse-plugin/updates/nightly/.

Note

While the screenshots are captured on macOS, the installation instructions are applicable to Windows, Linux, and macOS.

Installing IDF Eclipse Plugin from Eclipse Marketplace

To install the ESP-IDF Eclipse Plugin from the Eclipse Marketplace, follow these steps:

1. Open Eclipse and go to Help > Eclipse Marketplace….

2. In the search box, enter ESP-IDF Eclipse Plugin to locate the plugin.

3. Click Install and follow the on-screen instructions to complete the installation.

4. After installation, restart Eclipse to activate the plugin.

Installing IDF Eclipse Plugin from Local Archive

To install the ESP-IDF Eclipse Plugin from a local archive, follow these steps:

1. Download the latest update site archive for the IDF Eclipse Plugin from [here](https://github.com/espressif/idf-eclipse-plugin/releases).

2. In Eclipse, go to Help > Install New Software.

3. Click the Add… button.

4. In the Add Repository dialog, select Archive and choose the file com.espressif.idf.update-vxxxxxxx.zip.

5. Click Add.

6. Select Espressif IDF from the list and proceed with the installation.

7. Restart Eclipse after the installation is complete.

How do I upgrade my existing IDF Eclipse Plugin?

If you are installing the IDF Eclipse Plugin for the first time, follow these steps to add the repository for the new release:

1. Go to Window > Preferences > Install/Update > Available Software Sites.

2. Click Add.

3. Enter the URL of the new repository: https://dl.espressif.com/dl/idf-eclipse-plugin/updates/latest/.

4. Click Ok.

If you have already installed the IDF Eclipse Plugin using the update site URL, you can upgrade to the latest version with the following steps:

1. Go to Help > Check for Updates.

2. If updates are found, select Espressif IDF Plugins for Eclipse and deselect all other items.

3. Click Next to proceed with the installation.

Upgrading from Espressif-IDE 3.3.0 to 3.4.0

If the next version of the plugin requires updated dependencies (e.g., the minimum CDT version has changed from 11.6 to 12), make sure these dependencies are updated during installation from the update site.

If the required dependencies are not updated, the installer will display the following error: The installation cannot be completed as requested.

To resolve this:

1. Click Show original error and build my own solution.

2. Then select both:

• Update items already installed

• Remove items already installed

This will allow the installer to update or replace any conflicting components and continue the installation successfully.