alex/esp-idf
alex/esp-idf
1
0
Fork 0
mirror of https://github.com/espressif/esp-idf.git synced 2024-10-05 20:47:46 -04:00
Code Issues Actions 2 Packages Projects Releases Wiki Activity

Merge branch 'bugfix/correct_kconfigs' into 'master'

Browse Source 
Correct Kconfigs according to the coding style

See merge request idf/esp-idf!4172
This commit is contained in:
Angus Gratton 2019-01-30 09:24:22 +08:00
commit 0a2b54d2e3
106 changed files with 7563 additions and 7535 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

41
components/app_update/Kconfig.projbuild
View File

@ -1,26 +1,25 @@
menu "Application manager" menu "Application manager"
config APP_COMPILE_TIME_DATE config APP_COMPILE_TIME_DATE
bool "Use time/date stamp for app" bool "Use time/date stamp for app"
default y default y
help help
If set, then the app will be built with the current time/date stamp. It is stored in the app description structure. If set, then the app will be built with the current time/date stamp. It is stored in the app description
If not set, time/date stamp will be excluded from app image. structure. If not set, time/date stamp will be excluded from app image. This can be useful for getting the
This can be useful for getting the same binary image files made from the same source, same binary image files made from the same source, but at different times.
but at different times.
config APP_EXCLUDE_PROJECT_VER_VAR config APP_EXCLUDE_PROJECT_VER_VAR
bool "Exclude PROJECT_VER from firmware image" bool "Exclude PROJECT_VER from firmware image"
default n default n
help help
The PROJECT_VER variable from the build system will not affect the firmware image. 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. This value will not be contained in the esp_app_desc structure.
config APP_EXCLUDE_PROJECT_NAME_VAR config APP_EXCLUDE_PROJECT_NAME_VAR
bool "Exclude PROJECT_NAME from firmware image" bool "Exclude PROJECT_NAME from firmware image"
default n default n
help help
The PROJECT_NAME variable from the build system will not affect the firmware image. 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. This value will not be contained in the esp_app_desc structure.
endmenu # "Application manager" endmenu # "Application manager"

129
components/aws_iot/Kconfig
View File

@ -1,8 +1,8 @@
menuconfig AWS_IOT_SDK menuconfig AWS_IOT_SDK
bool "Amazon Web Services IoT Platform" bool "Amazon Web Services IoT Platform"
help help
Select this option to enable support for the AWS IoT platform, Select this option to enable support for the AWS IoT platform,
via the esp-idf component for the AWS IoT Device C SDK. via the esp-idf component for the AWS IoT Device C SDK.
config AWS_IOT_MQTT_HOST config AWS_IOT_MQTT_HOST
string "AWS IoT Endpoint Hostname" string "AWS IoT Endpoint Hostname"
@ -86,74 +86,79 @@ config AWS_IOT_MQTT_MAX_RECONNECT_WAIT_INTERVAL
menu "Thing Shadow" menu "Thing Shadow"
depends on AWS_IOT_SDK depends on AWS_IOT_SDK
config AWS_IOT_OVERRIDE_THING_SHADOW_RX_BUFFER config AWS_IOT_OVERRIDE_THING_SHADOW_RX_BUFFER
bool "Override Shadow RX buffer size" bool "Override Shadow RX buffer size"
depends on AWS_IOT_SDK depends on AWS_IOT_SDK
default n default n
help help
Allows setting a different Thing Shadow RX buffer Allows setting a different Thing Shadow RX buffer
size. This is the maximum size of a Thing Shadow size. This is the maximum size of a Thing Shadow
message in bytes, plus one. 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. 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 config AWS_IOT_SHADOW_MAX_SIZE_OF_RX_BUFFER
int "Maximum RX Buffer (bytes)" int "Maximum RX Buffer (bytes)"
depends on AWS_IOT_OVERRIDE_THING_SHADOW_RX_BUFFER depends on AWS_IOT_OVERRIDE_THING_SHADOW_RX_BUFFER
default 513 default 513
range 32 65536 range 32 65536
help help
Allows setting a different Thing Shadow RX buffer size. Allows setting a different Thing Shadow RX buffer size.
This is the maximum size of a Thing Shadow message in bytes, This is the maximum size of a Thing Shadow message in bytes,
plus one. plus one.
config AWS_IOT_SHADOW_MAX_SIZE_OF_UNIQUE_CLIENT_ID_BYTES config AWS_IOT_SHADOW_MAX_SIZE_OF_UNIQUE_CLIENT_ID_BYTES
int "Maximum unique client ID size (bytes)" int "Maximum unique client ID size (bytes)"
depends on AWS_IOT_SDK depends on AWS_IOT_SDK
default 80 default 80
range 4 1000 range 4 1000
help help
Maximum size of the Unique Client Id. Maximum size of the Unique Client Id.
config AWS_IOT_SHADOW_MAX_SIMULTANEOUS_ACKS config AWS_IOT_SHADOW_MAX_SIMULTANEOUS_ACKS
int "Maximum simultaneous responses" int "Maximum simultaneous responses"
depends on AWS_IOT_SDK depends on AWS_IOT_SDK
default 10 default 10
range 1 100 range 1 100
help help
At any given time we will wait for this many responses. This will correlate to the rate at which the shadow actions are requested 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 config AWS_IOT_SHADOW_MAX_SIMULTANEOUS_THINGNAMES
int "Maximum simultaneous Thing Name operations" int "Maximum simultaneous Thing Name operations"
depends on AWS_IOT_SDK depends on AWS_IOT_SDK
default 10 default 10
range 1 100 range 1 100
help help
We could perform shadow action on any thing Name and this is maximum Thing Names we can act on at any given time 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 config AWS_IOT_SHADOW_MAX_JSON_TOKEN_EXPECTED
int "Maximum expected JSON tokens" int "Maximum expected JSON tokens"
depends on AWS_IOT_SDK depends on AWS_IOT_SDK
default 120 default 120
help help
These are the max tokens that is expected to be in the Shadow JSON document. Includes the metadata which is published 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 config AWS_IOT_SHADOW_MAX_SHADOW_TOPIC_LENGTH_WITHOUT_THINGNAME
int "Maximum topic length (not including Thing Name)" int "Maximum topic length (not including Thing Name)"
depends on AWS_IOT_SDK depends on AWS_IOT_SDK
default 60 default 60
range 10 1000 range 10 1000
help help
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 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 config AWS_IOT_SHADOW_MAX_SIZE_OF_THING_NAME
int "Maximum Thing Name length" int "Maximum Thing Name length"
depends on AWS_IOT_SDK depends on AWS_IOT_SDK
default 20 default 20
range 4 1000 range 4 1000
help help
Maximum length of a Thing Name. Maximum length of a Thing Name.
endmenu # Thing Shadow endmenu # Thing Shadow

835
components/bootloader/Kconfig.projbuild
View File

@ -1,441 +1,474 @@
menu "Bootloader config" menu "Bootloader config"
choice LOG_BOOTLOADER_LEVEL choice LOG_BOOTLOADER_LEVEL
bool "Bootloader log verbosity" bool "Bootloader log verbosity"
default LOG_BOOTLOADER_LEVEL_INFO default LOG_BOOTLOADER_LEVEL_INFO
help help
Specify how much output to see in bootloader logs. Specify how much output to see in bootloader logs.
config LOG_BOOTLOADER_LEVEL_NONE config LOG_BOOTLOADER_LEVEL_NONE
bool "No output" bool "No output"
config LOG_BOOTLOADER_LEVEL_ERROR config LOG_BOOTLOADER_LEVEL_ERROR
bool "Error" bool "Error"
config LOG_BOOTLOADER_LEVEL_WARN config LOG_BOOTLOADER_LEVEL_WARN
bool "Warning" bool "Warning"
config LOG_BOOTLOADER_LEVEL_INFO config LOG_BOOTLOADER_LEVEL_INFO
bool "Info" bool "Info"
config LOG_BOOTLOADER_LEVEL_DEBUG config LOG_BOOTLOADER_LEVEL_DEBUG
bool "Debug" bool "Debug"
config LOG_BOOTLOADER_LEVEL_VERBOSE config LOG_BOOTLOADER_LEVEL_VERBOSE
bool "Verbose" bool "Verbose"
endchoice endchoice
config LOG_BOOTLOADER_LEVEL config LOG_BOOTLOADER_LEVEL
int int
default 0 if LOG_BOOTLOADER_LEVEL_NONE default 0 if LOG_BOOTLOADER_LEVEL_NONE
default 1 if LOG_BOOTLOADER_LEVEL_ERROR default 1 if LOG_BOOTLOADER_LEVEL_ERROR
default 2 if LOG_BOOTLOADER_LEVEL_WARN default 2 if LOG_BOOTLOADER_LEVEL_WARN
default 3 if LOG_BOOTLOADER_LEVEL_INFO default 3 if LOG_BOOTLOADER_LEVEL_INFO
default 4 if LOG_BOOTLOADER_LEVEL_DEBUG default 4 if LOG_BOOTLOADER_LEVEL_DEBUG
default 5 if LOG_BOOTLOADER_LEVEL_VERBOSE default 5 if LOG_BOOTLOADER_LEVEL_VERBOSE
config BOOTLOADER_SPI_WP_PIN config BOOTLOADER_SPI_WP_PIN
int "SPI Flash WP Pin when customising pins via efuse (read help)" int "SPI Flash WP Pin when customising pins via eFuse (read help)"
range 0 33 range 0 33
default 7 default 7
depends on FLASHMODE_QIO || FLASHMODE_QOUT depends on FLASHMODE_QIO || FLASHMODE_QOUT
help help
This value is ignored unless flash mode is set to QIO or QOUT *and* the SPI flash pins have been This value is ignored unless flash mode is set to QIO or QOUT *and* the SPI flash pins have been
overriden by setting the efuses SPI_PAD_CONFIG_xxx. overriden by setting the eFuses SPI_PAD_CONFIG_xxx.
When this is the case, the Efuse config only defines 3 of the 4 Quad I/O data pins. The WP pin (aka ESP32 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. That pin number is compiled into the bootloader pin "SD_DATA_3" or SPI flash pin "IO2") is not specified in eFuse. That pin number is compiled into the
instead. bootloader instead.
The default value (GPIO 7) is correct for WP pin on ESP32-D2WD integrated flash. The default value (GPIO 7) is correct for WP pin on ESP32-D2WD integrated flash.
choice BOOTLOADER_VDDSDIO_BOOST choice BOOTLOADER_VDDSDIO_BOOST
bool "VDDSDIO LDO voltage" bool "VDDSDIO LDO voltage"
default BOOTLOADER_VDDSDIO_BOOST_1_9V default BOOTLOADER_VDDSDIO_BOOST_1_9V
help help
If this option is enabled, and VDDSDIO LDO is set to 1.8V (using EFUSE 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 or MTDI bootstrapping pin), bootloader will change LDO settings to
output 1.9V instead. This helps prevent flash chip from browning out output 1.9V instead. This helps prevent flash chip from browning out
during flash programming operations. during flash programming operations.
This option has no effect if VDDSDIO is set to 3.3V, or if the internal This option has no effect if VDDSDIO is set to 3.3V, or if the internal
VDDSDIO regulator is disabled via efuse. VDDSDIO regulator is disabled via eFuse.
config BOOTLOADER_VDDSDIO_BOOST_1_8V config BOOTLOADER_VDDSDIO_BOOST_1_8V
bool "1.8V" bool "1.8V"
depends on !ESPTOOLPY_FLASHFREQ_80M depends on !ESPTOOLPY_FLASHFREQ_80M
config BOOTLOADER_VDDSDIO_BOOST_1_9V config BOOTLOADER_VDDSDIO_BOOST_1_9V
bool "1.9V" bool "1.9V"
endchoice endchoice
config BOOTLOADER_FACTORY_RESET config BOOTLOADER_FACTORY_RESET
bool "GPIO triggers factory reset" bool "GPIO triggers factory reset"
default N default N
help help
Allows to reset the device to factory settings: Allows to reset the device to factory settings:
- clear one or more data partitions; - clear one or more data partitions;
- boot from "factory" partition. - boot from "factory" partition.
The factory reset will occur if there is a GPIO input pulled low while device starts up. The factory reset will occur if there is a GPIO input pulled low while device starts up.
See settings below. See settings below.
config BOOTLOADER_NUM_PIN_FACTORY_RESET config BOOTLOADER_NUM_PIN_FACTORY_RESET
int "Number of the GPIO input for factory reset" int "Number of the GPIO input for factory reset"
depends on BOOTLOADER_FACTORY_RESET depends on BOOTLOADER_FACTORY_RESET
range 0 39 range 0 39
default 4 default 4
help help
The selected GPIO will be configured as an input with internal pull-up enabled. 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. 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. Note that GPIO34-39 do not have an internal pullup and an external one must be provided.
config BOOTLOADER_OTA_DATA_ERASE config BOOTLOADER_OTA_DATA_ERASE
bool "Clear OTA data on factory reset (select factory partition)" bool "Clear OTA data on factory reset (select factory partition)"
depends on BOOTLOADER_FACTORY_RESET depends on BOOTLOADER_FACTORY_RESET
help help
The device will boot from "factory" partition (or OTA slot 0 if no factory partition is present) after a 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 config BOOTLOADER_DATA_FACTORY_RESET
string "Comma-separated names of partitions to clear on factory reset" string "Comma-separated names of partitions to clear on factory reset"
depends on BOOTLOADER_FACTORY_RESET depends on BOOTLOADER_FACTORY_RESET
default "nvs" default "nvs"
help help
Allows customers to select which data partitions will be erased while 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 Specify the names of partitions as a comma-delimited with optional spaces for readability. (Like this:
bool "GPIO triggers boot from test app partition" "nvs, phy_init, ...")
default N Make sure that the name specified in the partition table and here are the same.
help Partitions of type "app" cannot be specified here.
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 config BOOTLOADER_APP_TEST
int "Number of the GPIO input to boot TEST partition" bool "GPIO triggers boot from test app partition"
depends on BOOTLOADER_APP_TEST default N
range 0 39 help
default 18 Allows to run the test app from "TEST" partition.
help A boot from "test" partition will occur if there is a GPIO input pulled low while device starts up.
The selected GPIO will be configured as an input with internal pull-up enabled. See settings below.
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 config BOOTLOADER_NUM_PIN_APP_TEST
int "Hold time of GPIO for reset/test mode (seconds)" int "Number of the GPIO input to boot TEST partition"
depends on BOOTLOADER_FACTORY_RESET || BOOTLOADER_APP_TEST depends on BOOTLOADER_APP_TEST
default 5 range 0 39
help default 18
The GPIO must be held low continuously for this period of time after reset help
before a factory reset or test partition boot (as applicable) is performed. 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_WDT_ENABLE config BOOTLOADER_HOLD_TIME_GPIO
bool "Use RTC watchdog in start code" int "Hold time of GPIO for reset/test mode (seconds)"
default y depends on BOOTLOADER_FACTORY_RESET || BOOTLOADER_APP_TEST
help default 5
Tracks the execution time of startup code. help
If the execution time is exceeded, the RTC_WDT will restart system. The GPIO must be held low continuously for this period of time after reset
It is also useful to prevent a lock up in start code caused by an unstable power source. before a factory reset or test partition boot (as applicable) is performed.
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 config BOOTLOADER_WDT_ENABLE
bool "Allows RTC watchdog disable in user code" bool "Use RTC watchdog in start code"
depends on BOOTLOADER_WDT_ENABLE default y
default n help
help Tracks the execution time of startup code.
If it is set, the client must itself reset or disable rtc_wdt in their code (app_main()). If the execution time is exceeded, the RTC_WDT will restart system.
Otherwise rtc_wdt will be disabled before calling app_main function. It is also useful to prevent a lock up in start code caused by an unstable power source.
Use function rtc_wdt_feed() for resetting counter of rtc_wdt. NOTE: Tracks the execution time starts from the bootloader code - re-set timeout, while selecting the
Use function rtc_wdt_disable() for disabling rtc_wdt. 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_TIME_MS config BOOTLOADER_WDT_DISABLE_IN_USER_CODE
int "Timeout for RTC watchdog (ms)" bool "Allows RTC watchdog disable in user code"
depends on BOOTLOADER_WDT_ENABLE depends on BOOTLOADER_WDT_ENABLE
default 9000 default n
range 0 120000 help
help If it is set, the client must itself reset or disable rtc_wdt in their code (app_main()).
Verify that this parameter is correct and more then the execution time. Otherwise rtc_wdt will be disabled before calling app_main function.
Pay attention to options such as reset to factory, trigger test partition and encryption on boot Use function rtc_wdt_feed() for resetting counter of rtc_wdt.
- these options can increase the execution time. Use function rtc_wdt_disable() for disabling rtc_wdt.
Note: RTC_WDT will reset while encryption operations will be performed.
config APP_ROLLBACK_ENABLE config BOOTLOADER_WDT_TIME_MS
bool "Enable app rollback support" int "Timeout for RTC watchdog (ms)"
default n depends on BOOTLOADER_WDT_ENABLE
help default 9000
After updating the app, the bootloader runs a new app with the "ESP_OTA_IMG_PENDING_VERIFY" state set. range 0 120000
This state prevents the re-run of this app. help
After the first boot of the new app in the user code, the function should be called to confirm Verify that this parameter is correct and more then the execution time.
the operability of the app or vice versa about its non-operability. If the app is working, Pay attention to options such as reset to factory, trigger test partition and encryption on boot
then it is marked as valid. Otherwise, it is marked as not valid and rolls back to the previous working app. - these options can increase the execution time.
A reboot is performed, and the app is booted before the software update. Note: RTC_WDT will reset while encryption operations will be performed.
Note: If during the first boot a new app the power goes out or the WDT works, then roll back will happen.
config APP_ROLLBACK_ENABLE
bool "Enable app rollback support"
default n
help
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.
endmenu # Bootloader endmenu # Bootloader
menu "Security features" menu "Security features"
# These three are the actual options to check in code, # These three are the actual options to check in code,
# selected by the displayed options # selected by the displayed options
config SECURE_SIGNED_ON_BOOT config SECURE_SIGNED_ON_BOOT
bool bool
default y default y
depends on SECURE_BOOT_ENABLED || SECURE_SIGNED_ON_BOOT_NO_SECURE_BOOT depends on SECURE_BOOT_ENABLED || SECURE_SIGNED_ON_BOOT_NO_SECURE_BOOT
config SECURE_SIGNED_ON_UPDATE
bool
default y
depends on SECURE_BOOT_ENABLED || SECURE_SIGNED_ON_UPDATE_NO_SECURE_BOOT
config SECURE_SIGNED_APPS
bool
default y
depends on SECURE_SIGNED_ON_BOOT || SECURE_SIGNED_ON_UPDATE
config SECURE_SIGNED_APPS_NO_SECURE_BOOT
bool "Require signed app images"
default n
depends on !SECURE_BOOT_ENABLED
help
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
bool "Bootloader verifies app signatures"
default n
depends on SECURE_SIGNED_APPS_NO_SECURE_BOOT
help
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
bool "Verify app signature on update"
default y
depends on SECURE_SIGNED_APPS_NO_SECURE_BOOT
help
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
bool "Enable hardware secure boot in bootloader (READ DOCS FIRST)"
default n
help
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 https://docs.espressif.com/projects/esp-idf/en/latest/security/secure-boot.html before enabling.
choice SECURE_BOOTLOADER_MODE
bool "Secure bootloader mode"
depends on SECURE_BOOT_ENABLED
default SECURE_BOOTLOADER_ONE_TIME_FLASH
config SECURE_SIGNED_ON_UPDATE config SECURE_BOOTLOADER_ONE_TIME_FLASH
bool bool "One-time flash"
default y help
depends on SECURE_BOOT_ENABLED || SECURE_SIGNED_ON_UPDATE_NO_SECURE_BOOT 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.
config SECURE_BOOTLOADER_REFLASHABLE
bool "Reflashable"
help
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.
endchoice
config SECURE_BOOT_BUILD_SIGNED_BINARIES
bool "Sign binaries during build"
depends on SECURE_SIGNED_APPS
default y
help
Once secure boot or signed app requirement is enabled, app images are required to be signed.
config SECURE_SIGNED_APPS If enabled (default), these binary files are signed as part of the build process. The file named in
bool "Secure boot private signing key" will be used to sign the image.
default y
depends on SECURE_SIGNED_ON_BOOT || SECURE_SIGNED_ON_UPDATE
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_SIGNED_APPS_NO_SECURE_BOOT config SECURE_BOOT_SIGNING_KEY
bool "Require signed app images" string "Secure boot private signing key"
default n depends on SECURE_BOOT_BUILD_SIGNED_BINARIES
depends on !SECURE_BOOT_ENABLED default secure_boot_signing_key.pem
help help
Require apps to be signed to verify their integrity. Path to the key file used to sign app images.
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. 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
config SECURE_SIGNED_ON_BOOT_NO_SECURE_BOOT See https://docs.espressif.com/projects/esp-idf/en/latest/security/secure-boot.html for details.
bool "Bootloader verifies app signatures"
default n config SECURE_BOOT_VERIFICATION_KEY
depends on SECURE_SIGNED_APPS_NO_SECURE_BOOT string "Secure boot public signature verification key"
help depends on SECURE_SIGNED_APPS && !SECURE_BOOT_BUILD_SIGNED_BINARIES
If this option is set, the bootloader will be compiled with code to verify that an app is signed before booting it. default signature_verification_key.bin
help
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.
If hardware secure boot is enabled, this option is always enabled and cannot be disabled. Key file is in raw binary format, and can be extracted from a
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. PEM formatted private key using the espsecure.py
extract_public_key command.
config SECURE_SIGNED_ON_UPDATE_NO_SECURE_BOOT Refer to https://docs.espressif.com/projects/esp-idf/en/latest/security/secure-boot.html before enabling.
bool "Verify app signature on update"
default y
depends on SECURE_SIGNED_APPS_NO_SECURE_BOOT
help
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, choice SECURE_BOOTLOADER_KEY_ENCODING
or esp_image_format.h APIs are used to verify apps. bool "Hardware Key Encoding"
depends on SECURE_BOOTLOADER_REFLASHABLE
default SECURE_BOOTLOADER_NO_ENCODING
help
If hardware secure boot is enabled, this option is always enabled and cannot be disabled. In reflashable secure bootloader mode, a hardware key is derived from the signing key (with SHA-256) and
If hardware secure boot is not enabled, this option still adds significant security against network-based attackers by preventing spoofing of OTA updates. can be written to eFuse with espefuse.py.
config SECURE_BOOT_ENABLED Normally this is a 256-bit key, but if 3/4 Coding Scheme is used on the device then the eFuse key is
bool "Enable hardware secure boot in bootloader (READ DOCS FIRST)" truncated to 192 bits.
default n
help
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. This configuration item doesn't change any firmware code, it only changes the size of key binary which is
generated at build time.
config SECURE_BOOTLOADER_KEY_ENCODING_256BIT
bool "No encoding (256 bit key)"
config SECURE_BOOTLOADER_KEY_ENCODING_192BIT
bool "3/4 encoding (192 bit key)"
When enabling secure boot, JTAG and ROM BASIC Interpreter are permanently disabled by default. endchoice
Refer to https://docs.espressif.com/projects/esp-idf/en/latest/security/secure-boot.html before enabling. config SECURE_BOOT_INSECURE
bool "Allow potentially insecure options"
choice SECURE_BOOTLOADER_MODE depends on SECURE_BOOT_ENABLED
bool "Secure bootloader mode" default N
depends on SECURE_BOOT_ENABLED help
default SECURE_BOOTLOADER_ONE_TIME_FLASH You can disable some of the default protections offered by secure boot, in order to enable testing or a
custom combination of security features.
config SECURE_BOOTLOADER_ONE_TIME_FLASH
bool "One-time flash" Only enable these options if you are very sure.
help
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. Refer to https://docs.espressif.com/projects/esp-idf/en/latest/security/secure-boot.html before enabling.
Enabling this option means that the bootloader cannot be changed after the first time it is booted. config FLASH_ENCRYPTION_ENABLED
bool "Enable flash encryption on boot (READ DOCS FIRST)"
config SECURE_BOOTLOADER_REFLASHABLE default N
bool "Reflashable" help
help If this option is set, flash contents will be encrypted by the bootloader on first boot.
Generate a reusable secure bootloader key, derived (via SHA-256) from the secure boot signing key.
Note: After first boot, the system will be permanently encrypted. Re-flashing an encrypted
This allows the secure bootloader to be re-flashed by anyone with access to the secure boot signing key. system is complicated and not always possible.
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. Read https://docs.espressif.com/projects/esp-idf/en/latest/security/flash-encryption.html before enabling.
endchoice config FLASH_ENCRYPTION_INSECURE
bool "Allow potentially insecure options"
config SECURE_BOOT_BUILD_SIGNED_BINARIES depends on FLASH_ENCRYPTION_ENABLED
bool "Sign binaries during build" default N
depends on SECURE_SIGNED_APPS help
default y You can disable some of the default protections offered by flash encryption, in order to enable testing or
help a custom combination of security features.
Once secure boot or signed app requirement is enabled, app images are required to be signed.
Only enable these options if you are very sure.
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.
Refer to https://docs.espressif.com/projects/esp-idf/en/latest/security/secure-boot.html and
If disabled, unsigned app/partition data will be built. They must be signed manually using espsecure.py (for example, on a remote signing server.) https://docs.espressif.com/projects/esp-idf/en/latest/security/flash-encryption.html for details.
config SECURE_BOOT_SIGNING_KEY menu "Potentially insecure options"
string "Secure boot private signing key" visible if FLASH_ENCRYPTION_INSECURE || SECURE_BOOT_INSECURE
depends on SECURE_BOOT_BUILD_SIGNED_BINARIES
default secure_boot_signing_key.pem # NOTE: Options in this menu NEED to have SECURE_BOOT_INSECURE
help # and/or FLASH_ENCRYPTION_INSECURE in "depends on", as the menu
Path to the key file used to sign app images. # itself doesn't enable/disable its children (if it's not set,
# it's possible for the insecure menu to be disabled but the insecure option
Key file is an ECDSA private key (NIST256p curve) in PEM format. # to remain on which is very bad.)
Path is evaluated relative to the project directory. config SECURE_BOOT_ALLOW_ROM_BASIC
bool "Leave ROM BASIC Interpreter available on reset"
You can generate a new signing key by running the following command: depends on SECURE_BOOT_INSECURE || FLASH_ENCRYPTION_INSECURE
espsecure.py generate_signing_key secure_boot_signing_key.pem default N
help
See docs/security/secure-boot.rst for details. By default, the BASIC ROM Console starts on reset if no valid bootloader is
read from the flash.
config SECURE_BOOT_VERIFICATION_KEY
string "Secure boot public signature verification key" When either flash encryption or secure boot are enabled, the default is to
depends on SECURE_SIGNED_APPS && !SECURE_BOOT_BUILD_SIGNED_BINARIES disable this BASIC fallback mode permanently via eFuse.
default signature_verification_key.bin
help If this option is set, this eFuse is not burned and the BASIC ROM Console may
Path to a public key file used to verify signed images. This key is compiled into the bootloader and/or app, remain accessible. Only set this option in testing environments.
to verify app images.
config SECURE_BOOT_ALLOW_JTAG
Key file is in raw binary format, and can be extracted from a bool "Allow JTAG Debugging"
PEM formatted private key using the espsecure.py depends on SECURE_BOOT_INSECURE || FLASH_ENCRYPTION_INSECURE
extract_public_key command. default N
help
Refer to https://docs.espressif.com/projects/esp-idf/en/latest/security/secure-boot.html before enabling. 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.
choice SECURE_BOOTLOADER_KEY_ENCODING
bool "Hardware Key Encoding" Setting this option leaves JTAG on for debugging, which negates all protections of flash encryption
depends on SECURE_BOOTLOADER_REFLASHABLE and some of the protections of secure boot.
default SECURE_BOOTLOADER_NO_ENCODING
help Only set this option in testing environments.
In reflashable secure bootloader mode, a hardware key is derived from the signing key (with SHA-256) and can be written to efuse config SECURE_BOOT_ALLOW_SHORT_APP_PARTITION
with espefuse.py. bool "Allow app partition length not 64KB aligned"
depends on SECURE_BOOT_INSECURE
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. help
If not set (default), app partition size must be a multiple of 64KB. App images are padded to 64KB
This configuration item doesn't change any firmware code, it only changes the size of key binary which is generated at build time. 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
config SECURE_BOOTLOADER_KEY_ENCODING_256BIT space. This prevents an attacker from appending unverified data after the app image in the flash,
bool "No encoding (256 bit key)" causing it to be mapped into the address space.
config SECURE_BOOTLOADER_KEY_ENCODING_192BIT Setting this option allows the app partition length to be unaligned, and disables padding of the app
bool "3/4 encoding (192 bit key)" 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.
endchoice
config FLASH_ENCRYPTION_UART_BOOTLOADER_ALLOW_ENCRYPT
config SECURE_BOOT_INSECURE bool "Leave UART bootloader encryption enabled"
bool "Allow potentially insecure options" depends on FLASH_ENCRYPTION_INSECURE
depends on SECURE_BOOT_ENABLED default N
default N help
help If not set (default), the bootloader will permanently disable UART bootloader encryption access on
You can disable some of the default protections offered by secure boot, in order to enable testing or a custom combination of security features. first boot. If set, the UART bootloader will still be able to access hardware encryption.
Only enable these options if you are very sure. It is recommended to only set this option in testing environments.
Refer to https://docs.espressif.com/projects/esp-idf/en/latest/security/secure-boot.html before enabling. config FLASH_ENCRYPTION_UART_BOOTLOADER_ALLOW_DECRYPT
bool "Leave UART bootloader decryption enabled"
config FLASH_ENCRYPTION_ENABLED depends on FLASH_ENCRYPTION_INSECURE
bool "Enable flash encryption on boot (READ DOCS FIRST)" default N
default N help
help If not set (default), the bootloader will permanently disable UART bootloader decryption access on
If this option is set, flash contents will be encrypted by the bootloader on first boot. first boot. If set, the UART bootloader will still be able to access hardware decryption.
Note: After first boot, the system will be permanently encrypted. Re-flashing an encrypted Only set this option in testing environments. Setting this option allows complete bypass of flash
system is complicated and not always possible. encryption.
Read https://docs.espressif.com/projects/esp-idf/en/latest/security/flash-encryption.html before enabling. config FLASH_ENCRYPTION_UART_BOOTLOADER_ALLOW_CACHE
bool "Leave UART bootloader flash cache enabled"
config FLASH_ENCRYPTION_INSECURE depends on FLASH_ENCRYPTION_INSECURE
bool "Allow potentially insecure options" default N
depends on FLASH_ENCRYPTION_ENABLED help
default N If not set (default), the bootloader will permanently disable UART bootloader flash cache access on
help first boot. If set, the UART bootloader will still be able to access the flash cache.
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 set this option in testing environments.
Only enable these options if you are very sure.
config SECURE_BOOT_TEST_MODE
Refer to docs/security/secure-boot.rst and docs/security/flash-encryption.rst for details. bool "Secure boot test mode: don't permanently set any eFuses"
depends on SECURE_BOOT_INSECURE
menu "Potentially insecure options" default N
visible if FLASH_ENCRYPTION_INSECURE || SECURE_BOOT_INSECURE help
If this option is set, all permanent secure boot changes (via eFuse) are disabled.
# NOTE: Options in this menu NEED to have SECURE_BOOT_INSECURE
# and/or FLASH_ENCRYPTION_INSECURE in "depends on", as the menu Log output will state changes which would be applied, but they will not be.
# itself doesn't enable/disable its children (if it's not set,
# it's possible for the insecure menu to be disabled but the insecure option This option is for testing purposes only - it completely disables secure boot protection.
# to remain on which is very bad.)
endmenu # Potentially Insecure
config SECURE_BOOT_ALLOW_ROM_BASIC
bool "Leave ROM BASIC Interpreter available on reset"
depends on SECURE_BOOT_INSECURE || FLASH_ENCRYPTION_INSECURE
default N
help
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
bool "Allow JTAG Debugging"
depends on SECURE_BOOT_INSECURE || FLASH_ENCRYPTION_INSECURE
default N
help
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
bool "Allow app partition length not 64KB aligned"
depends on SECURE_BOOT_INSECURE
help
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
bool "Leave UART bootloader encryption enabled"
depends on FLASH_ENCRYPTION_INSECURE
default N
help
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
bool "Leave UART bootloader decryption enabled"
depends on FLASH_ENCRYPTION_INSECURE
default N
help
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
bool "Leave UART bootloader flash cache enabled"
depends on FLASH_ENCRYPTION_INSECURE
default N
help
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 SECURE_BOOT_TEST_MODE
bool "Secure boot test mode: don't permanently set any efuses"
depends on SECURE_BOOT_INSECURE
default N
help
If this option is set, all permanent secure boot changes (via Efuse) are disabled.
Log output will state changes which would be applied, but they will not be.
This option is for testing purposes only - it completely disables secure boot protection.
endmenu # Potentially Insecure
endmenu # Security features endmenu # Security features

2404
components/bt/Kconfig
View File

File diff suppressed because it is too large Load Diff

113
components/driver/Kconfig
View File

@ -1,73 +1,74 @@
menu "Driver configurations" menu "Driver configurations"
menu "ADC configuration" menu "ADC configuration"
config ADC_FORCE_XPD_FSM config ADC_FORCE_XPD_FSM
bool "Use the FSM to control ADC power" bool "Use the FSM to control ADC power"
default n default n
help help
ADC power can be controlled by the FSM instead of software. This allows the ADC to 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 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. using the FSM control ADC power will increase the noise of ADC.
config ADC2_DISABLE_DAC config ADC2_DISABLE_DAC
bool "Disable DAC when ADC2 is used on GPIO 25 and 26" bool "Disable DAC when ADC2 is used on GPIO 25 and 26"
default y default y
help help
If this is set, the ADC2 driver will disables the output of the DAC corresponding to the specified channel. This is the default value. 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. For testing, disable this option so that we can measure the output of DAC by internal ADC.
endmenu # ADC Configuration endmenu # ADC Configuration
menu "SPI configuration" menu "SPI configuration"
config SPI_MASTER_IN_IRAM config SPI_MASTER_IN_IRAM
bool "Place transmitting functions of SPI master into IRAM" bool "Place transmitting functions of SPI master into IRAM"
default n default n
select SPI_MASTER_ISR_IN_IRAM select SPI_MASTER_ISR_IN_IRAM
help help
Normally only the ISR of SPI master is placed in the IRAM, so that it Normally only the ISR of SPI master is placed in the IRAM, so that it
can work without the flash when interrupt is triggered. can work without the flash when interrupt is triggered.
For other functions, there's some possibility that the flash cache For other functions, there's some possibility that the flash cache
miss when running inside and out of SPI functions, which may increase miss when running inside and out of SPI functions, which may increase
the interval of SPI transactions. the interval of SPI transactions.
Enable this to put ``queue_trans``, ``get_trans_result`` and Enable this to put ``queue_trans``, ``get_trans_result`` and
``transmit`` functions into the IRAM to avoid possible cache miss. ``transmit`` functions into the IRAM to avoid possible cache miss.
During unit test, this is enabled to measure the ideal case of api. During unit test, this is enabled to measure the ideal case of api.
config SPI_MASTER_ISR_IN_IRAM config SPI_MASTER_ISR_IN_IRAM
bool "Place SPI master ISR function into IRAM" bool "Place SPI master ISR function into IRAM"
default y default y
help help
Place the SPI master ISR in to IRAM to avoid possible cache miss. Place the SPI master ISR in to IRAM to avoid possible cache miss.
Also you can forbid the ISR being disabled during flash writing Also you can forbid the ISR being disabled during flash writing
access, by add ESP_INTR_FLAG_IRAM when initializing the driver. access, by add ESP_INTR_FLAG_IRAM when initializing the driver.
config SPI_SLAVE_IN_IRAM config SPI_SLAVE_IN_IRAM
bool "Place transmitting functions of SPI slave into IRAM" bool "Place transmitting functions of SPI slave into IRAM"
default n default n
select SPI_SLAVE_ISR_IN_IRAM select SPI_SLAVE_ISR_IN_IRAM
help help
Normally only the ISR of SPI slave is placed in the IRAM, so that it Normally only the ISR of SPI slave is placed in the IRAM, so that it
can work without the flash when interrupt is triggered. can work without the flash when interrupt is triggered.
For other functions, there's some possibility that the flash cache For other functions, there's some possibility that the flash cache
miss when running inside and out of SPI functions, which may increase miss when running inside and out of SPI functions, which may increase
the interval of SPI transactions. the interval of SPI transactions.
Enable this to put ``queue_trans``, ``get_trans_result`` and Enable this to put ``queue_trans``, ``get_trans_result`` and
``transmit`` functions into the IRAM to avoid possible cache miss. ``transmit`` functions into the IRAM to avoid possible cache miss.
config SPI_SLAVE_ISR_IN_IRAM config SPI_SLAVE_ISR_IN_IRAM
bool "Place SPI slave ISR function into IRAM" bool "Place SPI slave ISR function into IRAM"
default y default y
help help
Place the SPI slave ISR in to IRAM to avoid possible cache miss. Place the SPI slave ISR in to IRAM to avoid possible cache miss.
Also you can forbid the ISR being disabled during flash writing Also you can forbid the ISR being disabled during flash writing
access, by add ESP_INTR_FLAG_IRAM when initializing the driver. access, by add ESP_INTR_FLAG_IRAM when initializing the driver.
endmenu # SPI Configuration endmenu # SPI Configuration
endmenu # Driver configurations endmenu # Driver configurations

2569
components/esp32/Kconfig
View File

File diff suppressed because it is too large Load Diff

42
components/esp_adc_cal/Kconfig
View File

@ -1,27 +1,27 @@
menu "ADC-Calibration" menu "ADC-Calibration"
config ADC_CAL_EFUSE_TP_ENABLE config ADC_CAL_EFUSE_TP_ENABLE
bool "Use Two Point Values" bool "Use Two Point Values"
default "y" default "y"
help help
Some ESP32s have Two Point calibration values burned into eFuse BLOCK3. Some ESP32s have Two Point calibration values burned into eFuse BLOCK3.
This option will allow the ADC calibration component to characterize the This option will allow the ADC calibration component to characterize the
ADC-Voltage curve using Two Point values if they are available. ADC-Voltage curve using Two Point values if they are available.
config ADC_CAL_EFUSE_VREF_ENABLE config ADC_CAL_EFUSE_VREF_ENABLE
bool "Use eFuse Vref" bool "Use eFuse Vref"
default "y" default "y"
help help
Some ESP32s have Vref burned into eFuse BLOCK0. This option will allow Some ESP32s have Vref burned into eFuse BLOCK0. This option will allow
the ADC calibration component to characterize the ADC-Voltage curve using the ADC calibration component to characterize the ADC-Voltage curve using
eFuse Vref if it is available. eFuse Vref if it is available.
config ADC_CAL_LUT_ENABLE config ADC_CAL_LUT_ENABLE
bool "Use Lookup Tables" bool "Use Lookup Tables"
default "y" default "y"
help help
This option will allow the ADC calibration component to use Lookup Tables This option will allow the ADC calibration component to use Lookup Tables
to correct for non-linear behavior in 11db attenuation. Other attenuations 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. do not exhibit non-linear behavior hence will not be affected by this option.
endmenu # ADC-Calibration endmenu # ADC-Calibration

16
components/esp_event/Kconfig
View File

@ -1,11 +1,11 @@
menu "Event Loop Library" menu "Event Loop Library"
config EVENT_LOOP_PROFILING config EVENT_LOOP_PROFILING
bool "Enable event loop profiling" bool "Enable event loop profiling"
default n default n
help help
Enables collections of statistics in the event loop library such as the number of events posted to/recieved by an event loop, number of Enables collections of statistics in the event loop library such as the number of events posted
callbacks involved, number of events dropped to to a full event loop queue, run time of event handlers, and number of times/run to/recieved by an event loop, number of callbacks involved, number of events dropped to to a full event
time of each event handler. loop queue, run time of event handlers, and number of times/run time of each event handler.
endmenu endmenu

10
components/esp_http_client/Kconfig
View File

@ -1,10 +1,10 @@
menu "ESP HTTP client" menu "ESP HTTP client"
config ESP_HTTP_CLIENT_ENABLE_HTTPS config ESP_HTTP_CLIENT_ENABLE_HTTPS
bool "Enable https" bool "Enable https"
default y default y
help help
This option will enable https protocol by linking mbedtls library and initializing SSL transport This option will enable https protocol by linking mbedtls library and initializing SSL transport
endmenu endmenu

21
components/esp_http_server/Kconfig
View File

@ -1,15 +1,16 @@
menu "HTTP Server" menu "HTTP Server"
config HTTPD_MAX_REQ_HDR_LEN config HTTPD_MAX_REQ_HDR_LEN
int "Max HTTP Request Header Length" int "Max HTTP Request Header Length"
default 512 default 512
help help
This sets the maximum supported size of headers section in HTTP request packet to be processed by the 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 config HTTPD_MAX_URI_LEN
int "Max HTTP URI Length" int "Max HTTP URI Length"
default 512 default 512
help help
This sets the maximum supported size of HTTP request URI to be processed by the server This sets the maximum supported size of HTTP request URI to be processed by the server
endmenu endmenu

374
components/esptool_py/Kconfig.projbuild
View File

@ -1,223 +1,223 @@
menu "Serial flasher config" menu "Serial flasher config"
config ESPTOOLPY_PORT config ESPTOOLPY_PORT
string "Default serial port" string "Default serial port"
depends on !IDF_CMAKE depends on !IDF_CMAKE
default "/dev/ttyUSB0" default "/dev/ttyUSB0"
help help
The serial port that's connected to the ESP chip. This can be overridden by setting the ESPPORT The serial port that's connected to the ESP chip. This can be overridden by setting the ESPPORT
environment variable. environment variable.
This value is ignored when using the CMake-based build system or idf.py. This value is ignored when using the CMake-based build system or idf.py.
choice ESPTOOLPY_BAUD choice ESPTOOLPY_BAUD
prompt "Default baud rate" prompt "Default baud rate"
depends on !IDF_CMAKE depends on !IDF_CMAKE
default ESPTOOLPY_BAUD_115200B default ESPTOOLPY_BAUD_115200B
help help
Default baud rate to use while communicating with the ESP chip. Can be overridden by Default baud rate to use while communicating with the ESP chip. Can be overridden by
setting the ESPBAUD variable. setting the ESPBAUD variable.
This value is ignored when using the CMake-based build system or idf.py. This value is ignored when using the CMake-based build system or idf.py.
config ESPTOOLPY_BAUD_115200B config ESPTOOLPY_BAUD_115200B
bool "115200 baud" bool "115200 baud"
config ESPTOOLPY_BAUD_230400B config ESPTOOLPY_BAUD_230400B
bool "230400 baud" bool "230400 baud"
config ESPTOOLPY_BAUD_921600B config ESPTOOLPY_BAUD_921600B
bool "921600 baud" bool "921600 baud"
config ESPTOOLPY_BAUD_2MB config ESPTOOLPY_BAUD_2MB
bool "2Mbaud" bool "2Mbaud"
config ESPTOOLPY_BAUD_OTHER config ESPTOOLPY_BAUD_OTHER
bool "Other baud rate" bool "Other baud rate"
endchoice endchoice
config ESPTOOLPY_BAUD_OTHER_VAL config ESPTOOLPY_BAUD_OTHER_VAL
int "Other baud rate value" if ESPTOOLPY_BAUD_OTHER int "Other baud rate value" if ESPTOOLPY_BAUD_OTHER
default 115200 default 115200
config ESPTOOLPY_BAUD config ESPTOOLPY_BAUD
int int
depends on !IDF_CMAKE depends on !IDF_CMAKE
default 115200 if ESPTOOLPY_BAUD_115200B default 115200 if ESPTOOLPY_BAUD_115200B
default 230400 if ESPTOOLPY_BAUD_230400B default 230400 if ESPTOOLPY_BAUD_230400B
default 921600 if ESPTOOLPY_BAUD_921600B default 921600 if ESPTOOLPY_BAUD_921600B
default 2000000 if ESPTOOLPY_BAUD_2MB default 2000000 if ESPTOOLPY_BAUD_2MB
default ESPTOOLPY_BAUD_OTHER_VAL if ESPTOOLPY_BAUD_OTHER default ESPTOOLPY_BAUD_OTHER_VAL if ESPTOOLPY_BAUD_OTHER
config ESPTOOLPY_COMPRESSED config ESPTOOLPY_COMPRESSED
bool "Use compressed upload" bool "Use compressed upload"
depends on !IDF_CMAKE depends on !IDF_CMAKE
default "y" default "y"
help help
The flasher tool can send data compressed using zlib, letting the ROM on the ESP chip 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 decompress it on the fly before flashing it. For most payloads, this should result in a
speed increase. speed increase.
choice FLASHMODE choice FLASHMODE
prompt "Flash SPI mode" prompt "Flash SPI mode"
default FLASHMODE_DIO default FLASHMODE_DIO
help help
Mode the flash chip is flashed in, as well as the default mode for the Mode the flash chip is flashed in, as well as the default mode for the
binary to run in. binary to run in.
config FLASHMODE_QIO config FLASHMODE_QIO
bool "QIO" bool "QIO"
config FLASHMODE_QOUT config FLASHMODE_QOUT
bool "QOUT" bool "QOUT"
config FLASHMODE_DIO config FLASHMODE_DIO
bool "DIO" bool "DIO"
config FLASHMODE_DOUT config FLASHMODE_DOUT
bool "DOUT" bool "DOUT"
endchoice endchoice
# Note: we use esptool.py to flash bootloader in # Note: we use esptool.py to flash bootloader in
# dio mode for QIO/QOUT, bootloader then upgrades # dio mode for QIO/QOUT, bootloader then upgrades
# itself to quad mode during initialisation # itself to quad mode during initialisation
config ESPTOOLPY_FLASHMODE config ESPTOOLPY_FLASHMODE
string string
default "dio" if FLASHMODE_QIO default "dio" if FLASHMODE_QIO
default "dio" if FLASHMODE_QOUT default "dio" if FLASHMODE_QOUT
default "dio" if FLASHMODE_DIO default "dio" if FLASHMODE_DIO
default "dout" if FLASHMODE_DOUT default "dout" if FLASHMODE_DOUT
choice ESPTOOLPY_FLASHFREQ choice ESPTOOLPY_FLASHFREQ
prompt "Flash SPI speed" prompt "Flash SPI speed"
default ESPTOOLPY_FLASHFREQ_40M default ESPTOOLPY_FLASHFREQ_40M
help help
The SPI flash frequency to be used. The SPI flash frequency to be used.
config ESPTOOLPY_FLASHFREQ_80M config ESPTOOLPY_FLASHFREQ_80M
bool "80 MHz" bool "80 MHz"
config ESPTOOLPY_FLASHFREQ_40M config ESPTOOLPY_FLASHFREQ_40M
bool "40 MHz" bool "40 MHz"
config ESPTOOLPY_FLASHFREQ_26M config ESPTOOLPY_FLASHFREQ_26M
bool "26 MHz" bool "26 MHz"
config ESPTOOLPY_FLASHFREQ_20M config ESPTOOLPY_FLASHFREQ_20M
bool "20 MHz" bool "20 MHz"
endchoice endchoice
config ESPTOOLPY_FLASHFREQ config ESPTOOLPY_FLASHFREQ
string string
default "80m" if ESPTOOLPY_FLASHFREQ_80M default "80m" if ESPTOOLPY_FLASHFREQ_80M
default "40m" if ESPTOOLPY_FLASHFREQ_40M default "40m" if ESPTOOLPY_FLASHFREQ_40M
default "26m" if ESPTOOLPY_FLASHFREQ_26M default "26m" if ESPTOOLPY_FLASHFREQ_26M
default "20m" if ESPTOOLPY_FLASHFREQ_20M default "20m" if ESPTOOLPY_FLASHFREQ_20M
choice ESPTOOLPY_FLASHSIZE choice ESPTOOLPY_FLASHSIZE
prompt "Flash size" prompt "Flash size"
default ESPTOOLPY_FLASHSIZE_2MB default ESPTOOLPY_FLASHSIZE_2MB
help help
SPI flash size, in megabytes SPI flash size, in megabytes
config ESPTOOLPY_FLASHSIZE_1MB config ESPTOOLPY_FLASHSIZE_1MB
bool "1 MB" bool "1 MB"
config ESPTOOLPY_FLASHSIZE_2MB config ESPTOOLPY_FLASHSIZE_2MB
bool "2 MB" bool "2 MB"
config ESPTOOLPY_FLASHSIZE_4MB config ESPTOOLPY_FLASHSIZE_4MB
bool "4 MB" bool "4 MB"
config ESPTOOLPY_FLASHSIZE_8MB config ESPTOOLPY_FLASHSIZE_8MB
bool "8 MB" bool "8 MB"
config ESPTOOLPY_FLASHSIZE_16MB config ESPTOOLPY_FLASHSIZE_16MB
bool "16 MB" bool "16 MB"
endchoice endchoice
config ESPTOOLPY_FLASHSIZE config ESPTOOLPY_FLASHSIZE
string string
default "1MB" if ESPTOOLPY_FLASHSIZE_1MB default "1MB" if ESPTOOLPY_FLASHSIZE_1MB
default "2MB" if ESPTOOLPY_FLASHSIZE_2MB default "2MB" if ESPTOOLPY_FLASHSIZE_2MB
default "4MB" if ESPTOOLPY_FLASHSIZE_4MB default "4MB" if ESPTOOLPY_FLASHSIZE_4MB
default "8MB" if ESPTOOLPY_FLASHSIZE_8MB default "8MB" if ESPTOOLPY_FLASHSIZE_8MB
default "16MB" if ESPTOOLPY_FLASHSIZE_16MB default "16MB" if ESPTOOLPY_FLASHSIZE_16MB
config ESPTOOLPY_FLASHSIZE_DETECT config ESPTOOLPY_FLASHSIZE_DETECT
bool "Detect flash size when flashing bootloader" bool "Detect flash size when flashing bootloader"
default y default y
help help
If this option is set, 'make flash' targets will automatically detect If this option is set, 'make flash' targets will automatically detect
the flash size and update the bootloader image when flashing. the flash size and update the bootloader image when flashing.
choice ESPTOOLPY_BEFORE choice ESPTOOLPY_BEFORE
prompt "Before flashing" prompt "Before flashing"
default ESPTOOLPY_BEFORE_RESET default ESPTOOLPY_BEFORE_RESET
help help
Configure whether esptool.py should reset the ESP32 before flashing. Configure whether esptool.py should reset the ESP32 before flashing.
Automatic resetting depends on the RTS & DTR signals being Automatic resetting depends on the RTS & DTR signals being
wired from the serial port to the ESP32. Most USB development wired from the serial port to the ESP32. Most USB development
boards do this internally. boards do this internally.
config ESPTOOLPY_BEFORE_RESET config ESPTOOLPY_BEFORE_RESET
bool "Reset to bootloader" bool "Reset to bootloader"
config ESPTOOLPY_BEFORE_NORESET config ESPTOOLPY_BEFORE_NORESET
bool "No reset" bool "No reset"
endchoice endchoice
config ESPTOOLPY_BEFORE config ESPTOOLPY_BEFORE
string string
default "default_reset" if ESPTOOLPY_BEFORE_RESET default "default_reset" if ESPTOOLPY_BEFORE_RESET
default "no_reset" if ESPTOOLPY_BEFORE_NORESET default "no_reset" if ESPTOOLPY_BEFORE_NORESET
choice ESPTOOLPY_AFTER choice ESPTOOLPY_AFTER
prompt "After flashing" prompt "After flashing"
default ESPTOOLPY_AFTER_RESET default ESPTOOLPY_AFTER_RESET
help help
Configure whether esptool.py should reset the ESP32 after flashing. Configure whether esptool.py should reset the ESP32 after flashing.
Automatic resetting depends on the RTS & DTR signals being Automatic resetting depends on the RTS & DTR signals being
wired from the serial port to the ESP32. Most USB development wired from the serial port to the ESP32. Most USB development
boards do this internally. boards do this internally.
config ESPTOOLPY_AFTER_RESET config ESPTOOLPY_AFTER_RESET
bool "Reset after flashing" bool "Reset after flashing"
config ESPTOOLPY_AFTER_NORESET config ESPTOOLPY_AFTER_NORESET
bool "Stay in bootloader" bool "Stay in bootloader"
endchoice endchoice
config ESPTOOLPY_AFTER config ESPTOOLPY_AFTER
string string
default "hard_reset" if ESPTOOLPY_AFTER_RESET default "hard_reset" if ESPTOOLPY_AFTER_RESET
default "no_reset" if ESPTOOLPY_AFTER_NORESET default "no_reset" if ESPTOOLPY_AFTER_NORESET
choice MONITOR_BAUD choice MONITOR_BAUD
prompt "'make monitor' baud rate" prompt "'make monitor' baud rate"
default MONITOR_BAUD_115200B default MONITOR_BAUD_115200B
help help
Baud rate to use when running 'make monitor' to view serial output Baud rate to use when running 'make monitor' to view serial output
from a running chip. from a running chip.
Can override by setting the MONITORBAUD environment variable. Can override by setting the MONITORBAUD environment variable.
config MONITOR_BAUD_9600B config MONITOR_BAUD_9600B
bool "9600 bps" bool "9600 bps"
config MONITOR_BAUD_57600B config MONITOR_BAUD_57600B
bool "57600 bps" bool "57600 bps"
config MONITOR_BAUD_115200B config MONITOR_BAUD_115200B
bool "115200 bps" bool "115200 bps"
config MONITOR_BAUD_230400B config MONITOR_BAUD_230400B
bool "230400 bps" bool "230400 bps"
config MONITOR_BAUD_921600B config MONITOR_BAUD_921600B
bool "921600 bps" bool "921600 bps"
config MONITOR_BAUD_2MB config MONITOR_BAUD_2MB
bool "2 Mbps" bool "2 Mbps"
config MONITOR_BAUD_OTHER config MONITOR_BAUD_OTHER
bool "Custom baud rate" bool "Custom baud rate"
endchoice endchoice
config MONITOR_BAUD_OTHER_VAL config MONITOR_BAUD_OTHER_VAL
int "Custom baud rate value" if MONITOR_BAUD_OTHER int "Custom baud rate value" if MONITOR_BAUD_OTHER
default 115200 default 115200
config MONITOR_BAUD config MONITOR_BAUD
int int
default 9600 if MONITOR_BAUD_9600B default 9600 if MONITOR_BAUD_9600B
default 57600 if MONITOR_BAUD_57600B default 57600 if MONITOR_BAUD_57600B
default 115200 if MONITOR_BAUD_115200B default 115200 if MONITOR_BAUD_115200B
default 230400 if MONITOR_BAUD_230400B default 230400 if MONITOR_BAUD_230400B
default 921600 if MONITOR_BAUD_921600B default 921600 if MONITOR_BAUD_921600B
default 2000000 if MONITOR_BAUD_2MB default 2000000 if MONITOR_BAUD_2MB
default MONITOR_BAUD_OTHER_VAL if MONITOR_BAUD_OTHER default MONITOR_BAUD_OTHER_VAL if MONITOR_BAUD_OTHER
endmenu endmenu

332
components/fatfs/Kconfig
View File

@ -1,183 +1,183 @@
menu "FAT Filesystem support" menu "FAT Filesystem support"
choice FATFS_CHOOSE_CODEPAGE choice FATFS_CHOOSE_CODEPAGE
prompt "OEM Code Page" prompt "OEM Code Page"
default FATFS_CODEPAGE_437 default FATFS_CODEPAGE_437
help help
OEM code page used for file name encodings. 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.
config FATFS_CODEPAGE_DYNAMIC If "Dynamic" is selected, code page can be chosen at runtime using
bool "Dynamic (all code pages supported)" f_setcp function. Note that choosing this option will increase
config FATFS_CODEPAGE_437 application size by ~480kB.
bool "US (CP437)"
config FATFS_CODEPAGE_720
bool "Arabic (CP720)"
config FATFS_CODEPAGE_737
bool "Greek (CP737)"
config FATFS_CODEPAGE_771
bool "KBL (CP771)"
config FATFS_CODEPAGE_775
bool "Baltic (CP775)"
config FATFS_CODEPAGE_850
bool "Latin 1 (CP850)"
config FATFS_CODEPAGE_852
bool "Latin 2 (CP852)"
config FATFS_CODEPAGE_855
bool "Cyrillic (CP855)"
config FATFS_CODEPAGE_857
bool "Turkish (CP857)"
config FATFS_CODEPAGE_860
bool "Portugese (CP860)"
config FATFS_CODEPAGE_861
bool "Icelandic (CP861)"
config FATFS_CODEPAGE_862
bool "Hebrew (CP862)"
config FATFS_CODEPAGE_863
bool "Canadian French (CP863)"
config FATFS_CODEPAGE_864
bool "Arabic (CP864)"
config FATFS_CODEPAGE_865
bool "Nordic (CP865)"
config FATFS_CODEPAGE_866
bool "Russian (CP866)"
config FATFS_CODEPAGE_869
bool "Greek 2 (CP869)"
config FATFS_CODEPAGE_932
bool "Japanese (DBCS) (CP932)"
config FATFS_CODEPAGE_936
bool "Simplified Chinese (DBCS) (CP936)"
config FATFS_CODEPAGE_949
bool "Korean (DBCS) (CP949)"
config FATFS_CODEPAGE_950
bool "Traditional Chinese (DBCS) (CP950)"
endchoice config FATFS_CODEPAGE_DYNAMIC
bool "Dynamic (all code pages supported)"
config FATFS_CODEPAGE_437
bool "US (CP437)"
config FATFS_CODEPAGE_720
bool "Arabic (CP720)"
config FATFS_CODEPAGE_737
bool "Greek (CP737)"
config FATFS_CODEPAGE_771
bool "KBL (CP771)"
config FATFS_CODEPAGE_775
bool "Baltic (CP775)"
config FATFS_CODEPAGE_850
bool "Latin 1 (CP850)"
config FATFS_CODEPAGE_852
bool "Latin 2 (CP852)"
config FATFS_CODEPAGE_855
bool "Cyrillic (CP855)"
config FATFS_CODEPAGE_857
bool "Turkish (CP857)"
config FATFS_CODEPAGE_860
bool "Portugese (CP860)"
config FATFS_CODEPAGE_861
bool "Icelandic (CP861)"
config FATFS_CODEPAGE_862
bool "Hebrew (CP862)"
config FATFS_CODEPAGE_863
bool "Canadian French (CP863)"
config FATFS_CODEPAGE_864
bool "Arabic (CP864)"
config FATFS_CODEPAGE_865
bool "Nordic (CP865)"
config FATFS_CODEPAGE_866
bool "Russian (CP866)"
config FATFS_CODEPAGE_869
bool "Greek 2 (CP869)"
config FATFS_CODEPAGE_932
bool "Japanese (DBCS) (CP932)"
config FATFS_CODEPAGE_936
bool "Simplified Chinese (DBCS) (CP936)"
config FATFS_CODEPAGE_949
bool "Korean (DBCS) (CP949)"
config FATFS_CODEPAGE_950
bool "Traditional Chinese (DBCS) (CP950)"
config FATFS_CODEPAGE endchoice
int
default 0 if FATFS_CODEPAGE_DYNAMIC
default 437 if FATFS_CODEPAGE_437
default 720 if FATFS_CODEPAGE_720
default 737 if FATFS_CODEPAGE_737
default 771 if FATFS_CODEPAGE_771
default 775 if FATFS_CODEPAGE_775
default 850 if FATFS_CODEPAGE_850
default 852 if FATFS_CODEPAGE_852
default 855 if FATFS_CODEPAGE_855
default 857 if FATFS_CODEPAGE_857
default 860 if FATFS_CODEPAGE_860
default 861 if FATFS_CODEPAGE_861
default 862 if FATFS_CODEPAGE_862
default 863 if FATFS_CODEPAGE_863
default 864 if FATFS_CODEPAGE_864
default 865 if FATFS_CODEPAGE_865
default 866 if FATFS_CODEPAGE_866
default 869 if FATFS_CODEPAGE_869
default 932 if FATFS_CODEPAGE_932
default 936 if FATFS_CODEPAGE_936
default 949 if FATFS_CODEPAGE_949
default 950 if FATFS_CODEPAGE_950
default 437
choice FATFS_LONG_FILENAMES config FATFS_CODEPAGE
prompt "Long filename support" int
default FATFS_LFN_NONE default 0 if FATFS_CODEPAGE_DYNAMIC
help default 437 if FATFS_CODEPAGE_437
Support long filenames in FAT. Long filename data increases default 720 if FATFS_CODEPAGE_720
memory usage. FATFS can be configured to store the buffer for default 737 if FATFS_CODEPAGE_737
long filename data in stack or heap. default 771 if FATFS_CODEPAGE_771
default 775 if FATFS_CODEPAGE_775
default 850 if FATFS_CODEPAGE_850
default 852 if FATFS_CODEPAGE_852
default 855 if FATFS_CODEPAGE_855
default 857 if FATFS_CODEPAGE_857
default 860 if FATFS_CODEPAGE_860
default 861 if FATFS_CODEPAGE_861
default 862 if FATFS_CODEPAGE_862
default 863 if FATFS_CODEPAGE_863
default 864 if FATFS_CODEPAGE_864
default 865 if FATFS_CODEPAGE_865
default 866 if FATFS_CODEPAGE_866
default 869 if FATFS_CODEPAGE_869
default 932 if FATFS_CODEPAGE_932
default 936 if FATFS_CODEPAGE_936
default 949 if FATFS_CODEPAGE_949
default 950 if FATFS_CODEPAGE_950
default 437
config FATFS_LFN_NONE choice FATFS_LONG_FILENAMES
bool "No long filenames" prompt "Long filename support"
config FATFS_LFN_HEAP default FATFS_LFN_NONE
bool "Long filename buffer in heap" help
config FATFS_LFN_STACK Support long filenames in FAT. Long filename data increases
bool "Long filename buffer on stack" memory usage. FATFS can be configured to store the buffer for
endchoice long filename data in stack or heap.
config FATFS_MAX_LFN config FATFS_LFN_NONE
int "Max long filename length" bool "No long filenames"
depends on !FATFS_LFN_NONE config FATFS_LFN_HEAP
default 255 bool "Long filename buffer in heap"
range 12 255 config FATFS_LFN_STACK
help bool "Long filename buffer on stack"
Maximum long filename length. Can be reduced to save RAM. endchoice
choice FATFS_API_ENCODING config FATFS_MAX_LFN
prompt "API character encoding" int "Max long filename length"
depends on !FATFS_LFN_NONE depends on !FATFS_LFN_NONE
default FATFS_API_ENCODING_ANSI_OEM default 255
help range 12 255
Choose encoding for character and string arguments/returns when using help
FATFS APIs. The encoding of arguments will usually depend on text Maximum long filename length. Can be reduced to save RAM.
editor settings.
config FATFS_API_ENCODING_ANSI_OEM choice FATFS_API_ENCODING
bool "API uses ANSI/OEM encoding" prompt "API character encoding"
config FATFS_API_ENCODING_UTF_16 depends on !FATFS_LFN_NONE
bool "API uses UTF-16 encoding" default FATFS_API_ENCODING_ANSI_OEM
config FATFS_API_ENCODING_UTF_8 help
bool "API uses UTF-8 encoding" Choose encoding for character and string arguments/returns when using
endchoice FATFS APIs. The encoding of arguments will usually depend on text
editor settings.
config FATFS_FS_LOCK config FATFS_API_ENCODING_ANSI_OEM
int "Number of simultaneously open files protected by lock function" bool "API uses ANSI/OEM encoding"
default 0 config FATFS_API_ENCODING_UTF_16
range 0 65535 bool "API uses UTF-16 encoding"
help config FATFS_API_ENCODING_UTF_8
This option sets the FATFS configuration value _FS_LOCK. bool "API uses UTF-8 encoding"
The option _FS_LOCK switches file lock function to control duplicated file open endchoice
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 config FATFS_FS_LOCK
int "Timeout for acquiring a file lock, ms" int "Number of simultaneously open files protected by lock function"
default 10000 default 0
help range 0 65535
This option sets FATFS configuration value _FS_TIMEOUT, scaled to milliseconds. help
Sets the number of milliseconds FATFS will wait to acquire a mutex when This option sets the FATFS configuration value _FS_LOCK.
operating on an open file. For example, if one task is performing a lenghty The option _FS_LOCK switches file lock function to control duplicated file open
operation, another task will wait for the first task to release the lock, and illegal operation to open objects.
and time out after amount of time set by this option.
config FATFS_PER_FILE_CACHE * 0: Disable file lock function. To avoid volume corruption, application
bool "Use separate cache for each file" should avoid illegal open, remove and rename to the open objects.
default y
help * >0: Enable file lock function. The value defines how many files/sub-directories
This option affects FATFS configuration value _FS_TINY. can be opened simultaneously under file lock control.
If this option is set, _FS_TINY is 0, and each open file has its own cache, Note that the file lock control is independent of re-entrancy.
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 config FATFS_TIMEOUT_MS
and writes to the storage for some operations. int "Timeout for acquiring a file lock, ms"
default 10000
If this option is not set, _FS_TINY is 1, and single cache is used for help
all open files, size is also equal to _MAX_SS variable. This reduces the This option sets FATFS configuration value _FS_TIMEOUT, scaled to milliseconds.
amount of heap used when multiple files are open, but increases the number Sets the number of milliseconds FATFS will wait to acquire a mutex when
of read and write operations which FATFS needs to make. 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_ALLOC_PREFER_EXTRAM config FATFS_PER_FILE_CACHE
bool "Perfer external RAM when allocating FATFS buffers" bool "Use separate cache for each file"
default y default y
depends on SPIRAM_USE_CAPS_ALLOC || SPIRAM_USE_MALLOC help
help This option affects FATFS configuration value _FS_TINY.
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 If this option is set, _FS_TINY is 0, and each open file has its own cache,
be allocated from the internal RAM. size of the cache is equal to the _MAX_SS variable (512 or 4096 bytes).
Disable this option if optimizing for performance. Enable this option if This option uses more RAM if more than 1 file is open, but needs less reads
optimizing for internal memory size. 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
bool "Perfer external RAM when allocating FATFS buffers"
default y
depends on SPIRAM_USE_CAPS_ALLOC || SPIRAM_USE_MALLOC
help
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.
endmenu endmenu

192
components/freemodbus/Kconfig
View File

@ -1,109 +1,109 @@
menu "Modbus configuration" menu "Modbus configuration"
config MB_QUEUE_LENGTH config MB_QUEUE_LENGTH
int "Modbus serial task queue length" int "Modbus serial task queue length"
range 0 200 range 0 200
default 20 default 20
help help
Modbus serial driver queue length. It is used by event queue task. Modbus serial driver queue length. It is used by event queue task.
See the serial driver API for more information. See the serial driver API for more information.
config MB_SERIAL_TASK_STACK_SIZE
int "Modbus serial task stack size"
range 768 8192
default 2048
help
Modbus serial task stack size for event queue task.
It may be adjusted when debugging is enabled (for example).
config MB_SERIAL_BUF_SIZE config MB_SERIAL_TASK_STACK_SIZE
int "Modbus serial task RX/TX buffer size" int "Modbus serial task stack size"
range 0 2048 range 768 8192
default 256 default 2048
help help
Modbus serial task RX and TX buffer size for UART driver initialization. Modbus serial task stack size for event queue task.
This buffer is used for Modbus frame transfer. The Modbus protocol maximum It may be adjusted when debugging is enabled (for example).
frame size is 256 bytes. Bigger size can be used for non standard implementations.
config MB_SERIAL_TASK_PRIO
int "Modbus serial task priority"
range 3 10
default 10
help
Modbus UART driver event task priority.
The priority of Modbus controller task is equal to (CONFIG_MB_SERIAL_TASK_PRIO - 1).
config MB_CONTROLLER_SLAVE_ID_SUPPORT config MB_SERIAL_BUF_SIZE
bool "Modbus controller slave ID support" int "Modbus serial task RX/TX buffer size"
default n range 0 2048
help default 256
Modbus slave ID support enable. help
When enabled the Modbus <Report Slave ID> command is supported by stack. 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_CONTROLLER_SLAVE_ID config MB_SERIAL_TASK_PRIO
hex "Modbus controller slave ID" int "Modbus serial task priority"
range 0 4294967295 range 3 10
default 0x00112233 default 10
depends on MB_CONTROLLER_SLAVE_ID_SUPPORT help
help Modbus UART driver event task priority.
Modbus slave ID value to identify modbus device The priority of Modbus controller task is equal to (CONFIG_MB_SERIAL_TASK_PRIO - 1).
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 config MB_CONTROLLER_SLAVE_ID_SUPPORT
int "Modbus controller notification timeout (ms)" bool "Modbus controller slave ID support"
range 0 200 default n
default 20 help
help Modbus slave ID support enable.
Modbus controller notification timeout in milliseconds. When enabled the Modbus <Report Slave ID> command is supported by stack.
This timeout is used to send notification about accessed parameters.
config MB_CONTROLLER_NOTIFY_QUEUE_SIZE config MB_CONTROLLER_SLAVE_ID
int "Modbus controller notification queue size" hex "Modbus controller slave ID"
range 0 200 range 0 4294967295
default 20 default 0x00112233
help depends on MB_CONTROLLER_SLAVE_ID_SUPPORT
Modbus controller notification queue size. help
The notification queue is used to get information about accessed parameters. 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_STACK_SIZE config MB_CONTROLLER_NOTIFY_TIMEOUT
int "Modbus controller stack size" int "Modbus controller notification timeout (ms)"
range 0 8192 range 0 200
default 4096 default 20
help help
Modbus controller task stack size. The Stack size may be adjusted when Modbus controller notification timeout in milliseconds.
debug mode is used which requires more stack size (for example). This timeout is used to send notification about accessed parameters.
config MB_EVENT_QUEUE_TIMEOUT config MB_CONTROLLER_NOTIFY_QUEUE_SIZE
int "Modbus stack event queue timeout (ms)" int "Modbus controller notification queue size"
range 0 500 range 0 200
default 20 default 20
help help
Modbus stack event queue timeout in milliseconds. This may help to optimize Modbus controller notification queue size.
Modbus stack event processing time. The notification queue is used to get information about accessed parameters.
config MB_TIMER_PORT_ENABLED
bool "Modbus stack use timer for 3.5T symbol time measurement"
default y
help
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 config MB_CONTROLLER_STACK_SIZE
int "Modbus Timer group number" int "Modbus controller stack size"
range 0 1 range 0 8192
depends on MB_TIMER_PORT_ENABLED default 4096
default 0 help
help Modbus controller task stack size. The Stack size may be adjusted when
Modbus Timer group number that is used for timeout measurement. debug mode is used which requires more stack size (for example).
config MB_TIMER_INDEX config MB_EVENT_QUEUE_TIMEOUT
int "Modbus Timer index in the group" int "Modbus stack event queue timeout (ms)"
range 0 1 range 0 500
depends on MB_TIMER_PORT_ENABLED default 20
default 0 help
help Modbus stack event queue timeout in milliseconds. This may help to optimize
Modbus Timer Index in the group that is used for timeout measurement. Modbus stack event processing time.
config MB_TIMER_PORT_ENABLED
bool "Modbus stack use timer for 3.5T symbol time measurement"
default y
help
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
int "Modbus Timer group number"
range 0 1
depends on MB_TIMER_PORT_ENABLED
default 0
help
Modbus Timer group number that is used for timeout measurement.
config MB_TIMER_INDEX
int "Modbus Timer index in the group"
range 0 1
depends on MB_TIMER_PORT_ENABLED
default 0
help
Modbus Timer Index in the group that is used for timeout measurement.
endmenu endmenu

703
components/freertos/Kconfig
View File

@ -1,203 +1,204 @@
menu "FreeRTOS" menu "FreeRTOS"
# This is actually also handled in the ESP32 startup code, not only in FreeRTOS. # This is actually also handled in the ESP32 startup code, not only in FreeRTOS.
config FREERTOS_UNICORE config FREERTOS_UNICORE
bool "Run FreeRTOS only on first core" bool "Run FreeRTOS only on first core"
default n default n
help help
This version of FreeRTOS normally takes control of all cores of 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. 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 This is needed when e.g. another process needs complete control
over the second core. over the second core.
# This invisible config value sets the value of tskNO_AFFINITY in task.h. # This invisible config value sets the value of tskNO_AFFINITY in task.h.
# Intended to be used as a constant from other Kconfig files. # Intended to be used as a constant from other Kconfig files.
# Value is (32-bit) INT_MAX. # Value is (32-bit) INT_MAX.
config FREERTOS_NO_AFFINITY config FREERTOS_NO_AFFINITY
hex hex
default 0x7FFFFFFF default 0x7FFFFFFF
choice FREERTOS_CORETIMER choice FREERTOS_CORETIMER
prompt "Xtensa timer to use as the FreeRTOS tick source" prompt "Xtensa timer to use as the FreeRTOS tick source"
default CONFIG_FREERTOS_CORETIMER_0 default CONFIG_FREERTOS_CORETIMER_0
help help
FreeRTOS needs a timer with an associated interrupt to use as FreeRTOS needs a timer with an associated interrupt to use as
the main tick source to increase counters, run timers and do the main tick source to increase counters, run timers and do
pre-emptive multitasking with. There are multiple timers available pre-emptive multitasking with. There are multiple timers available
to do this, with different interrupt priorities. Check to do this, with different interrupt priorities. Check
config FREERTOS_CORETIMER_0 config FREERTOS_CORETIMER_0
bool "Timer 0 (int 6, level 1)" bool "Timer 0 (int 6, level 1)"
help help
Select this to use timer 0 Select this to use timer 0
config FREERTOS_CORETIMER_1 config FREERTOS_CORETIMER_1
bool "Timer 1 (int 15, level 3)" bool "Timer 1 (int 15, level 3)"
help help
Select this to use timer 1 Select this to use timer 1
endchoice endchoice
config FREERTOS_HZ config FREERTOS_HZ
int "Tick rate (Hz)" int "Tick rate (Hz)"
range 1 1000 range 1 1000
default 100 default 100
help help
Select the tick rate at which FreeRTOS does pre-emptive context switching. Select the tick rate at which FreeRTOS does pre-emptive context switching.
config FREERTOS_ASSERT_ON_UNTESTED_FUNCTION config FREERTOS_ASSERT_ON_UNTESTED_FUNCTION
bool "Halt when an SMP-untested function is called" bool "Halt when an SMP-untested function is called"
default y default y
help help
Some functions in FreeRTOS have not been thoroughly tested yet when moving to 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 the SMP implementation of FreeRTOS. When this option is enabled, these fuctions
will throw an assert(). will throw an assert().
choice FREERTOS_CHECK_STACKOVERFLOW choice FREERTOS_CHECK_STACKOVERFLOW
prompt "Check for stack overflow" prompt "Check for stack overflow"
default FREERTOS_CHECK_STACKOVERFLOW_CANARY default FREERTOS_CHECK_STACKOVERFLOW_CANARY
help help
FreeRTOS can check for stack overflows in threads and trigger an user function FreeRTOS can check for stack overflows in threads and trigger an user function
called vApplicationStackOverflowHook when this happens. called vApplicationStackOverflowHook when this happens.
config FREERTOS_CHECK_STACKOVERFLOW_NONE config FREERTOS_CHECK_STACKOVERFLOW_NONE
bool "No checking" bool "No checking"
help help
Do not check for stack overflows (configCHECK_FOR_STACK_OVERFLOW=0) Do not check for stack overflows (configCHECK_FOR_STACK_OVERFLOW=0)
config FREERTOS_CHECK_STACKOVERFLOW_PTRVAL config FREERTOS_CHECK_STACKOVERFLOW_PTRVAL
bool "Check by stack pointer value" bool "Check by stack pointer value"
help help
Check for stack overflows on each context switch by checking if Check for stack overflows on each context switch by checking if
the stack pointer is in a valid range. Quick but does not detect the stack pointer is in a valid range. Quick but does not detect
stack overflows that happened between context switches stack overflows that happened between context switches
(configCHECK_FOR_STACK_OVERFLOW=1) (configCHECK_FOR_STACK_OVERFLOW=1)
config FREERTOS_CHECK_STACKOVERFLOW_CANARY config FREERTOS_CHECK_STACKOVERFLOW_CANARY
bool "Check using canary bytes" bool "Check using canary bytes"
help help
Places some magic bytes at the end of the stack area and on each 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 context switch, check if these bytes are still intact. More thorough
than just checking the pointer, but also slightly slower. than just checking the pointer, but also slightly slower.
(configCHECK_FOR_STACK_OVERFLOW=2) (configCHECK_FOR_STACK_OVERFLOW=2)
endchoice endchoice
config FREERTOS_WATCHPOINT_END_OF_STACK config FREERTOS_WATCHPOINT_END_OF_STACK
bool "Set a debug watchpoint as a stack overflow check" bool "Set a debug watchpoint as a stack overflow check"
default n default n
help help
FreeRTOS can check if a stack has overflown its bounds by checking either the value of 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 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 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 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 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 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. 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 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. 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 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. will panic on an unhandled debug exception.
config FREERTOS_INTERRUPT_BACKTRACE config FREERTOS_INTERRUPT_BACKTRACE
bool "Enable backtrace from interrupt to task context" bool "Enable backtrace from interrupt to task context"
default y default y
help help
If this option is enabled, interrupt stack frame will be modified to If this option is enabled, interrupt stack frame will be modified to
point to the code of the interrupted task as its return address. point to the code of the interrupted task as its return address.
This helps the debugger (or the panic handler) show a backtrace from This helps the debugger (or the panic handler) show a backtrace from
the interrupt to the task which was interrupted. This also works for the interrupt to the task which was interrupted. This also works for
nested interrupts: higer level interrupt stack can be traced back to the nested interrupts: higer level interrupt stack can be traced back to the
lower level interrupt. lower level interrupt.
This option adds 4 instructions to the interrupt dispatching code. This option adds 4 instructions to the interrupt dispatching code.
config FREERTOS_THREAD_LOCAL_STORAGE_POINTERS config FREERTOS_THREAD_LOCAL_STORAGE_POINTERS
int "Number of thread local storage pointers" int "Number of thread local storage pointers"
range 1 256 range 1 256
default 1 default 1
help help
FreeRTOS has the ability to store per-thread pointers in the task FreeRTOS has the ability to store per-thread pointers in the task
control block. This controls the number of pointers available. 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 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. thread-local-storage. Other indexes can be used for any desired purpose.
choice FREERTOS_ASSERT choice FREERTOS_ASSERT
prompt "FreeRTOS assertions" prompt "FreeRTOS assertions"
default FREERTOS_ASSERT_FAIL_ABORT default FREERTOS_ASSERT_FAIL_ABORT
help help
Failed FreeRTOS configASSERT() assertions can be configured to Failed FreeRTOS configASSERT() assertions can be configured to
behave in different ways. behave in different ways.
config FREERTOS_ASSERT_FAIL_ABORT config FREERTOS_ASSERT_FAIL_ABORT
bool "abort() on failed assertions" bool "abort() on failed assertions"
help help
If a FreeRTOS configASSERT() fails, FreeRTOS will abort() and If a FreeRTOS configASSERT() fails, FreeRTOS will abort() and
halt execution. The panic handler can be configured to handle halt execution. The panic handler can be configured to handle
the outcome of an abort() in different ways. the outcome of an abort() in different ways.
config FREERTOS_ASSERT_FAIL_PRINT_CONTINUE config FREERTOS_ASSERT_FAIL_PRINT_CONTINUE
bool "Print and continue failed assertions" bool "Print and continue failed assertions"
help help
If a FreeRTOS assertion fails, print it out and continue. If a FreeRTOS assertion fails, print it out and continue.
config FREERTOS_ASSERT_DISABLE config FREERTOS_ASSERT_DISABLE
bool "Disable FreeRTOS assertions" bool "Disable FreeRTOS assertions"
help help
FreeRTOS configASSERT() will not be compiled into the binary. FreeRTOS configASSERT() will not be compiled into the binary.
endchoice endchoice
config FREERTOS_IDLE_TASK_STACKSIZE config FREERTOS_IDLE_TASK_STACKSIZE
int "Idle Task stack size" int "Idle Task stack size"
range 768 32768 range 768 32768
default 1536 default 1536
help help
The idle task has its own stack, sized in bytes. The default size is enough for most uses. Size can be reduced The idle task has its own stack, sized in bytes. The default size is enough for most uses. Size can be
to 768 bytes if no (or simple) FreeRTOS idle hooks are used and pthread local storage or FreeRTOS local storage reduced to 768 bytes if no (or simple) FreeRTOS idle hooks are used and pthread local storage or FreeRTOS
cleanup callbacks are not used. 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 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. cleanup hooks that use a lot of stack memory.
config FREERTOS_ISR_STACKSIZE config FREERTOS_ISR_STACKSIZE
int "ISR stack size" int "ISR stack size"
range 1536 32768 range 1536 32768
default 1536 default 1536
help help
The interrupt handlers have their own stack. The size of the stack can be defined here. 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. Each processor has its own stack, so the total size occupied will be twice this.
config FREERTOS_LEGACY_HOOKS config FREERTOS_LEGACY_HOOKS
bool "Use FreeRTOS legacy hooks" bool "Use FreeRTOS legacy hooks"
default n default n
help help
FreeRTOS offers a number of hooks/callback functions that are called when a timer 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 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 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 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. reason can't be migrated to the esp_register_freertos_xxx_hook system.
config FREERTOS_MAX_TASK_NAME_LEN config FREERTOS_MAX_TASK_NAME_LEN
int "Maximum task name length" int "Maximum task name length"
range 1 256 range 1 256
default 16 default 16
help help
Changes the maximum task name length. Each task allocated will Changes the maximum task name length. Each task allocated will
include this many bytes for a task name. Using a shorter value include this many bytes for a task name. Using a shorter value
saves a small amount of RAM, a longer value allows more complex saves a small amount of RAM, a longer value allows more complex
names. names.
For most uses, the default of 16 is OK. For most uses, the default of 16 is OK.
config SUPPORT_STATIC_ALLOCATION config SUPPORT_STATIC_ALLOCATION
bool "Enable FreeRTOS static allocation API" bool "Enable FreeRTOS static allocation API"
default n default n
help help
FreeRTOS gives the application writer the ability to instead provide the memory FreeRTOS gives the application writer the ability to instead provide the memory
themselves, allowing the following objects to optionally be created without any themselves, allowing the following objects to optionally be created without any
memory being allocated dynamically: memory being allocated dynamically:
- Tasks - Tasks
- Software Timers (Daemon task is still dynamic. See documentation) - Software Timers (Daemon task is still dynamic. See documentation)
@ -208,214 +209,214 @@ config SUPPORT_STATIC_ALLOCATION
- Recursive Semaphores - Recursive Semaphores
- Mutexes - Mutexes
Whether it is preferable to use static or dynamic memory allocation is dependent on 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 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. 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 Creating RTOS objects using statically allocated RAM has the benefit of providing the application writer
application writer with more control: RTOS objects can be placed at specific memory locations. with more control: RTOS objects can be placed at specific memory locations. The maximum RAM footprint can
The maximum RAM footprint can be determined at link time, rather than run time. be determined at link time, rather than run time. The application writer does not need to concern
The application writer does not need to concern themselves with graceful handling of memory allocation failures. themselves with graceful handling of memory allocation failures. It allows the RTOS to be used in
It allows the RTOS to be used in applications that simply don't allow any dynamic memory allocation applications that simply don't allow any dynamic memory allocation (although FreeRTOS includes allocation
(although FreeRTOS includes allocation schemes that can overcome most objections). schemes that can overcome most objections).
config ENABLE_STATIC_TASK_CLEAN_UP_HOOK config ENABLE_STATIC_TASK_CLEAN_UP_HOOK
bool "Enable static task clean up hook" bool "Enable static task clean up hook"
depends on SUPPORT_STATIC_ALLOCATION depends on SUPPORT_STATIC_ALLOCATION
default n default n
help help
Enable this option to make FreeRTOS call the static task clean up hook when a task is deleted. 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:: Bear in mind that if this option is enabled you will need to implement the following function::
void vPortCleanUpTCB ( void *pxTCB ) { void vPortCleanUpTCB ( void *pxTCB ) {
// place clean up code here // place clean up code here
} }
config TIMER_TASK_PRIORITY config TIMER_TASK_PRIORITY
int "FreeRTOS timer task priority" int "FreeRTOS timer task priority"
range 1 25 range 1 25
default 1 default 1
help help
The timer service task (primarily) makes use of existing FreeRTOS features, allowing timer 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 functionality to be added to an application with minimal impact on the size of the application's
executable binary. executable binary.
Use this constant to define the priority that the timer task will run at. Use this constant to define the priority that the timer task will run at.
config TIMER_TASK_STACK_DEPTH config TIMER_TASK_STACK_DEPTH
int "FreeRTOS timer task stack size" int "FreeRTOS timer task stack size"
range 1536 32768 range 1536 32768
default 2048 default 2048
help help
The timer service task (primarily) makes use of existing FreeRTOS features, allowing timer 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 functionality to be added to an application with minimal impact on the size of the application's
executable binary. executable binary.
Use this constant to define the size (in bytes) of the stack allocated for the timer task. Use this constant to define the size (in bytes) of the stack allocated for the timer task.
config TIMER_QUEUE_LENGTH config TIMER_QUEUE_LENGTH
int "FreeRTOS timer queue length" int "FreeRTOS timer queue length"
range 5 20 range 5 20
default 10 default 10
help help
FreeRTOS provides a set of timer related API functions. Many of these functions use a standard 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 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 called the 'timer command queue'. The 'timer command queue' is private to the FreeRTOS timer
implementation, and cannot be accessed directly. implementation, and cannot be accessed directly.
For most uses the default value of 10 is OK. For most uses the default value of 10 is OK.
config FREERTOS_QUEUE_REGISTRY_SIZE config FREERTOS_QUEUE_REGISTRY_SIZE
int "FreeRTOS queue registry size" int "FreeRTOS queue registry size"
range 0 20 range 0 20
default 0 default 0
help help
FreeRTOS uses the queue registry as a means for kernel aware debuggers to locate queues, semaphores, 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 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 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. will specify the number of queues/semaphores/mutexes that the registry can hold.
config FREERTOS_USE_TRACE_FACILITY config FREERTOS_USE_TRACE_FACILITY
bool "Enable FreeRTOS trace facility" bool "Enable FreeRTOS trace facility"
default n default n
help help
If enabled, configUSE_TRACE_FACILITY will be defined as 1 in FreeRTOS. If enabled, configUSE_TRACE_FACILITY will be defined as 1 in FreeRTOS.
This will allow the usage of trace facility functions such as This will allow the usage of trace facility functions such as
uxTaskGetSystemState(). uxTaskGetSystemState().
config FREERTOS_USE_STATS_FORMATTING_FUNCTIONS config FREERTOS_USE_STATS_FORMATTING_FUNCTIONS
bool "Enable FreeRTOS stats formatting functions" bool "Enable FreeRTOS stats formatting functions"
depends on FREERTOS_USE_TRACE_FACILITY depends on FREERTOS_USE_TRACE_FACILITY
default n default n
help help
If enabled, configUSE_STATS_FORMATTING_FUNCTIONS will be defined as 1 in If enabled, configUSE_STATS_FORMATTING_FUNCTIONS will be defined as 1 in
FreeRTOS. This will allow the usage of stats formatting functions such FreeRTOS. This will allow the usage of stats formatting functions such
as vTaskList(). as vTaskList().
config FREERTOS_VTASKLIST_INCLUDE_COREID config FREERTOS_VTASKLIST_INCLUDE_COREID
bool "Enable display of xCoreID in vTaskList" bool "Enable display of xCoreID in vTaskList"
depends on FREERTOS_USE_STATS_FORMATTING_FUNCTIONS depends on FREERTOS_USE_STATS_FORMATTING_FUNCTIONS
default n default n
help help
If enabled, this will include an extra column when vTaskList is called 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. to display the CoreID the task is pinned to (0,1) or -1 if not pinned.
config FREERTOS_GENERATE_RUN_TIME_STATS config FREERTOS_GENERATE_RUN_TIME_STATS
bool "Enable FreeRTOS to collect run time stats" bool "Enable FreeRTOS to collect run time stats"
default n default n
select FREERTOS_USE_TRACE_FACILITY select FREERTOS_USE_TRACE_FACILITY
select FREERTOS_USE_STATS_FORMATTING_FUNCTIONS select FREERTOS_USE_STATS_FORMATTING_FUNCTIONS
help help
If enabled, configGENERATE_RUN_TIME_STATS will be defined as 1 in If enabled, configGENERATE_RUN_TIME_STATS will be defined as 1 in
FreeRTOS. This will allow FreeRTOS to collect information regarding the FreeRTOS. This will allow FreeRTOS to collect information regarding the
usage of processor time amongst FreeRTOS tasks. Run time stats are usage of processor time amongst FreeRTOS tasks. Run time stats are
generated using either the ESP Timer or the CPU Clock as the clock 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 source (Note that run time stats are only valid until the clock source
overflows). The function vTaskGetRunTimeStats() will also be available overflows). The function vTaskGetRunTimeStats() will also be available
if FREERTOS_USE_STATS_FORMATTING_FUNCTIONS and if FREERTOS_USE_STATS_FORMATTING_FUNCTIONS and
FREERTOS_USE_TRACE_FACILITY are enabled. vTaskGetRunTimeStats() will FREERTOS_USE_TRACE_FACILITY are enabled. vTaskGetRunTimeStats() will
display the run time of each task as a % of the total run time of all 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 ) CPUs (task run time / no of CPUs) / (total run time / 100 )
choice FREERTOS_RUN_TIME_STATS_CLK
prompt "Choose the clock source for run time stats"
depends on FREERTOS_GENERATE_RUN_TIME_STATS
default FREERTOS_RUN_TIME_STATS_USING_ESP_TIMER
help
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.
config FREERTOS_RUN_TIME_STATS_USING_ESP_TIMER
bool "Use ESP TIMER for run time stats"
help
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.
config FREERTOS_RUN_TIME_STATS_USING_CPU_CLK
bool "Use CPU Clock for run time stats"
help
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.
endchoice choice FREERTOS_RUN_TIME_STATS_CLK
prompt "Choose the clock source for run time stats"
depends on FREERTOS_GENERATE_RUN_TIME_STATS
default FREERTOS_RUN_TIME_STATS_USING_ESP_TIMER
help
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.
config FREERTOS_USE_TICKLESS_IDLE config FREERTOS_RUN_TIME_STATS_USING_ESP_TIMER
bool "Tickless idle support" bool "Use ESP TIMER for run time stats"
depends on PM_ENABLE help
default n ESP Timer will be used as the clock source for FreeRTOS run time stats.
help The ESP Timer runs at a frequency of 1MHz regardless of Dynamic
If power management support is enabled, FreeRTOS will be able to put Frequency Scaling. Therefore the ESP Timer will overflow in
the system into light sleep mode when no tasks need to run for a number approximately 4290 seconds.
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 config FREERTOS_RUN_TIME_STATS_USING_CPU_CLK
entering sleep mode, even when no tasks need to run. bool "Use CPU Clock for run time stats"
help
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.
If disabled, automatic light sleep support will be disabled. endchoice
config FREERTOS_IDLE_TIME_BEFORE_SLEEP config FREERTOS_USE_TICKLESS_IDLE
int "Minimum number of ticks to enter sleep mode for" bool "Tickless idle support"
depends on FREERTOS_USE_TICKLESS_IDLE depends on PM_ENABLE
default 3 default n
range 2 4294967295 help
# Minimal value is 2 because of a check in FreeRTOS.h (search configEXPECTED_IDLE_TIME_BEFORE_SLEEP) If power management support is enabled, FreeRTOS will be able to put
help the system into light sleep mode when no tasks need to run for a number
FreeRTOS will enter light sleep mode if no tasks need to run for this number of ticks. This number can be set using FREERTOS_IDLE_TIME_BEFORE_SLEEP option.
of ticks. This feature is also known as "automatic light sleep".
menuconfig FREERTOS_DEBUG_INTERNALS Note that timers created using esp_timer APIs may prevent the system from
bool "Debug FreeRTOS internals" entering sleep mode, even when no tasks need to run.
default n
help
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.
if FREERTOS_DEBUG_INTERNALS If disabled, automatic light sleep support will be disabled.
config FREERTOS_PORTMUX_DEBUG config FREERTOS_IDLE_TIME_BEFORE_SLEEP
bool "Debug portMUX portENTER_CRITICAL/portEXIT_CRITICAL" int "Minimum number of ticks to enter sleep mode for"
depends on FREERTOS_DEBUG_INTERNALS depends on FREERTOS_USE_TICKLESS_IDLE
default n default 3
help range 2 4294967295
If enabled, debug information (including integrity checks) will be printed # Minimal value is 2 because of a check in FreeRTOS.h (search configEXPECTED_IDLE_TIME_BEFORE_SLEEP)
to UART for the port-specific MUX implementation. help
FreeRTOS will enter light sleep mode if no tasks need to run for this number
of ticks.
if !FREERTOS_UNICORE menuconfig FREERTOS_DEBUG_INTERNALS
config FREERTOS_PORTMUX_DEBUG_RECURSIVE bool "Debug FreeRTOS internals"
bool "Debug portMUX Recursion" default n
depends on FREERTOS_PORTMUX_DEBUG help
default n Enable this option to show the menu with internal FreeRTOS debugging features.
help This option does not change any code by itself, it just shows/hides some options.
If enabled, additional debug information will be printed for recursive
portMUX usage.
endif #FREERTOS_UNICORE
endif # FREERTOS_DEBUG_INTERNALS if FREERTOS_DEBUG_INTERNALS
config FREERTOS_TASK_FUNCTION_WRAPPER config FREERTOS_PORTMUX_DEBUG
bool "Enclose all task functions in a wrapper function" bool "Debug portMUX portENTER_CRITICAL/portEXIT_CRITICAL"
depends on OPTIMIZATION_LEVEL_DEBUG depends on FREERTOS_DEBUG_INTERNALS
default y default n
help help
If enabled, all FreeRTOS task functions will be enclosed in a wrapper function. If enabled, debug information (including integrity checks) will be printed
If a task function mistakenly returns (i.e. does not delete), the call flow will to UART for the port-specific MUX implementation.
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++ if !FREERTOS_UNICORE
exceptions to work correctly inside top-level task functions. config FREERTOS_PORTMUX_DEBUG_RECURSIVE
bool "Debug portMUX Recursion"
depends on FREERTOS_PORTMUX_DEBUG
default n
help
If enabled, additional debug information will be printed for recursive
portMUX usage.
endif #FREERTOS_UNICORE
endif # FREERTOS_DEBUG_INTERNALS
config FREERTOS_TASK_FUNCTION_WRAPPER
bool "Enclose all task functions in a wrapper function"
depends on OPTIMIZATION_LEVEL_DEBUG
default y
help
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.
endmenu endmenu

74
components/heap/Kconfig
View File

@ -1,49 +1,49 @@
menu "Heap memory debugging" menu "Heap memory debugging"
choice HEAP_CORRUPTION_DETECTION choice HEAP_CORRUPTION_DETECTION
prompt "Heap corruption detection" prompt "Heap corruption detection"
default HEAP_POISONING_DISABLED default HEAP_POISONING_DISABLED
help help
Enable heap poisoning features to detect heap corruption caused by out-of-bounds access to heap memory. 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 See the "Heap Memory Debugging" page of the IDF documentation
for a description of each level of heap corruption detection. for a description of each level of heap corruption detection.
config HEAP_POISONING_DISABLED config HEAP_POISONING_DISABLED
bool "Basic (no poisoning)" bool "Basic (no poisoning)"
config HEAP_POISONING_LIGHT config HEAP_POISONING_LIGHT
bool "Light impact" bool "Light impact"
config HEAP_POISONING_COMPREHENSIVE config HEAP_POISONING_COMPREHENSIVE
bool "Comprehensive" bool "Comprehensive"
endchoice endchoice
config HEAP_TRACING config HEAP_TRACING
bool "Enable heap tracing" bool "Enable heap tracing"
help help
Enables the heap tracing API defined in esp_heap_trace.h. 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 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 (malloc/free/realloc) CPU overhead, even when the tracing feature is not used. So it's best to keep it
unless tracing is being used. disabled unless tracing is being used.
config HEAP_TRACING_STACK_DEPTH config HEAP_TRACING_STACK_DEPTH
int "Heap tracing stack depth" int "Heap tracing stack depth"
range 0 10 range 0 10
default 2 default 2
depends on HEAP_TRACING depends on HEAP_TRACING
help help
Number of stack frames to save when tracing heap operation callers. 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 More stack frames uses more memory in the heap trace buffer (and slows down allocation), but
can provide useful information. can provide useful information.
config HEAP_TASK_TRACKING config HEAP_TASK_TRACKING
bool "Enable heap task tracking" bool "Enable heap task tracking"
depends on !HEAP_POISONING_DISABLED depends on !HEAP_POISONING_DISABLED
help help
Enables tracking the task responsible for each heap allocation. 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 This function depends on heap poisoning being enabled and adds four more bytes of overhead for each block
allocated. allocated.
endmenu endmenu

20
components/libsodium/Kconfig
View File

@ -1,15 +1,15 @@
menu "libsodium" menu "libsodium"
config LIBSODIUM_USE_MBEDTLS_SHA config LIBSODIUM_USE_MBEDTLS_SHA
bool "Use mbedTLS SHA256 & SHA512 implementations" bool "Use mbedTLS SHA256 & SHA512 implementations"
default y default y
depends on !MBEDTLS_HARDWARE_SHA depends on !MBEDTLS_HARDWARE_SHA
help help
If this option is enabled, libsodium will use thin wrappers If this option is enabled, libsodium will use thin wrappers
around mbedTLS for SHA256 & SHA512 operations. around mbedTLS for SHA256 & SHA512 operations.
This saves some code size if mbedTLS is also used. However it This saves some code size if mbedTLS is also used. However it
is incompatible with hardware SHA acceleration (due to the is incompatible with hardware SHA acceleration (due to the
way libsodium's API manages SHA state). way libsodium's API manages SHA state).
endmenu # libsodium endmenu # libsodium

78
components/log/Kconfig
View File

@ -1,48 +1,48 @@
menu "Log output" menu "Log output"
choice LOG_DEFAULT_LEVEL choice LOG_DEFAULT_LEVEL
bool "Default log verbosity" bool "Default log verbosity"
default LOG_DEFAULT_LEVEL_INFO default LOG_DEFAULT_LEVEL_INFO
help help
Specify how much output to see in logs by default. Specify how much output to see in logs by default.
You can set lower verbosity level at runtime using You can set lower verbosity level at runtime using
esp_log_level_set function. 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.
config LOG_DEFAULT_LEVEL_NONE Note that this setting limits which log statements
bool "No output" are compiled into the program. So setting this to, say,
config LOG_DEFAULT_LEVEL_ERROR "Warning" would mean that changing log level to "Debug"
bool "Error" at runtime will not be possible.
config LOG_DEFAULT_LEVEL_WARN
bool "Warning"
config LOG_DEFAULT_LEVEL_INFO
bool "Info"
config LOG_DEFAULT_LEVEL_DEBUG
bool "Debug"
config LOG_DEFAULT_LEVEL_VERBOSE
bool "Verbose"
endchoice
config LOG_DEFAULT_LEVEL config LOG_DEFAULT_LEVEL_NONE
int bool "No output"
default 0 if LOG_DEFAULT_LEVEL_NONE config LOG_DEFAULT_LEVEL_ERROR
default 1 if LOG_DEFAULT_LEVEL_ERROR bool "Error"
default 2 if LOG_DEFAULT_LEVEL_WARN config LOG_DEFAULT_LEVEL_WARN
default 3 if LOG_DEFAULT_LEVEL_INFO bool "Warning"
default 4 if LOG_DEFAULT_LEVEL_DEBUG config LOG_DEFAULT_LEVEL_INFO
default 5 if LOG_DEFAULT_LEVEL_VERBOSE bool "Info"
config LOG_DEFAULT_LEVEL_DEBUG
bool "Debug"
config LOG_DEFAULT_LEVEL_VERBOSE
bool "Verbose"
endchoice
config LOG_COLORS config LOG_DEFAULT_LEVEL
bool "Use ANSI terminal colors in log output" int
default "y" default 0 if LOG_DEFAULT_LEVEL_NONE
help default 1 if LOG_DEFAULT_LEVEL_ERROR
Enable ANSI terminal color codes in bootloader output. default 2 if LOG_DEFAULT_LEVEL_WARN
default 3 if LOG_DEFAULT_LEVEL_INFO
default 4 if LOG_DEFAULT_LEVEL_DEBUG
default 5 if LOG_DEFAULT_LEVEL_VERBOSE
In order to view these, your terminal program must support ANSI color codes. config LOG_COLORS
bool "Use ANSI terminal colors in log output"
default "y"
help
Enable ANSI terminal color codes in bootloader output.
In order to view these, your terminal program must support ANSI color codes.
endmenu endmenu

1084
components/lwip/Kconfig
View File

File diff suppressed because it is too large Load Diff

1112
components/mbedtls/Kconfig
View File

File diff suppressed because it is too large Load Diff

20
components/mdns/Kconfig
View File

@ -1,13 +1,13 @@
menu "mDNS" menu "mDNS"
config MDNS_MAX_SERVICES config MDNS_MAX_SERVICES
int "Max number of services" int "Max number of services"
range 1 64 range 1 64
default 10 default 10
help help
Services take up a certain amount of memory, and allowing fewer Services take up a certain amount of memory, and allowing fewer
services to be open at the same time conserves memory. Specify services to be open at the same time conserves memory. Specify
the maximum amount of services here. The valid value is from 1 the maximum amount of services here. The valid value is from 1
to 64. to 64.
endmenu endmenu

173
components/mqtt/Kconfig
View File

@ -1,102 +1,103 @@
menu "ESP-MQTT Configurations" menu "ESP-MQTT Configurations"
config MQTT_PROTOCOL_311 config MQTT_PROTOCOL_311
bool "Enable MQTT protocol 3.1.1" bool "Enable MQTT protocol 3.1.1"
default y default y
help help
If not, this library will use MQTT protocol 3.1 If not, this library will use MQTT protocol 3.1
config MQTT_TRANSPORT_SSL config MQTT_TRANSPORT_SSL
bool "Enable MQTT over SSL" bool "Enable MQTT over SSL"
default y default y
help help
Enable MQTT transport over SSL with mbedtls Enable MQTT transport over SSL with mbedtls
config MQTT_TRANSPORT_WEBSOCKET config MQTT_TRANSPORT_WEBSOCKET
bool "Enable MQTT over Websocket" bool "Enable MQTT over Websocket"
default y default y
help help
Enable MQTT transport over Websocket. Enable MQTT transport over Websocket.
config MQTT_TRANSPORT_WEBSOCKET_SECURE config MQTT_TRANSPORT_WEBSOCKET_SECURE
bool "Enable MQTT over Websocket Secure" bool "Enable MQTT over Websocket Secure"
default y default y
depends on MQTT_TRANSPORT_WEBSOCKET depends on MQTT_TRANSPORT_WEBSOCKET
depends on MQTT_TRANSPORT_SSL depends on MQTT_TRANSPORT_SSL
help help
Enable MQTT transport over Websocket Secure. Enable MQTT transport over Websocket Secure.
config MQTT_USE_CUSTOM_CONFIG config MQTT_USE_CUSTOM_CONFIG
bool "MQTT Using custom configurations" bool "MQTT Using custom configurations"
default n default n
help help
Custom MQTT configurations. Custom MQTT configurations.
config MQTT_TCP_DEFAULT_PORT config MQTT_TCP_DEFAULT_PORT
int "Default MQTT over TCP port" int "Default MQTT over TCP port"
default 1883 default 1883
depends on MQTT_USE_CUSTOM_CONFIG depends on MQTT_USE_CUSTOM_CONFIG
help help
Default MQTT over TCP port Default MQTT over TCP port
config MQTT_SSL_DEFAULT_PORT config MQTT_SSL_DEFAULT_PORT
int "Default MQTT over SSL port" int "Default MQTT over SSL port"
default 8883 default 8883
depends on MQTT_USE_CUSTOM_CONFIG depends on MQTT_USE_CUSTOM_CONFIG
depends on MQTT_TRANSPORT_SSL depends on MQTT_TRANSPORT_SSL
help help
Default MQTT over SSL port Default MQTT over SSL port
config MQTT_WS_DEFAULT_PORT
int "Default MQTT over Websocket port"
default 80
depends on MQTT_USE_CUSTOM_CONFIG
depends on MQTT_TRANSPORT_WEBSOCKET
help
Default MQTT over Websocket port
config MQTT_WSS_DEFAULT_PORT config MQTT_WS_DEFAULT_PORT
int "Default MQTT over Websocket Secure port" int "Default MQTT over Websocket port"
default 443 default 80
depends on MQTT_USE_CUSTOM_CONFIG depends on MQTT_USE_CUSTOM_CONFIG
depends on MQTT_TRANSPORT_WEBSOCKET depends on MQTT_TRANSPORT_WEBSOCKET
depends on MQTT_TRANSPORT_WEBSOCKET_SECURE help
help Default MQTT over Websocket port
Default MQTT over Websocket Secure port
config MQTT_BUFFER_SIZE config MQTT_WSS_DEFAULT_PORT
int "Default MQTT Buffer Size" int "Default MQTT over Websocket Secure port"
default 1024 default 443
depends on MQTT_USE_CUSTOM_CONFIG depends on MQTT_USE_CUSTOM_CONFIG
help depends on MQTT_TRANSPORT_WEBSOCKET
This buffer size using for both transmit and receive depends on MQTT_TRANSPORT_WEBSOCKET_SECURE
help
Default MQTT over Websocket Secure port
config MQTT_TASK_STACK_SIZE config MQTT_BUFFER_SIZE
int "MQTT task stack size" int "Default MQTT Buffer Size"
default 6144 default 1024
depends on MQTT_USE_CUSTOM_CONFIG depends on MQTT_USE_CUSTOM_CONFIG
help help
MQTT task stack size This buffer size using for both transmit and receive
config MQTT_TASK_CORE_SELECTION_ENABLED config MQTT_TASK_STACK_SIZE
bool "Enable MQTT task core selection" int "MQTT task stack size"
default false default 6144
help depends on MQTT_USE_CUSTOM_CONFIG
This will enable core selection help
MQTT task stack size
choice MQTT_TASK_CORE_SELECTION config MQTT_TASK_CORE_SELECTION_ENABLED
depends on MQTT_TASK_CORE_SELECTION_ENABLED bool "Enable MQTT task core selection"
prompt "Core to use ?" default false
config MQTT_USE_CORE_0 help
bool "Core 0" This will enable core selection
config MQTT_USE_CORE_1
bool "Core 1"
endchoice
config MQTT_CUSTOM_OUTBOX choice MQTT_TASK_CORE_SELECTION
bool "Enable custom outbox implementation" depends on MQTT_TASK_CORE_SELECTION_ENABLED
default n prompt "Core to use ?"
help config MQTT_USE_CORE_0
Set to true if a specific implementation of message outbox is needed (e.g. persistant outbox in NVM or similar). bool "Core 0"
config MQTT_USE_CORE_1
bool "Core 1"
endchoice
config MQTT_CUSTOM_OUTBOX
bool "Enable custom outbox implementation"
default n
help
Set to true if a specific implementation of message outbox is needed (e.g. persistant outbox in NVM or
similar).
endmenu endmenu

18
components/nvs_flash/Kconfig
View File

@ -1,12 +1,12 @@
menu NVS menu NVS
config NVS_ENCRYPTION config NVS_ENCRYPTION
bool "Enable NVS encryption" bool "Enable NVS encryption"
default n default n
depends on FLASH_ENCRYPTION_ENABLED depends on FLASH_ENCRYPTION_ENABLED
help help
This option enables encryption for NVS. When enabled, AES-XTS is used to encrypt 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 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 to be stored in an encrypted partition. This means enabling flash encryption is
a pre-requisite for this feature. a pre-requisite for this feature.
endmenu endmenu

108
components/openssl/Kconfig
View File

@ -1,70 +1,72 @@
menu "OpenSSL" menu "OpenSSL"
config OPENSSL_DEBUG config OPENSSL_DEBUG
bool "Enable OpenSSL debugging" bool "Enable OpenSSL debugging"
default n default n
help help
Enable OpenSSL debugging function. Enable OpenSSL debugging function.
If the option is enabled, "SSL_DEBUG" works. If the option is enabled, "SSL_DEBUG" works.
config OPENSSL_DEBUG_LEVEL config OPENSSL_DEBUG_LEVEL
int "OpenSSL debugging level" int "OpenSSL debugging level"
default 0 default 0
range 0 255 range 0 255
depends on OPENSSL_DEBUG depends on OPENSSL_DEBUG
help help
OpenSSL debugging level. OpenSSL debugging level.
Only function whose debugging level is higher than "OPENSSL_DEBUG_LEVEL" works. Only function whose debugging level is higher than "OPENSSL_DEBUG_LEVEL" works.
For example: For example:
If OPENSSL_DEBUG_LEVEL = 2, you use function "SSL_DEBUG(1, "malloc failed")". Because 1 < 2, it will not print. If OPENSSL_DEBUG_LEVEL = 2, you use function "SSL_DEBUG(1, "malloc failed")". Because 1 < 2, it will not
print.
config OPENSSL_LOWLEVEL_DEBUG config OPENSSL_LOWLEVEL_DEBUG
bool "Enable OpenSSL low-level module debugging" bool "Enable OpenSSL low-level module debugging"
default n default n
depends on OPENSSL_DEBUG depends on OPENSSL_DEBUG
select MBEDTLS_DEBUG select MBEDTLS_DEBUG
help help
If the option is enabled, low-level module debugging function of OpenSSL is enabled, e.g. mbedtls internal debugging function. If the option is enabled, low-level module debugging function of OpenSSL is enabled, e.g. mbedtls internal
debugging function.
choice OPENSSL_ASSERT choice OPENSSL_ASSERT
prompt "Select OpenSSL assert function" prompt "Select OpenSSL assert function"
default CONFIG_OPENSSL_ASSERT_EXIT default CONFIG_OPENSSL_ASSERT_EXIT
help help
OpenSSL function needs "assert" function to check if input parameters are valid. 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. If you want to use assert debugging function, "OPENSSL_DEBUG" should be enabled.
config OPENSSL_ASSERT_DO_NOTHING config OPENSSL_ASSERT_DO_NOTHING
bool "Do nothing" bool "Do nothing"
help help
Do nothing and "SSL_ASSERT" does not work. Do nothing and "SSL_ASSERT" does not work.
config OPENSSL_ASSERT_EXIT config OPENSSL_ASSERT_EXIT
bool "Check and exit" bool "Check and exit"
help help
Enable assert exiting, it will check and return error code. Enable assert exiting, it will check and return error code.
config OPENSSL_ASSERT_DEBUG config OPENSSL_ASSERT_DEBUG
bool "Show debugging message" bool "Show debugging message"
depends on OPENSSL_DEBUG depends on OPENSSL_DEBUG
help help
Enable assert debugging, it will check and show debugging message. Enable assert debugging, it will check and show debugging message.
config OPENSSL_ASSERT_DEBUG_EXIT config OPENSSL_ASSERT_DEBUG_EXIT
bool "Show debugging message and exit" bool "Show debugging message and exit"
depends on OPENSSL_DEBUG depends on OPENSSL_DEBUG
help help
Enable assert debugging and exiting, it will check, show debugging message and return error code. Enable assert debugging and exiting, it will check, show debugging message and return error code.
config OPENSSL_ASSERT_DEBUG_BLOCK config OPENSSL_ASSERT_DEBUG_BLOCK
bool "Show debugging message and block" bool "Show debugging message and block"
depends on OPENSSL_DEBUG depends on OPENSSL_DEBUG
help help
Enable assert debugging and blocking, it will check, show debugging message and block by "while (1);". Enable assert debugging and blocking, it will check, show debugging message and block by "while (1);".
endchoice endchoice
endmenu endmenu

99
components/partition_table/Kconfig.projbuild
View File

@ -1,62 +1,61 @@
menu "Partition Table" menu "Partition Table"
choice PARTITION_TABLE_TYPE choice PARTITION_TABLE_TYPE
prompt "Partition Table" prompt "Partition Table"
default PARTITION_TABLE_SINGLE_APP default PARTITION_TABLE_SINGLE_APP
help help
The partition table to flash to the ESP32. The partition table The partition table to flash to the ESP32. The partition table
determines where apps, data and other resources are expected to determines where apps, data and other resources are expected to
be found. be found.
The predefined partition table CSV descriptions can be found The predefined partition table CSV descriptions can be found
in the components/partition_table directory. Otherwise it's in the components/partition_table directory. Otherwise it's
possible to create a new custom partition CSV for your application. possible to create a new custom partition CSV for your application.
config PARTITION_TABLE_SINGLE_APP config PARTITION_TABLE_SINGLE_APP
bool "Single factory app, no OTA" bool "Single factory app, no OTA"
config PARTITION_TABLE_TWO_OTA config PARTITION_TABLE_TWO_OTA
bool "Factory app, two OTA definitions" bool "Factory app, two OTA definitions"
config PARTITION_TABLE_CUSTOM config PARTITION_TABLE_CUSTOM
bool "Custom partition table CSV" bool "Custom partition table CSV"
endchoice endchoice
config PARTITION_TABLE_CUSTOM_FILENAME config PARTITION_TABLE_CUSTOM_FILENAME
string "Custom partition CSV file" if PARTITION_TABLE_CUSTOM string "Custom partition CSV file" if PARTITION_TABLE_CUSTOM
default partitions.csv default partitions.csv
help help
Name of the custom partition CSV filename. This path is evaluated Name of the custom partition CSV filename. This path is evaluated
relative to the project root directory. relative to the project root directory.
config PARTITION_TABLE_FILENAME config PARTITION_TABLE_FILENAME
string string
default partitions_singleapp.csv if PARTITION_TABLE_SINGLE_APP && !ESP32_ENABLE_COREDUMP_TO_FLASH default partitions_singleapp.csv if PARTITION_TABLE_SINGLE_APP && !ESP32_ENABLE_COREDUMP_TO_FLASH
default partitions_singleapp_coredump.csv if PARTITION_TABLE_SINGLE_APP && ESP32_ENABLE_COREDUMP_TO_FLASH default partitions_singleapp_coredump.csv if PARTITION_TABLE_SINGLE_APP && ESP32_ENABLE_COREDUMP_TO_FLASH
default partitions_two_ota.csv if PARTITION_TABLE_TWO_OTA && !ESP32_ENABLE_COREDUMP_TO_FLASH default partitions_two_ota.csv if PARTITION_TABLE_TWO_OTA && !ESP32_ENABLE_COREDUMP_TO_FLASH
default partitions_two_ota_coredump.csv if PARTITION_TABLE_TWO_OTA && ESP32_ENABLE_COREDUMP_TO_FLASH default partitions_two_ota_coredump.csv if PARTITION_TABLE_TWO_OTA && ESP32_ENABLE_COREDUMP_TO_FLASH
default PARTITION_TABLE_CUSTOM_FILENAME if PARTITION_TABLE_CUSTOM default PARTITION_TABLE_CUSTOM_FILENAME if PARTITION_TABLE_CUSTOM
config PARTITION_TABLE_OFFSET config PARTITION_TABLE_OFFSET
hex "Offset of partition table" hex "Offset of partition table"
default 0x8000 default 0x8000
help help
The address of partition table (by default 0x8000). The address of partition table (by default 0x8000).
Allows you to move the partition table, it gives more space for the bootloader. 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. 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. 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 Note that partition offsets in the partition table CSV file may need to be changed if this value is set to
each partition offset adapt to the configured partition table offset, leave all partition offsets blank in the CSV file. 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 config PARTITION_TABLE_MD5
bool "Generate an MD5 checksum for the partition table" bool "Generate an MD5 checksum for the partition table"
default y default y
help help
Generate an MD5 checksum for the partition table for protecting the Generate an MD5 checksum for the partition table for protecting the
integrity of the table. The generation should be turned off for legacy integrity of the table. The generation should be turned off for legacy
bootloaders which cannot recognize the MD5 checksum in the partition bootloaders which cannot recognize the MD5 checksum in the partition
table. table.
endmenu endmenu

80
components/pthread/Kconfig
View File

@ -1,49 +1,49 @@
menu "PThreads" menu "PThreads"
config ESP32_PTHREAD_TASK_PRIO_DEFAULT config ESP32_PTHREAD_TASK_PRIO_DEFAULT
int "Default task priority" int "Default task priority"
range 0 255 range 0 255
default 5 default 5
help help
Priority used to create new tasks with default pthread parameters. Priority used to create new tasks with default pthread parameters.
config ESP32_PTHREAD_TASK_STACK_SIZE_DEFAULT config ESP32_PTHREAD_TASK_STACK_SIZE_DEFAULT
int "Default task stack size" int "Default task stack size"
default 3072 default 3072
help help
Stack size used to create new tasks with default pthread parameters. Stack size used to create new tasks with default pthread parameters.
config PTHREAD_STACK_MIN config PTHREAD_STACK_MIN
int "Minimum allowed pthread stack size" int "Minimum allowed pthread stack size"
default 768 default 768
help help
Minimum allowed pthread stack size set in attributes passed to pthread_create Minimum allowed pthread stack size set in attributes passed to pthread_create
choice ESP32_PTHREAD_TASK_CORE_DEFAULT choice ESP32_PTHREAD_TASK_CORE_DEFAULT
bool "Default pthread core affinity" bool "Default pthread core affinity"
default ESP32_DEFAULT_PTHREAD_CORE_NO_AFFINITY default ESP32_DEFAULT_PTHREAD_CORE_NO_AFFINITY
depends on !FREERTOS_UNICORE depends on !FREERTOS_UNICORE
help help
The default core to which pthreads are pinned. The default core to which pthreads are pinned.
config ESP32_DEFAULT_PTHREAD_CORE_NO_AFFINITY
bool "No affinity"
config ESP32_DEFAULT_PTHREAD_CORE_0
bool "Core 0"
config ESP32_DEFAULT_PTHREAD_CORE_1
bool "Core 1"
endchoice
config ESP32_PTHREAD_TASK_CORE_DEFAULT config ESP32_DEFAULT_PTHREAD_CORE_NO_AFFINITY
int bool "No affinity"
default -1 if ESP32_DEFAULT_PTHREAD_CORE_NO_AFFINITY || FREERTOS_UNICORE config ESP32_DEFAULT_PTHREAD_CORE_0
default 0 if ESP32_DEFAULT_PTHREAD_CORE_0 bool "Core 0"
default 1 if ESP32_DEFAULT_PTHREAD_CORE_1 config ESP32_DEFAULT_PTHREAD_CORE_1
bool "Core 1"
endchoice
config ESP32_PTHREAD_TASK_NAME_DEFAULT config ESP32_PTHREAD_TASK_CORE_DEFAULT
string "Default name of pthreads" int
default "pthread" default -1 if ESP32_DEFAULT_PTHREAD_CORE_NO_AFFINITY || FREERTOS_UNICORE
help default 0 if ESP32_DEFAULT_PTHREAD_CORE_0
The default name of pthreads. default 1 if ESP32_DEFAULT_PTHREAD_CORE_1
config ESP32_PTHREAD_TASK_NAME_DEFAULT
string "Default name of pthreads"
default "pthread"
help
The default name of pthreads.
endmenu endmenu

134
components/spi_flash/Kconfig
View File

@ -1,81 +1,81 @@
menu "SPI Flash driver" menu "SPI Flash driver"
config SPI_FLASH_VERIFY_WRITE config SPI_FLASH_VERIFY_WRITE
bool "Verify SPI flash writes" bool "Verify SPI flash writes"
default n default n
help help
If this option is enabled, any time SPI flash is written then the data will be read 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 back and verified. This can catch hardware problems with SPI flash, or flash which
was not erased before verification. was not erased before verification.
config SPI_FLASH_LOG_FAILED_WRITE config SPI_FLASH_LOG_FAILED_WRITE
bool "Log errors if verification fails" bool "Log errors if verification fails"
depends on SPI_FLASH_VERIFY_WRITE depends on SPI_FLASH_VERIFY_WRITE
default n default n
help help
If this option is enabled, if SPI flash write verification fails then a log error line 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 will be written with the address, expected & actual values. This can be useful when
debugging hardware SPI flash problems. debugging hardware SPI flash problems.
config SPI_FLASH_WARN_SETTING_ZERO_TO_ONE config SPI_FLASH_WARN_SETTING_ZERO_TO_ONE
bool "Log warning if writing zero bits to ones" bool "Log warning if writing zero bits to ones"
depends on SPI_FLASH_VERIFY_WRITE depends on SPI_FLASH_VERIFY_WRITE
default n default n
help help
If this option is enabled, any SPI flash write which tries to set zero bits in the flash to 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 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. 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. 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 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. 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. Such software will log spurious warnings if this option is enabled.
config SPI_FLASH_ENABLE_COUNTERS config SPI_FLASH_ENABLE_COUNTERS
bool "Enable operation counters" bool "Enable operation counters"
default 0 default 0
help help
This option enables the following APIs: 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 - spi_flash_reset_counters
bool "Enable SPI flash ROM driver patched functions" - spi_flash_dump_counters
default y - spi_flash_get_counters
help
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.
choice SPI_FLASH_WRITING_DANGEROUS_REGIONS These APIs may be used to collect performance data for spi_flash APIs
bool "Writing to dangerous flash regions" and to help understand behaviour of libraries which use SPI flash.
default SPI_FLASH_WRITING_DANGEROUS_REGIONS_ABORTS
help
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, config SPI_FLASH_ROM_DRIVER_PATCH
and this check prevents logic errors or corrupted firmware memory from bool "Enable SPI flash ROM driver patched functions"
damaging these regions. default y
help
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.
Note that this feature *does not* check calls to the esp_rom_xxx SPI flash choice SPI_FLASH_WRITING_DANGEROUS_REGIONS
ROM functions. These functions should not be called directly from IDF bool "Writing to dangerous flash regions"
applications. default SPI_FLASH_WRITING_DANGEROUS_REGIONS_ABORTS
help
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.
config SPI_FLASH_WRITING_DANGEROUS_REGIONS_ABORTS It is not recommended to ever write to these regions from an IDF app,
bool "Aborts" and this check prevents logic errors or corrupted firmware memory from
config SPI_FLASH_WRITING_DANGEROUS_REGIONS_FAILS damaging these regions.
bool "Fails"
config SPI_FLASH_WRITING_DANGEROUS_REGIONS_ALLOWED Note that this feature *does not* check calls to the esp_rom_xxx SPI flash
bool "Allowed" ROM functions. These functions should not be called directly from IDF
endchoice applications.
config SPI_FLASH_WRITING_DANGEROUS_REGIONS_ABORTS
bool "Aborts"
config SPI_FLASH_WRITING_DANGEROUS_REGIONS_FAILS
bool "Fails"
config SPI_FLASH_WRITING_DANGEROUS_REGIONS_ALLOWED
bool "Allowed"
endchoice
endmenu endmenu

308
components/spiffs/Kconfig
View File

@ -1,161 +1,161 @@
menu "SPIFFS Configuration" menu "SPIFFS Configuration"
config SPIFFS_MAX_PARTITIONS config SPIFFS_MAX_PARTITIONS
int "Maximum Number of Partitions" int "Maximum Number of Partitions"
default 3 default 3
range 1 10 range 1 10
help help
Define maximum number of partitions that can be mounted. Define maximum number of partitions that can be mounted.
menu "SPIFFS Cache Configuration" menu "SPIFFS Cache Configuration"
config SPIFFS_CACHE config SPIFFS_CACHE
bool "Enable SPIFFS Cache" bool "Enable SPIFFS Cache"
default "y" default "y"
help help
Enables/disable memory read caching of nucleus file system Enables/disable memory read caching of nucleus file system
operations. operations.
config SPIFFS_CACHE_WR config SPIFFS_CACHE_WR
bool "Enable SPIFFS Write Caching" bool "Enable SPIFFS Write Caching"
default "y" default "y"
depends on SPIFFS_CACHE depends on SPIFFS_CACHE
help help
Enables memory write caching for file descriptors in hydrogen. Enables memory write caching for file descriptors in hydrogen.
config SPIFFS_CACHE_STATS config SPIFFS_CACHE_STATS
bool "Enable SPIFFS Cache Statistics" bool "Enable SPIFFS Cache Statistics"
default "n" default "n"
depends on SPIFFS_CACHE depends on SPIFFS_CACHE
help help
Enable/disable statistics on caching. Debug/test purpose only. Enable/disable statistics on caching. Debug/test purpose only.
endmenu endmenu
config SPIFFS_PAGE_CHECK config SPIFFS_PAGE_CHECK
bool "Enable SPIFFS Page Check" bool "Enable SPIFFS Page Check"
default "y" default "y"
help help
Always check header of each accessed page to ensure consistent state. Always check header of each accessed page to ensure consistent state.
If enabled it will increase number of reads from flash, especially If enabled it will increase number of reads from flash, especially
if cache is disabled. if cache is disabled.
config SPIFFS_GC_MAX_RUNS config SPIFFS_GC_MAX_RUNS
int "Set Maximum GC Runs" int "Set Maximum GC Runs"
default 10 default 10
range 1 255 range 1 255
help help
Define maximum number of GC runs to perform to reach desired free pages. Define maximum number of GC runs to perform to reach desired free pages.
config SPIFFS_GC_STATS config SPIFFS_GC_STATS
bool "Enable SPIFFS GC Statistics" bool "Enable SPIFFS GC Statistics"
default "n" default "n"
help help
Enable/disable statistics on gc. Debug/test purpose only. Enable/disable statistics on gc. Debug/test purpose only.
config SPIFFS_PAGE_SIZE config SPIFFS_PAGE_SIZE
int "SPIFFS logical page size" int "SPIFFS logical page size"
default 256 default 256
range 256 1024 range 256 1024
help help
Logical page size of SPIFFS partition, in bytes. Must be multiple Logical page size of SPIFFS partition, in bytes. Must be multiple
of flash page size (which is usually 256 bytes). of flash page size (which is usually 256 bytes).
Larger page sizes reduce overhead when storing large files, and Larger page sizes reduce overhead when storing large files, and
improve filesystem performance when reading large files. improve filesystem performance when reading large files.
Smaller page sizes reduce overhead when storing small (< page size) Smaller page sizes reduce overhead when storing small (< page size)
files. files.
config SPIFFS_OBJ_NAME_LEN config SPIFFS_OBJ_NAME_LEN
int "Set SPIFFS Maximum Name Length" int "Set SPIFFS Maximum Name Length"
default 32 default 32
range 1 256 range 1 256
help help
Object name maximum length. Note that this length include the Object name maximum length. Note that this length include the
zero-termination character, meaning maximum string of characters zero-termination character, meaning maximum string of characters
can at most be SPIFFS_OBJ_NAME_LEN - 1. can at most be SPIFFS_OBJ_NAME_LEN - 1.
SPIFFS_OBJ_NAME_LEN + SPIFFS_META_LENGTH should not exceed SPIFFS_OBJ_NAME_LEN + SPIFFS_META_LENGTH should not exceed
SPIFFS_PAGE_SIZE - 64. SPIFFS_PAGE_SIZE - 64.
config SPIFFS_USE_MAGIC config SPIFFS_USE_MAGIC
bool "Enable SPIFFS Filesystem Magic" bool "Enable SPIFFS Filesystem Magic"
default "y" default "y"
help help
Enable this to have an identifiable spiffs filesystem. Enable this to have an identifiable spiffs filesystem.
This will look for a magic in all sectors to determine if this This will look for a magic in all sectors to determine if this
is a valid spiffs system or not at mount time. is a valid spiffs system or not at mount time.
config SPIFFS_USE_MAGIC_LENGTH config SPIFFS_USE_MAGIC_LENGTH
bool "Enable SPIFFS Filesystem Length Magic" bool "Enable SPIFFS Filesystem Length Magic"
default "y" default "y"
depends on SPIFFS_USE_MAGIC depends on SPIFFS_USE_MAGIC
help help
If this option is enabled, the magic will also be dependent If this option is enabled, the magic will also be dependent
on the length of the filesystem. For example, a filesystem on the length of the filesystem. For example, a filesystem
configured and formatted for 4 megabytes will not be accepted configured and formatted for 4 megabytes will not be accepted
for mounting with a configuration defining the filesystem as 2 megabytes. for mounting with a configuration defining the filesystem as 2 megabytes.
config SPIFFS_META_LENGTH config SPIFFS_META_LENGTH
int "Size of per-file metadata field" int "Size of per-file metadata field"
default 4 default 4
help help
This option sets the number of extra bytes stored in the file header. This option sets the number of extra bytes stored in the file header.
These bytes can be used in an application-specific manner. These bytes can be used in an application-specific manner.
Set this to at least 4 bytes to enable support for saving file Set this to at least 4 bytes to enable support for saving file
modification time. modification time.
SPIFFS_OBJ_NAME_LEN + SPIFFS_META_LENGTH should not exceed SPIFFS_OBJ_NAME_LEN + SPIFFS_META_LENGTH should not exceed
SPIFFS_PAGE_SIZE - 64. SPIFFS_PAGE_SIZE - 64.
config SPIFFS_USE_MTIME config SPIFFS_USE_MTIME
bool "Save file modification time" bool "Save file modification time"
default "y" default "y"
depends on SPIFFS_META_LENGTH >= 4 depends on SPIFFS_META_LENGTH >= 4
help help
If enabled, then the first 4 bytes of per-file metadata will be used If enabled, then the first 4 bytes of per-file metadata will be used
to store file modification time (mtime), accessible through to store file modification time (mtime), accessible through
stat/fstat functions. stat/fstat functions.
Modification time is updated when the file is opened. Modification time is updated when the file is opened.
menu "Debug Configuration" menu "Debug Configuration"
config SPIFFS_DBG config SPIFFS_DBG
bool "Enable general SPIFFS debug" bool "Enable general SPIFFS debug"
default "n" default "n"
help help
Enabling this option will print general debug mesages to the console. Enabling this option will print general debug mesages to the console.
config SPIFFS_API_DBG config SPIFFS_API_DBG
bool "Enable SPIFFS API debug" bool "Enable SPIFFS API debug"
default "n" default "n"
help help
Enabling this option will print API debug mesages to the console. Enabling this option will print API debug mesages to the console.
config SPIFFS_GC_DBG config SPIFFS_GC_DBG
bool "Enable SPIFFS Garbage Cleaner debug" bool "Enable SPIFFS Garbage Cleaner debug"
default "n" default "n"
help help
Enabling this option will print GC debug mesages to the console. Enabling this option will print GC debug mesages to the console.
config SPIFFS_CACHE_DBG config SPIFFS_CACHE_DBG
bool "Enable SPIFFS Cache debug" bool "Enable SPIFFS Cache debug"
default "n" default "n"
depends on SPIFFS_CACHE depends on SPIFFS_CACHE
help help
Enabling this option will print cache debug mesages to the console. Enabling this option will print cache debug mesages to the console.
config SPIFFS_CHECK_DBG config SPIFFS_CHECK_DBG
bool "Enable SPIFFS Filesystem Check debug" bool "Enable SPIFFS Filesystem Check debug"
default "n" default "n"
help help
Enabling this option will print Filesystem Check debug mesages Enabling this option will print Filesystem Check debug mesages
to the console. to the console.
config SPIFFS_TEST_VISUALISATION config SPIFFS_TEST_VISUALISATION
bool "Enable SPIFFS Filesystem Visualization" bool "Enable SPIFFS Filesystem Visualization"
default "n" default "n"
help help
Enable this option to enable SPIFFS_vis function in the API. Enable this option to enable SPIFFS_vis function in the API.
endmenu endmenu
endmenu endmenu

44
components/tcpip_adapter/Kconfig
View File

@ -1,27 +1,27 @@
menu "TCP/IP Adapter" menu "TCP/IP Adapter"
config IP_LOST_TIMER_INTERVAL config IP_LOST_TIMER_INTERVAL
int "IP Address lost timer interval (seconds)" int "IP Address lost timer interval (seconds)"
range 0 65535 range 0 65535
default 120 default 120
help
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.
choice USE_TCPIP_STACK_LIB
prompt "TCP/IP Stack Library"
default TCPIP_LWIP
help
Choose the TCP/IP Stack to work, for example, LwIP, uIP, etc.
config TCPIP_LWIP
bool "LwIP"
help help
lwIP is a small independent implementation of the TCP/IP protocol suite. The value of 0 indicates the IP lost timer is disabled, otherwise the timer is enabled.
endchoice
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.
choice USE_TCPIP_STACK_LIB
prompt "TCP/IP Stack Library"
default TCPIP_LWIP
help
Choose the TCP/IP Stack to work, for example, LwIP, uIP, etc.
config TCPIP_LWIP
bool "LwIP"
help
lwIP is a small independent implementation of the TCP/IP protocol suite.
endchoice
endmenu endmenu

70
components/unity/Kconfig
View File

@ -1,45 +1,45 @@
menu "Unity unit testing library" menu "Unity unit testing library"
config UNITY_ENABLE_FLOAT config UNITY_ENABLE_FLOAT
bool "Support for float type" bool "Support for float type"
default y default y
help help
If not set, assertions on float arguments will not be available. If not set, assertions on float arguments will not be available.
config UNITY_ENABLE_DOUBLE config UNITY_ENABLE_DOUBLE
bool "Support for double type" bool "Support for double type"
default y default y
help help
If not set, assertions on double arguments will not be available. If not set, assertions on double arguments will not be available.
config UNITY_ENABLE_COLOR config UNITY_ENABLE_COLOR
bool "Colorize test output" bool "Colorize test output"
default n default n
help help
If set, Unity will colorize test results using console escape sequences. If set, Unity will colorize test results using console escape sequences.
config UNITY_ENABLE_IDF_TEST_RUNNER config UNITY_ENABLE_IDF_TEST_RUNNER
bool "Include ESP-IDF test registration/running helpers" bool "Include ESP-IDF test registration/running helpers"
default y default y
help help
If set, then the following features will be available: 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 - TEST_CASE macro which performs automatic registration of test functions
bool "Include Unity test fixture" - Functions to run registered test functions: unity_run_all_tests,
default n unity_run_tests_with_filter, unity_run_single_test_by_name.
help - Interactive menu which lists test cases and allows choosing the tests to
If set, unity_fixture.h header file and associated source files are part of be run, available via unity_run_menu function.
the build. These provide an optional set of macros and functions to
implement test groups. Disable if a different test registration mechanism is used.
config UNITY_ENABLE_FIXTURE
bool "Include Unity test fixture"
default n
help
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.
endmenu # "Unity unit testing library" endmenu # "Unity unit testing library"

26
components/vfs/Kconfig
View File

@ -1,18 +1,18 @@
menu "Virtual file system" menu "Virtual file system"
config SUPPRESS_SELECT_DEBUG_OUTPUT config SUPPRESS_SELECT_DEBUG_OUTPUT
bool "Suppress select() related debug outputs" bool "Suppress select() related debug outputs"
default y default y
help help
Select() related functions might produce an unconveniently lot of Select() related functions might produce an unconveniently lot of
debug outputs when one sets the default log level to DEBUG or higher. debug outputs when one sets the default log level to DEBUG or higher.
It is possible to suppress these debug outputs by enabling this It is possible to suppress these debug outputs by enabling this
option. option.
config SUPPORT_TERMIOS config SUPPORT_TERMIOS
bool "Add support for termios.h" bool "Add support for termios.h"
default y default y
help help
Disabling this option can save memory when the support for termios.h is not required. Disabling this option can save memory when the support for termios.h is not required.
endmenu endmenu

110
components/wear_levelling/Kconfig
View File

@ -1,62 +1,62 @@
menu "Wear Levelling" menu "Wear Levelling"
choice WL_SECTOR_SIZE choice WL_SECTOR_SIZE
bool "Wear Levelling library sector size" bool "Wear Levelling library sector size"
default WL_SECTOR_SIZE_4096 default WL_SECTOR_SIZE_4096
help help
Sector size used by wear levelling library. Sector size used by wear levelling library.
You can set default sector size or size that will You can set default sector size or size that will
fit to the flash device sector size. 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).
config WL_SECTOR_SIZE_512
bool "512"
config WL_SECTOR_SIZE_4096
bool "4096"
endchoice
config WL_SECTOR_SIZE With sector size set to 4096 bytes, wear levelling library is more
int efficient. However if FAT filesystem is used on top of wear levelling
default 512 if WL_SECTOR_SIZE_512 library, it will need more temporary storage: 4096 bytes for each
default 4096 if WL_SECTOR_SIZE_4096 mounted filesystem and 4096 bytes for each opened file.
choice WL_SECTOR_MODE With sector size set to 512 bytes, wear levelling library will perform
bool "Sector store mode" more operations with flash memory, but less RAM will be used by FAT
depends on WL_SECTOR_SIZE_512 filesystem library (512 bytes for the filesystem and 512 bytes for each
default WL_SECTOR_MODE_SAFE file opened).
help
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.
config WL_SECTOR_MODE_PERF
bool "Perfomance"
config WL_SECTOR_MODE_SAFE
bool "Safety"
endchoice
config WL_SECTOR_MODE config WL_SECTOR_SIZE_512
int bool "512"
default 0 if WL_SECTOR_MODE_PERF config WL_SECTOR_SIZE_4096
default 1 if WL_SECTOR_MODE_SAFE bool "4096"
endchoice
config WL_SECTOR_SIZE
int
default 512 if WL_SECTOR_SIZE_512
default 4096 if WL_SECTOR_SIZE_4096
choice WL_SECTOR_MODE
bool "Sector store mode"
depends on WL_SECTOR_SIZE_512
default WL_SECTOR_MODE_SAFE
help
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.
config WL_SECTOR_MODE_PERF
bool "Perfomance"
config WL_SECTOR_MODE_SAFE
bool "Safety"
endchoice
config WL_SECTOR_MODE
int
default 0 if WL_SECTOR_MODE_PERF
default 1 if WL_SECTOR_MODE_SAFE
endmenu endmenu

