Troubleshooting
Suggestions for Build Errors using Hints Viewer
If you encounter a problem during a build, there may be a hint for this error in the ESP-IDF hint database, located at tools/idf_py_actions/hints.yml
in ESP-IDF. The ESP-IDF Eclipse plugin provides a hint viewer where you can type an error message to find a hint for it.
Prerequisites: The hints.yml
file is available from ESP-IDF v5.0 and higher. If you are using an older version, you can manually download the hints.yml
file from here and save it to esp-idf/tools/idf_py_actions/
. To download the file, right-click the Raw
button and select Save as...
.
To open the hints viewer:
1. Navigate to Windows
-> Show View
-> Other...
-> Espressif
-> Hints
.
Now you can type or paste an error from the build log, such as:
ccache error: Failed to create temporary file for esp-idf/libsodium/CMakeFiles/..../....: No such file or directory
Double-clicking on the row will display the hint message if it doesn’t fully fit on your screen.
Error Log
The Error Log view captures warnings and errors logged by plug-ins. The log file is stored in the .log
file within the .metadata
subdirectory of the workspace.
To open the Error Log view:
- Go to Window
> Show View
> Error Log
.
To export the current log view content:
1. Press the Export Log
toolbar button or select Export Log...
from the context menu.
2. Enter a file name.
It’s recommended to include an error log when reporting an issue.
Console View Log
The Console View shows warnings and errors related to the current running process or build. To access the Console View:
From the menu bar, select
Window
>Show View
>Console
.
CDT Global Build Log
To enable global build logging:
- Go to Preferences
> C/C++
> Build
> Logging
.
Espressif IDF Tools Console
The Espressif IDF Tools Console is part of the Console view and opens during the installation of IDF tools from Eclipse.
If you encounter any issues during installation of IDF tools via Espressif
> ESP-IDF Tools Manager
> Install tools
, check the Espressif IDF Tools Console for errors.
If this console is not active, switch to it by clicking on the Display Selected Console
icon in the console view.