Project

  • project
  • static library
  • idf_component_register
  • target_link_libraries
  • sdkconfig
  • fullclean

When using SNTP in ESP-IDF 5.4, which component names need to be added as dependencies in the CMake file?

Add dependencies based on the header files you use. For SNTP, refer to:

#include "esp_netif_sntp.h"
#include "lwip/ip_addr.h"
#include "esp_sntp.h"

Then add REQUIRES esp_netif lwip to your component CMakeLists.txt. You can locate the owning components by checking where the headers are stored, for example:

components/esp_netif/include/esp_netif_sntp.h
components/lwip/lwip/src/include/lwip/ip_addr.h
components/lwip/include/apps/esp_sntp.h

So the required component names here are esp_netif and lwip. The same method applies to other components as well.

How can I enable the 120 MHz clock for PSRAM and flash in ESP-IDF?

Enable the Make experimental features visible option in menuconfig.

menuconfig_make_experimental

PSRAM is enabled in menuconfig on ESP32-S3, but it is not detected at boot and the system keeps resetting. How should this be configured?

After enabling PSRAM, make sure the PSRAM bus mode is configured correctly.

  • If the PSRAM size is greater than 4 MB, select 8-line mode.
  • If the PSRAM size is 4 MB or smaller, select 4-line mode.

If the bus mode is configured incorrectly, PSRAM may not be detected correctly during boot, which can lead to continuous reset loops.

How can an ESP-IDF component be built as a static library (.a file)?

ESP-IDF components are built into static libraries by default. The output file is usually named lib[component_name].a. This is useful for feature encapsulation, code reuse, and closed-source delivery.

Register the source files and include directories in the component CMakeLists.txt:

idf_component_register(SRCS "xxx.c" INCLUDE_DIRS "include")

After building the project, the build system generates the corresponding libxxx.a file automatically.

When another component or project uses the static library, add the proper component dependency in CMakeLists.txt, or link it through target_link_libraries(), and make sure the header include paths are available.

Notes:

  • Some standard C APIs behave differently in ESP-IDF. For example, fopen() is eventually routed through VFS, so the runtime environment must be considered during porting.
  • Static library functions may depend on component registration and system initialization, such as VFS, SPIFFS, or FAT.
  • For closed-source delivery, provide both libxxx.a and the include/ header directory.

What should I do if ESP-IDF build behavior becomes abnormal because of sdkconfig issues, or if program behavior changes unexpectedly after switching branches?

This type of issue is usually caused by a mismatch between the local sdkconfig and the current code, target chip, or component dependencies. It is especially common after switching branches, changing the target chip, or updating dependencies.

Handle it in this order:

  1. Run idf.py fullclean to remove old build artifacts.
  2. If the configuration file may already be inconsistent, back up the current sdkconfig and then delete it.
  3. Run idf.py set-target esp32, or set the actual chip model used by the project.
  4. Run idf.py menuconfig or idf.py build again so ESP-IDF regenerates the configuration.

If the project provides sdkconfig.defaults, regenerate sdkconfig from that file whenever possible to keep team configuration consistent.