65
examples/bluetooth/a2dp_gatts_coex/main/Kconfig.projbuild
View File

@ -1,43 +1,42 @@
menu "A2DP Example Configuration" menu "A2DP Example Configuration"
choice A2DP_SINK_OUTPUT choice A2DP_SINK_OUTPUT
prompt "A2DP Sink Output" prompt "A2DP Sink Output"
default A2DP_SINK_OUTPUT_EXTERNAL_I2S default A2DP_SINK_OUTPUT_EXTERNAL_I2S
help help
Select to use Internal DAC or external I2S driver Select to use Internal DAC or external I2S driver
config A2DP_SINK_OUTPUT_INTERNAL_DAC config A2DP_SINK_OUTPUT_INTERNAL_DAC
bool "Internal DAC" bool "Internal DAC"
help help
Select this to use Internal DAC sink output Select this to use Internal DAC sink output
config A2DP_SINK_OUTPUT_EXTERNAL_I2S config A2DP_SINK_OUTPUT_EXTERNAL_I2S
bool "External I2S Codec" bool "External I2S Codec"
help help
Select this to use External I2S sink output Select this to use External I2S sink output
endchoice endchoice
config I2S_LRCK_PIN config I2S_LRCK_PIN
int "I2S LRCK (WS) GPIO" int "I2S LRCK (WS) GPIO"
default 22 default 22
depends on A2DP_SINK_OUTPUT_EXTERNAL_I2S depends on A2DP_SINK_OUTPUT_EXTERNAL_I2S
help help
GPIO number to use for I2S LRCK(WS) Driver. GPIO number to use for I2S LRCK(WS) Driver.
config I2S_BCK_PIN config I2S_BCK_PIN
int "I2S BCK GPIO" int "I2S BCK GPIO"
default 26 default 26
depends on A2DP_SINK_OUTPUT_EXTERNAL_I2S depends on A2DP_SINK_OUTPUT_EXTERNAL_I2S
help help
GPIO number to use for I2S BCK Driver. GPIO number to use for I2S BCK Driver.
config I2S_DATA_PIN
int "I2S DATA GPIO"
default 25
depends on A2DP_SINK_OUTPUT_EXTERNAL_I2S
help
GPIO number to use for I2S Data Driver.
config I2S_DATA_PIN
int "I2S DATA GPIO"
default 25
depends on A2DP_SINK_OUTPUT_EXTERNAL_I2S
help
GPIO number to use for I2S Data Driver.
endmenu endmenu

65
examples/bluetooth/a2dp_sink/main/Kconfig.projbuild
View File

@ -1,43 +1,42 @@
menu "A2DP Example Configuration" menu "A2DP Example Configuration"
choice A2DP_SINK_OUTPUT choice A2DP_SINK_OUTPUT
prompt "A2DP Sink Output" prompt "A2DP Sink Output"
default A2DP_SINK_OUTPUT_EXTERNAL_I2S default A2DP_SINK_OUTPUT_EXTERNAL_I2S
help help
Select to use Internal DAC or external I2S driver Select to use Internal DAC or external I2S driver
config A2DP_SINK_OUTPUT_INTERNAL_DAC config A2DP_SINK_OUTPUT_INTERNAL_DAC
bool "Internal DAC" bool "Internal DAC"
help help
Select this to use Internal DAC sink output Select this to use Internal DAC sink output
config A2DP_SINK_OUTPUT_EXTERNAL_I2S config A2DP_SINK_OUTPUT_EXTERNAL_I2S
bool "External I2S Codec" bool "External I2S Codec"
help help
Select this to use External I2S sink output Select this to use External I2S sink output
endchoice endchoice
config I2S_LRCK_PIN config I2S_LRCK_PIN
int "I2S LRCK (WS) GPIO" int "I2S LRCK (WS) GPIO"
default 22 default 22
depends on A2DP_SINK_OUTPUT_EXTERNAL_I2S depends on A2DP_SINK_OUTPUT_EXTERNAL_I2S
help help
GPIO number to use for I2S LRCK(WS) Driver. GPIO number to use for I2S LRCK(WS) Driver.
config I2S_BCK_PIN config I2S_BCK_PIN
int "I2S BCK GPIO" int "I2S BCK GPIO"
default 26 default 26
depends on A2DP_SINK_OUTPUT_EXTERNAL_I2S depends on A2DP_SINK_OUTPUT_EXTERNAL_I2S
help help
GPIO number to use for I2S BCK Driver. GPIO number to use for I2S BCK Driver.
config I2S_DATA_PIN
int "I2S DATA GPIO"
default 25
depends on A2DP_SINK_OUTPUT_EXTERNAL_I2S
help
GPIO number to use for I2S Data Driver.
config I2S_DATA_PIN
int "I2S DATA GPIO"
default 25
depends on A2DP_SINK_OUTPUT_EXTERNAL_I2S
help
GPIO number to use for I2S Data Driver.
endmenu endmenu

36
examples/bluetooth/ble_ibeacon/main/Kconfig.projbuild
View File

@ -1,26 +1,26 @@
menu "iBeacon Example Configuration" menu "iBeacon Example Configuration"
choice IBEACON_MODE choice IBEACON_MODE
bool "iBeacon Mode" bool "iBeacon Mode"
default IBEACON_SENDER default IBEACON_SENDER
help help
Select the iBeacon Mode. Select the iBeacon Mode.
config IBEACON_SENDER config IBEACON_SENDER
bool "iBeacon Sender Mode" bool "iBeacon Sender Mode"
help help
Select the iBeacon Sender Mode. Select the iBeacon Sender Mode.
config IBEACON_RECEIVER config IBEACON_RECEIVER
bool "iBeacon Receiver Mode" bool "iBeacon Receiver Mode"
help help
Select the iBeacon Receiver Mode. Select the iBeacon Receiver Mode.
endchoice endchoice
config IBEACON_MODE config IBEACON_MODE
int int
default 0 if IBEACON_SENDER default 0 if IBEACON_SENDER
default 1 if IBEACON_RECEIVER default 1 if IBEACON_RECEIVER
endmenu endmenu

20
examples/bluetooth/ble_throughput/throughput_client/main/Kconfig
View File

@ -1,14 +1,14 @@
menu "Example 'GATT CLIENT THROUGHPUT' Config" menu "Example 'GATT CLIENT THROUGHPUT' Config"
config GATTS_NOTIFY_THROUGHPUT config GATTS_NOTIFY_THROUGHPUT
bool "test the gatts notify throughput" bool "test the gatts notify throughput"
help help
If this config item is set, then the 'GATTC_WRITE_THROUGHPUT' config should be close, it can't test both write or notify at the same time at this demo If this config item is set, then the 'GATTC_WRITE_THROUGHPUT' config should be close, it can't test both
write or notify at the same time at this demo
config GATTC_WRITE_THROUGHPUT config GATTC_WRITE_THROUGHPUT
bool "test the gattc write throughput" bool "test the gattc write throughput"
help help
If this config item is set, then the 'GATTS_NOTIFY_THROUGHPUT' config should be close, it can't test both write or notify at the same time at this demo If this config item is set, then the 'GATTS_NOTIFY_THROUGHPUT' config should be close, it can't test both
write or notify at the same time at this demo
endmenu endmenu

36
examples/bluetooth/ble_throughput/throughput_server/main/Kconfig
View File

@ -1,23 +1,27 @@
menu "Example 'GATT SERVER THROUGHPUT' Config" menu "Example 'GATT SERVER THROUGHPUT' Config"
config SET_RAW_ADV_DATA config SET_RAW_ADV_DATA
bool "Use raw data for advertising packets and scan response data" bool "Use raw data for advertising packets and scan response data"
help help
If this config item is set, raw binary data will be used to generate advertising & scan response data. If this config item is set, raw binary data will be used to generate advertising & scan response data.
This option uses the esp_ble_gap_config_adv_data_raw() and esp_ble_gap_config_scan_rsp_data_raw() functions. This option uses the esp_ble_gap_config_adv_data_raw() and esp_ble_gap_config_scan_rsp_data_raw()
functions.
If this config item is unset, advertising & scan response data is provided via a higher-level esp_ble_adv_data_t structure. If this config item is unset, advertising & scan response data is provided via a higher-level
The lower layer will generate the BLE packets. This option has higher overhead at runtime. esp_ble_adv_data_t structure. The lower layer will generate the BLE packets. This option has higher
overhead at runtime.
config GATTS_NOTIFY_THROUGHPUT
bool "test the gatts notify throughput"
help
If this config item is set, then the 'GATTC_WRITE_THROUGHPUT' config should be close, it can't test both write or notify at the same time at this demo
config GATTC_WRITE_THROUGHPUT config GATTS_NOTIFY_THROUGHPUT
bool "test the gattc write throughput" bool "test the gatts notify throughput"
help help
If this config item is set, then the 'GATTS_NOTIFY_THROUGHPUT' config should be close, it can't test both write or notify at the same time at this demo If this config item is set, then the 'GATTC_WRITE_THROUGHPUT' config should be close, it can't test both
write or notify at the same time at this demo
config GATTC_WRITE_THROUGHPUT
bool "test the gattc write throughput"
help
If this config item is set, then the 'GATTS_NOTIFY_THROUGHPUT' config should be close, it can't test both
write or notify at the same time at this demo
endmenu endmenu

16
examples/bluetooth/gatt_server/main/Kconfig
View File

@ -1,12 +1,14 @@
menu "Example 'GATT SERVER' Config" menu "Example 'GATT SERVER' Config"
config SET_RAW_ADV_DATA config SET_RAW_ADV_DATA
bool "Use raw data for advertising packets and scan response data" bool "Use raw data for advertising packets and scan response data"
help help
If this config item is set, raw binary data will be used to generate advertising & scan response data. If this config item is set, raw binary data will be used to generate advertising & scan response data.
This option uses the esp_ble_gap_config_adv_data_raw() and esp_ble_gap_config_scan_rsp_data_raw() functions. This option uses the esp_ble_gap_config_adv_data_raw() and esp_ble_gap_config_scan_rsp_data_raw()
functions.
If this config item is unset, advertising & scan response data is provided via a higher-level esp_ble_adv_data_t structure. If this config item is unset, advertising & scan response data is provided via a higher-level
The lower layer will generate the BLE packets. This option has higher overhead at runtime. esp_ble_adv_data_t structure. The lower layer will generate the BLE packets. This option has higher
overhead at runtime.
endmenu endmenu

16
examples/get-started/blink/main/Kconfig.projbuild
View File

@ -1,14 +1,14 @@
menu "Example Configuration" menu "Example Configuration"
config BLINK_GPIO config BLINK_GPIO
int "Blink GPIO number" int "Blink GPIO number"
range 0 34 range 0 34
default 5 default 5
help help
GPIO number (IOxx) to blink on and off. GPIO number (IOxx) to blink on and off.
Some GPIOs are used for other purposes (flash connections, etc.) and cannot be used to blink. Some GPIOs are used for other purposes (flash connections, etc.) and cannot be used to blink.
GPIOs 35-39 are input-only so cannot be used as outputs. GPIOs 35-39 are input-only so cannot be used as outputs.
endmenu endmenu

62
examples/mesh/internal_communication/main/Kconfig.projbuild
View File

@ -1,42 +1,42 @@
menu "Example Configuration" menu "Example Configuration"
config MESH_CHANNEL config MESH_CHANNEL
int "channel" int "channel"
range 0 14 range 0 14
default 0 default 0
help help
mesh network channel. mesh network channel.
config MESH_ROUTER_SSID config MESH_ROUTER_SSID
string "Router SSID" string "Router SSID"
default "ROUTER_SSID" default "ROUTER_SSID"
help help
Router SSID. Router SSID.
config MESH_ROUTER_PASSWD config MESH_ROUTER_PASSWD
string "Router password" string "Router password"
default "ROUTER_PASSWD" default "ROUTER_PASSWD"
help help
Router password. Router password.
choice choice
bool "Mesh AP Authentication Mode" bool "Mesh AP Authentication Mode"
default WIFI_AUTH_WPA2_PSK default WIFI_AUTH_WPA2_PSK
help help
Authentication mode. Authentication mode.
config WIFI_AUTH_OPEN config WIFI_AUTH_OPEN
bool "WIFI_AUTH_OPEN" bool "WIFI_AUTH_OPEN"
config WIFI_AUTH_WPA_PSK config WIFI_AUTH_WPA_PSK
bool "WIFI_AUTH_WPA_PSK" bool "WIFI_AUTH_WPA_PSK"
config WIFI_AUTH_WPA2_PSK config WIFI_AUTH_WPA2_PSK
bool "WIFI_AUTH_WPA2_PSK" bool "WIFI_AUTH_WPA2_PSK"
config WIFI_AUTH_WPA_WPA2_PSK config WIFI_AUTH_WPA_WPA2_PSK
bool "WIFI_AUTH_WPA_WPA2_PSK" bool "WIFI_AUTH_WPA_WPA2_PSK"
endchoice endchoice
config MESH_AP_AUTHMODE config MESH_AP_AUTHMODE
int int
default 0 if WIFI_AUTH_OPEN default 0 if WIFI_AUTH_OPEN
default 2 if WIFI_AUTH_WPA_PSK default 2 if WIFI_AUTH_WPA_PSK
default 3 if WIFI_AUTH_WPA2_PSK default 3 if WIFI_AUTH_WPA2_PSK
@ -44,28 +44,28 @@ config MESH_AP_AUTHMODE
help help
Mesh AP authentication mode. Mesh AP authentication mode.
config MESH_AP_PASSWD config MESH_AP_PASSWD
string "Mesh AP Password" string "Mesh AP Password"
default "MAP_PASSWD" default "MAP_PASSWD"
help help
Mesh AP password. Mesh AP password.
config MESH_AP_CONNECTIONS config MESH_AP_CONNECTIONS
int "Mesh AP Connections" int "Mesh AP Connections"
range 1 10 range 1 10
default 6 default 6
help help
The number of stations allowed to connect in. The number of stations allowed to connect in.
config MESH_MAX_LAYER config MESH_MAX_LAYER
int "Mesh Max Layer" int "Mesh Max Layer"
range 1 25 range 1 25
default 6 default 6
help help
Max layer allowed in mesh network. Max layer allowed in mesh network.
config MESH_ROUTE_TABLE_SIZE config MESH_ROUTE_TABLE_SIZE
int "Mesh Routing Table Size" int "Mesh Routing Table Size"
range 1 300 range 1 300
default 50 default 50
help help

80
examples/mesh/manual_networking/main/Kconfig.projbuild
View File

@ -1,42 +1,42 @@
menu "Example Configuration" menu "Example Configuration"
config MESH_CHANNEL config MESH_CHANNEL
int "channel" int "channel"
range 1 14 range 1 14
default 1 default 1
help help
mesh network channel. mesh network channel.
config MESH_ROUTER_SSID config MESH_ROUTER_SSID
string "Router SSID" string "Router SSID"
default "ROUTER_SSID" default "ROUTER_SSID"
help help
Router SSID. Router SSID.
config MESH_ROUTER_PASSWD config MESH_ROUTER_PASSWD
string "Router password" string "Router password"
default "ROUTER_PASSWD" default "ROUTER_PASSWD"
help help
Router password. Router password.
choice choice
bool "Mesh AP Authentication Mode" bool "Mesh AP Authentication Mode"
default WIFI_AUTH_WPA2_PSK default WIFI_AUTH_WPA2_PSK
help help
Authentication mode. Authentication mode.
config WIFI_AUTH_OPEN config WIFI_AUTH_OPEN
bool "WIFI_AUTH_OPEN" bool "WIFI_AUTH_OPEN"
config WIFI_AUTH_WPA_PSK config WIFI_AUTH_WPA_PSK
bool "WIFI_AUTH_WPA_PSK" bool "WIFI_AUTH_WPA_PSK"
config WIFI_AUTH_WPA2_PSK config WIFI_AUTH_WPA2_PSK
bool "WIFI_AUTH_WPA2_PSK" bool "WIFI_AUTH_WPA2_PSK"
config WIFI_AUTH_WPA_WPA2_PSK config WIFI_AUTH_WPA_WPA2_PSK
bool "WIFI_AUTH_WPA_WPA2_PSK" bool "WIFI_AUTH_WPA_WPA2_PSK"
endchoice endchoice
config MESH_AP_AUTHMODE config MESH_AP_AUTHMODE
int int
default 0 if WIFI_AUTH_OPEN default 0 if WIFI_AUTH_OPEN
default 2 if WIFI_AUTH_WPA_PSK default 2 if WIFI_AUTH_WPA_PSK
default 3 if WIFI_AUTH_WPA2_PSK default 3 if WIFI_AUTH_WPA2_PSK
@ -44,46 +44,46 @@ config MESH_AP_AUTHMODE
help help
Mesh AP authentication mode. Mesh AP authentication mode.
config MESH_AP_PASSWD config MESH_AP_PASSWD
string "Mesh AP Password" string "Mesh AP Password"
default "MAP_PASSWD" default "MAP_PASSWD"
help help
Mesh AP password. Mesh AP password.
config MESH_AP_CONNECTIONS config MESH_AP_CONNECTIONS
int "Mesh AP Connections" int "Mesh AP Connections"
range 1 10 range 1 10
default 6 default 6
help help
The number of stations allowed to connect in. The number of stations allowed to connect in.
config MESH_MAX_LAYER config MESH_MAX_LAYER
int "Mesh Max Layer" int "Mesh Max Layer"
range 1 25 range 1 25
default 6 default 6
help help
Max layer allowed in mesh network. Max layer allowed in mesh network.
config MESH_IE_CRYPTO_KEY config MESH_IE_CRYPTO_KEY
string "Mesh IE Crypto Key" string "Mesh IE Crypto Key"
default "hello, esp-mesh." default "hello, esp-mesh."
help help
Mesh IE ASCII crypto key, length in bytes, range:8~64. Mesh IE ASCII crypto key, length in bytes, range:8~64.
choice choice
bool "Mesh IE Crypto Funcs" bool "Mesh IE Crypto Funcs"
default IE_CRYPTO_ENABLE default IE_CRYPTO_ENABLE
help help
Mesh IE crypto funcs. Mesh IE crypto funcs.
config IE_CRYPTO_ENABLE config IE_CRYPTO_ENABLE
bool "IE_CRYPTO_ENABLE" bool "IE_CRYPTO_ENABLE"
config IE_CRYPTO_DISABLE config IE_CRYPTO_DISABLE
bool "IE_CRYPTO_DISABLE" bool "IE_CRYPTO_DISABLE"
endchoice endchoice
config MESH_IE_CRYPTO_FUNCS config MESH_IE_CRYPTO_FUNCS
int int
default 1 if IE_CRYPTO_ENABLE default 1 if IE_CRYPTO_ENABLE
default 0 if IE_CRYPTO_DISABLE default 0 if IE_CRYPTO_DISABLE
help help

104
examples/peripherals/adc2/main/Kconfig.projbuild
View File

@ -1,61 +1,61 @@
menu "Example Configuration" menu "Example Configuration"
choice ADC2_EXAMPLE_CHANNEL choice ADC2_EXAMPLE_CHANNEL
bool "ADC2 Channel Num" bool "ADC2 Channel Num"
default ADC2_EXAMPLE_CHANNEL_7 default ADC2_EXAMPLE_CHANNEL_7
help help
The channel of ADC2 used in this example. The channel of ADC2 used in this example.
config ADC2_EXAMPLE_CHANNEL_0 config ADC2_EXAMPLE_CHANNEL_0
bool "ADC2 Channel 0 (GPIO 4)" bool "ADC2 Channel 0 (GPIO 4)"
config ADC2_EXAMPLE_CHANNEL_1 config ADC2_EXAMPLE_CHANNEL_1
bool "ADC2 Channel 1 (GPIO 0)" bool "ADC2 Channel 1 (GPIO 0)"
config ADC2_EXAMPLE_CHANNEL_2 config ADC2_EXAMPLE_CHANNEL_2
bool "ADC2 Channel 2 (GPIO 2)" bool "ADC2 Channel 2 (GPIO 2)"
config ADC2_EXAMPLE_CHANNEL_3 config ADC2_EXAMPLE_CHANNEL_3
bool "ADC2 Channel 3 (GPIO 15)" bool "ADC2 Channel 3 (GPIO 15)"
config ADC2_EXAMPLE_CHANNEL_4 config ADC2_EXAMPLE_CHANNEL_4
bool "ADC2 Channel 4 (GPIO 13)" bool "ADC2 Channel 4 (GPIO 13)"
config ADC2_EXAMPLE_CHANNEL_5 config ADC2_EXAMPLE_CHANNEL_5
bool "ADC2 Channel 5 (GPIO 12)" bool "ADC2 Channel 5 (GPIO 12)"
config ADC2_EXAMPLE_CHANNEL_6 config ADC2_EXAMPLE_CHANNEL_6
bool "ADC2 Channel 6 (GPIO 14)" bool "ADC2 Channel 6 (GPIO 14)"
config ADC2_EXAMPLE_CHANNEL_7 config ADC2_EXAMPLE_CHANNEL_7
bool "ADC2 Channel 7 (GPIO 27)" bool "ADC2 Channel 7 (GPIO 27)"
config ADC2_EXAMPLE_CHANNEL_8 config ADC2_EXAMPLE_CHANNEL_8
bool "ADC2 Channel 8 (GPIO 25)" bool "ADC2 Channel 8 (GPIO 25)"
config ADC2_EXAMPLE_CHANNEL_9 config ADC2_EXAMPLE_CHANNEL_9
bool "ADC2 Channel 9 (GPIO 26)" bool "ADC2 Channel 9 (GPIO 26)"
endchoice endchoice
config ADC2_EXAMPLE_CHANNEL config ADC2_EXAMPLE_CHANNEL
int int
default 0 if ADC2_EXAMPLE_CHANNEL_0 default 0 if ADC2_EXAMPLE_CHANNEL_0
default 1 if ADC2_EXAMPLE_CHANNEL_1 default 1 if ADC2_EXAMPLE_CHANNEL_1
default 2 if ADC2_EXAMPLE_CHANNEL_2 default 2 if ADC2_EXAMPLE_CHANNEL_2
default 3 if ADC2_EXAMPLE_CHANNEL_3 default 3 if ADC2_EXAMPLE_CHANNEL_3
default 4 if ADC2_EXAMPLE_CHANNEL_4 default 4 if ADC2_EXAMPLE_CHANNEL_4
default 5 if ADC2_EXAMPLE_CHANNEL_5 default 5 if ADC2_EXAMPLE_CHANNEL_5
default 6 if ADC2_EXAMPLE_CHANNEL_6 default 6 if ADC2_EXAMPLE_CHANNEL_6
default 7 if ADC2_EXAMPLE_CHANNEL_7 default 7 if ADC2_EXAMPLE_CHANNEL_7
default 8 if ADC2_EXAMPLE_CHANNEL_8 default 8 if ADC2_EXAMPLE_CHANNEL_8
default 9 if ADC2_EXAMPLE_CHANNEL_9 default 9 if ADC2_EXAMPLE_CHANNEL_9
choice DAC_EXAMPLE_CHANNEL choice DAC_EXAMPLE_CHANNEL
bool "DAC Channel Num" bool "DAC Channel Num"
default DAC_EXAMPLE_CHANNEL_1 default DAC_EXAMPLE_CHANNEL_1
help help
The channel of DAC used in this example. The channel of DAC used in this example.
config DAC_EXAMPLE_CHANNEL_1 config DAC_EXAMPLE_CHANNEL_1
bool "DAC Channel 1 (GPIO25)" bool "DAC Channel 1 (GPIO25)"
config DAC_EXAMPLE_CHANNEL_2 config DAC_EXAMPLE_CHANNEL_2
bool "DAC Channel 2 (GPIO26)" bool "DAC Channel 2 (GPIO26)"
endchoice endchoice
config DAC_EXAMPLE_CHANNEL config DAC_EXAMPLE_CHANNEL
int int
default 1 if DAC_EXAMPLE_CHANNEL_1 default 1 if DAC_EXAMPLE_CHANNEL_1
default 2 if DAC_EXAMPLE_CHANNEL_2 default 2 if DAC_EXAMPLE_CHANNEL_2
endmenu endmenu

214
examples/peripherals/i2c/i2c_self_test/main/Kconfig.projbuild
View File

