Project Configuration¶
Introduction¶
ESP-IDF uses kconfiglib which is a Python-based extension to the Kconfig system which provides a compile-time project configuration mechanism. Kconfig is based around options of several types: integer, string, boolean. Kconfig files specify dependencies between options, default values of the options, the way the options are grouped together, etc.
For the complete list of available features please see Kconfig and kconfiglib extentions.
Using sdkconfig.defaults¶
In some cases, such as when sdkconfig
file is under revision control, the fact that sdkconfig
file gets changed by the build system may be inconvenient. The build system offers a way to avoid this, in the form of sdkconfig.defaults
file. This file is never touched by the build system, and must be created manually. It can contain all the options which matter for the given application. The format is the same as that of the sdkconfig
file. Once sdkconfig.defaults
is created, sdkconfig
can be deleted and added to the ignore list of the revision control system (e.g. .gitignore
file for git). Project build targets will automatically create sdkconfig
file, populated with the settings from sdkconfig.defaults
file, and the rest of the settings will be set to their default values. Note that the build process will not override settings that are already in sdkconfig
by ones from sdkconfig.defaults
. For more information, see Custom sdkconfig defaults.
Kconfig Formatting Rules¶
The following attributes of Kconfig
files are standardized:
Within any menu, option names should have a consistent prefix. The prefix length is currently set to at least 3 characters.
The indentation style is 4 characters created by spaces. All sub-items belonging to a parent item are indented by one level deeper. For example,
menu
is indented by 0 characters, theconfig
inside of the menu by 4 characters, the help of theconfig
by 8 characters and the text of thehelp
by 12 characters.No trailing spaces are allowed at the end of the lines.
The maximum length of options is set to 40 characters.
The maximum length of lines is set to 120 characters.
Lines cannot be wrapped by backslash (because there is a bug in earlier versions of
conf-idf
which causes that Windows line endings are not recognized after a backslash).
Format checker¶
tools/check_kconfigs.py
is provided for checking the Kconfig
formatting
rules. The checker checks all Kconfig
and Kconfig.projbuild
files in
the ESP-IDF directory and generates a new file with suffix .new
with some
recommendations how to fix issues (if there are any). Please note that the
checker cannot correct all rules and the responsibility of the developer is to
check and make final corrections in order to pass the tests. For example,
indentations will be corrected if there isn’t some misleading previous
formatting but it cannot come up with a common prefix for options inside a
menu.
Backward Compatibility of Kconfig Options¶
The standard Kconfig tools ignore unknown options in sdkconfig
. So if a
developer has custom settings for options which are renamed in newer ESP-IDF
releases then the given setting for the option would be silently ignored.
Therefore, several features have been adopted to avoid this:
confgen.py
is used by the tool chain to pre-processsdkconfig
files before anything else, for examplemenuconfig
, would read them. As the consequence, the settings for old options will be kept and not ignored.confgen.py
recursively finds allsdkconfig.rename
files in ESP-IDF directory which contain old and newKconfig
option names. Old options are replaced by new ones in thesdkconfig
file.confgen.py
post-processessdkconfig
files and generates all build outputs (sdkconfig.h
,sdkconfig.cmake
,auto.conf
) by adding a list of compatibility statements, i.e. value of the old option is set the value of the new option (after modification). This is done in order to not break customer codes where old option might still be used.Deprecated options and their replacements are automatically generated by
confgen.py
.
Configuration Options Reference¶
Subsequent sections contain the list of available ESP-IDF options, automatically generated from Kconfig files. Note that depending on the options selected, some options listed here may not be visible by default in the interface of menuconfig.
By convention, all option names are upper case with underscores. When Kconfig generates sdkconfig and sdkconfig.h files, option names are prefixed with CONFIG_
. So if an option ENABLE_FOO
is defined in a Kconfig file and selected in menuconfig, then sdkconfig and sdkconfig.h files will have CONFIG_ENABLE_FOO
defined. In this reference, option names are also prefixed with CONFIG_
, same as in the source code.
SDK tool configuration¶
Contains:
CONFIG_SDK_TOOLPREFIX¶
Compiler toolchain path/prefix
Found in: SDK tool configuration
The prefix/path that is used to call the toolchain. The default setting assumes a crosstool-ng gcc setup that is in your PATH.
- Default value:
“riscv32-esp-elf-“
CONFIG_SDK_PYTHON¶
Python interpreter
Found in: SDK tool configuration
The executable name/path that is used to run python.
(Note: This option is used with the legacy GNU Make build system only.)
- Default value:
“python”
CONFIG_SDK_MAKE_WARN_UNDEFINED_VARIABLES¶
‘make’ warns on undefined variables
Found in: SDK tool configuration
Adds –warn-undefined-variables to MAKEFLAGS. This causes make to print a warning any time an undefined variable is referenced.
This option helps find places where a variable reference is misspelled or otherwise missing, but it can be unwanted if you have Makefiles which depend on undefined variables expanding to an empty string.
(Note: this option is used with the legacy GNU Make build system only.)
- Default value:
Yes (enabled)
CONFIG_SDK_TOOLCHAIN_SUPPORTS_TIME_WIDE_64_BITS¶
Toolchain supports time_t wide 64-bits
Found in: SDK tool configuration
Enable this option in case you have a custom toolchain which supports time_t wide 64-bits. This option checks time_t is 64-bits and disables ROM time functions to use the time functions from the toolchain instead. This option allows resolving the Y2K38 problem. See “Setup Linux Toolchain from Scratch” to build a custom toolchain which supports 64-bits time_t.
Note: ESP-IDF does not currently come with any pre-compiled toolchain that supports 64-bit wide time_t. This will change in a future major release, but currently 64-bit time_t requires a custom built toolchain.
- Default value:
No (disabled)
Build type¶
Contains:
CONFIG_APP_BUILD_TYPE¶
Application build type
Found in: Build type
Select the way the application is built.
By default, the application is built as a binary file in a format compatible with the ESP-IDF bootloader. In addition to this application, 2nd stage bootloader is also built. Application and bootloader binaries can be written into flash and loaded/executed from there.
Another option, useful for only very small and limited applications, is to only link the .elf file of the application, such that it can be loaded directly into RAM over JTAG. Note that since IRAM and DRAM sizes are very limited, it is not possible to build any complex application this way. However for kinds of testing and debugging, this option may provide faster iterations, since the application does not need to be written into flash. Note that at the moment, ESP-IDF does not contain all the startup code required to initialize the CPUs and ROM memory (data/bss). Therefore it is necessary to execute a bit of ROM code prior to executing the application. A gdbinit file may look as follows (for ESP32):
# Connect to a running instance of OpenOCD target remote :3333 # Reset and halt the target mon reset halt # Run to a specific point in ROM code, # where most of initialization is complete. thb *0x40007d54 c # Load the application into RAM load # Run till app_main tb app_main c
Execute this gdbinit file as follows:
xtensa-esp32-elf-gdb build/app-name.elf -x gdbinit
Example gdbinit files for other targets can be found in tools/test_apps/system/gdb_loadable_elf/
Recommended sdkconfig.defaults for building loadable ELF files is as follows. CONFIG_APP_BUILD_TYPE_ELF_RAM is required, other options help reduce application memory footprint.
CONFIG_APP_BUILD_TYPE_ELF_RAM=y CONFIG_VFS_SUPPORT_TERMIOS= CONFIG_NEWLIB_NANO_FORMAT=y CONFIG_ESP_SYSTEM_PANIC_PRINT_HALT=y CONFIG_ESP_DEBUG_STUBS_ENABLE= CONFIG_ESP_ERR_TO_NAME_LOOKUP=
- Available options:
Default (binary application + 2nd stage bootloader) (APP_BUILD_TYPE_APP_2NDBOOT)
ELF file, loadable into RAM (EXPERIMENTAL)) (APP_BUILD_TYPE_ELF_RAM)
Application manager¶
Contains:
CONFIG_APP_COMPILE_TIME_DATE¶
Use time/date stamp for app
Found in: Application manager
If set, then the app will be built with the current time/date stamp. It is stored in the app description structure. If not set, time/date stamp will be excluded from app image. This can be useful for getting the same binary image files made from the same source, but at different times.
- Default value:
Yes (enabled)
CONFIG_APP_EXCLUDE_PROJECT_VER_VAR¶
Exclude PROJECT_VER from firmware image
Found in: Application manager
The PROJECT_VER variable from the build system will not affect the firmware image. This value will not be contained in the esp_app_desc structure.
- Default value:
No (disabled)
CONFIG_APP_EXCLUDE_PROJECT_NAME_VAR¶
Exclude PROJECT_NAME from firmware image
Found in: Application manager
The PROJECT_NAME variable from the build system will not affect the firmware image. This value will not be contained in the esp_app_desc structure.
- Default value:
No (disabled)
CONFIG_APP_PROJECT_VER_FROM_CONFIG¶
Get the project version from Kconfig
Found in: Application manager
If this is enabled, then config item APP_PROJECT_VER will be used for the variable PROJECT_VER. Other ways to set PROJECT_VER will be ignored.
- Default value:
No (disabled)
CONFIG_APP_PROJECT_VER¶
Project version
Found in: Application manager > CONFIG_APP_PROJECT_VER_FROM_CONFIG
Project version
- Default value:
CONFIG_APP_RETRIEVE_LEN_ELF_SHA¶
The length of APP ELF SHA is stored in RAM(chars)
Found in: Application manager
At startup, the app will read this many hex characters from the embedded APP ELF SHA-256 hash value and store it in static RAM. This ensures the app ELF SHA-256 value is always available if it needs to be printed by the panic handler code. Changing this value will change the size of a static buffer, in bytes.
- Range:
from 8 to 64
- Default value:
16
Bootloader config¶
Contains:
CONFIG_BOOTLOADER_COMPILER_OPTIMIZATION¶
Bootloader optimization Level
Found in: Bootloader config
This option sets compiler optimization level (gcc -O argument) for the bootloader.
The default “Size” setting will add the -0s flag to CFLAGS.
The “Debug” setting will add the -Og flag to CFLAGS.
The “Performance” setting will add the -O2 flag to CFLAGS.
The “None” setting will add the -O0 flag to CFLAGS.
Note that custom optimization levels may be unsupported.
- Available options:
Size (-Os) (BOOTLOADER_COMPILER_OPTIMIZATION_SIZE)
Debug (-Og) (BOOTLOADER_COMPILER_OPTIMIZATION_DEBUG)
Optimize for performance (-O2) (BOOTLOADER_COMPILER_OPTIMIZATION_PERF)
Debug without optimization (-O0) (BOOTLOADER_COMPILER_OPTIMIZATION_NONE)
CONFIG_BOOTLOADER_LOG_LEVEL¶
Bootloader log verbosity
Found in: Bootloader config
Specify how much output to see in bootloader logs.
- Available options:
No output (BOOTLOADER_LOG_LEVEL_NONE)
Error (BOOTLOADER_LOG_LEVEL_ERROR)
Warning (BOOTLOADER_LOG_LEVEL_WARN)
Info (BOOTLOADER_LOG_LEVEL_INFO)
Debug (BOOTLOADER_LOG_LEVEL_DEBUG)
Verbose (BOOTLOADER_LOG_LEVEL_VERBOSE)
CONFIG_BOOTLOADER_VDDSDIO_BOOST¶
VDDSDIO LDO voltage
Found in: Bootloader config
If this option is enabled, and VDDSDIO LDO is set to 1.8V (using eFuse or MTDI bootstrapping pin), bootloader will change LDO settings to output 1.9V instead. This helps prevent flash chip from browning out during flash programming operations.
This option has no effect if VDDSDIO is set to 3.3V, or if the internal VDDSDIO regulator is disabled via eFuse.
- Available options:
1.8V (BOOTLOADER_VDDSDIO_BOOST_1_8V)
1.9V (BOOTLOADER_VDDSDIO_BOOST_1_9V)
CONFIG_BOOTLOADER_FACTORY_RESET¶
GPIO triggers factory reset
Found in: Bootloader config
Allows to reset the device to factory settings: - clear one or more data partitions; - boot from “factory” partition. The factory reset will occur if there is a GPIO input held at the configured level while device starts up. See settings below.
- Default value:
No (disabled)
CONFIG_BOOTLOADER_NUM_PIN_FACTORY_RESET¶
Number of the GPIO input for factory reset
Found in: Bootloader config > CONFIG_BOOTLOADER_FACTORY_RESET
The selected GPIO will be configured as an input with internal pull-up enabled (note that on some SoCs. not all pins have an internal pull-up, consult the hardware datasheet for details.) To trigger a factory reset, this GPIO must be held high or low (as configured) on startup.
- Default value:
CONFIG_BOOTLOADER_FACTORY_RESET_PIN_LEVEL¶
Factory reset GPIO level
Found in: Bootloader config > CONFIG_BOOTLOADER_FACTORY_RESET
Pin level for factory reset, can be triggered on low or high.
- Available options:
Reset on GPIO low (BOOTLOADER_FACTORY_RESET_PIN_LOW)
Reset on GPIO high (BOOTLOADER_FACTORY_RESET_PIN_HIGH)
CONFIG_BOOTLOADER_OTA_DATA_ERASE¶
Clear OTA data on factory reset (select factory partition)
Found in: Bootloader config > CONFIG_BOOTLOADER_FACTORY_RESET
The device will boot from “factory” partition (or OTA slot 0 if no factory partition is present) after a factory reset.
CONFIG_BOOTLOADER_DATA_FACTORY_RESET¶
Comma-separated names of partitions to clear on factory reset
Found in: Bootloader config > CONFIG_BOOTLOADER_FACTORY_RESET
Allows customers to select which data partitions will be erased while factory reset.
Specify the names of partitions as a comma-delimited with optional spaces for readability. (Like this: “nvs, phy_init, …”) Make sure that the name specified in the partition table and here are the same. Partitions of type “app” cannot be specified here.
- Default value:
“nvs” if CONFIG_BOOTLOADER_FACTORY_RESET
CONFIG_BOOTLOADER_APP_TEST¶
GPIO triggers boot from test app partition
Found in: Bootloader config
Allows to run the test app from “TEST” partition. A boot from “test” partition will occur if there is a GPIO input pulled low while device starts up. See settings below.
- Default value:
No (disabled) if CONFIG_BOOTLOADER_APP_ANTI_ROLLBACK
CONFIG_BOOTLOADER_NUM_PIN_APP_TEST¶
Number of the GPIO input to boot TEST partition
Found in: Bootloader config > CONFIG_BOOTLOADER_APP_TEST
The selected GPIO will be configured as an input with internal pull-up enabled. To trigger a test app, this GPIO must be pulled low on reset. After the GPIO input is deactivated and the device reboots, the old application will boot. (factory or OTA[x]). Note that GPIO34-39 do not have an internal pullup and an external one must be provided.
- Range:
from 0 to 39 if CONFIG_BOOTLOADER_APP_TEST
- Default value:
CONFIG_BOOTLOADER_HOLD_TIME_GPIO¶
Hold time of GPIO for reset/test mode (seconds)
Found in: Bootloader config
The GPIO must be held low continuously for this period of time after reset before a factory reset or test partition boot (as applicable) is performed.
- Default value:
CONFIG_BOOTLOADER_WDT_ENABLE¶
Use RTC watchdog in start code
Found in: Bootloader config
Tracks the execution time of startup code. If the execution time is exceeded, the RTC_WDT will restart system. It is also useful to prevent a lock up in start code caused by an unstable power source. NOTE: Tracks the execution time starts from the bootloader code - re-set timeout, while selecting the source for slow_clk - and ends calling app_main. Re-set timeout is needed due to WDT uses a SLOW_CLK clock source. After changing a frequency slow_clk a time of WDT needs to re-set for new frequency. slow_clk depends on ESP32_RTC_CLK_SRC (INTERNAL_RC or EXTERNAL_CRYSTAL).
- Default value:
Yes (enabled)
CONFIG_BOOTLOADER_WDT_DISABLE_IN_USER_CODE¶
Allows RTC watchdog disable in user code
Found in: Bootloader config > CONFIG_BOOTLOADER_WDT_ENABLE
If this option is set, the ESP-IDF app must explicitly reset, feed, or disable the rtc_wdt in the app’s own code. If this option is not set (default), then rtc_wdt will be disabled by ESP-IDF before calling the app_main() function.
Use function rtc_wdt_feed() for resetting counter of rtc_wdt. Use function rtc_wdt_disable() for disabling rtc_wdt.
- Default value:
No (disabled)
CONFIG_BOOTLOADER_WDT_TIME_MS¶
Timeout for RTC watchdog (ms)
Found in: Bootloader config > CONFIG_BOOTLOADER_WDT_ENABLE
Verify that this parameter is correct and more then the execution time. Pay attention to options such as reset to factory, trigger test partition and encryption on boot - these options can increase the execution time. Note: RTC_WDT will reset while encryption operations will be performed.
- Range:
from 0 to 120000
- Default value:
9000
CONFIG_BOOTLOADER_APP_ROLLBACK_ENABLE¶
Enable app rollback support
Found in: Bootloader config
After updating the app, the bootloader runs a new app with the “ESP_OTA_IMG_PENDING_VERIFY” state set. This state prevents the re-run of this app. After the first boot of the new app in the user code, the function should be called to confirm the operability of the app or vice versa about its non-operability. If the app is working, then it is marked as valid. Otherwise, it is marked as not valid and rolls back to the previous working app. A reboot is performed, and the app is booted before the software update. Note: If during the first boot a new app the power goes out or the WDT works, then roll back will happen. Rollback is possible only between the apps with the same security versions.
- Default value:
No (disabled)
CONFIG_BOOTLOADER_APP_ANTI_ROLLBACK¶
Enable app anti-rollback support
Found in: Bootloader config > CONFIG_BOOTLOADER_APP_ROLLBACK_ENABLE
This option prevents rollback to previous firmware/application image with lower security version.
- Default value:
No (disabled) if CONFIG_BOOTLOADER_APP_ROLLBACK_ENABLE
CONFIG_BOOTLOADER_APP_SECURE_VERSION¶
eFuse secure version of app
Found in: Bootloader config > CONFIG_BOOTLOADER_APP_ROLLBACK_ENABLE > CONFIG_BOOTLOADER_APP_ANTI_ROLLBACK
The secure version is the sequence number stored in the header of each firmware. The security version is set in the bootloader, version is recorded in the eFuse field as the number of set ones. The allocated number of bits in the efuse field for storing the security version is limited (see BOOTLOADER_APP_SEC_VER_SIZE_EFUSE_FIELD option).
Bootloader: When bootloader selects an app to boot, an app is selected that has a security version greater or equal that recorded in eFuse field. The app is booted with a higher (or equal) secure version.
The security version is worth increasing if in previous versions there is a significant vulnerability and their use is not acceptable.
Your partition table should has a scheme with ota_0 + ota_1 (without factory).
- Default value:
CONFIG_BOOTLOADER_APP_SEC_VER_SIZE_EFUSE_FIELD¶
Size of the efuse secure version field
Found in: Bootloader config > CONFIG_BOOTLOADER_APP_ROLLBACK_ENABLE > CONFIG_BOOTLOADER_APP_ANTI_ROLLBACK
The size of the efuse secure version field. Its length is limited to 32 bits for ESP32 and 16 bits for ESP32-S2. This determines how many times the security version can be increased.
- Range:
from 1 to 16 if CONFIG_BOOTLOADER_APP_ANTI_ROLLBACK
- Default value:
CONFIG_BOOTLOADER_EFUSE_SECURE_VERSION_EMULATE¶
Emulate operations with efuse secure version(only test)
Found in: Bootloader config > CONFIG_BOOTLOADER_APP_ROLLBACK_ENABLE > CONFIG_BOOTLOADER_APP_ANTI_ROLLBACK
This option allows to emulate read/write operations with all eFuses and efuse secure version. It allows to test anti-rollback implemention without permanent write eFuse bits. There should be an entry in partition table with following details: emul_efuse, data, efuse, , 0x2000.
This option enables: EFUSE_VIRTUAL and EFUSE_VIRTUAL_KEEP_IN_FLASH.
- Default value:
No (disabled) if CONFIG_BOOTLOADER_APP_ANTI_ROLLBACK
CONFIG_BOOTLOADER_SKIP_VALIDATE_IN_DEEP_SLEEP¶
Skip image validation when exiting deep sleep
Found in: Bootloader config
This option disables the normal validation of an image coming out of deep sleep (checksums, SHA256, and signature). This is a trade-off between wakeup performance from deep sleep, and image integrity checks.
Only enable this if you know what you are doing. It should not be used in conjunction with using deep_sleep() entry and changing the active OTA partition as this would skip the validation upon first load of the new OTA partition.
It is possible to enable this option with Secure Boot if “allow insecure options” is enabled, however it’s strongly recommended to NOT enable it as it may allow a Secure Boot bypass.
- Default value:
No (disabled) if (CONFIG_SECURE_BOOT && CONFIG_SECURE_BOOT_INSECURE) || CONFIG_SECURE_BOOT
CONFIG_BOOTLOADER_SKIP_VALIDATE_ON_POWER_ON¶
Skip image validation from power on reset (READ HELP FIRST)
Found in: Bootloader config
Some applications need to boot very quickly from power on. By default, the entire app binary is read from flash and verified which takes up a significant portion of the boot time.
Enabling this option will skip validation of the app when the SoC boots from power on. Note that in this case it’s not possible for the bootloader to detect if an app image is corrupted in the flash, therefore it’s not possible to safely fall back to a different app partition. Flash corruption of this kind is unlikely but can happen if there is a serious firmware bug or physical damage.
Following other reset types, the bootloader will still validate the app image. This increases the chances that flash corruption resulting in a crash can be detected following soft reset, and the bootloader will fall back to a valid app image. To increase the chances of successfully recovering from a flash corruption event, keep the option BOOTLOADER_WDT_ENABLE enabled and consider also enabling BOOTLOADER_WDT_DISABLE_IN_USER_CODE - then manually disable the RTC Watchdog once the app is running. In addition, enable both the Task and Interrupt watchdog timers with reset options set.
- Default value:
No (disabled)
CONFIG_BOOTLOADER_SKIP_VALIDATE_ALWAYS¶
Skip image validation always (READ HELP FIRST)
Found in: Bootloader config
Selecting this option prevents the bootloader from ever validating the app image before booting it. Any flash corruption of the selected app partition will make the entire SoC unbootable.
Although flash corruption is a very rare case, it is not recommended to select this option. Consider selecting “Skip image validation from power on reset” instead. However, if boot time is the only important factor then it can be enabled.
- Default value:
No (disabled)
CONFIG_BOOTLOADER_CUSTOM_RESERVE_RTC¶
Reserve RTC FAST memory for custom purposes
Found in: Bootloader config
This option allows the customer to place data in the RTC FAST memory, this area remains valid when rebooted, except for power loss. This memory is located at a fixed address and is available for both the bootloader and the application. (The application and bootoloader must be compiled with the same option). The RTC FAST memory has access only through PRO_CPU.
- Default value:
No (disabled)
CONFIG_BOOTLOADER_CUSTOM_RESERVE_RTC_SIZE¶
Size in bytes for custom purposes
Found in: Bootloader config > CONFIG_BOOTLOADER_CUSTOM_RESERVE_RTC
This option reserves in RTC FAST memory the area for custom purposes. If you want to create your own bootloader and save more information in this area of memory, you can increase it. It must be a multiple of 4 bytes. This area (rtc_retain_mem_t) is reserved and has access from the bootloader and an application.
- Range:
from 0 to 0x10 if CONFIG_BOOTLOADER_CUSTOM_RESERVE_RTC
- Default value:
CONFIG_BOOTLOADER_FLASH_XMC_SUPPORT¶
Enable the support for flash chips of XMC (READ HELP FIRST)
Found in: Bootloader config
Perform the startup flow recommended by XMC. Please consult XMC for the details of this flow. XMC chips will be forbidden to be used, when this option is disabled.
DON’T DISABLE THIS UNLESS YOU KNOW WHAT YOU ARE DOING.
- Default value:
Yes (enabled)
Security features¶
Contains:
CONFIG_SECURE_SIGNED_APPS_NO_SECURE_BOOT¶
Require signed app images
Found in: Security features
Require apps to be signed to verify their integrity.
This option uses the same app signature scheme as hardware secure boot, but unlike hardware secure boot it does not prevent the bootloader from being physically updated. This means that the device can be secured against remote network access, but not physical access. Compared to using hardware Secure Boot this option is much simpler to implement.
CONFIG_SECURE_SIGNED_APPS_SCHEME¶
App Signing Scheme
Found in: Security features
Select the Secure App signing scheme. Depends on the Chip Revision. There are two options: 1. ECDSA based secure boot scheme. (Only choice for Secure Boot V1) Supported in ESP32 and ESP32-ECO3. 2. The RSA based secure boot scheme. (Only choice for Secure Boot V2) Supported in ESP32-ECO3 (ESP32 Chip Revision 3 onwards), ESP32-S2, ESP32-C3, ESP32-S3.
- Available options:
ECDSA (SECURE_SIGNED_APPS_ECDSA_SCHEME)
Embeds the ECDSA public key in the bootloader and signs the application with an ECDSA key.
Refer to the documentation before enabling.
RSA (SECURE_SIGNED_APPS_RSA_SCHEME)
Appends the RSA-3072 based Signature block to the application. Refer to <Secure Boot Version 2 documentation link> before enabling.
CONFIG_SECURE_SIGNED_ON_UPDATE_NO_SECURE_BOOT¶
Verify app signature on update
Found in: Security features
If this option is set, any OTA updated apps will have the signature verified before being considered valid.
When enabled, the signature is automatically checked whenever the esp_ota_ops.h APIs are used for OTA updates, or esp_image_format.h APIs are used to verify apps.
If hardware secure boot is enabled, this option is always enabled and cannot be disabled. If hardware secure boot is not enabled, this option still adds significant security against network-based attackers by preventing spoofing of OTA updates.
- Default value:
Yes (enabled) if CONFIG_SECURE_SIGNED_APPS_NO_SECURE_BOOT
CONFIG_SECURE_BOOT¶
Enable hardware Secure Boot in bootloader (READ DOCS FIRST)
Found in: Security features
Build a bootloader which enables Secure Boot on first boot.
Once enabled, Secure Boot will not boot a modified bootloader. The bootloader will only load a partition table or boot an app if the data has a verified digital signature. There are implications for reflashing updated apps once secure boot is enabled.
When enabling secure boot, JTAG and ROM BASIC Interpreter are permanently disabled by default.
- Default value:
No (disabled)
CONFIG_SECURE_BOOT_VERSION¶
Select secure boot version
Found in: Security features > CONFIG_SECURE_BOOT
Select the Secure Boot Version. Depends on the Chip Revision. Secure Boot V2 is the new RSA based secure boot scheme. Supported in ESP32-ECO3 (ESP32 Chip Revision 3 onwards), ESP32-S2, ESP32-C3 ECO3. Secure Boot V1 is the AES based secure boot scheme. Supported in ESP32 and ESP32-ECO3.
- Available options:
Enable Secure Boot version 1 (SECURE_BOOT_V1_ENABLED)
Build a bootloader which enables secure boot version 1 on first boot. Refer to the Secure Boot section of the ESP-IDF Programmer’s Guide for this version before enabling.
Enable Secure Boot version 2 (SECURE_BOOT_V2_ENABLED)
Build a bootloader which enables Secure Boot version 2 on first boot. Refer to Secure Boot V2 section of the ESP-IDF Programmer’s Guide for this version before enabling.
CONFIG_SECURE_BOOT_BUILD_SIGNED_BINARIES¶
Sign binaries during build
Found in: Security features
Once secure boot or signed app requirement is enabled, app images are required to be signed.
If enabled (default), these binary files are signed as part of the build process. The file named in “Secure boot private signing key” will be used to sign the image.
If disabled, unsigned app/partition data will be built. They must be signed manually using espsecure.py. Version 1 to enable ECDSA Based Secure Boot and Version 2 to enable RSA based Secure Boot. (for example, on a remote signing server.)
CONFIG_SECURE_BOOT_SIGNING_KEY¶
Secure boot private signing key
Found in: Security features > CONFIG_SECURE_BOOT_BUILD_SIGNED_BINARIES
Path to the key file used to sign app images.
Key file is an ECDSA private key (NIST256p curve) in PEM format for Secure Boot V1. Key file is an RSA private key in PEM format for Secure Boot V2.
Path is evaluated relative to the project directory.
You can generate a new signing key by running the following command: espsecure.py generate_signing_key secure_boot_signing_key.pem
See the Secure Boot section of the ESP-IDF Programmer’s Guide for this version for details.
- Default value:
“secure_boot_signing_key.pem” if CONFIG_SECURE_BOOT_BUILD_SIGNED_BINARIES
CONFIG_SECURE_BOOT_VERIFICATION_KEY¶
Secure boot public signature verification key
Found in: Security features
Path to a public key file used to verify signed images. Secure Boot V1: This ECDSA public key is compiled into the bootloader and/or app, to verify app images. Secure Boot V2: This RSA public key is compiled into the signature block at the end of the bootloader/app.
Key file is in raw binary format, and can be extracted from a PEM formatted private key using the espsecure.py extract_public_key command.
Refer to the Secure Boot section of the ESP-IDF Programmer’s Guide for this version before enabling.
CONFIG_SECURE_BOOT_ENABLE_AGGRESSIVE_KEY_REVOKE¶
Enable Aggressive key revoke strategy
Found in: Security features
If this option is set, ROM bootloader will revoke the public key digest burned in efuse block if it fails to verify the signature of software bootloader with it. Revocation of keys does not happen when enabling secure boot. Once secure boot is enabled, key revocation checks will be done on subsequent boot-up, while verifying the software bootloader
This feature provides a strong resistance against physical attacks on the device.
NOTE: Once a digest slot is revoked, it can never be used again to verify an image This can lead to permanent bricking of the device, in case all keys are revoked because of signature verification failure.
- Default value:
No (disabled) if CONFIG_SECURE_BOOT
CONFIG_SECURE_BOOT_INSECURE¶
Allow potentially insecure options
Found in: Security features
You can disable some of the default protections offered by secure boot, in order to enable testing or a custom combination of security features.
Only enable these options if you are very sure.
Refer to the Secure Boot section of the ESP-IDF Programmer’s Guide for this version before enabling.
- Default value:
No (disabled) if CONFIG_SECURE_BOOT
CONFIG_SECURE_FLASH_ENC_ENABLED¶
Enable flash encryption on boot (READ DOCS FIRST)
Found in: Security features
If this option is set, flash contents will be encrypted by the bootloader on first boot.
Note: After first boot, the system will be permanently encrypted. Re-flashing an encrypted system is complicated and not always possible.
Read Flash Encryption before enabling.
- Default value:
No (disabled)
CONFIG_SECURE_FLASH_ENCRYPTION_MODE¶
Enable usage mode
Found in: Security features > CONFIG_SECURE_FLASH_ENC_ENABLED
By default Development mode is enabled which allows ROM download mode to perform flash encryption operations (plaintext is sent to the device, and it encrypts it internally and writes ciphertext to flash.) This mode is not secure, it’s possible for an attacker to write their own chosen plaintext to flash.
Release mode should always be selected for production or manufacturing. Once enabled it’s no longer possible for the device in ROM Download Mode to use the flash encryption hardware.
Refer to the Flash Encryption section of the ESP-IDF Programmer’s Guide for details.
- Available options:
Development (NOT SECURE) (SECURE_FLASH_ENCRYPTION_MODE_DEVELOPMENT)
Release (SECURE_FLASH_ENCRYPTION_MODE_RELEASE)
Potentially insecure options¶
Contains:
CONFIG_SECURE_BOOT_ALLOW_JTAG¶
Allow JTAG Debugging
Found in: Security features > Potentially insecure options
If not set (default), the bootloader will permanently disable JTAG (across entire chip) on first boot when either secure boot or flash encryption is enabled.
Setting this option leaves JTAG on for debugging, which negates all protections of flash encryption and some of the protections of secure boot.
Only set this option in testing environments.
- Default value:
No (disabled) if CONFIG_SECURE_BOOT_INSECURE || SECURE_FLASH_ENCRYPTION_MODE_DEVELOPMENT
CONFIG_SECURE_BOOT_ALLOW_SHORT_APP_PARTITION¶
Allow app partition length not 64KB aligned
Found in: Security features > Potentially insecure options
If not set (default), app partition size must be a multiple of 64KB. App images are padded to 64KB length, and the bootloader checks any trailing bytes after the signature (before the next 64KB boundary) have not been written. This is because flash cache maps entire 64KB pages into the address space. This prevents an attacker from appending unverified data after the app image in the flash, causing it to be mapped into the address space.
Setting this option allows the app partition length to be unaligned, and disables padding of the app image to this length. It is generally not recommended to set this option, unless you have a legacy partitioning scheme which doesn’t support 64KB aligned partition lengths.
CONFIG_SECURE_BOOT_V2_ALLOW_EFUSE_RD_DIS¶
Allow additional read protecting of efuses
Found in: Security features > Potentially insecure options
If not set (default, recommended), on first boot the bootloader will burn the WR_DIS_RD_DIS efuse when Secure Boot is enabled. This prevents any more efuses from being read protected.
If this option is set, it will remain possible to write the EFUSE_RD_DIS efuse field after Secure Boot is enabled. This may allow an attacker to read-protect the BLK2 efuse (for ESP32) and BLOCK4-BLOCK10 (i.e. BLOCK_KEY0-BLOCK_KEY5)(for other chips) holding the public key digest, causing an immediate denial of service and possibly allowing an additional fault injection attack to bypass the signature protection.
NOTE: Once a BLOCK is read-protected, the application will read all zeros from that block
NOTE: If “UART ROM download mode (Permanently disabled (recommended))” or “UART ROM download mode (Permanently switch to Secure mode (recommended))” is set, then it is __NOT__ possible to read/write efuses using espefuse.py utility. However, efuse can be read/written from the application
CONFIG_SECURE_BOOT_ALLOW_UNUSED_DIGEST_SLOTS¶
Leave unused digest slots available (not revoke)
Found in: Security features > Potentially insecure options
If not set (default), during startup in the app all unused digest slots will be revoked. To revoke unused slot will be called esp_efuse_set_digest_revoke(num_digest) for each digest. Revoking unused digest slots makes ensures that no trusted keys can be added later by an attacker. If set, it means that you have a plan to use unused digests slots later.
- Default value:
No (disabled) if CONFIG_SECURE_BOOT_INSECURE
CONFIG_SECURE_FLASH_UART_BOOTLOADER_ALLOW_ENC¶
Leave UART bootloader encryption enabled
Found in: Security features > Potentially insecure options
If not set (default), the bootloader will permanently disable UART bootloader encryption access on first boot. If set, the UART bootloader will still be able to access hardware encryption.
It is recommended to only set this option in testing environments.
- Default value:
No (disabled) if SECURE_FLASH_ENCRYPTION_MODE_DEVELOPMENT
CONFIG_SECURE_FLASH_UART_BOOTLOADER_ALLOW_CACHE¶
Leave UART bootloader flash cache enabled
Found in: Security features > Potentially insecure options
If not set (default), the bootloader will permanently disable UART bootloader flash cache access on first boot. If set, the UART bootloader will still be able to access the flash cache.
Only set this option in testing environments.
- Default value:
No (disabled) if SECURE_FLASH_ENCRYPTION_MODE_DEVELOPMENT
CONFIG_SECURE_FLASH_REQUIRE_ALREADY_ENABLED¶
Require flash encryption to be already enabled
Found in: Security features > Potentially insecure options
If not set (default), and flash encryption is not yet enabled in eFuses, the 2nd stage bootloader will enable flash encryption: generate the flash encryption key and program eFuses. If this option is set, and flash encryption is not yet enabled, the bootloader will error out and reboot. If flash encryption is enabled in eFuses, this option does not change the bootloader behavior.
Only use this option in testing environments, to avoid accidentally enabling flash encryption on the wrong device. The device needs to have flash encryption already enabled using espefuse.py.
- Default value:
No (disabled) if SECURE_FLASH_ENCRYPTION_MODE_DEVELOPMENT
CONFIG_SECURE_FLASH_CHECK_ENC_EN_IN_APP¶
Check Flash Encryption enabled on app startup
Found in: Security features
If set (default), in an app during startup code, there is a check of the flash encryption eFuse bit is on (as the bootloader should already have set it). The app requires this bit is on to continue work otherwise abort.
If not set, the app does not care if the flash encryption eFuse bit is set or not.
- Default value:
Yes (enabled) if CONFIG_SECURE_FLASH_ENC_ENABLED
CONFIG_SECURE_UART_ROM_DL_MODE¶
UART ROM download mode
Found in: Security features
- Available options:
UART ROM download mode (Permanently disabled (recommended)) (SECURE_DISABLE_ROM_DL_MODE)
If set, during startup the app will burn an eFuse bit to permanently disable the UART ROM Download Mode. This prevents any future use of esptool.py, espefuse.py and similar tools.
Once disabled, if the SoC is booted with strapping pins set for ROM Download Mode then an error is printed instead.
It is recommended to enable this option in any production application where Flash Encryption and/or Secure Boot is enabled and access to Download Mode is not required.
It is also possible to permanently disable Download Mode by calling esp_efuse_disable_rom_download_mode() at runtime.
UART ROM download mode (Permanently switch to Secure mode (recommended)) (SECURE_ENABLE_SECURE_ROM_DL_MODE)
If set, during startup the app will burn an eFuse bit to permanently switch the UART ROM Download Mode into a separate Secure Download mode. This option can only work if Download Mode is not already disabled by eFuse.
Secure Download mode limits the use of Download Mode functions to simple flash read, write and erase operations, plus a command to return a summary of currently enabled security features.
Secure Download mode is not compatible with the esptool.py flasher stub feature, espefuse.py, read/writing memory or registers, encrypted download, or any other features that interact with unsupported Download Mode commands.
Secure Download mode should be enabled in any application where Flash Encryption and/or Secure Boot is enabled. Disabling this option does not immediately cancel the benefits of the security features, but it increases the potential “attack surface” for an attacker to try and bypass them with a successful physical attack.
It is also possible to enable secure download mode at runtime by calling esp_efuse_enable_rom_secure_download_mode()
Note: Secure Download mode is not available for ESP32 (includes revisions till ECO3).
UART ROM download mode (Enabled (not recommended)) (SECURE_INSECURE_ALLOW_DL_MODE)
This is a potentially insecure option. Enabling this option will allow the full UART download mode to stay enabled. This option SHOULD NOT BE ENABLED for production use cases.
Boot ROM Behavior¶
Contains:
CONFIG_BOOT_ROM_LOG_SCHEME¶
Permanently change Boot ROM output
Found in: Boot ROM Behavior
Controls the Boot ROM log behavior. The rom log behavior can only be changed for once, specific eFuse bit(s) will be burned at app boot stage.
- Available options:
Always Log (BOOT_ROM_LOG_ALWAYS_ON)
Always print ROM logs, this is the default behavior.
Permanently disable logging (BOOT_ROM_LOG_ALWAYS_OFF)
Don’t print ROM logs.
Log on GPIO High (BOOT_ROM_LOG_ON_GPIO_HIGH)
Print ROM logs when GPIO level is high during start up. The GPIO number is chip dependent, e.g. on ESP32-S2, the control GPIO is GPIO46.
Log on GPIO Low (BOOT_ROM_LOG_ON_GPIO_LOW)
Print ROM logs when GPIO level is low during start up. The GPIO number is chip dependent, e.g. on ESP32-S2, the control GPIO is GPIO46.
Serial flasher config¶
Contains:
CONFIG_ESPTOOLPY_PORT¶
Default serial port
Found in: Serial flasher config
The serial port that’s connected to the ESP chip. This can be overridden by setting the ESPPORT environment variable.
This value is ignored when using the CMake-based build system or idf.py.
- Default value:
“/dev/ttyUSB0”
CONFIG_ESPTOOLPY_BAUD¶
Default baud rate
Found in: Serial flasher config
Default baud rate to use while communicating with the ESP chip. Can be overridden by setting the ESPBAUD variable.
This value is ignored when using the CMake-based build system or idf.py.
- Available options:
115200 baud (ESPTOOLPY_BAUD_115200B)
230400 baud (ESPTOOLPY_BAUD_230400B)
921600 baud (ESPTOOLPY_BAUD_921600B)
2Mbaud (ESPTOOLPY_BAUD_2MB)
Other baud rate (ESPTOOLPY_BAUD_OTHER)
CONFIG_ESPTOOLPY_BAUD_OTHER_VAL¶
CONFIG_ESPTOOLPY_COMPRESSED¶
Use compressed upload
Found in: Serial flasher config
The flasher tool can send data compressed using zlib, letting the ROM on the ESP chip decompress it on the fly before flashing it. For most payloads, this should result in a speed increase.
- Default value:
Yes (enabled)
CONFIG_ESPTOOLPY_NO_STUB¶
Disable download stub
Found in: Serial flasher config
The flasher tool sends a precompiled download stub first by default. That stub allows things like compressed downloads and more. Usually you should not need to disable that feature
- Default value:
No (disabled)
CONFIG_ESPTOOLPY_FLASHMODE¶
Flash SPI mode
Found in: Serial flasher config
Mode the flash chip is flashed in, as well as the default mode for the binary to run in.
- Available options:
QIO (ESPTOOLPY_FLASHMODE_QIO)
QOUT (ESPTOOLPY_FLASHMODE_QOUT)
DIO (ESPTOOLPY_FLASHMODE_DIO)
DOUT (ESPTOOLPY_FLASHMODE_DOUT)
OPI (ESPTOOLPY_FLASHMODE_OPI)
CONFIG_ESPTOOLPY_FLASH_SAMPLE_MODE¶
Flash Sampling Mode
Found in: Serial flasher config
- Available options:
STR Mode (ESPTOOLPY_FLASH_SAMPLE_MODE_STR)
DTR Mode (ESPTOOLPY_FLASH_SAMPLE_MODE_DTR)
CONFIG_ESPTOOLPY_FLASHFREQ¶
Flash SPI speed
Found in: Serial flasher config
The SPI flash frequency to be used.
- Available options:
120 MHz (ESPTOOLPY_FLASHFREQ_120M)
80 MHz (ESPTOOLPY_FLASHFREQ_80M)
40 MHz (ESPTOOLPY_FLASHFREQ_40M)
26 MHz (ESPTOOLPY_FLASHFREQ_26M)
20 MHz (ESPTOOLPY_FLASHFREQ_20M)
CONFIG_ESPTOOLPY_FLASHSIZE¶
Flash size
Found in: Serial flasher config
SPI flash size, in megabytes
- Available options:
1 MB (ESPTOOLPY_FLASHSIZE_1MB)
2 MB (ESPTOOLPY_FLASHSIZE_2MB)
4 MB (ESPTOOLPY_FLASHSIZE_4MB)
8 MB (ESPTOOLPY_FLASHSIZE_8MB)
16 MB (ESPTOOLPY_FLASHSIZE_16MB)
CONFIG_ESPTOOLPY_FLASHSIZE_DETECT¶
Detect flash size when flashing bootloader
Found in: Serial flasher config
If this option is set, flashing the project will automatically detect the flash size of the target chip and update the bootloader image before it is flashed.
- Default value:
Yes (enabled)
CONFIG_ESPTOOLPY_BEFORE¶
Before flashing
Found in: Serial flasher config
Configure whether esptool.py should reset the ESP32 before flashing.
Automatic resetting depends on the RTS & DTR signals being wired from the serial port to the ESP32. Most USB development boards do this internally.
- Available options:
Reset to bootloader (ESPTOOLPY_BEFORE_RESET)
No reset (ESPTOOLPY_BEFORE_NORESET)
CONFIG_ESPTOOLPY_AFTER¶
After flashing
Found in: Serial flasher config
Configure whether esptool.py should reset the ESP32 after flashing.
Automatic resetting depends on the RTS & DTR signals being wired from the serial port to the ESP32. Most USB development boards do this internally.
- Available options:
Reset after flashing (ESPTOOLPY_AFTER_RESET)
Stay in bootloader (ESPTOOLPY_AFTER_NORESET)
CONFIG_ESPTOOLPY_MONITOR_BAUD¶
‘idf.py monitor’ baud rate
Found in: Serial flasher config
Baud rate to use when running ‘idf.py monitor’ or ‘make monitor’ to view serial output from a running chip.
If “Same as UART Console baud rate” is chosen then the value will follow the “UART Console baud rate” config item.
Can override by setting the MONITORBAUD environment variable.
- Available options:
Same as UART console baud rate (ESPTOOLPY_MONITOR_BAUD_CONSOLE)
9600 bps (ESPTOOLPY_MONITOR_BAUD_9600B)
57600 bps (ESPTOOLPY_MONITOR_BAUD_57600B)
115200 bps (ESPTOOLPY_MONITOR_BAUD_115200B)
230400 bps (ESPTOOLPY_MONITOR_BAUD_230400B)
921600 bps (ESPTOOLPY_MONITOR_BAUD_921600B)
2 Mbps (ESPTOOLPY_MONITOR_BAUD_2MB)
Custom baud rate (ESPTOOLPY_MONITOR_BAUD_OTHER)
CONFIG_ESPTOOLPY_MONITOR_BAUD_OTHER_VAL¶
Partition Table¶
Contains:
CONFIG_PARTITION_TABLE_TYPE¶
Partition Table
Found in: Partition Table
The partition table to flash to the ESP32. The partition table determines where apps, data and other resources are expected to be found.
The predefined partition table CSV descriptions can be found in the components/partition_table directory. These are mostly intended for example and development use, it’s expect that for production use you will copy one of these CSV files and create a custom partition CSV for your application.
- Available options:
Single factory app, no OTA (PARTITION_TABLE_SINGLE_APP)
This is the default partition table, designed to fit into a 2MB or larger flash with a single 1MB app partition.
The corresponding CSV file in the IDF directory is components/partition_table/partitions_singleapp.csv
This partition table is not suitable for an app that needs OTA (over the air update) capability.
Single factory app (large), no OTA (PARTITION_TABLE_SINGLE_APP_LARGE)
This is a variation of the default partition table, that expands the 1MB app partition size to 1.5MB to fit more code.
The corresponding CSV file in the IDF directory is components/partition_table/partitions_singleapp_large.csv
This partition table is not suitable for an app that needs OTA (over the air update) capability.
Factory app, two OTA definitions (PARTITION_TABLE_TWO_OTA)
This is a basic OTA-enabled partition table with a factory app partition plus two OTA app partitions. All are 1MB, so this partition table requires 4MB or larger flash size.
The corresponding CSV file in the IDF directory is components/partition_table/partitions_two_ota.csv
Custom partition table CSV (PARTITION_TABLE_CUSTOM)
Specify the path to the partition table CSV to use for your project.
Consult the Partition Table section in the ESP-IDF Programmers Guide for more information.
Single factory app, no OTA, encrypted NVS (PARTITION_TABLE_SINGLE_APP_ENCRYPTED_NVS)
This is a variation of the default “Single factory app, no OTA” partition table that supports encrypted NVS when using flash encryption. See the Flash Encryption section in the ESP-IDF Programmers Guide for more information.
The corresponding CSV file in the IDF directory is components/partition_table/partitions_singleapp_encr_nvs.csv
Single factory app (large), no OTA, encrypted NVS (PARTITION_TABLE_SINGLE_APP_LARGE_ENC_NVS)
This is a variation of the “Single factory app (large), no OTA” partition table that supports encrypted NVS when using flash encryption. See the Flash Encryption section in the ESP-IDF Programmers Guide for more information.
The corresponding CSV file in the IDF directory is components/partition_table/partitions_singleapp_large_encr_nvs.csv
Factory app, two OTA definitions, encrypted NVS (PARTITION_TABLE_TWO_OTA_ENCRYPTED_NVS)
This is a variation of the “Factory app, two OTA definitions” partition table that supports encrypted NVS when using flash encryption. See the Flash Encryption section in the ESP-IDF Programmers Guide for more information.
The corresponding CSV file in the IDF directory is components/partition_table/partitions_two_ota_encr_nvs.csv
CONFIG_PARTITION_TABLE_CUSTOM_FILENAME¶
Custom partition CSV file
Found in: Partition Table
Name of the custom partition CSV filename. This path is evaluated relative to the project root directory.
- Default value:
“partitions.csv”
CONFIG_PARTITION_TABLE_OFFSET¶
Offset of partition table
Found in: Partition Table
The address of partition table (by default 0x8000). Allows you to move the partition table, it gives more space for the bootloader. Note that the bootloader and app will both need to be compiled with the same PARTITION_TABLE_OFFSET value.
This number should be a multiple of 0x1000.
Note that partition offsets in the partition table CSV file may need to be changed if this value is set to a higher value. To have each partition offset adapt to the configured partition table offset, leave all partition offsets blank in the CSV file.
- Default value:
“0x8000”
CONFIG_PARTITION_TABLE_MD5¶
Generate an MD5 checksum for the partition table
Found in: Partition Table
Generate an MD5 checksum for the partition table for protecting the integrity of the table. The generation should be turned off for legacy bootloaders which cannot recognize the MD5 checksum in the partition table.
- Default value:
Yes (enabled) if ESP32_COMPATIBLE_PRE_V3_1_BOOTLOADERS
Compiler options¶
Contains:
CONFIG_COMPILER_OPTIMIZATION¶
Optimization Level
Found in: Compiler options
This option sets compiler optimization level (gcc -O argument) for the app.
The “Default” setting will add the -0g flag to CFLAGS.
The “Size” setting will add the -0s flag to CFLAGS.
The “Performance” setting will add the -O2 flag to CFLAGS.
The “None” setting will add the -O0 flag to CFLAGS.
The “Size” setting cause the compiled code to be smaller and faster, but may lead to difficulties of correlating code addresses to source file lines when debugging.
The “Performance” setting causes the compiled code to be larger and faster, but will be easier to correlated code addresses to source file lines.
“None” with -O0 produces compiled code without optimization.
Note that custom optimization levels may be unsupported.
Compiler optimization for the IDF bootloader is set separately, see the BOOTLOADER_COMPILER_OPTIMIZATION setting.
- Available options:
Debug (-Og) (COMPILER_OPTIMIZATION_DEFAULT)
Optimize for size (-Os) (COMPILER_OPTIMIZATION_SIZE)
Optimize for performance (-O2) (COMPILER_OPTIMIZATION_PERF)
Debug without optimization (-O0) (COMPILER_OPTIMIZATION_NONE)
CONFIG_COMPILER_OPTIMIZATION_ASSERTION_LEVEL¶
Assertion level
Found in: Compiler options
Assertions can be:
Enabled. Failure will print verbose assertion details. This is the default.
Set to “silent” to save code size (failed assertions will abort() but user needs to use the aborting address to find the line number with the failed assertion.)
Disabled entirely (not recommended for most configurations.) -DNDEBUG is added to CPPFLAGS in this case.
- Available options:
Enabled (COMPILER_OPTIMIZATION_ASSERTIONS_ENABLE)
Enable assertions. Assertion content and line number will be printed on failure.
Silent (saves code size) (COMPILER_OPTIMIZATION_ASSERTIONS_SILENT)
Enable silent assertions. Failed assertions will abort(), user needs to use the aborting address to find the line number with the failed assertion.
Disabled (sets -DNDEBUG) (COMPILER_OPTIMIZATION_ASSERTIONS_DISABLE)
If assertions are disabled, -DNDEBUG is added to CPPFLAGS.
CONFIG_COMPILER_OPTIMIZATION_CHECKS_SILENT¶
Disable messages in ESP_RETURN_ON_* and ESP_EXIT_ON_* macros
Found in: Compiler options
If enabled, the error messages will be discarded in following check macros: - ESP_RETURN_ON_ERROR - ESP_EXIT_ON_ERROR - ESP_RETURN_ON_FALSE - ESP_EXIT_ON_FALSE
- Default value:
No (disabled)
CONFIG_COMPILER_HIDE_PATHS_MACROS¶
Replace ESP-IDF and project paths in binaries
Found in: Compiler options
When expanding the __FILE__ and __BASE_FILE__ macros, replace paths inside ESP-IDF with paths relative to the placeholder string “IDF”, and convert paths inside the project directory to relative paths.
This allows building the project with assertions or other code that embeds file paths, without the binary containing the exact path to the IDF or project directories.
This option passes -fmacro-prefix-map options to the GCC command line. To replace additional paths in your binaries, modify the project CMakeLists.txt file to pass custom -fmacro-prefix-map or -ffile-prefix-map arguments.
CONFIG_COMPILER_CXX_EXCEPTIONS¶
Enable C++ exceptions
Found in: Compiler options
Enabling this option compiles all IDF C++ files with exception support enabled.
Disabling this option disables C++ exception support in all compiled files, and any libstdc++ code which throws an exception will abort instead.
Enabling this option currently adds an additional ~500 bytes of heap overhead when an exception is thrown in user code for the first time.
- Default value:
No (disabled)
Contains:
CONFIG_COMPILER_CXX_EXCEPTIONS_EMG_POOL_SIZE¶
Emergency Pool Size
Found in: Compiler options > CONFIG_COMPILER_CXX_EXCEPTIONS
Size (in bytes) of the emergency memory pool for C++ exceptions. This pool will be used to allocate memory for thrown exceptions when there is not enough memory on the heap.
- Default value:
CONFIG_COMPILER_CXX_RTTI¶
Enable C++ run-time type info (RTTI)
Found in: Compiler options
Enabling this option compiles all C++ files with RTTI support enabled. This increases binary size (typically by tens of kB) but allows using dynamic_cast conversion and typeid operator.
- Default value:
No (disabled)
CONFIG_COMPILER_STACK_CHECK_MODE¶
Stack smashing protection mode
Found in: Compiler options
Stack smashing protection mode. Emit extra code to check for buffer overflows, such as stack smashing attacks. This is done by adding a guard variable to functions with vulnerable objects. The guards are initialized when a function is entered and then checked when the function exits. If a guard check fails, program is halted. Protection has the following modes:
In NORMAL mode (GCC flag: -fstack-protector) only functions that call alloca, and functions with buffers larger than 8 bytes are protected.
STRONG mode (GCC flag: -fstack-protector-strong) is like NORMAL, but includes additional functions to be protected – those that have local array definitions, or have references to local frame addresses.
In OVERALL mode (GCC flag: -fstack-protector-all) all functions are protected.
Modes have the following impact on code performance and coverage:
performance: NORMAL > STRONG > OVERALL
coverage: NORMAL < STRONG < OVERALL
The performance impact includes increasing the amount of stack memory required for each task.
- Available options:
None (COMPILER_STACK_CHECK_MODE_NONE)
Normal (COMPILER_STACK_CHECK_MODE_NORM)
Strong (COMPILER_STACK_CHECK_MODE_STRONG)
Overall (COMPILER_STACK_CHECK_MODE_ALL)
CONFIG_COMPILER_WARN_WRITE_STRINGS¶
Enable -Wwrite-strings warning flag
Found in: Compiler options
Adds -Wwrite-strings flag for the C/C++ compilers.
For C, this gives string constants the type
const char[]
so that copying the address of one into a non-constchar \*
pointer produces a warning. This warning helps to find at compile time code that tries to write into a string constant.For C++, this warns about the deprecated conversion from string literals to
char \*
.
- Default value:
No (disabled)
CONFIG_COMPILER_SAVE_RESTORE_LIBCALLS¶
Enable -msave-restore flag to reduce code size
Found in: Compiler options
Adds -msave-restore to C/C++ compilation flags.
When this flag is enabled, compiler will call library functions to save/restore registers in function prologues/epilogues. This results in lower overall code size, at the expense of slightly reduced performance.
This option can be enabled for RISC-V targets only.
CONFIG_COMPILER_DISABLE_GCC8_WARNINGS¶
Disable new warnings introduced in GCC 6 - 8
Found in: Compiler options
Enable this option if using GCC 6 or newer, and wanting to disable warnings which don’t appear with GCC 5.
- Default value:
No (disabled)
CONFIG_COMPILER_DUMP_RTL_FILES¶
Dump RTL files during compilation
Found in: Compiler options
If enabled, RTL files will be produced during compilation. These files can be used by other tools, for example to calculate call graphs.
Component config¶
Contains:
Application Level Tracing¶
Contains:
CONFIG_APPTRACE_DESTINATION¶
Data Destination
Found in: Component config > Application Level Tracing
Select destination for application trace: JTAG or none (to disable).
- Available options:
JTAG (APPTRACE_DEST_JTAG)
None (APPTRACE_DEST_NONE)
CONFIG_APPTRACE_ONPANIC_HOST_FLUSH_TMO¶
Timeout for flushing last trace data to host on panic
Found in: Component config > Application Level Tracing
Timeout for flushing last trace data to host in case of panic. In ms. Use -1 to disable timeout and wait forever.
CONFIG_APPTRACE_POSTMORTEM_FLUSH_THRESH¶
Threshold for flushing last trace data to host on panic
Found in: Component config > Application Level Tracing
Threshold for flushing last trace data to host on panic in post-mortem mode. This is minimal amount of data needed to perform flush. In bytes.
CONFIG_APPTRACE_BUF_SIZE¶
Size of the apptrace buffer
Found in: Component config > Application Level Tracing
Size of the memory buffer for trace data in bytes.
CONFIG_APPTRACE_PENDING_DATA_SIZE_MAX¶
Size of the pending data buffer
Found in: Component config > Application Level Tracing
Size of the buffer for events in bytes. It is useful for buffering events from the time critical code (scheduler, ISRs etc). If this parameter is 0 then events will be discarded when main HW buffer is full.
FreeRTOS SystemView Tracing¶
Contains:
CONFIG_APPTRACE_SV_ENABLE¶
SystemView Tracing Enable
Found in: Component config > Application Level Tracing > FreeRTOS SystemView Tracing
Enables supporrt for SEGGER SystemView tracing functionality.
CONFIG_APPTRACE_SV_TS_SOURCE¶
Timer to use as timestamp source
Found in: Component config > Application Level Tracing > FreeRTOS SystemView Tracing > CONFIG_APPTRACE_SV_ENABLE
SystemView needs to use a hardware timer as the source of timestamps when tracing. This option selects the timer for it.
- Available options:
CPU cycle counter (CCOUNT) (APPTRACE_SV_TS_SOURCE_CCOUNT)
Timer 0, Group 0 (APPTRACE_SV_TS_SOURCE_TIMER_00)
Timer 1, Group 0 (APPTRACE_SV_TS_SOURCE_TIMER_01)
Timer 0, Group 1 (APPTRACE_SV_TS_SOURCE_TIMER_10)
Timer 1, Group 1 (APPTRACE_SV_TS_SOURCE_TIMER_11)
esp_timer high resolution timer (APPTRACE_SV_TS_SOURCE_ESP_TIMER)
CONFIG_APPTRACE_SV_MAX_TASKS¶
Maximum supported tasks
Found in: Component config > Application Level Tracing > FreeRTOS SystemView Tracing > CONFIG_APPTRACE_SV_ENABLE
Configures maximum supported tasks in sysview debug
CONFIG_APPTRACE_SV_BUF_WAIT_TMO¶
Trace buffer wait timeout
Found in: Component config > Application Level Tracing > FreeRTOS SystemView Tracing > CONFIG_APPTRACE_SV_ENABLE
Configures timeout (in us) to wait for free space in trace buffer. Set to -1 to wait forever and avoid lost events.
CONFIG_APPTRACE_SV_EVT_OVERFLOW_ENABLE¶
Trace Buffer Overflow Event
Found in: Component config > Application Level Tracing > FreeRTOS SystemView Tracing > CONFIG_APPTRACE_SV_ENABLE
Enables “Trace Buffer Overflow” event.
CONFIG_APPTRACE_SV_EVT_ISR_ENTER_ENABLE¶
ISR Enter Event
Found in: Component config > Application Level Tracing > FreeRTOS SystemView Tracing > CONFIG_APPTRACE_SV_ENABLE
Enables “ISR Enter” event.
CONFIG_APPTRACE_SV_EVT_ISR_EXIT_ENABLE¶
ISR Exit Event
Found in: Component config > Application Level Tracing > FreeRTOS SystemView Tracing > CONFIG_APPTRACE_SV_ENABLE
Enables “ISR Exit” event.
CONFIG_APPTRACE_SV_EVT_ISR_TO_SCHED_ENABLE¶
ISR Exit to Scheduler Event
Found in: Component config > Application Level Tracing > FreeRTOS SystemView Tracing > CONFIG_APPTRACE_SV_ENABLE
Enables “ISR to Scheduler” event.
CONFIG_APPTRACE_SV_EVT_TASK_START_EXEC_ENABLE¶
Task Start Execution Event
Found in: Component config > Application Level Tracing > FreeRTOS SystemView Tracing > CONFIG_APPTRACE_SV_ENABLE
Enables “Task Start Execution” event.
CONFIG_APPTRACE_SV_EVT_TASK_STOP_EXEC_ENABLE¶
Task Stop Execution Event
Found in: Component config > Application Level Tracing > FreeRTOS SystemView Tracing > CONFIG_APPTRACE_SV_ENABLE
Enables “Task Stop Execution” event.
CONFIG_APPTRACE_SV_EVT_TASK_START_READY_ENABLE¶
Task Start Ready State Event
Found in: Component config > Application Level Tracing > FreeRTOS SystemView Tracing > CONFIG_APPTRACE_SV_ENABLE
Enables “Task Start Ready State” event.
CONFIG_APPTRACE_SV_EVT_TASK_STOP_READY_ENABLE¶
Task Stop Ready State Event
Found in: Component config > Application Level Tracing > FreeRTOS SystemView Tracing > CONFIG_APPTRACE_SV_ENABLE
Enables “Task Stop Ready State” event.
CONFIG_APPTRACE_SV_EVT_TASK_CREATE_ENABLE¶
Task Create Event
Found in: Component config > Application Level Tracing > FreeRTOS SystemView Tracing > CONFIG_APPTRACE_SV_ENABLE
Enables “Task Create” event.
CONFIG_APPTRACE_SV_EVT_TASK_TERMINATE_ENABLE¶
Task Terminate Event
Found in: Component config > Application Level Tracing > FreeRTOS SystemView Tracing > CONFIG_APPTRACE_SV_ENABLE
Enables “Task Terminate” event.
CONFIG_APPTRACE_SV_EVT_IDLE_ENABLE¶
System Idle Event
Found in: Component config > Application Level Tracing > FreeRTOS SystemView Tracing > CONFIG_APPTRACE_SV_ENABLE
Enables “System Idle” event.
CONFIG_APPTRACE_SV_EVT_TIMER_ENTER_ENABLE¶
Timer Enter Event
Found in: Component config > Application Level Tracing > FreeRTOS SystemView Tracing > CONFIG_APPTRACE_SV_ENABLE
Enables “Timer Enter” event.
CONFIG_APPTRACE_SV_EVT_TIMER_EXIT_ENABLE¶
Timer Exit Event
Found in: Component config > Application Level Tracing > FreeRTOS SystemView Tracing > CONFIG_APPTRACE_SV_ENABLE
Enables “Timer Exit” event.
CONFIG_APPTRACE_GCOV_ENABLE¶
GCOV to Host Enable
Found in: Component config > Application Level Tracing
Enables support for GCOV data transfer to host.
ESP-ASIO¶
Contains:
CONFIG_ASIO_SSL_SUPPORT¶
Enable SSL/TLS support of ASIO
Found in: Component config > ESP-ASIO
Enable support for basic SSL/TLS features, available for mbedTLS/OpenSSL as well as wolfSSL TLS library.
- Default value:
No (disabled)
CONFIG_ASIO_SSL_LIBRARY_CHOICE¶
Choose SSL/TLS library for ESP-TLS (See help for more Info)
Found in: Component config > ESP-ASIO > CONFIG_ASIO_SSL_SUPPORT
The ASIO support multiple backend TLS libraries. Currently the mbedTLS with a thin ESP-OpenSSL port layer (default choice) and WolfSSL are supported. Different TLS libraries may support different features and have different resource usage. Consult the ESP-TLS documentation in ESP-IDF Programming guide for more details.
- Available options:
esp-openssl (ASIO_USE_ESP_OPENSSL)
wolfSSL (License info in wolfSSL directory README) (ASIO_USE_ESP_WOLFSSL)
Bluetooth¶
Contains:
CONFIG_BT_ENABLED¶
Bluetooth
Found in: Component config > Bluetooth
Select this option to enable Bluetooth and show the submenu with Bluetooth configuration choices.
CONFIG_BT_CTRL_BLE_MAX_ACT¶
BLE Max Instances
Found in: Component config > Bluetooth > CONFIG_BT_ENABLED > Bluetooth controller
BLE maximum activities of bluetooth controller,both of connections, scan , sync and adv(periodic adv, multi-adv).
- Range:
from 1 to 10 if CONFIG_BT_ENABLED
- Default value:
10 if CONFIG_BT_ENABLED
CONFIG_BT_CTRL_BLE_STATIC_ACL_TX_BUF_NB¶
BLE static ACL TX buffer numbers
Found in: Component config > Bluetooth > CONFIG_BT_ENABLED > Bluetooth controller
BLE ACL buffer have two methods to be allocated. One is persistent allocating (alloate when controller initialise, never free until controller de-initialise) another is dynamically allocating (allocate before TX and free after TX).
- Range:
from 0 to 12 if CONFIG_BT_ENABLED
- Default value:
0 if CONFIG_BT_ENABLED
CONFIG_BT_CTRL_HCI_MODE_CHOICE¶
HCI mode
Found in: Component config > Bluetooth > CONFIG_BT_ENABLED > Bluetooth controller
Specify HCI mode as VHCI or UART(H4)
- Available options:
VHCI (BT_CTRL_HCI_MODE_VHCI)
Normal option. Mostly, choose this VHCI when bluetooth host run on ESP32C3, too.
UART(H4) (BT_CTRL_HCI_MODE_UART_H4)
If use external bluetooth host which run on other hardware and use UART as the HCI interface, choose this option.
CONFIG_BT_CTRL_ADV_DUP_FILT_MAX¶
The maxinum number of 5.0 extend duplicate scan filter
Found in: Component config > Bluetooth > CONFIG_BT_ENABLED > Bluetooth controller
The maxinum number of suplicate scan filter
- Range:
from 1 to 500 if CONFIG_BT_ENABLED
- Default value:
30 if CONFIG_BT_ENABLED
CONFIG_BT_CTRL_HW_CCA¶
HW CCA check enable
Found in: Component config > Bluetooth > CONFIG_BT_ENABLED > Bluetooth controller
It enables HW CCA feature in controller
- Default value:
No (disabled) if CONFIG_BT_ENABLED
CONFIG_BT_CTRL_HW_CCA_VAL¶
CCA threshold value
Found in: Component config > Bluetooth > CONFIG_BT_ENABLED > Bluetooth controller
It is the threshold value of HW CCA, if the value is 30, it means CCA threshold is -30 dBm.
- Range:
from 20 to 60 if CONFIG_BT_ENABLED
- Default value:
20 if CONFIG_BT_ENABLED
CONFIG_BT_CTRL_CE_LENGTH_TYPE¶
Connection event length determination method
Found in: Component config > Bluetooth > CONFIG_BT_ENABLED > Bluetooth controller
Specify connection event length determination
- Available options:
ORIGINAL (BT_CTRL_CE_LENGTH_TYPE_ORIG)
Use CE parameter for HCI command (BT_CTRL_CE_LENGTH_TYPE_CE)
Use Espressif self-defined method (BT_CTRL_CE_LENGTH_TYPE_SD)
CONFIG_BT_CTRL_TX_ANTENNA_INDEX¶
default Tx anntena used
Found in: Component config > Bluetooth > CONFIG_BT_ENABLED > Bluetooth controller
Specify default Tx antenna used for bluetooth
- Available options:
Antenna 0 (BT_CTRL_TX_ANTENNA_INDEX_0)
Antenna 1 (BT_CTRL_TX_ANTENNA_INDEX_1)
CONFIG_BT_CTRL_RX_ANTENNA_INDEX¶
default Rx anntena used
Found in: Component config > Bluetooth > CONFIG_BT_ENABLED > Bluetooth controller
Specify default Rx antenna used for bluetooth
- Available options:
Antenna 0 (BT_CTRL_RX_ANTENNA_INDEX_0)
Antenna 1 (BT_CTRL_RX_ANTENNA_INDEX_1)
CONFIG_BT_CTRL_DFT_TX_POWER_LEVEL¶
BLE default Tx power level
Found in: Component config > Bluetooth > CONFIG_BT_ENABLED > Bluetooth controller
Specify default Tx power level
- Available options:
-27dBm (BT_CTRL_DFT_TX_POWER_LEVEL_N27)
-24dBm (BT_CTRL_DFT_TX_POWER_LEVEL_N24)
-21dBm (BT_CTRL_DFT_TX_POWER_LEVEL_N21)
-18dBm (BT_CTRL_DFT_TX_POWER_LEVEL_N18)
-15dBm (BT_CTRL_DFT_TX_POWER_LEVEL_N15)
-12dBm (BT_CTRL_DFT_TX_POWER_LEVEL_N12)
- -9dBm
(BT_CTRL_DFT_TX_POWER_LEVEL_N9)
- -6dBm
(BT_CTRL_DFT_TX_POWER_LEVEL_N6)
- -3dBm
(BT_CTRL_DFT_TX_POWER_LEVEL_N3)
0dBm (BT_CTRL_DFT_TX_POWER_LEVEL_N0)
- +3dBm
(BT_CTRL_DFT_TX_POWER_LEVEL_P3)
- +6dBm
(BT_CTRL_DFT_TX_POWER_LEVEL_P6)
- +9dBm
(BT_CTRL_DFT_TX_POWER_LEVEL_P9)
+12dBm (BT_CTRL_DFT_TX_POWER_LEVEL_P12)
+15dBm (BT_CTRL_DFT_TX_POWER_LEVEL_P15)
+18dBm (BT_CTRL_DFT_TX_POWER_LEVEL_P18)
CONFIG_BT_CTRL_BLE_ADV_REPORT_FLOW_CTRL_SUPP¶
BLE adv report flow control supported
Found in: Component config > Bluetooth > CONFIG_BT_ENABLED > Bluetooth controller
The function is mainly used to enable flow control for advertising reports. When it is enabled, advertising reports will be discarded by the controller if the number of unprocessed advertising reports exceeds the size of BLE adv report flow control.
- Default value:
Yes (enabled) if CONFIG_BT_ENABLED
CONFIG_BT_CTRL_BLE_ADV_REPORT_FLOW_CTRL_NUM¶
BLE adv report flow control number
Found in: Component config > Bluetooth > CONFIG_BT_ENABLED > Bluetooth controller > CONFIG_BT_CTRL_BLE_ADV_REPORT_FLOW_CTRL_SUPP
The number of unprocessed advertising report that bluetooth host can save.If you set BT_CTRL_BLE_ADV_REPORT_FLOW_CTRL_NUM to a small value, this may cause adv packets lost. If you set BT_CTRL_BLE_ADV_REPORT_FLOW_CTRL_NUM to a large value, bluetooth host may cache a lot of adv packets and this may cause system memory run out. For example, if you set it to 50, the maximum memory consumed by host is 35 * 50 bytes. Please set BT_CTRL_BLE_ADV_REPORT_FLOW_CTRL_NUM according to your system free memory and handle adv packets as fast as possible, otherwise it will cause adv packets lost.
- Range:
from 50 to 1000 if CONFIG_BT_CTRL_BLE_ADV_REPORT_FLOW_CTRL_SUPP && CONFIG_BT_ENABLED
- Default value:
CONFIG_BT_CTRL_BLE_ADV_REPORT_DISCARD_THRSHOLD¶
BLE adv lost event threshold value
Found in: Component config > Bluetooth > CONFIG_BT_ENABLED > Bluetooth controller > CONFIG_BT_CTRL_BLE_ADV_REPORT_FLOW_CTRL_SUPP
When adv report flow control is enabled, The ADV lost event will be generated when the number of ADV packets lost in the controller reaches this threshold. It is better to set a larger value. If you set BT_CTRL_BLE_ADV_REPORT_DISCARD_THRSHOLD to a small value or printf every adv lost event, it may cause adv packets lost more.
- Range:
from 1 to 1000 if CONFIG_BT_CTRL_BLE_ADV_REPORT_FLOW_CTRL_SUPP && CONFIG_BT_ENABLED
- Default value:
CONFIG_BT_CTRL_BLE_SCAN_DUPL¶
BLE Scan Duplicate Options
Found in: Component config > Bluetooth > CONFIG_BT_ENABLED > Bluetooth controller
This select enables parameters setting of BLE scan duplicate.
- Default value:
Yes (enabled) if CONFIG_BT_ENABLED
CONFIG_BT_CTRL_SCAN_DUPL_TYPE¶
Scan Duplicate Type
Found in: Component config > Bluetooth > CONFIG_BT_ENABLED > Bluetooth controller > CONFIG_BT_CTRL_BLE_SCAN_DUPL
Scan duplicate have three ways. one is “Scan Duplicate By Device Address”, This way is to use advertiser address filtering. The adv packet of the same address is only allowed to be reported once. Another way is “Scan Duplicate By Device Address And Advertising Data”. This way is to use advertising data and device address filtering. All different adv packets with the same address are allowed to be reported. The last way is “Scan Duplicate By Advertising Data”. This way is to use advertising data filtering. All same advertising data only allow to be reported once even though they are from different devices.
- Available options:
Scan Duplicate By Device Address (BT_CTRL_SCAN_DUPL_TYPE_DEVICE)
This way is to use advertiser address filtering. The adv packet of the same address is only allowed to be reported once
Scan Duplicate By Advertising Data (BT_CTRL_SCAN_DUPL_TYPE_DATA)
This way is to use advertising data filtering. All same advertising data only allow to be reported once even though they are from different devices.
Scan Duplicate By Device Address And Advertising Data (BT_CTRL_SCAN_DUPL_TYPE_DATA_DEVICE)
This way is to use advertising data and device address filtering. All different adv packets with the same address are allowed to be reported.
CONFIG_BT_CTRL_SCAN_DUPL_CACHE_SIZE¶
Maximum number of devices in scan duplicate filter
Found in: Component config > Bluetooth > CONFIG_BT_ENABLED > Bluetooth controller > CONFIG_BT_CTRL_BLE_SCAN_DUPL
Maximum number of devices which can be recorded in scan duplicate filter. When the maximum amount of device in the filter is reached, the cache will be refreshed.
- Range:
from 10 to 1000 if CONFIG_BT_CTRL_BLE_SCAN_DUPL && CONFIG_BT_ENABLED
- Default value:
CONFIG_BT_CTRL_BLE_MESH_SCAN_DUPL_EN¶
Special duplicate scan mechanism for BLE Mesh scan
Found in: Component config > Bluetooth > CONFIG_BT_ENABLED > Bluetooth controller > CONFIG_BT_CTRL_BLE_SCAN_DUPL
This enables the BLE scan duplicate for special BLE Mesh scan.
- Default value:
No (disabled) if CONFIG_BT_CTRL_BLE_SCAN_DUPL && CONFIG_BT_ENABLED
CONFIG_BT_CTRL_MESH_DUPL_SCAN_CACHE_SIZE¶
Maximum number of Mesh adv packets in scan duplicate filter
Found in: Component config > Bluetooth > CONFIG_BT_ENABLED > Bluetooth controller > CONFIG_BT_CTRL_BLE_SCAN_DUPL > CONFIG_BT_CTRL_BLE_MESH_SCAN_DUPL_EN
Maximum number of adv packets which can be recorded in duplicate scan cache for BLE Mesh. When the maximum amount of device in the filter is reached, the cache will be refreshed.
- Range:
from 10 to 1000 if CONFIG_BT_CTRL_BLE_MESH_SCAN_DUPL_EN && CONFIG_BT_ENABLED
- Default value:
CONFIG_BT_CTRL_COEX_PHY_CODED_TX_RX_TLIM¶
Coexistence: limit on MAX Tx/Rx time for coded-PHY connection
Found in: Component config > Bluetooth > CONFIG_BT_ENABLED > Bluetooth controller
When using PHY-Coded in BLE connection, limitation on max tx/rx time can be applied to better avoid dramatic performance deterioration of Wi-Fi.
- Available options:
Force Enable (BT_CTRL_COEX_PHY_CODED_TX_RX_TLIM_EN)
Always enable the limitation on max tx/rx time for Coded-PHY connection
Force Disable (BT_CTRL_COEX_PHY_CODED_TX_RX_TLIM_DIS)
Disable the limitation on max tx/rx time for Coded-PHY connection
CONFIG_BT_CTRL_MODEM_SLEEP¶
Bluetooth modem sleep
Found in: Component config > Bluetooth > CONFIG_BT_ENABLED > Bluetooth controller > MODEM SLEEP Options
Enable/disable bluetooth controller low power mode. Modem sleep is not supported to be used with UART HCI.
- Default value:
No (disabled) if BT_CTRL_HCI_MODE_UART_H4 && CONFIG_BT_ENABLED
CONFIG_BT_CTRL_MODEM_SLEEP_MODE_1¶
Bluetooth Modem sleep Mode 1
Found in: Component config > Bluetooth > CONFIG_BT_ENABLED > Bluetooth controller > MODEM SLEEP Options > CONFIG_BT_CTRL_MODEM_SLEEP
Mode 1 is the currently supported sleep mode. In this mode, bluetooth controller sleeps between and BLE events. A low power clock is used to maintain bluetooth reference clock.
- Default value:
Yes (enabled) if CONFIG_BT_CTRL_MODEM_SLEEP && CONFIG_BT_ENABLED
CONFIG_BT_CTRL_LOW_POWER_CLOCK¶
Bluetooth low power clock
Found in: Component config > Bluetooth > CONFIG_BT_ENABLED > Bluetooth controller > MODEM SLEEP Options > CONFIG_BT_CTRL_MODEM_SLEEP > CONFIG_BT_CTRL_MODEM_SLEEP_MODE_1
Select the low power clock source for bluetooth controller
- Available options:
Main crystal (BT_CTRL_LPCLK_SEL_MAIN_XTAL)
Main crystal can be used as low power clock for bluetooth modem sleep. If this option is selected, bluetooth modem sleep can work under Dynamic Frequency Scaling(DFS) enabled, but cannot work when light sleep is enabled. Main crystal has a relatively better performance than other bluetooth low power clock sources.
External 32kHz crystal (BT_CTRL_LPCLK_SEL_EXT_32K_XTAL)
External 32kHz crystal has a nominal frequency of 32.768kHz and provides good frequency stability. If used as Bluetooth low power clock, External 32kHz can support Bluetooth modem sleep to be used with both DFS and light sleep.
Internal 150kHz RC oscillator (BT_CTRL_LPCLK_SEL_RTC_SLOW)
Internal 150kHz RC oscillator. The accuracy of this clock is a lot larger than 500ppm which is required in Bluetooth communication, so don’t select this option in scenarios such as BLE connection state.
CONFIG_BT_CTRL_AGC_RECORRECT_EN¶
Enable HW AGC recorrect
Found in: Component config > Bluetooth > CONFIG_BT_ENABLED > Bluetooth controller
Enable uncoded phy AGC recorrect
- Default value:
No (disabled) if CONFIG_BT_ENABLED
CONFIG_BT_CTRL_CODED_AGC_RECORRECT_EN¶
Enable coded phy AGC recorrect
Found in: Component config > Bluetooth > CONFIG_BT_ENABLED > Bluetooth controller > CONFIG_BT_CTRL_AGC_RECORRECT_EN
Enable coded phy AGC recorrect
- Default value:
No (disabled) if CONFIG_BT_CTRL_AGC_RECORRECT_EN && CONFIG_BT_ENABLED
CONFIG_BT_HOST¶
Bluetooth Host
Found in: Component config > Bluetooth > CONFIG_BT_ENABLED
This helps to choose Bluetooth host stack
- Available options:
Bluedroid - Dual-mode (BT_BLUEDROID_ENABLED)
This option is recommended for classic Bluetooth or for dual-mode usecases
NimBLE - BLE only (BT_NIMBLE_ENABLED)
This option is recommended for BLE only usecases to save on memory
Controller Only (BT_CONTROLLER_ONLY)
This option is recommended when you want to communicate directly with the controller (without any host) or when you are using any other host stack not supported by Espressif (not mentioned here).
Bluedroid Options¶
Contains:
CONFIG_BT_BTC_TASK_STACK_SIZE¶
Bluetooth event (callback to application) task stack size
Found in: Component config > Bluetooth > Bluedroid Options
This select btc task stack size
- Default value:
3072 if BT_BLUEDROID_ENABLED && BT_BLUEDROID_ENABLED
CONFIG_BT_BLUEDROID_PINNED_TO_CORE_CHOICE¶
The cpu core which Bluedroid run
Found in: Component config > Bluetooth > Bluedroid Options
Which the cpu core to run Bluedroid. Can choose core0 and core1. Can not specify no-affinity.
- Available options:
Core 0 (PRO CPU) (BT_BLUEDROID_PINNED_TO_CORE_0)
Core 1 (APP CPU) (BT_BLUEDROID_PINNED_TO_CORE_1)
CONFIG_BT_BTU_TASK_STACK_SIZE¶
Bluetooth Bluedroid Host Stack task stack size
Found in: Component config > Bluetooth > Bluedroid Options
This select btu task stack size
- Default value:
4096 if BT_BLUEDROID_ENABLED && BT_BLUEDROID_ENABLED
CONFIG_BT_BLUEDROID_MEM_DEBUG¶
Bluedroid memory debug
Found in: Component config > Bluetooth > Bluedroid Options
Bluedroid memory debug
- Default value:
No (disabled) if BT_BLUEDROID_ENABLED && BT_BLUEDROID_ENABLED
CONFIG_BT_BLE_ENABLED¶
Bluetooth Low Energy
Found in: Component config > Bluetooth > Bluedroid Options
This enables Bluetooth Low Energy
- Default value:
Yes (enabled) if BT_BLUEDROID_ENABLED && BT_BLUEDROID_ENABLED
CONFIG_BT_GATTS_ENABLE¶
Include GATT server module(GATTS)
Found in: Component config > Bluetooth > Bluedroid Options > CONFIG_BT_BLE_ENABLED
This option can be disabled when the app work only on gatt client mode
- Default value:
Yes (enabled) if CONFIG_BT_BLE_ENABLED && BT_BLUEDROID_ENABLED
CONFIG_BT_GATTS_PPCP_CHAR_GAP¶
Enable Peripheral Preferred Connection Parameters characteristic in GAP service
Found in: Component config > Bluetooth > Bluedroid Options > CONFIG_BT_BLE_ENABLED > CONFIG_BT_GATTS_ENABLE
This enables “Peripheral Preferred Connection Parameters” characteristic (UUID: 0x2A04) in GAP service that has connection parameters like min/max connection interval, slave latency and supervision timeout multiplier
- Default value:
No (disabled) if CONFIG_BT_GATTS_ENABLE && BT_BLUEDROID_ENABLED
CONFIG_BT_BLE_BLUFI_ENABLE¶
Include blufi function
Found in: Component config > Bluetooth > Bluedroid Options > CONFIG_BT_BLE_ENABLED > CONFIG_BT_GATTS_ENABLE
This option can be close when the app does not require blufi function.
- Default value:
No (disabled) if CONFIG_BT_GATTS_ENABLE && BT_BLUEDROID_ENABLED
CONFIG_BT_GATT_MAX_SR_PROFILES¶
Max GATT Server Profiles
Found in: Component config > Bluetooth > Bluedroid Options > CONFIG_BT_BLE_ENABLED > CONFIG_BT_GATTS_ENABLE
Maximum GATT Server Profiles Count
- Range:
from 1 to 32 if CONFIG_BT_GATTS_ENABLE && BT_BLUEDROID_ENABLED && BT_BLUEDROID_ENABLED
- Default value:
8 if CONFIG_BT_GATTS_ENABLE && BT_BLUEDROID_ENABLED && BT_BLUEDROID_ENABLED
CONFIG_BT_GATTS_SEND_SERVICE_CHANGE_MODE¶
GATTS Service Change Mode
Found in: Component config > Bluetooth > Bluedroid Options > CONFIG_BT_BLE_ENABLED > CONFIG_BT_GATTS_ENABLE
Service change indication mode for GATT Server.
- Available options:
GATTS manually send service change indication (BT_GATTS_SEND_SERVICE_CHANGE_MANUAL)
Manually send service change indication through API esp_ble_gatts_send_service_change_indication()
GATTS automatically send service change indication (BT_GATTS_SEND_SERVICE_CHANGE_AUTO)
Let Bluedroid handle the service change indication internally
CONFIG_BT_GATTC_ENABLE¶
Include GATT client module(GATTC)
Found in: Component config > Bluetooth > Bluedroid Options > CONFIG_BT_BLE_ENABLED
This option can be close when the app work only on gatt server mode
- Default value:
Yes (enabled) if CONFIG_BT_BLE_ENABLED && BT_BLUEDROID_ENABLED
CONFIG_BT_GATTC_CACHE_NVS_FLASH¶
Save gattc cache data to nvs flash
Found in: Component config > Bluetooth > Bluedroid Options > CONFIG_BT_BLE_ENABLED > CONFIG_BT_GATTC_ENABLE
This select can save gattc cache data to nvs flash
- Default value:
No (disabled) if CONFIG_BT_GATTC_ENABLE && BT_BLUEDROID_ENABLED
CONFIG_BT_GATTC_CONNECT_RETRY_COUNT¶
The number of attempts to reconnect if the connection establishment failed
Found in: Component config > Bluetooth > Bluedroid Options > CONFIG_BT_BLE_ENABLED > CONFIG_BT_GATTC_ENABLE
The number of attempts to reconnect if the connection establishment failed
- Range:
from 0 to 7 if CONFIG_BT_GATTC_ENABLE && BT_BLUEDROID_ENABLED
- Default value:
3 if CONFIG_BT_GATTC_ENABLE && BT_BLUEDROID_ENABLED
CONFIG_BT_BLE_SMP_ENABLE¶
Include BLE security module(SMP)
Found in: Component config > Bluetooth > Bluedroid Options > CONFIG_BT_BLE_ENABLED
This option can be close when the app not used the ble security connect.
- Default value:
Yes (enabled) if CONFIG_BT_BLE_ENABLED && BT_BLUEDROID_ENABLED
CONFIG_BT_SMP_SLAVE_CON_PARAMS_UPD_ENABLE¶
Slave enable connection parameters update during pairing
Found in: Component config > Bluetooth > Bluedroid Options > CONFIG_BT_BLE_ENABLED > CONFIG_BT_BLE_SMP_ENABLE
In order to reduce the pairing time, slave actively initiates connection parameters update during pairing.
- Default value:
No (disabled) if CONFIG_BT_BLE_SMP_ENABLE && BT_BLUEDROID_ENABLED
CONFIG_BT_STACK_NO_LOG¶
Disable BT debug logs (minimize bin size)
Found in: Component config > Bluetooth > Bluedroid Options
This select can save the rodata code size
- Default value:
No (disabled) if BT_BLUEDROID_ENABLED && BT_BLUEDROID_ENABLED
CONFIG_BT_LOG_HCI_TRACE_LEVEL¶
HCI layer
Found in: Component config > Bluetooth > Bluedroid Options > BT DEBUG LOG LEVEL
Define BT trace level for HCI layer
- Available options:
NONE (BT_LOG_HCI_TRACE_LEVEL_NONE)
ERROR (BT_LOG_HCI_TRACE_LEVEL_ERROR)
WARNING (BT_LOG_HCI_TRACE_LEVEL_WARNING)
API (BT_LOG_HCI_TRACE_LEVEL_API)
EVENT (BT_LOG_HCI_TRACE_LEVEL_EVENT)
DEBUG (BT_LOG_HCI_TRACE_LEVEL_DEBUG)
VERBOSE (BT_LOG_HCI_TRACE_LEVEL_VERBOSE)
CONFIG_BT_LOG_BTM_TRACE_LEVEL¶
BTM layer
Found in: Component config > Bluetooth > Bluedroid Options > BT DEBUG LOG LEVEL
Define BT trace level for BTM layer
- Available options:
NONE (BT_LOG_BTM_TRACE_LEVEL_NONE)
ERROR (BT_LOG_BTM_TRACE_LEVEL_ERROR)
WARNING (BT_LOG_BTM_TRACE_LEVEL_WARNING)
API (BT_LOG_BTM_TRACE_LEVEL_API)
EVENT (BT_LOG_BTM_TRACE_LEVEL_EVENT)
DEBUG (BT_LOG_BTM_TRACE_LEVEL_DEBUG)
VERBOSE (BT_LOG_BTM_TRACE_LEVEL_VERBOSE)
CONFIG_BT_LOG_L2CAP_TRACE_LEVEL¶
L2CAP layer
Found in: Component config > Bluetooth > Bluedroid Options > BT DEBUG LOG LEVEL
Define BT trace level for L2CAP layer
- Available options:
NONE (BT_LOG_L2CAP_TRACE_LEVEL_NONE)
ERROR (BT_LOG_L2CAP_TRACE_LEVEL_ERROR)
WARNING (BT_LOG_L2CAP_TRACE_LEVEL_WARNING)
API (BT_LOG_L2CAP_TRACE_LEVEL_API)
EVENT (BT_LOG_L2CAP_TRACE_LEVEL_EVENT)
DEBUG (BT_LOG_L2CAP_TRACE_LEVEL_DEBUG)
VERBOSE (BT_LOG_L2CAP_TRACE_LEVEL_VERBOSE)
CONFIG_BT_LOG_RFCOMM_TRACE_LEVEL¶
RFCOMM layer
Found in: Component config > Bluetooth > Bluedroid Options > BT DEBUG LOG LEVEL
Define BT trace level for RFCOMM layer
- Available options:
NONE (BT_LOG_RFCOMM_TRACE_LEVEL_NONE)
ERROR (BT_LOG_RFCOMM_TRACE_LEVEL_ERROR)
WARNING (BT_LOG_RFCOMM_TRACE_LEVEL_WARNING)
API (BT_LOG_RFCOMM_TRACE_LEVEL_API)
EVENT (BT_LOG_RFCOMM_TRACE_LEVEL_EVENT)
DEBUG (BT_LOG_RFCOMM_TRACE_LEVEL_DEBUG)
VERBOSE (BT_LOG_RFCOMM_TRACE_LEVEL_VERBOSE)
CONFIG_BT_LOG_SDP_TRACE_LEVEL¶
SDP layer
Found in: Component config > Bluetooth > Bluedroid Options > BT DEBUG LOG LEVEL
Define BT trace level for SDP layer
- Available options:
NONE (BT_LOG_SDP_TRACE_LEVEL_NONE)
ERROR (BT_LOG_SDP_TRACE_LEVEL_ERROR)
WARNING (BT_LOG_SDP_TRACE_LEVEL_WARNING)
API (BT_LOG_SDP_TRACE_LEVEL_API)
EVENT (BT_LOG_SDP_TRACE_LEVEL_EVENT)
DEBUG (BT_LOG_SDP_TRACE_LEVEL_DEBUG)
VERBOSE (BT_LOG_SDP_TRACE_LEVEL_VERBOSE)
CONFIG_BT_LOG_GAP_TRACE_LEVEL¶
GAP layer
Found in: Component config > Bluetooth > Bluedroid Options > BT DEBUG LOG LEVEL
Define BT trace level for GAP layer
- Available options:
NONE (BT_LOG_GAP_TRACE_LEVEL_NONE)
ERROR (BT_LOG_GAP_TRACE_LEVEL_ERROR)
WARNING (BT_LOG_GAP_TRACE_LEVEL_WARNING)
API (BT_LOG_GAP_TRACE_LEVEL_API)
EVENT (BT_LOG_GAP_TRACE_LEVEL_EVENT)
DEBUG (BT_LOG_GAP_TRACE_LEVEL_DEBUG)
VERBOSE (BT_LOG_GAP_TRACE_LEVEL_VERBOSE)
CONFIG_BT_LOG_BNEP_TRACE_LEVEL¶
BNEP layer
Found in: Component config > Bluetooth > Bluedroid Options > BT DEBUG LOG LEVEL
Define BT trace level for BNEP layer
- Available options:
NONE (BT_LOG_BNEP_TRACE_LEVEL_NONE)
ERROR (BT_LOG_BNEP_TRACE_LEVEL_ERROR)
WARNING (BT_LOG_BNEP_TRACE_LEVEL_WARNING)
API (BT_LOG_BNEP_TRACE_LEVEL_API)
EVENT (BT_LOG_BNEP_TRACE_LEVEL_EVENT)
DEBUG (BT_LOG_BNEP_TRACE_LEVEL_DEBUG)
VERBOSE (BT_LOG_BNEP_TRACE_LEVEL_VERBOSE)
CONFIG_BT_LOG_PAN_TRACE_LEVEL¶
PAN layer
Found in: Component config > Bluetooth > Bluedroid Options > BT DEBUG LOG LEVEL
Define BT trace level for PAN layer
- Available options:
NONE (BT_LOG_PAN_TRACE_LEVEL_NONE)
ERROR (BT_LOG_PAN_TRACE_LEVEL_ERROR)
WARNING (BT_LOG_PAN_TRACE_LEVEL_WARNING)
API (BT_LOG_PAN_TRACE_LEVEL_API)
EVENT (BT_LOG_PAN_TRACE_LEVEL_EVENT)
DEBUG (BT_LOG_PAN_TRACE_LEVEL_DEBUG)
VERBOSE (BT_LOG_PAN_TRACE_LEVEL_VERBOSE)
CONFIG_BT_LOG_A2D_TRACE_LEVEL¶
A2D layer
Found in: Component config > Bluetooth > Bluedroid Options > BT DEBUG LOG LEVEL
Define BT trace level for A2D layer
- Available options:
NONE (BT_LOG_A2D_TRACE_LEVEL_NONE)
ERROR (BT_LOG_A2D_TRACE_LEVEL_ERROR)
WARNING (BT_LOG_A2D_TRACE_LEVEL_WARNING)
API (BT_LOG_A2D_TRACE_LEVEL_API)
EVENT (BT_LOG_A2D_TRACE_LEVEL_EVENT)
DEBUG (BT_LOG_A2D_TRACE_LEVEL_DEBUG)
VERBOSE (BT_LOG_A2D_TRACE_LEVEL_VERBOSE)
CONFIG_BT_LOG_AVDT_TRACE_LEVEL¶
AVDT layer
Found in: Component config > Bluetooth > Bluedroid Options > BT DEBUG LOG LEVEL
Define BT trace level for AVDT layer
- Available options:
NONE (BT_LOG_AVDT_TRACE_LEVEL_NONE)
ERROR (BT_LOG_AVDT_TRACE_LEVEL_ERROR)
WARNING (BT_LOG_AVDT_TRACE_LEVEL_WARNING)
API (BT_LOG_AVDT_TRACE_LEVEL_API)
EVENT (BT_LOG_AVDT_TRACE_LEVEL_EVENT)
DEBUG (BT_LOG_AVDT_TRACE_LEVEL_DEBUG)
VERBOSE (BT_LOG_AVDT_TRACE_LEVEL_VERBOSE)
CONFIG_BT_LOG_AVCT_TRACE_LEVEL¶
AVCT layer
Found in: Component config > Bluetooth > Bluedroid Options > BT DEBUG LOG LEVEL
Define BT trace level for AVCT layer
- Available options:
NONE (BT_LOG_AVCT_TRACE_LEVEL_NONE)
ERROR (BT_LOG_AVCT_TRACE_LEVEL_ERROR)
WARNING (BT_LOG_AVCT_TRACE_LEVEL_WARNING)
API (BT_LOG_AVCT_TRACE_LEVEL_API)
EVENT (BT_LOG_AVCT_TRACE_LEVEL_EVENT)
DEBUG (BT_LOG_AVCT_TRACE_LEVEL_DEBUG)
VERBOSE (BT_LOG_AVCT_TRACE_LEVEL_VERBOSE)
CONFIG_BT_LOG_AVRC_TRACE_LEVEL¶
AVRC layer
Found in: Component config > Bluetooth > Bluedroid Options > BT DEBUG LOG LEVEL
Define BT trace level for AVRC layer
- Available options:
NONE (BT_LOG_AVRC_TRACE_LEVEL_NONE)
ERROR (BT_LOG_AVRC_TRACE_LEVEL_ERROR)
WARNING (BT_LOG_AVRC_TRACE_LEVEL_WARNING)
API (BT_LOG_AVRC_TRACE_LEVEL_API)
EVENT (BT_LOG_AVRC_TRACE_LEVEL_EVENT)
DEBUG (BT_LOG_AVRC_TRACE_LEVEL_DEBUG)
VERBOSE (BT_LOG_AVRC_TRACE_LEVEL_VERBOSE)
CONFIG_BT_LOG_MCA_TRACE_LEVEL¶
MCA layer
Found in: Component config > Bluetooth > Bluedroid Options > BT DEBUG LOG LEVEL
Define BT trace level for MCA layer
- Available options:
NONE (BT_LOG_MCA_TRACE_LEVEL_NONE)
ERROR (BT_LOG_MCA_TRACE_LEVEL_ERROR)
WARNING (BT_LOG_MCA_TRACE_LEVEL_WARNING)
API (BT_LOG_MCA_TRACE_LEVEL_API)
EVENT (BT_LOG_MCA_TRACE_LEVEL_EVENT)
DEBUG (BT_LOG_MCA_TRACE_LEVEL_DEBUG)
VERBOSE (BT_LOG_MCA_TRACE_LEVEL_VERBOSE)
CONFIG_BT_LOG_HID_TRACE_LEVEL¶
HID layer
Found in: Component config > Bluetooth > Bluedroid Options > BT DEBUG LOG LEVEL
Define BT trace level for HID layer
- Available options:
NONE (BT_LOG_HID_TRACE_LEVEL_NONE)
ERROR (BT_LOG_HID_TRACE_LEVEL_ERROR)
WARNING (BT_LOG_HID_TRACE_LEVEL_WARNING)
API (BT_LOG_HID_TRACE_LEVEL_API)
EVENT (BT_LOG_HID_TRACE_LEVEL_EVENT)
DEBUG (BT_LOG_HID_TRACE_LEVEL_DEBUG)
VERBOSE (BT_LOG_HID_TRACE_LEVEL_VERBOSE)
CONFIG_BT_LOG_APPL_TRACE_LEVEL¶
APPL layer
Found in: Component config > Bluetooth > Bluedroid Options > BT DEBUG LOG LEVEL
Define BT trace level for APPL layer
- Available options:
NONE (BT_LOG_APPL_TRACE_LEVEL_NONE)
ERROR (BT_LOG_APPL_TRACE_LEVEL_ERROR)
WARNING (BT_LOG_APPL_TRACE_LEVEL_WARNING)
API (BT_LOG_APPL_TRACE_LEVEL_API)
EVENT (BT_LOG_APPL_TRACE_LEVEL_EVENT)
DEBUG (BT_LOG_APPL_TRACE_LEVEL_DEBUG)
VERBOSE (BT_LOG_APPL_TRACE_LEVEL_VERBOSE)
CONFIG_BT_LOG_GATT_TRACE_LEVEL¶
GATT layer
Found in: Component config > Bluetooth > Bluedroid Options > BT DEBUG LOG LEVEL
Define BT trace level for GATT layer
- Available options:
NONE (BT_LOG_GATT_TRACE_LEVEL_NONE)
ERROR (BT_LOG_GATT_TRACE_LEVEL_ERROR)
WARNING (BT_LOG_GATT_TRACE_LEVEL_WARNING)
API (BT_LOG_GATT_TRACE_LEVEL_API)
EVENT (BT_LOG_GATT_TRACE_LEVEL_EVENT)
DEBUG (BT_LOG_GATT_TRACE_LEVEL_DEBUG)
VERBOSE (BT_LOG_GATT_TRACE_LEVEL_VERBOSE)
CONFIG_BT_LOG_SMP_TRACE_LEVEL¶
SMP layer
Found in: Component config > Bluetooth > Bluedroid Options > BT DEBUG LOG LEVEL
Define BT trace level for SMP layer
- Available options:
NONE (BT_LOG_SMP_TRACE_LEVEL_NONE)
ERROR (BT_LOG_SMP_TRACE_LEVEL_ERROR)
WARNING (BT_LOG_SMP_TRACE_LEVEL_WARNING)
API (BT_LOG_SMP_TRACE_LEVEL_API)
EVENT (BT_LOG_SMP_TRACE_LEVEL_EVENT)
DEBUG (BT_LOG_SMP_TRACE_LEVEL_DEBUG)
VERBOSE (BT_LOG_SMP_TRACE_LEVEL_VERBOSE)
CONFIG_BT_LOG_BTIF_TRACE_LEVEL¶
BTIF layer
Found in: Component config > Bluetooth > Bluedroid Options > BT DEBUG LOG LEVEL
Define BT trace level for BTIF layer
- Available options:
NONE (BT_LOG_BTIF_TRACE_LEVEL_NONE)
ERROR (BT_LOG_BTIF_TRACE_LEVEL_ERROR)
WARNING (BT_LOG_BTIF_TRACE_LEVEL_WARNING)
API (BT_LOG_BTIF_TRACE_LEVEL_API)
EVENT (BT_LOG_BTIF_TRACE_LEVEL_EVENT)
DEBUG (BT_LOG_BTIF_TRACE_LEVEL_DEBUG)
VERBOSE (BT_LOG_BTIF_TRACE_LEVEL_VERBOSE)
CONFIG_BT_LOG_BTC_TRACE_LEVEL¶
BTC layer
Found in: Component config > Bluetooth > Bluedroid Options > BT DEBUG LOG LEVEL
Define BT trace level for BTC layer
- Available options:
NONE (BT_LOG_BTC_TRACE_LEVEL_NONE)
ERROR (BT_LOG_BTC_TRACE_LEVEL_ERROR)
WARNING (BT_LOG_BTC_TRACE_LEVEL_WARNING)
API (BT_LOG_BTC_TRACE_LEVEL_API)
EVENT (BT_LOG_BTC_TRACE_LEVEL_EVENT)
DEBUG (BT_LOG_BTC_TRACE_LEVEL_DEBUG)
VERBOSE (BT_LOG_BTC_TRACE_LEVEL_VERBOSE)
CONFIG_BT_LOG_OSI_TRACE_LEVEL¶
OSI layer
Found in: Component config > Bluetooth > Bluedroid Options > BT DEBUG LOG LEVEL
Define BT trace level for OSI layer
- Available options:
NONE (BT_LOG_OSI_TRACE_LEVEL_NONE)
ERROR (BT_LOG_OSI_TRACE_LEVEL_ERROR)
WARNING (BT_LOG_OSI_TRACE_LEVEL_WARNING)
API (BT_LOG_OSI_TRACE_LEVEL_API)
EVENT (BT_LOG_OSI_TRACE_LEVEL_EVENT)
DEBUG (BT_LOG_OSI_TRACE_LEVEL_DEBUG)
VERBOSE (BT_LOG_OSI_TRACE_LEVEL_VERBOSE)
CONFIG_BT_LOG_BLUFI_TRACE_LEVEL¶
BLUFI layer
Found in: Component config > Bluetooth > Bluedroid Options > BT DEBUG LOG LEVEL
Define BT trace level for BLUFI layer
- Available options:
NONE (BT_LOG_BLUFI_TRACE_LEVEL_NONE)
ERROR (BT_LOG_BLUFI_TRACE_LEVEL_ERROR)
WARNING (BT_LOG_BLUFI_TRACE_LEVEL_WARNING)
API (BT_LOG_BLUFI_TRACE_LEVEL_API)
EVENT (BT_LOG_BLUFI_TRACE_LEVEL_EVENT)
DEBUG (BT_LOG_BLUFI_TRACE_LEVEL_DEBUG)
VERBOSE (BT_LOG_BLUFI_TRACE_LEVEL_VERBOSE)
CONFIG_BT_ACL_CONNECTIONS¶
BT/BLE MAX ACL CONNECTIONS(1~7)
Found in: Component config > Bluetooth > Bluedroid Options
Maximum BT/BLE connection count
- Range:
from 1 to 7 if BT_BLUEDROID_ENABLED && BT_BLUEDROID_ENABLED
- Default value:
4 if BT_BLUEDROID_ENABLED && BT_BLUEDROID_ENABLED
CONFIG_BT_MULTI_CONNECTION_ENBALE¶
Enable BLE multi-conections
Found in: Component config > Bluetooth > Bluedroid Options
Enable this option if there are multiple connections
- Default value:
Yes (enabled) if BT_BLUEDROID_ENABLED && BT_BLUEDROID_ENABLED
CONFIG_BT_ALLOCATION_FROM_SPIRAM_FIRST¶
BT/BLE will first malloc the memory from the PSRAM
Found in: Component config > Bluetooth > Bluedroid Options
This select can save the internal RAM if there have the PSRAM
- Default value:
No (disabled) if BT_BLUEDROID_ENABLED && BT_BLUEDROID_ENABLED
CONFIG_BT_BLE_DYNAMIC_ENV_MEMORY¶
Use dynamic memory allocation in BT/BLE stack
Found in: Component config > Bluetooth > Bluedroid Options
This select can make the allocation of memory will become more flexible
- Default value:
No (disabled) if BT_BLUEDROID_ENABLED && BT_BLUEDROID_ENABLED
CONFIG_BT_BLE_HOST_QUEUE_CONG_CHECK¶
BLE queue congestion check
Found in: Component config > Bluetooth > Bluedroid Options
When scanning and scan duplicate is not enabled, if there are a lot of adv packets around or application layer handling adv packets is slow, it will cause the controller memory to run out. if enabled, adv packets will be lost when host queue is congested.
- Default value:
No (disabled) if BT_BLUEDROID_ENABLED && BT_BLUEDROID_ENABLED
CONFIG_BT_BLE_ACT_SCAN_REP_ADV_SCAN¶
Report adv data and scan response individually when BLE active scan
Found in: Component config > Bluetooth > Bluedroid Options
Originally, when doing BLE active scan, Bluedroid will not report adv to application layer until receive scan response. This option is used to disable the behavior. When enable this option, Bluedroid will report adv data or scan response to application layer immediately.
# Memory reserved at start of DRAM for Bluetooth stack
- Default value:
No (disabled) if BT_BLUEDROID_ENABLED && (BTDM_CTRL_MODE_BTDM || BTDM_CTRL_MODE_BLE_ONLY) && BT_BLUEDROID_ENABLED
CONFIG_BT_BLE_ESTAB_LINK_CONN_TOUT¶
Timeout of BLE connection establishment
Found in: Component config > Bluetooth > Bluedroid Options
Bluetooth Connection establishment maximum time, if connection time exceeds this value, the connection establishment fails, ESP_GATTC_OPEN_EVT or ESP_GATTS_OPEN_EVT is triggered.
- Range:
from 1 to 60 if BT_BLUEDROID_ENABLED && BT_BLUEDROID_ENABLED
- Default value:
30 if BT_BLUEDROID_ENABLED && BT_BLUEDROID_ENABLED
CONFIG_BT_BLE_RPA_SUPPORTED¶
Update RPA to Controller
Found in: Component config > Bluetooth > Bluedroid Options
This enables controller RPA list function. For ESP32, ESP32 only support network privacy mode. If this option is enabled, ESP32 will only accept advertising packets from peer devices that contain private address, HW will not receive the advertising packets contain identity address after IRK changed. If this option is disabled, address resolution will be performed in the host, so the functions that require controller to resolve address in the white list cannot be used. This option is disabled by default on ESP32, please enable or disable this option according to your own needs.
For ESP32C3 and esp32s3, devices support network privacy mode and device privacy mode, users can switch the two modes according to their own needs. So this option is enabled by default.
- Default value:
Yes (enabled) if BT_BLUEDROID_ENABLED && BT_BLUEDROID_ENABLED
CONFIG_BT_BLE_50_FEATURES_SUPPORTED¶
Enable BLE 5.0 features
Found in: Component config > Bluetooth > Bluedroid Options
This enables BLE 5.0 features, this option only support esp32c3/esp32s3 chip
- Default value:
Yes (enabled) if BT_BLUEDROID_ENABLED && BT_BLUEDROID_ENABLED
CONFIG_BT_BLE_42_FEATURES_SUPPORTED¶
Enable BLE 4.2 features
Found in: Component config > Bluetooth > Bluedroid Options
This enables BLE 4.2 features.
- Default value:
No (disabled) if BT_BLUEDROID_ENABLED && BT_BLUEDROID_ENABLED
NimBLE Options¶
Contains:
CONFIG_BT_NIMBLE_MEM_ALLOC_MODE¶
Memory allocation strategy
Found in: Component config > Bluetooth > NimBLE Options
Allocation strategy for NimBLE host stack, essentially provides ability to allocate all required dynamic allocations from,
Internal DRAM memory only
External SPIRAM memory only
Either internal or external memory based on default malloc() behavior in ESP-IDF
Internal IRAM memory wherever applicable else internal DRAM
- Available options:
Internal memory (BT_NIMBLE_MEM_ALLOC_MODE_INTERNAL)
External SPIRAM (BT_NIMBLE_MEM_ALLOC_MODE_EXTERNAL)
Default alloc mode (BT_NIMBLE_MEM_ALLOC_MODE_DEFAULT)
Internal IRAM (BT_NIMBLE_MEM_ALLOC_MODE_IRAM_8BIT)
Allows to use IRAM memory region as 8bit accessible region.
Every unaligned (8bit or 16bit) access will result in an exception and incur penalty of certain clock cycles per unaligned read/write.
CONFIG_BT_NIMBLE_LOG_LEVEL¶
NimBLE Host log verbosity
Found in: Component config > Bluetooth > NimBLE Options
Select NimBLE log level. Please make a note that the selected NimBLE log verbosity can not exceed the level set in “Component config –> Log output –> Default log verbosity”.
- Available options:
No logs (BT_NIMBLE_LOG_LEVEL_NONE)
Error logs (BT_NIMBLE_LOG_LEVEL_ERROR)
Warning logs (BT_NIMBLE_LOG_LEVEL_WARNING)
Info logs (BT_NIMBLE_LOG_LEVEL_INFO)
Debug logs (BT_NIMBLE_LOG_LEVEL_DEBUG)
CONFIG_BT_NIMBLE_MAX_CONNECTIONS¶
Maximum number of concurrent connections
Found in: Component config > Bluetooth > NimBLE Options
Defines maximum number of concurrent BLE connections. For ESP32, user is expected to configure BTDM_CTRL_BLE_MAX_CONN from controller menu along with this option. Similarly for ESP32-C3 or ESP32-S3, user is expected to configure BT_CTRL_BLE_MAX_ACT from controller menu.
- Range:
from 1 to 8 if BT_NIMBLE_ENABLED && BT_NIMBLE_ENABLED
- Default value:
3 if BT_NIMBLE_ENABLED && BT_NIMBLE_ENABLED
CONFIG_BT_NIMBLE_MAX_BONDS¶
Maximum number of bonds to save across reboots
Found in: Component config > Bluetooth > NimBLE Options
Defines maximum number of bonds to save for peer security and our security
- Default value:
3 if BT_NIMBLE_ENABLED && BT_NIMBLE_ENABLED
CONFIG_BT_NIMBLE_MAX_CCCDS¶
Maximum number of CCC descriptors to save across reboots
Found in: Component config > Bluetooth > NimBLE Options
Defines maximum number of CCC descriptors to save
- Default value:
8 if BT_NIMBLE_ENABLED && BT_NIMBLE_ENABLED
CONFIG_BT_NIMBLE_L2CAP_COC_MAX_NUM¶
Maximum number of connection oriented channels
Found in: Component config > Bluetooth > NimBLE Options
Defines maximum number of BLE Connection Oriented Channels. When set to (0), BLE COC is not compiled in
- Range:
from 0 to 9 if BT_NIMBLE_ENABLED && BT_NIMBLE_ENABLED
- Default value:
0 if BT_NIMBLE_ENABLED && BT_NIMBLE_ENABLED
CONFIG_BT_NIMBLE_PINNED_TO_CORE_CHOICE¶
The CPU core on which NimBLE host will run
Found in: Component config > Bluetooth > NimBLE Options
The CPU core on which NimBLE host will run. You can choose Core 0 or Core 1. Cannot specify no-affinity
- Available options:
Core 0 (PRO CPU) (BT_NIMBLE_PINNED_TO_CORE_0)
Core 1 (APP CPU) (BT_NIMBLE_PINNED_TO_CORE_1)
CONFIG_BT_NIMBLE_TASK_STACK_SIZE¶
NimBLE Host task stack size
Found in: Component config > Bluetooth > NimBLE Options
This configures stack size of NimBLE host task
- Default value:
5120 if CONFIG_BLE_MESH && BT_NIMBLE_ENABLED && BT_NIMBLE_ENABLED
4096 if BT_NIMBLE_ENABLED && BT_NIMBLE_ENABLED
CONFIG_BT_NIMBLE_ROLE_CENTRAL¶
Enable BLE Central role
Found in: Component config > Bluetooth > NimBLE Options
- Default value:
Yes (enabled) if BT_NIMBLE_ENABLED && BT_NIMBLE_ENABLED
CONFIG_BT_NIMBLE_ROLE_PERIPHERAL¶
Enable BLE Peripheral role
Found in: Component config > Bluetooth > NimBLE Options
- Default value:
Yes (enabled) if BT_NIMBLE_ENABLED && BT_NIMBLE_ENABLED
CONFIG_BT_NIMBLE_ROLE_BROADCASTER¶
Enable BLE Broadcaster role
Found in: Component config > Bluetooth > NimBLE Options
- Default value:
Yes (enabled) if BT_NIMBLE_ENABLED && BT_NIMBLE_ENABLED
CONFIG_BT_NIMBLE_ROLE_OBSERVER¶
Enable BLE Observer role
Found in: Component config > Bluetooth > NimBLE Options
- Default value:
Yes (enabled) if BT_NIMBLE_ENABLED && BT_NIMBLE_ENABLED
CONFIG_BT_NIMBLE_NVS_PERSIST¶
Persist the BLE Bonding keys in NVS
Found in: Component config > Bluetooth > NimBLE Options
Enable this flag to make bonding persistent across device reboots
- Default value:
Yes (enabled) if BT_NIMBLE_ENABLED && BT_NIMBLE_ENABLED
CONFIG_BT_NIMBLE_SM_LEGACY¶
Security manager legacy pairing
Found in: Component config > Bluetooth > NimBLE Options
Enable security manager legacy pairing
- Default value:
Yes (enabled) if BT_NIMBLE_ENABLED && BT_NIMBLE_ENABLED
CONFIG_BT_NIMBLE_SM_SC¶
Security manager secure connections (4.2)
Found in: Component config > Bluetooth > NimBLE Options
Enable security manager secure connections
- Default value:
Yes (enabled) if BT_NIMBLE_ENABLED && BT_NIMBLE_ENABLED
CONFIG_BT_NIMBLE_DEBUG¶
Enable extra runtime asserts and host debugging
Found in: Component config > Bluetooth > NimBLE Options
This enables extra runtime asserts and host debugging
- Default value:
No (disabled) if BT_NIMBLE_ENABLED && BT_NIMBLE_ENABLED
CONFIG_BT_NIMBLE_SM_SC_DEBUG_KEYS¶
Use predefined public-private key pair
Found in: Component config > Bluetooth > NimBLE Options
If this option is enabled, SM uses predefined DH key pair as described in Core Specification, Vol. 3, Part H, 2.3.5.6.1. This allows to decrypt air traffic easily and thus should only be used for debugging.
- Default value:
No (disabled) if CONFIG_BT_NIMBLE_SM_SC && BT_NIMBLE_ENABLED
CONFIG_BT_NIMBLE_SVC_GAP_DEVICE_NAME¶
BLE GAP default device name
Found in: Component config > Bluetooth > NimBLE Options
The Device Name characteristic shall contain the name of the device as an UTF-8 string. This name can be changed by using API ble_svc_gap_device_name_set()
- Default value:
“nimble” if BT_NIMBLE_ENABLED && BT_NIMBLE_ENABLED
CONFIG_BT_NIMBLE_GAP_DEVICE_NAME_MAX_LEN¶
Maximum length of BLE device name in octets
Found in: Component config > Bluetooth > NimBLE Options
Device Name characteristic value shall be 0 to 248 octets in length
- Default value:
31 if BT_NIMBLE_ENABLED && BT_NIMBLE_ENABLED
CONFIG_BT_NIMBLE_ATT_PREFERRED_MTU¶
Preferred MTU size in octets
Found in: Component config > Bluetooth > NimBLE Options
This is the default value of ATT MTU indicated by the device during an ATT MTU exchange. This value can be changed using API ble_att_set_preferred_mtu()
- Default value:
256 if BT_NIMBLE_ENABLED && BT_NIMBLE_ENABLED
CONFIG_BT_NIMBLE_SVC_GAP_APPEARANCE¶
External appearance of the device
Found in: Component config > Bluetooth > NimBLE Options
Standard BLE GAP Appearance value in HEX format e.g. 0x02C0
- Default value:
0 if BT_NIMBLE_ENABLED && BT_NIMBLE_ENABLED
CONFIG_BT_NIMBLE_ACL_BUF_COUNT¶
ACL Buffer count
Found in: Component config > Bluetooth > NimBLE Options
The number of ACL data buffers.
- Default value:
20 if BT_NIMBLE_ENABLED && BT_NIMBLE_ENABLED
CONFIG_BT_NIMBLE_ACL_BUF_SIZE¶
ACL Buffer size
Found in: Component config > Bluetooth > NimBLE Options
This is the maximum size of the data portion of HCI ACL data packets. It does not include the HCI data header (of 4 bytes)
- Default value:
255 if BT_NIMBLE_ENABLED && BT_NIMBLE_ENABLED
CONFIG_BT_NIMBLE_HCI_EVT_BUF_SIZE¶
HCI Event Buffer size
Found in: Component config > Bluetooth > NimBLE Options
This is the size of each HCI event buffer in bytes. In case of extended advertising, packets can be fragmented. 257 bytes is the maximum size of a packet.
- Default value:
257 if CONFIG_BT_NIMBLE_EXT_ADV && BT_NIMBLE_ENABLED && BT_NIMBLE_ENABLED
70 if BT_NIMBLE_ENABLED && BT_NIMBLE_ENABLED
CONFIG_BT_NIMBLE_HCI_EVT_HI_BUF_COUNT¶
High Priority HCI Event Buffer count
Found in: Component config > Bluetooth > NimBLE Options
This is the high priority HCI events’ buffer size. High-priority event buffers are for everything except advertising reports. If there are no free high-priority event buffers then host will try to allocate a low-priority buffer instead
- Default value:
30 if BT_NIMBLE_ENABLED && BT_NIMBLE_ENABLED
CONFIG_BT_NIMBLE_HCI_EVT_LO_BUF_COUNT¶
Low Priority HCI Event Buffer count
Found in: Component config > Bluetooth > NimBLE Options
This is the low priority HCI events’ buffer size. Low-priority event buffers are only used for advertising reports. If there are no free low-priority event buffers, then an incoming advertising report will get dropped
- Default value:
8 if BT_NIMBLE_ENABLED && BT_NIMBLE_ENABLED
CONFIG_BT_NIMBLE_MSYS1_BLOCK_COUNT¶
MSYS_1 Block Count
Found in: Component config > Bluetooth > NimBLE Options
MSYS is a system level mbuf registry. For prepare write & prepare responses MBUFs are allocated out of msys_1 pool. For NIMBLE_MESH enabled cases, this block count is increased by 8 than user defined count.
- Default value:
12 if BT_NIMBLE_ENABLED && BT_NIMBLE_ENABLED
CONFIG_BT_NIMBLE_HS_FLOW_CTRL¶
Enable Host Flow control
Found in: Component config > Bluetooth > NimBLE Options
Enable Host Flow control
- Default value:
Yes (enabled) if BT_NIMBLE_ENABLED && BT_NIMBLE_ENABLED
CONFIG_BT_NIMBLE_HS_FLOW_CTRL_ITVL¶
Host Flow control interval
Found in: Component config > Bluetooth > NimBLE Options > CONFIG_BT_NIMBLE_HS_FLOW_CTRL
Host flow control interval in msecs
- Default value:
1000 if CONFIG_BT_NIMBLE_HS_FLOW_CTRL && BT_NIMBLE_ENABLED
CONFIG_BT_NIMBLE_HS_FLOW_CTRL_THRESH¶
Host Flow control threshold
Found in: Component config > Bluetooth > NimBLE Options > CONFIG_BT_NIMBLE_HS_FLOW_CTRL
Host flow control threshold, if the number of free buffers are at or below this threshold, send an immediate number-of-completed-packets event
- Default value:
2 if CONFIG_BT_NIMBLE_HS_FLOW_CTRL && BT_NIMBLE_ENABLED
CONFIG_BT_NIMBLE_HS_FLOW_CTRL_TX_ON_DISCONNECT¶
Host Flow control on disconnect
Found in: Component config > Bluetooth > NimBLE Options > CONFIG_BT_NIMBLE_HS_FLOW_CTRL
Enable this option to send number-of-completed-packets event to controller after disconnection
- Default value:
Yes (enabled) if CONFIG_BT_NIMBLE_HS_FLOW_CTRL && BT_NIMBLE_ENABLED
CONFIG_BT_NIMBLE_RPA_TIMEOUT¶
RPA timeout in seconds
Found in: Component config > Bluetooth > NimBLE Options
Time interval between RPA address change. This is applicable in case of Host based RPA
- Range:
from 1 to 41400 if BT_NIMBLE_ENABLED && BT_NIMBLE_ENABLED
- Default value:
900 if BT_NIMBLE_ENABLED && BT_NIMBLE_ENABLED
CONFIG_BT_NIMBLE_MESH¶
Enable BLE mesh functionality
Found in: Component config > Bluetooth > NimBLE Options
Enable BLE Mesh functionality
- Default value:
No (disabled) if BT_NIMBLE_ENABLED && BT_NIMBLE_ENABLED
Contains:
CONFIG_BT_NIMBLE_MESH_PROXY¶
Enable mesh proxy functionality
Found in: Component config > Bluetooth > NimBLE Options > CONFIG_BT_NIMBLE_MESH
Enable proxy. This is automatically set whenever NIMBLE_MESH_PB_GATT or NIMBLE_MESH_GATT_PROXY is set
- Default value:
No (disabled) if CONFIG_BT_NIMBLE_MESH && BT_NIMBLE_ENABLED
CONFIG_BT_NIMBLE_MESH_PROV¶
Enable BLE mesh provisioning
Found in: Component config > Bluetooth > NimBLE Options > CONFIG_BT_NIMBLE_MESH
Enable mesh provisioning
- Default value:
Yes (enabled) if CONFIG_BT_NIMBLE_MESH && BT_NIMBLE_ENABLED
CONFIG_BT_NIMBLE_MESH_PB_ADV¶
Enable mesh provisioning over advertising bearer
Found in: Component config > Bluetooth > NimBLE Options > CONFIG_BT_NIMBLE_MESH > CONFIG_BT_NIMBLE_MESH_PROV
Enable this option to allow the device to be provisioned over the advertising bearer
- Default value:
Yes (enabled) if CONFIG_BT_NIMBLE_MESH_PROV && BT_NIMBLE_ENABLED
CONFIG_BT_NIMBLE_MESH_PB_GATT¶
Enable mesh provisioning over GATT bearer
Found in: Component config > Bluetooth > NimBLE Options > CONFIG_BT_NIMBLE_MESH > CONFIG_BT_NIMBLE_MESH_PROV
Enable this option to allow the device to be provisioned over the GATT bearer
- Default value:
Yes (enabled) if CONFIG_BT_NIMBLE_MESH_PROV && BT_NIMBLE_ENABLED
CONFIG_BT_NIMBLE_MESH_GATT_PROXY¶
Enable GATT Proxy functionality
Found in: Component config > Bluetooth > NimBLE Options > CONFIG_BT_NIMBLE_MESH
This option enables support for the Mesh GATT Proxy Service, i.e. the ability to act as a proxy between a Mesh GATT Client and a Mesh network
- Default value:
Yes (enabled) if CONFIG_BT_NIMBLE_MESH && BT_NIMBLE_ENABLED
CONFIG_BT_NIMBLE_MESH_RELAY¶
Enable mesh relay functionality
Found in: Component config > Bluetooth > NimBLE Options > CONFIG_BT_NIMBLE_MESH
Support for acting as a Mesh Relay Node
- Default value:
No (disabled) if CONFIG_BT_NIMBLE_MESH && BT_NIMBLE_ENABLED
CONFIG_BT_NIMBLE_MESH_LOW_POWER¶
Enable mesh low power mode
Found in: Component config > Bluetooth > NimBLE Options > CONFIG_BT_NIMBLE_MESH
Enable this option to be able to act as a Low Power Node
- Default value:
No (disabled) if CONFIG_BT_NIMBLE_MESH && BT_NIMBLE_ENABLED
CONFIG_BT_NIMBLE_MESH_FRIEND¶
Enable mesh friend functionality
Found in: Component config > Bluetooth > NimBLE Options > CONFIG_BT_NIMBLE_MESH
Enable this option to be able to act as a Friend Node
- Default value:
No (disabled) if CONFIG_BT_NIMBLE_MESH && BT_NIMBLE_ENABLED
CONFIG_BT_NIMBLE_MESH_DEVICE_NAME¶
Set mesh device name
Found in: Component config > Bluetooth > NimBLE Options > CONFIG_BT_NIMBLE_MESH
This value defines Bluetooth Mesh device/node name
- Default value:
“nimble-mesh-node” if CONFIG_BT_NIMBLE_MESH && BT_NIMBLE_ENABLED
CONFIG_BT_NIMBLE_MESH_NODE_COUNT¶
Set mesh node count
Found in: Component config > Bluetooth > NimBLE Options > CONFIG_BT_NIMBLE_MESH
Defines mesh node count.
- Default value:
1 if CONFIG_BT_NIMBLE_MESH && BT_NIMBLE_ENABLED
CONFIG_BT_NIMBLE_MESH_PROVISIONER¶
Enable BLE mesh provisioner
Found in: Component config > Bluetooth > NimBLE Options > CONFIG_BT_NIMBLE_MESH
Enable mesh provisioner.
- Default value:
0 if CONFIG_BT_NIMBLE_MESH && BT_NIMBLE_ENABLED
CONFIG_BT_NIMBLE_CRYPTO_STACK_MBEDTLS¶
Override TinyCrypt with mbedTLS for crypto computations
Found in: Component config > Bluetooth > NimBLE Options
Enable this option to choose mbedTLS instead of TinyCrypt for crypto computations.
- Default value:
Yes (enabled) if BT_NIMBLE_ENABLED && BT_NIMBLE_ENABLED
CONFIG_BT_NIMBLE_HS_STOP_TIMEOUT_MS¶
BLE host stop timeout in msec
Found in: Component config > Bluetooth > NimBLE Options
BLE Host stop procedure timeout in milliseconds.
- Default value:
2000 if BT_NIMBLE_ENABLED && BT_NIMBLE_ENABLED
CONFIG_BT_NIMBLE_HOST_BASED_PRIVACY¶
Enable host based privacy for random address.
Found in: Component config > Bluetooth > NimBLE Options
Use this option to do host based Random Private Address resolution. If this option is disabled then controller based privacy is used.
- Default value:
No (disabled) if BT_NIMBLE_ENABLED && BT_NIMBLE_ENABLED
CONFIG_BT_NIMBLE_ENABLE_CONN_REATTEMPT¶
Enable connection reattempts on connection establishment error
Found in: Component config > Bluetooth > NimBLE Options
Enable to make the NimBLE host to reattempt GAP connection on connection establishment failure.
- Default value:
Yes (enabled) if BT_NIMBLE_ENABLED
CONFIG_BT_NIMBLE_MAX_CONN_REATTEMPT¶
Maximum number connection reattempts
Found in: Component config > Bluetooth > NimBLE Options > CONFIG_BT_NIMBLE_ENABLE_CONN_REATTEMPT
Defines maximum number of connection reattempts.
- Range:
from 1 to 7 if BT_NIMBLE_ENABLED && CONFIG_BT_NIMBLE_ENABLE_CONN_REATTEMPT && BT_NIMBLE_ENABLED
- Default value:
3 if BT_NIMBLE_ENABLED && CONFIG_BT_NIMBLE_ENABLE_CONN_REATTEMPT && BT_NIMBLE_ENABLED
CONFIG_BT_NIMBLE_EXT_ADV¶
Enable extended advertising.
Found in: Component config > Bluetooth > NimBLE Options
Enable this option to do extended advertising. Extended advertising will be supported from BLE 5.0 onwards.
CONFIG_BT_NIMBLE_MAX_EXT_ADV_INSTANCES¶
Maximum number of extended advertising instances.
Found in: Component config > Bluetooth > NimBLE Options > CONFIG_BT_NIMBLE_EXT_ADV
Change this option to set maximum number of extended advertising instances. Minimum there is always one instance of advertising. Enter how many more advertising instances you want.
- Range:
from 0 to 4 if CONFIG_BT_NIMBLE_EXT_ADV && BT_NIMBLE_ENABLED
- Default value:
1 if CONFIG_BT_NIMBLE_EXT_ADV && CONFIG_BT_NIMBLE_EXT_ADV && BT_NIMBLE_ENABLED
0 if CONFIG_BT_NIMBLE_EXT_ADV && BT_NIMBLE_ENABLED
CONFIG_BT_NIMBLE_MAX_EXT_ADV_DATA_LEN¶
Maximum length of the advertising data.
Found in: Component config > Bluetooth > NimBLE Options > CONFIG_BT_NIMBLE_EXT_ADV
Defines size of extended advertising data. Size should not increase 1650.
- Range:
from 0 to 1650 if CONFIG_BT_NIMBLE_EXT_ADV && BT_NIMBLE_ENABLED
- Default value:
1650 if CONFIG_BT_NIMBLE_EXT_ADV && CONFIG_BT_NIMBLE_EXT_ADV && BT_NIMBLE_ENABLED
0 if CONFIG_BT_NIMBLE_EXT_ADV && BT_NIMBLE_ENABLED
CONFIG_BT_NIMBLE_ENABLE_PERIODIC_ADV¶
Enable periodic advertisement.
Found in: Component config > Bluetooth > NimBLE Options > CONFIG_BT_NIMBLE_EXT_ADV
Enable this option to start periodic advertisement.
- Default value:
Yes (enabled) if CONFIG_BT_NIMBLE_EXT_ADV && BT_NIMBLE_ENABLED
CONFIG_BT_NIMBLE_MAX_PERIODIC_SYNCS¶
Maximum number of periodic advertising syncs.
Found in: Component config > Bluetooth > NimBLE Options > CONFIG_BT_NIMBLE_EXT_ADV > CONFIG_BT_NIMBLE_ENABLE_PERIODIC_ADV
Set this option to set the upper limit for number of periodic sync connections. This should be less than maximum connections allowed by controller.
- Range:
from 1 to 8 if CONFIG_BT_NIMBLE_ENABLE_PERIODIC_ADV && BT_NIMBLE_ENABLED
- Default value:
1 if CONFIG_BT_NIMBLE_ENABLE_PERIODIC_ADV && CONFIG_BT_NIMBLE_ENABLE_PERIODIC_ADV && BT_NIMBLE_ENABLED
0 if CONFIG_BT_NIMBLE_ENABLE_PERIODIC_ADV && BT_NIMBLE_ENABLED
CONFIG_BT_NIMBLE_BLUFI_ENABLE¶
Enable blufi functionality
Found in: Component config > Bluetooth > NimBLE Options
Set this option to enable blufi functionality.
- Default value:
No (disabled) if BT_NIMBLE_ENABLED && BT_NIMBLE_ENABLED
CONFIG_BT_NIMBLE_USE_ESP_TIMER¶
Enable Esp Timer for Nimble
Found in: Component config > Bluetooth > NimBLE Options
Set this option to use Esp Timer which has higher priority timer instead of FreeRTOS timer
- Default value:
Yes (enabled) if BT_NIMBLE_ENABLED
CONFIG_BLE_MESH¶
ESP BLE Mesh Support
Found in: Component config
This option enables ESP BLE Mesh support. The specific features that are available may depend on other features that have been enabled in the stack, such as Bluetooth Support, Bluedroid Support & GATT support.
Contains:
CONFIG_BLE_MESH_HCI_5_0¶
Support sending 20ms non-connectable adv packets
Found in: Component config > CONFIG_BLE_MESH
It is a temporary solution and needs further modifications.
- Default value:
Yes (enabled) if CONFIG_BLE_MESH
CONFIG_BLE_MESH_USE_DUPLICATE_SCAN¶
Support Duplicate Scan in BLE Mesh
Found in: Component config > CONFIG_BLE_MESH
Enable this option to allow using specific duplicate scan filter in BLE Mesh, and Scan Duplicate Type must be set by choosing the option in the Bluetooth Controller section in menuconfig, which is “Scan Duplicate By Device Address and Advertising Data”.
- Default value:
Yes (enabled) if BT_BLUEDROID_ENABLED && CONFIG_BLE_MESH
CONFIG_BLE_MESH_MEM_ALLOC_MODE¶
Memory allocation strategy
Found in: Component config > CONFIG_BLE_MESH
Allocation strategy for BLE Mesh stack, essentially provides ability to allocate all required dynamic allocations from,
Internal DRAM memory only
External SPIRAM memory only
Either internal or external memory based on default malloc() behavior in ESP-IDF
Internal IRAM memory wherever applicable else internal DRAM
Recommended mode here is always internal (*), since that is most preferred from security perspective. But if application requirement does not allow sufficient free internal memory then alternate mode can be selected.
(*) In case of ESP32-S2/ESP32-S3, hardware allows encryption of external SPIRAM contents provided hardware flash encryption feature is enabled. In that case, using external SPIRAM allocation strategy is also safe choice from security perspective.
- Available options:
Internal DRAM (BLE_MESH_MEM_ALLOC_MODE_INTERNAL)
External SPIRAM (BLE_MESH_MEM_ALLOC_MODE_EXTERNAL)
Default alloc mode (BLE_MESH_MEM_ALLOC_MODE_DEFAULT)
Enable this option to use the default memory allocation strategy when external SPIRAM is enabled. See the SPIRAM options for more details.
Internal IRAM (BLE_MESH_MEM_ALLOC_MODE_IRAM_8BIT)
Allows to use IRAM memory region as 8bit accessible region. Every unaligned (8bit or 16bit) access will result in an exception and incur penalty of certain clock cycles per unaligned read/write.
CONFIG_BLE_MESH_FREERTOS_STATIC_ALLOC¶
Enable FreeRTOS static allocation
Found in: Component config > CONFIG_BLE_MESH
Enable this option to use FreeRTOS static allocation APIs for BLE Mesh, which provides the ability to use different dynamic memory (i.e. SPIRAM or IRAM) for FreeRTOS objects. If this option is disabled, the FreeRTOS static allocation APIs will not be used, and internal DRAM will be allocated for FreeRTOS objects.
- Default value:
No (disabled) if (ESP32_SPIRAM_SUPPORT || ESP32_IRAM_AS_8BIT_ACCESSIBLE_MEMORY) && CONFIG_BLE_MESH
CONFIG_BLE_MESH_FREERTOS_STATIC_ALLOC_MODE¶
Memory allocation for FreeRTOS objects
Found in: Component config > CONFIG_BLE_MESH > CONFIG_BLE_MESH_FREERTOS_STATIC_ALLOC
Choose the memory to be used for FreeRTOS objects.
- Available options:
External SPIRAM (BLE_MESH_FREERTOS_STATIC_ALLOC_EXTERNAL)
If enabled, BLE Mesh allocates dynamic memory from external SPIRAM for FreeRTOS objects, i.e. mutex, queue, and task stack. External SPIRAM can only be used for task stack when SPIRAM_ALLOW_STACK_EXTERNAL_MEMORY is enabled. See the SPIRAM options for more details.
Internal IRAM (BLE_MESH_FREERTOS_STATIC_ALLOC_IRAM_8BIT)
If enabled, BLE Mesh allocates dynamic memory from internal IRAM for FreeRTOS objects, i.e. mutex, queue. Note: IRAM region cannot be used as task stack.
CONFIG_BLE_MESH_DEINIT¶
Support de-initialize BLE Mesh stack
Found in: Component config > CONFIG_BLE_MESH
If enabled, users can use the function esp_ble_mesh_deinit() to de-initialize the whole BLE Mesh stack.
- Default value:
Yes (enabled) if CONFIG_BLE_MESH
BLE Mesh and BLE coexistence support¶
Contains:
CONFIG_BLE_MESH_SUPPORT_BLE_ADV¶
Support sending normal BLE advertising packets
Found in: Component config > CONFIG_BLE_MESH > BLE Mesh and BLE coexistence support
When selected, users can send normal BLE advertising packets with specific API.
- Default value:
No (disabled) if CONFIG_BLE_MESH
CONFIG_BLE_MESH_BLE_ADV_BUF_COUNT¶
Number of advertising buffers for BLE advertising packets
Found in: Component config > CONFIG_BLE_MESH > BLE Mesh and BLE coexistence support > CONFIG_BLE_MESH_SUPPORT_BLE_ADV
Number of advertising buffers for BLE packets available.
- Range:
from 1 to 255 if CONFIG_BLE_MESH_SUPPORT_BLE_ADV && CONFIG_BLE_MESH
- Default value:
CONFIG_BLE_MESH_SUPPORT_BLE_SCAN¶
Support scanning normal BLE advertising packets
Found in: Component config > CONFIG_BLE_MESH > BLE Mesh and BLE coexistence support
When selected, users can register a callback and receive normal BLE advertising packets in the application layer.
- Default value:
No (disabled) if CONFIG_BLE_MESH
CONFIG_BLE_MESH_FAST_PROV¶
Enable BLE Mesh Fast Provisioning
Found in: Component config > CONFIG_BLE_MESH
Enable this option to allow BLE Mesh fast provisioning solution to be used. When there are multiple unprovisioned devices around, fast provisioning can greatly reduce the time consumption of the whole provisioning process. When this option is enabled, and after an unprovisioned device is provisioned into a node successfully, it can be changed to a temporary Provisioner.
- Default value:
No (disabled) if CONFIG_BLE_MESH
CONFIG_BLE_MESH_NODE¶
Support for BLE Mesh Node
Found in: Component config > CONFIG_BLE_MESH
Enable the device to be provisioned into a node. This option should be enabled when an unprovisioned device is going to be provisioned into a node and communicate with other nodes in the BLE Mesh network.
CONFIG_BLE_MESH_PROVISIONER¶
Support for BLE Mesh Provisioner
Found in: Component config > CONFIG_BLE_MESH
Enable the device to be a Provisioner. The option should be enabled when a device is going to act as a Provisioner and provision unprovisioned devices into the BLE Mesh network.
CONFIG_BLE_MESH_WAIT_FOR_PROV_MAX_DEV_NUM¶
Maximum number of unprovisioned devices that can be added to device queue
Found in: Component config > CONFIG_BLE_MESH > CONFIG_BLE_MESH_PROVISIONER
This option specifies how many unprovisioned devices can be added to device queue for provisioning. Users can use this option to define the size of the queue in the bottom layer which is used to store unprovisioned device information (e.g. Device UUID, address).
- Range:
from 1 to 100 if CONFIG_BLE_MESH_PROVISIONER && CONFIG_BLE_MESH
- Default value:
CONFIG_BLE_MESH_MAX_PROV_NODES¶
Maximum number of devices that can be provisioned by Provisioner
Found in: Component config > CONFIG_BLE_MESH > CONFIG_BLE_MESH_PROVISIONER
This option specifies how many devices can be provisioned by a Provisioner. This value indicates the maximum number of unprovisioned devices which can be provisioned by a Provisioner. For instance, if the value is 6, it means the Provisioner can provision up to 6 unprovisioned devices. Theoretically a Provisioner without the limitation of its memory can provision up to 32766 unprovisioned devices, here we limit the maximum number to 100 just to limit the memory used by a Provisioner. The bigger the value is, the more memory it will cost by a Provisioner to store the information of nodes.
- Range:
from 1 to 1000 if CONFIG_BLE_MESH_PROVISIONER && CONFIG_BLE_MESH
- Default value:
CONFIG_BLE_MESH_PBA_SAME_TIME¶
Maximum number of PB-ADV running at the same time by Provisioner
Found in: Component config > CONFIG_BLE_MESH > CONFIG_BLE_MESH_PROVISIONER
This option specifies how many devices can be provisioned at the same time using PB-ADV. For examples, if the value is 2, it means a Provisioner can provision two unprovisioned devices with PB-ADV at the same time.
- Range:
from 1 to 10 if CONFIG_BLE_MESH_PB_ADV && CONFIG_BLE_MESH_PROVISIONER && CONFIG_BLE_MESH
- Default value:
CONFIG_BLE_MESH_PBG_SAME_TIME¶
Maximum number of PB-GATT running at the same time by Provisioner
Found in: Component config > CONFIG_BLE_MESH > CONFIG_BLE_MESH_PROVISIONER
This option specifies how many devices can be provisioned at the same time using PB-GATT. For example, if the value is 2, it means a Provisioner can provision two unprovisioned devices with PB-GATT at the same time.
- Range:
from 1 to 5 if CONFIG_BLE_MESH_PB_GATT && CONFIG_BLE_MESH_PROVISIONER && CONFIG_BLE_MESH
- Default value:
CONFIG_BLE_MESH_PROVISIONER_SUBNET_COUNT¶
Maximum number of mesh subnets that can be created by Provisioner
Found in: Component config > CONFIG_BLE_MESH > CONFIG_BLE_MESH_PROVISIONER
This option specifies how many subnets per network a Provisioner can create. Indeed, this value decides the number of network keys which can be added by a Provisioner.
- Range:
from 1 to 4096 if CONFIG_BLE_MESH_PROVISIONER && CONFIG_BLE_MESH
- Default value:
CONFIG_BLE_MESH_PROVISIONER_APP_KEY_COUNT¶
Maximum number of application keys that can be owned by Provisioner
Found in: Component config > CONFIG_BLE_MESH > CONFIG_BLE_MESH_PROVISIONER
This option specifies how many application keys the Provisioner can have. Indeed, this value decides the number of the application keys which can be added by a Provisioner.
- Range:
from 1 to 4096 if CONFIG_BLE_MESH_PROVISIONER && CONFIG_BLE_MESH
- Default value:
CONFIG_BLE_MESH_PROVISIONER_RECV_HB¶
Support receiving Heartbeat messages
Found in: Component config > CONFIG_BLE_MESH > CONFIG_BLE_MESH_PROVISIONER
When this option is enabled, Provisioner can call specific functions to enable or disable receiving Heartbeat messages and notify them to the application layer.
- Default value:
No (disabled) if CONFIG_BLE_MESH_PROVISIONER && CONFIG_BLE_MESH
CONFIG_BLE_MESH_PROVISIONER_RECV_HB_FILTER_SIZE¶
Maximum number of filter entries for receiving Heartbeat messages
Found in: Component config > CONFIG_BLE_MESH > CONFIG_BLE_MESH_PROVISIONER > CONFIG_BLE_MESH_PROVISIONER_RECV_HB
This option specifies how many heartbeat filter entries Provisioner supports. The heartbeat filter (acceptlist or rejectlist) entries are used to store a list of SRC and DST which can be used to decide if a heartbeat message will be processed and notified to the application layer by Provisioner. Note: The filter is an empty rejectlist by default.
- Range:
from 1 to 1000 if CONFIG_BLE_MESH_PROVISIONER_RECV_HB && CONFIG_BLE_MESH_PROVISIONER && CONFIG_BLE_MESH
- Default value:
CONFIG_BLE_MESH_PROV¶
BLE Mesh Provisioning support
Found in: Component config > CONFIG_BLE_MESH
Enable this option to support BLE Mesh Provisioning functionality. For BLE Mesh, this option should be always enabled.
- Default value:
Yes (enabled) if CONFIG_BLE_MESH
CONFIG_BLE_MESH_PB_ADV¶
Provisioning support using the advertising bearer (PB-ADV)
Found in: Component config > CONFIG_BLE_MESH
Enable this option to allow the device to be provisioned over the advertising bearer. This option should be enabled if PB-ADV is going to be used during provisioning procedure.
- Default value:
Yes (enabled) if CONFIG_BLE_MESH
CONFIG_BLE_MESH_UNPROVISIONED_BEACON_INTERVAL¶
Interval between two consecutive Unprovisioned Device Beacon
Found in: Component config > CONFIG_BLE_MESH > CONFIG_BLE_MESH_PB_ADV
This option specifies the interval of sending two consecutive unprovisioned device beacon, users can use this option to change the frequency of sending unprovisioned device beacon. For example, if the value is 5, it means the unprovisioned device beacon will send every 5 seconds. When the option of BLE_MESH_FAST_PROV is selected, the value is better to be 3 seconds, or less.
- Range:
from 1 to 100 if CONFIG_BLE_MESH_NODE && CONFIG_BLE_MESH_PB_ADV && CONFIG_BLE_MESH
- Default value:
CONFIG_BLE_MESH_PB_GATT¶
Provisioning support using GATT (PB-GATT)
Found in: Component config > CONFIG_BLE_MESH
Enable this option to allow the device to be provisioned over GATT. This option should be enabled if PB-GATT is going to be used during provisioning procedure.
# Virtual option enabled whenever any Proxy protocol is needed
CONFIG_BLE_MESH_PROXY¶
BLE Mesh Proxy protocol support
Found in: Component config > CONFIG_BLE_MESH
Enable this option to support BLE Mesh Proxy protocol used by PB-GATT and other proxy pdu transmission.
- Default value:
Yes (enabled) if CONFIG_BLE_MESH
CONFIG_BLE_MESH_GATT_PROXY_SERVER¶
BLE Mesh GATT Proxy Server
Found in: Component config > CONFIG_BLE_MESH
This option enables support for Mesh GATT Proxy Service, i.e. the ability to act as a proxy between a Mesh GATT Client and a Mesh network. This option should be enabled if a node is going to be a Proxy Server.
- Default value:
Yes (enabled) if CONFIG_BLE_MESH_NODE && CONFIG_BLE_MESH
CONFIG_BLE_MESH_NODE_ID_TIMEOUT¶
Node Identity advertising timeout
Found in: Component config > CONFIG_BLE_MESH > CONFIG_BLE_MESH_GATT_PROXY_SERVER
This option determines for how long the local node advertises using Node Identity. The given value is in seconds. The specification limits this to 60 seconds and lists it as the recommended value as well. So leaving the default value is the safest option. When an unprovisioned device is provisioned successfully and becomes a node, it will start to advertise using Node Identity during the time set by this option. And after that, Network ID will be advertised.
- Range:
from 1 to 60 if CONFIG_BLE_MESH_GATT_PROXY_SERVER && CONFIG_BLE_MESH
- Default value:
CONFIG_BLE_MESH_PROXY_FILTER_SIZE¶
Maximum number of filter entries per Proxy Client
Found in: Component config > CONFIG_BLE_MESH > CONFIG_BLE_MESH_GATT_PROXY_SERVER
This option specifies how many Proxy Filter entries the local node supports. The entries of Proxy filter (whitelist or blacklist) are used to store a list of addresses which can be used to decide which messages will be forwarded to the Proxy Client by the Proxy Server.
- Range:
from 1 to 32767 if CONFIG_BLE_MESH_GATT_PROXY_SERVER && CONFIG_BLE_MESH
- Default value:
CONFIG_BLE_MESH_GATT_PROXY_CLIENT¶
BLE Mesh GATT Proxy Client
Found in: Component config > CONFIG_BLE_MESH
This option enables support for Mesh GATT Proxy Client. The Proxy Client can use the GATT bearer to send mesh messages to a node that supports the advertising bearer.
- Default value:
No (disabled) if CONFIG_BLE_MESH
CONFIG_BLE_MESH_SETTINGS¶
Store BLE Mesh configuration persistently
Found in: Component config > CONFIG_BLE_MESH
When selected, the BLE Mesh stack will take care of storing/restoring the BLE Mesh configuration persistently in flash. If the device is a BLE Mesh node, when this option is enabled, the configuration of the device will be stored persistently, including unicast address, NetKey, AppKey, etc. And if the device is a BLE Mesh Provisioner, the information of the device will be stored persistently, including the information of provisioned nodes, NetKey, AppKey, etc.
- Default value:
No (disabled) if CONFIG_BLE_MESH
CONFIG_BLE_MESH_STORE_TIMEOUT¶
Delay (in seconds) before storing anything persistently
Found in: Component config > CONFIG_BLE_MESH > CONFIG_BLE_MESH_SETTINGS
This value defines in seconds how soon any pending changes are actually written into persistent storage (flash) after a change occurs. The option allows nodes to delay a certain period of time to save proper information to flash. The default value is 0, which means information will be stored immediately once there are updates.
- Range:
from 0 to 1000000 if CONFIG_BLE_MESH_SETTINGS && CONFIG_BLE_MESH
- Default value:
CONFIG_BLE_MESH_SEQ_STORE_RATE¶
How often the sequence number gets updated in storage
Found in: Component config > CONFIG_BLE_MESH > CONFIG_BLE_MESH_SETTINGS
This value defines how often the local sequence number gets updated in persistent storage (i.e. flash). e.g. a value of 100 means that the sequence number will be stored to flash on every 100th increment. If the node sends messages very frequently a higher value makes more sense, whereas if the node sends infrequently a value as low as 0 (update storage for every increment) can make sense. When the stack gets initialized it will add sequence number to the last stored one, so that it starts off with a value that’s guaranteed to be larger than the last one used before power off.
- Range:
from 0 to 1000000 if CONFIG_BLE_MESH_SETTINGS && CONFIG_BLE_MESH
- Default value:
CONFIG_BLE_MESH_RPL_STORE_TIMEOUT¶
Minimum frequency that the RPL gets updated in storage
Found in: Component config > CONFIG_BLE_MESH > CONFIG_BLE_MESH_SETTINGS
This value defines in seconds how soon the RPL (Replay Protection List) gets written to persistent storage after a change occurs. If the node receives messages frequently, then a large value is recommended. If the node receives messages rarely, then the value can be as low as 0 (which means the RPL is written into the storage immediately). Note that if the node operates in a security-sensitive case, and there is a risk of sudden power-off, then a value of 0 is strongly recommended. Otherwise, a power loss before RPL being written into the storage may introduce message replay attacks and system security will be in a vulnerable state.
- Range:
from 0 to 1000000 if CONFIG_BLE_MESH_SETTINGS && CONFIG_BLE_MESH
- Default value:
CONFIG_BLE_MESH_SETTINGS_BACKWARD_COMPATIBILITY¶
A specific option for settings backward compatibility
Found in: Component config > CONFIG_BLE_MESH > CONFIG_BLE_MESH_SETTINGS
This option is created to solve the issue of failure in recovering node information after mesh stack updates. In the old version mesh stack, there is no key of “mesh/role” in nvs. In the new version mesh stack, key of “mesh/role” is added in nvs, recovering node information needs to check “mesh/role” key in nvs and implements selective recovery of mesh node information. Therefore, there may be failure in recovering node information during node restarting after OTA.
The new version mesh stack adds the option of “mesh/role” because we have added the support of storing Provisioner information, while the old version only supports storing node information.
If users are updating their nodes from old version to new version, we recommend enabling this option, so that system could set the flag in advance before recovering node information and make sure the node information recovering could work as expected.
- Default value:
No (disabled) if CONFIG_BLE_MESH_NODE && CONFIG_BLE_MESH_SETTINGS && CONFIG_BLE_MESH
CONFIG_BLE_MESH_SPECIFIC_PARTITION¶
Use a specific NVS partition for BLE Mesh
Found in: Component config > CONFIG_BLE_MESH > CONFIG_BLE_MESH_SETTINGS
When selected, the mesh stack will use a specified NVS partition instead of default NVS partition. Note that the specified partition must be registered with NVS using nvs_flash_init_partition() API, and the partition must exists in the csv file. When Provisioner needs to store a large amount of nodes’ information in the flash (e.g. more than 20), this option is recommended to be enabled.
- Default value:
No (disabled) if CONFIG_BLE_MESH_SETTINGS && CONFIG_BLE_MESH
CONFIG_BLE_MESH_PARTITION_NAME¶
Name of the NVS partition for BLE Mesh
Found in: Component config > CONFIG_BLE_MESH > CONFIG_BLE_MESH_SETTINGS > CONFIG_BLE_MESH_SPECIFIC_PARTITION
This value defines the name of the specified NVS partition used by the mesh stack.
- Default value:
“ble_mesh” if CONFIG_BLE_MESH_SPECIFIC_PARTITION && CONFIG_BLE_MESH_SETTINGS && CONFIG_BLE_MESH
CONFIG_BLE_MESH_USE_MULTIPLE_NAMESPACE¶
Support using multiple NVS namespaces by Provisioner
Found in: Component config > CONFIG_BLE_MESH > CONFIG_BLE_MESH_SETTINGS
When selected, Provisioner can use different NVS namespaces to store different instances of mesh information. For example, if in the first room, Provisioner uses NetKey A, AppKey A and provisions three devices, these information will be treated as mesh information instance A. When the Provisioner moves to the second room, it uses NetKey B, AppKey B and provisions two devices, then the information will be treated as mesh information instance B. Here instance A and instance B will be stored in different namespaces. With this option enabled, Provisioner needs to use specific functions to open the corresponding NVS namespace, restore the mesh information, release the mesh information or erase the mesh information.
- Default value:
No (disabled) if CONFIG_BLE_MESH_PROVISIONER && CONFIG_BLE_MESH_SETTINGS && CONFIG_BLE_MESH
CONFIG_BLE_MESH_MAX_NVS_NAMESPACE¶
Maximum number of NVS namespaces
Found in: Component config > CONFIG_BLE_MESH > CONFIG_BLE_MESH_SETTINGS > CONFIG_BLE_MESH_USE_MULTIPLE_NAMESPACE
This option specifies the maximum NVS namespaces supported by Provisioner.
- Range:
from 1 to 255 if CONFIG_BLE_MESH_USE_MULTIPLE_NAMESPACE && CONFIG_BLE_MESH_SETTINGS && CONFIG_BLE_MESH
- Default value:
CONFIG_BLE_MESH_SUBNET_COUNT¶
Maximum number of mesh subnets per network
Found in: Component config > CONFIG_BLE_MESH
This option specifies how many subnets a Mesh network can have at the same time. Indeed, this value decides the number of the network keys which can be owned by a node.
- Range:
from 1 to 4096 if CONFIG_BLE_MESH
- Default value:
3 if CONFIG_BLE_MESH
CONFIG_BLE_MESH_APP_KEY_COUNT¶
Maximum number of application keys per network
Found in: Component config > CONFIG_BLE_MESH
This option specifies how many application keys the device can store per network. Indeed, this value decides the number of the application keys which can be owned by a node.
- Range:
from 1 to 4096 if CONFIG_BLE_MESH
- Default value:
3 if CONFIG_BLE_MESH
CONFIG_BLE_MESH_MODEL_KEY_COUNT¶
Maximum number of application keys per model
Found in: Component config > CONFIG_BLE_MESH
This option specifies the maximum number of application keys to which each model can be bound.
- Range:
from 1 to 4096 if CONFIG_BLE_MESH
- Default value:
3 if CONFIG_BLE_MESH
CONFIG_BLE_MESH_MODEL_GROUP_COUNT¶
Maximum number of group address subscriptions per model
Found in: Component config > CONFIG_BLE_MESH
This option specifies the maximum number of addresses to which each model can be subscribed.
- Range:
from 1 to 4096 if CONFIG_BLE_MESH
- Default value:
3 if CONFIG_BLE_MESH
CONFIG_BLE_MESH_LABEL_COUNT¶
Maximum number of Label UUIDs used for Virtual Addresses
Found in: Component config > CONFIG_BLE_MESH
This option specifies how many Label UUIDs can be stored. Indeed, this value decides the number of the Virtual Addresses can be supported by a node.
- Range:
from 0 to 4096 if CONFIG_BLE_MESH
- Default value:
3 if CONFIG_BLE_MESH
CONFIG_BLE_MESH_CRPL¶
Maximum capacity of the replay protection list
Found in: Component config > CONFIG_BLE_MESH
This option specifies the maximum capacity of the replay protection list. It is similar to Network message cache size, but has a different purpose. The replay protection list is used to prevent a node from replay attack, which will store the source address and sequence number of the received mesh messages. For Provisioner, the replay protection list size should not be smaller than the maximum number of nodes whose information can be stored. And the element number of each node should also be taken into consideration. For example, if Provisioner can provision up to 20 nodes and each node contains two elements, then the replay protection list size of Provisioner should be at least 40.
- Range:
from 2 to 65535 if CONFIG_BLE_MESH
- Default value:
10 if CONFIG_BLE_MESH
CONFIG_BLE_MESH_MSG_CACHE_SIZE¶
Network message cache size
Found in: Component config > CONFIG_BLE_MESH
Number of messages that are cached for the network. This helps prevent unnecessary decryption operations and unnecessary relays. This option is similar to Replay protection list, but has a different purpose. A node is not required to cache the entire Network PDU and may cache only part of it for tracking, such as values for SRC/SEQ or others.
- Range:
from 2 to 65535 if CONFIG_BLE_MESH
- Default value:
10 if CONFIG_BLE_MESH
CONFIG_BLE_MESH_ADV_BUF_COUNT¶
Number of advertising buffers
Found in: Component config > CONFIG_BLE_MESH
Number of advertising buffers available. The transport layer reserves ADV_BUF_COUNT - 3 buffers for outgoing segments. The maximum outgoing SDU size is 12 times this value (out of which 4 or 8 bytes are used for the Transport Layer MIC). For example, 5 segments means the maximum SDU size is 60 bytes, which leaves 56 bytes for application layer data using a 4-byte MIC, or 52 bytes using an 8-byte MIC.
- Range:
from 6 to 256 if CONFIG_BLE_MESH
- Default value:
60 if CONFIG_BLE_MESH
CONFIG_BLE_MESH_IVU_DIVIDER¶
Divider for IV Update state refresh timer
Found in: Component config > CONFIG_BLE_MESH
When the IV Update state enters Normal operation or IV Update in Progress, we need to keep track of how many hours has passed in the state, since the specification requires us to remain in the state at least for 96 hours (Update in Progress has an additional upper limit of 144 hours).
In order to fulfill the above requirement, even if the node might be powered off once in a while, we need to store persistently how many hours the node has been in the state. This doesn’t necessarily need to happen every hour (thanks to the flexible duration range). The exact cadence will depend a lot on the ways that the node will be used and what kind of power source it has.
Since there is no single optimal answer, this configuration option allows specifying a divider, i.e. how many intervals the 96 hour minimum gets split into. After each interval the duration that the node has been in the current state gets stored to flash. E.g. the default value of 4 means that the state is saved every 24 hours (96 / 4).
- Range:
from 2 to 96 if CONFIG_BLE_MESH
- Default value:
4 if CONFIG_BLE_MESH
CONFIG_BLE_MESH_TX_SEG_MSG_COUNT¶
Maximum number of simultaneous outgoing segmented messages
Found in: Component config > CONFIG_BLE_MESH
Maximum number of simultaneous outgoing multi-segment and/or reliable messages. The default value is 1, which means the device can only send one segmented message at a time. And if another segmented message is going to be sent, it should wait for the completion of the previous one. If users are going to send multiple segmented messages at the same time, this value should be configured properly.
- Range:
from 1 to if CONFIG_BLE_MESH
- Default value:
1 if CONFIG_BLE_MESH
CONFIG_BLE_MESH_RX_SEG_MSG_COUNT¶
Maximum number of simultaneous incoming segmented messages
Found in: Component config > CONFIG_BLE_MESH
Maximum number of simultaneous incoming multi-segment and/or reliable messages. The default value is 1, which means the device can only receive one segmented message at a time. And if another segmented message is going to be received, it should wait for the completion of the previous one. If users are going to receive multiple segmented messages at the same time, this value should be configured properly.
- Range:
from 1 to 255 if CONFIG_BLE_MESH
- Default value:
1 if CONFIG_BLE_MESH
CONFIG_BLE_MESH_RX_SDU_MAX¶
Maximum incoming Upper Transport Access PDU length
Found in: Component config > CONFIG_BLE_MESH
Maximum incoming Upper Transport Access PDU length. Leave this to the default value, unless you really need to optimize memory usage.
- Range:
from 36 to 384 if CONFIG_BLE_MESH
- Default value:
384 if CONFIG_BLE_MESH
CONFIG_BLE_MESH_TX_SEG_MAX¶
Maximum number of segments in outgoing messages
Found in: Component config > CONFIG_BLE_MESH
Maximum number of segments supported for outgoing messages. This value should typically be fine-tuned based on what models the local node supports, i.e. what’s the largest message payload that the node needs to be able to send. This value affects memory and call stack consumption, which is why the default is lower than the maximum that the specification would allow (32 segments).
The maximum outgoing SDU size is 12 times this number (out of which 4 or 8 bytes is used for the Transport Layer MIC). For example, 5 segments means the maximum SDU size is 60 bytes, which leaves 56 bytes for application layer data using a 4-byte MIC and 52 bytes using an 8-byte MIC.
Be sure to specify a sufficient number of advertising buffers when setting this option to a higher value. There must be at least three more advertising buffers (BLE_MESH_ADV_BUF_COUNT) as there are outgoing segments.
- Range:
from 2 to 32 if CONFIG_BLE_MESH
- Default value:
32 if CONFIG_BLE_MESH
CONFIG_BLE_MESH_RELAY¶
Relay support
Found in: Component config > CONFIG_BLE_MESH
Support for acting as a Mesh Relay Node. Enabling this option will allow a node to support the Relay feature, and the Relay feature can still be enabled or disabled by proper configuration messages. Disabling this option will let a node not support the Relay feature.
- Default value:
Yes (enabled) if CONFIG_BLE_MESH_NODE && CONFIG_BLE_MESH
CONFIG_BLE_MESH_RELAY_ADV_BUF¶
Use separate advertising buffers for relay packets
Found in: Component config > CONFIG_BLE_MESH > CONFIG_BLE_MESH_RELAY
When selected, self-send packets will be put in a high-priority queue and relay packets will be put in a low-priority queue.
- Default value:
No (disabled) if CONFIG_BLE_MESH_RELAY && CONFIG_BLE_MESH
CONFIG_BLE_MESH_RELAY_ADV_BUF_COUNT¶
Number of advertising buffers for relay packets
Found in: Component config > CONFIG_BLE_MESH > CONFIG_BLE_MESH_RELAY > CONFIG_BLE_MESH_RELAY_ADV_BUF
Number of advertising buffers for relay packets available.
- Range:
from 6 to 256 if CONFIG_BLE_MESH_RELAY_ADV_BUF && CONFIG_BLE_MESH_RELAY && CONFIG_BLE_MESH
- Default value:
CONFIG_BLE_MESH_LOW_POWER¶
Support for Low Power features
Found in: Component config > CONFIG_BLE_MESH
Enable this option to operate as a Low Power Node. If low power consumption is required by a node, this option should be enabled. And once the node enters the mesh network, it will try to find a Friend node and establish a friendship.
CONFIG_BLE_MESH_LPN_ESTABLISHMENT¶
Perform Friendship establishment using low power
Found in: Component config > CONFIG_BLE_MESH > CONFIG_BLE_MESH_LOW_POWER
Perform the Friendship establishment using low power with the help of a reduced scan duty cycle. The downside of this is that the node may miss out on messages intended for it until it has successfully set up Friendship with a Friend node. When this option is enabled, the node will stop scanning for a period of time after a Friend Request or Friend Poll is sent, so as to reduce more power consumption.
- Default value:
No (disabled) if CONFIG_BLE_MESH_LOW_POWER && CONFIG_BLE_MESH
CONFIG_BLE_MESH_LPN_AUTO¶
Automatically start looking for Friend nodes once provisioned
Found in: Component config > CONFIG_BLE_MESH > CONFIG_BLE_MESH_LOW_POWER
Once provisioned, automatically enable LPN functionality and start looking for Friend nodes. If this option is disabled LPN mode needs to be manually enabled by calling bt_mesh_lpn_set(true). When an unprovisioned device is provisioned successfully and becomes a node, enabling this option will trigger the node starts to send Friend Request at a certain period until it finds a proper Friend node.
- Default value:
No (disabled) if CONFIG_BLE_MESH_LOW_POWER && CONFIG_BLE_MESH
CONFIG_BLE_MESH_LPN_AUTO_TIMEOUT¶
Time from last received message before going to LPN mode
Found in: Component config > CONFIG_BLE_MESH > CONFIG_BLE_MESH_LOW_POWER > CONFIG_BLE_MESH_LPN_AUTO
Time in seconds from the last received message, that the node waits out before starting to look for Friend nodes.
- Range:
from 0 to 3600 if CONFIG_BLE_MESH_LPN_AUTO && CONFIG_BLE_MESH_LOW_POWER && CONFIG_BLE_MESH
- Default value:
CONFIG_BLE_MESH_LPN_RETRY_TIMEOUT¶
Retry timeout for Friend requests
Found in: Component config > CONFIG_BLE_MESH > CONFIG_BLE_MESH_LOW_POWER
Time in seconds between Friend Requests, if a previous Friend Request did not yield any acceptable Friend Offers.
- Range:
from 1 to 3600 if CONFIG_BLE_MESH_LOW_POWER && CONFIG_BLE_MESH
- Default value:
CONFIG_BLE_MESH_LPN_RSSI_FACTOR¶
RSSIFactor, used in Friend Offer Delay calculation
Found in: Component config > CONFIG_BLE_MESH > CONFIG_BLE_MESH_LOW_POWER
The contribution of the RSSI, measured by the Friend node, used in Friend Offer Delay calculations. 0 = 1, 1 = 1.5, 2 = 2, 3 = 2.5. RSSIFactor, one of the parameters carried by Friend Request sent by Low Power node, which is used to calculate the Friend Offer Delay.
- Range:
from 0 to 3 if CONFIG_BLE_MESH_LOW_POWER && CONFIG_BLE_MESH
- Default value:
CONFIG_BLE_MESH_LPN_RECV_WIN_FACTOR¶
ReceiveWindowFactor, used in Friend Offer Delay calculation
Found in: Component config > CONFIG_BLE_MESH > CONFIG_BLE_MESH_LOW_POWER
The contribution of the supported Receive Window used in Friend Offer Delay calculations. 0 = 1, 1 = 1.5, 2 = 2, 3 = 2.5. ReceiveWindowFactor, one of the parameters carried by Friend Request sent by Low Power node, which is used to calculate the Friend Offer Delay.
- Range:
from 0 to 3 if CONFIG_BLE_MESH_LOW_POWER && CONFIG_BLE_MESH
- Default value:
CONFIG_BLE_MESH_LPN_MIN_QUEUE_SIZE¶
Minimum size of the acceptable friend queue (MinQueueSizeLog)
Found in: Component config > CONFIG_BLE_MESH > CONFIG_BLE_MESH_LOW_POWER
The MinQueueSizeLog field is defined as log_2(N), where N is the minimum number of maximum size Lower Transport PDUs that the Friend node can store in its Friend Queue. As an example, MinQueueSizeLog value 1 gives N = 2, and value 7 gives N = 128.
- Range:
from 1 to 7 if CONFIG_BLE_MESH_LOW_POWER && CONFIG_BLE_MESH
- Default value:
CONFIG_BLE_MESH_LPN_RECV_DELAY¶
Receive delay requested by the local node
Found in: Component config > CONFIG_BLE_MESH > CONFIG_BLE_MESH_LOW_POWER
The ReceiveDelay is the time between the Low Power node sending a request and listening for a response. This delay allows the Friend node time to prepare the response. The value is in units of milliseconds.
- Range:
from 10 to 255 if CONFIG_BLE_MESH_LOW_POWER && CONFIG_BLE_MESH
- Default value:
100 if CONFIG_BLE_MESH_LOW_POWER && CONFIG_BLE_MESH
CONFIG_BLE_MESH_LPN_POLL_TIMEOUT¶
The value of the PollTimeout timer
Found in: Component config > CONFIG_BLE_MESH > CONFIG_BLE_MESH_LOW_POWER
PollTimeout timer is used to measure time between two consecutive requests sent by a Low Power node. If no requests are received the Friend node before the PollTimeout timer expires, then the friendship is considered terminated. The value is in units of 100 milliseconds, so e.g. a value of 300 means 30 seconds. The smaller the value, the faster the Low Power node tries to get messages from corresponding Friend node and vice versa.
- Range:
from 10 to 244735 if CONFIG_BLE_MESH_LOW_POWER && CONFIG_BLE_MESH
- Default value:
300 if CONFIG_BLE_MESH_LOW_POWER && CONFIG_BLE_MESH
CONFIG_BLE_MESH_LPN_INIT_POLL_TIMEOUT¶
The starting value of the PollTimeout timer
Found in: Component config > CONFIG_BLE_MESH > CONFIG_BLE_MESH_LOW_POWER
The initial value of the PollTimeout timer when Friendship is to be established for the first time. After this, the timeout gradually grows toward the actual PollTimeout, doubling in value for each iteration. The value is in units of 100 milliseconds, so e.g. a value of 300 means 30 seconds.
- Range:
from 10 to if CONFIG_BLE_MESH_LOW_POWER && CONFIG_BLE_MESH
- Default value:
CONFIG_BLE_MESH_LPN_SCAN_LATENCY¶
Latency for enabling scanning
Found in: Component config > CONFIG_BLE_MESH > CONFIG_BLE_MESH_LOW_POWER
Latency (in milliseconds) is the time it takes to enable scanning. In practice, it means how much time in advance of the Receive Window, the request to enable scanning is made.
- Range:
from 0 to 50 if CONFIG_BLE_MESH_LOW_POWER && CONFIG_BLE_MESH
- Default value:
10 if CONFIG_BLE_MESH_LOW_POWER && CONFIG_BLE_MESH
CONFIG_BLE_MESH_LPN_GROUPS¶
Number of groups the LPN can subscribe to
Found in: Component config > CONFIG_BLE_MESH > CONFIG_BLE_MESH_LOW_POWER
Maximum number of groups to which the LPN can subscribe.
- Range:
from 0 to 16384 if CONFIG_BLE_MESH_LOW_POWER && CONFIG_BLE_MESH
- Default value:
CONFIG_BLE_MESH_FRIEND¶
Support for Friend feature
Found in: Component config > CONFIG_BLE_MESH
Enable this option to be able to act as a Friend Node.
CONFIG_BLE_MESH_FRIEND_RECV_WIN¶
Friend Receive Window
Found in: Component config > CONFIG_BLE_MESH > CONFIG_BLE_MESH_FRIEND
Receive Window in milliseconds supported by the Friend node.
- Range:
from 1 to 255 if CONFIG_BLE_MESH_FRIEND && CONFIG_BLE_MESH
- Default value:
255 if CONFIG_BLE_MESH_FRIEND && CONFIG_BLE_MESH
CONFIG_BLE_MESH_FRIEND_QUEUE_SIZE¶
Minimum number of buffers supported per Friend Queue
Found in: Component config > CONFIG_BLE_MESH > CONFIG_BLE_MESH_FRIEND
Minimum number of buffers available to be stored for each local Friend Queue. This option decides the size of each buffer which can be used by a Friend node to store messages for each Low Power node.
- Range:
from 2 to 65536 if CONFIG_BLE_MESH_FRIEND && CONFIG_BLE_MESH
- Default value:
16 if CONFIG_BLE_MESH_FRIEND && CONFIG_BLE_MESH
CONFIG_BLE_MESH_FRIEND_SUB_LIST_SIZE¶
Friend Subscription List Size
Found in: Component config > CONFIG_BLE_MESH > CONFIG_BLE_MESH_FRIEND
Size of the Subscription List that can be supported by a Friend node for a Low Power node. And Low Power node can send Friend Subscription List Add or Friend Subscription List Remove messages to the Friend node to add or remove subscription addresses.
- Range:
from 0 to 1023 if CONFIG_BLE_MESH_FRIEND && CONFIG_BLE_MESH
- Default value:
CONFIG_BLE_MESH_FRIEND_LPN_COUNT¶
Number of supported LPN nodes
Found in: Component config > CONFIG_BLE_MESH > CONFIG_BLE_MESH_FRIEND
Number of Low Power Nodes with which a Friend can have Friendship simultaneously. A Friend node can have friendship with multiple Low Power nodes at the same time, while a Low Power node can only establish friendship with only one Friend node at the same time.
- Range:
from 1 to 1000 if CONFIG_BLE_MESH_FRIEND && CONFIG_BLE_MESH
- Default value:
CONFIG_BLE_MESH_FRIEND_SEG_RX¶
Number of incomplete segment lists per LPN
Found in: Component config > CONFIG_BLE_MESH > CONFIG_BLE_MESH_FRIEND
Number of incomplete segment lists tracked for each Friends’ LPN. In other words, this determines from how many elements can segmented messages destined for the Friend queue be received simultaneously.
- Range:
from 1 to 1000 if CONFIG_BLE_MESH_FRIEND && CONFIG_BLE_MESH
- Default value:
CONFIG_BLE_MESH_NO_LOG¶
Disable BLE Mesh debug logs (minimize bin size)
Found in: Component config > CONFIG_BLE_MESH
Select this to save the BLE Mesh related rodata code size. Enabling this option will disable the output of BLE Mesh debug log.
- Default value:
No (disabled) if CONFIG_BLE_MESH && CONFIG_BLE_MESH
BLE Mesh STACK DEBUG LOG LEVEL¶
Contains:
CONFIG_BLE_MESH_STACK_TRACE_LEVEL¶
BLE_MESH_STACK
Found in: Component config > CONFIG_BLE_MESH > BLE Mesh STACK DEBUG LOG LEVEL
Define BLE Mesh trace level for BLE Mesh stack.
- Available options:
NONE (BLE_MESH_TRACE_LEVEL_NONE)
ERROR (BLE_MESH_TRACE_LEVEL_ERROR)
WARNING (BLE_MESH_TRACE_LEVEL_WARNING)
INFO (BLE_MESH_TRACE_LEVEL_INFO)
DEBUG (BLE_MESH_TRACE_LEVEL_DEBUG)
VERBOSE (BLE_MESH_TRACE_LEVEL_VERBOSE)
BLE Mesh NET BUF DEBUG LOG LEVEL¶
Contains:
CONFIG_BLE_MESH_NET_BUF_TRACE_LEVEL¶
BLE_MESH_NET_BUF
Found in: Component config > CONFIG_BLE_MESH > BLE Mesh NET BUF DEBUG LOG LEVEL
Define BLE Mesh trace level for BLE Mesh net buffer.
- Available options:
NONE (BLE_MESH_NET_BUF_TRACE_LEVEL_NONE)
ERROR (BLE_MESH_NET_BUF_TRACE_LEVEL_ERROR)
WARNING (BLE_MESH_NET_BUF_TRACE_LEVEL_WARNING)
INFO (BLE_MESH_NET_BUF_TRACE_LEVEL_INFO)
DEBUG (BLE_MESH_NET_BUF_TRACE_LEVEL_DEBUG)
VERBOSE (BLE_MESH_NET_BUF_TRACE_LEVEL_VERBOSE)
CONFIG_BLE_MESH_CLIENT_MSG_TIMEOUT¶
Timeout(ms) for client message response
Found in: Component config > CONFIG_BLE_MESH
Timeout value used by the node to get response of the acknowledged message which is sent by the client model. This value indicates the maximum time that a client model waits for the response of the sent acknowledged messages. If a client model uses 0 as the timeout value when sending acknowledged messages, then the default value will be used which is four seconds.
- Range:
from 100 to 1200000 if CONFIG_BLE_MESH
- Default value:
4000 if CONFIG_BLE_MESH
Support for BLE Mesh Foundation models¶
Contains:
CONFIG_BLE_MESH_CFG_CLI¶
Configuration Client model
Found in: Component config > CONFIG_BLE_MESH > Support for BLE Mesh Foundation models
Enable support for Configuration Client model.
CONFIG_BLE_MESH_HEALTH_CLI¶
Health Client model
Found in: Component config > CONFIG_BLE_MESH > Support for BLE Mesh Foundation models
Enable support for Health Client model.
CONFIG_BLE_MESH_HEALTH_SRV¶
Health Server model
Found in: Component config > CONFIG_BLE_MESH > Support for BLE Mesh Foundation models
Enable support for Health Server model.
- Default value:
Yes (enabled) if CONFIG_BLE_MESH
Support for BLE Mesh Client/Server models¶
Contains:
CONFIG_BLE_MESH_GENERIC_ONOFF_CLI¶
Generic OnOff Client model
Found in: Component config > CONFIG_BLE_MESH > Support for BLE Mesh Client/Server models
Enable support for Generic OnOff Client model.
CONFIG_BLE_MESH_GENERIC_LEVEL_CLI¶
Generic Level Client model
Found in: Component config > CONFIG_BLE_MESH > Support for BLE Mesh Client/Server models
Enable support for Generic Level Client model.
CONFIG_BLE_MESH_GENERIC_DEF_TRANS_TIME_CLI¶
Generic Default Transition Time Client model
Found in: Component config > CONFIG_BLE_MESH > Support for BLE Mesh Client/Server models
Enable support for Generic Default Transition Time Client model.
CONFIG_BLE_MESH_GENERIC_POWER_ONOFF_CLI¶
Generic Power OnOff Client model
Found in: Component config > CONFIG_BLE_MESH > Support for BLE Mesh Client/Server models
Enable support for Generic Power OnOff Client model.
CONFIG_BLE_MESH_GENERIC_POWER_LEVEL_CLI¶
Generic Power Level Client model
Found in: Component config > CONFIG_BLE_MESH > Support for BLE Mesh Client/Server models
Enable support for Generic Power Level Client model.
CONFIG_BLE_MESH_GENERIC_BATTERY_CLI¶
Generic Battery Client model
Found in: Component config > CONFIG_BLE_MESH > Support for BLE Mesh Client/Server models
Enable support for Generic Battery Client model.
CONFIG_BLE_MESH_GENERIC_LOCATION_CLI¶
Generic Location Client model
Found in: Component config > CONFIG_BLE_MESH > Support for BLE Mesh Client/Server models
Enable support for Generic Location Client model.
CONFIG_BLE_MESH_GENERIC_PROPERTY_CLI¶
Generic Property Client model
Found in: Component config > CONFIG_BLE_MESH > Support for BLE Mesh Client/Server models
Enable support for Generic Property Client model.
CONFIG_BLE_MESH_SENSOR_CLI¶
Sensor Client model
Found in: Component config > CONFIG_BLE_MESH > Support for BLE Mesh Client/Server models
Enable support for Sensor Client model.
CONFIG_BLE_MESH_TIME_CLI¶
Time Client model
Found in: Component config > CONFIG_BLE_MESH > Support for BLE Mesh Client/Server models
Enable support for Time Client model.
CONFIG_BLE_MESH_SCENE_CLI¶
Scene Client model
Found in: Component config > CONFIG_BLE_MESH > Support for BLE Mesh Client/Server models
Enable support for Scene Client model.
CONFIG_BLE_MESH_SCHEDULER_CLI¶
Scheduler Client model
Found in: Component config > CONFIG_BLE_MESH > Support for BLE Mesh Client/Server models
Enable support for Scheduler Client model.
CONFIG_BLE_MESH_LIGHT_LIGHTNESS_CLI¶
Light Lightness Client model
Found in: Component config > CONFIG_BLE_MESH > Support for BLE Mesh Client/Server models
Enable support for Light Lightness Client model.
CONFIG_BLE_MESH_LIGHT_CTL_CLI¶
Light CTL Client model
Found in: Component config > CONFIG_BLE_MESH > Support for BLE Mesh Client/Server models
Enable support for Light CTL Client model.
CONFIG_BLE_MESH_LIGHT_HSL_CLI¶
Light HSL Client model
Found in: Component config > CONFIG_BLE_MESH > Support for BLE Mesh Client/Server models
Enable support for Light HSL Client model.
CONFIG_BLE_MESH_LIGHT_XYL_CLI¶
Light XYL Client model
Found in: Component config > CONFIG_BLE_MESH > Support for BLE Mesh Client/Server models
Enable support for Light XYL Client model.
CONFIG_BLE_MESH_LIGHT_LC_CLI¶
Light LC Client model
Found in: Component config > CONFIG_BLE_MESH > Support for BLE Mesh Client/Server models
Enable support for Light LC Client model.
CONFIG_BLE_MESH_GENERIC_SERVER¶
Generic server models
Found in: Component config > CONFIG_BLE_MESH > Support for BLE Mesh Client/Server models
Enable support for Generic server models.
- Default value:
Yes (enabled) if CONFIG_BLE_MESH
CONFIG_BLE_MESH_SENSOR_SERVER¶
Sensor server models
Found in: Component config > CONFIG_BLE_MESH > Support for BLE Mesh Client/Server models
Enable support for Sensor server models.
- Default value:
Yes (enabled) if CONFIG_BLE_MESH
CONFIG_BLE_MESH_TIME_SCENE_SERVER¶
Time and Scenes server models
Found in: Component config > CONFIG_BLE_MESH > Support for BLE Mesh Client/Server models
Enable support for Time and Scenes server models.
- Default value:
Yes (enabled) if CONFIG_BLE_MESH
CONFIG_BLE_MESH_LIGHTING_SERVER¶
Lighting server models
Found in: Component config > CONFIG_BLE_MESH > Support for BLE Mesh Client/Server models
Enable support for Lighting server models.
- Default value:
Yes (enabled) if CONFIG_BLE_MESH
CONFIG_BLE_MESH_IV_UPDATE_TEST¶
Test the IV Update Procedure
Found in: Component config > CONFIG_BLE_MESH
This option removes the 96 hour limit of the IV Update Procedure and lets the state to be changed at any time. If IV Update test mode is going to be used, this option should be enabled.
- Default value:
No (disabled) if CONFIG_BLE_MESH
BLE Mesh specific test option¶
Contains:
CONFIG_BLE_MESH_SELF_TEST¶
Perform BLE Mesh self-tests
Found in: Component config > CONFIG_BLE_MESH > BLE Mesh specific test option
This option adds extra self-tests which are run every time BLE Mesh networking is initialized.
- Default value:
No (disabled) if CONFIG_BLE_MESH
CONFIG_BLE_MESH_TEST_AUTO_ENTER_NETWORK¶
Unprovisioned device enters mesh network automatically
Found in: Component config > CONFIG_BLE_MESH > BLE Mesh specific test option > CONFIG_BLE_MESH_SELF_TEST
With this option enabled, an unprovisioned device can automatically enters mesh network using a specific test function without the pro- visioning procedure. And on the Provisioner side, a test function needs to be invoked to add the node information into the mesh stack.
- Default value:
Yes (enabled) if CONFIG_BLE_MESH_SELF_TEST && CONFIG_BLE_MESH
CONFIG_BLE_MESH_TEST_USE_WHITE_LIST¶
Use white list to filter mesh advertising packets
Found in: Component config > CONFIG_BLE_MESH > BLE Mesh specific test option > CONFIG_BLE_MESH_SELF_TEST
With this option enabled, users can use white list to filter mesh advertising packets while scanning.
- Default value:
No (disabled) if CONFIG_BLE_MESH_SELF_TEST && CONFIG_BLE_MESH
CONFIG_BLE_MESH_SHELL¶
Enable BLE Mesh shell
Found in: Component config > CONFIG_BLE_MESH > BLE Mesh specific test option
Activate shell module that provides BLE Mesh commands to the console.
- Default value:
No (disabled) if CONFIG_BLE_MESH
CONFIG_BLE_MESH_DEBUG¶
Enable BLE Mesh debug logs
Found in: Component config > CONFIG_BLE_MESH > BLE Mesh specific test option
Enable debug logs for the BLE Mesh functionality.
- Default value:
No (disabled) if CONFIG_BLE_MESH
CONFIG_BLE_MESH_DEBUG_NET¶
Network layer debug
Found in: Component config > CONFIG_BLE_MESH > BLE Mesh specific test option > CONFIG_BLE_MESH_DEBUG
Enable Network layer debug logs for the BLE Mesh functionality.
CONFIG_BLE_MESH_DEBUG_TRANS¶
Transport layer debug
Found in: Component config > CONFIG_BLE_MESH > BLE Mesh specific test option > CONFIG_BLE_MESH_DEBUG
Enable Transport layer debug logs for the BLE Mesh functionality.
CONFIG_BLE_MESH_DEBUG_BEACON¶
Beacon debug
Found in: Component config > CONFIG_BLE_MESH > BLE Mesh specific test option > CONFIG_BLE_MESH_DEBUG
Enable Beacon-related debug logs for the BLE Mesh functionality.
CONFIG_BLE_MESH_DEBUG_CRYPTO¶
Crypto debug
Found in: Component config > CONFIG_BLE_MESH > BLE Mesh specific test option > CONFIG_BLE_MESH_DEBUG
Enable cryptographic debug logs for the BLE Mesh functionality.
CONFIG_BLE_MESH_DEBUG_PROV¶
Provisioning debug
Found in: Component config > CONFIG_BLE_MESH > BLE Mesh specific test option > CONFIG_BLE_MESH_DEBUG
Enable Provisioning debug logs for the BLE Mesh functionality.
CONFIG_BLE_MESH_DEBUG_ACCESS¶
Access layer debug
Found in: Component config > CONFIG_BLE_MESH > BLE Mesh specific test option > CONFIG_BLE_MESH_DEBUG
Enable Access layer debug logs for the BLE Mesh functionality.
CONFIG_BLE_MESH_DEBUG_MODEL¶
Foundation model debug
Found in: Component config > CONFIG_BLE_MESH > BLE Mesh specific test option > CONFIG_BLE_MESH_DEBUG
Enable Foundation Models debug logs for the BLE Mesh functionality.
CONFIG_BLE_MESH_DEBUG_ADV¶
Advertising debug
Found in: Component config > CONFIG_BLE_MESH > BLE Mesh specific test option > CONFIG_BLE_MESH_DEBUG
Enable advertising debug logs for the BLE Mesh functionality.
CONFIG_BLE_MESH_DEBUG_LOW_POWER¶
Low Power debug
Found in: Component config > CONFIG_BLE_MESH > BLE Mesh specific test option > CONFIG_BLE_MESH_DEBUG
Enable Low Power debug logs for the BLE Mesh functionality.
CONFIG_BLE_MESH_DEBUG_FRIEND¶
Friend debug
Found in: Component config > CONFIG_BLE_MESH > BLE Mesh specific test option > CONFIG_BLE_MESH_DEBUG
Enable Friend debug logs for the BLE Mesh functionality.
CONFIG_BLE_MESH_DEBUG_PROXY¶
Proxy debug
Found in: Component config > CONFIG_BLE_MESH > BLE Mesh specific test option > CONFIG_BLE_MESH_DEBUG
Enable Proxy protocol debug logs for the BLE Mesh functionality.
CoAP Configuration¶
Contains:
CONFIG_COAP_MBEDTLS_ENCRYPTION_MODE¶
CoAP Encryption method
Found in: Component config > CoAP Configuration
If the CoAP information is to be encrypted, the encryption environment can be set up in one of two ways (default being Pre-Shared key mode)
Encrypt using defined Pre-Shared Keys (PSK if uri includes coaps://)
Encrypt using defined Public Key Infrastructure (PKI if uri includes coaps://)
- Available options:
Pre-Shared Keys (COAP_MBEDTLS_PSK)
PKI Certificates (COAP_MBEDTLS_PKI)
CONFIG_COAP_MBEDTLS_DEBUG¶
Enable CoAP debugging
Found in: Component config > CoAP Configuration
Enable CoAP debugging functions at compile time for the example code.
If this option is enabled, call coap_set_log_level() at runtime in order to enable CoAP debug output via the ESP log mechanism.
- Default value:
No (disabled)
CONFIG_COAP_MBEDTLS_DEBUG_LEVEL¶
Set CoAP debugging level
Found in: Component config > CoAP Configuration > CONFIG_COAP_MBEDTLS_DEBUG
Set CoAP debugging level
- Available options:
Emergency (COAP_LOG_EMERG)
Alert (COAP_LOG_ALERT)
Critical (COAP_LOG_CRIT)
Error (COAP_LOG_ERROR)
Warning (COAP_LOG_WARNING)
Notice (COAP_LOG_NOTICE)
Info (COAP_LOG_INFO)
Debug (COAP_LOG_DEBUG)
mbedTLS (COAP_LOG_MBEDTLS)
Driver configurations¶
Contains:
ADC configuration¶
Contains:
CONFIG_ADC_FORCE_XPD_FSM¶
Use the FSM to control ADC power
Found in: Component config > Driver configurations > ADC configuration
ADC power can be controlled by the FSM instead of software. This allows the ADC to be shut off when it is not working leading to lower power consumption. However using the FSM control ADC power will increase the noise of ADC.
- Default value:
No (disabled)
CONFIG_ADC_DISABLE_DAC¶
Disable DAC when ADC2 is used on GPIO 25 and 26
Found in: Component config > Driver configurations > ADC configuration
If this is set, the ADC2 driver will disable the output of the DAC corresponding to the specified channel. This is the default value.
For testing, disable this option so that we can measure the output of DAC by internal ADC.
- Default value:
Yes (enabled)
MCPWM configuration¶
Contains:
CONFIG_MCPWM_ISR_IN_IRAM¶
Place MCPWM ISR function into IRAM
Found in: Component config > Driver configurations > MCPWM configuration
If this option is not selected, the MCPWM interrupt will be deferred when the Cache is in a disabled state (e.g. Flash write/erase operation).
Note that if this option is selected, all user registered ISR callbacks should never try to use cache as well. (with IRAM_ATTR)
- Default value:
No (disabled)
SPI configuration¶
Contains:
CONFIG_SPI_MASTER_IN_IRAM¶
Place transmitting functions of SPI master into IRAM
Found in: Component config > Driver configurations > SPI configuration
Normally only the ISR of SPI master is placed in the IRAM, so that it can work without the flash when interrupt is triggered. For other functions, there’s some possibility that the flash cache miss when running inside and out of SPI functions, which may increase the interval of SPI transactions. Enable this to put
queue\_trans
,get\_trans\_result
andtransmit
functions into the IRAM to avoid possible cache miss.During unit test, this is enabled to measure the ideal case of api.
- Default value:
No (disabled)
CONFIG_SPI_MASTER_ISR_IN_IRAM¶
Place SPI master ISR function into IRAM
Found in: Component config > Driver configurations > SPI configuration
Place the SPI master ISR in to IRAM to avoid possible cache miss.
Also you can forbid the ISR being disabled during flash writing access, by add ESP_INTR_FLAG_IRAM when initializing the driver.
- Default value:
Yes (enabled)
CONFIG_SPI_SLAVE_IN_IRAM¶
Place transmitting functions of SPI slave into IRAM
Found in: Component config > Driver configurations > SPI configuration
Normally only the ISR of SPI slave is placed in the IRAM, so that it can work without the flash when interrupt is triggered. For other functions, there’s some possibility that the flash cache miss when running inside and out of SPI functions, which may increase the interval of SPI transactions. Enable this to put
queue\_trans
,get\_trans\_result
andtransmit
functions into the IRAM to avoid possible cache miss.
- Default value:
No (disabled)
CONFIG_SPI_SLAVE_ISR_IN_IRAM¶
Place SPI slave ISR function into IRAM
Found in: Component config > Driver configurations > SPI configuration
Place the SPI slave ISR in to IRAM to avoid possible cache miss.
Also you can forbid the ISR being disabled during flash writing access, by add ESP_INTR_FLAG_IRAM when initializing the driver.
- Default value:
Yes (enabled)
TWAI configuration¶
Contains:
CONFIG_TWAI_ISR_IN_IRAM¶
Place TWAI ISR function into IRAM
Found in: Component config > Driver configurations > TWAI configuration
Place the TWAI ISR in to IRAM. This will allow the ISR to avoid cache misses, and also be able to run whilst the cache is disabled (such as when writing to SPI Flash). Note that if this option is enabled: - Users should also set the ESP_INTR_FLAG_IRAM in the driver configuration structure when installing the driver (see docs for specifics). - Alert logging (i.e., setting of the TWAI_ALERT_AND_LOG flag) will have no effect.
- Default value:
No (disabled)
UART configuration¶
Contains:
CONFIG_UART_ISR_IN_IRAM¶
Place UART ISR function into IRAM
Found in: Component config > Driver configurations > UART configuration
If this option is not selected, UART interrupt will be disabled for a long time and may cause data lost when doing spi flash operation.
- Default value:
No (disabled)
GDMA Configuration¶
Contains:
CONFIG_GDMA_CTRL_FUNC_IN_IRAM¶
Place GDMA control functions into IRAM
Found in: Component config > Driver configurations > GDMA Configuration
Place GDMA control functions (like start/stop/append/reset) into IRAM, so that these functions can be IRAM-safe and able to be called in the other IRAM interrupt context. Enabling this option can improve driver performance as well.
- Default value:
No (disabled)
CONFIG_GDMA_ISR_IRAM_SAFE¶
GDMA ISR IRAM-Safe
Found in: Component config > Driver configurations > GDMA Configuration
This will ensure the GDMA interrupt handler is IRAM-Safe, allow to avoid flash cache misses, and also be able to run whilst the cache is disabled. (e.g. SPI Flash write).
- Default value:
No (disabled)
eFuse Bit Manager¶
Contains:
CONFIG_EFUSE_CUSTOM_TABLE¶
Use custom eFuse table
Found in: Component config > eFuse Bit Manager
Allows to generate a structure for eFuse from the CSV file.
- Default value:
No (disabled)
CONFIG_EFUSE_CUSTOM_TABLE_FILENAME¶
Custom eFuse CSV file
Found in: Component config > eFuse Bit Manager > CONFIG_EFUSE_CUSTOM_TABLE
Name of the custom eFuse CSV filename. This path is evaluated relative to the project root directory.
- Default value:
“main/esp_efuse_custom_table.csv” if CONFIG_EFUSE_CUSTOM_TABLE
CONFIG_EFUSE_VIRTUAL¶
Simulate eFuse operations in RAM
Found in: Component config > eFuse Bit Manager
If “n” - No virtual mode. All eFuse operations are real and use eFuse registers. If “y” - The virtual mode is enabled and all eFuse operations (read and write) are redirected to RAM instead of eFuse registers, all permanent changes (via eFuse) are disabled. Log output will state changes that would be applied, but they will not be.
During startup, the eFuses are copied into RAM. This mode is useful for fast tests.
- Default value:
No (disabled)
CONFIG_EFUSE_VIRTUAL_KEEP_IN_FLASH¶
Keep eFuses in flash
Found in: Component config > eFuse Bit Manager > CONFIG_EFUSE_VIRTUAL
In addition to the “Simulate eFuse operations in RAM” option, this option just adds a feature to keep eFuses after reboots in flash memory. To use this mode the partition_table should have the efuse partition. partition.csv: “efuse_em, data, efuse, , 0x2000,”
During startup, the eFuses are copied from flash or, in case if flash is empty, from real eFuse to RAM and then update flash. This mode is useful when need to keep changes after reboot (testing secure_boot and flash_encryption).
ESP-TLS¶
Contains:
CONFIG_ESP_TLS_LIBRARY_CHOOSE¶
Choose SSL/TLS library for ESP-TLS (See help for more Info)
Found in: Component config > ESP-TLS
The ESP-TLS APIs support multiple backend TLS libraries. Currently mbedTLS and WolfSSL are supported. Different TLS libraries may support different features and have different resource usage. Consult the ESP-TLS documentation in ESP-IDF Programming guide for more details.
- Available options:
mbedTLS (ESP_TLS_USING_MBEDTLS)
wolfSSL (License info in wolfSSL directory README) (ESP_TLS_USING_WOLFSSL)
CONFIG_ESP_TLS_USE_DS_PERIPHERAL¶
Use Digital Signature (DS) Peripheral with ESP-TLS
Found in: Component config > ESP-TLS
Enable use of the Digital Signature Peripheral for ESP-TLS.The DS peripheral can only be used when it is appropriately configured for TLS. Consult the ESP-TLS documentation in ESP-IDF Programming Guide for more details.
- Default value:
Yes (enabled)
CONFIG_ESP_TLS_SERVER¶
Enable ESP-TLS Server
Found in: Component config > ESP-TLS
Enable support for creating server side SSL/TLS session, available for mbedTLS as well as wolfSSL TLS library.
- Default value:
No (disabled)
CONFIG_ESP_TLS_CLIENT_SESSION_TICKETS¶
Enable client session tickets
Found in: Component config > ESP-TLS
Enable session ticket support as specified in RFC5077.
- Default value:
No (disabled)
CONFIG_ESP_TLS_SERVER_SESSION_TICKETS¶
Enable server session tickets
Found in: Component config > ESP-TLS
Enable session ticket support as specified in RFC5077
- Default value:
No (disabled) if CONFIG_ESP_TLS_SERVER && ESP_TLS_USING_MBEDTLS && CONFIG_MBEDTLS_SERVER_SSL_SESSION_TICKETS
CONFIG_ESP_TLS_SERVER_SESSION_TICKET_TIMEOUT¶
Server session ticket timeout in seconds
Found in: Component config > ESP-TLS > CONFIG_ESP_TLS_SERVER_SESSION_TICKETS
Sets the session ticket timeout used in the tls server.
- Default value:
CONFIG_ESP_TLS_PSK_VERIFICATION¶
Enable PSK verification
Found in: Component config > ESP-TLS
Enable support for pre shared key ciphers, supported for both mbedTLS as well as wolfSSL TLS library.
- Default value:
No (disabled)
CONFIG_ESP_TLS_INSECURE¶
Allow potentially insecure options
Found in: Component config > ESP-TLS
You can enable some potentially insecure options. These options should only be used for testing pusposes. Only enable these options if you are very sure.
CONFIG_ESP_TLS_SKIP_SERVER_CERT_VERIFY¶
Skip server certificate verification by default (WARNING: ONLY FOR TESTING PURPOSE, READ HELP)
Found in: Component config > ESP-TLS > CONFIG_ESP_TLS_INSECURE
After enabling this option the esp-tls client will skip the server certificate verification by default. Note that this option will only modify the default behaviour of esp-tls client regarding server cert verification. The default behaviour should only be applicable when no other option regarding the server cert verification is opted in the esp-tls config (e.g. crt_bundle_attach, use_global_ca_store etc.). WARNING : Enabling this option comes with a potential risk of establishing a TLS connection with a server which has a fake identity, provided that the server certificate is not provided either through API or other mechanism like ca_store etc.
CONFIG_ESP_WOLFSSL_SMALL_CERT_VERIFY¶
Enable SMALL_CERT_VERIFY
Found in: Component config > ESP-TLS
Enables server verification with Intermediate CA cert, does not authenticate full chain of trust upto the root CA cert (After Enabling this option client only needs to have Intermediate CA certificate of the server to authenticate server, root CA cert is not necessary).
- Default value:
Yes (enabled) if ESP_TLS_USING_WOLFSSL
CONFIG_ESP_DEBUG_WOLFSSL¶
Enable debug logs for wolfSSL
Found in: Component config > ESP-TLS
Enable detailed debug prints for wolfSSL SSL library.
- Default value:
No (disabled) if ESP_TLS_USING_WOLFSSL
ESP32C3-Specific¶
Contains:
CONFIG_ESP32C3_DEFAULT_CPU_FREQ_MHZ¶
CPU frequency
Found in: Component config > ESP32C3-Specific
CPU frequency to be set on application startup.
- Available options:
40 MHz (ESP32C3_DEFAULT_CPU_FREQ_40)
80 MHz (ESP32C3_DEFAULT_CPU_FREQ_80)
160 MHz (ESP32C3_DEFAULT_CPU_FREQ_160)
CONFIG_ESP32C3_REV_MIN¶
Minimum Supported ESP32-C3 Revision
Found in: Component config > ESP32C3-Specific
Minimum revision that ESP-IDF would support.
Only supporting higher chip revisions can reduce binary size.
- Available options:
Rev 0 (ESP32C3_REV_MIN_0)
Rev 1 (ESP32C3_REV_MIN_1)
Rev 2 (ESP32C3_REV_MIN_2)
Rev 3 (ESP32C3_REV_MIN_3)
CONFIG_ESP32C3_DEBUG_OCDAWARE¶
Make exception and panic handlers JTAG/OCD aware
Found in: Component config > ESP32C3-Specific
The FreeRTOS panic and unhandled exception handers can detect a JTAG OCD debugger and instead of panicking, have the debugger stop on the offending instruction.
- Default value:
Yes (enabled)
CONFIG_ESP32C3_BROWNOUT_DET¶
Hardware brownout detect & reset
Found in: Component config > ESP32C3-Specific
The ESP32-C3 has a built-in brownout detector which can detect if the voltage is lower than a specific value. If this happens, it will reset the chip in order to prevent unintended behaviour.
- Default value:
Yes (enabled)
CONFIG_ESP32C3_BROWNOUT_DET_LVL_SEL¶
Brownout voltage level
Found in: Component config > ESP32C3-Specific > CONFIG_ESP32C3_BROWNOUT_DET
The brownout detector will reset the chip when the supply voltage is approximately below this level. Note that there may be some variation of brownout voltage level between each chip.
#The voltage levels here are estimates, more work needs to be done to figure out the exact voltages #of the brownout threshold levels.
- Available options:
2.51V (ESP32C3_BROWNOUT_DET_LVL_SEL_7)
2.64V (ESP32C3_BROWNOUT_DET_LVL_SEL_6)
2.76V (ESP32C3_BROWNOUT_DET_LVL_SEL_5)
2.92V (ESP32C3_BROWNOUT_DET_LVL_SEL_4)
3.10V (ESP32C3_BROWNOUT_DET_LVL_SEL_3)
3.27V (ESP32C3_BROWNOUT_DET_LVL_SEL_2)
CONFIG_ESP32C3_TIME_SYSCALL¶
Timers used for gettimeofday function
Found in: Component config > ESP32C3-Specific
This setting defines which hardware timers are used to implement ‘gettimeofday’ and ‘time’ functions in C library.
If both high-resolution (systimer) and RTC timers are used, timekeeping will continue in deep sleep. Time will be reported at 1 microsecond resolution. This is the default, and the recommended option.
If only high-resolution timer (systimer) is used, gettimeofday will provide time at microsecond resolution. Time will not be preserved when going into deep sleep mode.
If only RTC timer is used, timekeeping will continue in deep sleep, but time will be measured at 6.(6) microsecond resolution. Also the gettimeofday function itself may take longer to run.
If no timers are used, gettimeofday and time functions return -1 and set errno to ENOSYS.
When RTC is used for timekeeping, two RTC_STORE registers are used to keep time in deep sleep mode.
- Available options:
RTC and high-resolution timer (ESP32C3_TIME_SYSCALL_USE_RTC_SYSTIMER)
RTC (ESP32C3_TIME_SYSCALL_USE_RTC)
High-resolution timer (ESP32C3_TIME_SYSCALL_USE_SYSTIMER)
None (ESP32C3_TIME_SYSCALL_USE_NONE)
CONFIG_ESP32C3_RTC_CLK_SRC¶
RTC clock source
Found in: Component config > ESP32C3-Specific
Choose which clock is used as RTC clock source.
- Available options:
Internal 150kHz RC oscillator (ESP32C3_RTC_CLK_SRC_INT_RC)
External 32kHz crystal (ESP32C3_RTC_CLK_SRC_EXT_CRYS)
External 32kHz oscillator at 32K_XP pin (ESP32C3_RTC_CLK_SRC_EXT_OSC)
Internal 8MHz oscillator, divided by 256 (~32kHz) (ESP32C3_RTC_CLK_SRC_INT_8MD256)
CONFIG_ESP32C3_RTC_CLK_CAL_CYCLES¶
Number of cycles for RTC_SLOW_CLK calibration
Found in: Component config > ESP32C3-Specific
When the startup code initializes RTC_SLOW_CLK, it can perform calibration by comparing the RTC_SLOW_CLK frequency with main XTAL frequency. This option sets the number of RTC_SLOW_CLK cycles measured by the calibration routine. Higher numbers increase calibration precision, which may be important for applications which spend a lot of time in deep sleep. Lower numbers reduce startup time.
When this option is set to 0, clock calibration will not be performed at startup, and approximate clock frequencies will be assumed:
150000 Hz if internal RC oscillator is used as clock source. For this use value 1024.
32768 Hz if the 32k crystal oscillator is used. For this use value 3000 or more. In case more value will help improve the definition of the launch of the crystal. If the crystal could not start, it will be switched to internal RC.
- Range:
from 0 to 27000 if ESP32C3_RTC_CLK_SRC_EXT_CRYS || ESP32C3_RTC_CLK_SRC_EXT_OSC || ESP32C3_RTC_CLK_SRC_INT_8MD256
from 0 to 32766
- Default value:
3000 if ESP32C3_RTC_CLK_SRC_EXT_CRYS || ESP32C3_RTC_CLK_SRC_EXT_OSC || ESP32C3_RTC_CLK_SRC_INT_8MD256
1024
CONFIG_ESP32C3_NO_BLOBS¶
No Binary Blobs
Found in: Component config > ESP32C3-Specific
If enabled, this disables the linking of binary libraries in the application build. Note that after enabling this Wi-Fi/Bluetooth will not work.
- Default value:
No (disabled) if CONFIG_BT_ENABLED
ADC-Calibration¶
Ethernet¶
Contains:
CONFIG_ETH_USE_SPI_ETHERNET¶
Support SPI to Ethernet Module
Found in: Component config > Ethernet
ESP-IDF can also support some SPI-Ethernet modules.
- Default value:
Yes (enabled)
Contains:
CONFIG_ETH_SPI_ETHERNET_DM9051¶
Use DM9051
Found in: Component config > Ethernet > CONFIG_ETH_USE_SPI_ETHERNET
DM9051 is a fast Ethernet controller with an SPI interface. It’s also integrated with a 10/100M PHY and MAC. Select this to enable DM9051 driver.
CONFIG_ETH_SPI_ETHERNET_W5500¶
Use W5500 (MAC RAW)
Found in: Component config > Ethernet > CONFIG_ETH_USE_SPI_ETHERNET
W5500 is a HW TCP/IP embedded Ethernet controller. TCP/IP stack, 10/100 Ethernet MAC and PHY are embedded in a single chip. However the driver in ESP-IDF only enables the RAW MAC mode, making it compatible with the software TCP/IP stack. Say yes to enable W5500 driver.
CONFIG_ETH_SPI_ETHERNET_KSZ8851SNL¶
Use KSZ8851SNL
Found in: Component config > Ethernet > CONFIG_ETH_USE_SPI_ETHERNET
The KSZ8851SNL is a single-chip Fast Ethernet controller consisting of a 10/100 physical layer transceiver (PHY), a MAC, and a Serial Peripheral Interface (SPI). Select this to enable KSZ8851SNL driver.
CONFIG_ETH_USE_OPENETH¶
Support OpenCores Ethernet MAC (for use with QEMU)
Found in: Component config > Ethernet
OpenCores Ethernet MAC driver can be used when an ESP-IDF application is executed in QEMU. This driver is not supported when running on a real chip.
- Default value:
No (disabled)
Contains:
CONFIG_ETH_OPENETH_DMA_RX_BUFFER_NUM¶
Number of Ethernet DMA Rx buffers
Found in: Component config > Ethernet > CONFIG_ETH_USE_OPENETH
Number of DMA receive buffers, each buffer is 1600 bytes.
- Range:
from 1 to 64 if CONFIG_ETH_USE_OPENETH
- Default value:
CONFIG_ETH_OPENETH_DMA_TX_BUFFER_NUM¶
Number of Ethernet DMA Tx buffers
Found in: Component config > Ethernet > CONFIG_ETH_USE_OPENETH
Number of DMA transmit buffers, each buffer is 1600 bytes.
- Range:
from 1 to 64 if CONFIG_ETH_USE_OPENETH
- Default value:
Event Loop Library¶
Contains:
CONFIG_ESP_EVENT_LOOP_PROFILING¶
Enable event loop profiling
Found in: Component config > Event Loop Library
Enables collections of statistics in the event loop library such as the number of events posted to/recieved by an event loop, number of callbacks involved, number of events dropped to to a full event loop queue, run time of event handlers, and number of times/run time of each event handler.
- Default value:
No (disabled)
CONFIG_ESP_EVENT_POST_FROM_ISR¶
Support posting events from ISRs
Found in: Component config > Event Loop Library
Enable posting events from interrupt handlers.
- Default value:
Yes (enabled)
CONFIG_ESP_EVENT_POST_FROM_IRAM_ISR¶
Support posting events from ISRs placed in IRAM
Found in: Component config > Event Loop Library > CONFIG_ESP_EVENT_POST_FROM_ISR
Enable posting events from interrupt handlers placed in IRAM. Enabling this option places API functions esp_event_post and esp_event_post_to in IRAM.
- Default value:
Yes (enabled)
GDB Stub¶
Contains:
CONFIG_ESP_GDBSTUB_SUPPORT_TASKS¶
Enable listing FreeRTOS tasks through GDB Stub
Found in: Component config > GDB Stub
If enabled, GDBStub can supply the list of FreeRTOS tasks to GDB. Thread list can be queried from GDB using ‘info threads’ command. Note that if GDB task lists were corrupted, this feature may not work. If GDBStub fails, try disabling this feature.
CONFIG_ESP_GDBSTUB_MAX_TASKS¶
Maximum number of tasks supported by GDB Stub
Found in: Component config > GDB Stub > CONFIG_ESP_GDBSTUB_SUPPORT_TASKS
Set the number of tasks which GDB Stub will support.
- Default value:
ESP HTTP client¶
Contains:
CONFIG_ESP_HTTP_CLIENT_ENABLE_HTTPS¶
Enable https
Found in: Component config > ESP HTTP client
This option will enable https protocol by linking esp-tls library and initializing SSL transport
- Default value:
Yes (enabled)
CONFIG_ESP_HTTP_CLIENT_ENABLE_BASIC_AUTH¶
Enable HTTP Basic Authentication
Found in: Component config > ESP HTTP client
This option will enable HTTP Basic Authentication. It is disabled by default as Basic auth uses unencrypted encoding, so it introduces a vulnerability when not using TLS
- Default value:
No (disabled)
CONFIG_ESP_HTTP_CLIENT_ENABLE_DIGEST_AUTH¶
Enable HTTP Digest Authentication
Found in: Component config > ESP HTTP client
This option will enable HTTP Digest Authentication. It is enabled by default, but use of this configuration is not recommended as the password can be derived from the exchange, so it introduces a vulnerability when not using TLS
- Default value:
Yes (enabled)
HTTP Server¶
Contains:
CONFIG_HTTPD_MAX_REQ_HDR_LEN¶
Max HTTP Request Header Length
Found in: Component config > HTTP Server
This sets the maximum supported size of headers section in HTTP request packet to be processed by the server
- Default value:
512
CONFIG_HTTPD_MAX_URI_LEN¶
Max HTTP URI Length
Found in: Component config > HTTP Server
This sets the maximum supported size of HTTP request URI to be processed by the server
- Default value:
512
CONFIG_HTTPD_ERR_RESP_NO_DELAY¶
Use TCP_NODELAY socket option when sending HTTP error responses
Found in: Component config > HTTP Server
Using TCP_NODEALY socket option ensures that HTTP error response reaches the client before the underlying socket is closed. Please note that turning this off may cause multiple test failures
- Default value:
Yes (enabled)
CONFIG_HTTPD_PURGE_BUF_LEN¶
Length of temporary buffer for purging data
Found in: Component config > HTTP Server
This sets the size of the temporary buffer used to receive and discard any remaining data that is received from the HTTP client in the request, but not processed as part of the server HTTP request handler.
If the remaining data is larger than the available buffer size, the buffer will be filled in multiple iterations. The buffer should be small enough to fit on the stack, but large enough to avoid excessive iterations.
- Default value:
32
CONFIG_HTTPD_LOG_PURGE_DATA¶
Log purged content data at Debug level
Found in: Component config > HTTP Server
Enabling this will log discarded binary HTTP request data at Debug level. For large content data this may not be desirable as it will clutter the log.
- Default value:
No (disabled)
CONFIG_HTTPD_WS_SUPPORT¶
WebSocket server support
Found in: Component config > HTTP Server
This sets the WebSocket server support.
- Default value:
No (disabled)
ESP HTTPS OTA¶
Contains:
CONFIG_OTA_ALLOW_HTTP¶
Allow HTTP for OTA (WARNING: ONLY FOR TESTING PURPOSE, READ HELP)
Found in: Component config > ESP HTTPS OTA
It is highly recommended to keep HTTPS (along with server certificate validation) enabled. Enabling this option comes with potential risk of: - Non-encrypted communication channel with server - Accepting firmware upgrade image from server with fake identity
- Default value:
No (disabled)
ESP HTTPS server¶
Contains:
CONFIG_ESP_HTTPS_SERVER_ENABLE¶
Enable ESP_HTTPS_SERVER component
Found in: Component config > ESP HTTPS server
Enable ESP HTTPS server component
Hardware Settings¶
Contains:
MAC Config¶
Contains:
CONFIG_ESP32C3_UNIVERSAL_MAC_ADDRESSES¶
Number of universally administered (by IEEE) MAC address
Found in: Component config > Hardware Settings > MAC Config
Configure the number of universally administered (by IEEE) MAC addresses.
During initialization, MAC addresses for each network interface are generated or derived from a single base MAC address.
If the number of universal MAC addresses is four, all four interfaces (WiFi station, WiFi softap, Bluetooth and Ethernet) receive a universally administered MAC address. These are generated sequentially by adding 0, 1, 2 and 3 (respectively) to the final octet of the base MAC address.
If the number of universal MAC addresses is two, only two interfaces (WiFi station and Bluetooth) receive a universally administered MAC address. These are generated sequentially by adding 0 and 1 (respectively) to the base MAC address. The remaining two interfaces (WiFi softap and Ethernet) receive local MAC addresses. These are derived from the universal WiFi station and Bluetooth MAC addresses, respectively.
When using the default (Espressif-assigned) base MAC address, either setting can be used. When using a custom universal MAC address range, the correct setting will depend on the allocation of MAC addresses in this range (either 2 or 4 per device.)
Note that ESP32-C3 has no integrated Ethernet MAC. Although it’s possible to use the esp_read_mac() API to return a MAC for Ethernet, this can only be used with an external MAC peripheral.
- Available options:
Two (ESP32C3_UNIVERSAL_MAC_ADDRESSES_TWO)
Four (ESP32C3_UNIVERSAL_MAC_ADDRESSES_FOUR)
Sleep Config¶
Contains:
CONFIG_ESP_SLEEP_POWER_DOWN_FLASH¶
Power down flash in light sleep when there is no SPIRAM
Found in: Component config > Hardware Settings > Sleep Config
If enabled, chip will try to power down flash as part of esp_light_sleep_start(), which costs more time when chip wakes up. Can only be enabled if there is no SPIRAM configured. This option will in fact consider VDD_SDIO auto power value (ESP_PD_OPTION_AUTO) as OFF. Also, it is possible to force a power domain to stay ON during light sleep by using esp_sleep_pd_config() function.
- Default value:
Yes (enabled) if SPIRAM
CONFIG_ESP_SLEEP_GPIO_RESET_WORKAROUND¶
light sleep GPIO reset workaround
Found in: Component config > Hardware Settings > Sleep Config
esp32c3 and esp32s3 will reset at wake-up if GPIO is received a small electrostatic pulse during light sleep, with specific condition
GPIO needs to be configured as input-mode only
The pin receives a small electrostatic pulse, and reset occurs when the pulse voltage is higher than 6 V
For GPIO set to input mode only, it is not a good practice to leave it open/floating, The hardware design needs to controlled it with determined supply or ground voltage is necessary.
This option provides a software workaround for this issue. Configure to isolate all GPIO pins in sleep state.
- Default value:
Yes (enabled)
CONFIG_ESP_SLEEP_PSRAM_LEAKAGE_WORKAROUND¶
PSRAM leakage current workaround in light sleep
Found in: Component config > Hardware Settings > Sleep Config
When the CS pin of SPIRAM is not pulled up, the sleep current will increase during light sleep. If the CS pin of SPIRAM has an external pull-up, you do not need to select this option, otherwise, you should enable this option.
CONFIG_ESP_SLEEP_FLASH_LEAKAGE_WORKAROUND¶
Flash leakage current workaround in light sleep
Found in: Component config > Hardware Settings > Sleep Config
When the CS pin of Flash is not pulled up, the sleep current will increase during light sleep. If the CS pin of Flash has an external pull-up, you do not need to select this option, otherwise, you should enable this option.
RTC Clock Config¶
Contains:
CONFIG_RTC_CLOCK_BBPLL_POWER_ON_WITH_USB¶
Keep BBPLL clock always work
Found in: Component config > Hardware Settings > RTC Clock Config
When the chip goes sleep or software reset, the clock source would change to XTAL and switch off the BBPLL clock for saving power. However, this might make the USB_SERIAL_JTAG down which depends on BBPLL as its unique clock source. Therefore, this is used for keeping bbpll clock always on when USB_SERIAL_JTAG PORT is using. If you want to use USB_SERIAL_JTAG under sw_reset case or sleep-wakeup case, you shoule select this option. But be aware that this might increase the power consumption.
- Default value:
Yes (enabled)
IPC (Inter-Processor Call)¶
Contains:
CONFIG_ESP_IPC_TASK_STACK_SIZE¶
Inter-Processor Call (IPC) task stack size
Found in: Component config > IPC (Inter-Processor Call)
Configure the IPC tasks stack size. An IPC task runs on each core (in dual core mode), and allows for cross-core function calls. See IPC documentation for more details. The default IPC stack size should be enough for most common simple use cases. However, users can increase/decrease the stack size to their needs.
- Range:
from 512 to 65536
- Default value:
1536
CONFIG_ESP_IPC_USES_CALLERS_PRIORITY¶
IPC runs at caller’s priority
Found in: Component config > IPC (Inter-Processor Call)
If this option is not enabled then the IPC task will keep behavior same as prior to that of ESP-IDF v4.0, hence IPC task will run at (configMAX_PRIORITIES - 1) priority.
- Default value:
Yes (enabled)
LCD and Touch Panel¶
Contains:
LCD Peripheral Configuration¶
Contains:
CONFIG_LCD_PANEL_IO_FORMAT_BUF_SIZE¶
LCD panel io format buffer size
Found in: Component config > LCD and Touch Panel > LCD Peripheral Configuration
LCD driver allocates an internal buffer to transform the data into a proper format, because of the endian order mismatch. This option is to set the size of the buffer, in bytes.
- Default value:
32
ESP NETIF Adapter¶
Contains:
CONFIG_ESP_NETIF_IP_LOST_TIMER_INTERVAL¶
IP Address lost timer interval (seconds)
Found in: Component config > ESP NETIF Adapter
The value of 0 indicates the IP lost timer is disabled, otherwise the timer is enabled.
The IP address may be lost because of some reasons, e.g. when the station disconnects from soft-AP, or when DHCP IP renew fails etc. If the IP lost timer is enabled, it will be started everytime the IP is lost. Event SYSTEM_EVENT_STA_LOST_IP will be raised if the timer expires. The IP lost timer is stopped if the station get the IP again before the timer expires.
- Range:
from 0 to 65535
- Default value:
120
CONFIG_ESP_NETIF_USE_TCPIP_STACK_LIB¶
TCP/IP Stack Library
Found in: Component config > ESP NETIF Adapter
Choose the TCP/IP Stack to work, for example, LwIP, uIP, etc.
- Available options:
LwIP (ESP_NETIF_TCPIP_LWIP)
lwIP is a small independent implementation of the TCP/IP protocol suite.
Loopback (ESP_NETIF_LOOPBACK)
Dummy implementation of esp-netif functionality which connects driver transmit to receive function. This option is for testing purpose only
CONFIG_ESP_NETIF_TCPIP_ADAPTER_COMPATIBLE_LAYER¶
Enable backward compatible tcpip_adapter interface
Found in: Component config > ESP NETIF Adapter
Backward compatible interface to tcpip_adapter is enabled by default to support legacy TCP/IP stack initialisation code. Disable this option to use only esp-netif interface.
- Default value:
Yes (enabled)
PHY¶
Contains:
CONFIG_ESP_PHY_CALIBRATION_AND_DATA_STORAGE¶
Store phy calibration data in NVS
Found in: Component config > PHY
If this option is enabled, NVS will be initialized and calibration data will be loaded from there. PHY calibration will be skipped on deep sleep wakeup. If calibration data is not found, full calibration will be performed and stored in NVS. Normally, only partial calibration will be performed. If this option is disabled, full calibration will be performed.
If it’s easy that your board calibrate bad data, choose ‘n’. Two cases for example, you should choose ‘n’: 1.If your board is easy to be booted up with antenna disconnected. 2.Because of your board design, each time when you do calibration, the result are too unstable. If unsure, choose ‘y’.
- Default value:
Yes (enabled)
CONFIG_ESP_PHY_INIT_DATA_IN_PARTITION¶
Use a partition to store PHY init data
Found in: Component config > PHY
If enabled, PHY init data will be loaded from a partition. When using a custom partition table, make sure that PHY data partition is included (type: ‘data’, subtype: ‘phy’). With default partition tables, this is done automatically. If PHY init data is stored in a partition, it has to be flashed there, otherwise runtime error will occur.
If this option is not enabled, PHY init data will be embedded into the application binary.
If unsure, choose ‘n’.
- Default value:
No (disabled)
Contains:
CONFIG_ESP_PHY_DEFAULT_INIT_IF_INVALID¶
Reset default PHY init data if invalid
Found in: Component config > PHY > CONFIG_ESP_PHY_INIT_DATA_IN_PARTITION
If enabled, PHY init data will be restored to default if it cannot be verified successfully to avoid endless bootloops.
If unsure, choose ‘n’.
- Default value:
No (disabled) if CONFIG_ESP_PHY_INIT_DATA_IN_PARTITION
CONFIG_ESP_PHY_MULTIPLE_INIT_DATA_BIN¶
Support multiple PHY init data bin
Found in: Component config > PHY > CONFIG_ESP_PHY_INIT_DATA_IN_PARTITION
If enabled, the corresponding PHY init data type can be automatically switched according to the country code. China’s PHY init data bin is used by default. Can be modified by country information in API esp_wifi_set_country(). The priority of switching the PHY init data type is: 1. Country configured by API esp_wifi_set_country() and the parameter policy is WIFI_COUNTRY_POLICY_MANUAL. 2. Country notified by the connected AP. 3. Country configured by API esp_wifi_set_country() and the parameter policy is WIFI_COUNTRY_POLICY_AUTO.
- Default value:
No (disabled) if CONFIG_ESP_PHY_INIT_DATA_IN_PARTITION && CONFIG_ESP_PHY_INIT_DATA_IN_PARTITION
CONFIG_ESP_PHY_MULTIPLE_INIT_DATA_BIN_EMBED¶
Support embedded multiple phy init data bin to app bin
Found in: Component config > PHY > CONFIG_ESP_PHY_INIT_DATA_IN_PARTITION > CONFIG_ESP_PHY_MULTIPLE_INIT_DATA_BIN
If enabled, multiple phy init data bin will embedded into app bin If not enabled, multiple phy init data bin will still leave alone, and need to be flashed by users.
- Default value:
No (disabled) if CONFIG_ESP_PHY_MULTIPLE_INIT_DATA_BIN && CONFIG_ESP_PHY_INIT_DATA_IN_PARTITION
CONFIG_ESP_PHY_INIT_DATA_ERROR¶
Terminate operation when PHY init data error
Found in: Component config > PHY > CONFIG_ESP_PHY_INIT_DATA_IN_PARTITION > CONFIG_ESP_PHY_MULTIPLE_INIT_DATA_BIN
If enabled, when an error occurs while the PHY init data is updated, the program will terminate and restart. If not enabled, the PHY init data will not be updated when an error occurs.
- Default value:
No (disabled) if CONFIG_ESP_PHY_MULTIPLE_INIT_DATA_BIN && CONFIG_ESP_PHY_INIT_DATA_IN_PARTITION
CONFIG_ESP_PHY_MAX_WIFI_TX_POWER¶
Max WiFi TX power (dBm)
Found in: Component config > PHY
Set maximum transmit power for WiFi radio. Actual transmit power for high data rates may be lower than this setting.
- Range:
from 10 to 20
- Default value:
20
CONFIG_ESP_PHY_MAC_BB_PD¶
Power down MAC and baseband of Wi-Fi and Bluetooth when PHY is disabled
Found in: Component config > PHY
If enabled, the MAC and baseband of Wi-Fi and Bluetooth will be powered down when PHY is disabled. Enabling this setting reduces power consumption by a small amount but increases RAM use by approximately 4 KB(Wi-Fi only), 2 KB(Bluetooth only) or 5.3 KB(Wi-Fi + Bluetooth).
- Default value:
No (disabled) if CONFIG_FREERTOS_USE_TICKLESS_IDLE
CONFIG_ESP_PHY_REDUCE_TX_POWER¶
Reduce PHY TX power when brownout reset
Found in: Component config > PHY
When brownout reset occurs, reduce PHY TX power to keep the code running.
- Default value:
Yes (enabled) if ESP32_BROWNOUT_DET
CONFIG_ESP_PHY_ENABLE_USB¶
Enable USB when phy init
Found in: Component config > PHY
When using USB Serial/JTAG/OTG/CDC, PHY should enable USB, otherwise USB module can not work properly. Notice: Enabling this configuration option will slightly impact wifi performance.
- Default value:
Yes (enabled)
No (disabled)
Power Management¶
Contains:
CONFIG_PM_ENABLE¶
Support for power management
Found in: Component config > Power Management
If enabled, application is compiled with support for power management. This option has run-time overhead (increased interrupt latency, longer time to enter idle state), and it also reduces accuracy of RTOS ticks and timers used for timekeeping. Enable this option if application uses power management APIs.
- Default value:
No (disabled)
CONFIG_PM_DFS_INIT_AUTO¶
Enable dynamic frequency scaling (DFS) at startup
Found in: Component config > Power Management > CONFIG_PM_ENABLE
If enabled, startup code configures dynamic frequency scaling. Max CPU frequency is set to DEFAULT_CPU_FREQ_MHZ setting, min frequency is set to XTAL frequency. If disabled, DFS will not be active until the application configures it using esp_pm_configure function.
- Default value:
No (disabled) if CONFIG_PM_ENABLE
CONFIG_PM_PROFILING¶
Enable profiling counters for PM locks
Found in: Component config > Power Management > CONFIG_PM_ENABLE
If enabled, esp_pm_* functions will keep track of the amount of time each of the power management locks has been held, and esp_pm_dump_locks function will print this information. This feature can be used to analyze which locks are preventing the chip from going into a lower power state, and see what time the chip spends in each power saving mode. This feature does incur some run-time overhead, so should typically be disabled in production builds.
- Default value:
No (disabled) if CONFIG_PM_ENABLE
CONFIG_PM_TRACE¶
Enable debug tracing of PM using GPIOs
Found in: Component config > Power Management > CONFIG_PM_ENABLE
If enabled, some GPIOs will be used to signal events such as RTOS ticks, frequency switching, entry/exit from idle state. Refer to pm_trace.c file for the list of GPIOs. This feature is intended to be used when analyzing/debugging behavior of power management implementation, and should be kept disabled in applications.
- Default value:
No (disabled) if CONFIG_PM_ENABLE
CONFIG_PM_SLP_IRAM_OPT¶
Put lightsleep related codes in internal RAM
Found in: Component config > Power Management
If enabled, about 1.8KB of lightsleep related source code would be in IRAM and chip would sleep longer for 760us at most each time. This feature is intended to be used when lower power consumption is needed while there is enough place in IRAM to place source code.
CONFIG_PM_RTOS_IDLE_OPT¶
Put RTOS IDLE related codes in internal RAM
Found in: Component config > Power Management
If enabled, about 260B of RTOS_IDLE related source code would be in IRAM and chip would sleep longer for 40us at most each time. This feature is intended to be used when lower power consumption is needed while there is enough place in IRAM to place source code.
CONFIG_PM_SLP_DISABLE_GPIO¶
Disable all GPIO when chip at sleep
Found in: Component config > Power Management
This feature is intended to disable all GPIO pins at automantic sleep to get a lower power mode. If enabled, chips will disable all GPIO pins at automantic sleep to reduce about 200~300 uA current. If you want to specifically use some pins normally as chip wakes when chip sleeps, you can call ‘gpio_sleep_sel_dis’ to disable this feature on those pins. You can also keep this feature on and call ‘gpio_sleep_set_direction’ and ‘gpio_sleep_set_pull_mode’ to have a different GPIO configuration at sleep. Waring: If you want to enable this option on ESP32, you should enable GPIO_ESP32_SUPPORT_SWITCH_SLP_PULL at first, otherwise you will not be able to switch pullup/pulldown mode.
CONFIG_PM_POWER_DOWN_CPU_IN_LIGHT_SLEEP¶
Power down CPU in light sleep
Found in: Component config > Power Management
If enabled, the CPU will be powered down in light sleep. On esp32c3 soc, enabling this option will consume 1.68 KB of internal RAM and will reduce sleep current consumption by about 100 uA. On esp32s3 soc, enabling this option will consume 8.58 KB of internal RAM and will reduce sleep current consumption by about 650 uA.
- Default value:
Yes (enabled)
ESP System Settings¶
Contains:
CONFIG_ESP_SYSTEM_PANIC¶
Panic handler behaviour
Found in: Component config > ESP System Settings
If FreeRTOS detects unexpected behaviour or an unhandled exception, the panic handler is invoked. Configure the panic handler’s action here.
- Available options:
Print registers and halt (ESP_SYSTEM_PANIC_PRINT_HALT)
Outputs the relevant registers over the serial port and halt the processor. Needs a manual reset to restart.
Print registers and reboot (ESP_SYSTEM_PANIC_PRINT_REBOOT)
Outputs the relevant registers over the serial port and immediately reset the processor.
Silent reboot (ESP_SYSTEM_PANIC_SILENT_REBOOT)
Just resets the processor without outputting anything
GDBStub on panic (ESP_SYSTEM_PANIC_GDBSTUB)
Invoke gdbstub on the serial port, allowing for gdb to attach to it to do a postmortem of the crash.
GDBStub at runtime (ESP_SYSTEM_GDBSTUB_RUNTIME)
Invoke gdbstub on the serial port, allowing for gdb to attach to it and to do a debug on runtime. This feature will switch system to single core mode.
CONFIG_ESP_SYSTEM_RTC_EXT_XTAL_BOOTSTRAP_CYCLES¶
Bootstrap cycles for external 32kHz crystal
Found in: Component config > ESP System Settings
To reduce the startup time of an external RTC crystal, we bootstrap it with a 32kHz square wave for a fixed number of cycles. Setting 0 will disable bootstrapping (if disabled, the crystal may take longer to start up or fail to oscillate under some conditions).
If this value is too high, a faulty crystal may initially start and then fail. If this value is too low, an otherwise good crystal may not start.
To accurately determine if the crystal has started, set a larger “Number of cycles for RTC_SLOW_CLK calibration” (about 3000).
CONFIG_ESP_SYSTEM_ALLOW_RTC_FAST_MEM_AS_HEAP¶
Enable RTC fast memory for dynamic allocations
Found in: Component config > ESP System Settings
This config option allows to add RTC fast memory region to system heap with capability similar to that of DRAM region but without DMA. This memory will be consumed first per heap initialization order by early startup services and scheduler related code. Speed wise RTC fast memory operates on APB clock and hence does not have much performance impact.
- Default value:
Yes (enabled)
CONFIG_ESP_SYSTEM_USE_EH_FRAME¶
Generate and use eh_frame for backtracing
Found in: Component config > ESP System Settings
Generate DWARF information for each function of the project. These information will parsed and used to perform backtracing when panics occur. Activating this option will activate asynchronous frame unwinding and generation of both .eh_frame and .eh_frame_hdr sections, resulting in a bigger binary size (20% to 100% larger). The main purpose of this option is to be able to have a backtrace parsed and printed by the program itself, regardless of the serial monitor used. This option shall NOT be used for production.
- Default value:
No (disabled)
Memory protection¶
Contains:
CONFIG_ESP_SYSTEM_MEMPROT_FEATURE¶
Enable memory protection
Found in: Component config > ESP System Settings > Memory protection
If enabled, the permission control module watches all the memory access and fires the panic handler if a permission violation is detected. This feature automatically splits the SRAM memory into data and instruction segments and sets Read/Execute permissions for the instruction part (below given splitting address) and Read/Write permissions for the data part (above the splitting address). The memory protection is effective on all access through the IRAM0 and DRAM0 buses.
- Default value:
Yes (enabled)
CONFIG_ESP_SYSTEM_MEMPROT_FEATURE_LOCK¶
Lock memory protection settings
Found in: Component config > ESP System Settings > Memory protection > CONFIG_ESP_SYSTEM_MEMPROT_FEATURE
Once locked, memory protection settings cannot be changed anymore. The lock is reset only on the chip startup.
- Default value:
Yes (enabled)
CONFIG_ESP_SYSTEM_EVENT_QUEUE_SIZE¶
System event queue size
Found in: Component config > ESP System Settings
Config system event queue size in different application.
- Default value:
32
CONFIG_ESP_SYSTEM_EVENT_TASK_STACK_SIZE¶
Event loop task stack size
Found in: Component config > ESP System Settings
Config system event task stack size in different application.
- Default value:
2304
CONFIG_ESP_MAIN_TASK_STACK_SIZE¶
Main task stack size
Found in: Component config > ESP System Settings
Configure the “main task” stack size. This is the stack of the task which calls app_main(). If app_main() returns then this task is deleted and its stack memory is freed.
- Default value:
3584
CONFIG_ESP_MAIN_TASK_AFFINITY¶
Main task core affinity
Found in: Component config > ESP System Settings
Configure the “main task” core affinity. This is the used core of the task which calls app_main(). If app_main() returns then this task is deleted.
- Available options:
CPU0 (ESP_MAIN_TASK_AFFINITY_CPU0)
CPU1 (ESP_MAIN_TASK_AFFINITY_CPU1)
No affinity (ESP_MAIN_TASK_AFFINITY_NO_AFFINITY)
CONFIG_ESP_CONSOLE_UART¶
Channel for console output
Found in: Component config > ESP System Settings
Select where to send console output (through stdout and stderr).
Default is to use UART0 on pre-defined GPIOs.
If “Custom” is selected, UART0 or UART1 can be chosen, and any pins can be selected.
If “None” is selected, there will be no console output on any UART, except for initial output from ROM bootloader. This ROM output can be suppressed by GPIO strapping or EFUSE, refer to chip datasheet for details.
On chips with USB OTG peripheral, “USB CDC” option redirects output to the CDC port. This option uses the CDC driver in the chip ROM. This option is incompatible with TinyUSB stack.
On chips with an USB serial/JTAG debug controller, selecting the option for that redirects output to the CDC/ACM (serial port emulation) component of that device.
- Available options:
Default: UART0 (ESP_CONSOLE_UART_DEFAULT)
USB CDC (ESP_CONSOLE_USB_CDC)
USB Serial/JTAG Controller (ESP_CONSOLE_USB_SERIAL_JTAG)
Custom UART (ESP_CONSOLE_UART_CUSTOM)
None (ESP_CONSOLE_NONE)
CONFIG_ESP_CONSOLE_SECONDARY¶
Channel for console secondary output
Found in: Component config > ESP System Settings
This secondary option supports output through other specific port like USB_SERIAL_JTAG when UART0 port as a primary is selected but not connected. This secondary output currently only supports non-blocking mode without using REPL. If you want to output in blocking mode with REPL or input through this secondary port, please change the primary config to this port in Channel for console output menu.
- Available options:
No secondary console (ESP_CONSOLE_SECONDARY_NONE)
USB_SERIAL_JTAG PORT (ESP_CONSOLE_SECONDARY_USB_SERIAL_JTAG)
This option supports output through USB_SERIAL_JTAG port when the UART0 port is not connected. The output currently only supports non-blocking mode without using the console. If you want to output in blocking mode with REPL or input through USB_SERIAL_JTAG port, please change the primary config to ESP_CONSOLE_USB_SERIAL_JTAG above.
CONFIG_ESP_CONSOLE_UART_NUM¶
UART peripheral to use for console output (0-1)
Found in: Component config > ESP System Settings
This UART peripheral is used for console output from the ESP-IDF Bootloader and the app.
If the configuration is different in the Bootloader binary compared to the app binary, UART is reconfigured after the bootloader exits and the app starts.
Due to an ESP32 ROM bug, UART2 is not supported for console output via esp_rom_printf.
- Available options:
UART0 (ESP_CONSOLE_UART_CUSTOM_NUM_0)
UART1 (ESP_CONSOLE_UART_CUSTOM_NUM_1)
CONFIG_ESP_CONSOLE_UART_TX_GPIO¶
UART TX on GPIO#
Found in: Component config > ESP System Settings
This GPIO is used for console UART TX output in the ESP-IDF Bootloader and the app (including boot log output and default standard output and standard error of the app).
If the configuration is different in the Bootloader binary compared to the app binary, UART is reconfigured after the bootloader exits and the app starts.
- Range:
from 0 to 46 if ESP_CONSOLE_UART_CUSTOM
- Default value:
21 if ESP_CONSOLE_UART_CUSTOM
43 if ESP_CONSOLE_UART_CUSTOM
CONFIG_ESP_CONSOLE_UART_RX_GPIO¶
UART RX on GPIO#
Found in: Component config > ESP System Settings
This GPIO is used for UART RX input in the ESP-IDF Bootloader and the app (including default default standard input of the app).
Note: The default ESP-IDF Bootloader configures this pin but doesn’t read anything from the UART.
If the configuration is different in the Bootloader binary compared to the app binary, UART is reconfigured after the bootloader exits and the app starts.
- Range:
from 0 to 46 if ESP_CONSOLE_UART_CUSTOM
- Default value:
20 if ESP_CONSOLE_UART_CUSTOM
44 if ESP_CONSOLE_UART_CUSTOM
CONFIG_ESP_CONSOLE_UART_BAUDRATE¶
UART console baud rate
Found in: Component config > ESP System Settings
This baud rate is used by both the ESP-IDF Bootloader and the app (including boot log output and default standard input/output/error of the app).
The app’s maximum baud rate depends on the UART clock source. If Power Management is disabled, the UART clock source is the APB clock and all baud rates in the available range will be sufficiently accurate. If Power Management is enabled, REF_TICK clock source is used so the baud rate is divided from 1MHz. Baud rates above 1Mbps are not possible and values between 500Kbps and 1Mbps may not be accurate.
If the configuration is different in the Bootloader binary compared to the app binary, UART is reconfigured after the bootloader exits and the app starts.
- Range:
from 1200 to 4000000 if CONFIG_PM_ENABLE
from 1200 to 1000000 if CONFIG_PM_ENABLE
- Default value:
115200
CONFIG_ESP_INT_WDT¶
Interrupt watchdog
Found in: Component config > ESP System Settings
This watchdog timer can detect if the FreeRTOS tick interrupt has not been called for a certain time, either because a task turned off interrupts and did not turn them on for a long time, or because an interrupt handler did not return. It will try to invoke the panic handler first and failing that reset the SoC.
- Default value:
Yes (enabled)
CONFIG_ESP_INT_WDT_TIMEOUT_MS¶
Interrupt watchdog timeout (ms)
Found in: Component config > ESP System Settings > CONFIG_ESP_INT_WDT
The timeout of the watchdog, in miliseconds. Make this higher than the FreeRTOS tick rate.
- Range:
from 10 to 10000
- Default value:
300 if ESP32_SPIRAM_SUPPORT && CONFIG_ESP_INT_WDT
800 if ESP32_SPIRAM_SUPPORT && CONFIG_ESP_INT_WDT
CONFIG_ESP_INT_WDT_CHECK_CPU1¶
Also watch CPU1 tick interrupt
Found in: Component config > ESP System Settings > CONFIG_ESP_INT_WDT
Also detect if interrupts on CPU 1 are disabled for too long.
- Default value:
Yes (enabled)
CONFIG_ESP_TASK_WDT¶
Initialize Task Watchdog Timer on startup
Found in: Component config > ESP System Settings
The Task Watchdog Timer can be used to make sure individual tasks are still running. Enabling this option will cause the Task Watchdog Timer to be initialized automatically at startup. The Task Watchdog timer can be initialized after startup as well (see Task Watchdog Timer API Reference)
- Default value:
Yes (enabled)
CONFIG_ESP_TASK_WDT_PANIC¶
Invoke panic handler on Task Watchdog timeout
Found in: Component config > ESP System Settings > CONFIG_ESP_TASK_WDT
If this option is enabled, the Task Watchdog Timer will be configured to trigger the panic handler when it times out. This can also be configured at run time (see Task Watchdog Timer API Reference)
- Default value:
No (disabled)
CONFIG_ESP_TASK_WDT_TIMEOUT_S¶
Task Watchdog timeout period (seconds)
Found in: Component config > ESP System Settings > CONFIG_ESP_TASK_WDT
Timeout period configuration for the Task Watchdog Timer in seconds. This is also configurable at run time (see Task Watchdog Timer API Reference)
- Range:
from 1 to 60
- Default value:
5
CONFIG_ESP_TASK_WDT_CHECK_IDLE_TASK_CPU0¶
Watch CPU0 Idle Task
Found in: Component config > ESP System Settings > CONFIG_ESP_TASK_WDT
If this option is enabled, the Task Watchdog Timer will watch the CPU0 Idle Task. Having the Task Watchdog watch the Idle Task allows for detection of CPU starvation as the Idle Task not being called is usually a symptom of CPU starvation. Starvation of the Idle Task is detrimental as FreeRTOS household tasks depend on the Idle Task getting some runtime every now and then.
- Default value:
Yes (enabled)
CONFIG_ESP_TASK_WDT_CHECK_IDLE_TASK_CPU1¶
Watch CPU1 Idle Task
Found in: Component config > ESP System Settings > CONFIG_ESP_TASK_WDT
If this option is enabled, the Task Wtachdog Timer will wach the CPU1 Idle Task.
- Default value:
Yes (enabled)
CONFIG_ESP_XT_WDT¶
Initialize XTAL32K watchdog timer on startup
Found in: Component config > ESP System Settings
This watchdog timer can detect oscillation failure of the XTAL32K_CLK. When such a failure is detected the hardware can be set up to automatically switch to BACKUP32K_CLK and generate an interrupt.
CONFIG_ESP_XT_WDT_TIMEOUT¶
XTAL32K watchdog timeout period
Found in: Component config > ESP System Settings > CONFIG_ESP_XT_WDT
Timeout period configuration for the XTAL32K watchdog timer based on RTC_CLK.
- Range:
from 1 to 255 if CONFIG_ESP_XT_WDT
- Default value:
200 if CONFIG_ESP_XT_WDT
CONFIG_ESP_XT_WDT_BACKUP_CLK_ENABLE¶
Automatically switch to BACKUP32K_CLK when timer expires
Found in: Component config > ESP System Settings > CONFIG_ESP_XT_WDT
Enable this to automatically switch to BACKUP32K_CLK as the source of RTC_SLOW_CLK when the watchdog timer expires.
- Default value:
Yes (enabled) if CONFIG_ESP_XT_WDT
CONFIG_ESP_PANIC_HANDLER_IRAM¶
Place panic handler code in IRAM
Found in: Component config > ESP System Settings
If this option is disabled (default), the panic handler code is placed in flash not IRAM. This means that if ESP-IDF crashes while flash cache is disabled, the panic handler will automatically re-enable flash cache before running GDB Stub or Core Dump. This adds some minor risk, if the flash cache status is also corrupted during the crash.
If this option is enabled, the panic handler code (including required UART functions) is placed in IRAM. This may be necessary to debug some complex issues with crashes while flash cache is disabled (for example, when writing to SPI flash) or when flash cache is corrupted when an exception is triggered.
- Default value:
No (disabled)
CONFIG_ESP_DEBUG_STUBS_ENABLE¶
OpenOCD debug stubs
Found in: Component config > ESP System Settings
Debug stubs are used by OpenOCD to execute pre-compiled onboard code which does some useful debugging stuff, e.g. GCOV data dump.
- Default value:
“COMPILER_OPTIMIZATION_LEVEL_DEBUG” if ESP32_TRAX && ESP32S2_TRAX && ESP32S3_TRAX
CONFIG_ESP_SYSTEM_CHECK_INT_LEVEL¶
Interrupt level to use for Interrupt Watchdog and other system checks
Found in: Component config > ESP System Settings
Interrupt level to use for Interrupt Watchdog and other system checks.
- Available options:
Level 5 interrupt (ESP_SYSTEM_CHECK_INT_LEVEL_5)
Using level 5 interrupt for Interrupt Watchdog and other system checks.
Level 4 interrupt (ESP_SYSTEM_CHECK_INT_LEVEL_4)
Using level 4 interrupt for Interrupt Watchdog and other system checks.
High resolution timer (esp_timer)¶
Contains:
CONFIG_ESP_TIMER_PROFILING¶
Enable esp_timer profiling features
Found in: Component config > High resolution timer (esp_timer)
If enabled, esp_timer_dump will dump information such as number of times the timer was started, number of times the timer has triggered, and the total time it took for the callback to run. This option has some effect on timer performance and the amount of memory used for timer storage, and should only be used for debugging/testing purposes.
- Default value:
No (disabled)
CONFIG_ESP_TIMER_TASK_STACK_SIZE¶
High-resolution timer task stack size
Found in: Component config > High resolution timer (esp_timer)
Configure the stack size of “timer_task” task. This task is used to dispatch callbacks of timers created using ets_timer and esp_timer APIs. If you are seing stack overflow errors in timer task, increase this value.
Note that this is not the same as FreeRTOS timer task. To configure FreeRTOS timer task size, see “FreeRTOS timer task stack size” option in “FreeRTOS” menu.
- Range:
from 2048 to 65536
- Default value:
3584
CONFIG_ESP_TIMER_INTERRUPT_LEVEL¶
Interrupt level
Found in: Component config > High resolution timer (esp_timer)
It sets the interrupt level for esp_timer ISR in range 1..3. A higher level (3) helps to decrease the ISR esp_timer latency.
- Range:
from 1 to 1
- Default value:
1
CONFIG_ESP_TIMER_SUPPORTS_ISR_DISPATCH_METHOD¶
Support ISR dispatch method
Found in: Component config > High resolution timer (esp_timer)
Allows using ESP_TIMER_ISR dispatch method (ESP_TIMER_TASK dispatch method is also avalible). - ESP_TIMER_TASK - Timer callbacks are dispatched from a high-priority esp_timer task. - ESP_TIMER_ISR - Timer callbacks are dispatched directly from the timer interrupt handler. The ISR dispatch can be used, in some cases, when a callback is very simple or need a lower-latency.
- Default value:
No (disabled)
CONFIG_ESP_TIMER_IMPL¶
Hardware timer to use for esp_timer
Found in: Component config > High resolution timer (esp_timer)
esp_timer APIs can be implemented using different hardware timers.
“FRC2 (legacy)” implementation has been used in ESP-IDF v2.x - v4.1.
“LAC timer of Timer Group 0” implementation is simpler, and has smaller run time overhead because software handling of timer overflow is not needed.
“SYSTIMER” implementation is similar to “LAC timer of Timer Group 0” but for non ESP32 chips.
- Available options:
FRC2 (legacy) timer (ESP_TIMER_IMPL_FRC2)
LAC timer of Timer Group 0 (ESP_TIMER_IMPL_TG0_LAC)
SYSTIMER (ESP_TIMER_IMPL_SYSTIMER)
Wi-Fi¶
Contains:
CONFIG_ESP32_WIFI_SW_COEXIST_ENABLE¶
Software controls WiFi/Bluetooth coexistence
Found in: Component config > Wi-Fi
If enabled, WiFi & Bluetooth coexistence is controlled by software rather than hardware. Recommended for heavy traffic scenarios. Both coexistence configuration options are automatically managed, no user intervention is required. If only Bluetooth is used, it is recommended to disable this option to reduce binary file size.
- Default value:
Yes (enabled) if CONFIG_BT_ENABLED
CONFIG_ESP32_WIFI_STATIC_RX_BUFFER_NUM¶
Max number of WiFi static RX buffers
Found in: Component config > Wi-Fi
Set the number of WiFi static RX buffers. Each buffer takes approximately 1.6KB of RAM. The static rx buffers are allocated when esp_wifi_init is called, they are not freed until esp_wifi_deinit is called.
WiFi hardware use these buffers to receive all 802.11 frames. A higher number may allow higher throughput but increases memory use. If ESP32_WIFI_AMPDU_RX_ENABLED is enabled, this value is recommended to set equal or bigger than ESP32_WIFI_RX_BA_WIN in order to achieve better throughput and compatibility with both stations and APs.
- Range:
from 2 to 25
- Default value:
10 if SPIRAM_TRY_ALLOCATE_WIFI_LWIP
16 if SPIRAM_TRY_ALLOCATE_WIFI_LWIP
CONFIG_ESP32_WIFI_DYNAMIC_RX_BUFFER_NUM¶
Max number of WiFi dynamic RX buffers
Found in: Component config > Wi-Fi
Set the number of WiFi dynamic RX buffers, 0 means unlimited RX buffers will be allocated (provided sufficient free RAM). The size of each dynamic RX buffer depends on the size of the received data frame.
For each received data frame, the WiFi driver makes a copy to an RX buffer and then delivers it to the high layer TCP/IP stack. The dynamic RX buffer is freed after the higher layer has successfully received the data frame.
For some applications, WiFi data frames may be received faster than the application can process them. In these cases we may run out of memory if RX buffer number is unlimited (0).
If a dynamic RX buffer limit is set, it should be at least the number of static RX buffers.
- Range:
from 0 to 128 if CONFIG_LWIP_WND_SCALE
from 0 to 1024 if CONFIG_LWIP_WND_SCALE
- Default value:
32
CONFIG_ESP32_WIFI_TX_BUFFER¶
Type of WiFi TX buffers
Found in: Component config > Wi-Fi
Select type of WiFi TX buffers:
If “Static” is selected, WiFi TX buffers are allocated when WiFi is initialized and released when WiFi is de-initialized. The size of each static TX buffer is fixed to about 1.6KB.
If “Dynamic” is selected, each WiFi TX buffer is allocated as needed when a data frame is delivered to the Wifi driver from the TCP/IP stack. The buffer is freed after the data frame has been sent by the WiFi driver. The size of each dynamic TX buffer depends on the length of each data frame sent by the TCP/IP layer.
If PSRAM is enabled, “Static” should be selected to guarantee enough WiFi TX buffers. If PSRAM is disabled, “Dynamic” should be selected to improve the utilization of RAM.
- Available options:
Static (ESP32_WIFI_STATIC_TX_BUFFER)
Dynamic (ESP32_WIFI_DYNAMIC_TX_BUFFER)
CONFIG_ESP32_WIFI_STATIC_TX_BUFFER_NUM¶
Max number of WiFi static TX buffers
Found in: Component config > Wi-Fi
Set the number of WiFi static TX buffers. Each buffer takes approximately 1.6KB of RAM. The static RX buffers are allocated when esp_wifi_init() is called, they are not released until esp_wifi_deinit() is called.
For each transmitted data frame from the higher layer TCP/IP stack, the WiFi driver makes a copy of it in a TX buffer. For some applications especially UDP applications, the upper layer can deliver frames faster than WiFi layer can transmit. In these cases, we may run out of TX buffers.
- Range:
from 1 to 64 if ESP32_WIFI_STATIC_TX_BUFFER
- Default value:
16 if ESP32_WIFI_STATIC_TX_BUFFER
CONFIG_ESP32_WIFI_CACHE_TX_BUFFER_NUM¶
Max number of WiFi cache TX buffers
Found in: Component config > Wi-Fi
Set the number of WiFi cache TX buffer number.
For each TX packet from uplayer, such as LWIP etc, WiFi driver needs to allocate a static TX buffer and makes a copy of uplayer packet. If WiFi driver fails to allocate the static TX buffer, it caches the uplayer packets to a dedicated buffer queue, this option is used to configure the size of the cached TX queue.
- Range:
from 16 to 128 if ESP32_SPIRAM_SUPPORT || ESP32S2_SPIRAM_SUPPORT || ESP32S3_SPIRAM_SUPPORT
- Default value:
32 if ESP32_SPIRAM_SUPPORT || ESP32S2_SPIRAM_SUPPORT || ESP32S3_SPIRAM_SUPPORT
CONFIG_ESP32_WIFI_DYNAMIC_TX_BUFFER_NUM¶
Max number of WiFi dynamic TX buffers
Found in: Component config > Wi-Fi
Set the number of WiFi dynamic TX buffers. The size of each dynamic TX buffer is not fixed, it depends on the size of each transmitted data frame.
For each transmitted frame from the higher layer TCP/IP stack, the WiFi driver makes a copy of it in a TX buffer. For some applications, especially UDP applications, the upper layer can deliver frames faster than WiFi layer can transmit. In these cases, we may run out of TX buffers.
- Range:
from 1 to 128
- Default value:
32
CONFIG_ESP32_WIFI_CSI_ENABLED¶
WiFi CSI(Channel State Information)
Found in: Component config > Wi-Fi
Select this option to enable CSI(Channel State Information) feature. CSI takes about CONFIG_ESP32_WIFI_STATIC_RX_BUFFER_NUM KB of RAM. If CSI is not used, it is better to disable this feature in order to save memory.
- Default value:
No (disabled)
CONFIG_ESP32_WIFI_AMPDU_TX_ENABLED¶
WiFi AMPDU TX
Found in: Component config > Wi-Fi
Select this option to enable AMPDU TX feature
- Default value:
Yes (enabled)
CONFIG_ESP32_WIFI_TX_BA_WIN¶
WiFi AMPDU TX BA window size
Found in: Component config > Wi-Fi > CONFIG_ESP32_WIFI_AMPDU_TX_ENABLED
Set the size of WiFi Block Ack TX window. Generally a bigger value means higher throughput but more memory. Most of time we should NOT change the default value unless special reason, e.g. test the maximum UDP TX throughput with iperf etc. For iperf test in shieldbox, the recommended value is 9~12.
- Range:
from 2 to 32
- Default value:
6
CONFIG_ESP32_WIFI_AMPDU_RX_ENABLED¶
WiFi AMPDU RX
Found in: Component config > Wi-Fi
Select this option to enable AMPDU RX feature
- Default value:
Yes (enabled)
CONFIG_ESP32_WIFI_RX_BA_WIN¶
WiFi AMPDU RX BA window size
Found in: Component config > Wi-Fi > CONFIG_ESP32_WIFI_AMPDU_RX_ENABLED
Set the size of WiFi Block Ack RX window. Generally a bigger value means higher throughput and better compatibility but more memory. Most of time we should NOT change the default value unless special reason, e.g. test the maximum UDP RX throughput with iperf etc. For iperf test in shieldbox, the recommended value is 9~12. If PSRAM is used and WiFi memory is prefered to allocat in PSRAM first, the default and minimum value should be 16 to achieve better throughput and compatibility with both stations and APs.
- Range:
from 2 to 32
- Default value:
6 if SPIRAM_TRY_ALLOCATE_WIFI_LWIP && CONFIG_ESP32_WIFI_AMPDU_RX_ENABLED
16 if SPIRAM_TRY_ALLOCATE_WIFI_LWIP && CONFIG_ESP32_WIFI_AMPDU_RX_ENABLED
CONFIG_ESP32_WIFI_AMSDU_TX_ENABLED¶
WiFi AMSDU TX
Found in: Component config > Wi-Fi
Select this option to enable AMSDU TX feature
- Default value:
No (disabled) if ESP32_SPIRAM_SUPPORT || ESP32S2_SPIRAM_SUPPORT || ESP32S3_SPIRAM_SUPPORT
CONFIG_ESP32_WIFI_NVS_ENABLED¶
WiFi NVS flash
Found in: Component config > Wi-Fi
Select this option to enable WiFi NVS flash
- Default value:
Yes (enabled)
CONFIG_ESP32_WIFI_TASK_CORE_ID¶
WiFi Task Core ID
Found in: Component config > Wi-Fi
Pinned WiFi task to core 0 or core 1.
- Available options:
Core 0 (ESP32_WIFI_TASK_PINNED_TO_CORE_0)
Core 1 (ESP32_WIFI_TASK_PINNED_TO_CORE_1)
CONFIG_ESP32_WIFI_SOFTAP_BEACON_MAX_LEN¶
Max length of WiFi SoftAP Beacon
Found in: Component config > Wi-Fi
ESP-MESH utilizes beacon frames to detect and resolve root node conflicts (see documentation). However the default length of a beacon frame can simultaneously hold only five root node identifier structures, meaning that a root node conflict of up to five nodes can be detected at one time. In the occurence of more root nodes conflict involving more than five root nodes, the conflict resolution process will detect five of the root nodes, resolve the conflict, and re-detect more root nodes. This process will repeat until all root node conflicts are resolved. However this process can generally take a very long time.
To counter this situation, the beacon frame length can be increased such that more root nodes can be detected simultaneously. Each additional root node will require 36 bytes and should be added ontop of the default beacon frame length of 752 bytes. For example, if you want to detect 10 root nodes simultaneously, you need to set the beacon frame length as 932 (752+36*5).
Setting a longer beacon length also assists with debugging as the conflicting root nodes can be identified more quickly.
- Range:
from 752 to 1256
- Default value:
752
CONFIG_ESP32_WIFI_MGMT_SBUF_NUM¶
WiFi mgmt short buffer number
Found in: Component config > Wi-Fi
Set the number of WiFi management short buffer.
- Range:
from 6 to 32
- Default value:
32
CONFIG_ESP32_WIFI_IRAM_OPT¶
WiFi IRAM speed optimization
Found in: Component config > Wi-Fi
Select this option to place frequently called Wi-Fi library functions in IRAM. When this option is disabled, more than 10Kbytes of IRAM memory will be saved but Wi-Fi throughput will be reduced.
- Default value:
No (disabled) if CONFIG_BT_ENABLED && ESP32_SPIRAM_SUPPORT
Yes (enabled)
CONFIG_ESP32_WIFI_RX_IRAM_OPT¶
WiFi RX IRAM speed optimization
Found in: Component config > Wi-Fi
Select this option to place frequently called Wi-Fi library RX functions in IRAM. When this option is disabled, more than 17Kbytes of IRAM memory will be saved but Wi-Fi performance will be reduced.
- Default value:
No (disabled) if CONFIG_BT_ENABLED && ESP32_SPIRAM_SUPPORT
Yes (enabled)
CONFIG_ESP32_WIFI_ENABLE_WPA3_SAE¶
Enable WPA3-Personal
Found in: Component config > Wi-Fi
Select this option to allow the device to establish a WPA3-Personal connection with eligible AP’s. PMF (Protected Management Frames) is a prerequisite feature for a WPA3 connection, it needs to be explicitly configured before attempting connection. Please refer to the Wi-Fi Driver API Guide for details.
- Default value:
Yes (enabled)
CONFIG_ESP_WIFI_SLP_IRAM_OPT¶
WiFi SLP IRAM speed optimization
Found in: Component config > Wi-Fi
Select this option to place called Wi-Fi library TBTT process and receive beacon functions in IRAM. Some functions can be put in IRAM either by ESP32_WIFI_IRAM_OPT and ESP32_WIFI_RX_IRAM_OPT, or this one. If already enabled ESP32_WIFI_IRAM_OPT, the other 7.3KB IRAM memory would be taken by this option. If already enabled ESP32_WIFI_RX_IRAM_OPT, the other 1.3KB IRAM memory would be taken by this option. If neither of them are enabled, the other 7.4KB IRAM memory would be taken by this option. Wi-Fi power-save mode average current would be reduced if this option is enabled.
CONFIG_ESP_WIFI_SLP_DEFAULT_MIN_ACTIVE_TIME¶
Minimum active time
Found in: Component config > Wi-Fi > CONFIG_ESP_WIFI_SLP_IRAM_OPT
The minimum timeout for waiting to receive data, unit: milliseconds.
- Range:
from 8 to 60 if CONFIG_ESP_WIFI_SLP_IRAM_OPT
- Default value:
CONFIG_ESP_WIFI_SLP_DEFAULT_MAX_ACTIVE_TIME¶
Maximum keep alive time
Found in: Component config > Wi-Fi > CONFIG_ESP_WIFI_SLP_IRAM_OPT
The maximum time that wifi keep alive, unit: seconds.
- Range:
from 10 to 60 if CONFIG_ESP_WIFI_SLP_IRAM_OPT
- Default value:
CONFIG_ESP_WIFI_FTM_ENABLE¶
WiFi FTM
Found in: Component config > Wi-Fi
Enable feature Fine Timing Measurement for calculating WiFi Round-Trip-Time (RTT).
- Default value:
No (disabled)
CONFIG_ESP_WIFI_FTM_INITIATOR_SUPPORT¶
FTM Initiator support
Found in: Component config > Wi-Fi > CONFIG_ESP_WIFI_FTM_ENABLE
- Default value:
Yes (enabled) if CONFIG_ESP_WIFI_FTM_ENABLE
CONFIG_ESP_WIFI_FTM_RESPONDER_SUPPORT¶
FTM Responder support
Found in: Component config > Wi-Fi > CONFIG_ESP_WIFI_FTM_ENABLE
- Default value:
Yes (enabled) if CONFIG_ESP_WIFI_FTM_ENABLE
CONFIG_ESP_WIFI_STA_DISCONNECTED_PM_ENABLE¶
Power Management for station at disconnected
Found in: Component config > Wi-Fi
Select this option to enable power_management for station when disconnected. Chip will do modem-sleep when rf module is not in use any more.
CONFIG_ESP_WIFI_EXTERNAL_COEXIST_ENABLE¶
WiFi External Coexistence
Found in: Component config > Wi-Fi
If enabled, HW External coexistence arbitration is managed by GPIO pins. It can support three types of wired combinations so far which are 1-wired/2-wired/3-wired. User can select GPIO pins in application code with configure interfaces.
This function depends on BT-off because currently we don’t support external coex and internal coex simultaneously.
- Default value:
No (disabled) if CONFIG_BT_ENABLED
CONFIG_ESP_WIFI_GCMP_SUPPORT¶
WiFi GCMP Support(GCMP128 and GCMP256)
Found in: Component config > Wi-Fi
Select this option to enable GCMP support. GCMP support is compulsory for WiFi Suite-B support.
- Default value:
No (disabled)
CONFIG_ESP_WIFI_GMAC_SUPPORT¶
WiFi GMAC Support(GMAC128 and GMAC256)
Found in: Component config > Wi-Fi
Select this option to enable GMAC support. GMAC support is compulsory for WiFi 192 bit certification.
- Default value:
No (disabled)
CONFIG_ESP_WIFI_SOFTAP_SUPPORT¶
WiFi SoftAP Support
Found in: Component config > Wi-Fi
WiFi module can be compiled without SoftAP to save code size.
- Default value:
Yes (enabled)
Core dump¶
Contains:
CONFIG_ESP_COREDUMP_TO_FLASH_OR_UART¶
Data destination
Found in: Component config > Core dump
Select place to store core dump: flash, uart or none (to disable core dumps generation).
Core dumps to Flash are not available if PSRAM is used for task stacks.
If core dump is configured to be stored in flash and custom partition table is used add corresponding entry to your CSV. For examples, please see predefined partition table CSV descriptions in the components/partition_table directory.
- Available options:
Flash (ESP_COREDUMP_ENABLE_TO_FLASH)
UART (ESP_COREDUMP_ENABLE_TO_UART)
None (ESP_COREDUMP_ENABLE_TO_NONE)
CONFIG_ESP_COREDUMP_DATA_FORMAT¶
Core dump data format
Found in: Component config > Core dump
Select the data format for core dump.
- Available options:
Binary format (ESP_COREDUMP_DATA_FORMAT_BIN)
ELF format (ESP_COREDUMP_DATA_FORMAT_ELF)
CONFIG_ESP_COREDUMP_CHECKSUM¶
Core dump data integrity check
Found in: Component config > Core dump
Select the integrity check for the core dump.
- Available options:
Use CRC32 for integrity verification (ESP_COREDUMP_CHECKSUM_CRC32)
Use SHA256 for integrity verification (ESP_COREDUMP_CHECKSUM_SHA256)
CONFIG_ESP_COREDUMP_CHECK_BOOT¶
Check core dump data integrity on boot
Found in: Component config > Core dump
When enabled, if any data are found on the flash core dump partition, they will be checked by calculating their checksum.
- Default value:
Yes (enabled) if ESP_COREDUMP_ENABLE_TO_FLASH
CONFIG_ESP_COREDUMP_MAX_TASKS_NUM¶
Maximum number of tasks
Found in: Component config > Core dump
Maximum number of tasks snapshots in core dump.
CONFIG_ESP_COREDUMP_UART_DELAY¶
Delay before print to UART
Found in: Component config > Core dump
Config delay (in ms) before printing core dump to UART. Delay can be interrupted by pressing Enter key.
- Default value:
0 if ESP_COREDUMP_ENABLE_TO_UART
CONFIG_ESP_COREDUMP_STACK_SIZE¶
Reserved stack size
Found in: Component config > Core dump
Size of the memory to be reserved for core dump stack. If 0 core dump process will run on the stack of crashed task/ISR, otherwise special stack will be allocated. To ensure that core dump itself will not overflow task/ISR stack set this to the value above 800. NOTE: It eats DRAM.
CONFIG_ESP_COREDUMP_SUMMARY_STACKDUMP_SIZE¶
Size of the stack dump buffer
Found in: Component config > Core dump
Size of the buffer that would be reserved for extracting backtrace info summary. This buffer will contain the stack dump of the crashed task. This dump is useful in generating backtrace
- Range:
from 512 to 4096 if ESP_COREDUMP_DATA_FORMAT_ELF && ESP_COREDUMP_ENABLE_TO_FLASH
- Default value:
1024 if ESP_COREDUMP_DATA_FORMAT_ELF && ESP_COREDUMP_ENABLE_TO_FLASH
CONFIG_ESP_COREDUMP_DECODE¶
Handling of UART core dumps in IDF Monitor
Found in: Component config > Core dump
- Available options:
Decode and show summary (info_corefile) (ESP_COREDUMP_DECODE_INFO)
Don’t decode (ESP_COREDUMP_DECODE_DISABLE)
FAT Filesystem support¶
Contains:
CONFIG_FATFS_CHOOSE_CODEPAGE¶
OEM Code Page
Found in: Component config > FAT Filesystem support
OEM code page used for file name encodings.
If “Dynamic” is selected, code page can be chosen at runtime using f_setcp function. Note that choosing this option will increase application size by ~480kB.
- Available options:
Dynamic (all code pages supported) (FATFS_CODEPAGE_DYNAMIC)
US (CP437) (FATFS_CODEPAGE_437)
Arabic (CP720) (FATFS_CODEPAGE_720)
Greek (CP737) (FATFS_CODEPAGE_737)
KBL (CP771) (FATFS_CODEPAGE_771)
Baltic (CP775) (FATFS_CODEPAGE_775)
Latin 1 (CP850) (FATFS_CODEPAGE_850)
Latin 2 (CP852) (FATFS_CODEPAGE_852)
Cyrillic (CP855) (FATFS_CODEPAGE_855)
Turkish (CP857) (FATFS_CODEPAGE_857)
Portugese (CP860) (FATFS_CODEPAGE_860)
Icelandic (CP861) (FATFS_CODEPAGE_861)
Hebrew (CP862) (FATFS_CODEPAGE_862)
Canadian French (CP863) (FATFS_CODEPAGE_863)
Arabic (CP864) (FATFS_CODEPAGE_864)
Nordic (CP865) (FATFS_CODEPAGE_865)
Russian (CP866) (FATFS_CODEPAGE_866)
Greek 2 (CP869) (FATFS_CODEPAGE_869)
Japanese (DBCS) (CP932) (FATFS_CODEPAGE_932)
Simplified Chinese (DBCS) (CP936) (FATFS_CODEPAGE_936)
Korean (DBCS) (CP949) (FATFS_CODEPAGE_949)
Traditional Chinese (DBCS) (CP950) (FATFS_CODEPAGE_950)
CONFIG_FATFS_LONG_FILENAMES¶
Long filename support
Found in: Component config > FAT Filesystem support
Support long filenames in FAT. Long filename data increases memory usage. FATFS can be configured to store the buffer for long filename data in stack or heap.
- Available options:
No long filenames (FATFS_LFN_NONE)
Long filename buffer in heap (FATFS_LFN_HEAP)
Long filename buffer on stack (FATFS_LFN_STACK)
CONFIG_FATFS_MAX_LFN¶
Max long filename length
Found in: Component config > FAT Filesystem support
Maximum long filename length. Can be reduced to save RAM.
- Range:
from 12 to 255
- Default value:
255
CONFIG_FATFS_API_ENCODING¶
API character encoding
Found in: Component config > FAT Filesystem support
Choose encoding for character and string arguments/returns when using FATFS APIs. The encoding of arguments will usually depend on text editor settings.
- Available options:
API uses ANSI/OEM encoding (FATFS_API_ENCODING_ANSI_OEM)
API uses UTF-16 encoding (FATFS_API_ENCODING_UTF_16)
API uses UTF-8 encoding (FATFS_API_ENCODING_UTF_8)
CONFIG_FATFS_FS_LOCK¶
Number of simultaneously open files protected by lock function
Found in: Component config > FAT Filesystem support
This option sets the FATFS configuration value _FS_LOCK. The option _FS_LOCK switches file lock function to control duplicated file open and illegal operation to open objects.
* 0: Disable file lock function. To avoid volume corruption, application should avoid illegal open, remove and rename to the open objects.
* >0: Enable file lock function. The value defines how many files/sub-directories can be opened simultaneously under file lock control.
Note that the file lock control is independent of re-entrancy.
- Range:
from 0 to 65535
- Default value:
0
CONFIG_FATFS_TIMEOUT_MS¶
Timeout for acquiring a file lock, ms
Found in: Component config > FAT Filesystem support
This option sets FATFS configuration value _FS_TIMEOUT, scaled to milliseconds. Sets the number of milliseconds FATFS will wait to acquire a mutex when operating on an open file. For example, if one task is performing a lenghty operation, another task will wait for the first task to release the lock, and time out after amount of time set by this option.
- Default value:
10000
CONFIG_FATFS_PER_FILE_CACHE¶
Use separate cache for each file
Found in: Component config > FAT Filesystem support
This option affects FATFS configuration value _FS_TINY.
If this option is set, _FS_TINY is 0, and each open file has its own cache, size of the cache is equal to the _MAX_SS variable (512 or 4096 bytes). This option uses more RAM if more than 1 file is open, but needs less reads and writes to the storage for some operations.
If this option is not set, _FS_TINY is 1, and single cache is used for all open files, size is also equal to _MAX_SS variable. This reduces the amount of heap used when multiple files are open, but increases the number of read and write operations which FATFS needs to make.
- Default value:
Yes (enabled)
CONFIG_FATFS_ALLOC_PREFER_EXTRAM¶
Perfer external RAM when allocating FATFS buffers
Found in: Component config > FAT Filesystem support
When the option is enabled, internal buffers used by FATFS will be allocated from external RAM. If the allocation from external RAM fails, the buffer will be allocated from the internal RAM. Disable this option if optimizing for performance. Enable this option if optimizing for internal memory size.
- Default value:
Yes (enabled) if SPIRAM_USE_CAPS_ALLOC || SPIRAM_USE_MALLOC
CONFIG_FATFS_USE_FASTSEEK¶
Enable fast seek algorithm when using lseek function through VFS FAT
Found in: Component config > FAT Filesystem support
The fast seek feature enables fast backward/long seek operations without FAT access by using an in-memory CLMT (cluster link map table). Please note, fast-seek is only allowed for read-mode files, if a file is opened in write-mode, the seek mechanism will automatically fallback to the default implementation.
- Default value:
No (disabled)
CONFIG_FATFS_FAST_SEEK_BUFFER_SIZE¶
Fast seek CLMT buffer size
Found in: Component config > FAT Filesystem support > CONFIG_FATFS_USE_FASTSEEK
If fast seek algorithm is enabled, this defines the size of CLMT buffer used by this algorithm in 32-bit word units. This value should be chosen based on prior knowledge of maximum elements of each file entry would store.
- Default value:
Modbus configuration¶
Contains:
CONFIG_FMB_COMM_MODE_TCP_EN¶
Enable Modbus stack support for TCP communication mode
Found in: Component config > Modbus configuration
Enable Modbus TCP option for stack.
- Default value:
Yes (enabled)
CONFIG_FMB_TCP_PORT_DEFAULT¶
Modbus TCP port number
Found in: Component config > Modbus configuration > CONFIG_FMB_COMM_MODE_TCP_EN
Modbus default port number used by Modbus TCP stack
- Range:
from 0 to 65535
- Default value:
502
CONFIG_FMB_TCP_PORT_MAX_CONN¶
Maximum allowed connections for TCP stack
Found in: Component config > Modbus configuration > CONFIG_FMB_COMM_MODE_TCP_EN
Maximum allowed connections number for Modbus TCP stack. This is used by Modbus master and slave port layer to establish connections. This parameter may decrease performance of Modbus stack and can cause increasing of processing time (increase only if absolutely necessary).
- Range:
from 1 to 6
- Default value:
5
CONFIG_FMB_TCP_CONNECTION_TOUT_SEC¶
Modbus TCP connection timeout
Found in: Component config > Modbus configuration > CONFIG_FMB_COMM_MODE_TCP_EN
Modbus TCP connection timeout in seconds. Once expired the current connection with the client will be closed and Modbus slave will be waiting for new connection to accept.
- Range:
from 1 to 3600
- Default value:
20
CONFIG_FMB_COMM_MODE_RTU_EN¶
Enable Modbus stack support for RTU mode
Found in: Component config > Modbus configuration
Enable RTU Modbus communication mode option for Modbus serial stack.
- Default value:
Yes (enabled)
CONFIG_FMB_COMM_MODE_ASCII_EN¶
Enable Modbus stack support for ASCII mode
Found in: Component config > Modbus configuration
Enable ASCII Modbus communication mode option for Modbus serial stack.
- Default value:
Yes (enabled)
CONFIG_FMB_MASTER_TIMEOUT_MS_RESPOND¶
Slave respond timeout (Milliseconds)
Found in: Component config > Modbus configuration
If master sends a frame which is not broadcast, it has to wait sometime for slave response. if slave is not respond in this time, the master will process timeout error.
- Range:
from 50 to 3000
- Default value:
150
CONFIG_FMB_MASTER_DELAY_MS_CONVERT¶
Slave conversion delay (Milliseconds)
Found in: Component config > Modbus configuration
If master sends a broadcast frame, it has to wait conversion time to delay, then master can send next frame.
- Range:
from 50 to 400
- Default value:
200
CONFIG_FMB_QUEUE_LENGTH¶
Modbus serial task queue length
Found in: Component config > Modbus configuration
Modbus serial driver queue length. It is used by event queue task. See the serial driver API for more information.
- Range:
from 0 to 200
- Default value:
20
CONFIG_FMB_PORT_TASK_STACK_SIZE¶
Modbus port task stack size
Found in: Component config > Modbus configuration
Modbus port task stack size for rx/tx event processing. It may be adjusted when debugging is enabled (for example).
- Range:
from 2048 to 8192
- Default value:
4096
CONFIG_FMB_SERIAL_BUF_SIZE¶
Modbus serial task RX/TX buffer size
Found in: Component config > Modbus configuration
Modbus serial task RX and TX buffer size for UART driver initialization. This buffer is used for modbus frame transfer. The Modbus protocol maximum frame size is 256 bytes. Bigger size can be used for non standard implementations.
- Range:
from 0 to 2048
- Default value:
256
CONFIG_FMB_SERIAL_ASCII_BITS_PER_SYMB¶
Number of data bits per ASCII character
Found in: Component config > Modbus configuration
This option defines the number of data bits per ASCII character.
- Range:
from 7 to 8
- Default value:
8
CONFIG_FMB_SERIAL_ASCII_TIMEOUT_RESPOND_MS¶
Response timeout for ASCII communication mode (ms)
Found in: Component config > Modbus configuration
This option defines response timeout of slave in milliseconds for ASCII communication mode. Thus the timeout will expire and allow the master program to handle the error.
- Range:
from 300 to 2000
- Default value:
1000
CONFIG_FMB_PORT_TASK_PRIO¶
Modbus port task priority
Found in: Component config > Modbus configuration
Modbus port data processing task priority. The priority of Modbus controller task is equal to (CONFIG_FMB_PORT_TASK_PRIO - 1).
- Range:
from 3 to 23
- Default value:
10
CONFIG_FMB_PORT_TASK_AFFINITY¶
Modbus task affinity
Found in: Component config > Modbus configuration
Allows setting the core affinity of the Modbus controller task, i.e. whether the task is pinned to particular CPU, or allowed to run on any CPU.
- Available options:
No affinity (FMB_PORT_TASK_AFFINITY_NO_AFFINITY)
CPU0 (FMB_PORT_TASK_AFFINITY_CPU0)
CPU1 (FMB_PORT_TASK_AFFINITY_CPU1)
CONFIG_FMB_CONTROLLER_SLAVE_ID_SUPPORT¶
Modbus controller slave ID support
Found in: Component config > Modbus configuration
Modbus slave ID support enable. When enabled the Modbus <Report Slave ID> command is supported by stack.
- Default value:
Yes (enabled)
CONFIG_FMB_CONTROLLER_SLAVE_ID¶
Modbus controller slave ID
Found in: Component config > Modbus configuration > CONFIG_FMB_CONTROLLER_SLAVE_ID_SUPPORT
Modbus slave ID value to identify modbus device in the network using <Report Slave ID> command. Most significant byte of ID is used as short device ID and other three bytes used as long ID.
- Range:
from 0 to 4294967295
- Default value:
“0x00112233”
CONFIG_FMB_CONTROLLER_NOTIFY_TIMEOUT¶
Modbus controller notification timeout (ms)
Found in: Component config > Modbus configuration
Modbus controller notification timeout in milliseconds. This timeout is used to send notification about accessed parameters.
- Range:
from 0 to 200
- Default value:
20
CONFIG_FMB_CONTROLLER_NOTIFY_QUEUE_SIZE¶
Modbus controller notification queue size
Found in: Component config > Modbus configuration
Modbus controller notification queue size. The notification queue is used to get information about accessed parameters.
- Range:
from 0 to 200
- Default value:
20
CONFIG_FMB_CONTROLLER_STACK_SIZE¶
Modbus controller stack size
Found in: Component config > Modbus configuration
Modbus controller task stack size. The Stack size may be adjusted when debug mode is used which requires more stack size (for example).
- Range:
from 0 to 8192
- Default value:
4096
CONFIG_FMB_EVENT_QUEUE_TIMEOUT¶
Modbus stack event queue timeout (ms)
Found in: Component config > Modbus configuration
Modbus stack event queue timeout in milliseconds. This may help to optimize Modbus stack event processing time.
- Range:
from 0 to 500
- Default value:
20
CONFIG_FMB_TIMER_PORT_ENABLED¶
Modbus stack use timer for 3.5T symbol time measurement
Found in: Component config > Modbus configuration
If this option is set the Modbus stack uses timer for T3.5 time measurement. Else the internal UART TOUT timeout is used for 3.5T symbol time measurement.
- Default value:
No (disabled)
CONFIG_FMB_TIMER_GROUP¶
Slave Timer group number
Found in: Component config > Modbus configuration
Modbus slave Timer group number that is used for timeout measurement.
- Range:
from 0 to 1
- Default value:
0
CONFIG_FMB_TIMER_INDEX¶
Slave Timer index in the group
Found in: Component config > Modbus configuration
Modbus slave Timer Index in the group that is used for timeout measurement.
- Range:
from 0 to 1
- Default value:
0
CONFIG_FMB_MASTER_TIMER_GROUP¶
Master Timer group number
Found in: Component config > Modbus configuration
Modbus master Timer group number that is used for timeout measurement.
- Range:
from 0 to 1
- Default value:
0
CONFIG_FMB_MASTER_TIMER_INDEX¶
Master Timer index
Found in: Component config > Modbus configuration
Modbus master Timer Index in the group that is used for timeout measurement. Note: Modbus master and slave should have different timer index to be able to work simultaneously.
- Range:
from 0 to 1
- Default value:
0
CONFIG_FMB_TIMER_ISR_IN_IRAM¶
Place timer interrupt handler into IRAM
Found in: Component config > Modbus configuration
This option places Modbus timer IRQ handler into IRAM. This allows to avoid delays related to processing of non-IRAM-safe interrupts during a flash write operation (NVS updating a value, or some other flash API which has to perform an read/write operation and disable CPU cache). This option has dependency with the UART_ISR_IN_IRAM option which places UART interrupt handler into IRAM to prevent delays related to processing of UART events.
- Default value:
No (disabled)
FreeRTOS¶
Contains:
CONFIG_FREERTOS_UNICORE¶
Run FreeRTOS only on first core
Found in: Component config > FreeRTOS
This version of FreeRTOS normally takes control of all cores of the CPU. Select this if you only want to start it on the first core. This is needed when e.g. another process needs complete control over the second core.
# This invisible config value sets the value of tskNO_AFFINITY in task.h. # Intended to be used as a constant from other Kconfig files. # Value is (32-bit) INT_MAX.
CONFIG_FREERTOS_CORETIMER¶
Xtensa timer to use as the FreeRTOS tick source
Found in: Component config > FreeRTOS
FreeRTOS needs a timer with an associated interrupt to use as the main tick source to increase counters, run timers and do pre-emptive multitasking with. There are multiple timers available to do this, with different interrupt priorities. Check
- Available options:
Timer 0 (int 6, level 1) (FREERTOS_CORETIMER_0)
Select this to use timer 0
Timer 1 (int 15, level 3) (FREERTOS_CORETIMER_1)
Select this to use timer 1
SYSTIMER 0 (level 1) (FREERTOS_CORETIMER_SYSTIMER_LVL1)
Select this to use systimer with the 1 interrupt priority.
SYSTIMER 0 (level 3) (FREERTOS_CORETIMER_SYSTIMER_LVL3)
Select this to use systimer with the 3 interrupt priority.
CONFIG_FREERTOS_OPTIMIZED_SCHEDULER¶
Enable FreeRTOS pĺatform optimized scheduler
Found in: Component config > FreeRTOS
On most platforms there are instructions can speedup the ready task searching. Enabling this option the FreeRTOS with this instructions support will be built.
- Default value:
Yes (enabled)
CONFIG_FREERTOS_HZ¶
Tick rate (Hz)
Found in: Component config > FreeRTOS
Select the tick rate at which FreeRTOS does pre-emptive context switching.
- Range:
from 1 to 1000
- Default value:
100
CONFIG_FREERTOS_ASSERT_ON_UNTESTED_FUNCTION¶
Halt when an SMP-untested function is called
Found in: Component config > FreeRTOS
Some functions in FreeRTOS have not been thoroughly tested yet when moving to the SMP implementation of FreeRTOS. When this option is enabled, these fuctions will throw an assert().
- Default value:
Yes (enabled)
CONFIG_FREERTOS_CHECK_STACKOVERFLOW¶
Check for stack overflow
Found in: Component config > FreeRTOS
FreeRTOS can check for stack overflows in threads and trigger an user function called vApplicationStackOverflowHook when this happens.
- Available options:
No checking (FREERTOS_CHECK_STACKOVERFLOW_NONE)
Do not check for stack overflows (configCHECK_FOR_STACK_OVERFLOW=0)
Check by stack pointer value (FREERTOS_CHECK_STACKOVERFLOW_PTRVAL)
Check for stack overflows on each context switch by checking if the stack pointer is in a valid range. Quick but does not detect stack overflows that happened between context switches (configCHECK_FOR_STACK_OVERFLOW=1)
Check using canary bytes (FREERTOS_CHECK_STACKOVERFLOW_CANARY)
Places some magic bytes at the end of the stack area and on each context switch, check if these bytes are still intact. More thorough than just checking the pointer, but also slightly slower. (configCHECK_FOR_STACK_OVERFLOW=2)
CONFIG_FREERTOS_WATCHPOINT_END_OF_STACK¶
Set a debug watchpoint as a stack overflow check
Found in: Component config > FreeRTOS
FreeRTOS can check if a stack has overflown its bounds by checking either the value of the stack pointer or by checking the integrity of canary bytes. (See FREERTOS_CHECK_STACKOVERFLOW for more information.) These checks only happen on a context switch, and the situation that caused the stack overflow may already be long gone by then. This option will use the last debug memory watchpoint to allow breaking into the debugger (or panic’ing) as soon as any of the last 32 bytes on the stack of a task are overwritten. The side effect is that using gdb, you effectively have one hardware watchpoint less because the last one is overwritten as soon as a task switch happens.
Another consequence is that due to alignment requirements of the watchpoint, the usable stack size decreases by up to 60 bytes. This is because the watchpoint region has to be aligned to its size and the size for the stack watchpoint in IDF is 32 bytes.
This check only triggers if the stack overflow writes within 32 bytes near the end of the stack, rather than overshooting further, so it is worth combining this approach with one of the other stack overflow check methods.
When this watchpoint is hit, gdb will stop with a SIGTRAP message. When no JTAG OCD is attached, esp-idf will panic on an unhandled debug exception.
- Default value:
No (disabled)
CONFIG_FREERTOS_INTERRUPT_BACKTRACE¶
Enable backtrace from interrupt to task context
Found in: Component config > FreeRTOS
If this option is enabled, interrupt stack frame will be modified to point to the code of the interrupted task as its return address. This helps the debugger (or the panic handler) show a backtrace from the interrupt to the task which was interrupted. This also works for nested interrupts: higer level interrupt stack can be traced back to the lower level interrupt. This option adds 4 instructions to the interrupt dispatching code.
- Default value:
Yes (enabled)
CONFIG_FREERTOS_THREAD_LOCAL_STORAGE_POINTERS¶
Number of thread local storage pointers
Found in: Component config > FreeRTOS
FreeRTOS has the ability to store per-thread pointers in the task control block. This controls the number of pointers available.
This value must be at least 1. Index 0 is reserved for use by the pthreads API thread-local-storage. Other indexes can be used for any desired purpose.
- Range:
from 1 to 256
- Default value:
1
CONFIG_FREERTOS_ASSERT¶
FreeRTOS assertions
Found in: Component config > FreeRTOS
Failed FreeRTOS configASSERT() assertions can be configured to behave in different ways.
By default these behave the same as the global project assert settings.
- Available options:
abort() on failed assertions (FREERTOS_ASSERT_FAIL_ABORT)
If a FreeRTOS configASSERT() fails, FreeRTOS will abort() and halt execution. The panic handler can be configured to handle the outcome of an abort() in different ways.
If assertions are disabled for the entire project, they are also disabled in FreeRTOS and this option is unavailable.
Print and continue failed assertions (FREERTOS_ASSERT_FAIL_PRINT_CONTINUE)
If a FreeRTOS assertion fails, print it out and continue.
Disable FreeRTOS assertions (FREERTOS_ASSERT_DISABLE)
FreeRTOS configASSERT() will not be compiled into the binary.
CONFIG_FREERTOS_IDLE_TASK_STACKSIZE¶
Idle Task stack size
Found in: Component config > FreeRTOS
The idle task has its own stack, sized in bytes. The default size is enough for most uses. Size can be reduced to 768 bytes if no (or simple) FreeRTOS idle hooks are used and pthread local storage or FreeRTOS local storage cleanup callbacks are not used.
The stack size may need to be increased above the default if the app installs idle or thread local storage cleanup hooks that use a lot of stack memory.
- Range:
from 768 to 32768
- Default value:
1536
CONFIG_FREERTOS_ISR_STACKSIZE¶
ISR stack size
Found in: Component config > FreeRTOS
The interrupt handlers have their own stack. The size of the stack can be defined here. Each processor has its own stack, so the total size occupied will be twice this.
- Range:
from 2096 to 32768 if ESP_COREDUMP_DATA_FORMAT_ELF
from 1536 to 32768
- Default value:
2096 if ESP_COREDUMP_DATA_FORMAT_ELF
1536
CONFIG_FREERTOS_LEGACY_HOOKS¶
Use FreeRTOS legacy hooks
Found in: Component config > FreeRTOS
FreeRTOS offers a number of hooks/callback functions that are called when a timer tick happens, the idle thread runs etc. esp-idf replaces these by runtime registerable hooks using the esp_register_freertos_xxx_hook system, but for legacy reasons the old hooks can also still be enabled. Please enable this only if you have code that for some reason can’t be migrated to the esp_register_freertos_xxx_hook system.
- Default value:
No (disabled)
CONFIG_FREERTOS_MAX_TASK_NAME_LEN¶
Maximum task name length
Found in: Component config > FreeRTOS
Changes the maximum task name length. Each task allocated will include this many bytes for a task name. Using a shorter value saves a small amount of RAM, a longer value allows more complex names.
For most uses, the default of 16 is OK.
- Range:
from 1 to 256
- Default value:
16
CONFIG_FREERTOS_ENABLE_STATIC_TASK_CLEAN_UP¶
Enable static task clean up hook
Found in: Component config > FreeRTOS
Enable this option to make FreeRTOS call the static task clean up hook when a task is deleted.
Bear in mind that if this option is enabled you will need to implement the following function:
void vPortCleanUpTCB ( void \*pxTCB ) { // place clean up code here }
- Default value:
No (disabled)
CONFIG_FREERTOS_TIMER_TASK_PRIORITY¶
FreeRTOS timer task priority
Found in: Component config > FreeRTOS
The timer service task (primarily) makes use of existing FreeRTOS features, allowing timer functionality to be added to an application with minimal impact on the size of the application’s executable binary.
Use this constant to define the priority that the timer task will run at.
- Range:
from 1 to 25
- Default value:
1
CONFIG_FREERTOS_TIMER_TASK_STACK_DEPTH¶
FreeRTOS timer task stack size
Found in: Component config > FreeRTOS
The timer service task (primarily) makes use of existing FreeRTOS features, allowing timer functionality to be added to an application with minimal impact on the size of the application’s executable binary.
Use this constant to define the size (in bytes) of the stack allocated for the timer task.
- Range:
from 1536 to 32768
- Default value:
2048
CONFIG_FREERTOS_TIMER_QUEUE_LENGTH¶
FreeRTOS timer queue length
Found in: Component config > FreeRTOS
FreeRTOS provides a set of timer related API functions. Many of these functions use a standard FreeRTOS queue to send commands to the timer service task. The queue used for this purpose is called the ‘timer command queue’. The ‘timer command queue’ is private to the FreeRTOS timer implementation, and cannot be accessed directly.
For most uses the default value of 10 is OK.
- Range:
from 5 to 20
- Default value:
10
CONFIG_FREERTOS_QUEUE_REGISTRY_SIZE¶
FreeRTOS queue registry size
Found in: Component config > FreeRTOS
FreeRTOS uses the queue registry as a means for kernel aware debuggers to locate queues, semaphores, and mutexes. The registry allows for a textual name to be associated with a queue for easy identification within a debugging GUI. A value of 0 will disable queue registry functionality, and a value larger than 0 will specify the number of queues/semaphores/mutexes that the registry can hold.
- Range:
from 0 to 20
- Default value:
0
CONFIG_FREERTOS_USE_TRACE_FACILITY¶
Enable FreeRTOS trace facility
Found in: Component config > FreeRTOS
If enabled, configUSE_TRACE_FACILITY will be defined as 1 in FreeRTOS. This will allow the usage of trace facility functions such as uxTaskGetSystemState().
- Default value:
No (disabled)
CONFIG_FREERTOS_USE_STATS_FORMATTING_FUNCTIONS¶
Enable FreeRTOS stats formatting functions
Found in: Component config > FreeRTOS > CONFIG_FREERTOS_USE_TRACE_FACILITY
If enabled, configUSE_STATS_FORMATTING_FUNCTIONS will be defined as 1 in FreeRTOS. This will allow the usage of stats formatting functions such as vTaskList().
- Default value:
No (disabled) if CONFIG_FREERTOS_USE_TRACE_FACILITY
CONFIG_FREERTOS_VTASKLIST_INCLUDE_COREID¶
Enable display of xCoreID in vTaskList
Found in: Component config > FreeRTOS > CONFIG_FREERTOS_USE_TRACE_FACILITY > CONFIG_FREERTOS_USE_STATS_FORMATTING_FUNCTIONS
If enabled, this will include an extra column when vTaskList is called to display the CoreID the task is pinned to (0,1) or -1 if not pinned.
- Default value:
No (disabled) if CONFIG_FREERTOS_USE_STATS_FORMATTING_FUNCTIONS
CONFIG_FREERTOS_GENERATE_RUN_TIME_STATS¶
Enable FreeRTOS to collect run time stats
Found in: Component config > FreeRTOS
If enabled, configGENERATE_RUN_TIME_STATS will be defined as 1 in FreeRTOS. This will allow FreeRTOS to collect information regarding the usage of processor time amongst FreeRTOS tasks. Run time stats are generated using either the ESP Timer or the CPU Clock as the clock source (Note that run time stats are only valid until the clock source overflows). The function vTaskGetRunTimeStats() will also be available if FREERTOS_USE_STATS_FORMATTING_FUNCTIONS and FREERTOS_USE_TRACE_FACILITY are enabled. vTaskGetRunTimeStats() will display the run time of each task as a % of the total run time of all CPUs (task run time / no of CPUs) / (total run time / 100 )
- Default value:
No (disabled)
CONFIG_FREERTOS_RUN_TIME_STATS_CLK¶
Choose the clock source for run time stats
Found in: Component config > FreeRTOS > CONFIG_FREERTOS_GENERATE_RUN_TIME_STATS
Choose the clock source for FreeRTOS run time stats. Options are CPU0’s CPU Clock or the ESP Timer. Both clock sources are 32 bits. The CPU Clock can run at a higher frequency hence provide a finer resolution but will overflow much quicker. Note that run time stats are only valid until the clock source overflows.
- Available options:
Use ESP TIMER for run time stats (FREERTOS_RUN_TIME_STATS_USING_ESP_TIMER)
ESP Timer will be used as the clock source for FreeRTOS run time stats. The ESP Timer runs at a frequency of 1MHz regardless of Dynamic Frequency Scaling. Therefore the ESP Timer will overflow in approximately 4290 seconds.
Use CPU Clock for run time stats (FREERTOS_RUN_TIME_STATS_USING_CPU_CLK)
CPU Clock will be used as the clock source for the generation of run time stats. The CPU Clock has a frequency dependent on ESP32_DEFAULT_CPU_FREQ_MHZ and Dynamic Frequency Scaling (DFS). Therefore the CPU Clock frequency can fluctuate between 80 to 240MHz. Run time stats generated using the CPU Clock represents the number of CPU cycles each task is allocated and DOES NOT reflect the amount of time each task runs for (as CPU clock frequency can change). If the CPU clock consistently runs at the maximum frequency of 240MHz, it will overflow in approximately 17 seconds.
CONFIG_FREERTOS_USE_TICKLESS_IDLE¶
Tickless idle support
Found in: Component config > FreeRTOS
If power management support is enabled, FreeRTOS will be able to put the system into light sleep mode when no tasks need to run for a number of ticks. This number can be set using FREERTOS_IDLE_TIME_BEFORE_SLEEP option. This feature is also known as “automatic light sleep”.
Note that timers created using esp_timer APIs may prevent the system from entering sleep mode, even when no tasks need to run. To skip unnecessary wake-up initialize a timer with the “skip_unhandled_events” option as true.
If disabled, automatic light sleep support will be disabled.
- Default value:
No (disabled) if CONFIG_PM_ENABLE
CONFIG_FREERTOS_IDLE_TIME_BEFORE_SLEEP¶
Minimum number of ticks to enter sleep mode for
Found in: Component config > FreeRTOS > CONFIG_FREERTOS_USE_TICKLESS_IDLE
FreeRTOS will enter light sleep mode if no tasks need to run for this number of ticks.
- Range:
from 2 to 4294967295 if CONFIG_FREERTOS_USE_TICKLESS_IDLE
- Default value:
CONFIG_FREERTOS_TASK_FUNCTION_WRAPPER¶
Enclose all task functions in a wrapper function
Found in: Component config > FreeRTOS
If enabled, all FreeRTOS task functions will be enclosed in a wrapper function. If a task function mistakenly returns (i.e. does not delete), the call flow will return to the wrapper function. The wrapper function will then log an error and abort the application. This option is also required for GDB backtraces and C++ exceptions to work correctly inside top-level task functions.
- Default value:
Yes (enabled)
CONFIG_FREERTOS_CHECK_MUTEX_GIVEN_BY_OWNER¶
Check that mutex semaphore is given by owner task
Found in: Component config > FreeRTOS
If enabled, assert that when a mutex semaphore is given, the task giving the semaphore is the task which is currently holding the mutex.
- Default value:
Yes (enabled)
CONFIG_FREERTOS_CHECK_PORT_CRITICAL_COMPLIANCE¶
Tests compliance with Vanilla FreeRTOS port*_CRITICAL calls
Found in: Component config > FreeRTOS
If enabled, context of port*_CRITICAL calls (ISR or Non-ISR) would be checked to be in compliance with Vanilla FreeRTOS. e.g Calling port*_CRITICAL from ISR context would cause assert failure
- Default value:
No (disabled)
CONFIG_FREERTOS_PLACE_FUNCTIONS_INTO_FLASH¶
Place FreeRTOS functions into Flash
Found in: Component config > FreeRTOS
When enabled the selected Non-ISR FreeRTOS functions will be placed into Flash memory instead of IRAM. This saves up to 8KB of IRAM depending on which functions are used.
- Default value:
No (disabled)
CONFIG_FREERTOS_ENABLE_TASK_SNAPSHOT¶
Enable task snapshot functions
Found in: Component config > FreeRTOS
When enabled, the functions related to snapshots, such as vTaskGetSnapshot or uxTaskGetSnapshotAll, are compiled and linked.
- Default value:
Yes (enabled)
CONFIG_FREERTOS_PLACE_SNAPSHOT_FUNS_INTO_FLASH¶
Place task snapshot functions into flash
Found in: Component config > FreeRTOS > CONFIG_FREERTOS_ENABLE_TASK_SNAPSHOT
When enabled, the functions related to snapshots, such as vTaskGetSnapshot or uxTaskGetSnapshotAll, will be placed in flash. Note that if enabled, these functions cannot be called when cache is disabled.
- Default value:
No (disabled) if CONFIG_FREERTOS_ENABLE_TASK_SNAPSHOT && CONFIG_ESP_PANIC_HANDLER_IRAM
Hardware Abstraction Layer (HAL) and Low Level (LL)¶
Contains:
CONFIG_HAL_DEFAULT_ASSERTION_LEVEL¶
Default HAL assertion level
Found in: Component config > Hardware Abstraction Layer (HAL) and Low Level (LL)
Set the assert behavior / level for HAL component. HAL component assert level can be set separately, but the level can’t exceed the system assertion level. e.g. If the system assertion is disabled, then the HAL assertion can’t be enabled either. If the system assertion is enable, then the HAL assertion can still be disabled by this Kconfig option.
- Available options:
Same as system assertion level (HAL_ASSERTION_EQUALS_SYSTEM)
Disabled (HAL_ASSERTION_DISABLE)
Silent (HAL_ASSERTION_SILIENT)
Enabled (HAL_ASSERTION_ENABLE)
Heap memory debugging¶
Contains:
CONFIG_HEAP_CORRUPTION_DETECTION¶
Heap corruption detection
Found in: Component config > Heap memory debugging
Enable heap poisoning features to detect heap corruption caused by out-of-bounds access to heap memory.
See the “Heap Memory Debugging” page of the IDF documentation for a description of each level of heap corruption detection.
- Available options:
Basic (no poisoning) (HEAP_POISONING_DISABLED)
Light impact (HEAP_POISONING_LIGHT)
Comprehensive (HEAP_POISONING_COMPREHENSIVE)
CONFIG_HEAP_TRACING_DEST¶
Heap tracing
Found in: Component config > Heap memory debugging
Enables the heap tracing API defined in esp_heap_trace.h.
This function causes a moderate increase in IRAM code side and a minor increase in heap function (malloc/free/realloc) CPU overhead, even when the tracing feature is not used. So it’s best to keep it disabled unless tracing is being used.
- Available options:
Disabled (HEAP_TRACING_OFF)
Standalone (HEAP_TRACING_STANDALONE)
Host-based (HEAP_TRACING_TOHOST)
CONFIG_HEAP_TRACING_STACK_DEPTH¶
Heap tracing stack depth
Found in: Component config > Heap memory debugging
Number of stack frames to save when tracing heap operation callers.
More stack frames uses more memory in the heap trace buffer (and slows down allocation), but can provide useful information.
CONFIG_HEAP_TASK_TRACKING¶
Enable heap task tracking
Found in: Component config > Heap memory debugging
Enables tracking the task responsible for each heap allocation.
This function depends on heap poisoning being enabled and adds four more bytes of overhead for each block allocated.
CONFIG_HEAP_ABORT_WHEN_ALLOCATION_FAILS¶
Abort if memory allocation fails
Found in: Component config > Heap memory debugging
When enabled, if a memory allocation operation fails it will cause a system abort.
- Default value:
No (disabled)
jsmn¶
Contains:
CONFIG_JSMN_PARENT_LINKS¶
Enable parent links
Found in: Component config > jsmn
You can access to parent node of parsed json
- Default value:
No (disabled)
CONFIG_JSMN_STRICT¶
Enable strict mode
Found in: Component config > jsmn
In strict mode primitives are: numbers and booleans
- Default value:
No (disabled)
libsodium¶
Contains:
CONFIG_LIBSODIUM_USE_MBEDTLS_SHA¶
Use mbedTLS SHA256 & SHA512 implementations
Found in: Component config > libsodium
If this option is enabled, libsodium will use thin wrappers around mbedTLS for SHA256 & SHA512 operations.
This saves some code size if mbedTLS is also used. However it is incompatible with hardware SHA acceleration (due to the way libsodium’s API manages SHA state).
- Default value:
Yes (enabled)
Log output¶
Contains:
CONFIG_LOG_DEFAULT_LEVEL¶
Default log verbosity
Found in: Component config > Log output
Specify how much output to see in logs by default. You can set lower verbosity level at runtime using esp_log_level_set function.
By default, this setting limits which log statements are compiled into the program. For example, selecting “Warning” would mean that changing log level to “Debug” at runtime will not be possible. To allow increasing log level above the default at runtime, see the next option.
- Available options:
No output (LOG_DEFAULT_LEVEL_NONE)
Error (LOG_DEFAULT_LEVEL_ERROR)
Warning (LOG_DEFAULT_LEVEL_WARN)
Info (LOG_DEFAULT_LEVEL_INFO)
Debug (LOG_DEFAULT_LEVEL_DEBUG)
Verbose (LOG_DEFAULT_LEVEL_VERBOSE)
CONFIG_LOG_MAXIMUM_LEVEL¶
Maximum log verbosity
Found in: Component config > Log output
This config option sets the highest log verbosity that it’s possible to select at runtime by calling esp_log_level_set(). This level may be higher than the default verbosity level which is set when the app starts up.
This can be used enable debugging output only at a critical point, for a particular tag, or to minimize startup time but then enable more logs once the firmware has loaded.
Note that increasing the maximum available log level will increase the firmware binary size.
This option only applies to logging from the app, the bootloader log level is fixed at compile time to the separate “Bootloader log verbosity” setting.
- Available options:
Same as default (LOG_MAXIMUM_EQUALS_DEFAULT)
Error (LOG_MAXIMUM_LEVEL_ERROR)
Warning (LOG_MAXIMUM_LEVEL_WARN)
Info (LOG_MAXIMUM_LEVEL_INFO)
Debug (LOG_MAXIMUM_LEVEL_DEBUG)
Verbose (LOG_MAXIMUM_LEVEL_VERBOSE)
CONFIG_LOG_COLORS¶
Use ANSI terminal colors in log output
Found in: Component config > Log output
Enable ANSI terminal color codes in bootloader output.
In order to view these, your terminal program must support ANSI color codes.
- Default value:
Yes (enabled)
CONFIG_LOG_TIMESTAMP_SOURCE¶
Log Timestamps
Found in: Component config > Log output
Choose what sort of timestamp is displayed in the log output:
Milliseconds since boot is calulated from the RTOS tick count multiplied by the tick period. This time will reset after a software reboot. e.g. (90000)
System time is taken from POSIX time functions which use the ESP32’s RTC and FRC1 timers to maintain an accurate time. The system time is initialized to 0 on startup, it can be set with an SNTP sync, or with POSIX time functions. This time will not reset after a software reboot. e.g. (00:01:30.000)
NOTE: Currently this will not get used in logging from binary blobs (i.e WiFi & Bluetooth libraries), these will always print milliseconds since boot.
- Available options:
Milliseconds Since Boot (LOG_TIMESTAMP_SOURCE_RTOS)
System Time (LOG_TIMESTAMP_SOURCE_SYSTEM)
LWIP¶
Contains:
CONFIG_LWIP_LOCAL_HOSTNAME¶
Local netif hostname
Found in: Component config > LWIP
The default name this device will report to other devices on the network. Could be updated at runtime with esp_netif_set_hostname()
- Default value:
“espressif”
CONFIG_LWIP_NETIF_API¶
Enable usage of standard POSIX APIs in LWIP
Found in: Component config > LWIP
If this feature is enabled, standard POSIX APIs: if_indextoname(), if_nametoindex() could be used to convert network interface index to name instead of IDF specific esp-netif APIs (such as esp_netif_get_netif_impl_name())
- Default value:
No (disabled)
CONFIG_LWIP_TCPIP_CORE_LOCKING¶
Enable tcpip core locking
Found in: Component config > LWIP
If Enable tcpip core locking,Creates a global mutex that is held during TCPIP thread operations.Can be locked by client code to perform lwIP operations without changing into TCPIP thread using callbacks. See LOCK_TCPIP_CORE() and UNLOCK_TCPIP_CORE().
If disable tcpip core locking,TCP IP will perform tasks through context switching.
- Default value:
No (disabled)
CONFIG_LWIP_DNS_SUPPORT_MDNS_QUERIES¶
Enable mDNS queries in resolving host name
Found in: Component config > LWIP
If this feature is enabled, standard API such as gethostbyname support .local addresses by sending one shot multicast mDNS query
- Default value:
Yes (enabled)
CONFIG_LWIP_L2_TO_L3_COPY¶
Enable copy between Layer2 and Layer3 packets
Found in: Component config > LWIP
If this feature is enabled, all traffic from layer2(WIFI Driver) will be copied to a new buffer before sending it to layer3(LWIP stack), freeing the layer2 buffer. Please be notified that the total layer2 receiving buffer is fixed and ESP32 currently supports 25 layer2 receiving buffer, when layer2 buffer runs out of memory, then the incoming packets will be dropped in hardware. The layer3 buffer is allocated from the heap, so the total layer3 receiving buffer depends on the available heap size, when heap runs out of memory, no copy will be sent to layer3 and packet will be dropped in layer2. Please make sure you fully understand the impact of this feature before enabling it.
- Default value:
No (disabled)
CONFIG_LWIP_IRAM_OPTIMIZATION¶
Enable LWIP IRAM optimization
Found in: Component config > LWIP
If this feature is enabled, some functions relating to RX/TX in LWIP will be put into IRAM, it can improve UDP/TCP throughput by >10% for single core mode, it doesn’t help too much for dual core mode. On the other hand, it needs about 10KB IRAM for these optimizations.
If this feature is disabled, all lwip functions will be put into FLASH.
- Default value:
No (disabled)
CONFIG_LWIP_TIMERS_ONDEMAND¶
Enable LWIP Timers on demand
Found in: Component config > LWIP
If this feature is enabled, IGMP and MLD6 timers will be activated only when joining groups or receiving QUERY packets.
This feature will reduce the power consumption for applications which do not use IGMP and MLD6.
- Default value:
Yes (enabled)
CONFIG_LWIP_MAX_SOCKETS¶
Max number of open sockets
Found in: Component config > LWIP
Sockets take up a certain amount of memory, and allowing fewer sockets to be open at the same time conserves memory. Specify the maximum amount of sockets here. The valid value is from 1 to 16.
- Range:
from 1 to 16
- Default value:
10
CONFIG_LWIP_USE_ONLY_LWIP_SELECT¶
Support LWIP socket select() only (DEPRECATED)
Found in: Component config > LWIP
This option is deprecated. Use VFS_SUPPORT_SELECT instead, which is the inverse of this option.
The virtual filesystem layer of select() redirects sockets to lwip_select() and non-socket file descriptors to their respective driver implementations. If this option is enabled then all calls of select() will be redirected to lwip_select(), therefore, select can be used for sockets only.
- Default value:
No (disabled)
CONFIG_LWIP_SO_LINGER¶
Enable SO_LINGER processing
Found in: Component config > LWIP
Enabling this option allows SO_LINGER processing. l_onoff = 1,l_linger can set the timeout.
If l_linger=0, When a connection is closed, TCP will terminate the connection. This means that TCP will discard any data packets stored in the socket send buffer and send an RST to the peer.
If l_linger!=0,Then closesocket() calls to block the process until the remaining data packets has been sent or timed out.
- Default value:
No (disabled)
CONFIG_LWIP_SO_REUSE¶
Enable SO_REUSEADDR option
Found in: Component config > LWIP
Enabling this option allows binding to a port which remains in TIME_WAIT.
- Default value:
Yes (enabled)
CONFIG_LWIP_SO_REUSE_RXTOALL¶
SO_REUSEADDR copies broadcast/multicast to all matches
Found in: Component config > LWIP > CONFIG_LWIP_SO_REUSE
Enabling this option means that any incoming broadcast or multicast packet will be copied to all of the local sockets that it matches (may be more than one if SO_REUSEADDR is set on the socket.)
This increases memory overhead as the packets need to be copied, however they are only copied per matching socket. You can safely disable it if you don’t plan to receive broadcast or multicast traffic on more than one socket at a time.
- Default value:
Yes (enabled)
CONFIG_LWIP_SO_RCVBUF¶
Enable SO_RCVBUF option
Found in: Component config > LWIP
Enabling this option allows checking for available data on a netconn.
- Default value:
No (disabled)
CONFIG_LWIP_NETBUF_RECVINFO¶
Enable IP_PKTINFO option
Found in: Component config > LWIP
Enabling this option allows checking for the destination address of a received IPv4 Packet.
- Default value:
No (disabled)
CONFIG_LWIP_IP4_FRAG¶
Enable fragment outgoing IP4 packets
Found in: Component config > LWIP
Enabling this option allows fragmenting outgoing IP4 packets if their size exceeds MTU.
- Default value:
Yes (enabled)
CONFIG_LWIP_IP6_FRAG¶
Enable fragment outgoing IP6 packets
Found in: Component config > LWIP
Enabling this option allows fragmenting outgoing IP6 packets if their size exceeds MTU.
- Default value:
Yes (enabled)
CONFIG_LWIP_IP4_REASSEMBLY¶
Enable reassembly incoming fragmented IP4 packets
Found in: Component config > LWIP
Enabling this option allows reassemblying incoming fragmented IP4 packets.
- Default value:
No (disabled)
CONFIG_LWIP_IP6_REASSEMBLY¶
Enable reassembly incoming fragmented IP6 packets
Found in: Component config > LWIP
Enabling this option allows reassemblying incoming fragmented IP6 packets.
- Default value:
No (disabled)
CONFIG_LWIP_IP_FORWARD¶
Enable IP forwarding
Found in: Component config > LWIP
Enabling this option allows packets forwarding across multiple interfaces.
- Default value:
No (disabled)
CONFIG_LWIP_IPV4_NAPT¶
Enable NAT (new/experimental)
Found in: Component config > LWIP > CONFIG_LWIP_IP_FORWARD
Enabling this option allows Network Address and Port Translation.
- Default value:
No (disabled) if CONFIG_LWIP_IP_FORWARD
CONFIG_LWIP_STATS¶
Enable LWIP statistics
Found in: Component config > LWIP
Enabling this option allows LWIP statistics
- Default value:
No (disabled)
CONFIG_LWIP_ETHARP_TRUST_IP_MAC¶
Enable LWIP ARP trust
Found in: Component config > LWIP
Enabling this option allows ARP table to be updated.
If this option is enabled, the incoming IP packets cause the ARP table to be updated with the source MAC and IP addresses supplied in the packet. You may want to disable this if you do not trust LAN peers to have the correct addresses, or as a limited approach to attempt to handle spoofing. If disabled, lwIP will need to make a new ARP request if the peer is not already in the ARP table, adding a little latency. The peer *is* in the ARP table if it requested our address before. Also notice that this slows down input processing of every IP packet!
There are two known issues in real application if this feature is enabled: - The LAN peer may have bug to update the ARP table after the ARP entry is aged out. If the ARP entry on the LAN peer is aged out but failed to be updated, all IP packets sent from LWIP to the LAN peer will be dropped by LAN peer. - The LAN peer may not be trustful, the LAN peer may send IP packets to LWIP with two different MACs, but the same IP address. If this happens, the LWIP has problem to receive IP packets from LAN peer.
So the recommendation is to disable this option. Here the LAN peer means the other side to which the ESP station or soft-AP is connected.
- Default value:
No (disabled)
CONFIG_LWIP_ESP_GRATUITOUS_ARP¶
Send gratuitous ARP periodically
Found in: Component config > LWIP
Enable this option allows to send gratuitous ARP periodically.
This option solve the compatibility issues.If the ARP table of the AP is old, and the AP doesn’t send ARP request to update it’s ARP table, this will lead to the STA sending IP packet fail. Thus we send gratuitous ARP periodically to let AP update it’s ARP table.
- Default value:
Yes (enabled)
CONFIG_LWIP_GARP_TMR_INTERVAL¶
GARP timer interval(seconds)
Found in: Component config > LWIP > CONFIG_LWIP_ESP_GRATUITOUS_ARP
Set the timer interval for gratuitous ARP. The default value is 60s
- Default value:
60
CONFIG_LWIP_TCPIP_RECVMBOX_SIZE¶
TCPIP task receive mail box size
Found in: Component config > LWIP
Set TCPIP task receive mail box size. Generally bigger value means higher throughput but more memory. The value should be bigger than UDP/TCP mail box size.
- Range:
from 6 to 64 if CONFIG_LWIP_WND_SCALE
from 6 to 1024 if CONFIG_LWIP_WND_SCALE
- Default value:
32
CONFIG_LWIP_DHCP_DOES_ARP_CHECK¶
DHCP: Perform ARP check on any offered address
Found in: Component config > LWIP
Enabling this option performs a check (via ARP request) if the offered IP address is not already in use by another host on the network.
- Default value:
Yes (enabled)
CONFIG_LWIP_DHCP_DISABLE_CLIENT_ID¶
DHCP: Disable Use of HW address as client identification
Found in: Component config > LWIP
This option could be used to disable DHCP client identification with its MAC address. (Client id is used by DHCP servers to uniquely identify clients and are included in the DHCP packets as an option 61) Set this option to “y” in order to exclude option 61 from DHCP packets.
- Default value:
No (disabled)
CONFIG_LWIP_DHCP_DISABLE_VENDOR_CLASS_ID¶
DHCP: Disable Use of vendor class identification
Found in: Component config > LWIP
This option could be used to disable DHCP client vendor class identification. Set this option to “y” in order to exclude option 60 from DHCP packets.
- Default value:
Yes (enabled)
CONFIG_LWIP_DHCP_RESTORE_LAST_IP¶
DHCP: Restore last IP obtained from DHCP server
Found in: Component config > LWIP
When this option is enabled, DHCP client tries to re-obtain last valid IP address obtained from DHCP server. Last valid DHCP configuration is stored in nvs and restored after reset/power-up. If IP is still available, there is no need for sending discovery message to DHCP server and save some time.
- Default value:
No (disabled)
CONFIG_LWIP_DHCP_OPTIONS_LEN¶
DHCP total option length
Found in: Component config > LWIP
Set total length of outgoing DHCP option msg. Generally bigger value means it can carry more options and values. If your code meets LWIP_ASSERT due to option value is too long. Please increase the LWIP_DHCP_OPTIONS_LEN value.
- Range:
from 68 to 255
- Default value:
68
108
DHCP server¶
Contains:
CONFIG_LWIP_DHCPS¶
DHCPS: Enable IPv4 Dynamic Host Configuration Protocol Server (DHCPS)
Found in: Component config > LWIP > DHCP server
Enabling this option allows the device to run the DHCP server (to dynamically assign IPv4 addresses to clients).
- Default value:
Yes (enabled)
CONFIG_LWIP_DHCPS_LEASE_UNIT¶
Multiplier for lease time, in seconds
Found in: Component config > LWIP > DHCP server > CONFIG_LWIP_DHCPS
The DHCP server is calculating lease time multiplying the sent and received times by this number of seconds per unit. The default is 60, that equals one minute.
- Range:
from 1 to 3600
- Default value:
60
CONFIG_LWIP_DHCPS_MAX_STATION_NUM¶
Maximum number of stations
Found in: Component config > LWIP > DHCP server > CONFIG_LWIP_DHCPS
The maximum number of DHCP clients that are connected to the server. After this number is exceeded, DHCP server removes of the oldest device from it’s address pool, without notification.
- Range:
from 1 to 64
- Default value:
8
CONFIG_LWIP_AUTOIP¶
Enable IPV4 Link-Local Addressing (AUTOIP)
Found in: Component config > LWIP
Enabling this option allows the device to self-assign an address in the 169.256/16 range if none is assigned statically or via DHCP.
See RFC 3927.
- Default value:
No (disabled)
Contains:
CONFIG_LWIP_AUTOIP_TRIES¶
DHCP Probes before self-assigning IPv4 LL address
Found in: Component config > LWIP > CONFIG_LWIP_AUTOIP
DHCP client will send this many probes before self-assigning a link local address.
From LWIP help: “This can be set as low as 1 to get an AutoIP address very quickly, but you should be prepared to handle a changing IP address when DHCP overrides AutoIP.” (In the case of ESP-IDF, this means multiple SYSTEM_EVENT_STA_GOT_IP events.)
- Range:
from 1 to 100 if CONFIG_LWIP_AUTOIP
- Default value:
2 if CONFIG_LWIP_AUTOIP
CONFIG_LWIP_AUTOIP_MAX_CONFLICTS¶
Max IP conflicts before rate limiting
Found in: Component config > LWIP > CONFIG_LWIP_AUTOIP
If the AUTOIP functionality detects this many IP conflicts while self-assigning an address, it will go into a rate limited mode.
- Range:
from 1 to 100 if CONFIG_LWIP_AUTOIP
- Default value:
9 if CONFIG_LWIP_AUTOIP
CONFIG_LWIP_AUTOIP_RATE_LIMIT_INTERVAL¶
Rate limited interval (seconds)
Found in: Component config > LWIP > CONFIG_LWIP_AUTOIP
If rate limiting self-assignment requests, wait this long between each request.
- Range:
from 5 to 120 if CONFIG_LWIP_AUTOIP
- Default value:
20 if CONFIG_LWIP_AUTOIP
CONFIG_LWIP_IPV6¶
Enable IPv6
Found in: Component config > LWIP
Enable IPv6 function. If not use IPv6 function, set this option to n. If disabling LWIP_IPV6 then some other components (coap and asio) will no longer be available.
- Default value:
Yes (enabled)
CONFIG_LWIP_IPV6_AUTOCONFIG¶
Enable IPV6 stateless address autoconfiguration (SLAAC)
Found in: Component config > LWIP > CONFIG_LWIP_IPV6
Enabling this option allows the devices to IPV6 stateless address autoconfiguration (SLAAC).
See RFC 4862.
- Default value:
No (disabled)
CONFIG_LWIP_IPV6_NUM_ADDRESSES¶
Number of IPv6 addresses on each network interface
Found in: Component config > LWIP > CONFIG_LWIP_IPV6
The maximum number of IPv6 addresses on each interface. Any additional addresses will be discarded.
- Default value:
3
CONFIG_LWIP_IPV6_FORWARD¶
Enable IPv6 forwarding between interfaces
Found in: Component config > LWIP > CONFIG_LWIP_IPV6
Forwarding IPv6 packets between interfaces is only required when acting as a router.
- Default value:
No (disabled)
CONFIG_LWIP_IPV6_RDNSS_MAX_DNS_SERVERS¶
Use IPv6 Router Advertisement Recursive DNS Server Option
Found in: Component config > LWIP
Use IPv6 Router Advertisement Recursive DNS Server Option (as per RFC 6106) to copy a defined maximum number of DNS servers to the DNS module. Set this option to a number of desired DNS servers advertised in the RA protocol. This feature is disabled when set to 0.
- Default value:
CONFIG_LWIP_IPV6_DHCP6¶
Enable DHCPv6 stateless address autoconfiguration
Found in: Component config > LWIP
Enable DHCPv6 for IPv6 stateless address autoconfiguration. Note that the dhcpv6 client has to be started using dhcp6_enable_stateless(netif); Note that the stateful address autoconfiguration is not supported.
- Default value:
No (disabled) if CONFIG_LWIP_IPV6_AUTOCONFIG
CONFIG_LWIP_NETIF_STATUS_CALLBACK¶
Enable status callback for network interfaces
Found in: Component config > LWIP
Enable callbacks when the network interface is up/down and addresses are changed.
- Default value:
No (disabled)
CONFIG_LWIP_NETIF_LOOPBACK¶
Support per-interface loopback
Found in: Component config > LWIP
Enabling this option means that if a packet is sent with a destination address equal to the interface’s own IP address, it will “loop back” and be received by this interface.
- Default value:
Yes (enabled)
Contains:
CONFIG_LWIP_LOOPBACK_MAX_PBUFS¶
Max queued loopback packets per interface
Found in: Component config > LWIP > CONFIG_LWIP_NETIF_LOOPBACK
Configure the maximum number of packets which can be queued for loopback on a given interface. Reducing this number may cause packets to be dropped, but will avoid filling memory with queued packet data.
- Range:
from 0 to 16
- Default value:
8
TCP¶
Contains:
CONFIG_LWIP_MAX_ACTIVE_TCP¶
Maximum active TCP Connections
Found in: Component config > LWIP > TCP
The maximum number of simultaneously active TCP connections. The practical maximum limit is determined by available heap memory at runtime.
Changing this value by itself does not substantially change the memory usage of LWIP, except for preventing new TCP connections after the limit is reached.
- Range:
from 1 to 1024
- Default value:
16
CONFIG_LWIP_MAX_LISTENING_TCP¶
Maximum listening TCP Connections
Found in: Component config > LWIP > TCP
The maximum number of simultaneously listening TCP connections. The practical maximum limit is determined by available heap memory at runtime.
Changing this value by itself does not substantially change the memory usage of LWIP, except for preventing new listening TCP connections after the limit is reached.
- Range:
from 1 to 1024
- Default value:
16
CONFIG_LWIP_TCP_HIGH_SPEED_RETRANSMISSION¶
TCP high speed retransmissions
Found in: Component config > LWIP > TCP
Speed up the TCP retransmission interval. If disabled, it is recommended to change the number of SYN retransmissions to 6, and TCP initial rto time to 3000.
- Default value:
Yes (enabled)
CONFIG_LWIP_TCP_MAXRTX¶
Maximum number of retransmissions of data segments
Found in: Component config > LWIP > TCP
Set maximum number of retransmissions of data segments.
- Range:
from 3 to 12
- Default value:
12
CONFIG_LWIP_TCP_SYNMAXRTX¶
Maximum number of retransmissions of SYN segments
Found in: Component config > LWIP > TCP
Set maximum number of retransmissions of SYN segments.
- Range:
from 3 to 12
- Default value:
6
12
CONFIG_LWIP_TCP_MSS¶
Maximum Segment Size (MSS)
Found in: Component config > LWIP > TCP
Set maximum segment size for TCP transmission.
Can be set lower to save RAM, the default value 1460(ipv4)/1440(ipv6) will give best throughput. IPv4 TCP_MSS Range: 576 <= TCP_MSS <= 1460 IPv6 TCP_MSS Range: 1220<= TCP_mSS <= 1440
- Range:
from 536 to 1460
- Default value:
1440
CONFIG_LWIP_TCP_TMR_INTERVAL¶
TCP timer interval(ms)
Found in: Component config > LWIP > TCP
Set TCP timer interval in milliseconds.
Can be used to speed connections on bad networks. A lower value will redeliver unacked packets faster.
- Default value:
250
CONFIG_LWIP_TCP_MSL¶
Maximum segment lifetime (MSL)
Found in: Component config > LWIP > TCP
Set maximum segment lifetime in in milliseconds.
- Default value:
60000
CONFIG_LWIP_TCP_SND_BUF_DEFAULT¶
Default send buffer size
Found in: Component config > LWIP > TCP
Set default send buffer size for new TCP sockets.
Per-socket send buffer size can be changed at runtime with lwip_setsockopt(s, TCP_SNDBUF, …).
This value must be at least 2x the MSS size, and the default is 4x the default MSS size.
Setting a smaller default SNDBUF size can save some RAM, but will decrease performance.
- Range:
from 2440 to 65535 if CONFIG_LWIP_WND_SCALE
from 2440 to 1024000 if CONFIG_LWIP_WND_SCALE
- Default value:
5744
CONFIG_LWIP_TCP_WND_DEFAULT¶
Default receive window size
Found in: Component config > LWIP > TCP
Set default TCP receive window size for new TCP sockets.
Per-socket receive window size can be changed at runtime with lwip_setsockopt(s, TCP_WINDOW, …).
Setting a smaller default receive window size can save some RAM, but will significantly decrease performance.
- Range:
from 2440 to 65535 if CONFIG_LWIP_WND_SCALE
from 2440 to 1024000 if CONFIG_LWIP_WND_SCALE
- Default value:
5744
CONFIG_LWIP_TCP_RECVMBOX_SIZE¶
Default TCP receive mail box size
Found in: Component config > LWIP > TCP
Set TCP receive mail box size. Generally bigger value means higher throughput but more memory. The recommended value is: LWIP_TCP_WND_DEFAULT/TCP_MSS + 2, e.g. if LWIP_TCP_WND_DEFAULT=14360, TCP_MSS=1436, then the recommended receive mail box size is (14360/1436 + 2) = 12.
TCP receive mail box is a per socket mail box, when the application receives packets from TCP socket, LWIP core firstly posts the packets to TCP receive mail box and the application then fetches the packets from mail box. It means LWIP can caches maximum LWIP_TCP_RECCVMBOX_SIZE packets for each TCP socket, so the maximum possible cached TCP packets for all TCP sockets is LWIP_TCP_RECCVMBOX_SIZE multiples the maximum TCP socket number. In other words, the bigger LWIP_TCP_RECVMBOX_SIZE means more memory. On the other hand, if the receiv mail box is too small, the mail box may be full. If the mail box is full, the LWIP drops the packets. So generally we need to make sure the TCP receive mail box is big enough to avoid packet drop between LWIP core and application.
- Range:
from 6 to 64 if CONFIG_LWIP_WND_SCALE
from 6 to 1024 if CONFIG_LWIP_WND_SCALE
- Default value:
6
CONFIG_LWIP_TCP_QUEUE_OOSEQ¶
Queue incoming out-of-order segments
Found in: Component config > LWIP > TCP
Queue incoming out-of-order segments for later use.
Disable this option to save some RAM during TCP sessions, at the expense of increased retransmissions if segments arrive out of order.
- Default value:
Yes (enabled)
CONFIG_LWIP_TCP_SACK_OUT¶
Support sending selective acknowledgements
Found in: Component config > LWIP > TCP
TCP will support sending selective acknowledgements (SACKs).
- Default value:
No (disabled)
CONFIG_LWIP_TCP_KEEP_CONNECTION_WHEN_IP_CHANGES¶
Keep TCP connections when IP changed
Found in: Component config > LWIP > TCP
This option is enabled when the following scenario happen: network dropped and reconnected, IP changes is like: 192.168.0.2->0.0.0.0->192.168.0.2
Disable this option to keep consistent with the original LWIP code behavior.
- Default value:
No (disabled)
CONFIG_LWIP_TCP_OVERSIZE¶
Pre-allocate transmit PBUF size
Found in: Component config > LWIP > TCP
Allows enabling “oversize” allocation of TCP transmission pbufs ahead of time, which can reduce the length of pbuf chains used for transmission.
This will not make a difference to sockets where Nagle’s algorithm is disabled.
Default value of MSS is fine for most applications, 25% MSS may save some RAM when only transmitting small amounts of data. Disabled will have worst performance and fragmentation characteristics, but uses least RAM overall.
- Available options:
MSS (LWIP_TCP_OVERSIZE_MSS)
25% MSS (LWIP_TCP_OVERSIZE_QUARTER_MSS)
Disabled (LWIP_TCP_OVERSIZE_DISABLE)
CONFIG_LWIP_WND_SCALE¶
Support TCP window scale
Found in: Component config > LWIP > TCP
Enable this feature to support TCP window scaling.
- Default value:
No (disabled) if SPIRAM_TRY_ALLOCATE_WIFI_LWIP
CONFIG_LWIP_TCP_RCV_SCALE¶
Set TCP receiving window scaling factor
Found in: Component config > LWIP > TCP > CONFIG_LWIP_WND_SCALE
Enable this feature to support TCP window scaling.
- Range:
from 0 to 14 if CONFIG_LWIP_WND_SCALE
- Default value:
CONFIG_LWIP_TCP_RTO_TIME¶
Default TCP rto time
Found in: Component config > LWIP > TCP
Set default TCP rto time for a reasonable initial rto. In bad network environment, recommend set value of rto time to 1500.
- Default value:
3000
1500
UDP¶
Contains:
CONFIG_LWIP_MAX_UDP_PCBS¶
Maximum active UDP control blocks
Found in: Component config > LWIP > UDP
The maximum number of active UDP “connections” (ie UDP sockets sending/receiving data). The practical maximum limit is determined by available heap memory at runtime.
- Range:
from 1 to 1024
- Default value:
16
CONFIG_LWIP_UDP_RECVMBOX_SIZE¶
Default UDP receive mail box size
Found in: Component config > LWIP > UDP
Set UDP receive mail box size. The recommended value is 6.
UDP receive mail box is a per socket mail box, when the application receives packets from UDP socket, LWIP core firstly posts the packets to UDP receive mail box and the application then fetches the packets from mail box. It means LWIP can caches maximum UDP_RECCVMBOX_SIZE packets for each UDP socket, so the maximum possible cached UDP packets for all UDP sockets is UDP_RECCVMBOX_SIZE multiples the maximum UDP socket number. In other words, the bigger UDP_RECVMBOX_SIZE means more memory. On the other hand, if the receiv mail box is too small, the mail box may be full. If the mail box is full, the LWIP drops the packets. So generally we need to make sure the UDP receive mail box is big enough to avoid packet drop between LWIP core and application.
- Range:
from 6 to 64
- Default value:
6
Checksums¶
Contains:
CONFIG_LWIP_CHECKSUM_CHECK_IP¶
Enable LWIP IP checksums
Found in: Component config > LWIP > Checksums
Enable checksum checking for received IP messages
- Default value:
No (disabled)
CONFIG_LWIP_CHECKSUM_CHECK_UDP¶
Enable LWIP UDP checksums
Found in: Component config > LWIP > Checksums
Enable checksum checking for received UDP messages
- Default value:
No (disabled)
CONFIG_LWIP_CHECKSUM_CHECK_ICMP¶
Enable LWIP ICMP checksums
Found in: Component config > LWIP > Checksums
Enable checksum checking for received ICMP messages
- Default value:
Yes (enabled)
CONFIG_LWIP_TCPIP_TASK_STACK_SIZE¶
TCP/IP Task Stack Size
Found in: Component config > LWIP
Configure TCP/IP task stack size, used by LWIP to process multi-threaded TCP/IP operations. Setting this stack too small will result in stack overflow crashes.
- Range:
from 2048 to 65536
- Default value:
3072
CONFIG_LWIP_TCPIP_TASK_AFFINITY¶
TCP/IP task affinity
Found in: Component config > LWIP
Allows setting LwIP tasks affinity, i.e. whether the task is pinned to CPU0, pinned to CPU1, or allowed to run on any CPU. Currently this applies to “TCP/IP” task and “Ping” task.
- Available options:
No affinity (LWIP_TCPIP_TASK_AFFINITY_NO_AFFINITY)
CPU0 (LWIP_TCPIP_TASK_AFFINITY_CPU0)
CPU1 (LWIP_TCPIP_TASK_AFFINITY_CPU1)
CONFIG_LWIP_PPP_SUPPORT¶
Enable PPP support (new/experimental)
Found in: Component config > LWIP
Enable PPP stack. Now only PPP over serial is possible.
PPP over serial support is experimental and unsupported.
- Default value:
No (disabled)
Contains:
CONFIG_LWIP_PPP_ENABLE_IPV6¶
Enable IPV6 support for PPP connections (IPV6CP)
Found in: Component config > LWIP > CONFIG_LWIP_PPP_SUPPORT
Enable IPV6 support in PPP for the local link between the DTE (processor) and DCE (modem). There are some modems which do not support the IPV6 addressing in the local link. If they are requested for IPV6CP negotiation, they may time out. This would in turn fail the configuration for the whole link. If your modem is not responding correctly to PPP Phase Network, try to disable IPV6 support.
- Default value:
Yes (enabled) if CONFIG_LWIP_PPP_SUPPORT && CONFIG_LWIP_IPV6
CONFIG_LWIP_IPV6_MEMP_NUM_ND6_QUEUE¶
Max number of IPv6 packets to queue during MAC resolution
Found in: Component config > LWIP
Config max number of IPv6 packets to queue during MAC resolution.
- Range:
from 3 to 20
- Default value:
3
CONFIG_LWIP_IPV6_ND6_NUM_NEIGHBORS¶
Max number of entries in IPv6 neighbor cache
Found in: Component config > LWIP
Config max number of entries in IPv6 neighbor cache
- Range:
from 3 to 10
- Default value:
5
CONFIG_LWIP_PPP_NOTIFY_PHASE_SUPPORT¶
Enable Notify Phase Callback
Found in: Component config > LWIP
Enable to set a callback which is called on change of the internal PPP state machine.
- Default value:
No (disabled) if CONFIG_LWIP_PPP_SUPPORT
CONFIG_LWIP_PPP_PAP_SUPPORT¶
Enable PAP support
Found in: Component config > LWIP
Enable Password Authentication Protocol (PAP) support
- Default value:
No (disabled) if CONFIG_LWIP_PPP_SUPPORT
CONFIG_LWIP_PPP_CHAP_SUPPORT¶
Enable CHAP support
Found in: Component config > LWIP
Enable Challenge Handshake Authentication Protocol (CHAP) support
- Default value:
No (disabled) if CONFIG_LWIP_PPP_SUPPORT
CONFIG_LWIP_PPP_MSCHAP_SUPPORT¶
Enable MSCHAP support
Found in: Component config > LWIP
Enable Microsoft version of the Challenge-Handshake Authentication Protocol (MSCHAP) support
- Default value:
No (disabled) if CONFIG_LWIP_PPP_SUPPORT
CONFIG_LWIP_PPP_MPPE_SUPPORT¶
Enable MPPE support
Found in: Component config > LWIP
Enable Microsoft Point-to-Point Encryption (MPPE) support
- Default value:
No (disabled) if CONFIG_LWIP_PPP_SUPPORT
CONFIG_LWIP_ENABLE_LCP_ECHO¶
Enable LCP ECHO
Found in: Component config > LWIP
Enable LCP echo keepalive requests
- Default value:
No (disabled) if CONFIG_LWIP_PPP_SUPPORT
CONFIG_LWIP_LCP_ECHOINTERVAL¶
Echo interval (s)
Found in: Component config > LWIP > CONFIG_LWIP_ENABLE_LCP_ECHO
Interval in seconds between keepalive LCP echo requests, 0 to disable.
- Range:
from 0 to 1000000 if CONFIG_LWIP_ENABLE_LCP_ECHO
- Default value:
CONFIG_LWIP_LCP_MAXECHOFAILS¶
Maximum echo failures
Found in: Component config > LWIP > CONFIG_LWIP_ENABLE_LCP_ECHO
Number of consecutive unanswered echo requests before failure is indicated.
- Range:
from 0 to 100000 if CONFIG_LWIP_ENABLE_LCP_ECHO
- Default value:
CONFIG_LWIP_PPP_DEBUG_ON¶
Enable PPP debug log output
Found in: Component config > LWIP
Enable PPP debug log output
- Default value:
No (disabled) if CONFIG_LWIP_PPP_SUPPORT
CONFIG_LWIP_SLIP_SUPPORT¶
Enable SLIP support (new/experimental)
Found in: Component config > LWIP
Enable SLIP stack. Now only SLIP over serial is possible.
SLIP over serial support is experimental and unsupported.
- Default value:
No (disabled)
Contains:
CONFIG_LWIP_SLIP_DEBUG_ON¶
Enable SLIP debug log output
Found in: Component config > LWIP > CONFIG_LWIP_SLIP_SUPPORT
Enable SLIP debug log output
- Default value:
No (disabled) if CONFIG_LWIP_SLIP_SUPPORT
ICMP¶
Contains:
CONFIG_LWIP_ICMP¶
ICMP: Enable ICMP
Found in: Component config > LWIP > ICMP
Enable ICMP module for check network stability
- Default value:
Yes (enabled)
CONFIG_LWIP_MULTICAST_PING¶
CONFIG_LWIP_BROADCAST_PING¶
LWIP RAW API¶
Contains:
CONFIG_LWIP_MAX_RAW_PCBS¶
Maximum LWIP RAW PCBs
Found in: Component config > LWIP > LWIP RAW API
The maximum number of simultaneously active LWIP RAW protocol control blocks. The practical maximum limit is determined by available heap memory at runtime.
- Range:
from 1 to 1024
- Default value:
16
SNTP¶
Contains:
CONFIG_LWIP_SNTP_MAX_SERVERS¶
Maximum number of NTP servers
Found in: Component config > LWIP > SNTP
Set maximum number of NTP servers used by LwIP SNTP module. First argument of sntp_setserver/sntp_setservername functions is limited to this value.
- Range:
from 1 to 16
- Default value:
1
CONFIG_LWIP_DHCP_GET_NTP_SRV¶
Request NTP servers from DHCP
Found in: Component config > LWIP > SNTP
If enabled, LWIP will add ‘NTP’ to Parameter-Request Option sent via DHCP-request. DHCP server might reply with an NTP server address in option 42. SNTP callback for such replies should be set accordingly (see sntp_servermode_dhcp() func.)
- Default value:
No (disabled)
CONFIG_LWIP_DHCP_MAX_NTP_SERVERS¶
Maximum number of NTP servers aquired via DHCP
Found in: Component config > LWIP > SNTP > CONFIG_LWIP_DHCP_GET_NTP_SRV
Set maximum number of NTP servers aquired via DHCP-offer. Should be less or equal to “Maximum number of NTP servers”, any extra servers would be just ignored.
- Range:
from 1 to 16 if CONFIG_LWIP_DHCP_GET_NTP_SRV
- Default value:
CONFIG_LWIP_SNTP_UPDATE_DELAY¶
Request interval to update time (ms)
Found in: Component config > LWIP > SNTP
This option allows you to set the time update period via SNTP. Default is 1 hour. Must not be below 15 seconds by specification. (SNTPv4 RFC 4330 enforces a minimum update time of 15 seconds).
- Range:
from 15000 to 4294967295
- Default value:
3600000
CONFIG_LWIP_ESP_LWIP_ASSERT¶
Enable LWIP ASSERT checks
Found in: Component config > LWIP
Enable this option keeps LWIP assertion checks enabled. It is recommended to keep this option enabled.
If asserts are disabled for the entire project, they are also disabled for LWIP and this option is ignored.
- Default value:
Yes (enabled) if COMPILER_OPTIMIZATION_ASSERTIONS_DISABLE
Hooks¶
Contains:
CONFIG_LWIP_HOOK_TCP_ISN¶
TCP ISN Hook
Found in: Component config > LWIP > Hooks
Enables to define a TCP ISN hook to randomize initial sequence number in TCP connection. The default TCP ISN algorithm used in IDF (standardized in RFC 6528) produces ISN by combining an MD5 of the new TCP id and a stable secret with the current time. This is because the lwIP implementation (tcp_next_iss) is not very strong, as it does not take into consideration any platform specific entropy source.
Set to LWIP_HOOK_TCP_ISN_CUSTOM to provide custom implementation. Set to LWIP_HOOK_TCP_ISN_NONE to use lwIP implementation.
- Available options:
No hook declared (LWIP_HOOK_TCP_ISN_NONE)
Default implementation (LWIP_HOOK_TCP_ISN_DEFAULT)
Custom implementation (LWIP_HOOK_TCP_ISN_CUSTOM)
CONFIG_LWIP_HOOK_IP6_ROUTE¶
IPv6 route Hook
Found in: Component config > LWIP > Hooks
Enables custom IPv6 route hook. Setting this to “default” provides weak implementation stub that could be overwritten in application code. Setting this to “custom” provides hook’s declaration only and expects the application to implement it.
- Available options:
No hook declared (LWIP_HOOK_IP6_ROUTE_NONE)
Default (weak) implementation (LWIP_HOOK_IP6_ROUTE_DEFAULT)
Custom implementation (LWIP_HOOK_IP6_ROUTE_CUSTOM)
CONFIG_LWIP_HOOK_ND6_GET_GW¶
IPv6 get gateway Hook
Found in: Component config > LWIP > Hooks
Enables custom IPv6 route hook. Setting this to “default” provides weak implementation stub that could be overwritten in application code. Setting this to “custom” provides hook’s declaration only and expects the application to implement it.
- Available options:
No hook declared (LWIP_HOOK_ND6_GET_GW_NONE)
Default (weak) implementation (LWIP_HOOK_ND6_GET_GW_DEFAULT)
Custom implementation (LWIP_HOOK_ND6_GET_GW_CUSTOM)
CONFIG_LWIP_HOOK_NETCONN_EXTERNAL_RESOLVE¶
Netconn external resolve Hook
Found in: Component config > LWIP > Hooks
Enables custom DNS resolve hook. Setting this to “default” provides weak implementation stub that could be overwritten in application code. Setting this to “custom” provides hook’s declaration only and expects the application to implement it.
- Available options:
No hook declared (LWIP_HOOK_NETCONN_EXT_RESOLVE_NONE)
Default (weak) implementation (LWIP_HOOK_NETCONN_EXT_RESOLVE_DEFAULT)
Custom implementation (LWIP_HOOK_NETCONN_EXT_RESOLVE_CUSTOM)
CONFIG_LWIP_DEBUG¶
Enable LWIP Debug
Found in: Component config > LWIP
Enabling this option allows different kinds of lwIP debug output.
All lwIP debug features increase the size of the final binary.
- Default value:
No (disabled)
Contains:
CONFIG_LWIP_NETIF_DEBUG¶
Enable netif debug messages
Found in: Component config > LWIP > CONFIG_LWIP_DEBUG
- Default value:
No (disabled) if CONFIG_LWIP_DEBUG
CONFIG_LWIP_PBUF_DEBUG¶
Enable pbuf debug messages
Found in: Component config > LWIP > CONFIG_LWIP_DEBUG
- Default value:
No (disabled) if CONFIG_LWIP_DEBUG
CONFIG_LWIP_ETHARP_DEBUG¶
Enable etharp debug messages
Found in: Component config > LWIP > CONFIG_LWIP_DEBUG
- Default value:
No (disabled) if CONFIG_LWIP_DEBUG
CONFIG_LWIP_API_LIB_DEBUG¶
Enable api lib debug messages
Found in: Component config > LWIP > CONFIG_LWIP_DEBUG
- Default value:
No (disabled) if CONFIG_LWIP_DEBUG
CONFIG_LWIP_SOCKETS_DEBUG¶
Enable socket debug messages
Found in: Component config > LWIP > CONFIG_LWIP_DEBUG
- Default value:
No (disabled) if CONFIG_LWIP_DEBUG
CONFIG_LWIP_IP_DEBUG¶
Enable IP debug messages
Found in: Component config > LWIP > CONFIG_LWIP_DEBUG
- Default value:
No (disabled) if CONFIG_LWIP_DEBUG
CONFIG_LWIP_ICMP_DEBUG¶
Enable ICMP debug messages
Found in: Component config > LWIP > CONFIG_LWIP_DEBUG
- Default value:
No (disabled) if CONFIG_LWIP_DEBUG && CONFIG_LWIP_ICMP
CONFIG_LWIP_DHCP_STATE_DEBUG¶
Enable DHCP state tracking
Found in: Component config > LWIP > CONFIG_LWIP_DEBUG
- Default value:
No (disabled) if CONFIG_LWIP_DEBUG
CONFIG_LWIP_DHCP_DEBUG¶
Enable DHCP debug messages
Found in: Component config > LWIP > CONFIG_LWIP_DEBUG
- Default value:
No (disabled) if CONFIG_LWIP_DEBUG
CONFIG_LWIP_IP6_DEBUG¶
Enable IP6 debug messages
Found in: Component config > LWIP > CONFIG_LWIP_DEBUG
- Default value:
No (disabled) if CONFIG_LWIP_DEBUG
CONFIG_LWIP_ICMP6_DEBUG¶
Enable ICMP6 debug messages
Found in: Component config > LWIP > CONFIG_LWIP_DEBUG
- Default value:
No (disabled) if CONFIG_LWIP_DEBUG
CONFIG_LWIP_TCP_DEBUG¶
Enable TCP debug messages
Found in: Component config > LWIP > CONFIG_LWIP_DEBUG
- Default value:
No (disabled) if CONFIG_LWIP_DEBUG
CONFIG_LWIP_SNTP_DEBUG¶
Enable SNTP debug messages
Found in: Component config > LWIP > CONFIG_LWIP_DEBUG
- Default value:
No (disabled) if CONFIG_LWIP_DEBUG
mbedTLS¶
Contains:
CONFIG_MBEDTLS_MEM_ALLOC_MODE¶
Memory allocation strategy
Found in: Component config > mbedTLS
Allocation strategy for mbedTLS, essentially provides ability to allocate all required dynamic allocations from,
Internal DRAM memory only
External SPIRAM memory only
Either internal or external memory based on default malloc() behavior in ESP-IDF
Custom allocation mode, by overwriting calloc()/free() using mbedtls_platform_set_calloc_free() function
Internal IRAM memory wherever applicable else internal DRAM
Recommended mode here is always internal (*), since that is most preferred from security perspective. But if application requirement does not allow sufficient free internal memory then alternate mode can be selected.
(*) In case of ESP32-S2/ESP32-S3, hardware allows encryption of external SPIRAM contents provided hardware flash encryption feature is enabled. In that case, using external SPIRAM allocation strategy is also safe choice from security perspective.
- Available options:
Internal memory (MBEDTLS_INTERNAL_MEM_ALLOC)
External SPIRAM (MBEDTLS_EXTERNAL_MEM_ALLOC)
Default alloc mode (MBEDTLS_DEFAULT_MEM_ALLOC)
Custom alloc mode (MBEDTLS_CUSTOM_MEM_ALLOC)
Internal IRAM (MBEDTLS_IRAM_8BIT_MEM_ALLOC)
Allows to use IRAM memory region as 8bit accessible region.
TLS input and output buffers will be allocated in IRAM section which is 32bit aligned memory. Every unaligned (8bit or 16bit) access will result in an exception and incur penalty of certain clock cycles per unaligned read/write.
CONFIG_MBEDTLS_SSL_MAX_CONTENT_LEN¶
TLS maximum message content length
Found in: Component config > mbedTLS
Maximum TLS message length (in bytes) supported by mbedTLS.
16384 is the default and this value is required to comply fully with TLS standards.
However you can set a lower value in order to save RAM. This is safe if the other end of the connection supports Maximum Fragment Length Negotiation Extension (max_fragment_length, see RFC6066) or you know for certain that it will never send a message longer than a certain number of bytes.
If the value is set too low, symptoms are a failed TLS handshake or a return value of MBEDTLS_ERR_SSL_INVALID_RECORD (-0x7200).
- Range:
from 512 to 16384
- Default value:
16384
CONFIG_MBEDTLS_ASYMMETRIC_CONTENT_LEN¶
Asymmetric in/out fragment length
Found in: Component config > mbedTLS
If enabled, this option allows customizing TLS in/out fragment length in asymmetric way. Please note that enabling this with default values saves 12KB of dynamic memory per TLS connection.
- Default value:
Yes (enabled)
CONFIG_MBEDTLS_SSL_IN_CONTENT_LEN¶
TLS maximum incoming fragment length
Found in: Component config > mbedTLS > CONFIG_MBEDTLS_ASYMMETRIC_CONTENT_LEN
This defines maximum incoming fragment length, overriding default maximum content length (MBEDTLS_SSL_MAX_CONTENT_LEN).
- Range:
from 512 to 16384
- Default value:
16384
CONFIG_MBEDTLS_SSL_OUT_CONTENT_LEN¶
TLS maximum outgoing fragment length
Found in: Component config > mbedTLS > CONFIG_MBEDTLS_ASYMMETRIC_CONTENT_LEN
This defines maximum outgoing fragment length, overriding default maximum content length (MBEDTLS_SSL_MAX_CONTENT_LEN).
- Range:
from 512 to 16384
- Default value:
4096
CONFIG_MBEDTLS_DYNAMIC_BUFFER¶
Using dynamic TX/RX buffer
Found in: Component config > mbedTLS
Using dynamic TX/RX buffer. After enabling this option, mbedTLS will allocate TX buffer when need to send data and then free it if all data is sent, allocate RX buffer when need to receive data and then free it when all data is used or read by upper layer.
By default, when SSL is initialized, mbedTLS also allocate TX and RX buffer with the default value of “MBEDTLS_SSL_OUT_CONTENT_LEN” or “MBEDTLS_SSL_IN_CONTENT_LEN”, so to save more heap, users can set the options to be an appropriate value.
- Default value:
No (disabled) if CONFIG_MBEDTLS_SSL_PROTO_DTLS && CONFIG_MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH
CONFIG_MBEDTLS_DYNAMIC_FREE_PEER_CERT¶
Free SSL peer certificate after its usage
Found in: Component config > mbedTLS > CONFIG_MBEDTLS_DYNAMIC_BUFFER
Free peer certificate after its usage in handshake process.
- Default value:
No (disabled) if CONFIG_MBEDTLS_DYNAMIC_BUFFER
CONFIG_MBEDTLS_DYNAMIC_FREE_CONFIG_DATA¶
Free private key and DHM data after its usage
Found in: Component config > mbedTLS > CONFIG_MBEDTLS_DYNAMIC_BUFFER
Free private key and DHM data after its usage in handshake process.
The option will decrease heap cost when handshake, but also lead to problem:
Becasue all certificate, private key and DHM data are freed so users should register certificate and private key to ssl config object again.
- Default value:
No (disabled) if CONFIG_MBEDTLS_DYNAMIC_BUFFER
CONFIG_MBEDTLS_DYNAMIC_FREE_CA_CERT¶
Free SSL CA certificate after its usage
Found in: Component config > mbedTLS > CONFIG_MBEDTLS_DYNAMIC_BUFFER > CONFIG_MBEDTLS_DYNAMIC_FREE_CONFIG_DATA
Free CA certificate after its usage in the handshake process. This option will decrease the heap footprint for the TLS handshake, but may lead to a problem: If the respective ssl object needs to perform the TLS handshake again, the CA certificate should once again be registered to the ssl object.
- Default value:
Yes (enabled) if CONFIG_MBEDTLS_DYNAMIC_FREE_CONFIG_DATA
CONFIG_MBEDTLS_DEBUG¶
Enable mbedTLS debugging
Found in: Component config > mbedTLS
Enable mbedTLS debugging functions at compile time.
If this option is enabled, you can include “mbedtls/esp_debug.h” and call mbedtls_esp_enable_debug_log() at runtime in order to enable mbedTLS debug output via the ESP log mechanism.
- Default value:
No (disabled)
CONFIG_MBEDTLS_DEBUG_LEVEL¶
Set mbedTLS debugging level
Found in: Component config > mbedTLS > CONFIG_MBEDTLS_DEBUG
Set mbedTLS debugging level
- Available options:
Warning (MBEDTLS_DEBUG_LEVEL_WARN)
Info (MBEDTLS_DEBUG_LEVEL_INFO)
Debug (MBEDTLS_DEBUG_LEVEL_DEBUG)
Verbose (MBEDTLS_DEBUG_LEVEL_VERBOSE)
Certificate Bundle¶
Contains:
CONFIG_MBEDTLS_CERTIFICATE_BUNDLE¶
Enable trusted root certificate bundle
Found in: Component config > mbedTLS > Certificate Bundle
Enable support for large number of default root certificates
When enabled this option allows user to store default as well as customer specific root certificates in compressed format rather than storing full certificate. For the root certificates the public key and the subject name will be stored.
- Default value:
Yes (enabled)
CONFIG_MBEDTLS_DEFAULT_CERTIFICATE_BUNDLE¶
Default certificate bundle options
Found in: Component config > mbedTLS > Certificate Bundle > CONFIG_MBEDTLS_CERTIFICATE_BUNDLE
- Available options:
Use the full default certificate bundle (MBEDTLS_CERTIFICATE_BUNDLE_DEFAULT_FULL)
Use only the most common certificates from the default bundles (MBEDTLS_CERTIFICATE_BUNDLE_DEFAULT_CMN)
Use only the most common certificates from the default bundles, reducing the size with 50%, while still having around 99% coverage.
Do not use the default certificate bundle (MBEDTLS_CERTIFICATE_BUNDLE_DEFAULT_NONE)
CONFIG_MBEDTLS_CUSTOM_CERTIFICATE_BUNDLE¶
Add custom certificates to the default bundle
Found in: Component config > mbedTLS > Certificate Bundle > CONFIG_MBEDTLS_CERTIFICATE_BUNDLE
- Default value:
No (disabled)
CONFIG_MBEDTLS_CUSTOM_CERTIFICATE_BUNDLE_PATH¶
Custom certificate bundle path
Found in: Component config > mbedTLS > Certificate Bundle > CONFIG_MBEDTLS_CERTIFICATE_BUNDLE > CONFIG_MBEDTLS_CUSTOM_CERTIFICATE_BUNDLE
Name of the custom certificate directory or file. This path is evaluated relative to the project root directory.
CONFIG_MBEDTLS_ECP_RESTARTABLE¶
Enable mbedTLS ecp restartable
Found in: Component config > mbedTLS
Enable “non-blocking” ECC operations that can return early and be resumed.
- Default value:
No (disabled)
CONFIG_MBEDTLS_CMAC_C¶
Enable CMAC mode for block ciphers
Found in: Component config > mbedTLS
Enable the CMAC (Cipher-based Message Authentication Code) mode for block ciphers.
- Default value:
No (disabled)
CONFIG_MBEDTLS_HARDWARE_AES¶
Enable hardware AES acceleration
Found in: Component config > mbedTLS
Enable hardware accelerated AES encryption & decryption.
Note that if the ESP32 CPU is running at 240MHz, hardware AES does not offer any speed boost over software AES.
- Default value:
Yes (enabled) if SPIRAM_CACHE_WORKAROUND_STRATEGY_DUPLDST
CONFIG_MBEDTLS_AES_USE_INTERRUPT¶
Use interrupt for long AES operations
Found in: Component config > mbedTLS > CONFIG_MBEDTLS_HARDWARE_AES
Use an interrupt to coordinate long AES operations.
This allows other code to run on the CPU while an AES operation is pending. Otherwise the CPU busy-waits.
- Default value:
Yes (enabled)
CONFIG_MBEDTLS_HARDWARE_MPI¶
Enable hardware MPI (bignum) acceleration
Found in: Component config > mbedTLS
Enable hardware accelerated multiple precision integer operations.
Hardware accelerated multiplication, modulo multiplication, and modular exponentiation for up to SOC_RSA_MAX_BIT_LEN bit results.
These operations are used by RSA.
- Default value:
Yes (enabled) if SPIRAM_CACHE_WORKAROUND_STRATEGY_DUPLDST
CONFIG_MBEDTLS_HARDWARE_SHA¶
Enable hardware SHA acceleration
Found in: Component config > mbedTLS
Enable hardware accelerated SHA1, SHA256, SHA384 & SHA512 in mbedTLS.
Due to a hardware limitation, on the ESP32 hardware acceleration is only guaranteed if SHA digests are calculated one at a time. If more than one SHA digest is calculated at the same time, one will be calculated fully in hardware and the rest will be calculated (at least partially calculated) in software. This happens automatically.
SHA hardware acceleration is faster than software in some situations but slower in others. You should benchmark to find the best setting for you.
- Default value:
Yes (enabled) if SPIRAM_CACHE_WORKAROUND_STRATEGY_DUPLDST
CONFIG_MBEDTLS_ROM_MD5¶
Use MD5 implementation in ROM
Found in: Component config > mbedTLS
Use ROM MD5 in mbedTLS.
- Default value:
Yes (enabled)
CONFIG_MBEDTLS_ATCA_HW_ECDSA_SIGN¶
Enable hardware ECDSA sign acceleration when using ATECC608A
Found in: Component config > mbedTLS
This option enables hardware acceleration for ECDSA sign function, only when using ATECC608A cryptoauth chip (integrated with ESP32-WROOM-32SE)
- Default value:
No (disabled)
CONFIG_MBEDTLS_ATCA_HW_ECDSA_VERIFY¶
Enable hardware ECDSA verify acceleration when using ATECC608A
Found in: Component config > mbedTLS
This option enables hardware acceleration for ECDSA sign function, only when using ATECC608A cryptoauth chip (integrated with ESP32-WROOM-32SE)
- Default value:
No (disabled)
CONFIG_MBEDTLS_HAVE_TIME¶
Enable mbedtls time support
Found in: Component config > mbedTLS
Enable use of time.h functions (time() and gmtime()) by mbedTLS.
This option doesn’t require the system time to be correct, but enables functionality that requires relative timekeeping - for example periodic expiry of TLS session tickets or session cache entries.
Disabling this option will save some firmware size, particularly if the rest of the firmware doesn’t call any standard timekeeeping functions.
- Default value:
Yes (enabled)
CONFIG_MBEDTLS_HAVE_TIME_DATE¶
Enable mbedtls certificate expiry check
Found in: Component config > mbedTLS > CONFIG_MBEDTLS_HAVE_TIME
Enables X.509 certificate expiry checks in mbedTLS.
If this option is disabled (default) then X.509 certificate “valid from” and “valid to” timestamp fields are ignored.
If this option is enabled, these fields are compared with the current system date and time. The time is retrieved using the standard time() and gmtime() functions. If the certificate is not valid for the current system time then verification will fail with code MBEDTLS_X509_BADCERT_FUTURE or MBEDTLS_X509_BADCERT_EXPIRED.
Enabling this option requires adding functionality in the firmware to set the system clock to a valid timestamp before using TLS. The recommended way to do this is via ESP-IDF’s SNTP functionality, but any method can be used.
In the case where only a small number of certificates are trusted by the device, please carefully consider the tradeoffs of enabling this option. There may be undesired consequences, for example if all trusted certificates expire while the device is offline and a TLS connection is required to update. Or if an issue with the SNTP server means that the system time is invalid for an extended period after a reset.
- Default value:
No (disabled)
CONFIG_MBEDTLS_ECDSA_DETERMINISTIC¶
Enable deterministic ECDSA
Found in: Component config > mbedTLS
Standard ECDSA is “fragile” in the sense that lack of entropy when signing may result in a compromise of the long-term signing key.
- Default value:
Yes (enabled)
CONFIG_MBEDTLS_SHA512_C¶
Enable the SHA-384 and SHA-512 cryptographic hash algorithms
Found in: Component config > mbedTLS
Enable MBEDTLS_SHA512_C adds support for SHA-384 and SHA-512.
- Default value:
Yes (enabled)
CONFIG_MBEDTLS_TLS_MODE¶
TLS Protocol Role
Found in: Component config > mbedTLS
mbedTLS can be compiled with protocol support for the TLS server, TLS client, or both server and client.
Reducing the number of TLS roles supported saves code size.
- Available options:
Server & Client (MBEDTLS_TLS_SERVER_AND_CLIENT)
Server (MBEDTLS_TLS_SERVER_ONLY)
Client (MBEDTLS_TLS_CLIENT_ONLY)
None (MBEDTLS_TLS_DISABLED)
TLS Key Exchange Methods¶
Contains:
CONFIG_MBEDTLS_PSK_MODES¶
Enable pre-shared-key ciphersuites
Found in: Component config > mbedTLS > TLS Key Exchange Methods
Enable to show configuration for different types of pre-shared-key TLS authentatication methods.
Leaving this options disabled will save code size if they are not used.
- Default value:
No (disabled)
CONFIG_MBEDTLS_KEY_EXCHANGE_PSK¶
Enable PSK based ciphersuite modes
Found in: Component config > mbedTLS > TLS Key Exchange Methods > CONFIG_MBEDTLS_PSK_MODES
Enable to support symmetric key PSK (pre-shared-key) TLS key exchange modes.
- Default value:
No (disabled) if CONFIG_MBEDTLS_PSK_MODES
CONFIG_MBEDTLS_KEY_EXCHANGE_DHE_PSK¶
Enable DHE-PSK based ciphersuite modes
Found in: Component config > mbedTLS > TLS Key Exchange Methods > CONFIG_MBEDTLS_PSK_MODES
Enable to support Diffie-Hellman PSK (pre-shared-key) TLS authentication modes.
- Default value:
Yes (enabled) if CONFIG_MBEDTLS_PSK_MODES
CONFIG_MBEDTLS_KEY_EXCHANGE_ECDHE_PSK¶
Enable ECDHE-PSK based ciphersuite modes
Found in: Component config > mbedTLS > TLS Key Exchange Methods > CONFIG_MBEDTLS_PSK_MODES
Enable to support Elliptic-Curve-Diffie-Hellman PSK (pre-shared-key) TLS authentication modes.
- Default value:
Yes (enabled) if CONFIG_MBEDTLS_PSK_MODES && CONFIG_MBEDTLS_ECDH_C
CONFIG_MBEDTLS_KEY_EXCHANGE_RSA_PSK¶
Enable RSA-PSK based ciphersuite modes
Found in: Component config > mbedTLS > TLS Key Exchange Methods > CONFIG_MBEDTLS_PSK_MODES
Enable to support RSA PSK (pre-shared-key) TLS authentication modes.
- Default value:
Yes (enabled) if CONFIG_MBEDTLS_PSK_MODES
CONFIG_MBEDTLS_KEY_EXCHANGE_RSA¶
Enable RSA-only based ciphersuite modes
Found in: Component config > mbedTLS > TLS Key Exchange Methods
Enable to support ciphersuites with prefix TLS-RSA-WITH-
- Default value:
Yes (enabled)
CONFIG_MBEDTLS_KEY_EXCHANGE_DHE_RSA¶
Enable DHE-RSA based ciphersuite modes
Found in: Component config > mbedTLS > TLS Key Exchange Methods
Enable to support ciphersuites with prefix TLS-DHE-RSA-WITH-
- Default value:
Yes (enabled)
CONFIG_MBEDTLS_KEY_EXCHANGE_ELLIPTIC_CURVE¶
Support Elliptic Curve based ciphersuites
Found in: Component config > mbedTLS > TLS Key Exchange Methods
Enable to show Elliptic Curve based ciphersuite mode options.
Disabling all Elliptic Curve ciphersuites saves code size and can give slightly faster TLS handshakes, provided the server supports RSA-only ciphersuite modes.
- Default value:
Yes (enabled)
CONFIG_MBEDTLS_KEY_EXCHANGE_ECDHE_RSA¶
Enable ECDHE-RSA based ciphersuite modes
Found in: Component config > mbedTLS > TLS Key Exchange Methods > CONFIG_MBEDTLS_KEY_EXCHANGE_ELLIPTIC_CURVE
Enable to support ciphersuites with prefix TLS-ECDHE-RSA-WITH-
- Default value:
Yes (enabled)
CONFIG_MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA¶
Enable ECDHE-ECDSA based ciphersuite modes
Found in: Component config > mbedTLS > TLS Key Exchange Methods > CONFIG_MBEDTLS_KEY_EXCHANGE_ELLIPTIC_CURVE
Enable to support ciphersuites with prefix TLS-ECDHE-RSA-WITH-
- Default value:
Yes (enabled)
CONFIG_MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA¶
Enable ECDH-ECDSA based ciphersuite modes
Found in: Component config > mbedTLS > TLS Key Exchange Methods > CONFIG_MBEDTLS_KEY_EXCHANGE_ELLIPTIC_CURVE
Enable to support ciphersuites with prefix TLS-ECDHE-RSA-WITH-
- Default value:
Yes (enabled)
CONFIG_MBEDTLS_KEY_EXCHANGE_ECDH_RSA¶
Enable ECDH-RSA based ciphersuite modes
Found in: Component config > mbedTLS > TLS Key Exchange Methods > CONFIG_MBEDTLS_KEY_EXCHANGE_ELLIPTIC_CURVE
Enable to support ciphersuites with prefix TLS-ECDHE-RSA-WITH-
- Default value:
Yes (enabled)
CONFIG_MBEDTLS_KEY_EXCHANGE_ECJPAKE¶
Enable ECJPAKE based ciphersuite modes
Found in: Component config > mbedTLS > TLS Key Exchange Methods
Enable to support ciphersuites with prefix TLS-ECJPAKE-WITH-
- Default value:
No (disabled) if CONFIG_MBEDTLS_ECJPAKE_C && CONFIG_MBEDTLS_ECP_DP_SECP256R1_ENABLED
CONFIG_MBEDTLS_SSL_RENEGOTIATION¶
Support TLS renegotiation
Found in: Component config > mbedTLS
The two main uses of renegotiation are (1) refresh keys on long-lived connections and (2) client authentication after the initial handshake. If you don’t need renegotiation, disabling it will save code size and reduce the possibility of abuse/vulnerability.
- Default value:
Yes (enabled)
CONFIG_MBEDTLS_SSL_PROTO_SSL3¶
Legacy SSL 3.0 support
Found in: Component config > mbedTLS
Support the legacy SSL 3.0 protocol. Most servers will speak a newer TLS protocol these days.
- Default value:
No (disabled)
CONFIG_MBEDTLS_SSL_PROTO_TLS1¶
CONFIG_MBEDTLS_SSL_PROTO_TLS1_1¶
CONFIG_MBEDTLS_SSL_PROTO_TLS1_2¶
CONFIG_MBEDTLS_SSL_PROTO_GMTSSL1_1¶
Support GM/T SSL 1.1 protocol
Found in: Component config > mbedTLS
Provisions for GM/T SSL 1.1 support
- Default value:
No (disabled)
CONFIG_MBEDTLS_SSL_PROTO_DTLS¶
Support DTLS protocol (all versions)
Found in: Component config > mbedTLS
Requires TLS 1.1 to be enabled for DTLS 1.0 Requires TLS 1.2 to be enabled for DTLS 1.2
- Default value:
No (disabled)
CONFIG_MBEDTLS_SSL_ALPN¶
Support ALPN (Application Layer Protocol Negotiation)
Found in: Component config > mbedTLS
Disabling this option will save some code size if it is not needed.
- Default value:
Yes (enabled)
CONFIG_MBEDTLS_CLIENT_SSL_SESSION_TICKETS¶
TLS: Client Support for RFC 5077 SSL session tickets
Found in: Component config > mbedTLS
Client support for RFC 5077 session tickets. See mbedTLS documentation for more details. Disabling this option will save some code size.
- Default value:
Yes (enabled)
CONFIG_MBEDTLS_X509_CHECK_KEY_USAGE¶
Enable verification of the keyUsage extension
Found in: Component config > mbedTLS
Disabling this avoids problems with mis-issued and/or misused (intermediate) CA and leaf certificates. Depending on your PKI use, disabling this can be a security risk.
- Default value:
Yes (enabled)
CONFIG_MBEDTLS_X509_CHECK_EXTENDED_KEY_USAGE¶
Enable verification of the extendedKeyUsage extension
Found in: Component config > mbedTLS
Disabling this avoids problems with mis-issued and/or misused certificates. Depending on your PKI use, disabling this can be a security risk.
- Default value:
Yes (enabled)
CONFIG_MBEDTLS_SERVER_SSL_SESSION_TICKETS¶
TLS: Server Support for RFC 5077 SSL session tickets
Found in: Component config > mbedTLS
Server support for RFC 5077 session tickets. See mbedTLS documentation for more details. Disabling this option will save some code size.
- Default value:
Yes (enabled)
Symmetric Ciphers¶
Contains:
CONFIG_MBEDTLS_AES_C¶
AES block cipher
Found in: Component config > mbedTLS > Symmetric Ciphers
- Default value:
Yes (enabled)
CONFIG_MBEDTLS_CAMELLIA_C¶
Camellia block cipher
Found in: Component config > mbedTLS > Symmetric Ciphers
- Default value:
No (disabled)
CONFIG_MBEDTLS_DES_C¶
DES block cipher (legacy, insecure)
Found in: Component config > mbedTLS > Symmetric Ciphers
Enables the DES block cipher to support 3DES-based TLS ciphersuites.
3DES is vulnerable to the Sweet32 attack and should only be enabled if absolutely necessary.
- Default value:
No (disabled)
CONFIG_MBEDTLS_RC4_MODE¶
RC4 Stream Cipher (legacy, insecure)
Found in: Component config > mbedTLS > Symmetric Ciphers
ARCFOUR (RC4) stream cipher can be disabled entirely, enabled but not added to default ciphersuites, or enabled completely.
Please consider the security implications before enabling RC4.
- Available options:
Disabled (MBEDTLS_RC4_DISABLED)
Enabled, not in default ciphersuites (MBEDTLS_RC4_ENABLED_NO_DEFAULT)
Enabled (MBEDTLS_RC4_ENABLED)
CONFIG_MBEDTLS_BLOWFISH_C¶
Blowfish block cipher (read help)
Found in: Component config > mbedTLS > Symmetric Ciphers
Enables the Blowfish block cipher (not used for TLS sessions.)
The Blowfish cipher is not used for mbedTLS TLS sessions but can be used for other purposes. Read up on the limitations of Blowfish (including Sweet32) before enabling.
- Default value:
No (disabled)
CONFIG_MBEDTLS_XTEA_C¶
XTEA block cipher
Found in: Component config > mbedTLS > Symmetric Ciphers
Enables the XTEA block cipher.
- Default value:
No (disabled)
CONFIG_MBEDTLS_CCM_C¶
CCM (Counter with CBC-MAC) block cipher modes
Found in: Component config > mbedTLS > Symmetric Ciphers
Enable Counter with CBC-MAC (CCM) modes for AES and/or Camellia ciphers.
Disabling this option saves some code size.
- Default value:
Yes (enabled)
CONFIG_MBEDTLS_GCM_C¶
GCM (Galois/Counter) block cipher modes
Found in: Component config > mbedTLS > Symmetric Ciphers
Enable Galois/Counter Mode for AES and/or Camellia ciphers.
This option is generally faster than CCM.
- Default value:
Yes (enabled)
CONFIG_MBEDTLS_NIST_KW_C¶
NIST key wrapping (KW) and KW padding (KWP)
Found in: Component config > mbedTLS > Symmetric Ciphers
Enable NIST key wrapping and key wrapping padding.
- Default value:
No (disabled)
CONFIG_MBEDTLS_RIPEMD160_C¶
Enable RIPEMD-160 hash algorithm
Found in: Component config > mbedTLS
Enable the RIPEMD-160 hash algorithm.
- Default value: