Chapter 4. API Guides
idf_build_executable(executable)
Specify the executable executable for ESP-IDF build. This attaches additional targets such as dependencies related
to flashing, generating additional binary files, etc. Should be called after idf_build_process.
idf_build_get_config(var config [GENERATOR_EXPRESSION])
Get the value of the specified config. Much like build properties, specifying GENERATOR_EXPRESSION will retrieve
the generator expression string for that config, instead of the actual value, which can be used with CMake commands
that support generator expressions. Actual config values are only known after call to idf_build_process,
however.
idf-build-properties
These are properties that describe the build. Values of build properties can be retrieved by using the build command
idf_build_get_property. For example, to get the Python interpreter used for the build:
idf_build_get_property(python PYTHON)
message(STATUS "The Python intepreter is: ${python}")
• BUILD_DIR - build directory; set from idf_build_process BUILD_DIR argument
• BUILD_COMPONENTS - list of components included in the build; set by idf_build_process
• BUILD_COMPONENT_ALIASES - list of library alias of components included in the build; set by
idf_build_process
• C_COMPILE_OPTIONS - compile options applied to all components’C source files
• COMPILE_OPTIONS - compile options applied to all components’source files, regardless of it being C or
C++
• COMPILE_DEFINITIONS - compile definitions applied to all component source files
• CXX_COMPILE_OPTIONS - compile options applied to all components’C++ source files
• EXECUTABLE - project executable; set by call to idf_build_executable
• EXECUTABLE_NAME - name of project executable without extension; set by call to
idf_build_executable
• EXECUTABLE_DIR - path containing the output executable
• IDF_PATH - ESP-IDF path; set from IDF_PATH environment variable, if not, inferred from the location of
idf.cmake
• IDF_TARGET - target chip for the build; set from the required target argument for idf_build_process
• IDF_VER - ESP-IDF version; set from either a version file or the Git revision of the IDF_PATH repository
• INCLUDE_DIRECTORIES - include directories for all component source files
• KCONFIGS - list of Kconfig files found in components in build; set by idf_build_process
• KCONFIG_PROJBUILDS - list of Kconfig.projbuild files found in components in build; set by
idf_build_process
• PROJECT_NAME - name of the project; set from idf_build_process PROJECT_NAME argument
• PROJECT_DIR - directory of the project; set from idf_build_process PROJECT_DIR argument
• PROJECT_VER - version of the project; set from idf_build_process PROJECT_VER argument
• PYTHON - Python interpreter used for the build; set from PYTHON environment variable if available, if not
“python”is used
• SDKCONFIG - full path to output config file; set from idf_build_process SDKCONFIG argument
• SDKCONFIG_DEFAULTS - list of files containing default config to use in the build; set from
idf_build_process SDKCONFIG_DEFAULTS argument
• SDKCONFIG_HEADER - full path to C/C++ header file containing component configuration; set by
idf_build_process
• SDKCONFIG_CMAKE - full path to CMake file containing component configuration; set by
idf_build_process
• SDKCONFIG_JSON - full path to JSON file containing component configuration; set by
idf_build_process
• SDKCONFIG_JSON_MENUS - full path to JSON file containing config menus; set by
idf_build_process
Espressif Systems 1292
Submit Document Feedback
Release v4.4
To Next Page
Loading...
Need help?
General