@ -1,124 +1,124 @@
menu "Example Configuration" menu "Example Configuration"
menu "I2C Master" menu "I2C Master"
config I2C_MASTER_SCL config I2C_MASTER_SCL
int "SCL GPIO Num" int "SCL GPIO Num"
default 19 default 19
help help
GPIO number for I2C Master clock line. GPIO number for I2C Master clock line.
config I2C_MASTER_SDA config I2C_MASTER_SDA
int "SDA GPIO Num" int "SDA GPIO Num"
default 18 default 18
help help
GPIO number for I2C Master data line. GPIO number for I2C Master data line.
config I2C_MASTER_PORT_NUM config I2C_MASTER_PORT_NUM
int "Port Number" int "Port Number"
default 1 default 1
help help
Port number for I2C Master device. Port number for I2C Master device.
config I2C_MASTER_FREQUENCY config I2C_MASTER_FREQUENCY
int "Master Frequency" int "Master Frequency"
default 100000 default 100000
help help
I2C Speed of Master device. I2C Speed of Master device.
endmenu endmenu
menu "I2C Slave" menu "I2C Slave"
config I2C_SLAVE_SCL config I2C_SLAVE_SCL
int "SCL GPIO Num" int "SCL GPIO Num"
default 26 default 26
help help
GPIO number for I2C Slave clock line. GPIO number for I2C Slave clock line.
config I2C_SLAVE_SDA config I2C_SLAVE_SDA
int "SDA GPIO Num" int "SDA GPIO Num"
default 25 default 25
help help
GPIO number for I2C Slave data line. GPIO number for I2C Slave data line.
config I2C_SLAVE_PORT_NUM config I2C_SLAVE_PORT_NUM
int "Port Number" int "Port Number"
default 0 default 0
help help
Port number for I2C Slave device. Port number for I2C Slave device.
config I2C_SLAVE_ADDRESS config I2C_SLAVE_ADDRESS
hex "ESP Slave Address" hex "ESP Slave Address"
default 0x28 default 0x28
help help
Hardware Address of I2C Slave Port. Hardware Address of I2C Slave Port.
endmenu endmenu
menu "BH1750 Sensor" menu "BH1750 Sensor"
choice BH1750_ADDR choice BH1750_ADDR
prompt "BH1750 I2C Address" prompt "BH1750 I2C Address"
default BH1750_I2C_ADDRESS_LOW default BH1750_I2C_ADDRESS_LOW
help help
Hardware address of BH1750, which is 2 types, and determined by ADDR terminal. Hardware address of BH1750, which is 2 types, and determined by ADDR terminal.
config BH1750_I2C_ADDRESS_LOW config BH1750_I2C_ADDRESS_LOW
bool "BH1750 I2C Address(ADDR=0)" bool "BH1750 I2C Address(ADDR=0)"
help help
I2C Address of BH1750 Sensor according to your schemetic configuration. I2C Address of BH1750 Sensor according to your schemetic configuration.
config BH1750_I2C_ADDRESS_High config BH1750_I2C_ADDRESS_High
bool "BH1750 I2C Address(ADDR=1)" bool "BH1750 I2C Address(ADDR=1)"
help help
I2C Address of BH1750 Sensor according to your schemetic configuration. I2C Address of BH1750 Sensor according to your schemetic configuration.
endchoice endchoice
config BH1750_ADDR config BH1750_ADDR
hex hex
default 0x5C if BH1750_I2C_ADDRESS_High default 0x5C if BH1750_I2C_ADDRESS_High
default 0x23 if BH1750_I2C_ADDRESS_LOW default 0x23 if BH1750_I2C_ADDRESS_LOW
choice BH1750_MODE choice BH1750_MODE
prompt "BH1750 Operation Mode" prompt "BH1750 Operation Mode"
default BH1750_ONETIME_L_RESOLUTION default BH1750_ONETIME_L_RESOLUTION
help help
Operation Mode of BH1750. Operation Mode of BH1750.
Different mode means different resolution and measurement time. Different mode means different resolution and measurement time.
config BH1750_CONTINU_H_RESOLUTION config BH1750_CONTINU_H_RESOLUTION
bool "Continuously H-Resolution Mode" bool "Continuously H-Resolution Mode"
help help
Resolution is 1lx, measurement time is typically 120ms. Resolution is 1lx, measurement time is typically 120ms.
config BH1750_CONTINU_H_RESOLUTION2 config BH1750_CONTINU_H_RESOLUTION2
bool "Continuously H-Resolution Mode2" bool "Continuously H-Resolution Mode2"
help help
Resolution is 0.5lx, measurement time is typically 120ms. Resolution is 0.5lx, measurement time is typically 120ms.
config BH1750_CONTINU_L_RESOLUTION config BH1750_CONTINU_L_RESOLUTION
bool "Continuously L-Resolution Mode" bool "Continuously L-Resolution Mode"
help help
Resolution is 4lx, measurement time is typically 16ms. Resolution is 4lx, measurement time is typically 16ms.
config BH1750_ONETIME_H_RESOLUTION config BH1750_ONETIME_H_RESOLUTION
bool "One Time H-Resolution Mode" bool "One Time H-Resolution Mode"
help help
Resolution is 1lx, measurement time is typically 120ms. Resolution is 1lx, measurement time is typically 120ms.
It is automatically set to Power Down mode after measurement. It is automatically set to Power Down mode after measurement.
config BH1750_ONETIME_H_RESOLUTION2 config BH1750_ONETIME_H_RESOLUTION2
bool "One Time H-Resolution Mode2" bool "One Time H-Resolution Mode2"
help help
Resolution is 0.5lx, measurement time is typically 120ms. Resolution is 0.5lx, measurement time is typically 120ms.
It is automatically set to Power Down mode after measurement. It is automatically set to Power Down mode after measurement.
config BH1750_ONETIME_L_RESOLUTION config BH1750_ONETIME_L_RESOLUTION
bool "One Time L-Resolution Mode" bool "One Time L-Resolution Mode"
help help
Resolution is 4lx, measurement time is typically 16ms. Resolution is 4lx, measurement time is typically 16ms.
It is automatically set to Power Down mode after measurement. It is automatically set to Power Down mode after measurement.
endchoice endchoice
config BH1750_OPMODE config BH1750_OPMODE
hex hex
default 0x10 if BH1750_CONTINU_H_RESOLUTION default 0x10 if BH1750_CONTINU_H_RESOLUTION
default 0x11 if BH1750_CONTINU_H_RESOLUTION2 default 0x11 if BH1750_CONTINU_H_RESOLUTION2
default 0x13 if BH1750_CONTINU_L_RESOLUTION default 0x13 if BH1750_CONTINU_L_RESOLUTION
default 0x20 if BH1750_ONETIME_H_RESOLUTION default 0x20 if BH1750_ONETIME_H_RESOLUTION
default 0x21 if BH1750_ONETIME_H_RESOLUTION2 default 0x21 if BH1750_ONETIME_H_RESOLUTION2
default 0x23 if BH1750_ONETIME_L_RESOLUTION default 0x23 if BH1750_ONETIME_L_RESOLUTION
endmenu endmenu
endmenu endmenu

38
examples/peripherals/i2c/i2c_tools/main/Kconfig.projbuild
View File

@ -1,25 +1,25 @@
menu "Example Configuration" menu "Example Configuration"
config STORE_HISTORY config STORE_HISTORY
bool "Store command history in flash" bool "Store command history in flash"
default y default y
help help
Linenoise line editing library provides functions to save and load Linenoise line editing library provides functions to save and load
command history. If this option is enabled, initalizes a FAT filesystem command history. If this option is enabled, initalizes a FAT filesystem
and uses it to store command history. and uses it to store command history.
config MAX_CMD_ARGUMENTS config MAX_CMD_ARGUMENTS
int "Maximum number of command line arguments" int "Maximum number of command line arguments"
default 16 default 16
range 8 256 range 8 256
help help
maximum number of command line arguments to parse maximum number of command line arguments to parse
config MAX_CMD_LENGTH config MAX_CMD_LENGTH
int "Command line buffer length" int "Command line buffer length"
default 256 default 256
range 256 512 range 256 512
help help
length of command line buffer, in bytes length of command line buffer, in bytes
endmenu endmenu

68
examples/peripherals/sdio/host/main/Kconfig.projbuild
View File

@ -1,43 +1,43 @@
menu "Example Configuration" menu "Example Configuration"
config SDIO_EXAMPLE_4BIT config SDIO_EXAMPLE_4BIT
bool "Host tries using 4-bit mode to communicate with slave" bool "Host tries using 4-bit mode to communicate with slave"
default n default n
help help
If this is set, the host tries using 4-bit mode to communicate with If this is set, the host tries using 4-bit mode to communicate with
slave. If failed, the communication falls back to 1-bit mode. slave. If failed, the communication falls back to 1-bit mode.
If this is not set, the host uses 1-bit mode. However, CMD1 is still
mandatory for interrupts.
Note that 4-bit mode is not compatible (by default) if the slave is If this is not set, the host uses 1-bit mode. However, CMD1 is still
using 3.3V flash which requires a pull-down on the MTDI pin. mandatory for interrupts.
config SDIO_EXAMPLE_HIGHSPEED Note that 4-bit mode is not compatible (by default) if the slave is
bool "Host tries using HS mode to communicate with slave" using 3.3V flash which requires a pull-down on the MTDI pin.
default y
help
If this is set, the host tries using high-speed mode to communicate
with slave. If the slave doesn't support high-speed mode, the
communication falls back to default-speed mode. If this is not set,
the host uses DS mode.
If the example does not work, please try disabling the HS mode. config SDIO_EXAMPLE_HIGHSPEED
bool "Host tries using HS mode to communicate with slave"
default y
help
If this is set, the host tries using high-speed mode to communicate
with slave. If the slave doesn't support high-speed mode, the
communication falls back to default-speed mode. If this is not set,
the host uses DS mode.
choice EXAMPLE_SLAVE If the example does not work, please try disabling the HS mode.
prompt "Id of Slave used in Espressif master-slave board."
default EXAMPLE_SLAVE_NONE
help
If Espressif master-slave board is used, select which slave is used.
config EXAMPLE_SLAVE_NONE choice EXAMPLE_SLAVE
bool "Not using Espressif master-slave board." prompt "Id of Slave used in Espressif master-slave board."
config EXAMPLE_SLAVE_B1 default EXAMPLE_SLAVE_NONE
bool "Using slave B1" help
config EXAMPLE_SLAVE_B2 If Espressif master-slave board is used, select which slave is used.
bool "Using slave B2"
config EXAMPLE_SLAVE_B3 config EXAMPLE_SLAVE_NONE
bool "Using slave B3" bool "Not using Espressif master-slave board."
endchoice config EXAMPLE_SLAVE_B1
bool "Using slave B1"
config EXAMPLE_SLAVE_B2
bool "Using slave B2"
config EXAMPLE_SLAVE_B3
bool "Using slave B3"
endchoice
endmenu endmenu

24
examples/peripherals/sdio/slave/main/Kconfig.projbuild
View File

@ -1,16 +1,16 @@
menu "Example Configuration" menu "Example Configuration"
config SDIO_DAT2_DISABLED config SDIO_DAT2_DISABLED
bool "Disable the DAT2 in SDIO slave" bool "Disable the DAT2 in SDIO slave"
default y default y
help help
SDIO slave DAT pin is unfortunately the same pin as MTDI, which SDIO slave DAT pin is unfortunately the same pin as MTDI, which
controls the flash power voltage. For 3.3v flash devkits / modules / controls the flash power voltage. For 3.3v flash devkits / modules /
kits, it conflicts with the DAT2 pullups required by the kits, it conflicts with the DAT2 pullups required by the
specification. specification.
This disables the peripheral input from the DAT2 so that we can work This disables the peripheral input from the DAT2 so that we can work
in 1-bit mode when DAT2 is floating (pulled down). 4-bit mode is in 1-bit mode when DAT2 is floating (pulled down). 4-bit mode is
therefore unavailable. therefore unavailable.
endmenu endmenu

40
examples/peripherals/spi_master/main/Kconfig.projbuild
View File

@ -1,26 +1,26 @@
menu "Example Configuration" menu "Example Configuration"
choice LCD_TYPE choice LCD_TYPE
prompt "LCD module type" prompt "LCD module type"
default LCD_TYPE_AUTO default LCD_TYPE_AUTO
help help
The type of LCD on the evaluation board. The type of LCD on the evaluation board.
config LCD_TYPE_AUTO config LCD_TYPE_AUTO
bool "Auto detect" bool "Auto detect"
config LCD_TYPE_ST7789V config LCD_TYPE_ST7789V
bool "ST7789V (WROVER Kit v2 or v3)" bool "ST7789V (WROVER Kit v2 or v3)"
config LCD_TYPE_ILI9341 config LCD_TYPE_ILI9341
bool "ILI9341 (WROVER Kit v1 or DevKitJ v1)" bool "ILI9341 (WROVER Kit v1 or DevKitJ v1)"
endchoice endchoice
config LCD_OVERCLOCK config LCD_OVERCLOCK
bool bool
prompt "Run LCD at higher clock speed than allowed" prompt "Run LCD at higher clock speed than allowed"
default "n" default "n"
help help
The ILI9341 and ST7789 specify that the maximum clock speed for the SPI interface is 10MHz. However, The ILI9341 and ST7789 specify that the maximum clock speed for the SPI interface is 10MHz. However,
in practice the driver chips work fine with a higher clock rate, and using that gives a better framerate. in practice the driver chips work fine with a higher clock rate, and using that gives a better framerate.
Select this to try using the out-of-spec clock rate. Select this to try using the out-of-spec clock rate.
endmenu endmenu

134
examples/peripherals/uart/nmea0183_parser/main/Kconfig.projbuild
View File

@ -1,85 +1,85 @@
menu "Example Configuration" menu "Example Configuration"
config NMEA_PARSER_RING_BUFFER_SIZE config NMEA_PARSER_RING_BUFFER_SIZE
int "NMEA Parser Ring Buffer Size" int "NMEA Parser Ring Buffer Size"
range 0 2048 range 0 2048
default 1024 default 1024
help help
Size of the ring buffer used for UART Rx channel. Size of the ring buffer used for UART Rx channel.
config NMEA_PARSER_TASK_STACK_SIZE config NMEA_PARSER_TASK_STACK_SIZE
int "NMEA Parser Task Stack Size" int "NMEA Parser Task Stack Size"
range 0 4096 range 0 4096
default 2048 default 2048
help help
Stack size of NMEA Parser task. Stack size of NMEA Parser task.
config NMEA_PARSER_TASK_PRIORITY config NMEA_PARSER_TASK_PRIORITY
int "NMEA Parser Task Priority" int "NMEA Parser Task Priority"
range 0 24 range 0 24
default 2 default 2
help help
Priority of NMEA Parser task. Priority of NMEA Parser task.
menu "NMEA Statement Support" menu "NMEA Statement Support"
comment "At least one statement must be selected" comment "At least one statement must be selected"
config NMEA_STATEMENT_GGA config NMEA_STATEMENT_GGA
bool "GGA Statement" bool "GGA Statement"
default y default y
help help
Enabling this option will parse the following parameter from GGA statement: Enabling this option will parse the following parameter from GGA statement:
- Latitude, Longitude, Altitude; - Latitude, Longitude, Altitude;
- Number of satellites in use, fix status (no fix, GPS, DGPS), UTC time; - Number of satellites in use, fix status (no fix, GPS, DGPS), UTC time;
config NMEA_STATEMENT_GSA config NMEA_STATEMENT_GSA
bool "GSA Statement" bool "GSA Statement"
default y default y
help help
Enabling this option will parse the following parameter from GSA statement: Enabling this option will parse the following parameter from GSA statement:
- Position/Vertical/Horizontal dilution of precision; - Position/Vertical/Horizontal dilution of precision;
- Fix mode (no fix, 2D, 3D fix); - Fix mode (no fix, 2D, 3D fix);
- IDs of satellites in use; - IDs of satellites in use;
config NMEA_STATEMENT_GSV config NMEA_STATEMENT_GSV
bool "GSV Statement" bool "GSV Statement"
default y default y
help help
Enabling this option will parse the following parameter from GSV statement: Enabling this option will parse the following parameter from GSV statement:
- Number of satellites in view; - Number of satellites in view;
- Optional details of each satellite in view; - Optional details of each satellite in view;
config NMEA_STATEMENT_RMC config NMEA_STATEMENT_RMC
bool "RMC Statement" bool "RMC Statement"
default y default y
help help
Enabling this option will parse the following parameter from RMC statement: Enabling this option will parse the following parameter from RMC statement:
- Validity of GPS signal; - Validity of GPS signal;
- Ground speed (knots) and course over ground (degrees); - Ground speed (knots) and course over ground (degrees);
- Magnetic variation; - Magnetic variation;
- UTC date; - UTC date;
config NMEA_STATEMENT_GLL config NMEA_STATEMENT_GLL
bool "GLL Statement" bool "GLL Statement"
default y default y
help help
Enabling this option will parse the following parameter from GLL statement: Enabling this option will parse the following parameter from GLL statement:
- Latitude, Longitude; - Latitude, Longitude;
- UTC time; - UTC time;
config NMEA_STATEMENT_VTG config NMEA_STATEMENT_VTG
bool "VTG Statement" bool "VTG Statement"
default y default y
help help
Enabling this option will parse the following parameter from VTG statement: Enabling this option will parse the following parameter from VTG statement:
- Ground speed (knots, km/h) and course over ground (degrees); - Ground speed (knots, km/h) and course over ground (degrees);
- Magnetic variation; - Magnetic variation;
endmenu endmenu
endmenu endmenu

41
examples/protocols/asio/chat_client/main/Kconfig.projbuild
View File

@ -1,27 +1,28 @@
menu "Example Configuration" menu "Example Configuration"
config ESP_WIFI_SSID config ESP_WIFI_SSID
string "WiFi SSID" string "WiFi SSID"
default "myssid" default "myssid"
help help
SSID (network name) for the example to connect to. SSID (network name) for the example to connect to.
config ESP_WIFI_PASSWORD config ESP_WIFI_PASSWORD
string "WiFi Password" string "WiFi Password"
default "mypassword" default "mypassword"
help help
WiFi password (WPA or WPA2) for the example to use. WiFi password (WPA or WPA2) for the example to use.
config EXAMPLE_PORT config EXAMPLE_PORT
string "asio example port number" string "asio example port number"
default "2222" default "2222"
help help
Port number used by ASIO example Port number used by ASIO example
config EXAMPLE_SERVER_IP config EXAMPLE_SERVER_IP
string "asio example server ip for this client to connect to (leave defalut=FROM_STDIN to enter the server address via serial terminal)" string "asio example server ip"
default "FROM_STDIN" default "FROM_STDIN"
help help
Please set the host name or ip address of corespondant server running asio example server ip for this client to connect to (leave default=FROM_STDIN to enter the server address
via serial terminal).
endmenu endmenu

30
examples/protocols/asio/chat_server/main/Kconfig.projbuild
View File

@ -1,21 +1,21 @@
menu "Example Configuration" menu "Example Configuration"
config ESP_WIFI_SSID config ESP_WIFI_SSID
string "WiFi SSID" string "WiFi SSID"
default "myssid" default "myssid"
help help
SSID (network name) for the example to connect to. SSID (network name) for the example to connect to.
config ESP_WIFI_PASSWORD config ESP_WIFI_PASSWORD
string "WiFi Password" string "WiFi Password"
default "mypassword" default "mypassword"
help help
WiFi password (WPA or WPA2) for the example to use. WiFi password (WPA or WPA2) for the example to use.
config EXAMPLE_PORT config EXAMPLE_PORT
string "asio example port number" string "asio example port number"
default "80" default "80"
help help
Port number used by ASIO example Port number used by ASIO example
endmenu endmenu

30
examples/protocols/asio/tcp_echo_server/main/Kconfig.projbuild
View File

@ -1,21 +1,21 @@
menu "Example Configuration" menu "Example Configuration"
config ESP_WIFI_SSID config ESP_WIFI_SSID
string "WiFi SSID" string "WiFi SSID"
default "myssid" default "myssid"
help help
SSID (network name) for the example to connect to. SSID (network name) for the example to connect to.
config ESP_WIFI_PASSWORD config ESP_WIFI_PASSWORD
string "WiFi Password" string "WiFi Password"
default "mypassword" default "mypassword"
help help
WiFi password (WPA or WPA2) for the example to use. WiFi password (WPA or WPA2) for the example to use.
config EXAMPLE_PORT config EXAMPLE_PORT
string "asio example port number" string "asio example port number"
default "80" default "80"
help help
Port number used by ASIO example Port number used by ASIO example
endmenu endmenu

30
examples/protocols/asio/udp_echo_server/main/Kconfig.projbuild
View File

@ -1,21 +1,21 @@
menu "Example Configuration" menu "Example Configuration"
config ESP_WIFI_SSID config ESP_WIFI_SSID
string "WiFi SSID" string "WiFi SSID"
default "myssid" default "myssid"
help help
SSID (network name) for the example to connect to. SSID (network name) for the example to connect to.
config ESP_WIFI_PASSWORD config ESP_WIFI_PASSWORD
string "WiFi Password" string "WiFi Password"
default "mypassword" default "mypassword"
help help
WiFi password (WPA or WPA2) for the example to use. WiFi password (WPA or WPA2) for the example to use.
config EXAMPLE_PORT config EXAMPLE_PORT
string "asio example port number" string "asio example port number"
default "80" default "80"
help help
Port number used by ASIO example Port number used by ASIO example
endmenu endmenu

94
examples/protocols/aws_iot/subscribe_publish/main/Kconfig.projbuild
View File

@ -1,60 +1,60 @@
menu "Example Configuration" menu "Example Configuration"
config WIFI_SSID config WIFI_SSID
string "WiFi SSID" string "WiFi SSID"
default "myssid" default "myssid"
help help
SSID (network name) for the example to connect to. SSID (network name) for the example to connect to.
config WIFI_PASSWORD config WIFI_PASSWORD
string "WiFi Password" string "WiFi Password"
default "mypassword" default "mypassword"
help help
WiFi password (WPA or WPA2) for the example to use. WiFi password (WPA or WPA2) for the example to use.
Can be left blank if the network has no security set. Can be left blank if the network has no security set.
config AWS_EXAMPLE_CLIENT_ID config AWS_EXAMPLE_CLIENT_ID
string "AWS IoT Client ID" string "AWS IoT Client ID"
default "myesp32" default "myesp32"
help help
AWS IoT Client ID for the example. Should be unique for every device. AWS IoT Client ID for the example. Should be unique for every device.
choice EXAMPLE_CERT_SOURCE choice EXAMPLE_CERT_SOURCE
prompt "AWS IoT Certificate Source" prompt "AWS IoT Certificate Source"
default EXAMPLE_EMBEDDED_CERTS default EXAMPLE_EMBEDDED_CERTS
help help
AWS IoT requires loading of a device-specific certificate and private key, AWS IoT requires loading of a device-specific certificate and private key,
and a common Root CA Certificate. These can be compiled into the example and a common Root CA Certificate. These can be compiled into the example
app, or they can be loaded via the filesystem from an SD card. app, or they can be loaded via the filesystem from an SD card.
config EXAMPLE_EMBEDDED_CERTS config EXAMPLE_EMBEDDED_CERTS
bool "Embed into app" bool "Embed into app"
config EXAMPLE_SDCARD_CERTS config EXAMPLE_SDCARD_CERTS
bool "Load from SD card" bool "Load from SD card"
select EXAMPLE_FILESYSTEM_CERTS select EXAMPLE_FILESYSTEM_CERTS
endchoice endchoice
# Currently this is equivalent to EXAMPLE_SDCARD_CERTS, # Currently this is equivalent to EXAMPLE_SDCARD_CERTS,
# however eventually we want to support more filesystem # however eventually we want to support more filesystem
# sources (SPIFFS, etc.) So this hidden config item # sources (SPIFFS, etc.) So this hidden config item
# is selected whenever the item should load from filesystem. # is selected whenever the item should load from filesystem.
config EXAMPLE_FILESYSTEM_CERTS config EXAMPLE_FILESYSTEM_CERTS
bool bool
config EXAMPLE_CERTIFICATE_PATH config EXAMPLE_CERTIFICATE_PATH
string "Device Certificate Path" string "Device Certificate Path"
depends on EXAMPLE_FILESYSTEM_CERTS depends on EXAMPLE_FILESYSTEM_CERTS
default "/sdcard/certificate.pem.crt" default "/sdcard/certificate.pem.crt"
config EXAMPLE_PRIVATE_KEY_PATH config EXAMPLE_PRIVATE_KEY_PATH
string "Device Private Key Path" string "Device Private Key Path"
depends on EXAMPLE_FILESYSTEM_CERTS depends on EXAMPLE_FILESYSTEM_CERTS
default "/sdcard/private.pem.key" default "/sdcard/private.pem.key"
config EXAMPLE_ROOT_CA_PATH config EXAMPLE_ROOT_CA_PATH
string "Root CA Certificate Path" string "Root CA Certificate Path"
depends on EXAMPLE_FILESYSTEM_CERTS depends on EXAMPLE_FILESYSTEM_CERTS
default "/sdcard/aws-root-ca.pem" default "/sdcard/aws-root-ca.pem"
endmenu endmenu

104
examples/protocols/aws_iot/thing_shadow/main/Kconfig.projbuild
View File

@ -1,66 +1,66 @@
menu "Example Configuration" menu "Example Configuration"
config WIFI_SSID config WIFI_SSID
string "WiFi SSID" string "WiFi SSID"
default "myssid" default "myssid"
help help
SSID (network name) for the example to connect to. SSID (network name) for the example to connect to.
config WIFI_PASSWORD config WIFI_PASSWORD
string "WiFi Password" string "WiFi Password"
default "mypassword" default "mypassword"
help help
WiFi password (WPA or WPA2) for the example to use. WiFi password (WPA or WPA2) for the example to use.
Can be left blank if the network has no security set. Can be left blank if the network has no security set.
config AWS_EXAMPLE_CLIENT_ID config AWS_EXAMPLE_CLIENT_ID
string "AWS IoT Client ID" string "AWS IoT Client ID"
default "myesp32" default "myesp32"
help help
AWS IoT Client ID for the example. Should be unique for every device. AWS IoT Client ID for the example. Should be unique for every device.
config AWS_EXAMPLE_THING_NAME config AWS_EXAMPLE_THING_NAME
string "AWS IoT Thing Name" string "AWS IoT Thing Name"
default "myesp32" default "myesp32"
help help
AWS IoT Thing Name for the example. Should be unique for every device. AWS IoT Thing Name for the example. Should be unique for every device.
choice EXAMPLE_CERT_SOURCE choice EXAMPLE_CERT_SOURCE
prompt "AWS IoT Certificate Source" prompt "AWS IoT Certificate Source"
default EXAMPLE_EMBEDDED_CERTS default EXAMPLE_EMBEDDED_CERTS
help help
AWS IoT requires loading of a device-specific certificate and private key, AWS IoT requires loading of a device-specific certificate and private key,
and a common Root CA Certificate. These can be compiled into the example and a common Root CA Certificate. These can be compiled into the example
app, or they can be loaded via the filesystem from an SD card. app, or they can be loaded via the filesystem from an SD card.
config EXAMPLE_EMBEDDED_CERTS config EXAMPLE_EMBEDDED_CERTS
bool "Embed into app" bool "Embed into app"
config EXAMPLE_SDCARD_CERTS config EXAMPLE_SDCARD_CERTS
bool "Load from SD card" bool "Load from SD card"
select EXAMPLE_FILESYSTEM_CERTS select EXAMPLE_FILESYSTEM_CERTS
endchoice endchoice
# Currently this is equivalent to EXAMPLE_SDCARD_CERTS, # Currently this is equivalent to EXAMPLE_SDCARD_CERTS,
# however eventually we want to support more filesystem # however eventually we want to support more filesystem
# sources (SPIFFS, etc.) So this hidden config item # sources (SPIFFS, etc.) So this hidden config item
# is selected whenever the item should load from filesystem. # is selected whenever the item should load from filesystem.
config EXAMPLE_FILESYSTEM_CERTS config EXAMPLE_FILESYSTEM_CERTS
bool bool
config EXAMPLE_CERTIFICATE_PATH config EXAMPLE_CERTIFICATE_PATH
string "Device Certificate Path" string "Device Certificate Path"
depends on EXAMPLE_FILESYSTEM_CERTS depends on EXAMPLE_FILESYSTEM_CERTS
default "/sdcard/certificate.pem.crt" default "/sdcard/certificate.pem.crt"
config EXAMPLE_PRIVATE_KEY_PATH config EXAMPLE_PRIVATE_KEY_PATH
string "Device Private Key Path" string "Device Private Key Path"
depends on EXAMPLE_FILESYSTEM_CERTS depends on EXAMPLE_FILESYSTEM_CERTS
default "/sdcard/private.pem.key" default "/sdcard/private.pem.key"
config EXAMPLE_ROOT_CA_PATH config EXAMPLE_ROOT_CA_PATH
string "Root CA Certificate Path" string "Root CA Certificate Path"
depends on EXAMPLE_FILESYSTEM_CERTS depends on EXAMPLE_FILESYSTEM_CERTS
default "/sdcard/aws-root-ca.pem" default "/sdcard/aws-root-ca.pem"
endmenu endmenu

30
examples/protocols/coap_client/main/Kconfig.projbuild
View File

@ -1,21 +1,21 @@
menu "Example Configuration" menu "Example Configuration"
config TARGET_DOMAIN_URI config TARGET_DOMAIN_URI
string "Target Uri" string "Target Uri"
default "coap://californium.eclipse.org" default "coap://californium.eclipse.org"
help help
Target uri for the example to use. Target uri for the example to use.
config WIFI_SSID config WIFI_SSID
string "WiFi SSID" string "WiFi SSID"
default "myssid" default "myssid"
help help
SSID (network name) for the example to connect to. SSID (network name) for the example to connect to.
config WIFI_PASSWORD config WIFI_PASSWORD
string "WiFi Password" string "WiFi Password"
default "mypassword" default "mypassword"
help help
WiFi password (WPA or WPA2) for the example to use. WiFi password (WPA or WPA2) for the example to use.
endmenu endmenu

20
examples/protocols/coap_server/main/Kconfig.projbuild
View File

@ -1,15 +1,15 @@
menu "Example Configuration" menu "Example Configuration"
config WIFI_SSID config WIFI_SSID
string "WiFi SSID" string "WiFi SSID"
default "myssid" default "myssid"
help help
SSID (network name) for the example to connect to. SSID (network name) for the example to connect to.
config WIFI_PASSWORD config WIFI_PASSWORD
string "WiFi Password" string "WiFi Password"
default "mypassword" default "mypassword"
help help
WiFi password (WPA or WPA2) for the example to use. WiFi password (WPA or WPA2) for the example to use.
endmenu endmenu

22
examples/protocols/esp_http_client/main/Kconfig.projbuild
View File

@ -1,17 +1,17 @@
menu "Example Configuration" menu "Example Configuration"
config WIFI_SSID config WIFI_SSID
string "WiFi SSID" string "WiFi SSID"
default "myssid" default "myssid"
help help
SSID (network name) for the example to connect to. SSID (network name) for the example to connect to.
config WIFI_PASSWORD config WIFI_PASSWORD
string "WiFi Password" string "WiFi Password"
default "mypassword" default "mypassword"
help help
WiFi password (WPA or WPA2) for the example to use. WiFi password (WPA or WPA2) for the example to use.
Can be left blank if the network has no security set. Can be left blank if the network has no security set.
endmenu endmenu

22
examples/protocols/http2_request/main/Kconfig.projbuild
View File

@ -1,17 +1,17 @@
menu "Example Configuration" menu "Example Configuration"
config WIFI_SSID config WIFI_SSID
string "WiFi SSID" string "WiFi SSID"
default "myssid" default "myssid"
help help
SSID (network name) for the example to connect to. SSID (network name) for the example to connect to.
config WIFI_PASSWORD config WIFI_PASSWORD
string "WiFi Password" string "WiFi Password"
default "mypassword" default "mypassword"
help help
WiFi password (WPA or WPA2) for the example to use. WiFi password (WPA or WPA2) for the example to use.
Can be left blank if the network has no security set. Can be left blank if the network has no security set.
endmenu endmenu

22
examples/protocols/http_request/main/Kconfig.projbuild
View File

@ -1,17 +1,17 @@
menu "Example Configuration" menu "Example Configuration"
config WIFI_SSID config WIFI_SSID
string "WiFi SSID" string "WiFi SSID"
default "myssid" default "myssid"
help help
SSID (network name) for the example to connect to. SSID (network name) for the example to connect to.
config WIFI_PASSWORD config WIFI_PASSWORD
string "WiFi Password" string "WiFi Password"
default "mypassword" default "mypassword"
help help
WiFi password (WPA or WPA2) for the example to use. WiFi password (WPA or WPA2) for the example to use.
Can be left blank if the network has no security set. Can be left blank if the network has no security set.
endmenu endmenu

22
examples/protocols/http_server/advanced_tests/main/Kconfig.projbuild
View File

@ -1,16 +1,16 @@
menu "Example Configuration" menu "Example Configuration"
config WIFI_SSID config WIFI_SSID
string "WiFi SSID" string "WiFi SSID"
default "myssid" default "myssid"
help help
SSID (network name) for the example to connect to. SSID (network name) for the example to connect to.
config WIFI_PASSWORD config WIFI_PASSWORD
string "WiFi Password" string "WiFi Password"
default "mypassword" default "mypassword"
help help
WiFi password (WPA or WPA2) for the example to use. WiFi password (WPA or WPA2) for the example to use.
Can be left blank if the network has no security set. Can be left blank if the network has no security set.
endmenu endmenu

22
examples/protocols/http_server/persistent_sockets/main/Kconfig.projbuild
View File

@ -1,16 +1,16 @@
menu "Example Configuration" menu "Example Configuration"
config WIFI_SSID config WIFI_SSID
string "WiFi SSID" string "WiFi SSID"
default "myssid" default "myssid"
help help
SSID (network name) for the example to connect to. SSID (network name) for the example to connect to.
config WIFI_PASSWORD config WIFI_PASSWORD
string "WiFi Password" string "WiFi Password"
default "mypassword" default "mypassword"
help help
WiFi password (WPA or WPA2) for the example to use. WiFi password (WPA or WPA2) for the example to use.
Can be left blank if the network has no security set. Can be left blank if the network has no security set.
endmenu endmenu

22
examples/protocols/http_server/simple/main/Kconfig.projbuild
View File

@ -1,16 +1,16 @@
menu "Example Configuration" menu "Example Configuration"
config WIFI_SSID config WIFI_SSID
string "WiFi SSID" string "WiFi SSID"
default "myssid" default "myssid"
help help
SSID (network name) for the example to connect to. SSID (network name) for the example to connect to.
config WIFI_PASSWORD config WIFI_PASSWORD
string "WiFi Password" string "WiFi Password"
default "mypassword" default "mypassword"
help help
WiFi password (WPA or WPA2) for the example to use. WiFi password (WPA or WPA2) for the example to use.
Can be left blank if the network has no security set. Can be left blank if the network has no security set.
endmenu endmenu

