How to fix ESP-IDF fatal error: esp_console.h: No such file or directory

Problem

When building an ESP-IDF project, you may encounter the following error:

/home/user/MyProject/main/main.cpp:7:10: fatal error: esp_console.h: No such file or directory
    7 | #include <esp_console.h>
      |          ^~~~~~~~~~~~~~~
compilation terminated.

Solution

You need to ensure that the console component is included in your project. This can be done by modifying your main/CMakeLists.txt file to include the console component as a dependency.

You can do this by adding the REQUIRES console line in your idf_component_register function. Here’s how to modify your main/CMakeLists.txt file:

idf_component_register(
    SRCS "main.cpp"
    INCLUDE_DIRS "../include"
    REQUIRES console
)