Configuration Options¶
Introduction¶
ESP-IDF uses Kconfig system to provide a compile-time 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.
Applications developers can use make menuconfig build target to edit components’ configuration. This configuration is saved inside sdkconfig file in the project root directory. Based on sdkconfig, application build targets will generate sdkconfig.h file in the build directory, and will make sdkconfig options available to component makefiles.
Using sdkconfig.defaults¶
When updating ESP-IDF version, it is not uncommon to find that new Kconfig options are introduced. When this happens, application build targets will offer an interactive prompt to select values for the new options. New values are then written into sdkconfig file. To supress interactive prompts, applications can either define BATCH_BUILD environment variable, which will cause all prompts to be suppressed. This is the same effect as that of V or VERBOSE variables. Alternatively, defconfig build target can be used to update configuration for all new variables to the default values.
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 when make defconfig is used, settings in sdkconfig will be overriden by the ones in sdkconfig.defaults. For more information, see Custom sdkconfig defaults.
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_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.
CONFIG_PYTHON¶
Python 2 interpreter
Found in: SDK tool configuration
The executable name/path that is used to run python. On some systems Python 2.x may need to be invoked as python2.
(Note: This option is used with the GNU Make build system only, not idf.py or CMake-based builds.)
CONFIG_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.
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.
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.
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.
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.
Bootloader config¶
Contains:
CONFIG_LOG_BOOTLOADER_LEVEL¶
Bootloader log verbosity
Found in: Bootloader config
Specify how much output to see in bootloader logs.
- Available options:
No output (LOG_BOOTLOADER_LEVEL_NONE)
Error (LOG_BOOTLOADER_LEVEL_ERROR)
Warning (LOG_BOOTLOADER_LEVEL_WARN)
Info (LOG_BOOTLOADER_LEVEL_INFO)
Debug (LOG_BOOTLOADER_LEVEL_DEBUG)
Verbose (LOG_BOOTLOADER_LEVEL_VERBOSE)
CONFIG_BOOTLOADER_SPI_CUSTOM_WP_PIN¶
Use custom SPI Flash WP Pin when flash pins set in eFuse (read help)
Found in: Bootloader config
This setting is only used if the SPI flash pins have been overridden by setting the eFuses SPI_PAD_CONFIG_xxx, and the SPI flash mode is QIO or QOUT.
When this is the case, the eFuse config only defines 3 of the 4 Quad I/O data pins. The WP pin (aka ESP32 pin “SD_DATA_3” or SPI flash pin “IO2”) is not specified in eFuse. The same pin is also used for external SPIRAM if it is enabled.
If this config item is set to N (default), the correct WP pin will be automatically used for any Espressif chip or module with integrated flash. If a custom setting is needed, set this config item to Y and specify the GPIO number connected to the WP.
CONFIG_BOOTLOADER_SPI_WP_PIN¶
Custom SPI Flash WP Pin
Found in: Bootloader config
The option “Use custom SPI Flash WP Pin” must be set or this value is ignored
If burning a customized set of SPI flash pins in eFuse and using QIO or QOUT mode for flash, set this value to the GPIO number of the SPI flash WP pin.
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 pulled low while device starts up. See settings below.
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. To trigger a factory reset, this GPIO must be pulled low on reset. Note that GPIO34-39 do not have an internal pullup and an external one must be provided.
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.
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.
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.
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.
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_CLOCK_SOURCE (INTERNAL_RC or EXTERNAL_CRYSTAL).
CONFIG_BOOTLOADER_WDT_DISABLE_IN_USER_CODE¶
Allows RTC watchdog disable in user code
Found in: Bootloader config > CONFIG_BOOTLOADER_WDT_ENABLE
If it is set, the client must itself reset or disable rtc_wdt in their code (app_main()). Otherwise rtc_wdt will be disabled before calling app_main function. Use function rtc_wdt_feed() for resetting counter of rtc_wdt. Use function rtc_wdt_disable() for disabling rtc_wdt.
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.
CONFIG_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.
CONFIG_APP_ANTI_ROLLBACK¶
Enable app anti-rollback support
Found in: Bootloader config > CONFIG_APP_ROLLBACK_ENABLE
This option prevents rollback to previous firmware/application image with lower security version.
CONFIG_APP_SECURE_VERSION¶
eFuse secure version of app
Found in: Bootloader config > CONFIG_APP_ROLLBACK_ENABLE > CONFIG_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 APP_SECURE_VERSION_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).
CONFIG_APP_SECURE_VERSION_SIZE_EFUSE_FIELD¶
Size of the efuse secure version field
Found in: Bootloader config > CONFIG_APP_ROLLBACK_ENABLE > CONFIG_APP_ANTI_ROLLBACK
The size of the efuse secure version field. Its length is limited to 32 bits. This determines how many times the security version can be increased.
CONFIG_EFUSE_SECURE_VERSION_EMULATE¶
Emulate operations with efuse secure version(only test)
Found in: Bootloader config > CONFIG_APP_ROLLBACK_ENABLE > CONFIG_APP_ANTI_ROLLBACK
This option allow emulate read/write operations with efuse secure version. It allow to test anti-rollback implemention without permanent write eFuse bits. In partition table should be exist this partition emul_efuse, data, 5, , 0x2000.
CONFIG_BOOTLOADER_FLASH_XMC_SUPPORT_ENA¶
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.
Due to the limitation of Flash size, this flow is disabled by default on IDF v3.3. You may need to disable some bootloader features to enable it.
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_ON_BOOT_NO_SECURE_BOOT¶
Bootloader verifies app signatures
Found in: Security features > CONFIG_SECURE_SIGNED_APPS_NO_SECURE_BOOT
If this option is set, the bootloader will be compiled with code to verify that an app is signed before booting it.
If hardware secure boot is enabled, this option is always enabled and cannot be disabled. If hardware secure boot is not enabled, this option doesn’t add significant security by itself so most users will want to leave it disabled.
CONFIG_SECURE_SIGNED_ON_UPDATE_NO_SECURE_BOOT¶
Verify app signature on update
Found in: Security features > CONFIG_SECURE_SIGNED_APPS_NO_SECURE_BOOT
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.
CONFIG_SECURE_BOOT_ENABLED¶
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.
Refer to Secure Boot before enabling.
CONFIG_SECURE_BOOTLOADER_MODE¶
Secure bootloader mode
Found in: Security features > CONFIG_SECURE_BOOT_ENABLED
- Available options:
One-time flash (SECURE_BOOTLOADER_ONE_TIME_FLASH)
On first boot, the bootloader will generate a key which is not readable externally or by software. A digest is generated from the bootloader image itself. This digest will be verified on each subsequent boot.
Enabling this option means that the bootloader cannot be changed after the first time it is booted.
Reflashable (SECURE_BOOTLOADER_REFLASHABLE)
Generate a reusable secure bootloader key, derived (via SHA-256) from the secure boot signing key.
This allows the secure bootloader to be re-flashed by anyone with access to the secure boot signing key.
This option is less secure than one-time flash, because a leak of the digest key from one device allows reflashing of any device that uses it.
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 (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.
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 Secure Boot for details.
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. This key is compiled into the bootloader and/or app, to verify app images.
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 Secure Boot before enabling.
CONFIG_SECURE_BOOTLOADER_KEY_ENCODING¶
Hardware Key Encoding
Found in: Security features
In reflashable secure bootloader mode, a hardware key is derived from the signing key (with SHA-256) and can be written to eFuse with espefuse.py.
Normally this is a 256-bit key, but if 3/4 Coding Scheme is used on the device then the eFuse key is truncated to 192 bits.
This configuration item doesn’t change any firmware code, it only changes the size of key binary which is generated at build time.
- Available options:
No encoding (256 bit key) (SECURE_BOOTLOADER_KEY_ENCODING_256BIT)
3/4 encoding (192 bit key) (SECURE_BOOTLOADER_KEY_ENCODING_192BIT)
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 Secure Boot before enabling.
CONFIG_FLASH_ENCRYPTION_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.
CONFIG_FLASH_ENCRYPTION_INSECURE¶
Allow potentially insecure options
Found in: Security features > CONFIG_FLASH_ENCRYPTION_ENABLED
You can disable some of the default protections offered by flash encryption, in order to enable testing or a custom combination of security features.
Only enable these options if you are very sure.
Refer to Secure Boot and Flash Encryption for details.
Potentially insecure options¶
Contains:
CONFIG_SECURE_BOOT_ALLOW_ROM_BASIC¶
Leave ROM BASIC Interpreter available on reset
Found in: Security features > Potentially insecure options
By default, the BASIC ROM Console starts on reset if no valid bootloader is read from the flash.
When either flash encryption or secure boot are enabled, the default is to disable this BASIC fallback mode permanently via eFuse.
If this option is set, this eFuse is not burned and the BASIC ROM Console may remain accessible. Only set this option in testing environments.
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.
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_FLASH_ENCRYPTION_UART_BOOTLOADER_ALLOW_ENCRYPT¶
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.
CONFIG_FLASH_ENCRYPTION_UART_BOOTLOADER_ALLOW_DECRYPT¶
Leave UART bootloader decryption enabled
Found in: Security features > Potentially insecure options
If not set (default), the bootloader will permanently disable UART bootloader decryption access on first boot. If set, the UART bootloader will still be able to access hardware decryption.
Only set this option in testing environments. Setting this option allows complete bypass of flash encryption.
CONFIG_FLASH_ENCRYPTION_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.
CONFIG_FLASH_ENCRYPTION_DISABLE_PLAINTEXT¶
Disable serial reflashing of plaintext firmware
Found in: Security features
If this option is enabled, flash encryption is permanently enabled after first boot by write-protecting the FLASH_CRYPT_CNT efuse. This is the recommended configuration for a secure production system.
If this option is disabled, FLASH_CRYPT_CNT is left writeable and up to 4 plaintext re-flashes are allowed. An attacker with physical access will be able to read out encrypted flash contents until all plaintext re-flashes have been used up.
If this option is disabled and hardware Secure Boot is enabled, Secure Boot must be configured in Reflashable mode so that a new Secure Boot digest can be flashed at the same time as plaintext firmware. This combination is not secure and should not be used for a production system.
CONFIG_SECURE_DISABLE_ROM_DL_MODE¶
Permanently disable ROM Download Mode
Found in: Security features
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.
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.
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¶
Other baud rate value
Found in: Serial flasher config
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.
CONFIG_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 (FLASHMODE_QIO)
QOUT (FLASHMODE_QOUT)
DIO (FLASHMODE_DIO)
DOUT (FLASHMODE_DOUT)
CONFIG_ESPTOOLPY_FLASHFREQ¶
Flash SPI speed
Found in: Serial flasher config
The SPI flash frequency to be used.
- Available options:
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, ‘make flash’ targets will automatically detect the flash size and update the bootloader image when flashing.
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_MONITOR_BAUD¶
‘make monitor’ baud rate
Found in: Serial flasher config
Baud rate to use when running ‘make monitor’ to view serial output from a running chip.
Can override by setting the MONITORBAUD environment variable.
- Available options:
9600 bps (MONITOR_BAUD_9600B)
57600 bps (MONITOR_BAUD_57600B)
115200 bps (MONITOR_BAUD_115200B)
230400 bps (MONITOR_BAUD_230400B)
921600 bps (MONITOR_BAUD_921600B)
2 Mbps (MONITOR_BAUD_2MB)
Custom baud rate (MONITOR_BAUD_OTHER)
CONFIG_MONITOR_BAUD_OTHER_VAL¶
Custom baud rate value
Found in: Serial flasher config
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. Otherwise it’s possible to create a new custom partition CSV for your application.
- Available options:
Single factory app, no OTA (PARTITION_TABLE_SINGLE_APP)
Factory app, two OTA definitions (PARTITION_TABLE_TWO_OTA)
Custom partition table CSV (PARTITION_TABLE_CUSTOM)
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.
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.
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.
Compiler options¶
Contains:
CONFIG_OPTIMIZATION_COMPILER¶
Optimization Level
Found in: Compiler options
This option sets compiler optimization level (gcc -O argument).
for “Release” setting, -Os flag is added to CFLAGS.
for “Debug” setting, -Og flag is added to CFLAGS.
“Release” with -Os produces smaller & faster compiled code but it may be harder to correlated code addresses to source files when debugging.
To add custom optimization settings, set CFLAGS and/or CPPFLAGS in project makefile, before including $(IDF_PATH)/make/project.mk. Note that custom optimization levels may be unsupported.
- Available options:
Debug (-Og) (OPTIMIZATION_LEVEL_DEBUG)
Release (-Os) (OPTIMIZATION_LEVEL_RELEASE)
CONFIG_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 (OPTIMIZATION_ASSERTIONS_ENABLED)
Enable assertions. Assertion content and line number will be printed on failure.
Silent (saves code size) (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) (OPTIMIZATION_ASSERTIONS_DISABLED)
If assertions are disabled, -DNDEBUG is added to CPPFLAGS.
CONFIG_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.
Contains:
CONFIG_CXX_EXCEPTIONS_EMG_POOL_SIZE¶
Emergency Pool Size
Found in: Compiler options > CONFIG_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.
CONFIG_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
- Available options:
None (STACK_CHECK_NONE)
Normal (STACK_CHECK_NORM)
Strong (STACK_CHECK_STRONG)
Overall (STACK_CHECK_ALL)
CONFIG_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 \*.
CONFIG_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.
Component config¶
Contains:
Application Level Tracing¶
Contains:
CONFIG_ESP32_APPTRACE_DESTINATION¶
Data Destination
Found in: Component config > Application Level Tracing
Select destination for application trace: trace memory or none (to disable).
- Available options:
Trace memory (ESP32_APPTRACE_DEST_TRAX)
None (ESP32_APPTRACE_DEST_NONE)
CONFIG_ESP32_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_ESP32_APPTRACE_POSTMORTEM_FLUSH_TRAX_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_ESP32_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_SYSVIEW_ENABLE¶
SystemView Tracing Enable
Found in: Component config > Application Level Tracing > FreeRTOS SystemView Tracing
Enables supporrt for SEGGER SystemView tracing functionality.
CONFIG_SYSVIEW_TS_SOURCE¶
Timer to use as timestamp source
Found in: Component config > Application Level Tracing > FreeRTOS SystemView Tracing > CONFIG_SYSVIEW_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) (SYSVIEW_TS_SOURCE_CCOUNT)
Timer 0, Group 0 (SYSVIEW_TS_SOURCE_TIMER_00)
Timer 1, Group 0 (SYSVIEW_TS_SOURCE_TIMER_01)
Timer 0, Group 1 (SYSVIEW_TS_SOURCE_TIMER_10)
Timer 1, Group 1 (SYSVIEW_TS_SOURCE_TIMER_11)
esp_timer high resolution timer (SYSVIEW_TS_SOURCE_ESP_TIMER)
CONFIG_SYSVIEW_MAX_TASKS¶
Maximum supported tasks
Found in: Component config > Application Level Tracing > FreeRTOS SystemView Tracing > CONFIG_SYSVIEW_ENABLE
Configures maximum supported tasks in sysview debug
CONFIG_SYSVIEW_EVT_OVERFLOW_ENABLE¶
Trace Buffer Overflow Event
Found in: Component config > Application Level Tracing > FreeRTOS SystemView Tracing > CONFIG_SYSVIEW_ENABLE
Enables “Trace Buffer Overflow” event.
CONFIG_SYSVIEW_EVT_ISR_ENTER_ENABLE¶
ISR Enter Event
Found in: Component config > Application Level Tracing > FreeRTOS SystemView Tracing > CONFIG_SYSVIEW_ENABLE
Enables “ISR Enter” event.
CONFIG_SYSVIEW_EVT_ISR_EXIT_ENABLE¶
ISR Exit Event
Found in: Component config > Application Level Tracing > FreeRTOS SystemView Tracing > CONFIG_SYSVIEW_ENABLE
Enables “ISR Exit” event.
CONFIG_SYSVIEW_EVT_ISR_TO_SCHEDULER_ENABLE¶
ISR Exit to Scheduler Event
Found in: Component config > Application Level Tracing > FreeRTOS SystemView Tracing > CONFIG_SYSVIEW_ENABLE
Enables “ISR to Scheduler” event.
CONFIG_SYSVIEW_EVT_TASK_START_EXEC_ENABLE¶
Task Start Execution Event
Found in: Component config > Application Level Tracing > FreeRTOS SystemView Tracing > CONFIG_SYSVIEW_ENABLE
Enables “Task Start Execution” event.
CONFIG_SYSVIEW_EVT_TASK_STOP_EXEC_ENABLE¶
Task Stop Execution Event
Found in: Component config > Application Level Tracing > FreeRTOS SystemView Tracing > CONFIG_SYSVIEW_ENABLE
Enables “Task Stop Execution” event.
CONFIG_SYSVIEW_EVT_TASK_START_READY_ENABLE¶
Task Start Ready State Event
Found in: Component config > Application Level Tracing > FreeRTOS SystemView Tracing > CONFIG_SYSVIEW_ENABLE
Enables “Task Start Ready State” event.
CONFIG_SYSVIEW_EVT_TASK_STOP_READY_ENABLE¶
Task Stop Ready State Event
Found in: Component config > Application Level Tracing > FreeRTOS SystemView Tracing > CONFIG_SYSVIEW_ENABLE
Enables “Task Stop Ready State” event.
CONFIG_SYSVIEW_EVT_TASK_CREATE_ENABLE¶
Task Create Event
Found in: Component config > Application Level Tracing > FreeRTOS SystemView Tracing > CONFIG_SYSVIEW_ENABLE
Enables “Task Create” event.
CONFIG_SYSVIEW_EVT_TASK_TERMINATE_ENABLE¶
Task Terminate Event
Found in: Component config > Application Level Tracing > FreeRTOS SystemView Tracing > CONFIG_SYSVIEW_ENABLE
Enables “Task Terminate” event.
CONFIG_SYSVIEW_EVT_IDLE_ENABLE¶
System Idle Event
Found in: Component config > Application Level Tracing > FreeRTOS SystemView Tracing > CONFIG_SYSVIEW_ENABLE
Enables “System Idle” event.
CONFIG_SYSVIEW_EVT_TIMER_ENTER_ENABLE¶
Timer Enter Event
Found in: Component config > Application Level Tracing > FreeRTOS SystemView Tracing > CONFIG_SYSVIEW_ENABLE
Enables “Timer Enter” event.
CONFIG_SYSVIEW_EVT_TIMER_EXIT_ENABLE¶
Timer Exit Event
Found in: Component config > Application Level Tracing > FreeRTOS SystemView Tracing > CONFIG_SYSVIEW_ENABLE
Enables “Timer Exit” event.
CONFIG_ESP32_GCOV_ENABLE¶
GCOV to Host Enable
Found in: Component config > Application Level Tracing
Enables support for GCOV data transfer to host.
CONFIG_AWS_IOT_SDK¶
Amazon Web Services IoT Platform
Found in: Component config
Select this option to enable support for the AWS IoT platform, via the esp-idf component for the AWS IoT Device C SDK.
Contains:
CONFIG_AWS_IOT_MQTT_HOST¶
AWS IoT Endpoint Hostname
Found in: Component config > CONFIG_AWS_IOT_SDK
Default endpoint host name to connect to AWS IoT MQTT/S gateway
This is the custom endpoint hostname and is specific to an AWS IoT account. You can find it by logging into your AWS IoT Console and clicking the Settings button. The endpoint hostname is shown under the “Custom Endpoint” heading on this page.
If you need per-device hostnames for different regions or accounts, you can override the default hostname in your app.
CONFIG_AWS_IOT_MQTT_PORT¶
AWS IoT MQTT Port
Found in: Component config > CONFIG_AWS_IOT_SDK
Default port number to connect to AWS IoT MQTT/S gateway
If you need per-device port numbers for different regions, you can override the default port number in your app.
CONFIG_AWS_IOT_MQTT_TX_BUF_LEN¶
MQTT TX Buffer Length
Found in: Component config > CONFIG_AWS_IOT_SDK
Maximum MQTT transmit buffer size. This is the maximum MQTT message length (including protocol overhead) which can be sent.
Sending longer messages will fail.
CONFIG_AWS_IOT_MQTT_RX_BUF_LEN¶
MQTT RX Buffer Length
Found in: Component config > CONFIG_AWS_IOT_SDK
Maximum MQTT receive buffer size. This is the maximum MQTT message length (including protocol overhead) which can be received.
Longer messages are dropped.
CONFIG_AWS_IOT_MQTT_NUM_SUBSCRIBE_HANDLERS¶
Maximum MQTT Topic Filters
Found in: Component config > CONFIG_AWS_IOT_SDK
Maximum number of concurrent MQTT topic filters.
CONFIG_AWS_IOT_MQTT_MIN_RECONNECT_WAIT_INTERVAL¶
Auto reconnect initial interval (ms)
Found in: Component config > CONFIG_AWS_IOT_SDK
Initial delay before making first reconnect attempt, if the AWS IoT connection fails. Client will perform exponential backoff, starting from this value.
CONFIG_AWS_IOT_MQTT_MAX_RECONNECT_WAIT_INTERVAL¶
Auto reconnect maximum interval (ms)
Found in: Component config > CONFIG_AWS_IOT_SDK
Maximum delay between reconnection attempts. If the exponentially increased delay interval reaches this value, the client will stop automatically attempting to reconnect.
Thing Shadow¶
Contains:
CONFIG_AWS_IOT_OVERRIDE_THING_SHADOW_RX_BUFFER¶
Override Shadow RX buffer size
Found in: Component config > CONFIG_AWS_IOT_SDK > Thing Shadow
Allows setting a different Thing Shadow RX buffer size. This is the maximum size of a Thing Shadow message in bytes, plus one.
If not overridden, the default value is the MQTT RX Buffer length plus one. If overriden, do not set higher than the default value.
CONFIG_AWS_IOT_SHADOW_MAX_SIZE_OF_RX_BUFFER¶
Maximum RX Buffer (bytes)
Found in: Component config > CONFIG_AWS_IOT_SDK > Thing Shadow > CONFIG_AWS_IOT_OVERRIDE_THING_SHADOW_RX_BUFFER
Allows setting a different Thing Shadow RX buffer size. This is the maximum size of a Thing Shadow message in bytes, plus one.
CONFIG_AWS_IOT_SHADOW_MAX_SIZE_OF_UNIQUE_CLIENT_ID_BYTES¶
Maximum unique client ID size (bytes)
Found in: Component config > CONFIG_AWS_IOT_SDK > Thing Shadow
Maximum size of the Unique Client Id.
CONFIG_AWS_IOT_SHADOW_MAX_SIMULTANEOUS_ACKS¶
Maximum simultaneous responses
Found in: Component config > CONFIG_AWS_IOT_SDK > Thing Shadow
At any given time we will wait for this many responses. This will correlate to the rate at which the shadow actions are requested
CONFIG_AWS_IOT_SHADOW_MAX_SIMULTANEOUS_THINGNAMES¶
Maximum simultaneous Thing Name operations
Found in: Component config > CONFIG_AWS_IOT_SDK > Thing Shadow
We could perform shadow action on any thing Name and this is maximum Thing Names we can act on at any given time
CONFIG_AWS_IOT_SHADOW_MAX_JSON_TOKEN_EXPECTED¶
Maximum expected JSON tokens
Found in: Component config > CONFIG_AWS_IOT_SDK > Thing Shadow
These are the max tokens that is expected to be in the Shadow JSON document. Includes the metadata which is published
CONFIG_AWS_IOT_SHADOW_MAX_SHADOW_TOPIC_LENGTH_WITHOUT_THINGNAME¶
Maximum topic length (not including Thing Name)
Found in: Component config > CONFIG_AWS_IOT_SDK > Thing Shadow
All shadow actions have to be published or subscribed to a topic which is of the format $aws/things/{thingName}/shadow/update/accepted. This refers to the size of the topic without the Thing Name
CONFIG_AWS_IOT_SHADOW_MAX_SIZE_OF_THING_NAME¶
Maximum Thing Name length
Found in: Component config > CONFIG_AWS_IOT_SDK > Thing Shadow
Maximum length of a Thing Name.
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.
Bluetooth controller¶
Contains:
CONFIG_BTDM_CONTROLLER_MODE¶
Bluetooth controller mode (BR/EDR/BLE/DUALMODE)
Found in: Component config > Bluetooth > Bluetooth controller
Specify the bluetooth controller mode (BR/EDR, BLE or dual mode).
- Available options:
BLE Only (BTDM_CONTROLLER_MODE_BLE_ONLY)
BR/EDR Only (BTDM_CONTROLLER_MODE_BR_EDR_ONLY)
Bluetooth Dual Mode (BTDM_CONTROLLER_MODE_BTDM)
CONFIG_BTDM_CONTROLLER_BLE_MAX_CONN¶
BLE Max Connections
Found in: Component config > Bluetooth > Bluetooth controller
BLE maximum connections of bluetooth controller. Each connection uses 1KB static DRAM whenever the BT controller is enabled.
CONFIG_BTDM_CONTROLLER_BR_EDR_MAX_ACL_CONN¶
BR/EDR ACL Max Connections
Found in: Component config > Bluetooth > Bluetooth controller
BR/EDR ACL maximum connections of bluetooth controller. Each connection uses 1.2KB static DRAM whenever the BT controller is enabled.
CONFIG_BTDM_CONTROLLER_BR_EDR_MAX_SYNC_CONN¶
BR/EDR Sync(SCO/eSCO) Max Connections
Found in: Component config > Bluetooth > Bluetooth controller
BR/EDR Synchronize maximum connections of bluetooth controller. Each connection uses 2KB static DRAM whenever the BT controller is enabled.
CONFIG_BTDM_CTRL_BR_EDR_SCO_DATA_PATH¶
BR/EDR Sync(SCO/eSCO) default data path
Found in: Component config > Bluetooth > Bluetooth controller
SCO data path, i.e. HCI or PCM. SCO data can be sent/received through HCI synchronous packets, or the data can be routed to on-chip PCM module on ESP32. PCM input/output signals can be “matrixed” to GPIOs. The default data path can also be set using API “esp_bredr_sco_datapath_set”
- Available options:
HCI (BTDM_CTRL_BR_EDR_SCO_DATA_PATH_HCI)
PCM (BTDM_CTRL_BR_EDR_SCO_DATA_PATH_PCM)
CONFIG_BTDM_CTRL_AUTO_LATENCY¶
Auto latency
Found in: Component config > Bluetooth > Bluetooth controller
BLE auto latency, used to enhance classic BT performance while classic BT and BLE are enabled at the same time.
CONFIG_BTDM_CTRL_LEGACY_AUTH_VENDOR_EVT¶
Legacy Authentication Vendor Specific Event Enable
Found in: Component config > Bluetooth > Bluetooth controller
To protect from BIAS attack during Legacy authentication, Legacy authentication Vendor specific event should be enabled
CONFIG_BTDM_CONTROLLER_PINNED_TO_CORE_CHOICE¶
The cpu core which bluetooth controller run
Found in: Component config > Bluetooth > Bluetooth controller
Specify the cpu core to run bluetooth controller. Can not specify no-affinity.
- Available options:
Core 0 (PRO CPU) (BTDM_CONTROLLER_PINNED_TO_CORE_0)
Core 1 (APP CPU) (BTDM_CONTROLLER_PINNED_TO_CORE_1)
CONFIG_BTDM_CONTROLLER_HCI_MODE_CHOICE¶
HCI mode
Found in: Component config > Bluetooth > Bluetooth controller
Speicify HCI mode as VHCI or UART(H4)
- Available options:
VHCI (BTDM_CONTROLLER_HCI_MODE_VHCI)
Normal option. Mostly, choose this VHCI when bluetooth host run on ESP32, too.
UART(H4) (BTDM_CONTROLLER_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_HCI_UART_NO¶
UART Number for HCI
Found in: Component config > Bluetooth > Bluetooth controller > HCI UART(H4) Options
Uart number for HCI. The available uart is UART1 and UART2.
CONFIG_BT_HCI_UART_BAUDRATE¶
UART Baudrate for HCI
Found in: Component config > Bluetooth > Bluetooth controller > HCI UART(H4) Options
UART Baudrate for HCI. Please use standard baudrate.
CONFIG_BTDM_CONTROLLER_MODEM_SLEEP¶
Bluetooth modem sleep
Found in: Component config > Bluetooth > Bluetooth controller > MODEM SLEEP Options
Enable/disable bluetooth controller low power mode.
CONFIG_BTDM_MODEM_SLEEP_MODE¶
Bluetooth Modem sleep mode
Found in: Component config > Bluetooth > Bluetooth controller > MODEM SLEEP Options > CONFIG_BTDM_CONTROLLER_MODEM_SLEEP
To select which strategy to use for modem sleep
- Available options:
ORIG Mode(sleep with low power clock) (BTDM_MODEM_SLEEP_MODE_ORIG)
ORIG mode is a bluetooth sleep mode that can be used for dual mode controller. In this mode, bluetooth controller sleeps between BR/EDR frames and BLE events. A low power clock is used to maintain bluetooth reference clock.
EVED Mode(For internal test only) (BTDM_MODEM_SLEEP_MODE_EVED)
EVED mode is for BLE only and is only for internal test. Do not use it for production. this mode is not compatible with DFS nor light sleep
CONFIG_BTDM_LOW_POWER_CLOCK¶
Bluetooth low power clock
Found in: Component config > Bluetooth > Bluetooth controller > MODEM SLEEP Options
Select the low power clock source for bluetooth controller
- Available options:
Main crystal (BTDM_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 (BTDM_LPCLK_SEL_EXT_32K_XTAL)
CONFIG_BLE_SCAN_DUPLICATE¶
BLE Scan Duplicate Options
Found in: Component config > Bluetooth > Bluetooth controller
This select enables parameters setting of BLE scan duplicate.
CONFIG_SCAN_DUPLICATE_TYPE¶
Scan Duplicate Type
Found in: Component config > Bluetooth > Bluetooth controller > CONFIG_BLE_SCAN_DUPLICATE
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 (SCAN_DUPLICATE_BY_DEVICE_ADDR)
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 (SCAN_DUPLICATE_BY_ADV_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 (SCAN_DUPLICATE_BY_ADV_DATA_AND_DEVICE_ADDR)
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_DUPLICATE_SCAN_CACHE_SIZE¶
Maximum number of devices in scan duplicate filter
Found in: Component config > Bluetooth > Bluetooth controller > CONFIG_BLE_SCAN_DUPLICATE
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.
CONFIG_BLE_MESH_SCAN_DUPLICATE_EN¶
Special duplicate scan mechanism for BLE Mesh scan
Found in: Component config > Bluetooth > Bluetooth controller > CONFIG_BLE_SCAN_DUPLICATE
This enables the BLE scan duplicate for special BLE Mesh scan.
CONFIG_MESH_DUPLICATE_SCAN_CACHE_SIZE¶
Maximum number of Mesh adv packets in scan duplicate filter
Found in: Component config > Bluetooth > Bluetooth controller > CONFIG_BLE_SCAN_DUPLICATE > CONFIG_BLE_MESH_SCAN_DUPLICATE_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.
CONFIG_BTDM_CONTROLLER_FULL_SCAN_SUPPORTED¶
BLE full scan feature supported
Found in: Component config > Bluetooth > Bluetooth controller
The full scan function is mainly used to provide BLE scan performance. This is required for scenes with high scan performance requirements, such as BLE Mesh scenes.
CONFIG_BLE_ADV_REPORT_FLOW_CONTROL_SUPPORTED¶
BLE adv report flow control supported
Found in: Component config > Bluetooth > 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.
CONFIG_BLE_ADV_REPORT_FLOW_CONTROL_NUM¶
BLE adv report flow control number
Found in: Component config > Bluetooth > Bluetooth controller > CONFIG_BLE_ADV_REPORT_FLOW_CONTROL_SUPPORTED
The number of unprocessed advertising report that Bluedroid can save.If you set BLE_ADV_REPORT_FLOW_CONTROL_NUM to a small value, this may cause adv packets lost. If you set BLE_ADV_REPORT_FLOW_CONTROL_NUM to a large value, Bluedroid 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 BLE_ADV_REPORT_FLOW_CONTROL_NUM according to your system free memory and handle adv packets as fast as possible, otherwise it will cause adv packets lost.
CONFIG_BLE_ADV_REPORT_DISCARD_THRSHOLD¶
BLE adv lost event threshold value
Found in: Component config > Bluetooth > Bluetooth controller > CONFIG_BLE_ADV_REPORT_FLOW_CONTROL_SUPPORTED
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 BLE_ADV_REPORT_DISCARD_THRSHOLD to a small value or printf every adv lost event, it may cause adv packets lost more.
CONFIG_BLUEDROID_ENABLED¶
Bluedroid Enable
Found in: Component config > Bluetooth
This enables the default Bluedroid Bluetooth stack
Contains:
CONFIG_BLUEDROID_PINNED_TO_CORE_CHOICE¶
The cpu core which Bluedroid run
Found in: Component config > Bluetooth > CONFIG_BLUEDROID_ENABLED
Which the cpu core to run Bluedroid. Can choose core0 and core1. Can not specify no-affinity.
- Available options:
Core 0 (PRO CPU) (BLUEDROID_PINNED_TO_CORE_0)
Core 1 (APP CPU) (BLUEDROID_PINNED_TO_CORE_1)
CONFIG_BTC_TASK_STACK_SIZE¶
Bluetooth event (callback to application) task stack size
Found in: Component config > Bluetooth > CONFIG_BLUEDROID_ENABLED
This select btc task stack size
CONFIG_BTU_TASK_STACK_SIZE¶
Bluetooth Bluedroid Host Stack task stack size
Found in: Component config > Bluetooth > CONFIG_BLUEDROID_ENABLED
This select btu task stack size
CONFIG_BLUEDROID_MEM_DEBUG¶
Bluedroid memory debug
Found in: Component config > Bluetooth > CONFIG_BLUEDROID_ENABLED
Bluedroid memory debug
CONFIG_CLASSIC_BT_ENABLED¶
Classic Bluetooth
Found in: Component config > Bluetooth > CONFIG_BLUEDROID_ENABLED
For now this option needs “SMP_ENABLE” to be set to yes
CONFIG_A2DP_ENABLE¶
A2DP
Found in: Component config > Bluetooth > CONFIG_BLUEDROID_ENABLED > CONFIG_CLASSIC_BT_ENABLED
Advanced Audio Distrubution Profile
CONFIG_A2DP_SINK_TASK_STACK_SIZE¶
A2DP sink (audio stream decoding) task stack size
Found in: Component config > Bluetooth > CONFIG_BLUEDROID_ENABLED > CONFIG_CLASSIC_BT_ENABLED > CONFIG_A2DP_ENABLE
CONFIG_A2DP_SOURCE_TASK_STACK_SIZE¶
A2DP source (audio stream encoding) task stack size
Found in: Component config > Bluetooth > CONFIG_BLUEDROID_ENABLED > CONFIG_CLASSIC_BT_ENABLED > CONFIG_A2DP_ENABLE
CONFIG_BT_SPP_ENABLED¶
SPP
Found in: Component config > Bluetooth > CONFIG_BLUEDROID_ENABLED > CONFIG_CLASSIC_BT_ENABLED
This enables the Serial Port Profile
CONFIG_HFP_ENABLE¶
Hands Free/Handset Profile
Found in: Component config > Bluetooth > CONFIG_BLUEDROID_ENABLED > CONFIG_CLASSIC_BT_ENABLED
CONFIG_HFP_ROLE¶
Hands-free Profile Role configuration
Found in: Component config > Bluetooth > CONFIG_BLUEDROID_ENABLED > CONFIG_CLASSIC_BT_ENABLED > CONFIG_HFP_ENABLE
- Available options:
Hands Free Unit (HFP_CLIENT_ENABLE)
CONFIG_HFP_AUDIO_DATA_PATH¶
audio(SCO) data path
Found in: Component config > Bluetooth > CONFIG_BLUEDROID_ENABLED > CONFIG_CLASSIC_BT_ENABLED > CONFIG_HFP_ENABLE
SCO data path, i.e. HCI or PCM. This option is set using API “esp_bredr_sco_datapath_set” in Bluetooth host. Default SCO data path can also be set in Bluetooth Controller.
- Available options:
PCM (HFP_AUDIO_DATA_PATH_PCM)
HCI (HFP_AUDIO_DATA_PATH_HCI)
CONFIG_BT_SSP_ENABLED¶
Secure Simple Pairing
Found in: Component config > Bluetooth > CONFIG_BLUEDROID_ENABLED > CONFIG_CLASSIC_BT_ENABLED
This enables the Secure Simple Pairing. If disable this option, Bluedroid will only support Legacy Pairing
CONFIG_GATTS_ENABLE¶
Include GATT server module(GATTS)
Found in: Component config > Bluetooth > CONFIG_BLUEDROID_ENABLED
This option can be disabled when the app work only on gatt client mode
CONFIG_GATTS_BLUFI_ENABLE¶
Include blufi function
Found in: Component config > Bluetooth > CONFIG_BLUEDROID_ENABLED > CONFIG_GATTS_ENABLE
This option can be close when the app does not require blufi function.
CONFIG_GATTS_SEND_SERVICE_CHANGE_MODE¶
GATTS Service Change Mode
Found in: Component config > Bluetooth > CONFIG_BLUEDROID_ENABLED > CONFIG_GATTS_ENABLE
Service change indication mode for GATT Server.
- Available options:
GATTS manually send service change indication (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 (GATTS_SEND_SERVICE_CHANGE_AUTO)
Let Bluedroid handle the service change indication internally
CONFIG_GATTC_ENABLE¶
Include GATT client module(GATTC)
Found in: Component config > Bluetooth > CONFIG_BLUEDROID_ENABLED
This option can be close when the app work only on gatt server mode
CONFIG_GATTC_CACHE_NVS_FLASH¶
Save gattc cache data to nvs flash
Found in: Component config > Bluetooth > CONFIG_BLUEDROID_ENABLED > CONFIG_GATTC_ENABLE
This select can save gattc cache data to nvs flash
CONFIG_BLE_SMP_ENABLE¶
Include BLE security module(SMP)
Found in: Component config > Bluetooth > CONFIG_BLUEDROID_ENABLED
This option can be close when the app not used the ble security connect.
CONFIG_SMP_SLAVE_CON_PARAMS_UPD_ENABLE¶
Slave enable connection parameters update during pairing
Found in: Component config > Bluetooth > CONFIG_BLUEDROID_ENABLED > CONFIG_BLE_SMP_ENABLE
In order to reduce the pairing time, slave actively initiates connection parameters update during pairing.
CONFIG_BT_STACK_NO_LOG¶
Disable BT debug logs (minimize bin size)
Found in: Component config > Bluetooth > CONFIG_BLUEDROID_ENABLED
This select can save the rodata code size
CONFIG_HCI_INITIAL_TRACE_LEVEL¶
HCI layer
Found in: Component config > Bluetooth > CONFIG_BLUEDROID_ENABLED > BT DEBUG LOG LEVEL
Define BT trace level for HCI layer
- Available options:
NONE (HCI_TRACE_LEVEL_NONE)
ERROR (HCI_TRACE_LEVEL_ERROR)
WARNING (HCI_TRACE_LEVEL_WARNING)
API (HCI_TRACE_LEVEL_API)
EVENT (HCI_TRACE_LEVEL_EVENT)
DEBUG (HCI_TRACE_LEVEL_DEBUG)
VERBOSE (HCI_TRACE_LEVEL_VERBOSE)
CONFIG_BTM_INITIAL_TRACE_LEVEL¶
BTM layer
Found in: Component config > Bluetooth > CONFIG_BLUEDROID_ENABLED > BT DEBUG LOG LEVEL
Define BT trace level for BTM layer
- Available options:
NONE (BTM_TRACE_LEVEL_NONE)
ERROR (BTM_TRACE_LEVEL_ERROR)
WARNING (BTM_TRACE_LEVEL_WARNING)
API (BTM_TRACE_LEVEL_API)
EVENT (BTM_TRACE_LEVEL_EVENT)
DEBUG (BTM_TRACE_LEVEL_DEBUG)
VERBOSE (BTM_TRACE_LEVEL_VERBOSE)
CONFIG_L2CAP_INITIAL_TRACE_LEVEL¶
L2CAP layer
Found in: Component config > Bluetooth > CONFIG_BLUEDROID_ENABLED > BT DEBUG LOG LEVEL
Define BT trace level for L2CAP layer
- Available options:
NONE (L2CAP_TRACE_LEVEL_NONE)
ERROR (L2CAP_TRACE_LEVEL_ERROR)
WARNING (L2CAP_TRACE_LEVEL_WARNING)
API (L2CAP_TRACE_LEVEL_API)
EVENT (L2CAP_TRACE_LEVEL_EVENT)
DEBUG (L2CAP_TRACE_LEVEL_DEBUG)
VERBOSE (L2CAP_TRACE_LEVEL_VERBOSE)
CONFIG_RFCOMM_INITIAL_TRACE_LEVEL¶
RFCOMM layer
Found in: Component config > Bluetooth > CONFIG_BLUEDROID_ENABLED > BT DEBUG LOG LEVEL
Define BT trace level for RFCOMM layer
- Available options:
NONE (RFCOMM_TRACE_LEVEL_NONE)
ERROR (RFCOMM_TRACE_LEVEL_ERROR)
WARNING (RFCOMM_TRACE_LEVEL_WARNING)
API (RFCOMM_TRACE_LEVEL_API)
EVENT (RFCOMM_TRACE_LEVEL_EVENT)
DEBUG (RFCOMM_TRACE_LEVEL_DEBUG)
VERBOSE (RFCOMM_TRACE_LEVEL_VERBOSE)
CONFIG_SDP_INITIAL_TRACE_LEVEL¶
SDP layer
Found in: Component config > Bluetooth > CONFIG_BLUEDROID_ENABLED > BT DEBUG LOG LEVEL
Define BT trace level for SDP layer
- Available options:
NONE (SDP_TRACE_LEVEL_NONE)
ERROR (SDP_TRACE_LEVEL_ERROR)
WARNING (SDP_TRACE_LEVEL_WARNING)
API (SDP_TRACE_LEVEL_API)
EVENT (SDP_TRACE_LEVEL_EVENT)
DEBUG (SDP_TRACE_LEVEL_DEBUG)
VERBOSE (SDP_TRACE_LEVEL_VERBOSE)
CONFIG_GAP_INITIAL_TRACE_LEVEL¶
GAP layer
Found in: Component config > Bluetooth > CONFIG_BLUEDROID_ENABLED > BT DEBUG LOG LEVEL
Define BT trace level for GAP layer
- Available options:
NONE (GAP_TRACE_LEVEL_NONE)
ERROR (GAP_TRACE_LEVEL_ERROR)
WARNING (GAP_TRACE_LEVEL_WARNING)
API (GAP_TRACE_LEVEL_API)
EVENT (GAP_TRACE_LEVEL_EVENT)
DEBUG (GAP_TRACE_LEVEL_DEBUG)
VERBOSE (GAP_TRACE_LEVEL_VERBOSE)
CONFIG_BNEP_INITIAL_TRACE_LEVEL¶
BNEP layer
Found in: Component config > Bluetooth > CONFIG_BLUEDROID_ENABLED > BT DEBUG LOG LEVEL
Define BT trace level for BNEP layer
- Available options:
NONE (BNEP_TRACE_LEVEL_NONE)
ERROR (BNEP_TRACE_LEVEL_ERROR)
WARNING (BNEP_TRACE_LEVEL_WARNING)
API (BNEP_TRACE_LEVEL_API)
EVENT (BNEP_TRACE_LEVEL_EVENT)
DEBUG (BNEP_TRACE_LEVEL_DEBUG)
VERBOSE (BNEP_TRACE_LEVEL_VERBOSE)
CONFIG_PAN_INITIAL_TRACE_LEVEL¶
PAN layer
Found in: Component config > Bluetooth > CONFIG_BLUEDROID_ENABLED > BT DEBUG LOG LEVEL
Define BT trace level for PAN layer
- Available options:
NONE (PAN_TRACE_LEVEL_NONE)
ERROR (PAN_TRACE_LEVEL_ERROR)
WARNING (PAN_TRACE_LEVEL_WARNING)
API (PAN_TRACE_LEVEL_API)
EVENT (PAN_TRACE_LEVEL_EVENT)
DEBUG (PAN_TRACE_LEVEL_DEBUG)
VERBOSE (PAN_TRACE_LEVEL_VERBOSE)
CONFIG_A2D_INITIAL_TRACE_LEVEL¶
A2D layer
Found in: Component config > Bluetooth > CONFIG_BLUEDROID_ENABLED > BT DEBUG LOG LEVEL
Define BT trace level for A2D layer
- Available options:
NONE (A2D_TRACE_LEVEL_NONE)
ERROR (A2D_TRACE_LEVEL_ERROR)
WARNING (A2D_TRACE_LEVEL_WARNING)
API (A2D_TRACE_LEVEL_API)
EVENT (A2D_TRACE_LEVEL_EVENT)
DEBUG (A2D_TRACE_LEVEL_DEBUG)
VERBOSE (A2D_TRACE_LEVEL_VERBOSE)
CONFIG_AVDT_INITIAL_TRACE_LEVEL¶
AVDT layer
Found in: Component config > Bluetooth > CONFIG_BLUEDROID_ENABLED > BT DEBUG LOG LEVEL
Define BT trace level for AVDT layer
- Available options:
NONE (AVDT_TRACE_LEVEL_NONE)
ERROR (AVDT_TRACE_LEVEL_ERROR)
WARNING (AVDT_TRACE_LEVEL_WARNING)
API (AVDT_TRACE_LEVEL_API)
EVENT (AVDT_TRACE_LEVEL_EVENT)
DEBUG (AVDT_TRACE_LEVEL_DEBUG)
VERBOSE (AVDT_TRACE_LEVEL_VERBOSE)
CONFIG_AVCT_INITIAL_TRACE_LEVEL¶
AVCT layer
Found in: Component config > Bluetooth > CONFIG_BLUEDROID_ENABLED > BT DEBUG LOG LEVEL
Define BT trace level for AVCT layer
- Available options:
NONE (AVCT_TRACE_LEVEL_NONE)
ERROR (AVCT_TRACE_LEVEL_ERROR)
WARNING (AVCT_TRACE_LEVEL_WARNING)
API (AVCT_TRACE_LEVEL_API)
EVENT (AVCT_TRACE_LEVEL_EVENT)
DEBUG (AVCT_TRACE_LEVEL_DEBUG)
VERBOSE (AVCT_TRACE_LEVEL_VERBOSE)
CONFIG_AVRC_INITIAL_TRACE_LEVEL¶
AVRC layer
Found in: Component config > Bluetooth > CONFIG_BLUEDROID_ENABLED > BT DEBUG LOG LEVEL
Define BT trace level for AVRC layer
- Available options:
NONE (AVRC_TRACE_LEVEL_NONE)
ERROR (AVRC_TRACE_LEVEL_ERROR)
WARNING (AVRC_TRACE_LEVEL_WARNING)
API (AVRC_TRACE_LEVEL_API)
EVENT (AVRC_TRACE_LEVEL_EVENT)
DEBUG (AVRC_TRACE_LEVEL_DEBUG)
VERBOSE (AVRC_TRACE_LEVEL_VERBOSE)
CONFIG_MCA_INITIAL_TRACE_LEVEL¶
MCA layer
Found in: Component config > Bluetooth > CONFIG_BLUEDROID_ENABLED > BT DEBUG LOG LEVEL
Define BT trace level for MCA layer
- Available options:
NONE (MCA_TRACE_LEVEL_NONE)
ERROR (MCA_TRACE_LEVEL_ERROR)
WARNING (MCA_TRACE_LEVEL_WARNING)
API (MCA_TRACE_LEVEL_API)
EVENT (MCA_TRACE_LEVEL_EVENT)
DEBUG (MCA_TRACE_LEVEL_DEBUG)
VERBOSE (MCA_TRACE_LEVEL_VERBOSE)
CONFIG_HID_INITIAL_TRACE_LEVEL¶
HID layer
Found in: Component config > Bluetooth > CONFIG_BLUEDROID_ENABLED > BT DEBUG LOG LEVEL
Define BT trace level for HID layer
- Available options:
NONE (HID_TRACE_LEVEL_NONE)
ERROR (HID_TRACE_LEVEL_ERROR)
WARNING (HID_TRACE_LEVEL_WARNING)
API (HID_TRACE_LEVEL_API)
EVENT (HID_TRACE_LEVEL_EVENT)
DEBUG (HID_TRACE_LEVEL_DEBUG)
VERBOSE (HID_TRACE_LEVEL_VERBOSE)
CONFIG_APPL_INITIAL_TRACE_LEVEL¶
APPL layer
Found in: Component config > Bluetooth > CONFIG_BLUEDROID_ENABLED > BT DEBUG LOG LEVEL
Define BT trace level for APPL layer
- Available options:
NONE (APPL_TRACE_LEVEL_NONE)
ERROR (APPL_TRACE_LEVEL_ERROR)
WARNING (APPL_TRACE_LEVEL_WARNING)
API (APPL_TRACE_LEVEL_API)
EVENT (APPL_TRACE_LEVEL_EVENT)
DEBUG (APPL_TRACE_LEVEL_DEBUG)
VERBOSE (APPL_TRACE_LEVEL_VERBOSE)
CONFIG_GATT_INITIAL_TRACE_LEVEL¶
GATT layer
Found in: Component config > Bluetooth > CONFIG_BLUEDROID_ENABLED > BT DEBUG LOG LEVEL
Define BT trace level for GATT layer
- Available options:
NONE (GATT_TRACE_LEVEL_NONE)
ERROR (GATT_TRACE_LEVEL_ERROR)
WARNING (GATT_TRACE_LEVEL_WARNING)
API (GATT_TRACE_LEVEL_API)
EVENT (GATT_TRACE_LEVEL_EVENT)
DEBUG (GATT_TRACE_LEVEL_DEBUG)
VERBOSE (GATT_TRACE_LEVEL_VERBOSE)
CONFIG_SMP_INITIAL_TRACE_LEVEL¶
SMP layer
Found in: Component config > Bluetooth > CONFIG_BLUEDROID_ENABLED > BT DEBUG LOG LEVEL
Define BT trace level for SMP layer
- Available options:
NONE (SMP_TRACE_LEVEL_NONE)
ERROR (SMP_TRACE_LEVEL_ERROR)
WARNING (SMP_TRACE_LEVEL_WARNING)
API (SMP_TRACE_LEVEL_API)
EVENT (SMP_TRACE_LEVEL_EVENT)
DEBUG (SMP_TRACE_LEVEL_DEBUG)
VERBOSE (SMP_TRACE_LEVEL_VERBOSE)
CONFIG_BTIF_INITIAL_TRACE_LEVEL¶
BTIF layer
Found in: Component config > Bluetooth > CONFIG_BLUEDROID_ENABLED > BT DEBUG LOG LEVEL
Define BT trace level for BTIF layer
- Available options:
NONE (BTIF_TRACE_LEVEL_NONE)
ERROR (BTIF_TRACE_LEVEL_ERROR)
WARNING (BTIF_TRACE_LEVEL_WARNING)
API (BTIF_TRACE_LEVEL_API)
EVENT (BTIF_TRACE_LEVEL_EVENT)
DEBUG (BTIF_TRACE_LEVEL_DEBUG)
VERBOSE (BTIF_TRACE_LEVEL_VERBOSE)
CONFIG_BTC_INITIAL_TRACE_LEVEL¶
BTC layer
Found in: Component config > Bluetooth > CONFIG_BLUEDROID_ENABLED > BT DEBUG LOG LEVEL
Define BT trace level for BTC layer
- Available options:
NONE (BTC_TRACE_LEVEL_NONE)
ERROR (BTC_TRACE_LEVEL_ERROR)
WARNING (BTC_TRACE_LEVEL_WARNING)
API (BTC_TRACE_LEVEL_API)
EVENT (BTC_TRACE_LEVEL_EVENT)
DEBUG (BTC_TRACE_LEVEL_DEBUG)
VERBOSE (BTC_TRACE_LEVEL_VERBOSE)
CONFIG_OSI_INITIAL_TRACE_LEVEL¶
OSI layer
Found in: Component config > Bluetooth > CONFIG_BLUEDROID_ENABLED > BT DEBUG LOG LEVEL
Define BT trace level for OSI layer
- Available options:
NONE (OSI_TRACE_LEVEL_NONE)
ERROR (OSI_TRACE_LEVEL_ERROR)
WARNING (OSI_TRACE_LEVEL_WARNING)
API (OSI_TRACE_LEVEL_API)
EVENT (OSI_TRACE_LEVEL_EVENT)
DEBUG (OSI_TRACE_LEVEL_DEBUG)
VERBOSE (OSI_TRACE_LEVEL_VERBOSE)
CONFIG_BLUFI_INITIAL_TRACE_LEVEL¶
BLUFI layer
Found in: Component config > Bluetooth > CONFIG_BLUEDROID_ENABLED > BT DEBUG LOG LEVEL
Define BT trace level for BLUFI layer
- Available options:
NONE (BLUFI_TRACE_LEVEL_NONE)
ERROR (BLUFI_TRACE_LEVEL_ERROR)
WARNING (BLUFI_TRACE_LEVEL_WARNING)
API (BLUFI_TRACE_LEVEL_API)
EVENT (BLUFI_TRACE_LEVEL_EVENT)
DEBUG (BLUFI_TRACE_LEVEL_DEBUG)
VERBOSE (BLUFI_TRACE_LEVEL_VERBOSE)
CONFIG_BT_ACL_CONNECTIONS¶
BT/BLE MAX ACL CONNECTIONS(1~7)
Found in: Component config > Bluetooth > CONFIG_BLUEDROID_ENABLED
Maximum BT/BLE connection count
CONFIG_BT_ALLOCATION_FROM_SPIRAM_FIRST¶
BT/BLE will first malloc the memory from the PSRAM
Found in: Component config > Bluetooth > CONFIG_BLUEDROID_ENABLED
This select can save the internal RAM if there have the PSRAM
CONFIG_BT_BLE_DYNAMIC_ENV_MEMORY¶
Use dynamic memory allocation in BT/BLE stack
Found in: Component config > Bluetooth > CONFIG_BLUEDROID_ENABLED
This select can make the allocation of memory will become more flexible
CONFIG_BLE_HOST_QUEUE_CONGESTION_CHECK¶
BLE queue congestion check
Found in: Component config > Bluetooth > CONFIG_BLUEDROID_ENABLED
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.
CONFIG_BLE_ACTIVE_SCAN_REPORT_ADV_SCAN_RSP_INDIVIDUALLY¶
Report adv data and scan response individually when BLE active scan
Found in: Component config > Bluetooth > CONFIG_BLUEDROID_ENABLED
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
CONFIG_BLE_ESTABLISH_LINK_CONNECTION_TIMEOUT¶
Timeout of BLE connection establishment
Found in: Component config > Bluetooth > CONFIG_BLUEDROID_ENABLED
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.
CONFIG_NIMBLE_ENABLED¶
Contains:
CONFIG_NIMBLE_MEM_ALLOC_MODE¶
Memory allocation strategy
Found in: Component config > Bluetooth > CONFIG_NIMBLE_ENABLED
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
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.
- Available options:
Internal memory (NIMBLE_MEM_ALLOC_MODE_INTERNAL)
External SPIRAM (NIMBLE_MEM_ALLOC_MODE_EXTERNAL)
Default alloc mode (NIMBLE_MEM_ALLOC_MODE_DEFAULT)
CONFIG_NIMBLE_MAX_CONNECTIONS¶
Maximum number of concurrent connections
Found in: Component config > Bluetooth > CONFIG_NIMBLE_ENABLED
Defines maximum number of concurrent BLE connections
CONFIG_NIMBLE_MAX_BONDS¶
Maximum number of bonds to save across reboots
Found in: Component config > Bluetooth > CONFIG_NIMBLE_ENABLED
Defines maximum number of bonds to save for peer security and our security
CONFIG_NIMBLE_MAX_CCCDS¶
Maximum number of CCC descriptors to save across reboots
Found in: Component config > Bluetooth > CONFIG_NIMBLE_ENABLED
Defines maximum number of CCC descriptors to save
CONFIG_NIMBLE_L2CAP_COC_MAX_NUM¶
Maximum number of connection oriented channels
Found in: Component config > Bluetooth > CONFIG_NIMBLE_ENABLED
Defines maximum number of BLE Connection Oriented Channels. When set to (0), BLE COC is not compiled in
CONFIG_NIMBLE_PINNED_TO_CORE_CHOICE¶
The CPU core on which NimBLE host will run
Found in: Component config > Bluetooth > CONFIG_NIMBLE_ENABLED
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) (NIMBLE_PINNED_TO_CORE_0)
Core 1 (APP CPU) (NIMBLE_PINNED_TO_CORE_1)
CONFIG_NIMBLE_TASK_STACK_SIZE¶
NimBLE Host task stack size
Found in: Component config > Bluetooth > CONFIG_NIMBLE_ENABLED
This configures stack size of NimBLE host task
CONFIG_NIMBLE_ROLE_CENTRAL¶
Enable BLE Central role
Found in: Component config > Bluetooth > CONFIG_NIMBLE_ENABLED
CONFIG_NIMBLE_ROLE_PERIPHERAL¶
Enable BLE Peripheral role
Found in: Component config > Bluetooth > CONFIG_NIMBLE_ENABLED
CONFIG_NIMBLE_ROLE_BROADCASTER¶
Enable BLE Broadcaster role
Found in: Component config > Bluetooth > CONFIG_NIMBLE_ENABLED
CONFIG_NIMBLE_ROLE_OBSERVER¶
Enable BLE Observer role
Found in: Component config > Bluetooth > CONFIG_NIMBLE_ENABLED
CONFIG_NIMBLE_NVS_PERSIST¶
Persist the BLE Bonding keys in NVS
Found in: Component config > Bluetooth > CONFIG_NIMBLE_ENABLED
Enable this flag to make bonding persistent across device reboots
CONFIG_NIMBLE_SM_LEGACY¶
Security manager legacy pairing
Found in: Component config > Bluetooth > CONFIG_NIMBLE_ENABLED
Enable security manager legacy pairing
CONFIG_NIMBLE_SM_SC¶
Security manager secure connections (4.2)
Found in: Component config > Bluetooth > CONFIG_NIMBLE_ENABLED
Enable security manager secure connections
CONFIG_NIMBLE_DEBUG¶
Enable extra runtime asserts and host debugging
Found in: Component config > Bluetooth > CONFIG_NIMBLE_ENABLED
This enables extra runtime asserts and host debugging
CONFIG_NIMBLE_SM_SC_DEBUG_KEYS¶
Use predefined public-private key pair
Found in: Component config > Bluetooth > CONFIG_NIMBLE_ENABLED
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.
CONFIG_NIMBLE_SVC_GAP_DEVICE_NAME¶
BLE GAP default device name
Found in: Component config > Bluetooth > CONFIG_NIMBLE_ENABLED
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()
CONFIG_NIMBLE_GAP_DEVICE_NAME_MAX_LEN¶
Maximum length of BLE device name in octets
Found in: Component config > Bluetooth > CONFIG_NIMBLE_ENABLED
Device Name characteristic value shall be 0 to 248 octets in length
CONFIG_NIMBLE_ATT_PREFERRED_MTU¶
Preferred MTU size in octets
Found in: Component config > Bluetooth > CONFIG_NIMBLE_ENABLED
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()
CONFIG_NIMBLE_SVC_GAP_APPEARANCE¶
External appearance of the device
Found in: Component config > Bluetooth > CONFIG_NIMBLE_ENABLED
Standard BLE GAP Appearance value in HEX format e.g. 0x02C0
CONFIG_NIMBLE_ACL_BUF_COUNT¶
ACL Buffer count
Found in: Component config > Bluetooth > CONFIG_NIMBLE_ENABLED
The number of ACL data buffers.
CONFIG_NIMBLE_ACL_BUF_SIZE¶
ACL Buffer size
Found in: Component config > Bluetooth > CONFIG_NIMBLE_ENABLED
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)
CONFIG_NIMBLE_HCI_EVT_BUF_SIZE¶
HCI Event Buffer size
Found in: Component config > Bluetooth > CONFIG_NIMBLE_ENABLED
This is the size of each HCI event buffer in bytes
CONFIG_NIMBLE_HCI_EVT_HI_BUF_COUNT¶
High Priority HCI Event Buffer count
Found in: Component config > Bluetooth > CONFIG_NIMBLE_ENABLED
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
CONFIG_NIMBLE_HCI_EVT_LO_BUF_COUNT¶
Low Priority HCI Event Buffer count
Found in: Component config > Bluetooth > CONFIG_NIMBLE_ENABLED
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
CONFIG_NIMBLE_MSYS1_BLOCK_COUNT¶
MSYS_1 Block Count
Found in: Component config > Bluetooth > CONFIG_NIMBLE_ENABLED
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.
CONFIG_NIMBLE_HS_FLOW_CTRL¶
Enable Host Flow control
Found in: Component config > Bluetooth > CONFIG_NIMBLE_ENABLED
Enable Host Flow control
CONFIG_NIMBLE_HS_FLOW_CTRL_ITVL¶
Host Flow control interval
Found in: Component config > Bluetooth > CONFIG_NIMBLE_ENABLED > CONFIG_NIMBLE_HS_FLOW_CTRL
Host flow control interval in msecs
CONFIG_NIMBLE_HS_FLOW_CTRL_THRESH¶
Host Flow control threshold
Found in: Component config > Bluetooth > CONFIG_NIMBLE_ENABLED > CONFIG_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
CONFIG_NIMBLE_HS_FLOW_CTRL_TX_ON_DISCONNECT¶
Host Flow control on disconnect
Found in: Component config > Bluetooth > CONFIG_NIMBLE_ENABLED > CONFIG_NIMBLE_HS_FLOW_CTRL
Enable this option to send number-of-completed-packets event to controller after disconnection
CONFIG_NIMBLE_RPA_TIMEOUT¶
RPA timeout in seconds
Found in: Component config > Bluetooth > CONFIG_NIMBLE_ENABLED
Time interval between RPA address change. This is applicable in case of Host based RPA
CONFIG_NIMBLE_MESH¶
Enable BLE mesh functionality
Found in: Component config > Bluetooth > CONFIG_NIMBLE_ENABLED
Enable BLE Mesh functionality
Contains:
CONFIG_NIMBLE_MESH_PROXY¶
Enable mesh proxy functionality
Found in: Component config > Bluetooth > CONFIG_NIMBLE_ENABLED > CONFIG_NIMBLE_MESH
Enable proxy. This is automatically set whenever NIMBLE_MESH_PB_GATT or NIMBLE_MESH_GATT_PROXY is set
CONFIG_NIMBLE_MESH_PROV¶
Enable BLE mesh provisioning
Found in: Component config > Bluetooth > CONFIG_NIMBLE_ENABLED > CONFIG_NIMBLE_MESH
Enable mesh provisioning
CONFIG_NIMBLE_MESH_PB_ADV¶
Enable mesh provisioning over advertising bearer
Found in: Component config > Bluetooth > CONFIG_NIMBLE_ENABLED > CONFIG_NIMBLE_MESH > CONFIG_NIMBLE_MESH_PROV
Enable this option to allow the device to be provisioned over the advertising bearer
CONFIG_NIMBLE_MESH_PB_GATT¶
Enable mesh provisioning over GATT bearer
Found in: Component config > Bluetooth > CONFIG_NIMBLE_ENABLED > CONFIG_NIMBLE_MESH > CONFIG_NIMBLE_MESH_PROV
Enable this option to allow the device to be provisioned over the GATT bearer
CONFIG_NIMBLE_MESH_GATT_PROXY¶
Enable GATT Proxy functionality
Found in: Component config > Bluetooth > CONFIG_NIMBLE_ENABLED > CONFIG_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
CONFIG_NIMBLE_MESH_RELAY¶
Enable mesh relay functionality
Found in: Component config > Bluetooth > CONFIG_NIMBLE_ENABLED > CONFIG_NIMBLE_MESH
Support for acting as a Mesh Relay Node
CONFIG_NIMBLE_MESH_LOW_POWER¶
Enable mesh low power mode
Found in: Component config > Bluetooth > CONFIG_NIMBLE_ENABLED > CONFIG_NIMBLE_MESH
Enable this option to be able to act as a Low Power Node
CONFIG_NIMBLE_MESH_FRIEND¶
Enable mesh friend functionality
Found in: Component config > Bluetooth > CONFIG_NIMBLE_ENABLED > CONFIG_NIMBLE_MESH
Enable this option to be able to act as a Friend Node
CONFIG_NIMBLE_MESH_DEVICE_NAME¶
Set mesh device name
Found in: Component config > Bluetooth > CONFIG_NIMBLE_ENABLED > CONFIG_NIMBLE_MESH
This value defines Bluetooth Mesh device/node name
CONFIG_NIMBLE_CRYPTO_STACK_MBEDTLS¶
Override TinyCrypt with mbedTLS for crypto computations
Found in: Component config > Bluetooth > CONFIG_NIMBLE_ENABLED
Enable this option to choose mbedTLS instead of TinyCrypt for crypto computations.
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.
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”.
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
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.
- Available options:
Internal DRAM (BLE_MESH_MEM_ALLOC_MODE_INTERNAL)
External SPIRAM (BLE_MESH_ALLOC_FROM_PSRAM_FIRST)
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.
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) 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.
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.
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.
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.
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.
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.
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.
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).
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 then 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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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).
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
CONFIG_ADC2_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 disables 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.
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\_resultandtransmitfunctions into the IRAM to avoid possible cache miss.During unit test, this is enabled to measure the ideal case of api.
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.
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\_resultandtransmitfunctions into the IRAM to avoid possible cache miss.
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.
CAN Configuration¶
Contains:
CONFIG_CAN_ISR_IN_IRAM¶
Place CAN ISR function into IRAM
Found in: Component config > Driver configurations > CAN Configuration
Place the CAN 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 CAN_ALERT_AND_LOG flag) will have no effect.
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.
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.
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.
CONFIG_EFUSE_VIRTUAL¶
Simulate eFuse operations in RAM
Found in: Component config > eFuse Bit Manager
All read and writes operations are redirected to RAM instead of eFuse registers. If this option is set, all permanent changes (via eFuse) are disabled. Log output will state changes which would be applied, but they will not be.
CONFIG_EFUSE_CODE_SCHEME_SELECTOR¶
Coding Scheme Compatibility
Found in: Component config > eFuse Bit Manager
Selector eFuse code scheme.
- Available options:
None Only (EFUSE_CODE_SCHEME_COMPAT_NONE)
3/4 and None (EFUSE_CODE_SCHEME_COMPAT_3_4)
Repeat, 3/4 and None (common table does not support it) (EFUSE_CODE_SCHEME_COMPAT_REPEAT)
ESP32-specific¶
Contains:
CONFIG_ESP32_REV_MIN¶
Minimum Supported ESP32 Revision
Found in: Component config > ESP32-specific
Minimum revision that ESP-IDF would support. ESP-IDF performs different strategy on different esp32 revision.
- Available options:
Rev 0 (ESP32_REV_MIN_0)
Rev 1 (ESP32_REV_MIN_1)
Rev 2 (ESP32_REV_MIN_2)
Rev 3 (ESP32_REV_MIN_3)
CONFIG_ESP32_DEFAULT_CPU_FREQ_MHZ¶
CPU frequency
Found in: Component config > ESP32-specific
CPU frequency to be set on application startup.
- Available options:
80 MHz (ESP32_DEFAULT_CPU_FREQ_80)
160 MHz (ESP32_DEFAULT_CPU_FREQ_160)
240 MHz (ESP32_DEFAULT_CPU_FREQ_240)
CONFIG_SPIRAM_SUPPORT¶
Support for external, SPI-connected RAM
Found in: Component config > ESP32-specific
This enables support for an external SPI RAM chip, connected in parallel with the main SPI flash chip.
CONFIG_SPIRAM_BOOT_INIT¶
Initialize SPI RAM when booting the ESP32
Found in: Component config > ESP32-specific > CONFIG_SPIRAM_SUPPORT > SPI RAM config
If this is enabled, the SPI RAM will be enabled during initial boot. Unless you have specific requirements, you’ll want to leave this enabled so memory allocated during boot-up can also be placed in SPI RAM.
CONFIG_SPIRAM_IGNORE_NOTFOUND¶
Ignore PSRAM when not found
Found in: Component config > ESP32-specific > CONFIG_SPIRAM_SUPPORT > SPI RAM config > CONFIG_SPIRAM_BOOT_INIT
Normally, if psram initialization is enabled during compile time but not found at runtime, it is seen as an error making the ESP32 panic. If this is enabled, the ESP32 will keep on running but will not add the (non-existing) RAM to any allocator.
CONFIG_SPIRAM_USE¶
SPI RAM access method
Found in: Component config > ESP32-specific > CONFIG_SPIRAM_SUPPORT > SPI RAM config
The SPI RAM can be accessed in multiple methods: by just having it available as an unmanaged memory region in the ESP32 memory map, by integrating it in the ESP32s heap as ‘special’ memory needing heap_caps_malloc to allocate, or by fully integrating it making malloc() also able to return SPI RAM pointers.
- Available options:
Integrate RAM into ESP32 memory map (SPIRAM_USE_MEMMAP)
Make RAM allocatable using heap_caps_malloc(…, MALLOC_CAP_SPIRAM) (SPIRAM_USE_CAPS_ALLOC)
Make RAM allocatable using malloc() as well (SPIRAM_USE_MALLOC)
CONFIG_SPIRAM_TYPE¶
Type of SPI RAM chip in use
Found in: Component config > ESP32-specific > CONFIG_SPIRAM_SUPPORT > SPI RAM config
- Available options:
Auto-detect (SPIRAM_TYPE_AUTO)
ESP-PSRAM16 or APS1604 (SPIRAM_TYPE_ESPPSRAM16)
ESP-PSRAM32 or IS25WP032 (SPIRAM_TYPE_ESPPSRAM32)
ESP-PSRAM64 or LY68L6400 (SPIRAM_TYPE_ESPPSRAM64)
CONFIG_SPIRAM_SPEED¶
Set RAM clock speed
Found in: Component config > ESP32-specific > CONFIG_SPIRAM_SUPPORT > SPI RAM config
Select the speed for the SPI RAM chip. If SPI RAM is enabled, we only support three combinations of SPI speed mode we supported now:
Flash SPI running at 40Mhz and RAM SPI running at 40Mhz
Flash SPI running at 80Mhz and RAM SPI running at 40Mhz
Flash SPI running at 80Mhz and RAM SPI running at 80Mhz
Note: If the third mode(80Mhz+80Mhz) is enabled for SPI RAM of type 32MBit, one of the HSPI/VSPI host will be occupied by the system. Which SPI host to use can be selected by the config item SPIRAM_OCCUPY_SPI_HOST. Application code should never touch HSPI/VSPI hardware in this case. The option to select 80MHz will only be visible if the flash SPI speed is also 80MHz. (ESPTOOLPY_FLASHFREQ_80M is true)
- Available options:
40MHz clock speed (SPIRAM_SPEED_40M)
80MHz clock speed (SPIRAM_SPEED_80M)
CONFIG_SPIRAM_MEMTEST¶
Run memory test on SPI RAM initialization
Found in: Component config > ESP32-specific > CONFIG_SPIRAM_SUPPORT > SPI RAM config
Runs a rudimentary memory test on initialization. Aborts when memory test fails. Disable this for slightly faster startop.
CONFIG_SPIRAM_CACHE_WORKAROUND¶
Enable workaround for bug in SPI RAM cache for Rev1 ESP32s
Found in: Component config > ESP32-specific > CONFIG_SPIRAM_SUPPORT > SPI RAM config
Revision 1 of the ESP32 has a bug that can cause a write to PSRAM not to take place in some situations when the cache line needs to be fetched from external RAM and an interrupt occurs. This enables a fix in the compiler (-mfix-esp32-psram-cache-issue) that makes sure the specific code that is vulnerable to this will not be emitted.
This will also not use any bits of newlib that are located in ROM, opting for a version that is compiled with the workaround and located in flash instead.
The workaround is not required for ESP32 revision 3 and above.
CONFIG_SPIRAM_BANKSWITCH_ENABLE¶
Enable bank switching for >4MiB external RAM
Found in: Component config > ESP32-specific > CONFIG_SPIRAM_SUPPORT > SPI RAM config
The ESP32 only supports 4MiB of external RAM in its address space. The hardware does support larger memories, but these have to be bank-switched in and out of this address space. Enabling this allows you to reserve some MMU pages for this, which allows the use of the esp_himem api to manage these banks.
#Note that this is limited to 62 banks, as esp_spiram_writeback_cache needs some kind of mapping of #some banks below that mark to work. We cannot at this moment guarantee this to exist when himem is #enabled.
If spiram 2T mode is enabled, the size of 64Mbit psram will be changed as 32Mbit, so himem will be unusable.
CONFIG_SPIRAM_BANKSWITCH_RESERVE¶
Amount of 32K pages to reserve for bank switching
Found in: Component config > ESP32-specific > CONFIG_SPIRAM_SUPPORT > SPI RAM config > CONFIG_SPIRAM_BANKSWITCH_ENABLE
Select the amount of banks reserved for bank switching. Note that the amount of RAM allocatable with malloc/esp_heap_alloc_caps will decrease by 32K for each page reserved here.
Note that this reservation is only actually done if your program actually uses the himem API. Without any himem calls, the reservation is not done and the original amount of memory will be available to malloc/esp_heap_alloc_caps.
CONFIG_SPIRAM_MALLOC_ALWAYSINTERNAL¶
Maximum malloc() size, in bytes, to always put in internal memory
Found in: Component config > ESP32-specific > CONFIG_SPIRAM_SUPPORT > SPI RAM config
If malloc() is capable of also allocating SPI-connected ram, its allocation strategy will prefer to allocate chunks less than this size in internal memory, while allocations larger than this will be done from external RAM. If allocation from the preferred region fails, an attempt is made to allocate from the non-preferred region instead, so malloc() will not suddenly fail when either internal or external memory is full.
CONFIG_WIFI_LWIP_ALLOCATION_FROM_SPIRAM_FIRST¶
Try to allocate memories of WiFi and LWIP in SPIRAM firstly. If failed, allocate internal memory
Found in: Component config > ESP32-specific > CONFIG_SPIRAM_SUPPORT > SPI RAM config
Try to allocate memories of WiFi and LWIP in SPIRAM firstly. If failed, try to allocate internal memory then.
CONFIG_SPIRAM_MALLOC_RESERVE_INTERNAL¶
Reserve this amount of bytes for data that specifically needs to be in DMA or internal memory
Found in: Component config > ESP32-specific > CONFIG_SPIRAM_SUPPORT > SPI RAM config
Because the external/internal RAM allocation strategy is not always perfect, it sometimes may happen that the internal memory is entirely filled up. This causes allocations that are specifically done in internal memory, for example the stack for new tasks or memory to service DMA or have memory that’s also available when SPI cache is down, to fail. This option reserves a pool specifically for requests like that; the memory in this pool is not given out when a normal malloc() is called.
Set this to 0 to disable this feature.
Note that because FreeRTOS stacks are forced to internal memory, they will also use this memory pool; be sure to keep this in mind when adjusting this value.
Note also that the DMA reserved pool may not be one single contiguous memory region, depending on the configured size and the static memory usage of the app.
CONFIG_SPIRAM_ALLOW_STACK_EXTERNAL_MEMORY¶
Allow external memory as an argument to xTaskCreateStatic
Found in: Component config > ESP32-specific > CONFIG_SPIRAM_SUPPORT > SPI RAM config
Because some bits of the ESP32 code environment cannot be recompiled with the cache workaround, normally tasks cannot be safely run with their stack residing in external memory; for this reason xTaskCreate and friends always allocate stack in internal memory and xTaskCreateStatic will check if the memory passed to it is in internal memory. If you have a task that needs a large amount of stack and does not call on ROM code in any way (no direct calls, but also no Bluetooth/WiFi), you can try to disable this and use xTaskCreateStatic to create the tasks stack in external memory.
CONFIG_SPIRAM_ALLOW_BSS_SEG_EXTERNAL_MEMORY¶
Allow .bss segment placed in external memory
Found in: Component config > ESP32-specific > CONFIG_SPIRAM_SUPPORT > SPI RAM config
If enabled the option,and add EXT_RAM_ATTR defined your variable,then your variable will be placed in PSRAM instead of internal memory, and placed most of variables of lwip,net802.11,pp,bluedroid library to external memory defaultly.
CONFIG_SPIRAM_OCCUPY_SPI_HOST¶
SPI host to use for 32MBit PSRAM
Found in: Component config > ESP32-specific > CONFIG_SPIRAM_SUPPORT > SPI RAM config
When both flash and PSRAM is working under 80MHz, and the PSRAM is of type 32MBit, one of the HSPI/VSPI host will be used to output the clock. Select which one to use here.
- Available options:
HSPI host (SPI2) (SPIRAM_OCCUPY_HSPI_HOST)
VSPI host (SPI3) (SPIRAM_OCCUPY_VSPI_HOST)
Will not try to use any host, will abort if not able to use the PSRAM (SPIRAM_OCCUPY_NO_HOST)
CONFIG_D0WD_PSRAM_CLK_IO¶
PSRAM CLK IO number
Found in: Component config > ESP32-specific > CONFIG_SPIRAM_SUPPORT > SPI RAM config > PSRAM clock and cs IO for ESP32-DOWD
The PSRAM CLOCK IO can be any unused GPIO, user can config it based on hardware design. If user use 1.8V flash and 1.8V psram, this value can only be one of 6, 7, 8, 9, 10, 11, 16, 17.
CONFIG_D0WD_PSRAM_CS_IO¶
PSRAM CS IO number
Found in: Component config > ESP32-specific > CONFIG_SPIRAM_SUPPORT > SPI RAM config > PSRAM clock and cs IO for ESP32-DOWD
The PSRAM CS IO can be any unused GPIO, user can config it based on hardware design. If user use 1.8V flash and 1.8V psram, this value can only be one of 6, 7, 8, 9, 10, 11, 16, 17.
CONFIG_D2WD_PSRAM_CLK_IO¶
PSRAM CLK IO number
Found in: Component config > ESP32-specific > CONFIG_SPIRAM_SUPPORT > SPI RAM config > PSRAM clock and cs IO for ESP32-D2WD
User can config it based on hardware design. For ESP32-D2WD chip, the psram can only be 1.8V psram, so this value can only be one of 6, 7, 8, 9, 10, 11, 16, 17.
CONFIG_D2WD_PSRAM_CS_IO¶
PSRAM CS IO number
Found in: Component config > ESP32-specific > CONFIG_SPIRAM_SUPPORT > SPI RAM config > PSRAM clock and cs IO for ESP32-D2WD
User can config it based on hardware design. For ESP32-D2WD chip, the psram can only be 1.8V psram, so this value can only be one of 6, 7, 8, 9, 10, 11, 16, 17.
CONFIG_PICO_PSRAM_CS_IO¶
PSRAM CS IO number
Found in: Component config > ESP32-specific > CONFIG_SPIRAM_SUPPORT > SPI RAM config > PSRAM clock and cs IO for ESP32-PICO
The PSRAM CS IO can be any unused GPIO, user can config it based on hardware design.
For ESP32-PICO chip, the psram share clock with flash, so user do not need to configure the clock IO. For the reference hardware design, please refer to https://www.espressif.com/sites/default/files/documentation/esp32-pico-d4_datasheet_en.pdf
CONFIG_SPIRAM_CUSTOM_SPIWP_SD3_PIN¶
Use custom SPI PSRAM WP(SD3) Pin when flash pins set in eFuse (read help)
Found in: Component config > ESP32-specific > CONFIG_SPIRAM_SUPPORT > SPI RAM config
This setting is only used if the SPI flash pins have been overridden by setting the eFuses SPI_PAD_CONFIG_xxx, and the SPI flash mode is DIO or DOUT.
When this is the case, the eFuse config only defines 3 of the 4 Quad I/O data pins. The WP pin (aka ESP32 pin “SD_DATA_3” or SPI flash pin “IO2”) is not specified in eFuse. The psram only has QPI mode, so a WP pin setting is necessary.
If this config item is set to N (default), the correct WP pin will be automatically used for any Espressif chip or module with integrated flash. If a custom setting is needed, set this config item to Y and specify the GPIO number connected to the WP pin.
When flash mode is set to QIO or QOUT, the PSRAM WP pin will be set the same as the SPI Flash WP pin configured in the bootloader.
CONFIG_SPIRAM_SPIWP_SD3_PIN¶
Custom SPI PSRAM WP(SD3) Pin
Found in: Component config > ESP32-specific > CONFIG_SPIRAM_SUPPORT > SPI RAM config
The option “Use custom SPI PSRAM WP(SD3) pin” must be set or this value is ignored
If burning a customized set of SPI flash pins in eFuse and using DIO or DOUT mode for flash, set this value to the GPIO number of the SPIRAM WP pin.
CONFIG_SPIRAM_2T_MODE¶
Enable SPI PSRAM 2T mode
Found in: Component config > ESP32-specific > CONFIG_SPIRAM_SUPPORT > SPI RAM config
Enable this option to fix single bit errors inside 64Mbit PSRAM.
Some 64Mbit PSRAM chips have a hardware issue in the RAM which causes bit errors at multiple fixed bit positions.
Note: If this option is enabled, the 64Mbit PSRAM chip will appear to be 32Mbit in size. Applications will not be affected unless the use the esp_himem APIs, which are not supported in 2T mode.
CONFIG_ESP32_TRAX¶
Use TRAX tracing feature
Found in: Component config > ESP32-specific
The ESP32 contains a feature which allows you to trace the execution path the processor has taken through the program. This is stored in a chunk of 32K (16K for single-processor) of memory that can’t be used for general purposes anymore. Disable this if you do not know what this is.
CONFIG_ESP32_TRAX_TWOBANKS¶
Reserve memory for tracing both pro as well as app cpu execution
Found in: Component config > ESP32-specific > CONFIG_ESP32_TRAX
The ESP32 contains a feature which allows you to trace the execution path the processor has taken through the program. This is stored in a chunk of 32K (16K for single-processor) of memory that can’t be used for general purposes anymore. Disable this if you do not know what this is.
# Memory to reverse for trace, used in linker script
CONFIG_NUMBER_OF_UNIVERSAL_MAC_ADDRESS¶
Number of universally administered (by IEEE) MAC address
Found in: Component config > ESP32-specific
Configure the number of universally administered (by IEEE) MAC addresses. During initialisation, 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.)
- Available options:
Two (TWO_UNIVERSAL_MAC_ADDRESS)
Four (FOUR_UNIVERSAL_MAC_ADDRESS)
CONFIG_SYSTEM_EVENT_QUEUE_SIZE¶
System event queue size
Found in: Component config > ESP32-specific
Config system event queue size in different application.
CONFIG_SYSTEM_EVENT_TASK_STACK_SIZE¶
Event loop task stack size
Found in: Component config > ESP32-specific
Config system event task stack size in different application.
CONFIG_MAIN_TASK_STACK_SIZE¶
Main task stack size
Found in: Component config > ESP32-specific
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.
CONFIG_IPC_TASK_STACK_SIZE¶
Inter-Processor Call (IPC) task stack size
Found in: Component config > ESP32-specific
Configure the IPC tasks stack size. One 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 stack size should be enough for most common use cases. It can be shrunk if you are sure that you do not use any custom IPC functionality.
CONFIG_TIMER_TASK_STACK_SIZE¶
High-resolution timer task stack size
Found in: Component config > ESP32-specific
Configure the stack size of esp_timer/ets_timer 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.
CONFIG_NEWLIB_STDOUT_LINE_ENDING¶
Line ending for UART output
Found in: Component config > ESP32-specific
This option allows configuring the desired line endings sent to UART when a newline (‘n’, LF) appears on stdout. Three options are possible:
CRLF: whenever LF is encountered, prepend it with CR
LF: no modification is applied, stdout is sent as is
CR: each occurence of LF is replaced with CR
This option doesn’t affect behavior of the UART driver (drivers/uart.h).
- Available options:
CRLF (NEWLIB_STDOUT_LINE_ENDING_CRLF)
LF (NEWLIB_STDOUT_LINE_ENDING_LF)
CR (NEWLIB_STDOUT_LINE_ENDING_CR)
CONFIG_NEWLIB_STDIN_LINE_ENDING¶
Line ending for UART input
Found in: Component config > ESP32-specific
This option allows configuring which input sequence on UART produces a newline (‘n’, LF) on stdin. Three options are possible:
CRLF: CRLF is converted to LF
LF: no modification is applied, input is sent to stdin as is
CR: each occurence of CR is replaced with LF
This option doesn’t affect behavior of the UART driver (drivers/uart.h).
- Available options:
CRLF (NEWLIB_STDIN_LINE_ENDING_CRLF)
LF (NEWLIB_STDIN_LINE_ENDING_LF)
CR (NEWLIB_STDIN_LINE_ENDING_CR)
CONFIG_NEWLIB_NANO_FORMAT¶
Enable ‘nano’ formatting options for printf/scanf family
Found in: Component config > ESP32-specific
ESP32 ROM contains parts of newlib C library, including printf/scanf family of functions. These functions have been compiled with so-called “nano” formatting option. This option doesn’t support 64-bit integer formats and C99 features, such as positional arguments.
For more details about “nano” formatting option, please see newlib readme file, search for ‘–enable-newlib-nano-formatted-io’: https://sourceware.org/newlib/README
If this option is enabled, build system will use functions available in ROM, reducing the application binary size. Functions available in ROM run faster than functions which run from flash. Functions available in ROM can also run when flash instruction cache is disabled.
If you need 64-bit integer formatting support or C99 features, keep this option disabled.
CONFIG_CONSOLE_UART¶
UART for console output
Found in: Component config > ESP32-specific
Select whether to use UART for console output (through stdout and stderr).
Default is to use UART0 on pins GPIO1(TX) and GPIO3(RX).
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 output can be further suppressed by bootstrapping GPIO13 pin to low logic level.
- Available options:
Default: UART0, TX=GPIO1, RX=GPIO3 (CONSOLE_UART_DEFAULT)
Custom (CONSOLE_UART_CUSTOM)
None (CONSOLE_UART_NONE)
CONFIG_CONSOLE_UART_NUM¶
UART peripheral to use for console output (0-1)
Found in: Component config > ESP32-specific
Due of a ROM bug, UART2 is not supported for console output via ets_printf.
- Available options:
UART0 (CONSOLE_UART_CUSTOM_NUM_0)
UART1 (CONSOLE_UART_CUSTOM_NUM_1)
CONFIG_CONSOLE_UART_TX_GPIO¶
UART TX on GPIO#
Found in: Component config > ESP32-specific
CONFIG_CONSOLE_UART_RX_GPIO¶
UART RX on GPIO#
Found in: Component config > ESP32-specific
CONFIG_CONSOLE_UART_BAUDRATE¶
UART console baud rate
Found in: Component config > ESP32-specific
CONFIG_ULP_COPROC_ENABLED¶
Enable Ultra Low Power (ULP) Coprocessor
Found in: Component config > ESP32-specific
Set to ‘y’ if you plan to load a firmware for the coprocessor.
If this option is enabled, further coprocessor configuration will appear in the Components menu.
CONFIG_ULP_COPROC_RESERVE_MEM¶
RTC slow memory reserved for coprocessor
Found in: Component config > ESP32-specific > CONFIG_ULP_COPROC_ENABLED
Bytes of memory to reserve for ULP coprocessor firmware & data.
Data is reserved at the beginning of RTC slow memory.
CONFIG_ESP32_PANIC¶
Panic handler behaviour
Found in: Component config > ESP32-specific
If FreeRTOS detects unexpected behaviour or an unhandled exception, the panic handler is invoked. Configure the panic handlers action here.
- Available options:
Print registers and halt (ESP32_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 (ESP32_PANIC_PRINT_REBOOT)
Outputs the relevant registers over the serial port and immediately reset the processor.
Silent reboot (ESP32_PANIC_SILENT_REBOOT)
Just resets the processor without outputting anything
Invoke GDBStub (ESP32_PANIC_GDBSTUB)
Invoke gdbstub on the serial port, allowing for gdb to attach to it to do a postmortem of the crash.
CONFIG_GDBSTUB_SUPPORT_TASKS¶
GDBStub: enable listing FreeRTOS tasks
Found in: Component config > ESP32-specific
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_GDBSTUB_MAX_TASKS¶
GDBStub: maximum number of tasks supported
Found in: Component config > ESP32-specific > CONFIG_GDBSTUB_SUPPORT_TASKS
Set the number of tasks which GDB Stub will support.
CONFIG_ESP32_DEBUG_OCDAWARE¶
Make exception and panic handlers JTAG/OCD aware
Found in: Component config > ESP32-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.
CONFIG_ESP32_DEBUG_STUBS_ENABLE¶
OpenOCD debug stubs
Found in: Component config > ESP32-specific
Debug stubs are used by OpenOCD to execute pre-compiled onboard code which does some useful debugging, e.g. GCOV data dump.
CONFIG_INT_WDT¶
Interrupt watchdog
Found in: Component config > ESP32-specific
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.
CONFIG_INT_WDT_TIMEOUT_MS¶
Interrupt watchdog timeout (ms)
Found in: Component config > ESP32-specific > CONFIG_INT_WDT
The timeout of the watchdog, in miliseconds. Make this higher than the FreeRTOS tick rate.
CONFIG_INT_WDT_CHECK_CPU1¶
Also watch CPU1 tick interrupt
Found in: Component config > ESP32-specific > CONFIG_INT_WDT
Also detect if interrupts on CPU 1 are disabled for too long.
CONFIG_TASK_WDT¶
Initialize Task Watchdog Timer on startup
Found in: Component config > ESP32-specific
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)
CONFIG_TASK_WDT_PANIC¶
Invoke panic handler on Task Watchdog timeout
Found in: Component config > ESP32-specific > CONFIG_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)
CONFIG_TASK_WDT_TIMEOUT_S¶
Task Watchdog timeout period (seconds)
Found in: Component config > ESP32-specific > CONFIG_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)
CONFIG_TASK_WDT_CHECK_IDLE_TASK_CPU0¶
Watch CPU0 Idle Task
Found in: Component config > ESP32-specific > CONFIG_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.
CONFIG_TASK_WDT_CHECK_IDLE_TASK_CPU1¶
Watch CPU1 Idle Task
Found in: Component config > ESP32-specific > CONFIG_TASK_WDT
If this option is enabled, the Task Wtachdog Timer will wach the CPU1 Idle Task.
CONFIG_BROWNOUT_DET¶
Hardware brownout detect & reset
Found in: Component config > ESP32-specific
The ESP32 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.
CONFIG_BROWNOUT_DET_LVL_SEL¶
Brownout voltage level
Found in: Component config > ESP32-specific > CONFIG_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 ESP32 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.43V +/- 0.05 (BROWNOUT_DET_LVL_SEL_0)
2.48V +/- 0.05 (BROWNOUT_DET_LVL_SEL_1)
2.58V +/- 0.05 (BROWNOUT_DET_LVL_SEL_2)
2.62V +/- 0.05 (BROWNOUT_DET_LVL_SEL_3)
2.67V +/- 0.05 (BROWNOUT_DET_LVL_SEL_4)
2.70V +/- 0.05 (BROWNOUT_DET_LVL_SEL_5)
2.77V +/- 0.05 (BROWNOUT_DET_LVL_SEL_6)
2.80V +/- 0.05 (BROWNOUT_DET_LVL_SEL_7)
CONFIG_REDUCE_PHY_TX_POWER¶
Reduce PHY TX power when brownout reset
Found in: Component config > ESP32-specific
When brownout reset occurs, reduce PHY TX power to keep the code running
# Note about the use of “FRC1” name: currently FRC1 timer is not used for # high resolution timekeeping anymore. Instead the esp_timer API, implemented # using FRC2 timer, is used. # FRC1 name in the option name is kept for compatibility.
CONFIG_ESP32_TIME_SYSCALL¶
Timers used for gettimeofday function
Found in: Component config > ESP32-specific
This setting defines which hardware timers are used to implement ‘gettimeofday’ and ‘time’ functions in C library.
If both high-resolution 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 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 (ESP32_TIME_SYSCALL_USE_RTC_FRC1)
RTC (ESP32_TIME_SYSCALL_USE_RTC)
High-resolution timer (ESP32_TIME_SYSCALL_USE_FRC1)
None (ESP32_TIME_SYSCALL_USE_NONE)
CONFIG_ESP32_RTC_CLOCK_SOURCE¶
RTC clock source
Found in: Component config > ESP32-specific
Choose which clock is used as RTC clock source.
“Internal 150kHz oscillator” option provides lowest deep sleep current consumption, and does not require extra external components. However frequency stability with respect to temperature is poor, so time may drift in deep/light sleep modes.
“External 32kHz crystal” provides better frequency stability, at the expense of slightly higher (1uA) deep sleep current consumption.
“External 32kHz oscillator” allows using 32kHz clock generated by an external circuit. In this case, external clock signal must be connected to 32K_XP pin. Amplitude should be <1.2V in case of sine wave signal, and <1V in case of square wave signal. Common mode voltage should be 0.1 < Vcm < 0.5Vamp, where Vamp is the signal amplitude. Additionally, 1nF capacitor must be connected between 32K_XN pin and ground. 32K_XN pin can not be used as a GPIO in this case.
“Internal 8.5MHz oscillator divided by 256” option results in higher deep sleep current (by 5uA) but has better frequency stability than the internal 150kHz oscillator. It does not require external components.
- Available options:
Internal 150kHz RC oscillator (ESP32_RTC_CLOCK_SOURCE_INTERNAL_RC)
External 32kHz crystal (ESP32_RTC_CLOCK_SOURCE_EXTERNAL_CRYSTAL)
External 32kHz oscillator at 32K_XP pin (ESP32_RTC_CLOCK_SOURCE_EXTERNAL_OSC)
Internal 8.5MHz oscillator, divided by 256 (~33kHz) (ESP32_RTC_CLOCK_SOURCE_INTERNAL_8MD256)
CONFIG_ESP32_RTC_EXTERNAL_CRYSTAL_ADDITIONAL_CURRENT¶
Additional current for external 32kHz crystal
Found in: Component config > ESP32-specific
Choose which additional current is used for rtc external crystal.
With some 32kHz crystal configurations, the X32N and X32P pins may not have enough drive strength to keep the crystal oscillating during deep sleep. If this option is enabled, additional current from touchpad 9 is provided internally to drive the 32kHz crystal. If this option is enabled, deep sleep current is slightly higher (4-5uA) and the touchpad and ULP wakeup sources are not available.
CONFIG_ESP32_RTC_CLK_CAL_CYCLES¶
Number of cycles for RTC_SLOW_CLK calibration
Found in: Component config > ESP32-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.
CONFIG_ESP32_RTC_XTAL_CAL_RETRY¶
Number of attempts to repeat 32k XTAL calibration
Found in: Component config > ESP32-specific
Number of attempts to repeat 32k XTAL calibration before giving up and switching to the internal RC. Increase this option if the 32k crystal oscillator does not start and switches to internal RC.
CONFIG_ESP32_RTC_XTAL_BOOTSTRAP_CYCLES¶
Bootstrap cycles for external 32kHz crystal
Found in: Component config > ESP32-specific
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_ESP32_DEEP_SLEEP_WAKEUP_DELAY¶
Extra delay in deep sleep wake stub (in us)
Found in: Component config > ESP32-specific
When ESP32 exits deep sleep, the CPU and the flash chip are powered on at the same time. CPU will run deep sleep stub first, and then proceed to load code from flash. Some flash chips need sufficient time to pass between power on and first read operation. By default, without any extra delay, this time is approximately 900us, although some flash chip types need more than that.
By default extra delay is set to 2000us. When optimizing startup time for applications which require it, this value may be reduced.
If you are seeing “flash read err, 1000” message printed to the console after deep sleep reset, try increasing this value.
CONFIG_ESP32_XTAL_FREQ_SEL¶
Main XTAL frequency
Found in: Component config > ESP32-specific
ESP32 currently supports the following XTAL frequencies:
26 MHz
40 MHz
Startup code can automatically estimate XTAL frequency. This feature uses the internal 8MHz oscillator as a reference. Because the internal oscillator frequency is temperature dependent, it is not recommended to use automatic XTAL frequency detection in applications which need to work at high ambient temperatures and use high-temperature qualified chips and modules.
- Available options:
40 MHz (ESP32_XTAL_FREQ_40)
26 MHz (ESP32_XTAL_FREQ_26)
Autodetect (ESP32_XTAL_FREQ_AUTO)
CONFIG_DISABLE_BASIC_ROM_CONSOLE¶
Permanently disable BASIC ROM Console
Found in: Component config > ESP32-specific
If set, the first time the app boots it will disable the BASIC ROM Console permanently (by burning an eFuse).
Otherwise, the BASIC ROM Console starts on reset if no valid bootloader is read from the flash.
(Enabling secure boot also disables the BASIC ROM Console by default.)
CONFIG_NO_BLOBS¶
No Binary Blobs
Found in: Component config > ESP32-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.
CONFIG_ESP_TIMER_PROFILING¶
Enable esp_timer profiling features
Found in: Component config > ESP32-specific
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.
CONFIG_COMPATIBLE_PRE_V2_1_BOOTLOADERS¶
App compatible with bootloaders before ESP-IDF v2.1
Found in: Component config > ESP32-specific
Bootloaders before ESP-IDF v2.1 did less initialisation of the system clock. This setting needs to be enabled to build an app which can be booted by these older bootloaders.
If this setting is enabled, the app can be booted by any bootloader from IDF v1.0 up to the current version.
If this setting is disabled, the app can only be booted by bootloaders from IDF v2.1 or newer.
Enabling this setting adds approximately 1KB to the app’s IRAM usage.
CONFIG_ESP32_COMPATIBLE_PRE_V3_1_BOOTLOADERS¶
App compatible with bootloader and partition table before ESP-IDF v3.1
Found in: Component config > ESP32-specific
Partition tables before ESP-IDF V3.1 do not contain an MD5 checksum field, and the bootloader before ESP-IDF v3.1 cannot read a partition table that contains an MD5 checksum field.
Enable this option only if your app needs to boot on a bootloader and/or partition table that was generated from a version *before* ESP-IDF v3.1.
If this option and Flash Encryption are enabled at the same time, and any data partitions in the partition table are marked Encrypted, then the partition encrypted flag should be manually verified in the app before accessing the partition (see CVE-2021-27926).
CONFIG_ESP_ERR_TO_NAME_LOOKUP¶
Enable lookup of error code strings
Found in: Component config > ESP32-specific
Functions esp_err_to_name() and esp_err_to_name_r() return string representations of error codes from a pre-generated lookup table. This option can be used to turn off the use of the look-up table in order to save memory but this comes at the price of sacrificing distinguishable (meaningful) output string representations.
CONFIG_ESP32_RTCDATA_IN_FAST_MEM¶
Place RTC_DATA_ATTR and RTC_RODATA_ATTR variables into RTC fast memory segment
Found in: Component config > ESP32-specific
This option allows to place .rtc_data and .rtc_rodata sections into RTC fast memory segment to free the slow memory region for ULP programs. This option depends on the CONFIG_FREERTOS_UNICORE option because RTC fast memory can be accessed only by PRO_CPU core.
CONFIG_ESP32_DPORT_DIS_INTERRUPT_LVL¶
Disable the interrupt level for the DPORT workarounds
Found in: Component config > ESP32-specific
To prevent interrupting DPORT workarounds, need to disable interrupt with a maximum used level in the system.
Wi-Fi¶
Contains:
CONFIG_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.
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.
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.
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.
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.
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.
CONFIG_ESP32_WIFI_AMPDU_TX_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.
CONFIG_ESP32_WIFI_AMPDU_RX_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.
CONFIG_ESP32_WIFI_NVS_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.
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.
CONFIG_ESP32_WIFI_DEBUG_LOG_ENABLE¶
Enable WiFi debug log
Found in: Component config > Wi-Fi
Select this option to enable WiFi debug log
CONFIG_ESP32_WIFI_DEBUG_LOG_LEVEL¶
WiFi debug log level
Found in: Component config > Wi-Fi > CONFIG_ESP32_WIFI_DEBUG_LOG_ENABLE
The WiFi log is divided into the following levels: ERROR,WARNING,INFO,DEBUG,VERBOSE. The ERROR,WARNING,INFO levels are enabled by default, and the DEBUG,VERBOSE levels can be enabled here.
- Available options:
WiFi Debug Log Debug (ESP32_WIFI_DEBUG_LOG_DEBUG)
WiFi Debug Log Verbose (ESP32_WIFI_DEBUG_LOG_VERBOSE)
CONFIG_ESP32_WIFI_DEBUG_LOG_MODULE¶
WiFi debug log module
Found in: Component config > Wi-Fi > CONFIG_ESP32_WIFI_DEBUG_LOG_ENABLE
The WiFi log module contains three parts: WIFI,COEX,MESH. The WIFI module indicates the logs related to WiFi, the COEX module indicates the logs related to WiFi and BT(or BLE) coexist, the MESH module indicates the logs related to Mesh. When ESP32_WIFI_LOG_MODULE_ALL is enabled, all modules are selected.
- Available options:
WiFi Debug Log Module All (ESP32_WIFI_DEBUG_LOG_MODULE_ALL)
WiFi Debug Log Module WiFi (ESP32_WIFI_DEBUG_LOG_MODULE_WIFI)
WiFi Debug Log Module Coex (ESP32_WIFI_DEBUG_LOG_MODULE_COEX)
WiFi Debug Log Module Mesh (ESP32_WIFI_DEBUG_LOG_MODULE_MESH)
CONFIG_ESP32_WIFI_DEBUG_LOG_SUBMODULE¶
WiFi debug log submodule
Found in: Component config > Wi-Fi > CONFIG_ESP32_WIFI_DEBUG_LOG_ENABLE
Enable this option to set the WiFi debug log submodule. Currently the log submodule contains the following parts: INIT,IOCTL,CONN,SCAN. The INIT submodule indicates the initialization process.The IOCTL submodule indicates the API calling process. The CONN submodule indicates the connecting process.The SCAN submodule indicates the scaning process.
CONFIG_ESP32_WIFI_DEBUG_LOG_SUBMODULE_ALL¶
WiFi Debug Log Submodule All
Found in: Component config > Wi-Fi > CONFIG_ESP32_WIFI_DEBUG_LOG_ENABLE > CONFIG_ESP32_WIFI_DEBUG_LOG_SUBMODULE
When this option is enabled, all debug submodules are selected.
CONFIG_ESP32_WIFI_DEBUG_LOG_SUBMODULE_INIT¶
WiFi Debug Log Submodule Init
Found in: Component config > Wi-Fi > CONFIG_ESP32_WIFI_DEBUG_LOG_ENABLE > CONFIG_ESP32_WIFI_DEBUG_LOG_SUBMODULE
CONFIG_ESP32_WIFI_DEBUG_LOG_SUBMODULE_IOCTL¶
WiFi Debug Log Submodule Ioctl
Found in: Component config > Wi-Fi > CONFIG_ESP32_WIFI_DEBUG_LOG_ENABLE > CONFIG_ESP32_WIFI_DEBUG_LOG_SUBMODULE
CONFIG_ESP32_WIFI_DEBUG_LOG_SUBMODULE_CONN¶
WiFi Debug Log Submodule Conn
Found in: Component config > Wi-Fi > CONFIG_ESP32_WIFI_DEBUG_LOG_ENABLE > CONFIG_ESP32_WIFI_DEBUG_LOG_SUBMODULE
CONFIG_ESP32_WIFI_DEBUG_LOG_SUBMODULE_SCAN¶
WiFi Debug Log Submodule Scan
Found in: Component config > Wi-Fi > CONFIG_ESP32_WIFI_DEBUG_LOG_ENABLE > CONFIG_ESP32_WIFI_DEBUG_LOG_SUBMODULE
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.
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.
PHY¶
Contains:
CONFIG_ESP32_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’.
CONFIG_ESP32_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’.
CONFIG_ESP32_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.
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.
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 CONFIG_ESP32_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.
CONFIG_PM_USE_RTC_TIMER_REF¶
Use RTC timer to prevent time drift (EXPERIMENTAL)
Found in: Component config > Power Management > CONFIG_PM_ENABLE
When APB clock frequency changes, high-resolution timer (esp_timer) scale and base value need to be adjusted. Each adjustment may cause small error, and over time such small errors may cause time drift. If this option is enabled, RTC timer will be used as a reference to compensate for the drift. It is recommended that this option is only used if 32k XTAL is selected as RTC clock source.
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.
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.
ADC-Calibration¶
Contains:
CONFIG_ADC_CAL_EFUSE_TP_ENABLE¶
Use Two Point Values
Found in: Component config > ADC-Calibration
Some ESP32s have Two Point calibration values burned into eFuse BLOCK3. This option will allow the ADC calibration component to characterize the ADC-Voltage curve using Two Point values if they are available.
CONFIG_ADC_CAL_EFUSE_VREF_ENABLE¶
Use eFuse Vref
Found in: Component config > ADC-Calibration
Some ESP32s have Vref burned into eFuse BLOCK0. This option will allow the ADC calibration component to characterize the ADC-Voltage curve using eFuse Vref if it is available.
CONFIG_ADC_CAL_LUT_ENABLE¶
Use Lookup Tables
Found in: Component config > ADC-Calibration
This option will allow the ADC calibration component to use Lookup Tables to correct for non-linear behavior in 11db attenuation. Other attenuations do not exhibit non-linear behavior hence will not be affected by this option.
Event Loop Library¶
Contains:
CONFIG_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.
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 mbedtls library and initializing SSL transport
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
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
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
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
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.
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.
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
Core dump¶
Contains:
CONFIG_ESP32_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).
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 (ESP32_ENABLE_COREDUMP_TO_FLASH)
UART (ESP32_ENABLE_COREDUMP_TO_UART)
None (ESP32_ENABLE_COREDUMP_TO_NONE)
CONFIG_ESP32_CORE_DUMP_MAX_TASKS_NUM¶
Maximum number of tasks
Found in: Component config > Core dump
Maximum number of tasks snapshots in core dump.
CONFIG_ESP32_CORE_DUMP_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.
Ethernet¶
Contains:
CONFIG_DMA_RX_BUF_NUM¶
Number of DMA RX buffers
Found in: Component config > Ethernet
Number of DMA receive buffers. Each buffer is 1600 bytes. These buffers are allocated dynamically. More buffers will increase throughput. If flow ctrl is enabled, make sure this number is larger than 9.
CONFIG_DMA_TX_BUF_NUM¶
Number of DMA TX buffers
Found in: Component config > Ethernet
Number of DMA transmit buffers. Each buffer is 1600 bytes. These buffers are allocated dynamically. More buffers will increase throughput.
CONFIG_EMAC_L2_TO_L3_RX_BUF_MODE¶
Enable received buffers be copied to Layer3 from Layer2
Found in: Component config > Ethernet
If this option is selected, a copy of each received buffer will be allocated from the heap before passing it to the IP Layer (L3). Which means, the total amount of received buffers is limited by the heap size.
If this option is not selected, IP layer only uses the pointers to the DMA buffers owned by Ethernet MAC. When Ethernet MAC doesn’t have any available buffers left, it will drop the incoming packets.
CONFIG_EMAC_CHECK_LINK_PERIOD_MS¶
Period (ms) of checking Ethernet linkup status
Found in: Component config > Ethernet
The emac driver uses an internal timer to check the Ethernet linkup status. Here you should choose a valid interval time.
CONFIG_EMAC_TASK_PRIORITY¶
CONFIG_EMAC_TASK_STACK_SIZE¶
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.
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.
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.
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.
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.
Modbus configuration¶
Contains:
CONFIG_MB_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.
CONFIG_MB_SERIAL_TASK_STACK_SIZE¶
Modbus serial task stack size
Found in: Component config > Modbus configuration
Modbus serial task stack size for event queue task. It may be adjusted when debugging is enabled (for example).
CONFIG_MB_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.
CONFIG_MB_SERIAL_TASK_PRIO¶
Modbus serial task priority
Found in: Component config > Modbus configuration
Modbus UART driver event task priority. The priority of Modbus controller task is equal to (CONFIG_MB_SERIAL_TASK_PRIO - 1).
CONFIG_MB_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 (MB_PORT_TASK_AFFINITY_NO_AFFINITY)
CPU0 (MB_PORT_TASK_AFFINITY_CPU0)
CPU1 (MB_PORT_TASK_AFFINITY_CPU1)
CONFIG_MB_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.
CONFIG_MB_CONTROLLER_SLAVE_ID¶
Modbus controller slave ID
Found in: Component config > Modbus configuration > CONFIG_MB_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.
CONFIG_MB_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.
CONFIG_MB_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.
CONFIG_MB_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).
CONFIG_MB_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.
CONFIG_MB_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.
CONFIG_MB_TIMER_GROUP¶
Modbus Timer group number
Found in: Component config > Modbus configuration > CONFIG_MB_TIMER_PORT_ENABLED
Modbus Timer group number that is used for timeout measurement.
CONFIG_MB_TIMER_INDEX¶
Modbus Timer index in the group
Found in: Component config > Modbus configuration > CONFIG_MB_TIMER_PORT_ENABLED
Modbus Timer Index in the group that is used for timeout measurement.
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
CONFIG_FREERTOS_HZ¶
Tick rate (Hz)
Found in: Component config > FreeRTOS
Select the tick rate at which FreeRTOS does pre-emptive context switching.
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().
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 debug memory watchpoint 1 (the second one) 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 only have one watchpoint; the 2nd one is overwritten as soon as a task switch happens.
This check only triggers if the stack overflow writes within 4 bytes of 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.
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.
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.
CONFIG_FREERTOS_ASSERT¶
FreeRTOS assertions
Found in: Component config > FreeRTOS
Failed FreeRTOS configASSERT() assertions can be configured to behave in different ways.
- 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.
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.
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.
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.
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.
CONFIG_SUPPORT_STATIC_ALLOCATION¶
Enable FreeRTOS static allocation API
Found in: Component config > FreeRTOS
FreeRTOS gives the application writer the ability to instead provide the memory themselves, allowing the following objects to optionally be created without any memory being allocated dynamically:
Tasks
Software Timers (Daemon task is still dynamic. See documentation)
Queues
Event Groups
Binary Semaphores
Counting Semaphores
Recursive Semaphores
Mutexes
Whether it is preferable to use static or dynamic memory allocation is dependent on the application, and the preference of the application writer. Both methods have pros and cons, and both methods can be used within the same RTOS application.
Creating RTOS objects using statically allocated RAM has the benefit of providing the application writer with more control: RTOS objects can be placed at specific memory locations. The maximum RAM footprint can be determined at link time, rather than run time. The application writer does not need to concern themselves with graceful handling of memory allocation failures. It allows the RTOS to be used in applications that simply don’t allow any dynamic memory allocation (although FreeRTOS includes allocation schemes that can overcome most objections).
CONFIG_ENABLE_STATIC_TASK_CLEAN_UP_HOOK¶
Enable static task clean up hook
Found in: Component config > FreeRTOS > CONFIG_SUPPORT_STATIC_ALLOCATION
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 }
CONFIG_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.
CONFIG_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.
CONFIG_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.
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.
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().
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().
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.
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 )
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.
If disabled, automatic light sleep support will be disabled.
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.
CONFIG_FREERTOS_DEBUG_INTERNALS¶
Debug FreeRTOS internals
Found in: Component config > FreeRTOS
Enable this option to show the menu with internal FreeRTOS debugging features. This option does not change any code by itself, it just shows/hides some options.
Contains:
CONFIG_FREERTOS_PORTMUX_DEBUG¶
Debug portMUX portENTER_CRITICAL/portEXIT_CRITICAL
Found in: Component config > FreeRTOS > CONFIG_FREERTOS_DEBUG_INTERNALS
If enabled, debug information (including integrity checks) will be printed to UART for the port-specific MUX implementation.
CONFIG_FREERTOS_PORTMUX_DEBUG_RECURSIVE¶
Debug portMUX Recursion
Found in: Component config > FreeRTOS > CONFIG_FREERTOS_DEBUG_INTERNALS
If enabled, additional debug information will be printed for recursive portMUX usage.
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.
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.
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
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¶
Enable 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.
CONFIG_HEAP_TRACING_STACK_DEPTH¶
Heap tracing stack depth
Found in: Component config > Heap memory debugging > CONFIG_HEAP_TRACING
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.
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).
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.
Note that this setting limits which log statements are compiled into the program. So setting this to, say, “Warning” would mean that changing log level to “Debug” at runtime will not be possible.
- 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_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.
LWIP¶
Contains:
CONFIG_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.
CONFIG_ETHARP_SUPPORT_VLAN¶
Support receiving and sending ethernet packets with VLAN header
Found in: Component config > LWIP
ETHARP_SUPPORT_VLAN==1: support receiving and sending ethernet packets with VLAN header. See the description of LWIP_HOOK_VLAN_CHECK and LWIP_HOOK_VLAN_SET hooks to check/set VLAN headers. If ETHARP_VLAN_CHECK is defined, only VLAN-traffic for this VLAN is accepted. If ETHARP_VLAN_CHECK is not defined, all traffic is accepted.
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.
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.
CONFIG_LWIP_RANDOMIZE_INITIAL_LOCAL_PORTS¶
Randomize the local port for the first
Found in: Component config > LWIP
LWIP_RANDOMIZE_INITIAL_LOCAL_PORTS==1: randomize the local port for the first local TCP/UDP pcb (default==0). This can prevent creating predictable port numbers after booting a device.
CONFIG_USE_ONLY_LWIP_SELECT¶
Support LWIP socket select() only
Found in: Component config > LWIP
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.
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.
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.
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.
CONFIG_LWIP_SO_RCVBUF¶
Enable SO_RCVBUF option
Found in: Component config > LWIP
Enabling this option allows checking for available data on a netconn.
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.
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.
CONFIG_LWIP_IP4_REASSEMBLY¶
Enable reassembly incoming fragmented IP4 packets
Found in: Component config > LWIP
Enabling this option allows reassemblying incoming fragmented IP4 packets.
CONFIG_LWIP_IP6_REASSEMBLY¶
Enable reassembly incoming fragmented IP6 packets
Found in: Component config > LWIP
Enabling this option allows reassemblying incoming fragmented IP6 packets.
CONFIG_LWIP_STATS¶
Enable LWIP statistics
Found in: Component config > LWIP
Enabling this option allows LWIP statistics
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.
CONFIG_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.
CONFIG_GARP_TMR_INTERVAL¶
GARP timer interval(seconds)
Found in: Component config > LWIP > CONFIG_ESP_GRATUITOUS_ARP
Set the timer interval for gratuitous ARP. The default value is 60s
CONFIG_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.
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.
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.
DHCP server¶
Contains:
CONFIG_LWIP_DHCPS_LEASE_UNIT¶
Multiplier for lease time, in seconds
Found in: Component config > LWIP > DHCP server
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.
CONFIG_LWIP_DHCPS_MAX_STATION_NUM¶
Maximum number of stations
Found in: Component config > LWIP > DHCP server
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.
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.
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.)
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.
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.
CONFIG_LWIP_IPV6_AUTOCONFIG¶
Enable IPV6 stateless address autoconfiguration
Found in: Component config > LWIP
Enabling this option allows the devices to IPV6 stateless address autoconfiguration.
See RFC 4862.
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.
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.
TCP¶
Contains:
CONFIG_LWIP_TCP_ISN_HOOK¶
Enable TCP ISN Hook
Found in: Component config > LWIP > TCP
Enables custom TCP ISN hook to randomize initial sequence number in TCP connection. This is recommended as default lwIP implementation (tcp_next_iss) is not very strong, as it does not take into consideration any platform specific entropy source.
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.
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.
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.
CONFIG_TCP_MAXRTX¶
Maximum number of retransmissions of data segments
Found in: Component config > LWIP > TCP
Set maximum number of retransmissions of data segments.
CONFIG_TCP_SYNMAXRTX¶
Maximum number of retransmissions of SYN segments
Found in: Component config > LWIP > TCP
Set maximum number of retransmissions of SYN segments.
CONFIG_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
CONFIG_TCP_MSL¶
Maximum segment lifetime (MSL)
Found in: Component config > LWIP > TCP
Set maximum segment lifetime in in milliseconds.
CONFIG_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.
CONFIG_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.
CONFIG_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: TCP_WND_DEFAULT/TCP_MSS + 2, e.g. if 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 TCP_RECCVMBOX_SIZE packets for each TCP socket, so the maximum possible cached TCP packets for all TCP sockets is TCP_RECCVMBOX_SIZE multiples the maximum TCP socket number. In other words, the bigger 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.
CONFIG_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.
CONFIG_ESP_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.
CONFIG_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 (TCP_OVERSIZE_MSS)
25% MSS (TCP_OVERSIZE_QUARTER_MSS)
Disabled (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.
CONFIG_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.
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.
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.
CONFIG_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.
CONFIG_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.
CONFIG_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 (TCPIP_TASK_AFFINITY_NO_AFFINITY)
CPU0 (TCPIP_TASK_AFFINITY_CPU0)
CPU1 (TCPIP_TASK_AFFINITY_CPU1)
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.
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.
CONFIG_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.
Contains:
CONFIG_PPP_NOTIFY_PHASE_SUPPORT¶
Enable Notify Phase Callback
Found in: Component config > LWIP > CONFIG_PPP_SUPPORT
Enable to set a callback which is called on change of the internal PPP state machine.
CONFIG_PPP_PAP_SUPPORT¶
Enable PAP support
Found in: Component config > LWIP > CONFIG_PPP_SUPPORT
Enable Password Authentication Protocol (PAP) support
CONFIG_PPP_CHAP_SUPPORT¶
Enable CHAP support
Found in: Component config > LWIP > CONFIG_PPP_SUPPORT
Enable Challenge Handshake Authentication Protocol (CHAP) support
CONFIG_PPP_MSCHAP_SUPPORT¶
Enable MSCHAP support
Found in: Component config > LWIP > CONFIG_PPP_SUPPORT
Enable Microsoft version of the Challenge-Handshake Authentication Protocol (MSCHAP) support
CONFIG_PPP_MPPE_SUPPORT¶
Enable MPPE support
Found in: Component config > LWIP > CONFIG_PPP_SUPPORT
Enable Microsoft Point-to-Point Encryption (MPPE) support
CONFIG_PPP_DEBUG_ON¶
Enable PPP debug log output
Found in: Component config > LWIP > CONFIG_PPP_SUPPORT
Enable PPP debug log output
ICMP¶
Contains:
CONFIG_LWIP_MULTICAST_PING¶
Respond to multicast pings
Found in: Component config > LWIP > ICMP
CONFIG_LWIP_BROADCAST_PING¶
Respond to broadcast pings
Found in: Component config > LWIP > ICMP
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.
SNTP¶
Contains:
CONFIG_LWIP_DHCP_MAX_NTP_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.
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).
CONFIG_LWIP_ESP_LWIP_ASSERT¶
Enable LWIP ASSERT checks
Found in: Component config > LWIP
Enable this option allows lwip to check assert. It is recommended to keep it open, do not close it.
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
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.
- 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)
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).
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.
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).
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).
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.
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.
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.
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.
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 4096 bit results.
These operations are used by RSA.
CONFIG_MBEDTLS_MPI_USE_INTERRUPT¶
Use interrupt for MPI operations
Found in: Component config > mbedTLS > CONFIG_MBEDTLS_HARDWARE_MPI
Use an interrupt to coordinate MPI operations.
This allows other code to run on the CPU while an MPI operation is pending. Otherwise the CPU busy-waits.
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, 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.
CONFIG_MBEDTLS_HAVE_TIME¶
Enable mbedtls time
Found in: Component config > mbedTLS
System has time.h and time(). The time does not need to be correct, only time differences are used.
CONFIG_MBEDTLS_HAVE_TIME_DATE¶
Enable mbedtls certificate expiry check
Found in: Component config > mbedTLS > CONFIG_MBEDTLS_HAVE_TIME
System has time.h and time(), gmtime() and the clock is correct. The time needs to be correct (not necesarily very accurate, but at least the date should be correct). This is used to verify the validity period of X.509 certificates.
It is suggested that you should get the real time by “SNTP”.
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.
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.
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.
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.
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.
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-
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-
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.
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-
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-
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-
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-
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.
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.
CONFIG_MBEDTLS_SSL_PROTO_TLS1¶
Support TLS 1.0 protocol
Found in: Component config > mbedTLS
CONFIG_MBEDTLS_SSL_PROTO_TLS1_1¶
Support TLS 1.1 protocol
Found in: Component config > mbedTLS
CONFIG_MBEDTLS_SSL_PROTO_TLS1_2¶
Support TLS 1.2 protocol
Found in: Component config > mbedTLS
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
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.
CONFIG_MBEDTLS_SSL_SESSION_TICKETS¶
TLS: Support RFC 5077 SSL session tickets
Found in: Component config > mbedTLS
Support RFC 5077 session tickets. See mbedTLS documentation for more details.
Disabling this option will save some code size.
Symmetric Ciphers¶
Contains:
CONFIG_MBEDTLS_AES_C¶
AES block cipher
Found in: Component config > mbedTLS > Symmetric Ciphers
CONFIG_MBEDTLS_CAMELLIA_C¶
Camellia block cipher
Found in: Component config > mbedTLS > Symmetric Ciphers
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.
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.
CONFIG_MBEDTLS_XTEA_C¶
XTEA block cipher
Found in: Component config > mbedTLS > Symmetric Ciphers
Enables the XTEA block cipher.
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.
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.
CONFIG_MBEDTLS_RIPEMD160_C¶
Enable RIPEMD-160 hash algorithm
Found in: Component config > mbedTLS
Enable the RIPEMD-160 hash algorithm.
Certificates¶
Contains:
CONFIG_MBEDTLS_PEM_PARSE_C¶
Read & Parse PEM formatted certificates
Found in: Component config > mbedTLS > Certificates
Enable decoding/parsing of PEM formatted certificates.
If your certificates are all in the simpler DER format, disabling this option will save some code size.
CONFIG_MBEDTLS_PEM_WRITE_C¶
Write PEM formatted certificates
Found in: Component config > mbedTLS > Certificates
Enable writing of PEM formatted certificates.
If writing certificate data only in DER format, disabling this option will save some code size.
CONFIG_MBEDTLS_X509_CRL_PARSE_C¶
X.509 CRL parsing
Found in: Component config > mbedTLS > Certificates
Support for parsing X.509 Certifificate Revocation Lists.
CONFIG_MBEDTLS_X509_CSR_PARSE_C¶
X.509 CSR parsing
Found in: Component config > mbedTLS > Certificates
Support for parsing X.509 Certifificate Signing Requests
CONFIG_MBEDTLS_ECP_C¶
Elliptic Curve Ciphers
Found in: Component config > mbedTLS
Contains:
CONFIG_MBEDTLS_ECDH_C¶
Elliptic Curve Diffie-Hellman (ECDH)
Found in: Component config > mbedTLS > CONFIG_MBEDTLS_ECP_C
Enable ECDH. Needed to use ECDHE-xxx TLS ciphersuites.
CONFIG_MBEDTLS_ECDSA_C¶
Elliptic Curve DSA
Found in: Component config > mbedTLS > CONFIG_MBEDTLS_ECP_C > CONFIG_MBEDTLS_ECDH_C
Enable ECDSA. Needed to use ECDSA-xxx TLS ciphersuites.
CONFIG_MBEDTLS_ECP_DP_SECP192R1_ENABLED¶
Enable SECP192R1 curve
Found in: Component config > mbedTLS > CONFIG_MBEDTLS_ECP_C
Enable support for SECP192R1 Elliptic Curve.
CONFIG_MBEDTLS_ECP_DP_SECP224R1_ENABLED¶
Enable SECP224R1 curve
Found in: Component config > mbedTLS > CONFIG_MBEDTLS_ECP_C
Enable support for SECP224R1 Elliptic Curve.
CONFIG_MBEDTLS_ECP_DP_SECP256R1_ENABLED¶
Enable SECP256R1 curve
Found in: Component config > mbedTLS > CONFIG_MBEDTLS_ECP_C
Enable support for SECP256R1 Elliptic Curve.
CONFIG_MBEDTLS_ECP_DP_SECP384R1_ENABLED¶
Enable SECP384R1 curve
Found in: Component config > mbedTLS > CONFIG_MBEDTLS_ECP_C
Enable support for SECP384R1 Elliptic Curve.
CONFIG_MBEDTLS_ECP_DP_SECP521R1_ENABLED¶
Enable SECP521R1 curve
Found in: Component config > mbedTLS > CONFIG_MBEDTLS_ECP_C
Enable support for SECP521R1 Elliptic Curve.
CONFIG_MBEDTLS_ECP_DP_SECP192K1_ENABLED¶
Enable SECP192K1 curve
Found in: Component config > mbedTLS > CONFIG_MBEDTLS_ECP_C
Enable support for SECP192K1 Elliptic Curve.
CONFIG_MBEDTLS_ECP_DP_SECP224K1_ENABLED¶
Enable SECP224K1 curve
Found in: Component config > mbedTLS > CONFIG_MBEDTLS_ECP_C
Enable support for SECP224K1 Elliptic Curve.
CONFIG_MBEDTLS_ECP_DP_SECP256K1_ENABLED¶
Enable SECP256K1 curve
Found in: Component config > mbedTLS > CONFIG_MBEDTLS_ECP_C
Enable support for SECP256K1 Elliptic Curve.
CONFIG_MBEDTLS_ECP_DP_BP256R1_ENABLED¶
Enable BP256R1 curve
Found in: Component config > mbedTLS > CONFIG_MBEDTLS_ECP_C
support for DP Elliptic Curve.
CONFIG_MBEDTLS_ECP_DP_BP384R1_ENABLED¶
Enable BP384R1 curve
Found in: Component config > mbedTLS > CONFIG_MBEDTLS_ECP_C
support for DP Elliptic Curve.
CONFIG_MBEDTLS_ECP_DP_BP512R1_ENABLED¶
Enable BP512R1 curve
Found in: Component config > mbedTLS > CONFIG_MBEDTLS_ECP_C
support for DP Elliptic Curve.
CONFIG_MBEDTLS_ECP_DP_CURVE25519_ENABLED¶
Enable CURVE25519 curve
Found in: Component config > mbedTLS > CONFIG_MBEDTLS_ECP_C
Enable support for CURVE25519 Elliptic Curve.
CONFIG_MBEDTLS_ECP_NIST_OPTIM¶
NIST ‘modulo p’ optimisations
Found in: Component config > mbedTLS > CONFIG_MBEDTLS_ECP_C
NIST ‘modulo p’ optimisations increase Elliptic Curve operation performance.
Disabling this option saves some code size.
# end of Elliptic Curve options
mDNS¶
Contains:
CONFIG_MDNS_MAX_SERVICES¶
Max number of services
Found in: Component config > mDNS
Services take up a certain amount of memory, and allowing fewer services to be open at the same time conserves memory. Specify the maximum amount of services here. The valid value is from 1 to 64.
ESP-MQTT Configurations¶
Contains:
CONFIG_MQTT_PROTOCOL_311¶
Enable MQTT protocol 3.1.1
Found in: Component config > ESP-MQTT Configurations
If not, this library will use MQTT protocol 3.1
CONFIG_MQTT_TRANSPORT_SSL¶
Enable MQTT over SSL
Found in: Component config > ESP-MQTT Configurations
Enable MQTT transport over SSL with mbedtls
CONFIG_MQTT_TRANSPORT_WEBSOCKET¶
Enable MQTT over Websocket
Found in: Component config > ESP-MQTT Configurations
Enable MQTT transport over Websocket.
CONFIG_MQTT_TRANSPORT_WEBSOCKET_SECURE¶
Enable MQTT over Websocket Secure
Found in: Component config > ESP-MQTT Configurations > CONFIG_MQTT_TRANSPORT_WEBSOCKET
Enable MQTT transport over Websocket Secure.
CONFIG_MQTT_USE_CUSTOM_CONFIG¶
MQTT Using custom configurations
Found in: Component config > ESP-MQTT Configurations
Custom MQTT configurations.
CONFIG_MQTT_TCP_DEFAULT_PORT¶
Default MQTT over TCP port
Found in: Component config > ESP-MQTT Configurations > CONFIG_MQTT_USE_CUSTOM_CONFIG
Default MQTT over TCP port
CONFIG_MQTT_SSL_DEFAULT_PORT¶
Default MQTT over SSL port
Found in: Component config > ESP-MQTT Configurations > CONFIG_MQTT_USE_CUSTOM_CONFIG
Default MQTT over SSL port
CONFIG_MQTT_WS_DEFAULT_PORT¶
Default MQTT over Websocket port
Found in: Component config > ESP-MQTT Configurations > CONFIG_MQTT_USE_CUSTOM_CONFIG
Default MQTT over Websocket port
CONFIG_MQTT_WSS_DEFAULT_PORT¶
Default MQTT over Websocket Secure port
Found in: Component config > ESP-MQTT Configurations > CONFIG_MQTT_USE_CUSTOM_CONFIG
Default MQTT over Websocket Secure port
CONFIG_MQTT_BUFFER_SIZE¶
Default MQTT Buffer Size
Found in: Component config > ESP-MQTT Configurations > CONFIG_MQTT_USE_CUSTOM_CONFIG
This buffer size using for both transmit and receive
CONFIG_MQTT_TASK_STACK_SIZE¶
MQTT task stack size
Found in: Component config > ESP-MQTT Configurations > CONFIG_MQTT_USE_CUSTOM_CONFIG
MQTT task stack size
CONFIG_MQTT_DISABLE_API_LOCKS¶
Disable API locks
Found in: Component config > ESP-MQTT Configurations > CONFIG_MQTT_USE_CUSTOM_CONFIG
Default config employs API locks to protect internal structures. It is possible to disable these locks if the user code doesn’t access MQTT API from multiple concurrent tasks
CONFIG_MQTT_TASK_PRIORITY¶
MQTT task priority
Found in: Component config > ESP-MQTT Configurations > CONFIG_MQTT_USE_CUSTOM_CONFIG
MQTT task priority. Higher number denotes higher priority.
CONFIG_MQTT_TASK_CORE_SELECTION_ENABLED¶
Enable MQTT task core selection
Found in: Component config > ESP-MQTT Configurations
This will enable core selection
CONFIG_MQTT_TASK_CORE_SELECTION¶
Core to use ?
Found in: Component config > ESP-MQTT Configurations > CONFIG_MQTT_TASK_CORE_SELECTION_ENABLED
- Available options:
Core 0 (MQTT_USE_CORE_0)
Core 1 (MQTT_USE_CORE_1)
CONFIG_MQTT_CUSTOM_OUTBOX¶
Enable custom outbox implementation
Found in: Component config > ESP-MQTT Configurations
Set to true if a specific implementation of message outbox is needed (e.g. persistant outbox in NVM or similar).
NVS¶
Contains:
CONFIG_NVS_ENCRYPTION¶
Enable NVS encryption
Found in: Component config > NVS
This option enables encryption for NVS. When enabled, AES-XTS is used to encrypt the complete NVS data, except the page headers. It requires XTS encryption keys to be stored in an encrypted partition. This means enabling flash encryption is a pre-requisite for this feature.
OpenSSL¶
Contains:
CONFIG_OPENSSL_DEBUG¶
Enable OpenSSL debugging
Found in: Component config > OpenSSL
Enable OpenSSL debugging function.
If the option is enabled, “SSL_DEBUG” works.
CONFIG_OPENSSL_DEBUG_LEVEL¶
OpenSSL debugging level
Found in: Component config > OpenSSL > CONFIG_OPENSSL_DEBUG
OpenSSL debugging level.
Only function whose debugging level is higher than “OPENSSL_DEBUG_LEVEL” works.
For example: If OPENSSL_DEBUG_LEVEL = 2, you use function “SSL_DEBUG(1, “malloc failed”)”. Because 1 < 2, it will not print.
CONFIG_OPENSSL_LOWLEVEL_DEBUG¶
Enable OpenSSL low-level module debugging
Found in: Component config > OpenSSL > CONFIG_OPENSSL_DEBUG
If the option is enabled, low-level module debugging function of OpenSSL is enabled, e.g. mbedtls internal debugging function.
CONFIG_OPENSSL_ASSERT¶
Select OpenSSL assert function
Found in: Component config > OpenSSL
OpenSSL function needs “assert” function to check if input parameters are valid.
If you want to use assert debugging function, “OPENSSL_DEBUG” should be enabled.
- Available options:
Do nothing (OPENSSL_ASSERT_DO_NOTHING)
Do nothing and “SSL_ASSERT” does not work.
Check and exit (OPENSSL_ASSERT_EXIT)
Enable assert exiting, it will check and return error code.
Show debugging message (OPENSSL_ASSERT_DEBUG)
Enable assert debugging, it will check and show debugging message.
Show debugging message and exit (OPENSSL_ASSERT_DEBUG_EXIT)
Enable assert debugging and exiting, it will check, show debugging message and return error code.
Show debugging message and block (OPENSSL_ASSERT_DEBUG_BLOCK)
Enable assert debugging and blocking, it will check, show debugging message and block by “while (1);”.
PThreads¶
Contains:
CONFIG_ESP32_PTHREAD_TASK_PRIO_DEFAULT¶
Default task priority
Found in: Component config > PThreads
Priority used to create new tasks with default pthread parameters.
CONFIG_ESP32_PTHREAD_TASK_STACK_SIZE_DEFAULT¶
Default task stack size
Found in: Component config > PThreads
Stack size used to create new tasks with default pthread parameters.
CONFIG_PTHREAD_STACK_MIN¶
Minimum allowed pthread stack size
Found in: Component config > PThreads
Minimum allowed pthread stack size set in attributes passed to pthread_create
CONFIG_ESP32_PTHREAD_TASK_CORE_DEFAULT¶
Default pthread core affinity
Found in: Component config > PThreads
The default core to which pthreads are pinned.
- Available options:
No affinity (ESP32_DEFAULT_PTHREAD_CORE_NO_AFFINITY)
Core 0 (ESP32_DEFAULT_PTHREAD_CORE_0)
Core 1 (ESP32_DEFAULT_PTHREAD_CORE_1)
CONFIG_ESP32_PTHREAD_TASK_NAME_DEFAULT¶
SPI Flash driver¶
Contains:
CONFIG_SPI_FLASH_VERIFY_WRITE¶
Verify SPI flash writes
Found in: Component config > SPI Flash driver
If this option is enabled, any time SPI flash is written then the data will be read back and verified. This can catch hardware problems with SPI flash, or flash which was not erased before verification.
CONFIG_SPI_FLASH_LOG_FAILED_WRITE¶
Log errors if verification fails
Found in: Component config > SPI Flash driver > CONFIG_SPI_FLASH_VERIFY_WRITE
If this option is enabled, if SPI flash write verification fails then a log error line will be written with the address, expected & actual values. This can be useful when debugging hardware SPI flash problems.
CONFIG_SPI_FLASH_WARN_SETTING_ZERO_TO_ONE¶
Log warning if writing zero bits to ones
Found in: Component config > SPI Flash driver > CONFIG_SPI_FLASH_VERIFY_WRITE
If this option is enabled, any SPI flash write which tries to set zero bits in the flash to ones will log a warning. Such writes will not result in the requested data appearing identically in flash once written, as SPI NOR flash can only set bits to one when an entire sector is erased. After erasing, individual bits can only be written from one to zero.
Note that some software (such as SPIFFS) which is aware of SPI NOR flash may write one bits as an optimisation, relying on the data in flash becoming a bitwise AND of the new data and any existing data. Such software will log spurious warnings if this option is enabled.
CONFIG_SPI_FLASH_ENABLE_COUNTERS¶
Enable operation counters
Found in: Component config > SPI Flash driver
This option enables the following APIs:
spi_flash_reset_counters
spi_flash_dump_counters
spi_flash_get_counters
These APIs may be used to collect performance data for spi_flash APIs and to help understand behaviour of libraries which use SPI flash.
CONFIG_SPI_FLASH_ROM_DRIVER_PATCH¶
Enable SPI flash ROM driver patched functions
Found in: Component config > SPI Flash driver
Enable this flag to use patched versions of SPI flash ROM driver functions. This option is needed to write to flash on ESP32-D2WD, and any configuration where external SPI flash is connected to non-default pins.
CONFIG_SPI_FLASH_WRITING_DANGEROUS_REGIONS¶
Writing to dangerous flash regions
Found in: Component config > SPI Flash driver
SPI flash APIs can optionally abort or return a failure code if erasing or writing addresses that fall at the beginning of flash (covering the bootloader and partition table) or that overlap the app partition that contains the running app.
It is not recommended to ever write to these regions from an IDF app, and this check prevents logic errors or corrupted firmware memory from damaging these regions.
Note that this feature *does not* check calls to the esp_rom_xxx SPI flash ROM functions. These functions should not be called directly from IDF applications.
- Available options:
Aborts (SPI_FLASH_WRITING_DANGEROUS_REGIONS_ABORTS)
Fails (SPI_FLASH_WRITING_DANGEROUS_REGIONS_FAILS)
Allowed (SPI_FLASH_WRITING_DANGEROUS_REGIONS_ALLOWED)
CONFIG_SPI_FLASH_YIELD_DURING_ERASE¶
Enables yield operation during flash erase
Found in: Component config > SPI Flash driver
This allows to yield the CPUs between erase commands. Prevents starvation of other tasks.
CONFIG_SPI_FLASH_ERASE_YIELD_DURATION_MS¶
Duration of erasing to yield CPUs (ms)
Found in: Component config > SPI Flash driver > CONFIG_SPI_FLASH_YIELD_DURING_ERASE
If a duration of one erase command is large then it will yield CPUs after finishing a current command.
CONFIG_SPI_FLASH_ERASE_YIELD_TICKS¶
CPU release time (tick)
Found in: Component config > SPI Flash driver > CONFIG_SPI_FLASH_YIELD_DURING_ERASE
Defines how many ticks will be before returning to continue a erasing.
SPIFFS Configuration¶
Contains:
CONFIG_SPIFFS_MAX_PARTITIONS¶
Maximum Number of Partitions
Found in: Component config > SPIFFS Configuration
Define maximum number of partitions that can be mounted.
SPIFFS Cache Configuration¶
Contains:
CONFIG_SPIFFS_CACHE¶
Enable SPIFFS Cache
Found in: Component config > SPIFFS Configuration > SPIFFS Cache Configuration
Enables/disable memory read caching of nucleus file system operations.
CONFIG_SPIFFS_CACHE_WR¶
Enable SPIFFS Write Caching
Found in: Component config > SPIFFS Configuration > SPIFFS Cache Configuration > CONFIG_SPIFFS_CACHE
Enables memory write caching for file descriptors in hydrogen.
CONFIG_SPIFFS_CACHE_STATS¶
Enable SPIFFS Cache Statistics
Found in: Component config > SPIFFS Configuration > SPIFFS Cache Configuration > CONFIG_SPIFFS_CACHE
Enable/disable statistics on caching. Debug/test purpose only.
CONFIG_SPIFFS_PAGE_CHECK¶
Enable SPIFFS Page Check
Found in: Component config > SPIFFS Configuration
Always check header of each accessed page to ensure consistent state. If enabled it will increase number of reads from flash, especially if cache is disabled.
CONFIG_SPIFFS_GC_MAX_RUNS¶
Set Maximum GC Runs
Found in: Component config > SPIFFS Configuration
Define maximum number of GC runs to perform to reach desired free pages.
CONFIG_SPIFFS_GC_STATS¶
Enable SPIFFS GC Statistics
Found in: Component config > SPIFFS Configuration
Enable/disable statistics on gc. Debug/test purpose only.
CONFIG_SPIFFS_PAGE_SIZE¶
SPIFFS logical page size
Found in: Component config > SPIFFS Configuration
Logical page size of SPIFFS partition, in bytes. Must be multiple of flash page size (which is usually 256 bytes). Larger page sizes reduce overhead when storing large files, and improve filesystem performance when reading large files. Smaller page sizes reduce overhead when storing small (< page size) files.
CONFIG_SPIFFS_OBJ_NAME_LEN¶
Set SPIFFS Maximum Name Length
Found in: Component config > SPIFFS Configuration
Object name maximum length. Note that this length include the zero-termination character, meaning maximum string of characters can at most be SPIFFS_OBJ_NAME_LEN - 1.
SPIFFS_OBJ_NAME_LEN + SPIFFS_META_LENGTH should not exceed SPIFFS_PAGE_SIZE - 64.
CONFIG_SPIFFS_USE_MAGIC¶
Enable SPIFFS Filesystem Magic
Found in: Component config > SPIFFS Configuration
Enable this to have an identifiable spiffs filesystem. This will look for a magic in all sectors to determine if this is a valid spiffs system or not at mount time.
CONFIG_SPIFFS_USE_MAGIC_LENGTH¶
Enable SPIFFS Filesystem Length Magic
Found in: Component config > SPIFFS Configuration > CONFIG_SPIFFS_USE_MAGIC
If this option is enabled, the magic will also be dependent on the length of the filesystem. For example, a filesystem configured and formatted for 4 megabytes will not be accepted for mounting with a configuration defining the filesystem as 2 megabytes.
CONFIG_SPIFFS_META_LENGTH¶
Size of per-file metadata field
Found in: Component config > SPIFFS Configuration
This option sets the number of extra bytes stored in the file header. These bytes can be used in an application-specific manner. Set this to at least 4 bytes to enable support for saving file modification time.
SPIFFS_OBJ_NAME_LEN + SPIFFS_META_LENGTH should not exceed SPIFFS_PAGE_SIZE - 64.
CONFIG_SPIFFS_USE_MTIME¶
Save file modification time
Found in: Component config > SPIFFS Configuration
If enabled, then the first 4 bytes of per-file metadata will be used to store file modification time (mtime), accessible through stat/fstat functions. Modification time is updated when the file is opened.
Debug Configuration¶
Contains:
CONFIG_SPIFFS_DBG¶
Enable general SPIFFS debug
Found in: Component config > SPIFFS Configuration > Debug Configuration
Enabling this option will print general debug mesages to the console.
CONFIG_SPIFFS_API_DBG¶
Enable SPIFFS API debug
Found in: Component config > SPIFFS Configuration > Debug Configuration
Enabling this option will print API debug mesages to the console.
CONFIG_SPIFFS_GC_DBG¶
Enable SPIFFS Garbage Cleaner debug
Found in: Component config > SPIFFS Configuration > Debug Configuration
Enabling this option will print GC debug mesages to the console.
CONFIG_SPIFFS_CACHE_DBG¶
Enable SPIFFS Cache debug
Found in: Component config > SPIFFS Configuration > Debug Configuration
Enabling this option will print cache debug mesages to the console.
CONFIG_SPIFFS_CHECK_DBG¶
Enable SPIFFS Filesystem Check debug
Found in: Component config > SPIFFS Configuration > Debug Configuration
Enabling this option will print Filesystem Check debug mesages to the console.
CONFIG_SPIFFS_TEST_VISUALISATION¶
Enable SPIFFS Filesystem Visualization
Found in: Component config > SPIFFS Configuration > Debug Configuration
Enable this option to enable SPIFFS_vis function in the API.
TCP/IP Adapter¶
Contains:
CONFIG_IP_LOST_TIMER_INTERVAL¶
IP Address lost timer interval (seconds)
Found in: Component config > TCP/IP 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.
CONFIG_USE_TCPIP_STACK_LIB¶
TCP/IP Stack Library
Found in: Component config > TCP/IP Adapter
Choose the TCP/IP Stack to work, for example, LwIP, uIP, etc.
- Available options:
LwIP (TCPIP_LWIP)
lwIP is a small independent implementation of the TCP/IP protocol suite.
Unity unit testing library¶
Contains:
CONFIG_UNITY_ENABLE_FLOAT¶
Support for float type
Found in: Component config > Unity unit testing library
If not set, assertions on float arguments will not be available.
CONFIG_UNITY_ENABLE_DOUBLE¶
Support for double type
Found in: Component config > Unity unit testing library
If not set, assertions on double arguments will not be available.
CONFIG_UNITY_ENABLE_COLOR¶
Colorize test output
Found in: Component config > Unity unit testing library
If set, Unity will colorize test results using console escape sequences.
CONFIG_UNITY_ENABLE_IDF_TEST_RUNNER¶
Include ESP-IDF test registration/running helpers
Found in: Component config > Unity unit testing library
If set, then the following features will be available:
TEST_CASE macro which performs automatic registration of test functions
Functions to run registered test functions: unity_run_all_tests, unity_run_tests_with_filter, unity_run_single_test_by_name.
Interactive menu which lists test cases and allows choosing the tests to be run, available via unity_run_menu function.
Disable if a different test registration mechanism is used.
CONFIG_UNITY_ENABLE_FIXTURE¶
Include Unity test fixture
Found in: Component config > Unity unit testing library
If set, unity_fixture.h header file and associated source files are part of the build. These provide an optional set of macros and functions to implement test groups.
CONFIG_UNITY_ENABLE_BACKTRACE_ON_FAIL¶
Print a backtrace when a unit test fails
Found in: Component config > Unity unit testing library
If set, the unity framework will print the backtrace information before jumping back to the test menu. The jumping is usually occurs in assert functions such as TEST_ASSERT, TEST_FAIL etc.
Virtual file system¶
Contains:
CONFIG_SUPPRESS_SELECT_DEBUG_OUTPUT¶
Suppress select() related debug outputs
Found in: Component config > Virtual file system
Select() related functions might produce an unconveniently lot of debug outputs when one sets the default log level to DEBUG or higher. It is possible to suppress these debug outputs by enabling this option.
CONFIG_SUPPORT_TERMIOS¶
Add support for termios.h
Found in: Component config > Virtual file system
Disabling this option can save memory when the support for termios.h is not required.
Wear Levelling¶
Contains:
CONFIG_WL_SECTOR_SIZE¶
Wear Levelling library sector size
Found in: Component config > Wear Levelling
Sector size used by wear levelling library. You can set default sector size or size that will fit to the flash device sector size.
With sector size set to 4096 bytes, wear levelling library is more efficient. However if FAT filesystem is used on top of wear levelling library, it will need more temporary storage: 4096 bytes for each mounted filesystem and 4096 bytes for each opened file.
With sector size set to 512 bytes, wear levelling library will perform more operations with flash memory, but less RAM will be used by FAT filesystem library (512 bytes for the filesystem and 512 bytes for each file opened).
- Available options:
512 (WL_SECTOR_SIZE_512)
4096 (WL_SECTOR_SIZE_4096)
CONFIG_WL_SECTOR_MODE¶
Sector store mode
Found in: Component config > Wear Levelling
Specify the mode to store data into flash:
In Performance mode a data will be stored to the RAM and then stored back to the flash. Compared to the Safety mode, this operation is faster, but if power will be lost when erase sector operation is in progress, then the data from complete flash device sector will be lost.
In Safety mode data from complete flash device sector will be read from flash, modified, and then stored back to flash. Compared to the Performance mode, this operation is slower, but if power is lost during erase sector operation, then the data from full flash device sector will not be lost.
- Available options:
Perfomance (WL_SECTOR_MODE_PERF)
Safety (WL_SECTOR_MODE_SAFE)
Wi-Fi Provisioning Manager¶
Contains:
CONFIG_WIFI_PROV_SCAN_MAX_ENTRIES¶
Max Wi-Fi Scan Result Entries
Found in: Component config > Wi-Fi Provisioning Manager
This sets the maximum number of entries of Wi-Fi scan results that will be kept by the provisioning manager
Supplicant¶
Contains:
CONFIG_WPA_WPS_WARS¶
Enable WPS Inter operatability Fixes
Found in: Component config > Supplicant
Select this option to enable WPS related IOT fixes with different APs. This option fixes IOT related issues with APs which do not follow some of the standard of WPS-2.0 specification. However these do not include any of the security related bypassing, just simple configuration corrections. Current fixes under this flag: 1. Allow NULL-padded WPS attributes: Some APs keep NULL-padding at the end of some variable length WPS Attributes. This is not as par the WPS2.0 specs, but to avoid interop issues, ignore the padding by reducing the attribute length by 1. 2. Bypass WPS-Config method validation: Some APs set display/pbc button bit without setting virtual/phycial display/button bit which will cause M2 validation fail, bypassing WPS-Config method validation.
CONFIG_WPA_DEBUG_PRINT¶
Print debug messages from WPA Supplicant
Found in: Component config > Supplicant
Select this option to print logging information from WPA supplicant, this includes handshake information and key hex dumps depending on the project logging level.
Enabling this could increase the build size ~60kb depending on the project logging level.
Customisations¶
Because IDF builds by default with Warning On Undefined Variables, when the Kconfig tool generates Makefiles (the auto.conf file) its behaviour has been customised. In normal Kconfig, a variable which is set to “no” is undefined. In IDF’s version of Kconfig, this variable is defined in the Makefile but has an empty value.
(Note that ifdef and ifndef can still be used in Makefiles, because they test if a variable is defined and has a non-empty value.)
When generating header files for C & C++, the behaviour is not customised - so #ifdef can be used to test if a boolean config item is set or not.