22
examples/protocols/https_mbedtls/main/Kconfig.projbuild
View File

@ -1,17 +1,17 @@
menu "Example Configuration" menu "Example Configuration"
config WIFI_SSID config WIFI_SSID
string "WiFi SSID" string "WiFi SSID"
default "myssid" default "myssid"
help help
SSID (network name) for the example to connect to. SSID (network name) for the example to connect to.
config WIFI_PASSWORD config WIFI_PASSWORD
string "WiFi Password" string "WiFi Password"
default "mypassword" default "mypassword"
help help
WiFi password (WPA or WPA2) for the example to use. WiFi password (WPA or WPA2) for the example to use.
Can be left blank if the network has no security set. Can be left blank if the network has no security set.
endmenu endmenu

22
examples/protocols/https_request/main/Kconfig.projbuild
View File

@ -1,17 +1,17 @@
menu "Example Configuration" menu "Example Configuration"
config WIFI_SSID config WIFI_SSID
string "WiFi SSID" string "WiFi SSID"
default "myssid" default "myssid"
help help
SSID (network name) for the example to connect to. SSID (network name) for the example to connect to.
config WIFI_PASSWORD config WIFI_PASSWORD
string "WiFi Password" string "WiFi Password"
default "mypassword" default "mypassword"
help help
WiFi password (WPA or WPA2) for the example to use. WiFi password (WPA or WPA2) for the example to use.
Can be left blank if the network has no security set. Can be left blank if the network has no security set.
endmenu endmenu

22
examples/protocols/https_server/main/Kconfig.projbuild
View File

@ -1,16 +1,16 @@
menu "Example Configuration" menu "Example Configuration"
config WIFI_SSID config WIFI_SSID
string "WiFi SSID" string "WiFi SSID"
default "myssid" default "myssid"
help help
SSID (network name) for the example to connect to. SSID (network name) for the example to connect to.
config WIFI_PASSWORD config WIFI_PASSWORD
string "WiFi Password" string "WiFi Password"
default "mypassword" default "mypassword"
help help
WiFi password (WPA or WPA2) for the example to use. WiFi password (WPA or WPA2) for the example to use.
Can be left blank if the network has no security set. Can be left blank if the network has no security set.
endmenu endmenu

58
examples/protocols/mdns/main/Kconfig.projbuild
View File

@ -1,38 +1,38 @@
menu "Example Configuration" menu "Example Configuration"
config WIFI_SSID config WIFI_SSID
string "WiFi SSID" string "WiFi SSID"
default "myssid" default "myssid"
help help
SSID (network name) for the example to connect to. SSID (network name) for the example to connect to.
config WIFI_PASSWORD config WIFI_PASSWORD
string "WiFi Password" string "WiFi Password"
default "mypassword" default "mypassword"
help help
WiFi password (WPA or WPA2) for the example to use. WiFi password (WPA or WPA2) for the example to use.
Can be left blank if the network has no security set. Can be left blank if the network has no security set.
config MDNS_HOSTNAME config MDNS_HOSTNAME
string "mDNS Hostname" string "mDNS Hostname"
default "esp32-mdns" default "esp32-mdns"
help help
mDNS Hostname for example to use mDNS Hostname for example to use
config MDNS_INSTANCE config MDNS_INSTANCE
string "mDNS Instance Name" string "mDNS Instance Name"
default "ESP32 with mDNS" default "ESP32 with mDNS"
help help
mDNS Instance Name for example to use mDNS Instance Name for example to use
config RESOLVE_TEST_SERVICES config RESOLVE_TEST_SERVICES
bool "Resolve test services" bool "Resolve test services"
default y default y
help help
Enable resolving test services on startup. Enable resolving test services on startup.
These services are advertized and evaluated in automated tests. These services are advertized and evaluated in automated tests.
When executed locally, these will not be resolved and warnings appear in the log. When executed locally, these will not be resolved and warnings appear in the log.
Please set to false to disable initial querying to avoid warnings. Please set to false to disable initial querying to avoid warnings.
endmenu endmenu

44
examples/protocols/modbus_slave/main/Kconfig.projbuild
View File

@ -1,27 +1,27 @@
menu "Modbus Slave Example Configuration" menu "Modbus Slave Example Configuration"
config MB_UART_RXD config MB_UART_RXD
int "UART RXD pin number" int "UART RXD pin number"
range 0 34 range 0 34
default 22 default 22
help help
GPIO number for UART RX pin. See UART documentation for more information GPIO number for UART RX pin. See UART documentation for more information
about available pin numbers for UART. about available pin numbers for UART.
config MB_UART_TXD
int "UART TXD pin number"
range 0 34
default 23
help
GPIO number for UART TX pin. See UART documentation for more information
about available pin numbers for UART.
config MB_UART_RTS config MB_UART_TXD
int "UART RTS pin number" int "UART TXD pin number"
range 0 34 range 0 34
default 18 default 23
help help
GPIO number for UART RTS pin. This pin is connected to GPIO number for UART TX pin. See UART documentation for more information
~RE/DE pin of RS485 transceiver to switch direction. about available pin numbers for UART.
config MB_UART_RTS
int "UART RTS pin number"
range 0 34
default 18
help
GPIO number for UART RTS pin. This pin is connected to
~RE/DE pin of RS485 transceiver to switch direction.
endmenu endmenu

47
examples/protocols/mqtt/ssl/main/Kconfig.projbuild
View File

@ -1,31 +1,32 @@
menu "Example Configuration" menu "Example Configuration"
config WIFI_SSID config WIFI_SSID
string "WiFi SSID" string "WiFi SSID"
default "myssid" default "myssid"
help help
SSID (network name) for the example to connect to. SSID (network name) for the example to connect to.
config WIFI_PASSWORD config WIFI_PASSWORD
string "WiFi Password" string "WiFi Password"
default "mypassword" default "mypassword"
help help
WiFi password (WPA or WPA2) for the example to use. WiFi password (WPA or WPA2) for the example to use.
config BROKER_URI config BROKER_URI
string "Broker URL" string "Broker URL"
default "mqtts://iot.eclipse.org:8883" default "mqtts://iot.eclipse.org:8883"
help help
URL of an mqtt broker which this example connects to. URL of an mqtt broker which this example connects to.
config BROKER_CERTIFICATE_OVERRIDE config BROKER_CERTIFICATE_OVERRIDE
string "Broker certificate override" string "Broker certificate override"
default "" default ""
help help
Please leave empty if broker certificate included from a textfile; otherwise fill in a base64 part of PEM format certificate Please leave empty if broker certificate included from a textfile; otherwise fill in a base64 part of PEM
format certificate
config BROKER_CERTIFICATE_OVERRIDDEN config BROKER_CERTIFICATE_OVERRIDDEN
bool bool
default y if BROKER_CERTIFICATE_OVERRIDE != "" default y if BROKER_CERTIFICATE_OVERRIDE != ""
endmenu endmenu

20
examples/protocols/mqtt/ssl_mutual_auth/main/Kconfig.projbuild
View File

@ -1,15 +1,15 @@
menu "Example Configuration" menu "Example Configuration"
config WIFI_SSID config WIFI_SSID
string "WiFi SSID" string "WiFi SSID"
default "myssid" default "myssid"
help help
SSID (network name) for the example to connect to. SSID (network name) for the example to connect to.
config WIFI_PASSWORD config WIFI_PASSWORD
string "WiFi Password" string "WiFi Password"
default "mypassword" default "mypassword"
help help
WiFi password (WPA or WPA2) for the example to use. WiFi password (WPA or WPA2) for the example to use.
endmenu endmenu

36
examples/protocols/mqtt/tcp/main/Kconfig.projbuild
View File

@ -1,25 +1,25 @@
menu "Example Configuration" menu "Example Configuration"
config WIFI_SSID config WIFI_SSID
string "WiFi SSID" string "WiFi SSID"
default "myssid" default "myssid"
help help
SSID (network name) for the example to connect to. SSID (network name) for the example to connect to.
config WIFI_PASSWORD config WIFI_PASSWORD
string "WiFi Password" string "WiFi Password"
default "mypassword" default "mypassword"
help help
WiFi password (WPA or WPA2) for the example to use. WiFi password (WPA or WPA2) for the example to use.
config BROKER_URL config BROKER_URL
string "Broker URL" string "Broker URL"
default "mqtt://iot.eclipse.org" default "mqtt://iot.eclipse.org"
help help
URL of the broker to connect to URL of the broker to connect to
config BROKER_URL_FROM_STDIN config BROKER_URL_FROM_STDIN
bool bool
default y if BROKER_URL = "FROM_STDIN" default y if BROKER_URL = "FROM_STDIN"
endmenu endmenu

30
examples/protocols/mqtt/ws/main/Kconfig.projbuild
View File

@ -1,21 +1,21 @@
menu "Example Configuration" menu "Example Configuration"
config WIFI_SSID config WIFI_SSID
string "WiFi SSID" string "WiFi SSID"
default "myssid" default "myssid"
help help
SSID (network name) for the example to connect to. SSID (network name) for the example to connect to.
config WIFI_PASSWORD config WIFI_PASSWORD
string "WiFi Password" string "WiFi Password"
default "mypassword" default "mypassword"
help help
WiFi password (WPA or WPA2) for the example to use. WiFi password (WPA or WPA2) for the example to use.
config BROKER_URI config BROKER_URI
string "Broker URL" string "Broker URL"
default "ws://iot.eclipse.org:80/ws" default "ws://iot.eclipse.org:80/ws"
help help
URL of an mqtt broker which this example connects to. URL of an mqtt broker which this example connects to.
endmenu endmenu

47
examples/protocols/mqtt/wss/main/Kconfig.projbuild
View File

@ -1,31 +1,32 @@
menu "Example Configuration" menu "Example Configuration"
config WIFI_SSID config WIFI_SSID
string "WiFi SSID" string "WiFi SSID"
default "myssid" default "myssid"
help help
SSID (network name) for the example to connect to. SSID (network name) for the example to connect to.
config WIFI_PASSWORD config WIFI_PASSWORD
string "WiFi Password" string "WiFi Password"
default "mypassword" default "mypassword"
help help
WiFi password (WPA or WPA2) for the example to use. WiFi password (WPA or WPA2) for the example to use.
config BROKER_URI config BROKER_URI
string "Broker URL" string "Broker URL"
default "wss://iot.eclipse.org:443/ws" default "wss://iot.eclipse.org:443/ws"
help help
URL of an mqtt broker which this example connects to. URL of an mqtt broker which this example connects to.
config BROKER_CERTIFICATE_OVERRIDE config BROKER_CERTIFICATE_OVERRIDE
string "Server certificate override" string "Server certificate override"
default "" default ""
help help
Please leave empty if server certificate included from a textfile; otherwise fill in a base64 part of PEM format certificate Please leave empty if server certificate included from a textfile; otherwise fill in a base64 part of PEM
format certificate
config BROKER_CERTIFICATE_OVERRIDDEN config BROKER_CERTIFICATE_OVERRIDDEN
bool bool
default y if BROKER_CERTIFICATE_OVERRIDE != "" default y if BROKER_CERTIFICATE_OVERRIDE != ""
endmenu endmenu

44
examples/protocols/openssl_client/main/Kconfig.projbuild
View File

@ -1,28 +1,28 @@
menu "Example Configuration" menu "Example Configuration"
config TARGET_DOMAIN config TARGET_DOMAIN
string "Target Domain" string "Target Domain"
default "www.baidu.com" default "www.baidu.com"
help help
Target domain for the example to connect to. Target domain for the example to connect to.
config TARGET_PORT_NUMBER
int "Target port number"
range 0 65535
default 443
help
Target port number for the example to connect to.
config WIFI_SSID config TARGET_PORT_NUMBER
string "WiFi SSID" int "Target port number"
default "myssid" range 0 65535
help default 443
SSID (network name) for the example to connect to. help
Target port number for the example to connect to.
config WIFI_PASSWORD config WIFI_SSID
string "WiFi Password" string "WiFi SSID"
default "mypassword" default "myssid"
help help
WiFi password (WPA or WPA2) for the example to use. SSID (network name) for the example to connect to.
config WIFI_PASSWORD
string "WiFi Password"
default "mypassword"
help
WiFi password (WPA or WPA2) for the example to use.
endmenu endmenu

20
examples/protocols/openssl_server/main/Kconfig.projbuild
View File

@ -1,15 +1,15 @@
menu "Example Configuration" menu "Example Configuration"
config WIFI_SSID config WIFI_SSID
string "WiFi SSID" string "WiFi SSID"
default "myssid" default "myssid"
help help
SSID (network name) for the example to connect to. SSID (network name) for the example to connect to.
config WIFI_PASSWORD config WIFI_PASSWORD
string "WiFi Password" string "WiFi Password"
default "mypassword" default "mypassword"
help help
WiFi password (WPA or WPA2) for the example to use. WiFi password (WPA or WPA2) for the example to use.
endmenu endmenu

10
examples/protocols/pppos_client/main/Kconfig.projbuild
View File

@ -41,11 +41,11 @@ menu "Example Configuration"
Select this, the modem will send a short message before power off. Select this, the modem will send a short message before power off.
if SEND_MSG if SEND_MSG
config SEND_MSG_PEER_PHONE_NUMBER config SEND_MSG_PEER_PHONE_NUMBER
string "Peer Phone Number (with area code)" string "Peer Phone Number (with area code)"
default "+8610086" default "+8610086"
help help
Enter the peer phone number that you want to send message to. Enter the peer phone number that you want to send message to.
endif endif
menu "UART Configuration" menu "UART Configuration"

22
examples/protocols/sntp/main/Kconfig.projbuild
View File

@ -1,17 +1,17 @@
menu "Example Configuration" menu "Example Configuration"
config WIFI_SSID config WIFI_SSID
string "WiFi SSID" string "WiFi SSID"
default "myssid" default "myssid"
help help
SSID (network name) for the example to connect to. SSID (network name) for the example to connect to.
config WIFI_PASSWORD config WIFI_PASSWORD
string "WiFi Password" string "WiFi Password"
default "mypassword" default "mypassword"
help help
WiFi password (WPA or WPA2) for the example to use. WiFi password (WPA or WPA2) for the example to use.
Can be left blank if the network has no security set. Can be left blank if the network has no security set.
endmenu endmenu

76
examples/protocols/sockets/tcp_client/main/Kconfig.projbuild
View File

@ -1,50 +1,50 @@
menu "Example Configuration" menu "Example Configuration"
config WIFI_SSID config WIFI_SSID
string "WiFi SSID" string "WiFi SSID"
default "myssid" default "myssid"
help help
SSID (network name) for the example to connect to. SSID (network name) for the example to connect to.
config WIFI_PASSWORD config WIFI_PASSWORD
string "WiFi Password" string "WiFi Password"
default "mypassword" default "mypassword"
help help
WiFi password (WPA or WPA2) for the example to use. WiFi password (WPA or WPA2) for the example to use.
Can be left blank if the network has no security set. Can be left blank if the network has no security set.
choice EXAMPLE_IP_MODE choice EXAMPLE_IP_MODE
prompt "IP Version" prompt "IP Version"
help help
Example can use either IPV4 or IPV6. Example can use either IPV4 or IPV6.
config EXAMPLE_IPV4 config EXAMPLE_IPV4
bool "IPV4" bool "IPV4"
config EXAMPLE_IPV6 config EXAMPLE_IPV6
bool "IPV6" bool "IPV6"
endchoice endchoice
config EXAMPLE_IPV4_ADDR config EXAMPLE_IPV4_ADDR
string "IPV4 Address" string "IPV4 Address"
default "192.168.0.165" default "192.168.0.165"
depends on EXAMPLE_IPV4 depends on EXAMPLE_IPV4
help help
The example will connect to this IPV4 address. The example will connect to this IPV4 address.
config EXAMPLE_IPV6_ADDR config EXAMPLE_IPV6_ADDR
string "IPV6 Address" string "IPV6 Address"
default "FE80::30AD:E57B:C212:68AD" default "FE80::30AD:E57B:C212:68AD"
depends on EXAMPLE_IPV6 depends on EXAMPLE_IPV6
help help
The example will connect to this IPV6 address. The example will connect to this IPV6 address.
config EXAMPLE_PORT config EXAMPLE_PORT
int "Port" int "Port"
range 0 65535 range 0 65535
default 3333 default 3333
help help
The remote port to which the client example will connect to. The remote port to which the client example will connect to.
endmenu endmenu

52
examples/protocols/sockets/tcp_server/main/Kconfig.projbuild
View File

@ -1,36 +1,36 @@
menu "Example Configuration" menu "Example Configuration"
config WIFI_SSID config WIFI_SSID
string "WiFi SSID" string "WiFi SSID"
default "myssid" default "myssid"
help help
SSID (network name) for the example to connect to. SSID (network name) for the example to connect to.
config WIFI_PASSWORD config WIFI_PASSWORD
string "WiFi Password" string "WiFi Password"
default "mypassword" default "mypassword"
help help
WiFi password (WPA or WPA2) for the example to use. WiFi password (WPA or WPA2) for the example to use.
Can be left blank if the network has no security set. Can be left blank if the network has no security set.
choice EXAMPLE_IP_MODE choice EXAMPLE_IP_MODE
prompt "IP Version" prompt "IP Version"
help help
Example can use either IPV4 or IPV6. Example can use either IPV4 or IPV6.
config EXAMPLE_IPV4 config EXAMPLE_IPV4
bool "IPV4" bool "IPV4"
config EXAMPLE_IPV6 config EXAMPLE_IPV6
bool "IPV6" bool "IPV6"
endchoice endchoice
config EXAMPLE_PORT config EXAMPLE_PORT
int "Port" int "Port"
range 0 65535 range 0 65535
default 3333 default 3333
help help
Local port the example server will listen on. Local port the example server will listen on.
endmenu endmenu

76
examples/protocols/sockets/udp_client/main/Kconfig.projbuild
View File

@ -1,50 +1,50 @@
menu "Example Configuration" menu "Example Configuration"
config WIFI_SSID config WIFI_SSID
string "WiFi SSID" string "WiFi SSID"
default "myssid" default "myssid"
help help
SSID (network name) for the example to connect to. SSID (network name) for the example to connect to.
config WIFI_PASSWORD config WIFI_PASSWORD
string "WiFi Password" string "WiFi Password"
default "mypassword" default "mypassword"
help help
WiFi password (WPA or WPA2) for the example to use. WiFi password (WPA or WPA2) for the example to use.
Can be left blank if the network has no security set. Can be left blank if the network has no security set.
choice EXAMPLE_IP_MODE choice EXAMPLE_IP_MODE
prompt "IP Version" prompt "IP Version"
help help
Example can use either IPV4 or IPV6. Example can use either IPV4 or IPV6.
config EXAMPLE_IPV4 config EXAMPLE_IPV4
bool "IPV4" bool "IPV4"
config EXAMPLE_IPV6 config EXAMPLE_IPV6
bool "IPV6" bool "IPV6"
endchoice endchoice
config EXAMPLE_IPV4_ADDR config EXAMPLE_IPV4_ADDR
string "IPV4 Address" string "IPV4 Address"
default "192.168.0.165" default "192.168.0.165"
depends on EXAMPLE_IPV4 depends on EXAMPLE_IPV4
help help
IPV4 address to which the client example will send data. IPV4 address to which the client example will send data.
config EXAMPLE_IPV6_ADDR config EXAMPLE_IPV6_ADDR
string "IPV6 Address" string "IPV6 Address"
default "FE80::30AD:E57B:C212:68AD" default "FE80::30AD:E57B:C212:68AD"
depends on EXAMPLE_IPV6 depends on EXAMPLE_IPV6
help help
IPV6 address to which the client example will send data. IPV6 address to which the client example will send data.
config EXAMPLE_PORT config EXAMPLE_PORT
int "Port" int "Port"
range 0 65535 range 0 65535
default 3333 default 3333
help help
The remote port to which the client example will send data. The remote port to which the client example will send data.
endmenu endmenu

139
examples/protocols/sockets/udp_multicast/main/Kconfig.projbuild
View File

@ -1,91 +1,92 @@
menu "Example Configuration" menu "Example Configuration"
config WIFI_SSID config WIFI_SSID
string "WiFi SSID" string "WiFi SSID"
default "myssid" default "myssid"
help help
SSID (network name) for the example to connect to. SSID (network name) for the example to connect to.
config WIFI_PASSWORD config WIFI_PASSWORD
string "WiFi Password" string "WiFi Password"
default "mypassword" default "mypassword"
help help
WiFi password (WPA or WPA2) for the example to use. WiFi password (WPA or WPA2) for the example to use.
Can be left blank if the network has no security set. Can be left blank if the network has no security set.
choice EXAMPLE_IP_MODE choice EXAMPLE_IP_MODE
prompt "Multicast IP type" prompt "Multicast IP type"
help help
Example can multicast IPV4, IPV6, or both. Example can multicast IPV4, IPV6, or both.
config EXAMPLE_IPV4_V6 config EXAMPLE_IPV4_V6
bool "IPV4 & IPV6" bool "IPV4 & IPV6"
select EXAMPLE_IPV4 select EXAMPLE_IPV4
select EXAMPLE_IPV6 select EXAMPLE_IPV6
config EXAMPLE_IPV4_ONLY config EXAMPLE_IPV4_ONLY
bool "IPV4" bool "IPV4"
select EXAMPLE_IPV4 select EXAMPLE_IPV4
config EXAMPLE_IPV6_ONLY config EXAMPLE_IPV6_ONLY
bool "IPV6" bool "IPV6"
select EXAMPLE_IPV6 select EXAMPLE_IPV6
endchoice endchoice
config EXAMPLE_IPV4 config EXAMPLE_IPV4
bool bool
config EXAMPLE_IPV6 config EXAMPLE_IPV6
bool bool
config EXAMPLE_MULTICAST_IPV4_ADDR config EXAMPLE_MULTICAST_IPV4_ADDR
string "Multicast IPV4 Address (send & receive)" string "Multicast IPV4 Address (send & receive)"
default "232.10.11.12" default "232.10.11.12"
depends on EXAMPLE_IPV4 depends on EXAMPLE_IPV4
help help
IPV4 multicast address. Example will both send to and listen to this address. IPV4 multicast address. Example will both send to and listen to this address.
config EXAMPLE_MULTICAST_IPV6_ADDR config EXAMPLE_MULTICAST_IPV6_ADDR
string "Multicast IPV6 Address (send & receive)" string "Multicast IPV6 Address (send & receive)"
default "FF02::FC" default "FF02::FC"
depends on EXAMPLE_IPV6 depends on EXAMPLE_IPV6
help help
IPV6 multicast address. Example will both send to and listen to this address. IPV6 multicast address. Example will both send to and listen to this address.
The default FF02::FC address is a link-local multicast address. Consult IPV6 specifications or documentation for information about meaning of different IPV6 multicast ranges. The default FF02::FC address is a link-local multicast address. Consult IPV6 specifications or
documentation for information about meaning of different IPV6 multicast ranges.
config EXAMPLE_PORT config EXAMPLE_PORT
int "Multicast port (send & receive)" int "Multicast port (send & receive)"
range 0 65535 range 0 65535
default 3333 default 3333
help help
Multicast port the example will both send & receive UDP packets on. Multicast port the example will both send & receive UDP packets on.
config EXAMPLE_LOOPBACK config EXAMPLE_LOOPBACK
bool "Multicast loopback" bool "Multicast loopback"
help help
Enables IP_MULTICAST_LOOP/IPV6_MULTICAST_LOOP options, meaning Enables IP_MULTICAST_LOOP/IPV6_MULTICAST_LOOP options, meaning
that packets transmitted from the device are also received by the that packets transmitted from the device are also received by the
device itself. device itself.
config EXAMPLE_MULTICAST_TTL config EXAMPLE_MULTICAST_TTL
int "Multicast packet TTL" int "Multicast packet TTL"
range 1 255 range 1 255
help help
Sets TTL field of multicast packets. Separate from uni- & broadcast TTL. Sets TTL field of multicast packets. Separate from uni- & broadcast TTL.
choice EXAMPLE_MULTICAST_IF choice EXAMPLE_MULTICAST_IF
prompt "Multicast Interface" prompt "Multicast Interface"
help help
Multicast socket can bind to default interface, or all interfaces. Multicast socket can bind to default interface, or all interfaces.
config EXAMPLE_MULTICAST_LISTEN_DEFAULT_IF config EXAMPLE_MULTICAST_LISTEN_DEFAULT_IF
bool "Default interface" bool "Default interface"
config EXAMPLE_MULTICAST_LISTEN_STA_IF config EXAMPLE_MULTICAST_LISTEN_STA_IF
bool "WiFi STA interface" bool "WiFi STA interface"
endchoice endchoice
endmenu endmenu

52
examples/protocols/sockets/udp_server/main/Kconfig.projbuild
View File

@ -1,36 +1,36 @@
menu "Example Configuration" menu "Example Configuration"
config WIFI_SSID config WIFI_SSID
string "WiFi SSID" string "WiFi SSID"
default "myssid" default "myssid"
help help
SSID (network name) for the example to connect to. SSID (network name) for the example to connect to.
config WIFI_PASSWORD config WIFI_PASSWORD
string "WiFi Password" string "WiFi Password"
default "mypassword" default "mypassword"
help help
WiFi password (WPA or WPA2) for the example to use. WiFi password (WPA or WPA2) for the example to use.
Can be left blank if the network has no security set. Can be left blank if the network has no security set.
choice EXAMPLE_IP_MODE choice EXAMPLE_IP_MODE
prompt "IP Version" prompt "IP Version"
help help
Example can use either IPV4 or IPV6. Example can use either IPV4 or IPV6.
config EXAMPLE_IPV4 config EXAMPLE_IPV4
bool "IPV4" bool "IPV4"
config EXAMPLE_IPV6 config EXAMPLE_IPV6
bool "IPV6" bool "IPV6"
endchoice endchoice
config EXAMPLE_PORT config EXAMPLE_PORT
int "Port" int "Port"
range 0 65535 range 0 65535
default 3333 default 3333
help help
Local port the example server will listen on. Local port the example server will listen on.
endmenu endmenu

54
examples/provisioning/ble_prov/main/Kconfig.projbuild
View File

@ -1,34 +1,34 @@
menu "Example Configuration" menu "Example Configuration"
config USE_SEC_1 config USE_SEC_1
bool bool
default y default y
prompt "Use Security Version 1" prompt "Use Security Version 1"
help help
Security version 1 used Curve25519 key exchange for establishing Security version 1 used Curve25519 key exchange for establishing
secure session between device and client during provisioning secure session between device and client during provisioning
config USE_POP config USE_POP
bool bool
depends on USE_SEC_1 depends on USE_SEC_1
default y default y
prompt "Use proof-of-possession" prompt "Use proof-of-possession"
help help
Proof-of-possession can be optionally used to prove that the device is indeed Proof-of-possession can be optionally used to prove that the device is indeed
in possession of the user who is provisioning the device. This proof-of-possession in possession of the user who is provisioning the device. This proof-of-possession
is internally used to generate the shared secret through key exchange. is internally used to generate the shared secret through key exchange.
config POP config POP
string "Proof-of-possession" string "Proof-of-possession"
default "abcd1234" default "abcd1234"
depends on USE_POP depends on USE_POP
config RESET_PROVISIONED config RESET_PROVISIONED
bool bool
default n default n
prompt "Reset provisioned status of the device" prompt "Reset provisioned status of the device"
help help
This erases the NVS to reset provisioned status of the device on every reboot. This erases the NVS to reset provisioned status of the device on every reboot.
Provisioned status is determined by the WiFi STA configuration, saved on the NVS. Provisioned status is determined by the WiFi STA configuration, saved on the NVS.
endmenu endmenu

54
examples/provisioning/console_prov/main/Kconfig.projbuild
View File

@ -1,34 +1,34 @@
menu "Example Configuration" menu "Example Configuration"
config USE_SEC_1 config USE_SEC_1
bool bool
default y default y
prompt "Use Security Version 1" prompt "Use Security Version 1"
help help
Security version 1 used Curve25519 key exchange for establishing Security version 1 used Curve25519 key exchange for establishing
secure session between device and client during provisioning secure session between device and client during provisioning
config USE_POP config USE_POP
bool bool
depends on USE_SEC_1 depends on USE_SEC_1
default y default y
prompt "Use proof-of-possession" prompt "Use proof-of-possession"
help help
Proof-of-possession can be optionally used to prove that the device is indeed Proof-of-possession can be optionally used to prove that the device is indeed
in possession of the user who is provisioning the device. This proof-of-possession in possession of the user who is provisioning the device. This proof-of-possession
is internally used to generate the shared secret through key exchange. is internally used to generate the shared secret through key exchange.
config POP config POP
string "Proof-of-possession" string "Proof-of-possession"
default "abcd1234" default "abcd1234"
depends on USE_POP depends on USE_POP
config RESET_PROVISIONED config RESET_PROVISIONED
bool bool
default n default n
prompt "Reset provisioned status of the device" prompt "Reset provisioned status of the device"
help help
This erases the NVS to reset provisioned status of the device on every reboot. This erases the NVS to reset provisioned status of the device on every reboot.
Provisioned status is determined by the WiFi STA configuration, saved on the NVS. Provisioned status is determined by the WiFi STA configuration, saved on the NVS.
endmenu endmenu

84
examples/provisioning/custom_config/main/Kconfig.projbuild
View File

@ -1,52 +1,52 @@
menu "Example Configuration" menu "Example Configuration"
config SOFTAP_SSID config SOFTAP_SSID
string "WiFi SSID" string "WiFi SSID"
default "myssid" default "myssid"
help help
SSID (network name) for the example to connect to. SSID (network name) for the example to connect to.
config SOFTAP_PASS config SOFTAP_PASS
string "WiFi Password" string "WiFi Password"
default "mypassword" default "mypassword"
help help
WiFi password (WPA or WPA2) for the example to use. WiFi password (WPA or WPA2) for the example to use.
config USE_SEC_1 config USE_SEC_1
bool bool
default n default n
prompt "Use Security Version 1" prompt "Use Security Version 1"
help help
Security version 1 used Curve25519 key exchange for establishing Security version 1 used Curve25519 key exchange for establishing
secure session between device and client during provisioning secure session between device and client during provisioning
config USE_POP config USE_POP
bool bool
depends on USE_SEC_1 depends on USE_SEC_1
default n default n
prompt "Use proof-of-possession" prompt "Use proof-of-possession"
help help
Proof-of-possession can be optionally used to prove that the device is indeed Proof-of-possession can be optionally used to prove that the device is indeed
in possession of the user who is provisioning the device. This proof-of-possession in possession of the user who is provisioning the device. This proof-of-possession
is internally used to generate the shared secret through key exchange. is internally used to generate the shared secret through key exchange.
config POP config POP
string "Proof-of-possession" string "Proof-of-possession"
default "abcd1234" default "abcd1234"
depends on USE_POP depends on USE_POP
config PROTOCOMM_HTTPD_PORT config PROTOCOMM_HTTPD_PORT
int "Protocomm HTTP Port" int "Protocomm HTTP Port"
default 80 default 80
help help
Port on which to run Protocomm HTTP based provisioning service Port on which to run Protocomm HTTP based provisioning service
config RESET_PROVISIONED config RESET_PROVISIONED
bool bool
default n default n
prompt "Reset provisioned status of the device" prompt "Reset provisioned status of the device"
help help
This erases the NVS to reset provisioned status of the device on every reboot. This erases the NVS to reset provisioned status of the device on every reboot.
Provisioned status is determined by the WiFi STA configuration, saved on the NVS. Provisioned status is determined by the WiFi STA configuration, saved on the NVS.
endmenu endmenu

86
examples/provisioning/softap_prov/main/Kconfig.projbuild
View File

