Release/v4.0.0 (Review for rebase)

.github/workflows/ci.yml

@@ -5,33 +5,31 @@ name: Java CI with Maven
 
 on:
   push:
-    branches: [ master ]
+    branches:
+     - master
+     - release/**
   pull_request:
-    branches: [ master ]
+    branches:
+     - master
+     - release/**
 
 jobs:
-  build:
+  build_linux:
 
-    runs-on:
-      - self-hosted
-      - eclipse
-      - BrnoUBU0004
+    runs-on: [self-hosted, eclipse, BrnoUBU0004]
 
     steps:
-    - uses: actions/checkout@v2
-
-    - name: Clone IDF Release From Github
-      uses: actions/checkout@v2
-      with:
-        repository: espressif/esp-idf
-        path: dependencies/idf-tools
-        submodules: 'true'
-        ref: release/v5.4
+    - uses: actions/checkout@v4
 
     - name: Set up Python
       uses: actions/setup-python@v2
       with:
-          python-version: '3.10'
+        python-version: '3.10'
+
+    - name: Install ESP-IDF via eim		
+      uses: espressif/install-esp-idf-action@v1
+      with:
+        version: 'v5.4'
 
     - name: Set up Maven
       uses: stCarolas/setup-maven@v5
@@ -42,8 +40,9 @@ jobs:
       uses: actions/setup-java@v4
       with:
         java-version: '21'
-        distribution: 'temurin'
-
+        distribution: 'temurin'    
+        cache: 'maven'
+
     - name: Build with Maven
       run: export NO_AT_BRIDGE=1 && mvn clean verify -Djarsigner.skip=true -DskipTests=false -DtestWorkspace=/opt/actions-runner/_work/workspace
 

.github/workflows/ci_release.yml

@@ -4,7 +4,7 @@ on:
   push:
     tags:
       - "v[0-9]+.[0-9]+.[0-9]+"
-      - "v[0-9]+\\.[0-9]+\\.[0-9]+-beta"
+      - "v[0-9]+.[0-9]+.[0-9]+-beta.*"
 
 env:
   ARCHIVE_PREFIX: com.espressif.idf.update-

.github/workflows/ci_windows.yml

@@ -5,9 +5,13 @@ name: Java CI with Maven on Windows
 
 on:
   push:
-    branches: [ master ]
+    branches:
+     - master
+     - release/**
   pull_request:
-    branches: [ master ]
+    branches:
+     - master
+     - release/**
 
 jobs:
   build_windows:

.github/workflows/docs_build.yml

@@ -38,7 +38,7 @@ jobs:
         # Update the path to include them and run.
         cd ./docs
         PATH=/home/runner/.local/bin:$PATH pip3 install -r requirements.txt --prefer-binary
-        PATH=/home/runner/.local/bin:$PATH SPHINXOPTS="-W" build-docs -l en
+        PATH=/home/runner/.local/bin:$PATH SPHINXOPTS="-W" build-docs
     - name: Archive Docs
       uses: actions/upload-artifact@v4
       with:

.github/workflows/docs_production.yml

@@ -46,7 +46,7 @@ jobs:
         echo "PIP install requirements..."
         pip3 install --user -r ./docs/requirements.txt
         echo "Building the Docs..."
-        cd ./docs && build-docs -l en
+        cd ./docs && build-docs
         echo "Deploy the Docs..."
         export DOCS_BUILD_DIR=$GITHUB_WORKSPACE/docs/
         cd $GITHUB_WORKSPACE/docs

bundles/com.espressif.idf.branding/META-INF/MANIFEST.MF

@@ -2,7 +2,7 @@ Manifest-Version: 1.0
 Bundle-ManifestVersion: 2
 Bundle-Name: %pluginName
 Bundle-SymbolicName: com.espressif.idf.branding;singleton:=true
-Bundle-Version: 3.7.0.qualifier
+Bundle-Version: 4.0.0.qualifier
 Bundle-Vendor: %providerName
 Bundle-Localization: plugin
 Bundle-RequiredExecutionEnvironment: JavaSE-17

bundles/com.espressif.idf.core/META-INF/MANIFEST.MF

@@ -46,8 +46,10 @@ Export-Package: com.espressif.idf.core,
  com.espressif.idf.core.resources,
  com.espressif.idf.core.toolchain,
  com.espressif.idf.core.tools,
+ com.espressif.idf.core.tools.exceptions,
  com.espressif.idf.core.tools.util,
  com.espressif.idf.core.tools.vo,
+ com.espressif.idf.core.tools.watcher,
  com.espressif.idf.core.util,
  com.espressif.idf.core.variable,
  org.json.simple,

bundles/com.espressif.idf.core/src/com/espressif/idf/core/IDFCorePreferenceConstants.java

@@ -7,14 +7,11 @@
 
 import org.eclipse.core.resources.IProject;
 import org.eclipse.core.resources.ProjectScope;
-import org.eclipse.core.runtime.Platform;
 import org.eclipse.core.runtime.preferences.ConfigurationScope;
 import org.eclipse.core.runtime.preferences.DefaultScope;
 import org.eclipse.core.runtime.preferences.IEclipsePreferences;
 import org.eclipse.core.runtime.preferences.InstanceScope;
 
-import com.espressif.idf.core.util.IDFUtil;
-
 /**
  * @author Kondal Kolipaka
  * 
@@ -32,16 +29,6 @@ public class IDFCorePreferenceConstants
 	public static final boolean CMAKE_CCACHE_DEFAULT_STATUS = true;
 	public static final boolean AUTOMATE_BUILD_HINTS_DEFAULT_STATUS = true;
 	public static final boolean HIDE_ERRORS_IDF_COMPONENTS_DEFAULT_STATUS = true;
-	public static final String IDF_GITHUB_ASSETS = "IDF_GITHUB_ASSETS"; //$NON-NLS-1$
-	public static final String IDF_GITHUB_ASSETS_DEFAULT_GLOBAL = "dl.espressif.com/github_assets"; //$NON-NLS-1$
-	public static final String IDF_GITHUB_ASSETS_DEFAULT_CHINA = "dl.espressif.cn/github_assets"; //$NON-NLS-1$
-	public static final String PIP_EXTRA_INDEX_URL = "PIP_EXTRA_INDEX_URL"; //$NON-NLS-1$
-	public static final String PIP_EXTRA_INDEX_URL_DEFAULT_GLOBAL = "https://dl.espressif.com/pypi"; //$NON-NLS-1$
-	public static final String PIP_EXTRA_INDEX_URL_DEFAULT_CHINA = "https://dl.espressif.cn/pypi"; //$NON-NLS-1$
-	public static final String IDF_TOOLS_PATH = "IDF_TOOLS_PATH"; //$NON-NLS-1$
-	public static final String IDF_TOOLS_PATH_DEFAULT = Platform.getOS().equals(Platform.OS_WIN32)
-			? IDFUtil.resolveEnvVariable("%USERPROFILE%\\.espressif") //$NON-NLS-1$
-			: IDFUtil.resolveEnvVariable("$HOME/.espressif"); //$NON-NLS-1$
 
 	/**
 	 * Returns the node in the preference in the given context.

bundles/com.espressif.idf.core/src/com/espressif/idf/core/IDFEnvironmentVariables.java

@@ -18,7 +18,6 @@
 import org.eclipse.cdt.managedbuilder.envvar.IBuildEnvironmentVariable;
 
 import com.espressif.idf.core.logging.Logger;
-import com.espressif.idf.core.util.IDFUtil;
 import com.espressif.idf.core.util.StringUtil;
 
 /**
@@ -52,6 +51,12 @@ public class IDFEnvironmentVariables
 
 	public static final String IDF_CCACHE_ENABLE = "IDF_CCACHE_ENABLE"; //$NON-NLS-1$
 
+	public static final String ESP_IDF_EIM_ID = "ESP_IDF_EIM_ID"; //$NON-NLS-1$
+
+	public static final String EIM_PATH = "EIM_PATH"; //$NON-NLS-1$
+
+	public static final String SYSTEM_PATH = "SYSTEM_PATH"; //$NON-NLS-1$
+
 	/**
 	 * @param variableName Environment variable Name
 	 * @return IEnvironmentVariable
@@ -129,16 +134,12 @@ public Map<String, String> getSystemEnvMap()
 		IEnvironmentVariableManager buildEnvironmentManager = CCorePlugin.getDefault().getBuildEnvironmentManager();
 		IEnvironmentVariable[] variables = buildEnvironmentManager.getVariables((ICConfigurationDescription) null,
 				true);
-		Map<String, String> envMap = IDFUtil.getSystemEnv();
+		Map<String, String> envMap = new HashMap<String, String>(System.getenv());
 		if (variables != null)
 		{
 			for (IEnvironmentVariable iEnvironmentVariable : variables)
 			{
 				String key = iEnvironmentVariable.getName();
-				if (key.equals(IDFCorePreferenceConstants.IDF_TOOLS_PATH))
-				{
-					continue;
-				}
 				String value = iEnvironmentVariable.getValue();
 				envMap.put(key, value);
 			}

bundles/com.espressif.idf.core/src/com/espressif/idf/core/bug/BugReportGenerator.java

@@ -323,16 +323,6 @@ private File getInstalledToolsInfoFile() throws IOException
 		Logger.log(environment.toString());
 		environment.put("PYTHONUNBUFFERED", "1"); //$NON-NLS-1$ //$NON-NLS-2$
 
-		environment.put("IDF_GITHUB_ASSETS", //$NON-NLS-1$
-				Platform.getPreferencesService().getString(IDFCorePlugin.PLUGIN_ID,
-						IDFCorePreferenceConstants.IDF_GITHUB_ASSETS,
-						IDFCorePreferenceConstants.IDF_GITHUB_ASSETS_DEFAULT_GLOBAL, null));
-
-		environment.put("PIP_EXTRA_INDEX_URL", //$NON-NLS-1$
-				Platform.getPreferencesService().getString(IDFCorePlugin.PLUGIN_ID,
-						IDFCorePreferenceConstants.PIP_EXTRA_INDEX_URL,
-						IDFCorePreferenceConstants.PIP_EXTRA_INDEX_URL_DEFAULT_GLOBAL, null));
-
 		if (StringUtil.isEmpty(gitExecutablePath))
 		{
 			Logger.log("Git executable path is empty. Please check GIT_PATH environment variable."); //$NON-NLS-1$

bundles/com.espressif.idf.core/src/com/espressif/idf/core/build/IDFBuildConfiguration.java

@@ -359,9 +359,6 @@ private void runCmakeBuildCommand(IConsole console, IProgressMonitor monitor, IP
 				}
 			}
 
-			envVars.add(new EnvironmentVariable(IDFCorePreferenceConstants.IDF_TOOLS_PATH,
-					IDFUtil.getIDFToolsPathFromPreferences()));
-
 			String buildCommand = getProperty(BUILD_COMMAND);
 			if (buildCommand.isBlank())
 			{
@@ -481,10 +478,8 @@ private void runCmakeCommand(IConsole console, IProgressMonitor monitor, IProjec
 		// Set PYTHONUNBUFFERED to 1/TRUE to dump the messages back immediately without
 		// buffering
 		IEnvironmentVariable bufferEnvVar = new EnvironmentVariable("PYTHONUNBUFFERED", "1"); //$NON-NLS-1$ //$NON-NLS-2$
-		IEnvironmentVariable idfToolsPathEnvVar = new EnvironmentVariable(IDFCorePreferenceConstants.IDF_TOOLS_PATH,
-				IDFUtil.getIDFToolsPathFromPreferences());
 
-		Process p = startBuildProcess(command, new IEnvironmentVariable[] { bufferEnvVar, idfToolsPathEnvVar },
+		Process p = startBuildProcess(command, new IEnvironmentVariable[] { bufferEnvVar },
 				workingDir, errConsole, monitor);
 		if (p == null)
 		{

bundles/com.espressif.idf.core/src/com/espressif/idf/core/build/Messages.java

@@ -33,8 +33,26 @@ public class Messages extends NLS
 	public static String ToolsInitializationDifferentPathMessageBoxOptionYes;
 	public static String ToolsInitializationDifferentPathMessageBoxOptionNo;
 	public static String IDFToolChainsMissingErrorMsg;
+
+	public static String ToolsInitializationEimMissingMsgBoxTitle;
+	public static String ToolsInitializationEimMissingMsgBoxMessage;
 
 	public static String RefreshingProjects_JobName;
+
+	public static String NoActiveEspIdfInWorkspaceMsgTitle;
+	public static String NoActiveEspIdfInWorkspaceMsg;
+
+	public static String OldConfigFoundMsgBoxTitle;
+	public static String OldConfigFoundMsgBoxMsg;
+	public static String OldConfigExportDirectorSelectionDialogTitle;
+	public static String OldConfigExportDirectorSelectionDialogInfo;
+	public static String OldConfigExportCompleteSuccessMsgTitle;
+	public static String OldConfigExportCompleteSuccessMsg;
+	public static String OldConfigExportCompleteFailMsgTitle;
+	public static String OldConfigExportCompleteFailMsg;
+
+	public static String EIMNotInApplicationsTitle;
+	public static String EIMNotInApplicationsMessage;
 
 	static
 	{

bundles/com.espressif.idf.core/src/com/espressif/idf/core/build/messages.properties

@@ -19,9 +19,26 @@ IDFBuildConfiguration_ParseCommand=Parse Compile Commands File
 IncreasePartitionSizeTitle=Low Application Partition Size
 IncreasePartitionSizeMessage=Less than 30% of application partition size is free({0} of {1} bytes), would you like to increase it? Please click <a href={2}>here</a> to check more details.
 ToolsInitializationDifferentPathMessageBoxTitle=Different IDF path found in the config file
+ToolsInitializationEimMissingMsgBoxTitle=ESP-IDF Installation Required
+ToolsInitializationEimMissingMsgBoxMessage=ESP-IDF is not currently installed on your system.\n\nThe IDE can automatically download and launch the EIM - GUI Installer to help you install it.\n\nWould you like to proceed with the installation?\n\nOnce complete, ESP-IDF will be detected automatically. You can also manage installations later from the ESP-IDF Manager (Espressif > ESP-IDF Manager). 
 ToolsInitializationDifferentPathMessageBoxMessage=A different ESP-IDF path was found in the esp_idf.json.json configuration file. Do you want to install the tools in the new path or the old path? Please click on the appropriate button.\nNew Path: {0}\nOld Path: {1}
-ToolsInitializationDifferentPathMessageBoxOptionYes=Use New Path
-ToolsInitializationDifferentPathMessageBoxOptionNo=Use Old Path
+ToolsInitializationDifferentPathMessageBoxOptionYes=Yes
+ToolsInitializationDifferentPathMessageBoxOptionNo=No
 RefreshingProjects_JobName=Refreshing Projects...
 IDFBuildConfiguration_PreCheck_DifferentIdfPath=The project was built using the ESP-IDF located at the {0} path.\nThe currently active ESP-IDF path in the IDE is {1}.\nPlease clean the project using "ESP-IDF:Project Full Clean" menu option to use the active ESP-IDF configuration. 
-IDFToolChainsMissingErrorMsg=Toolchains are missing. Please use ESP-IDF Manager for configuring
+IDFToolChainsMissingErrorMsg=Toolchains are missing. Please use ESP-IDF Manager for configuring
+
+NoActiveEspIdfInWorkspaceMsgTitle=ESP-IDF Setup
+NoActiveEspIdfInWorkspaceMsg=ESP-IDF tools installed via EIM have been detected, but this workspace is not configured yet. The IDE needs to complete setup to enable full functionality. Would you like to proceed now?
+
+EIMNotInApplicationsTitle=EIM Not Located in Applications Folder
+EIMNotInApplicationsMessage=Espressif Installation Manager (EIM) is not located in the Applications folder.\nRunning EIM from a temporary location (e.g., a mounted disk image) may cause issues during configuration import or tool setup.\nTo avoid problems, please move EIM to the /Applications directory and launch it from there.
+
+OldConfigFoundMsgBoxTitle=Old Configuration Detected
+OldConfigFoundMsgBoxMsg=Espressif IDE now uses the EIM system to manage ESP-IDF installations. A legacy configuration was found in your current workspace. Converting it to the EIM format will allow proper environment setup and ensure the IDE works seamlessly with your existing projects. Would you like to convert the configuration now?
+OldConfigExportDirectorSelectionDialogTitle=Select Destination
+OldConfigExportDirectorSelectionDialogInfo=Choose a directory to save the exported settings.
+OldConfigExportCompleteSuccessMsgTitle=Import Successful
+OldConfigExportCompleteSuccessMsg=The old configuration has been successfully imported.
+OldConfigExportCompleteFailMsgTitle=Conversion Failed
+OldConfigExportCompleteFailMsg=An error occurred while importing old configuration.

bundles/com.espressif.idf.core/src/com/espressif/idf/core/logging/Logger.java

@@ -20,6 +20,10 @@
  */
 public class Logger
 {
+	public static void log(String message, Exception e)
+	{
+		log(IDFCorePlugin.getPlugin(), message, e);
+	}
 
 	public static void log(String message)
 	{

bundles/com.espressif.idf.core/src/com/espressif/idf/core/toolchain/ESPToolChainManager.java

@@ -179,7 +179,7 @@ public File findToolChain(List<String> paths, String filePattern)
 
 	private Path[] getDirectories(String path)
 	{
-		return Arrays.stream(path.split(File.pathSeparator)).map(String::trim).map(Paths::get).filter(Files::exists)
+		return Arrays.stream(path.split(File.pathSeparator)).map(String::trim).map(Paths::get).filter(Files::exists).filter(Files::isDirectory)
 				.toArray(Path[]::new);
 	}
 
@@ -318,7 +318,7 @@ protected String getIdfToolsExportPath()
 			Logger.log(commands.toString());
 
 			IStatus idfToolsExportStatus = new ProcessBuilderFactory().runInBackground(commands,
-					org.eclipse.core.runtime.Path.ROOT, IDFUtil.getSystemEnv());
+					org.eclipse.core.runtime.Path.ROOT, System.getenv());
 			if (idfToolsExportStatus != null && idfToolsExportStatus.isOK())
 			{
 				String message = idfToolsExportStatus.getMessage();

bundles/com.espressif.idf.core/src/com/espressif/idf/core/tools/DownloadListener.java

@@ -0,0 +1,19 @@
+/*******************************************************************************
+ * Copyright 2025 Espressif Systems (Shanghai) PTE LTD. All rights reserved.
+ * Use is subject to license terms.
+ *******************************************************************************/
+package com.espressif.idf.core.tools;
+
+/**
+ * Interface to use for the download listening this can be used in your own classes. 
+ * Added specifically for {@link EimLoader} 
+ * @author Ali Azam Rana <[email protected]>
+ *
+ */
+public interface DownloadListener
+{
+	public void onProgress(int percent);
+	public void onCompleted(String filePath);
+	public void onError(String message, Exception e);
+
+}

bundles/com.espressif.idf.core/src/com/espressif/idf/core/tools/EimConstants.java

@@ -0,0 +1,31 @@
+package com.espressif.idf.core.tools;
+
+import java.io.File;
+import java.nio.file.Paths;
+
+public interface EimConstants
+{
+	String EIM_JSON = "eim_idf.json"; //$NON-NLS-1$
+
+	String EIM_POSIX_DIR = System.getProperty("user.home").concat(File.separator +  ".espressif" + File.separator + "tools" + File.separator);  //$NON-NLS-1$//$NON-NLS-2$ //$NON-NLS-3$
+
+	String EIM_WIN_ESPRESSIF_DIR = "C:" + File.separator + "Espressif"; //$NON-NLS-1$ //$NON-NLS-2$
+
+	String EIM_WIN_DIR = EIM_WIN_ESPRESSIF_DIR + File.separator + "tools" + File.separator;  //$NON-NLS-1$
+
+	String EIM_WIN_PATH = EIM_WIN_DIR + EIM_JSON;
+
+	String EIM_URL = "https://dl.espressif.com/dl/eim/"; //$NON-NLS-1$
+
+	String EIM_POSIX_PATH = EIM_POSIX_DIR + EIM_JSON;
+
+	String INSTALL_TOOLS_FLAG = "INSTALL_TOOLS_FLAG"; //$NON-NLS-1$
+
+	String TOOL_SET_CONFIG_LEGACY_CONFIG_FILE = "tool_set_config.json"; //$NON-NLS-1$
+
+	String OLD_CONFIG_EXPORTED_FLAG = "OLD_CONFIG_EXPORTED_FLAG"; //$NON-NLS-1$
+
+	String USER_EIM_DIR = Paths.get(System.getProperty("user.home"), ".espressif", "eim_gui").toString(); //$NON-NLS-1$ //$NON-NLS-2$ //$NON-NLS-3$
+
+	String EIM_JSON_VALID_VERSION = "1.0"; //$NON-NLS-1$
+}