@ -1,53 +1,53 @@
menu "Example Configuration" menu "Example Configuration"
config SOFTAP_SSID_SET_MAC config SOFTAP_SSID_SET_MAC
bool "Use MAC as SSID" bool "Use MAC as SSID"
default y default y
help help
Set SoftAP SSID as PROV_<MAC>. Set SoftAP SSID as PROV_<MAC>.
config SOFTAP_SSID config SOFTAP_SSID
string "WiFi SSID" string "WiFi SSID"
default "PROV_SSID" default "PROV_SSID"
depends on !SOFTAP_SSID_SET_MAC depends on !SOFTAP_SSID_SET_MAC
help help
SSID (network name) for the example to connect to. SSID (network name) for the example to connect to.
config SOFTAP_PASS config SOFTAP_PASS
string "WiFi Password" string "WiFi Password"
default "PROV_PASS" default "PROV_PASS"
help help
WiFi password (WPA or WPA2) for the example to use. WiFi password (WPA or WPA2) for the example to use.
config USE_SEC_1 config USE_SEC_1
bool bool
default y default y
prompt "Use Security Version 1" prompt "Use Security Version 1"
help help
Security version 1 used Curve25519 key exchange for establishing Security version 1 used Curve25519 key exchange for establishing
secure session between device and client during provisioning secure session between device and client during provisioning
config USE_POP config USE_POP
bool bool
depends on USE_SEC_1 depends on USE_SEC_1
default y default y
prompt "Use proof-of-possession" prompt "Use proof-of-possession"
help help
Proof-of-possession can be optionally used to prove that the device is indeed Proof-of-possession can be optionally used to prove that the device is indeed
in possession of the user who is provisioning the device. This proof-of-possession in possession of the user who is provisioning the device. This proof-of-possession
is internally used to generate the shared secret through key exchange. is internally used to generate the shared secret through key exchange.
config POP config POP
string "Proof-of-possession" string "Proof-of-possession"
default "abcd1234" default "abcd1234"
depends on USE_POP depends on USE_POP
config RESET_PROVISIONED config RESET_PROVISIONED
bool bool
default n default n
prompt "Reset provisioned status of the device" prompt "Reset provisioned status of the device"
help help
This erases the NVS to reset provisioned status of the device on every reboot. This erases the NVS to reset provisioned status of the device on every reboot.
Provisioned status is determined by the WiFi STA configuration, saved on the NVS. Provisioned status is determined by the WiFi STA configuration, saved on the NVS.
endmenu endmenu

28
examples/system/app_trace_to_host/main/Kconfig.projbuild
View File

@ -1,20 +1,20 @@
menu "Example Configuration" menu "Example Configuration"
config CUSTOM_RTC_CLK_8M_DIV config CUSTOM_RTC_CLK_8M_DIV
bool "Set custom RTC 8 MHz clock divider to lower CW frequency (CHECK HELP FIRST)" bool "Set custom RTC 8 MHz clock divider to lower CW frequency (CHECK HELP FIRST)"
default "n" default "n"
help help
Set custom / non standard divider for RTC 8 MHz clock. Set custom / non standard divider for RTC 8 MHz clock.
This is to lower minimum frequency of cosine waveform generator (CW) This is to lower minimum frequency of cosine waveform generator (CW)
in order to provide sinusoidal signal at about 50 or 60 Hz. in order to provide sinusoidal signal at about 50 or 60 Hz.
WARNINIG: setting non standard divider for the RTC 8 MHz clock
will affect functionality of RTC peripherals other than CW.
This includes ADC sampling, and will in general make WARNINIG: setting non standard divider for the RTC 8 MHz clock
all RTC register access slower. will affect functionality of RTC peripherals other than CW.
DO NOT use this option / change default RTC 8 MHz clock divider This includes ADC sampling, and will in general make
in your applications, if you are not sure what you are doing. all RTC register access slower.
DO NOT use this option / change default RTC 8 MHz clock divider
in your applications, if you are not sure what you are doing.
endmenu endmenu

72
examples/system/base_mac_address/main/Kconfig.projbuild
View File

@ -1,42 +1,42 @@
menu "Example Configuration" menu "Example Configuration"
choice BASE_MAC_ADDRESS_STORAGE choice BASE_MAC_ADDRESS_STORAGE
prompt "Storage of the base MAC address" prompt "Storage of the base MAC address"
default BASE_MAC_STORED_EFUSE_BLK0 default BASE_MAC_STORED_EFUSE_BLK0
help help
Select storage of the base MAC address which is used to generate MAC addresses of all network interfaces Select storage of the base MAC address which is used to generate MAC addresses of all network interfaces
when networking is initialized. when networking is initialized.
If "Default (Espressif factory) EFUSE BLK0" is selected, esp32 will use default base MAC address which is If "Default (Espressif factory) eFuse BLK0" is selected, esp32 will use default base MAC address which is
written into EFUSE block 0 words 1, 2 when the chip is manufactured. written into eFuse block 0 words 1, 2 when the chip is manufactured.
If "Custom EFUSE BLK3" is selected, ESP32 will use customer-defined base MAC address which is written into If "Custom eFuse BLK3" is selected, ESP32 will use customer-defined base MAC address which is written into
EFUSE Block 3 words 0, 1. Users must call esp_efuse_mac_get_custom to get base MAC address and eFuse Block 3 words 0, 1. Users must call esp_efuse_mac_get_custom to get base MAC address and
esp_base_mac_addr_set to set the base MAC address before network interfaces are initialised. esp_base_mac_addr_set to set the base MAC address before network interfaces are initialised.
If "Other external storage" is selected, esp32 will use customer-defined base MAC address from external If "Other external storage" is selected, esp32 will use customer-defined base MAC address from external
storage(flash, EEPROM, etc). Users must get the base MAC address first and call esp_base_mac_addr_set to storage(flash, EEPROM, etc). Users must get the base MAC address first and call esp_base_mac_addr_set to
set the base MAC address before network interfaces are initialised. set the base MAC address before network interfaces are initialised.
config BASE_MAC_STORED_EFUSE_BLK0 config BASE_MAC_STORED_EFUSE_BLK0
bool "Default (Espressif factory) EFUSE BLK0" bool "Default (Espressif factory) eFuse BLK0"
config BASE_MAC_STORED_EFUSE_BLK3 config BASE_MAC_STORED_EFUSE_BLK3
bool "Custom EFUSE BLK3" bool "Custom eFuse BLK3"
config BASE_MAC_STORED_OTHER_EXTERNAL_STORAGE config BASE_MAC_STORED_OTHER_EXTERNAL_STORAGE
bool "Other external storage" bool "Other external storage"
endchoice endchoice
choice BASE_MAC_STORED_EFUSE_BLK3_ERROR_BEHAVIOR choice BASE_MAC_STORED_EFUSE_BLK3_ERROR_BEHAVIOR
prompt "Read base MAC address from BLK3 of EFUSE error behavior" prompt "Read base MAC address from BLK3 of eFuse error behavior"
depends on BASE_MAC_STORED_EFUSE_BLK3 depends on BASE_MAC_STORED_EFUSE_BLK3
default BASE_MAC_STORED_EFUSE_BLK3_ERROR_USE_DEFAULT default BASE_MAC_STORED_EFUSE_BLK3_ERROR_USE_DEFAULT
help help
Select behavior when reading base MAC address from BLK3 of EFUSE error. Select behavior when reading base MAC address from BLK3 of eFuse error.
If "Abort" is selected, esp32 will abort. If "Abort" is selected, esp32 will abort.
If "Use base MAC address from BLK3 of EFUSE" is selected, esp32 will use the base MAC address which is If "Use base MAC address from BLK3 of eFuse" is selected, esp32 will use the base MAC address which is
written into EFUSE block 0 words 1, 2 when the chip is manufactured. written into eFuse block 0 words 1, 2 when the chip is manufactured.
config BASE_MAC_STORED_EFUSE_BLK3_ERROR_ABORT config BASE_MAC_STORED_EFUSE_BLK3_ERROR_ABORT
bool "Abort" bool "Abort"
config BASE_MAC_STORED_EFUSE_BLK3_ERROR_USE_DEFAULT config BASE_MAC_STORED_EFUSE_BLK3_ERROR_USE_DEFAULT
bool "Use base MAC address from BLK3 of EFUSE" bool "Use base MAC address from BLK3 of eFuse"
endchoice endchoice
endmenu endmenu

14
examples/system/console/main/Kconfig.projbuild
View File

@ -1,11 +1,11 @@
menu "Example Configuration" menu "Example Configuration"
config STORE_HISTORY config STORE_HISTORY
bool "Store command history in flash" bool "Store command history in flash"
default y default y
help help
Linenoise line editing library provides functions to save and load Linenoise line editing library provides functions to save and load
command history. If this option is enabled, initalizes a FAT filesystem command history. If this option is enabled, initalizes a FAT filesystem
and uses it to store command history. and uses it to store command history.
endmenu endmenu

30
examples/system/deep_sleep/main/Kconfig.projbuild
View File

@ -1,20 +1,20 @@
menu "Example Configuration" menu "Example Configuration"
config ENABLE_TOUCH_WAKEUP config ENABLE_TOUCH_WAKEUP
bool "Enable touch wake up" bool "Enable touch wake up"
default y default y
help help
This option enables wake up from deep sleep using touch pads This option enables wake up from deep sleep using touch pads
TOUCH8 and TOUCH9, which correspond to GPIO33 and GPIO32. TOUCH8 and TOUCH9, which correspond to GPIO33 and GPIO32.
config ENABLE_ULP_TEMPERATURE_WAKEUP config ENABLE_ULP_TEMPERATURE_WAKEUP
bool "Enable temperature monitoring by ULP" bool "Enable temperature monitoring by ULP"
default y default y
help help
This option enables wake up from deep sleep using ULP. This option enables wake up from deep sleep using ULP.
ULP program monitors the on-chip temperature sensor and ULP program monitors the on-chip temperature sensor and
wakes up the chip when the temperature goes outside of wakes up the chip when the temperature goes outside of
the window defined by the initial temperature and a threshold the window defined by the initial temperature and a threshold
around it. around it.
endmenu endmenu

16
examples/system/gcov/main/Kconfig.projbuild
View File

@ -1,14 +1,14 @@
menu "Example Configuration" menu "Example Configuration"
config BLINK_GPIO config BLINK_GPIO
int "Blink GPIO number" int "Blink GPIO number"
range 0 34 range 0 34
default 5 default 5
help help
GPIO number (IOxx) to blink on and off. GPIO number (IOxx) to blink on and off.
Some GPIOs are used for other purposes (flash connections, etc.) and cannot be used to blink. Some GPIOs are used for other purposes (flash connections, etc.) and cannot be used to blink.
GPIOs 35-39 are input-only so cannot be used as outputs. GPIOs 35-39 are input-only so cannot be used as outputs.
endmenu endmenu

34
examples/system/ota/native_ota_example/main/Kconfig.projbuild
View File

@ -1,25 +1,25 @@
menu "Example Configuration" menu "Example Configuration"
config WIFI_SSID config WIFI_SSID
string "WiFi SSID" string "WiFi SSID"
default "myssid" default "myssid"
help help
SSID (network name) for the example to connect to. SSID (network name) for the example to connect to.
config WIFI_PASSWORD config WIFI_PASSWORD
string "WiFi Password" string "WiFi Password"
default "mypassword" default "mypassword"
help help
WiFi password (WPA or WPA2) for the example to use. WiFi password (WPA or WPA2) for the example to use.
Can be left blank if the network has no security set. Can be left blank if the network has no security set.
config FIRMWARE_UPG_URL config FIRMWARE_UPG_URL
string "HTTP Server URL" string "HTTP Server URL"
default "https://192.168.0.3:8070/hello-world.bin" default "https://192.168.0.3:8070/hello-world.bin"
help help
HTTP Server IP to download the image file from. HTTP Server IP to download the image file from.
See example README.md for details. See example README.md for details.
endmenu endmenu

32
examples/system/ota/simple_ota_example/main/Kconfig.projbuild
View File

@ -1,21 +1,21 @@
menu "Example Configuration" menu "Example Configuration"
config WIFI_SSID config WIFI_SSID
string "WiFi SSID" string "WiFi SSID"
default "myssid" default "myssid"
help help
SSID (network name) for the example to connect to. SSID (network name) for the example to connect to.
config WIFI_PASSWORD config WIFI_PASSWORD
string "WiFi Password" string "WiFi Password"
default "mypassword" default "mypassword"
help help
WiFi password (WPA or WPA2) for the example to use. WiFi password (WPA or WPA2) for the example to use.
config FIRMWARE_UPGRADE_URL config FIRMWARE_UPGRADE_URL
string "firmware upgrade url endpoint" string "firmware upgrade url endpoint"
default "https://192.168.0.3:8070/hello-world.bin" default "https://192.168.0.3:8070/hello-world.bin"
help help
URL of server which hosts the firmware URL of server which hosts the firmware
image. image.
endmenu endmenu

16
examples/system/sysview_tracing/main/Kconfig.projbuild
View File

@ -1,12 +1,12 @@
menu "Example Configuration" menu "Example Configuration"
config USE_CUSTOM_EVENT_ID config USE_CUSTOM_EVENT_ID
bool "Use custom SystemView event IDs" bool "Use custom SystemView event IDs"
default "n" default "n"
help help
Use custom IDs for user events. If it is enabled, replace `SYSVIEW_FreeRTOS.txt` in SystemView Use custom IDs for user events. If it is enabled, replace `SYSVIEW_FreeRTOS.txt` in SystemView
installation directory with the version from example's root directory. installation directory with the version from example's root directory.
By default SYSVIEW_EVTID_USER_START/STOP are used for tracing purposes of the example. By default SYSVIEW_EVTID_USER_START/STOP are used for tracing purposes of the example.
endmenu endmenu

108
examples/wifi/espnow/main/Kconfig.projbuild
View File

@ -1,61 +1,61 @@
menu "Example Configuration" menu "Example Configuration"
choice WIFI_MODE choice WIFI_MODE
prompt "WiFi mode" prompt "WiFi mode"
default STATION_MODE default STATION_MODE
help help
WiFi mode(station or softap). WiFi mode(station or softap).
config STATION_MODE
bool "Station"
config SOFTAP_MODE
bool "Softap"
endchoice
config ESPNOW_PMK
string "ESPNOW primary master key"
default "pmk1234567890123"
help
ESPNOW primary master for the example to use. The length of ESPNOW primary master must be 16 bytes.
config ESPNOW_LMK config STATION_MODE
string "ESPNOW local master key" bool "Station"
default "lmk1234567890123" config SOFTAP_MODE
help bool "Softap"
ESPNOW local master for the example to use. The length of ESPNOW local master must be 16 bytes. endchoice
config ESPNOW_CHANNEL
int "Channel"
default 1
range 1 13
help
The channel on which sending and receiving ESPNOW data.
config ESPNOW_SEND_COUNT config ESPNOW_PMK
int "Send count" string "ESPNOW primary master key"
default 100 default "pmk1234567890123"
range 1 65535 help
help ESPNOW primary master for the example to use. The length of ESPNOW primary master must be 16 bytes.
Total count of unicast ESPNOW data to be sent.
config ESPNOW_SEND_DELAY
int "Send delay"
default 1000
range 0 65535
help
Delay between sending two ESPNOW data, unit: ms.
config ESPNOW_SEND_LEN
int "Send len"
range 10 250
default 10
help
Length of ESPNOW data to be sent, unit: byte.
config ENABLE_LONG_RANGE config ESPNOW_LMK
bool "Enable Long Range" string "ESPNOW local master key"
default "n" default "lmk1234567890123"
help help
When enable long range, the PHY rate of ESP32 will be 512Kbps or 256Kbps ESPNOW local master for the example to use. The length of ESPNOW local master must be 16 bytes.
config ESPNOW_CHANNEL
int "Channel"
default 1
range 1 13
help
The channel on which sending and receiving ESPNOW data.
config ESPNOW_SEND_COUNT
int "Send count"
default 100
range 1 65535
help
Total count of unicast ESPNOW data to be sent.
config ESPNOW_SEND_DELAY
int "Send delay"
default 1000
range 0 65535
help
Delay between sending two ESPNOW data, unit: ms.
config ESPNOW_SEND_LEN
int "Send len"
range 10 250
default 10
help
Length of ESPNOW data to be sent, unit: byte.
config ENABLE_LONG_RANGE
bool "Enable Long Range"
default "n"
help
When enable long range, the PHY rate of ESP32 will be 512Kbps or 256Kbps
endmenu endmenu

32
examples/wifi/getting_started/softAP/main/Kconfig.projbuild
View File

@ -1,20 +1,20 @@
menu "Example Configuration" menu "Example Configuration"
config ESP_WIFI_SSID config ESP_WIFI_SSID
string "WiFi SSID" string "WiFi SSID"
default "myssid" default "myssid"
help help
SSID (network name) for the example to connect to. SSID (network name) for the example to connect to.
config ESP_WIFI_PASSWORD config ESP_WIFI_PASSWORD
string "WiFi Password" string "WiFi Password"
default "mypassword" default "mypassword"
help help
WiFi password (WPA or WPA2) for the example to use. WiFi password (WPA or WPA2) for the example to use.
config MAX_STA_CONN config MAX_STA_CONN
int "Maximal STA connections" int "Maximal STA connections"
default 4 default 4
help help
Max number of the STA connects to AP. Max number of the STA connects to AP.
endmenu endmenu

30
examples/wifi/getting_started/station/main/Kconfig.projbuild
View File

@ -1,20 +1,20 @@
menu "Example Configuration" menu "Example Configuration"
config ESP_WIFI_SSID config ESP_WIFI_SSID
string "WiFi SSID" string "WiFi SSID"
default "myssid" default "myssid"
help help
SSID (network name) for the example to connect to. SSID (network name) for the example to connect to.
config ESP_WIFI_PASSWORD config ESP_WIFI_PASSWORD
string "WiFi Password" string "WiFi Password"
default "mypassword" default "mypassword"
help help
WiFi password (WPA or WPA2) for the example to use. WiFi password (WPA or WPA2) for the example to use.
config ESP_MAXIMUM_RETRY config ESP_MAXIMUM_RETRY
int "Maximum retry" int "Maximum retry"
default 5 default 5
help help
Set the Maximum retry to avoid station reconnecting to the AP unlimited when the AP is really inexistent. Set the Maximum retry to avoid station reconnecting to the AP unlimited when the AP is really inexistent.
endmenu endmenu

166
examples/wifi/power_save/main/Kconfig.projbuild
View File

@ -1,96 +1,96 @@
menu "Example Configuration" menu "Example Configuration"
config WIFI_SSID config WIFI_SSID
string "WiFi SSID" string "WiFi SSID"
default "myssid" default "myssid"
help help
SSID (network name) for the example to connect to. SSID (network name) for the example to connect to.
config WIFI_PASSWORD config WIFI_PASSWORD
string "WiFi Password" string "WiFi Password"
default "mypassword" default "mypassword"
help help
WiFi password (WPA or WPA2) for the example to use. WiFi password (WPA or WPA2) for the example to use.
config WIFI_LISTEN_INTERVAL
int "WiFi listen interval"
default 3
help
Interval for station to listen to beacon from AP. The unit of listen interval is one beacon interval.
For example, if beacon interval is 100 ms and listen interval is 3, the interval for station to listen
to beacon is 300 ms.
choice POWER_SAVE_MODE config WIFI_LISTEN_INTERVAL
prompt "power save mode" int "WiFi listen interval"
default POWER_SAVE_MIN_MODEM default 3
help help
Power save mode for the esp32 to use. Modem sleep mode includes minimum and maximum power save modes. Interval for station to listen to beacon from AP. The unit of listen interval is one beacon interval.
In minimum power save mode, station wakes up every DTIM to receive beacon. Broadcast data will not be For example, if beacon interval is 100 ms and listen interval is 3, the interval for station to listen
lost because it is transmitted after DTIM. However, it can not save much more power if DTIM is short to beacon is 300 ms.
for DTIM is determined by AP.
In maximum power save mode, station wakes up every listen interval to receive beacon. Broadcast data
may be lost because station may be in sleep state at DTIM time. If listen interval is longer, more power
is saved but broadcast data is more easy to lose.
config POWER_SAVE_NONE choice POWER_SAVE_MODE
bool "none" prompt "power save mode"
config POWER_SAVE_MIN_MODEM default POWER_SAVE_MIN_MODEM
bool "minimum modem" help
config POWER_SAVE_MAX_MODEM Power save mode for the esp32 to use. Modem sleep mode includes minimum and maximum power save modes.
bool "maximum modem" In minimum power save mode, station wakes up every DTIM to receive beacon. Broadcast data will not be
endchoice lost because it is transmitted after DTIM. However, it can not save much more power if DTIM is short
for DTIM is determined by AP.
In maximum power save mode, station wakes up every listen interval to receive beacon. Broadcast data
may be lost because station may be in sleep state at DTIM time. If listen interval is longer, more power
is saved but broadcast data is more easy to lose.
choice EXAMPLE_MAX_CPU_FREQ config POWER_SAVE_NONE
prompt "Maximum CPU frequency" bool "none"
default EXAMPLE_MAX_CPU_FREQ_80 config POWER_SAVE_MIN_MODEM
help bool "minimum modem"
Maximum CPU frequency to use for dynamic frequency scaling. config POWER_SAVE_MAX_MODEM
bool "maximum modem"
endchoice
config EXAMPLE_MAX_CPU_FREQ_80 choice EXAMPLE_MAX_CPU_FREQ
bool "80 MHz" prompt "Maximum CPU frequency"
config EXAMPLE_MAX_CPU_FREQ_160 default EXAMPLE_MAX_CPU_FREQ_80
bool "160 MHz" help
config EXAMPLE_MAX_CPU_FREQ_240 Maximum CPU frequency to use for dynamic frequency scaling.
bool "240 MHz"
endchoice
config EXAMPLE_MAX_CPU_FREQ_MHZ config EXAMPLE_MAX_CPU_FREQ_80
int bool "80 MHz"
default 80 if EXAMPLE_MAX_CPU_FREQ_80 config EXAMPLE_MAX_CPU_FREQ_160
default 160 if EXAMPLE_MAX_CPU_FREQ_160 bool "160 MHz"
default 240 if EXAMPLE_MAX_CPU_FREQ_240 config EXAMPLE_MAX_CPU_FREQ_240
bool "240 MHz"
endchoice
config EXAMPLE_MAX_CPU_FREQ_MHZ
int
default 80 if EXAMPLE_MAX_CPU_FREQ_80
default 160 if EXAMPLE_MAX_CPU_FREQ_160
default 240 if EXAMPLE_MAX_CPU_FREQ_240
choice EXAMPLE_MIN_CPU_FREQ choice EXAMPLE_MIN_CPU_FREQ
prompt "Minimum CPU frequency" prompt "Minimum CPU frequency"
default EXAMPLE_MIN_CPU_FREQ_10M default EXAMPLE_MIN_CPU_FREQ_10M
help help
Minimum CPU frequency to use for dynamic frequency scaling. Minimum CPU frequency to use for dynamic frequency scaling.
Should be set to XTAL frequency or XTAL frequency divided by integer. Should be set to XTAL frequency or XTAL frequency divided by integer.
config EXAMPLE_MIN_CPU_FREQ_40M config EXAMPLE_MIN_CPU_FREQ_40M
bool "40 MHz (use with 40MHz XTAL)" bool "40 MHz (use with 40MHz XTAL)"
depends on ESP32_XTAL_FREQ_40 || ESP32_XTAL_FREQ_AUTO depends on ESP32_XTAL_FREQ_40 || ESP32_XTAL_FREQ_AUTO
config EXAMPLE_MIN_CPU_FREQ_20M config EXAMPLE_MIN_CPU_FREQ_20M
bool "20 MHz (use with 40MHz XTAL)" bool "20 MHz (use with 40MHz XTAL)"
depends on ESP32_XTAL_FREQ_40 || ESP32_XTAL_FREQ_AUTO depends on ESP32_XTAL_FREQ_40 || ESP32_XTAL_FREQ_AUTO
config EXAMPLE_MIN_CPU_FREQ_10M config EXAMPLE_MIN_CPU_FREQ_10M
bool "10 MHz (use with 40MHz XTAL)" bool "10 MHz (use with 40MHz XTAL)"
depends on ESP32_XTAL_FREQ_40 || ESP32_XTAL_FREQ_AUTO depends on ESP32_XTAL_FREQ_40 || ESP32_XTAL_FREQ_AUTO
config EXAMPLE_MIN_CPU_FREQ_26M config EXAMPLE_MIN_CPU_FREQ_26M
bool "26 MHz (use with 26MHz XTAL)" bool "26 MHz (use with 26MHz XTAL)"
depends on ESP32_XTAL_FREQ_26 || ESP32_XTAL_FREQ_AUTO depends on ESP32_XTAL_FREQ_26 || ESP32_XTAL_FREQ_AUTO
config EXAMPLE_MIN_CPU_FREQ_13M config EXAMPLE_MIN_CPU_FREQ_13M
bool "13 MHz (use with 26MHz XTAL)" bool "13 MHz (use with 26MHz XTAL)"
depends on ESP32_XTAL_FREQ_26 || ESP32_XTAL_FREQ_AUTO depends on ESP32_XTAL_FREQ_26 || ESP32_XTAL_FREQ_AUTO
endchoice endchoice
config EXAMPLE_MIN_CPU_FREQ_MHZ
int
default 40 if EXAMPLE_MIN_CPU_FREQ_40M
default 20 if EXAMPLE_MIN_CPU_FREQ_20M
default 10 if EXAMPLE_MIN_CPU_FREQ_10M
default 26 if EXAMPLE_MIN_CPU_FREQ_26M
default 13 if EXAMPLE_MIN_CPU_FREQ_13M
config EXAMPLE_MIN_CPU_FREQ_MHZ
int
default 40 if EXAMPLE_MIN_CPU_FREQ_40M
default 20 if EXAMPLE_MIN_CPU_FREQ_20M
default 10 if EXAMPLE_MIN_CPU_FREQ_10M
default 26 if EXAMPLE_MIN_CPU_FREQ_26M
default 13 if EXAMPLE_MIN_CPU_FREQ_13M
endmenu endmenu

110
examples/wifi/scan/main/Kconfig.projbuild
View File

@ -1,68 +1,68 @@
menu "Example Configuration" menu "Example Configuration"
config WIFI_SSID config WIFI_SSID
string "WiFi SSID" string "WiFi SSID"
default "myssid" default "myssid"
help help
SSID (network name) for the example to connect to. SSID (network name) for the example to connect to.
config WIFI_PASSWORD config WIFI_PASSWORD
string "WiFi Password" string "WiFi Password"
default "mypassword" default "mypassword"
help help
WiFi password (WPA or WPA2) for the example to use. WiFi password (WPA or WPA2) for the example to use.
choice SCAN_METHOD choice SCAN_METHOD
prompt "scan method" prompt "scan method"
default WIFI_FAST_SCAN default WIFI_FAST_SCAN
help help
scan method for the esp32 to use scan method for the esp32 to use
config WIFI_FAST_SCAN config WIFI_FAST_SCAN
bool "fast" bool "fast"
config WIFI_ALL_CHANNEL_SCAN config WIFI_ALL_CHANNEL_SCAN
bool "all" bool "all"
endchoice endchoice
choice SORT_METHOD choice SORT_METHOD
prompt "sort method" prompt "sort method"
default WIFI_CONNECT_AP_BY_SIGNAL default WIFI_CONNECT_AP_BY_SIGNAL
help help
sort method for the esp32 to use sort method for the esp32 to use
config WIFI_CONNECT_AP_BY_SIGNAL config WIFI_CONNECT_AP_BY_SIGNAL
bool "rssi" bool "rssi"
config WIFI_CONNECT_AP_BY_SECURITY config WIFI_CONNECT_AP_BY_SECURITY
bool "authmode" bool "authmode"
endchoice endchoice
config FAST_SCAN_THRESHOLD config FAST_SCAN_THRESHOLD
bool "fast scan threshold" bool "fast scan threshold"
default y default y
help help
wifi fast scan threshold wifi fast scan threshold
config FAST_SCAN_MINIMUM_SIGNAL config FAST_SCAN_MINIMUM_SIGNAL
int "fast scan minimum rssi" int "fast scan minimum rssi"
depends on FAST_SCAN_THRESHOLD depends on FAST_SCAN_THRESHOLD
range -127 0 range -127 0
default -127 default -127
help help
rssi is use to measure the signal rssi is use to measure the signal
choice FAST_SCAN_WEAKEST_AUTHMODE choice FAST_SCAN_WEAKEST_AUTHMODE
prompt "fast scan weakest authmode" prompt "fast scan weakest authmode"
depends on FAST_SCAN_THRESHOLD depends on FAST_SCAN_THRESHOLD
default EXAMPLE_OPEN default EXAMPLE_OPEN
config EXAMPLE_OPEN config EXAMPLE_OPEN
bool "open" bool "open"
config EXAMPLE_WEP config EXAMPLE_WEP
bool "wep" bool "wep"
config EXAMPLE_WPA config EXAMPLE_WPA
bool "wpa" bool "wpa"
config EXAMPLE_WPA2 config EXAMPLE_WPA2
bool "wpa2" bool "wpa2"
endchoice endchoice
endmenu endmenu

70
examples/wifi/simple_sniffer/main/Kconfig.projbuild
View File

@ -1,44 +1,44 @@
menu "Example Configuration" menu "Example Configuration"
config STORE_HISTORY config STORE_HISTORY
bool "Store command history in flash" bool "Store command history in flash"
default y default y
help help
Linenoise line editing library provides functions to save and load Linenoise line editing library provides functions to save and load
command history. If this option is enabled, initalizes a FAT filesystem command history. If this option is enabled, initalizes a FAT filesystem
and uses it to store command history. and uses it to store command history.
config SNIFFER_MOUNT_POINT config SNIFFER_MOUNT_POINT
string "Mount Point in your filesystem to store pcap files" string "Mount Point in your filesystem to store pcap files"
default "/sdcard" default "/sdcard"
help help
Here you need to specify the mount point in the VFS (Virtual File System) where the pcap would be saved. Here you need to specify the mount point in the VFS (Virtual File System) where the pcap would be saved.
config SNIFFER_WORK_QUEUE_LENGTH config SNIFFER_WORK_QUEUE_LENGTH
int "Length of sniffer work queue" int "Length of sniffer work queue"
default 128 default 128
help help
The sniffer callback function should not do heavy work, so we put all heavy IO operation to another task. The sniffer callback function should not do heavy work, so we put all heavy IO operation to another task.
The task gets some basic info of sniffer packet via queue. The task gets some basic info of sniffer packet via queue.
Here you should specify the length of queue. Here you should specify the length of queue.
config SNIFFER_TASK_STACK_SIZE config SNIFFER_TASK_STACK_SIZE
int "Stack size of sniffer task" int "Stack size of sniffer task"
default 2560 default 2560
help help
The stack size of sniffer task. The stack size of sniffer task.
config SNIFFER_TASK_PRIORITY config SNIFFER_TASK_PRIORITY
int "Priority of sniffer task" int "Priority of sniffer task"
default 2 default 2
help help
Priority of sniffer task. Priority of sniffer task.
config PCAP_FILE_MAX_PACKETS config PCAP_FILE_MAX_PACKETS
int "Max packets in a pcap file" int "Max packets in a pcap file"
default 2000 default 2000
help help
To avoid the pcap file being very large, we should save packets into multiple fiiles. To avoid the pcap file being very large, we should save packets into multiple fiiles.
Here you should specify the max number of packets that should be save in one pcap file. Here you should specify the max number of packets that should be save in one pcap file.
endmenu endmenu

58
examples/wifi/wpa2_enterprise/main/Kconfig.projbuild
View File

@ -1,34 +1,34 @@
menu "Example Configuration" menu "Example Configuration"
config WIFI_SSID config WIFI_SSID
string "WiFi SSID" string "WiFi SSID"
default "wpa2_test" default "wpa2_test"
help help
SSID (network name) for the example to connect to. SSID (network name) for the example to connect to.
config EAP_METHOD config EAP_METHOD
int "EAP METHOD" int "EAP METHOD"
default 1 default 1
help help
EAP method (TLS, PEAP or TTLS) for the example to use. EAP method (TLS, PEAP or TTLS) for the example to use.
TLS: 0, PEAP: 1, TTLS: 2 TLS: 0, PEAP: 1, TTLS: 2
config EAP_ID config EAP_ID
string "EAP ID" string "EAP ID"
default "example@espressif.com" default "example@espressif.com"
help help
Identity in phase 1 of EAP procedure. Identity in phase 1 of EAP procedure.
config EAP_USERNAME config EAP_USERNAME
string "EAP USERNAME" string "EAP USERNAME"
default "espressif" default "espressif"
help help
Username for EAP method (PEAP and TTLS). Username for EAP method (PEAP and TTLS).
config EAP_PASSWORD config EAP_PASSWORD
string "EAP PASSWORD" string "EAP PASSWORD"
default "test11" default "test11"
help help
Password for EAP method (PEAP and TTLS). Password for EAP method (PEAP and TTLS).
endmenu endmenu

24
examples/wifi/wps/main/Kconfig.projbuild
View File

@ -1,17 +1,17 @@
menu "Example Configuration" menu "Example Configuration"
choice EXAMPLE_WPS_TYPE choice EXAMPLE_WPS_TYPE
prompt "WPS mode" prompt "WPS mode"
default EXAMPLE_WPS_TYPE_PBC default EXAMPLE_WPS_TYPE_PBC
help help
WPS type for the esp32 to use. WPS type for the esp32 to use.
config EXAMPLE_WPS_TYPE_PBC config EXAMPLE_WPS_TYPE_PBC
bool "PBC" bool "PBC"
config EXAMPLE_WPS_TYPE_PIN config EXAMPLE_WPS_TYPE_PIN
bool "PIN" bool "PIN"
config EXAMPLE_WPS_TYPE_DISABLE config EXAMPLE_WPS_TYPE_DISABLE
bool "disable" bool "disable"
endchoice endchoice
endmenu endmenu

Some files were not shown because too many files have changed in this diff Show More