ESP-IDF Release v5.0.1

Documentation for IDF v5.0.1 is available at https://docs.espressif.com/projects/esp-idf/en/v5.0.1/

ESP-IDF v5.0.1 is a bugfix update for ESP-IDF v5.0.

Obtaining v5.0.1

For full installation instructions, see the ESP-IDF Programming Guide.

The source files attached to this release will not work due to our use of git submodules. Use one of the following methods instead:

Using git

To get this release, use the following commands:

git clone -b v5.0.1 --recursive https://github.com/espressif/esp-idf.git esp-idf-v5.0.1
cd esp-idf-v5.0.1/

This is the recommended way of obtaining v5.0.1 of ESP-IDF.

Download an archive with submodules included

Attached to this release is an esp-idf-v5.0.1.zip archive. It includes .git directory and all the submodules, so can be used out of the box. This archive is provided for users who have connectivity issues preventing them from cloning from GitHub.

This archive can also be downloaded from Espressif's download server:
https://dl.espressif.com/github_assets/espressif/esp-idf/releases/download/v5.0.1/esp-idf-v5.0.1.zip

Major changes

This is the list of changes since release v5.0:

Breaking Changes

• System/sleep: esp_light_sleep_start now returns two error num when sleep fails: ESP_ERR_SLEEP_REJECT and ESP_ERR_SLEEP_TOO_SHORT_SLEEP_DURATION (f91cb28)
• Wi-Fi: Changed espnow receive callback function type (esp_now_recv_cb_t) (6818b30)
• Wi-Fi: added ESP_WIFI_ESPNOW_MAX_ENCRYPT_NUM to configure the maximum ESPNOW encrypted connection number which impact the maximum SoftAP connection number (175f0de, fe4efc0)
• ADC: No longer support ADC2 continuous (DMA) mode on ESP32-S3 and ESP32-C3, search for errata on espressif website to know more details. Users can force use it by enabling ADC_CONTINUOUS_FORCE_USE_ADC2_ON_C3_S3 (1c373cf)
• ADC: No longer support ADC2 oneshot mode on ESP32-C3, search for errata on espressif website to know more details. Users can force use it by enabling ADC_ONESHOT_FORCE_USE_ADC2_ON_C3 (bb07490)
• esp_chip_info() returns the chip version in the format = 100 * major eFuse version + minor eFuse version.

Changelog

Bluetooth

Controller

Fixed

• Fixed lld_con.c line 3048 assert on ESP32-C3 and ESP32-S3 (8b0ec09)
• Fixed crash sometimes when connected as a slave by 8th device on ESP32-C3 and ESP32-S3 (8b0ec09)

Bluetooth Low Energy

Added

• Added comments explaining how much memory will be used by each connection/advertiser for ESP32-C2 (dcc310f)
• Added config to disable scan backoff on ESP32-C3 and ESP32-S3(6d11786)
• Supported Bluetooth to release .bss and .data segment memory on ESP32-C2 (6c4292f), ESP32-C3 and ESP32-S3 (1b44990)
• Added config to set duplicate scan list refresh period on ESP32, ESP32-C3 and ESP32-S3 (e7ee437, 0733694)

Changed

• Changed BLE default TX power from 3dBm to 9dBm on ESP32-C3 and ESP32-S3(99cd534)
• Updated phy lib for ESP32-C2, ESP32-C3 and ESP32-S3 (9cfffd2)
• Enable BLE PLL track to fix bluetooth disconnection caused by temperature rise or fall on ESP32-C3 and ESP32-S3
• Unified the controller internal error code on ESP32-C2 (de7e62f)
• Changed default TX power to 9 dBm on ESP32 (0b8f0e5)

Fixed

• Fixed a bug in the linker fragment file that made BSS part marked by bt_bss_start and bt_bss_end empty on all BLE chips (d4070f7)
• Fixed llm_scan.c assert at line 1485 during controller deinit if extend duplicate scan is not stopped on ESP32-C3 and ESP32-S3(0af189b)
• Fixed memory leak issue caused by insufficient heap on ESP32-C2 (90fa0e5)
• Fixed interrupt latency when cache is disabled on ESP32-C2 (06290d4)
• Fixed occasional assertion when periodic adv is stopped on ESP32-C2
• Overwrite the oldest device infor if the list is full on ESP32, ESP32-C3 and ESP32-S3 (e7ee437, 0733694)
• Fixed duplicate scan period is not accurate on ESP32, ESP32-C3 and ESP32-S3 (e7ee437, 0733694)
• Fixed some memory was not released after Bluetooth controller initialization failed on ESP32, ESP32-C3 and ESP32-S3 (5fff471, c656e7e)
• Fixed privacy error for directed advertising on ESP32-C3 and ESP32-S3 (e95d720)
• Fixed multiple periodic advertising sync failed in air on ESP32-C3 and ESP32-S3 (e95d720)
• Fixed disconnect reason 0x1f (unspecified error) on ESP32 (0b8f0e5)
• Fixed connection timeout due to LL_TERMINATE_IND has not been acknowledged on ESP32 (0b8f0e5)

Removed

• Removed redundant pm_lock on ESP32-C2 (5c481c5)

Classic Bluetooth

Bluedroid

Classic Bluetooth

Added

• Added esp_spp_enhanced_init() API to indicate whether to enable Logical Link Control and Adaptation Layer Protocol enhanced retransmission mode (c2c9b09)
• Added report for ACL link related events to upper layer (80da46e)
• Added esp_spp_vfs_unregister() to free memory allocated by esp_spp_vfs_register() (3f5aaf1)

Changed

• Changed the default SR mode to R2 for the paging device when it knows nothing about the paged device's SR mode. (a1de1bf)
• Updated A2DP version to v1.4 (e579466)
• Updated HFP version to v1.8 (71bd180)
• Changed A2DP audio buffer management behaviour, removed audio cache in BTC layer and added flow control for audio data in application layer in A2DP sink example. (9ad1c7d, 75b2e63)

Fixed

• Fixed compatibility issues with HID devices that do not support Secure Simple Paring in HID examples. (a69c540, #10069)
• Fixed esp_spp_write() crash when data length is 0 (47232f5)
• Fixed incorrect description in macro BT_CONTROLLER_INIT_CONFIG_DEFAULT(). (ffcabde, #9906)
• Fixed the unexpected memory free when malloc failed. (11b6c25, #9972)
• Fixed the issue Bluetooth Classic connection can not be created while this is a Bluetooth Low Energy connection is in active. (650b665, #6557)
• Fixed HFP client parce CLCC command response bug (2539529)
• Fixed authentication failure during legacy pairing by using variable PIN type instead of fixed PIN. (728e2c9, #10005)
• Fixed HID Host improper handle of freeing resource in esp_hid component (de55b5d)
• Fixed A2DP failing to connect again after disconnected (d47bf56)
• Fixed HID Device can not remove virtually cabled device without a connection. (ad43b04)
• Fixed memory leak due to not freeing memory if posting a message to a thread fails (f9732cb)
• Fixed the use of invalid configuration when the peer device configures the stream, and returned an incorrect error code (9bd1484)
• Fixed memory leak when SPP initialization failed (29b718b)

Bluetooth Low Energy

Added

• Support bluedroid host maximum number of connections to 9 on ESP32-C3 and ESP32-S3 (2a76e35)

Changed

• Reduce the stack consumption of BTU_TASK, saving 609 bytes(7884457)

Fixed

• Fixed ble_compatibility_test example NVS init error (f258183)
• Clean up BLE examples sdkconfig.defaults (fdd75ea)
• Fixed sometimes BTU task overflow when doing read and write performance test(2e0a5b3)
• Fixed BLE HID LED output report error (e8fef19)
• Fixed encrypt key size error of GATT characteristic permission (c97df72)
• Fixed no BLE connection update event with the same parameters (938d912)
• Correct the length of ATT_READ_BY_TYPE_REQ PDU(4b7702c)

Removed

• Remove -Wno-format compile option for bluedroid BLE examples (16f9add)

NimBLE

Added

• Added init deinit of nimble stack in a loop. (ff29f5c)
• Added stack support for Connection subrating feature (586a471)
• Support to expose blufi handler for external BLE application (7a72210)
• Added support for HCI Commands / Events for LE Power Control (e8e79e8)
• Added an example support for ble periodic adv. (9d3e157)
• Helper macro added to set perdiodic adv interval (1623ad0)
• Support BLE memory release on ESP32C2 (6c4292f)
• Support max number of connections to 9 on esp32c3 and esp32s3 (7d68a35)

Changed

• Updated README file of BLE PHY prph example (5774ca1)
• Changed GATT notify/indicate from gattc to gatts (b1d87a4)
• Updated Mesh example documentation (71e1c0a)

Fixed

• Fixed freeing up of same memory address twice in L2CAP COC example. (5c50cbc)
• Fixed esprv_intc_int_set_type() usage (50b1a99)

Removed

• Remove -Wno-format compile option for nimble examples (cbf8cf7)

Blufi

Added

• Added API for stack and profile deinit (ab2dee9)
• Added data subtype for more Wi-Fi information (39080a2)
• Support to query disconnected information, connecting information (497b451)

Fixed

• Examples: Return errcode if fail to scan (497b451)

ESP-BLE-Mesh

Added

• Added an option for initiating IV Index Recovery if missing one (54f18a4)

Fixed

• Fixed not using fast adv interval when PB-GATT and PB-ADV are both enabled (3d695ce)
• Fixed not able to get optional fields from messages with a group address as DST (f825fcd)
• Fixed typo in the directly erase settings event (1529613)

Removed

• Removed -Wno-format compile option for BLE Mesh examples (fca1b1d)

Coexistence

Added

• Added external coexistence (leader mode) support on ESP32-S3 and ESP32-C2 (9bbe6e7)
• Added external coexistence (follower mode) support on ESP32-C2 (676a347)
• Added force RX mode in external coexistence on ESP32-C2 (676a347)
• Added support for output grant signal delay and validate pin level configuration on ESP32-C2 (676a347)

Fixed

• Fixed part of modem module not reset when power up (18fef64)

Wi-Fi

Added

• Added connectionless power save documentation (5cd3244)
• ...

ESP-IDF Release v4.4.4

Documentation for IDF v4.4.4 is available at https://docs.espressif.com/projects/esp-idf/en/v4.4.4/

ESP-IDF v4.4.4 is a bugfix update for ESP-IDF v4.4.

Obtaining v4.4.4

For full installation instructions, see the ESP-IDF Programming Guide.

The source files attached to this release will not work due to our use of git submodules. Use one of the following methods instead:

Using git

To get this release, use the following commands:

git clone -b v4.4.4 --recursive https://github.com/espressif/esp-idf.git esp-idf-v4.4.4
cd esp-idf-v4.4.4/

This is the recommended way of obtaining v4.4.4 of ESP-IDF.

Download an archive with submodules included

Attached to this release is an esp-idf-v4.4.4.zip archive. It includes .git directory and all the submodules, so can be used out of the box. This archive is provided for users who have connectivity issues preventing them from cloning from GitHub.

This archive can also be downloaded from Espressif's download server: https://dl.espressif.com/github_assets/espressif/esp-idf/releases/download/v4.4.4/esp-idf-v4.4.4.zip

Major changes

This is the list of changes since release v4.4.3:

Major Bug Fixes

• Wi-Fi: Fixed multicast pkts drop issue for some AP when DTIM period > 1

Breaking Changes

• Power management: esp_light_sleep_start now returns two error num when sleep fails: ESP_ERR_SLEEP_REJECT and ESP_ERR_SLEEP_TOO_SHORT_SLEEP_DURATION
• Wi-Fi: Modified maximum Softap connection number and ESP-NOW encrypted connection number.
• esp_flash_encrypt: In API to set flash encryption to release mode, if the target supports it then enable Secure ROM DL mode instead of disabling it completely.

Changelog

Bluetooth

Controller

Changed

• Updated phy lib for ESP32-C2, ESP32-C3 and ESP32-S3

Bluetooth Low Energy

Added

• Added config to disable scan backoff
• Support Bluetooth to release .bss and .data segment memory on ESP32-C3 and ESP32-S3

Changed

• Changed BLE default TX power from 3dBm to 9dBm on ESP32-C3 and ESP32-S3
• Enabled BLE PLL track to fix bluetooth disconnection caused by temperature rise or fall on ESP32-C3 and ESP32-S3

Fixed

• Fixed BLE lld_per_adv.c line 401 assert on ESP32-C3 and ESP32-S3
• Fixed BLE ASSERT_PARAM(32 0) in rwble.c at line 384 on ESP32
• Fixed llm_scan.c assert at line 1485 during controller deinit if extend duplicate scan is not stopped on ESP32-C3 and ESP32-S3
• Fixed BLE array access out of bounds on ESP32-C3 and ESP32-S3
• Fixed lld_con.c line 3048 assert on ESP32-C3 and ESP32-S3
• Fixed crash sometimes when connected as a slave by 8th device on ESP32-C3 and ESP32-S3

Classic Bluetooth

Fixed

• Fixed the issue that Wi-Fi task can be blocked by Bluetooth Controller because of the use of blocking coexistence callback function on ESP32

Bluedroid

Classic Bluetooth

Added

• Added API esp_spp_vfs_unregister() to free memory allocated by esp_spp_vfs_register()

Changed

• Changed pin_type of Legacy Paring from FIXED to VARIABLE to avoid authentication failure (#10005)
• Changed the SR_mode selection when the pager knows nothing about the paged device's SR mode

Fixed

• Fixed the unexpected memory free when malloc failed.
• Fixed incorrect description in macro BT_CONTROLLER_INIT_CONFIG_DEFAULT()
• SPP: Fixed esp_spp_write() crash when len is 0
• Fixed the issue Bluetooth Classic connection can not be created while this is a Bluetooth Low Energy connection is in active
• HFP: Fixed HFP client parce CLCC command response bug
• HID: Fixed HID Host improper handle of freeing resource in esp_hid component
• A2DP: Fixed a2dp failing to connect again after disconnected
• HID: Fixed HID Device can not remove virtually cabled device without a connection
• Fixed memory leak due to not freeing memory if posting a message to a thread fails
• SPP: Fixed memory leak when SPP initialization failed
• Fixed build errors for HID examples in the condition that Secure Simple Paring is disabled (#10069)

Removed

• Removed audio cache in BTC layer of Bluedroid and added flow control for audio data in application layer.

Bluetooth Low Energy

Added

• Support bluedroid host maximum number of connections to 9 on ESP32-C3 and ESP32-S3

Changed

• Reduced the stack consumption of BTU_TASK, saving 609 bytes

Fixed

• Allow bluedroid host to report ADV_IND separately
• Configurable max GATTC cache characteristic count
• Configurable option to modify max GATT service attributes count
• Fixed BLE advertising TX power map
• Fix BLE resolvable private address generate and update
• Fixed BLE generate RPA for ESP32
• Fixed ESP HID crash when authentication failed
• Fixed a bug in the linker fragment file that made BSS part, marked by bt_bss_start and bt_bss_end, empty
• Fixed ble_compatibility_test example NVS flash init error
• Clean up BLE examples sdkconfig.defaults
• Fixed sometimes BTU task overflow when doing read and write performance test

NimBLE

Added

• Added init deinit of nimble stack in a loop
• Support Nimble host maximum number of connections to 9 on ESP32-C3 and ESP32-S3

Changed

• Updated check for reattempt connection code

Blufi

Added

• Added data subtype for more WiFi information
• Example: support to query disconnected information, connecting information
• Example: return errcode if fail to scan

ESP-BLE-Mesh

Added

• Added an option for initiating IV Index Recovery if missing one

Fixed

• Fixed not able to get optional fields from messages with a group address as DST
• Fixed not using fast adv interval when PB-GATT and PB-ADV are both enabled

Coexistence

Fixed

• Fixed part of modem module not reset when power up

Wi-Fi

Added

• Added check for ies in match security.
• Added station connect retry count to make it easier to connect to the except AP
• Provided RSSI info in disconnected event
• Supported WiFi TX fragment in the crypto mode of GCMP.
• Added clear ap list interface
• Added configuration options for maximum number of ESP-NOW encrypted connections.
• Added config option to mandate station authmode threshold to WPA3 if AP sends transition_disable bit.

Changed

• Changed wifi scan return value.
• Changed the log level of some logs to avoid misunderstanding.
• Modified maximum Softap connection number.
• Changed the max connection num on ESP32-C3 and ESP32-S3

Fixed

• Added security fixes from upstream wpa_supplicant (CVE-2019-9496, CVE-2022-23304, CVE-2022-23303, CVE-2019-9494)
• Fixed Wi-Fi getting stuck in Wi-Fi start when working with BT on ESP32-C3 and ESP32-S3
• Fixed issue that sniffer mode can not capture control packet
• Fixed a few memory leaks in the operation of a station in WPS pin mode, which led to crashes after a few executions of WPS Start with no attempt to connect it to it for the WPS timeout duration.
• Fixed WPA2 Enterprise Re-authentication issue
• Added changes to prevent security parameters overwritten in full scan
• Fixed the bug that station connected to an AP already connected caused subsequent scan fail.
• Prevented using WPA3 PMK caching for WPA2 connection.
• Fixed high current issue after reconnected
• Fixed potential Wi-Fi disconnection when BT deinit.
• Cleared scan result info when wifi stop
• Fixed connect fail return wrong error code issue.
• Fixed WAPI issue on GTK compability and reference to broadcast ARP pkts.
• Fixed TX fragment issue that PN code is less than MSDU after PN code add two for TX fragment.
• Fixed some issues on Soft-AP power save.
• Fixed SoftAP memory leak after wifi init and deinit
• Fixed station get AP info does not return connected SSID issue.
• Fixed SoftAP disconnection happened even when receive PS-Poll
• Fixed SSID copy length during WPS scan
• Prevented PMK caching if AP security has changed
• Fixed multicast pkts drop issue for some AP when DTIM period > 1.
• Added a check to avoid FTM initiator mode in SoftAP interface
• Fixed home channel issue in FTM for STA+SoftAP mode
• Fixed integer overflow in FTM which caused some invalid test
• Clear current pmksa to fix WPA3 connect loop
• Added a check to avoid initiator mode in ftm softap
• Fixed home channel issue in ftm for apsta mode
• Fixed int overflow for T1-T4 counter variable

ESP-WIFI-MESH

Fixed

• Fixed memory leak issue when esp_mesh_start/stop
• Fixed invalid child issue(#9773)
• Fixed WIFI_EVENT_AP_STADISCONNECTED event error

Security

Fixed

• esp_flash_encrypt: In API to set flash encryption to release mode, if the target supports it then enable Secure ROM DL mode instead of disabling it completely.

Peripheral Drivers

Added

• ESP_LCD: Support register color-transfer-done callback at runtime
• I2C_LCD: Added support of rotation for OLED SSD1306 screen
• SPI_LCD: Support transmit color buffer without specifying a command (#10302)
• MCPWM: BDC control example now supports USB serial jtag console
• SPI Flash: Added flash high-performance mode (> 80MHz) support for ESP32-S3
• SPI Flash: Added docs for optional features

Changed

• esp_lcd: Added esp_lcd_panel_disp_on_off function and it's recommended to replace the esp_lcd_panel_disp_off function
• freemodbus: Synced to upstream esp-modbus v1.0.7 via git-subrepo
• freemodbus: Updated/removed default Kconfig options for the updated component
• freemodbus: Updated docs to describe component usage, make links to component docume...

ESP-IDF Release v4.1.4

Documentation for IDF v4.1.4 is available at https://docs.espressif.com/projects/esp-idf/en/v4.1.4/

ESP-IDF v4.1.4 is a bugfix update for ESP-IDF v4.1.3.

Obtaining v4.1.4

For full installation instructions, see the ESP-IDF Programming Guide.

The source files attached to this release will not work due to our use of git submodules. Use one of the following methods instead:

Using git

To get this release, use the following commands:

git clone -b v4.1.4 --recursive https://github.com/espressif/esp-idf.git esp-idf-v4.1.4
cd esp-idf-v4.1.4/

This is the recommended way of obtaining v4.1.4 of ESP-IDF.

Download an archive with submodules included

Attached to this release is an esp-idf-v4.1.4.zip archive. It includes .git directory and all the submodules, so can be used out of the box. This archive is provided for users who have connectivity issues preventing them from cloning from GitHub.

This archive can also be downloaded from Espressif's download server:
https://dl.espressif.com/github_assets/espressif/esp-idf/releases/download/v4.1.4/esp-idf-v4.1.4.zip

Major changes

This is the list of changes since release v4.1.3:

Major Bug Fixes

• Fixed deadlock due to wrong parameter when calling btc_transfer_context() after calling esp_bluedroid_disable(). (#9672)

Breaking Changes

• Station Always connect to AP with PMF mode if possible, added a separate PMF disable API

Changelog

Bluetooth

Controller

Fixed

• Fixed that FreeRTOS semaphores and queues used by Bluetooth Controller are created in SPIRAM, which causes software crash when handling ISRs
• Fixed missing in processing VHCI interrupt caused by lack of protection against race conditions in accessing VHCI environment variables on ESP32
• Fixed the issue that Wi-Fi task can be blocked by Bluetooth Controller because of the use of blocking coexistence callback function on ESP32

Bluetooth Low Energy

Fixed

• Fixed BLE ke_mem.c assert on ESP32
• Fixed BLE ASSERT_PARAM(32 0) in rwble.c at line 384 on ESP32

Classic Bluetooth

• Allow max supported feature page lower than current feature page when handle with the respond of extend features to support for some devices which generate wrongly LMP respond on ESP32
• Fixed the EDR mode wrongly cleared by after a successful role switch, which caused that the 2M/3M packet type can not be selected for use
• Fixed the issue during legacy pairing procedure that controller does not report link key to Host on ESP32
• Fixed the duplicated reports of HCI_Connection_Request event from the same Bluetooth device on ESP32
• Fixed the exhaustion of ACL buffer in case of connection-disconnection stress test

Bluedroid

Classic Bluetooth

Added

• Added parameter field Bluetooth device address to esp_bt_gap_cb_param_t::read_rmt_name_param. (#9033)

Changed

• Updated HFP_HF version to 1.7.2

Fixed

• Fixed the linker error of functions not defined when memory debugging functionality is enabled
• Resolved type redefinitions in btc_spp.h and btc_hd.h/btc_hh.h
• A2DP: Fixed the format error of AVDTP general reject message
• A2DP: Fixed in A2DP sink example that audio playback is clogged due to higher priority of application task in case of heavy workload from the task
• HFP: Fixed the failure of 'connect audio' operation in HFP examples with default SDK configuration
• SPP: Fixed SPP initiator can not free resources when the connection fails
• SPP: Fixed SPP crash after calling esp_spp_deinit
• SPP: Fixed SPP resource leak due to missing of deleting the mutex upon failure of initialization
• A2DP: fixed sink device not being able to accept and decode mono channel audio stream
• Fixed the issue Bluetooth Classic connection can not be created while this is a Bluetooth Low Energy connection is in active
• Fixed incorrect description in macro BT_CONTROLLER_INIT_CONFIG_DEFAULT()
• Fixed the unexpected memory free when malloc failed (#9972)
• HFP: Fixed the issue that HFP client makes error in parsing CLCC command response
• A2DP: Fixed A2DP failing to connect again after disconnected

Bluetooth Low Energy

Fixed

• Allow bluedroid host to report ADV_IND separately
• Fixed bluedroid host memory overflow
• Fixed calling esp_ble_get_cur_sendable_packets_num() sometimes crashes when bluetooth is disconnecting
• Fixed the bug that no event is reported if the same data length is set repeatedly
• Fixed second bonding failed issue

NimBLE

Fixed

• Corrected stack initialization dependency function checks

ESP-BLE-Mesh

Added

• Added an option for initiating IV Index Recovery if missing one
• Added an option for filtering packets with old SeqAuth
• Added an option for LPN to subscribe all-nodes-address automatically

Fixed

• Fixed not checking the oversized SegN during provisioning
• Fixed Friend not relay LPN message when relay feature is disabled
• Fixed handling continuously received secure update in friend queue
• Fixed using wrong range for Heartbeat Publication Period Log value
• Fixed using wrong count_log for Heartbeat Subscription Status
• Fixed not ignoring connectable PB-ADV PDU containing a Link Open message
• Fixed ignoring KR flag within Secure Network Beacon from non-primary subnet
• Fixed the sequence of checking invalid Provisioning PDU type
• Fixed not using fast adv interval when PB-GATT and PB-ADV are both enabled
• Fixed not checking invalid link flag during PB-GATT provisioning
• Fixed wrongly overwritten the expect_ack_for flag after send_pub_key
• Fixed not checking if AppKey is bound to model during model publication set
• Fixed the regression introduced in the btc_transfer_context changes
• Fixed not able to get optional fields from messages with a group address as DST

Wi-Fi

Changed

• Compile WiFi library with -Os instead of -Og to reduce code size
• Station Always connect to AP with PMF mode if possible, added a separate PMF disable API

Fixed

• Fixed the bug that Wi-Fi stop stuck when sniffer not disabled
• Fixed the bug that QoS null will update BA SSN which may leader packet drop by firmware
• Fixed clearing default wifi netif procedure
• Fixed station can't reconnect to ap when PMF enabled after deep sleep or reset
• Fixed ESP-NOW can receive unencrypted packets from encrypted peer devices
• Fixed some AP will ignore authentication after receiving deauthentication for a while
• Fixed handling of key RSC
• Fixed issue of STA does not connect to AP in mixed mode security if PMF is enabled
• Fixed the QoS value of reply packets to peers
• Fixed the wrong suggestion of method in NAK for all the methods (#7769)
• Fixed write to null pointer if malloc failed
• Fixed static analysis issues
• Fixed an issue that station connected to an AP already connected caused subsequent scan fail
• Fixed the bug that sniffer FCS error packets may cause crash
• Fixed TKIP and PMF compability issue
• Added changes for unicast key renew for TKIP MIC failure
• Do not use pmkid caching when SSID is changed
• Ignore unauthenticated encrypted EAPOL-Key data
• Multiple bugfixes in SoftAP and Station PMF
• Fixed memory leaks in WPS operation
• Fixed the bug that stale PMF config in NVS
• Fixed the bug that security parameters overwritten in full scan
• Fixed unprotected SA Query issue

Peripheral Drivers

Added

• SPI Flash: Support unlock for ISSI chips
• SPI Flash: Added unlock function patch in bootloader to make GD flash more stable
• SPI Flash: Support unlock for MXIC chips

Changed

• SPI Flash: Decrease the IRAM usage of SPI Flash driver

Fixed

• GPIO: Fixed the issue that config struct is not properly initialized in the example
• freemodbus: Fixed slave destroy bug when master and slave init simultaneously
• freemodbus: Fixed master and slave use the same timer group index (#4699)
• freemodbus: Fixed uart_set_pin() check error in modbus master serial example
• I2S: Fixed the issue that I2S DAC has no output (#6470)
• SDIO Slave: Fixed crash caused by incorrect return value check in host example
• SPI Master: Fixed the error log when using SPI_TRANS_USE_TXDATA or SPI_TRANS_USE_RXDATA with data longer than expected
• SPI Slave: Fixed an issue with placing the interrupt handler into IRAM (#3870)
• UART: Fixed uart_set_line_inverse cannot disable inverse issue
• UART: Fixed RTS mis-reset before sending caused by context switch (#4178)
• UART: Fixed unreliable uart_wait_tx_done caused by the wrong handling to legacy UART_INTR_TX_DONE event
• SPI Flash: Fixed the issue mmap cannot be called with pointers to psram

Core System

Fixed

• Fixed calibration failure on rtc8m clock after CPU/core reset as 8md256 clock is not enabled during calibration
• Fixed xtal 32k not oscillate or oscillate too slowly issue for ESP32

FreeRTOS

Fixed

• Fixed bug in Xtensa FreeRTOS port where extra threadptr CPU was not being saved on solicited context switches
• Fixed bug in event group functions where blocked task list was being accessed without acquiring the task list spinlock

Power Management

Fixed

• Fixed problem when idle task neither enters light sleep nor "waiti" state

LWIP

Fixed

• Fixed esp_netif_set_dns_info() API to work correctly with IPv6 addresses

Bootloader

Added

• Enable write protection to flash at end of bootloader to increase s...

ESP-IDF Release v5.0

Documentation for release IDF v5.0 is available at https://docs.espressif.com/projects/esp-idf/en/v5.0/

ESP-IDF v5.0 is a major update for ESP-IDF v4.x. Release v5.0 is mostly compatible with apps written for ESP-IDF v4.x, but there are some breaking changes (please consult the list below) and removal of deprecated functionality which will require code changes when updating projects. Release v5.0 is the latest stable release at the time of writing.

We highly recommend referring to our migration guide while moving your apps from ESP-IDF v4.4 to v5.0 release.

Obtaining v5.0

For full installation instructions, see the ESP-IDF Programming Guide.

The source files attached to this release will not work due to our use of git submodules. Use one of the following methods instead:

Using git

To get this release, use the following commands:

git clone -b v5.0 --recursive https://github.com/espressif/esp-idf.git esp-idf-v5.0
cd esp-idf-v5.0/

This is the recommended way of obtaining v5.0 of ESP-IDF.

Download an archive with submodules included

Attached to this release is an esp-idf-v5.0.zip archive. It includes .git directory and all the submodules, so can be used out of the box. This archive is provided for users who have connectivity issues preventing them from cloning from GitHub.

This archive can also be downloaded from Espressif's download server:
https://dl.espressif.com/github_assets/espressif/esp-idf/releases/download/v5.0/esp-idf-v5.0.zip

Major changes

This is the list of changes since release v4.4:

Major New Features

Support of new SoC's

ESP32-C2 SoC

• Wi-Fi
  • 802.11 bgn mode
  • Station, SoftAP, sniffer mode
  • ESP-NOW
  • TX/RX AMPDU, TX/RX AMSDU
  • TX Fragment, TXOP
  • WEP/TKIP/CCMP
  • WPA/WPA2-PSK/WPA2-ENT/WPA3-PSK/WPA3-ENT
  • ESP-Touch v1/v2
  • Device Provisioning Protocol(DPP)
  • Network-assisted roaming using 802.11k (Radio Measurements), 802.11v (BTM) specifications and 802.11r (Fast BSS Transition)
  • Wi-Fi modem sleep and light sleep
• Bluetooth
  • BLE 5.0 Controller
  • HCI
  • NimBLE host with BLE 5.0
  • BLE modem sleep and light sleep
• Wi-Fi & BLE coexistence
  • Hardware arbiter based coexistence mechanism
  • Application scenarios based scheme coexistence mechanism
• Security
  • Secure boot
  • Flash encryption
  • ECC accelerator
  • RNG
• Peripherals
  • LCD driver
  • GDMA
  • GPIO driver
  • I2C
  • LEDC driver
  • memory copy by DMA
  • Dedicated GPIO driver
  • GPTimer driver
  • SPI Flash driver
  • GPSPI
  • UART
  • Temperature Sensor driver
• Power management
  • Dynamic Frequency Scaling
  • Light Sleep
  • Deep Sleep
  • Auto Light Sleep
• Security Features
  • Secure boot
  • Flash encryption
  • ECC accelerator
  • SHA accelerator
  • RNG
• System features
  • MMU
  • Efuse controller driver
  • Cache
  • Brownout Detector
  • OTA
• Tools
  • idf.py
  • esptool.py
• Debugging
  • JTAG debugging with OpenOCD
• Protocols
  • Provisioning

ESP32-H2 SoC

• Added support for ESP32-H2-beta2

Extended support of existing SoC's

ESP32-S3 SoC

• Added PMS bus-based memory access protection for ESP32-S3
• Added temperature sensor support on ESP32-S3
• PSRAM: Supported .bss on PSRAM on ESP32-S3
• Added support for ULP FSM for ESP32-S3
• trax: Added ESP32-S3 Support
• apptrace: Added ESP32-S3 Support
• Added support for using touch sensor in sleep modes on ESP32-S3

ESP32-C3 SoC

• Added support for ESP32-C3 ECO4
• Added support for semihosting on ESP32-C3

ESP32-S2 SoC

• PHY: Added support for ESP32-S2-ECO1 silicon

ESP32 SoC

• PSRAM: Added support on ESP32-D0WDR2-V3

Other features

• Pre-encrypted firmware distribution during OTA upgrades
• More robust security2 scheme (based on SRP6a+AES-GCM) in the WiFi provisioning component
• Integration of mbedTLS-3.x (3.2.1) stack
• Support for ECDSA based secure boot v2 scheme for ESP32-C2
• Included FreeRTOS SMP Kernel (upstream AWS version)
• More Wi-Fi features:
  • 802.11r (Fast BSS Transition)
  • PMF support for softAP
  • WPS registrar support in softAP
  • WPA3 OWE support for station
  • WPA3 SAE H2E support for station

Major Bug Fixes

• USB_SERIAL_JTAG: Can print through USB_SERIAL_JTAG port without change the config option from UART.
• Heap: Fixed a bug in the TLSF allocator returning a chunk of memory smaller than requested
• tcp-transport: Fixed potential null dereference if esp_transport_tcp_init is used separately.
• efuse: Fixed eFuse time settings issue on ESP32-C3
• efuse: Fixed eFuse time settings for ESP32-S3 chip
• I2C Master: Fixed watchdog timeout issue (#8543, #8120, #7281)
• Fixed POWER ON reset when using RTC IO as input in deepsleep on ESP32-S3.
• Fixed RTC memory lost in high temperature in deepsleep on ESP32-S3.
• Reduce power consumption in lightsleep when using 8MD256 as RTC slow clock, but not using LEDC clock source on ESP32-S3.
• Decreased power consumption in different use cases on ESP32-S3.
• Fixed dangerous power parameters in sleep modes on ESP32-S3.
• Updated chip revision print format in compliance with AR2022-005

Breaking Changes

External Libraries

• ASIO: Internal ASIO component and ASIO examples were migrated from IDF to https://github.com/espressif/esp-protocols/components/asio

Bluetooth

• Bluedroid: Changed API parameter for esp_bt_hf_init & esp_bt_hf_deinit
• Bluedroid: Renamed some macros/types/functions typos (see Bluetooth migration notes)
• NimBLE: Now esp_nimble_hci_and_controller_init is not accepted any more, just use nimble_port_init is ok, consistent with native nimble operations.

Build System

• driver component is not included by target components anymore. Applications using driver shall now explicitly require it in their CMakeLists.txt file
• efuse component is not included by target components anymore. Applications using efuse shall now explicitly require it in their CMakeLists.txt file
• Removed COMPILER_DISABLE_GCC8_WARNINGS option
• The "make" build system was deprecated in v4.0 in favor of idf.py (cmake). The remaining support is removed in v5.0.
• Adding non-existent directories to COMPONENT_DIRS or EXTRA_COMPONENT_DIRS is no longer supported and will result in an error.
• Kconfig option CONFIG_SDK_TOOLCHAIN_SUPPORTS_TIME_WIDE_64_BITS has been removed. The size of time_t type in the toolchain is determined automatically now. See "System Time" chapter of API reference for more information on 64/32-bit time_t support.
• Components which use esp_timer must add esp_timer to the requirements when calling idf_component_register
• Components which use lwip, vfs, esp_wifi, esp_event, esp_netif, esp_eth must add add these dependencies to the requirements list when calling idf_component_register.
• Removed Kconfig option SDK_TOOLPREFIX. Now the toolchain prefix can be fetched by CMake variable _CMAKE_TOOLCHAIN_PREFIX
• Removed the target components (e.g. esp32), it is no longer necessary to require this component in any CMakeLists.txt
• It is now necessary to specify PRIVATE, PUBLIC or INTERFACE in target_link_libraries calls to project_elf instead of leaving the default behavior
• Using CMake versions lower than 3.16 is not supported anymore. Run "tools/idf_tools.py install cmake" to install a suitable version if your OS versions doesn't have one.
• Format string warnings (-Wformat) are now enabled for Xtensa and RISC-V targets. This will result in warnings whenever uint32_t values are formatted using %u or %d format specifiers. The reason is that int32_t type is defined as long which was int in a past. The same is for uint32_t. To fix the warnings, do either one of the following: 1) Use PRIx32 specifier from inttypes.h instead of d or u. 2) Cast the values being formatted to unsigned int. 3) (Not recommended) add -Wno-format compiler flag to the files where this warning occurs using set_source_files_properties CMake function.

Networking

• esp_https_server: Now servercert variable inherits role of cacert variable
• esp_https_server: Now cacert variable inherits role of client_verify_cert_pem variable
• esp_https_server: The return type of the httpd_ssl_stop API has been changed to esp_err_t from void.
• esp_http_server: http_server.h header is no longer available in esp_http_server.
• esp-netif: Removed tcpip_adapter compatibility layer, please use esp_netif component directly.
• esp_netif/esp_wifi: The API esp_netif_get_sta_list() from esp_netif component has been migrated to esp_wifi component and renamed to esp_wifi_ap_get_sta_list_with_ip()
• Ethernet: esp_eth_ioctl third argument always acts as untyped pointer to memory now
• Ethernet: esp_eth_phy_new_ksz8041 and esp_eth_phy_new_ksz8081 functions were removed, use esp_eth_phy_new_ksz80xx instead. esp_eth_phy_new_lan8720 was removed, use esp_eth_phy_new_lan87xx instead.
• Ethernet: Removed deprecated esp_eth_set_default_handlers and esp_eth_clear_default_handlers functions
• Ethernet: Updated internal EMAC's API esp_eth_mac_new_esp32() to pass two configuration paramete...

ESP-IDF Pre-release v5.0-rc1

Documentation for pre-release IDF v5.0-rc1 is available at https://docs.espressif.com/projects/esp-idf/en/v5.0-rc1/

ESP-IDF v5.0 is a major update for ESP-IDF v4.x. Release v5.0 is mostly compatible with apps written for ESP-IDF v4.x, but there are some breaking changes (please consult the list below) and removal of deprecated functionality which will require code changes when updating projects. v5.0-rc1 is the release candidate. We will release v5.0 final release shortly after the release candidate.

We highly recommend referring to our migration guide while moving your apps from ESP-IDF v4.4 to v5.0-rc1 release.

Obtaining v5.0-rc1

For full installation instructions, see the ESP-IDF Programming Guide.

The source files attached to this release will not work due to our use of git submodules. Use one of the following methods instead:

Using git

To get this release, use the following commands:

git clone -b v5.0-rc1 --recursive https://github.com/espressif/esp-idf.git esp-idf-v5.0-rc1
cd esp-idf-v5.0-rc1/

This is the recommended way of obtaining v5.0-rc1 of ESP-IDF.

Download an archive with submodules included

Attached to this release is an esp-idf-v5.0-rv1.zip archive. It includes .git directory and all the submodules, so can be used out of the box. This archive is provided for users who have connectivity issues preventing them from cloning from GitHub.

This archive can also be downloaded from Espressif's download server:
https://dl.espressif.com/github_assets/espressif/esp-idf/releases/download/v5.0-rc1/esp-idf-v5.0-rc1.zip

Major changes

This is the list of changes since release v4.4:

Major New Features

Support of new SoC's

ESP32-C2 SoC

• Wi-Fi
  • 802.11 bgn mode
  • Station, SoftAP, sniffer mode
  • ESP-NOW
  • TX/RX AMPDU, TX/RX AMSDU
  • TX Fragment, TXOP
  • WEP/TKIP/CCMP
  • WPA/WPA2-PSK/WPA2-ENT/WPA3-PSK/WPA3-ENT
  • ESP-Touch v1/v2
  • Device Provisioning Protocol(DPP)
  • Network-assisted roaming using 802.11k (Radio Measurements), 802.11v (BTM) specifications and 802.11r (Fast BSS Transition)
  • Wi-Fi modem sleep and light sleep
• Bluetooth
  • BLE 5.0 Controller
  • HCI
  • NimBLE host with BLE 5.0
  • BLE modem sleep and light sleep
• Wi-Fi & BLE coexistence
  • Hardware arbiter based coexistence mechanism
  • Application scenarios based scheme coexistence mechanism
• Security
  • Secure boot
  • Flash encryption
  • ECC accelerator
  • RNG
• Peripherals
  • LCD driver
  • GDMA
  • GPIO driver
  • I2C
  • LEDC driver
  • memory copy by DMA
  • Dedicated GPIO driver
  • GPTimer driver
  • SPI Flash driver
  • GPSPI
  • UART
  • Temperature Sensor driver
• Power management
  • Dynamic Frequency Scaling
  • Light Sleep
  • Deep Sleep
  • Auto Light Sleep
• Security Features
  • Secure boot
  • Flash encryption
  • ECC accelerator
  • SHA accelerator
  • RNG
• System features
  • MMU
  • Efuse controller driver
  • Cache
  • Brownout Detector
  • OTA
• Tools
  • idf.py
  • esptool.py
• Debugging
  • JTAG debugging with OpenOCD
• Protocols
  • Provisioning

ESP32-H2 SoC

• Added support for ESP32-H2-beta2

Extended support of existing SoC's

ESP32-S3 SoC

• Added PMS bus-based memory access protection for ESP32-S3
• Added temperature sensor support on ESP32-S3
• PSRAM: Supported .bss on PSRAM on ESP32-S3
• Added support for ULP FSM for ESP32-S3
• trax: Added ESP32-S3 Support
• apptrace: Added ESP32-S3 Support
• Added support for using touch sensor in sleep modes on ESP32-S3

ESP32-C3 SoC

• Added support for ESP32-C3 ECO4
• Added support for semihosting on ESP32-C3

ESP32-S2 SoC

• PHY: Added support for ESP32-S2-ECO1 silicon

ESP32 SoC

• PSRAM: Added support on ESP32-D0WDR2-V3

Other features

• Pre-encrypted firmware distribution during OTA upgrades
• More robust security2 scheme (based on SRP6a+AES-GCM) in the WiFi provisioning component
• Integration of mbedTLS-3.x (3.2.1) stack
• Support for ECDSA based secure boot v2 scheme for ESP32-C2
• Included FreeRTOS SMP Kernel (upstream AWS version)
• More Wi-Fi features:
  • 802.11r (Fast BSS Transition)
  • PMF support for softAP
  • WPS registrar support in softAP
  • WPA3 OWE support for station
  • WPA3 SAE H2E support for station

Major Bug Fixes

• USB_SERIAL_JTAG: Can print through USB_SER_JTAG port without change the config option from UART.
• Heap: Fixed a bug in the TLSF allocator returning a chunk of memory smaller than requested
• tcp-transport: Fixed potential null dereference if esp_transport_tcp_init is used separately.
• efuse: Fixed eFuse time settings issue on ESP32-C3
• efuse: Fixed eFuse time settings for ESP32-S3 chip
• I2C Master: Fixed watchdog timeout issue (#8543, #8120, #7281)
• Fixed POWER ON reset when using RTC IO as input in deepsleep on ESP32-S3.
• Fixed RTC memory lost in high temperature in deepsleep on ESP32-S3.
• Reduce power consumption in lightsleep when using 8MD256 as RTC slow clock, but not using LEDC clock source on ESP32-S3.
• Decreased power consumption in different use cases on ESP32-S3.
• Fixed dangerous power parameters in sleep modes on ESP32-S3.

Breaking Changes

External Libraries

• ASIO: Internal ASIO component and ASIO examples were migrated from IDF to https://github.com/espressif/esp-protocols/components/asio

Bluetooth

• Bluedroid: Changed API parameter for esp_bt_hf_init & esp_bt_hf_deinit
• Bluedroid: Renamed some macros/types/functions typos (see Bluetooth migration notes)
• NimBLE: Now esp_nimble_hci_and_controller_init is not accepted any more, just use nimble_port_init is ok, consistent with native nimble operations.

Build System

• driver component is not included by target components anymore. Applications using driver shall now explicitly require it in their CMakeLists.txt file
• efuse component is not included by target components anymore. Applications using efuse shall now explicitly require it in their CMakeLists.txt file
• Removed COMPILER_DISABLE_GCC8_WARNINGS option
• The "make" build system was deprecated in v4.0 in favor of idf.py (cmake). The remaining support is removed in v5.0.
• Adding non-existent directories to COMPONENT_DIRS or EXTRA_COMPONENT_DIRS is no longer supported and will result in an error.
• Kconfig option CONFIG_SDK_TOOLCHAIN_SUPPORTS_TIME_WIDE_64_BITS has been removed. The size of time_t type in the toolchain is determined automatically now. See "System Time" chapter of API reference for more information on 64/32-bit time_t support.
• Components which use esp_timer must add esp_timer to the requirements when calling idf_component_register
• Components which use lwip, vfs, esp_wifi, esp_event, esp_netif, esp_eth must add add these dependencies to the requirements list when calling idf_component_register.
• Removed Kconfig option SDK_TOOLPREFIX. Now the toolchain prefix can be fetched by CMake variable _CMAKE_TOOLCHAIN_PREFIX
• Removed the target components (e.g. esp32), it is no longer necessary to require this component in any CMakeLists.txt
• It is now necessary to specify PRIVATE, PUBLIC or INTERFACE in target_link_libraries calls to project_elf instead of leaving the default behavior
• Using CMake versions lower than 3.16 is not supported anymore. Run "tools/idf_tools.py install cmake" to install a suitable version if your OS versions doesn't have one.
• Format string warnings (-Wformat) are now enabled for Xtensa and RISC-V targets. This will result in warnings whenever uint32_t values are formatted using %u or %d format specifiers. The reason is that int32_t type is defined as long which was int in a past. The same is for uint32_t. To fix the warnings, do either one of the following: 1) Use PRIx32 specifier from inttypes.h instead of d or u. 2) Cast the values being formatted to unsigned int. 3) (Not recommended) add -Wno-format compiler flag to the files where this warning occurs using set_source_files_properties CMake function.

Networking

• esp_https_server: Now servercert variable inherits role of cacert variable
• esp_https_server: Now cacert variable inherits role of client_verify_cert_pem variable
• esp_https_server: The return type of the httpd_ssl_stop API has been changed to esp_err_t from void.
• esp_http_server: http_server.h header is no longer available in esp_http_server.
• esp-netif: Removed tcpip_adapter compatibility layer, please use esp_netif component directly.
• esp_netif/esp_wifi: The API esp_netif_get_sta_list() from esp_netif component has been migrated to esp_wifi component and renamed to esp_wifi_ap_get_sta_list_with_ip()
• Ethernet: esp_eth_ioctl third argument always acts as untyped pointer to memory now
• Ethernet: esp_eth_phy_new_ksz8041 and esp_eth_phy_new_ksz8081 functions were removed, use esp_eth_phy_new_ksz80xx instead. esp_eth_phy_new_lan8720 was removed, use esp_eth_phy_new_lan87xx instead.
• Ethernet: Removed deprecated esp_eth_set_default_handlers and esp_eth_clear_default_handlers functions
• Ethernet: Updated internal EMAC's API esp_eth_mac_new_esp32() to pass two configuration parameters: One general driver's config of eth_mac_config_t type and the other one describes vendor specific options (eth_esp32_emac_t type), ...

ESP-IDF Release v4.4.3

Documentation for IDF v4.4.3 is available at https://docs.espressif.com/projects/esp-idf/en/v4.4.3/

ESP-IDF v4.4.3 is a bugfix update for ESP-IDF v4.4.

Obtaining v4.4.3

For full installation instructions, see the ESP-IDF Programming Guide.

The source files attached to this release will not work due to our use of git submodules. Use one of the following methods instead:

Using git

To get this release, use the following commands:

git clone -b v4.4.3 --recursive https://github.com/espressif/esp-idf.git esp-idf-v4.4.3
cd esp-idf-v4.4.3/

This is the recommended way of obtaining v4.4.3 of ESP-IDF.

Download an archive with submodules included

Attached to this release is an esp-idf-v4.4.3.zip archive. It includes .git directory and all the submodules, so can be used out of the box. This archive is provided for users who have connectivity issues preventing them from cloning from GitHub.

This archive can also be downloaded from Espressif's download server:
https://dl.espressif.com/github_assets/espressif/esp-idf/releases/download/v4.4.3/esp-idf-v4.4.3.zip

Major changes

This is the list of changes since release v4.4.2:

Major Bug Fixes

• Fixed deadlock due to wrong parameter when calling btc_transfer_context() after calling esp_bluedroid_disable() (#9672)

Breaking Changes

• FreeRTOS: esp_ringbuf function placement in flash is no longer controlled by CONFIG_FREERTOS_PLACE_FUNCTIONS_INTO_FLASH. New options have been introduced to control esp_ringbuf placement: CONFIG_RINGBUF_PLACE_FUNCTIONS_INTO_FLASH, CONFIG_RINGBUF_PLACE_ISR_FUNCTIONS_INTO_FLASH.

Changelog

Bluetooth

Controller

Added

• Added support to use main crystal as Bluetooth lowe power clock in light sleep bluetooth support on ESP32-C3 and ESP32-S3

Fixed

• Fixed the issue of Bluetooth disconnection due to not backing up Bluetooth AGC related registers when light sleep is enabled and baseband power down on ESP32-C3 and ESP32-S3
• Fixed the issue that FreeRTOS semaphores and queues used in Blueotooth ISRs can be allocated in SPIRAM which causes crash

Bluetooth Low Energy

Added

• Added ADV mode error check in ADV RX interrupt handler function on ESP32-C3 and ESP32-S3

Changed

• Updated BLE TX power level mapping on ESP32-C3 and ESP32-S3

Fixed

• Fixed BLE sch_arb assert on ESP32-C3 and ESP32-S3
• Fixed the performance issue of BLE sync scan in coexistence scenario when PLL track is enabled on ESP32-C3 and ESP32-S3
• Fixed BLE connection failed due to sync found was triggered incorrectly
• Fixed BLE disconnect failed due to LL_TERMINATE_IND have sent but no ACK is received
• Fixed BLE RAL_UNDERRUN and TX_CRYPT_ERR assert
• Fixed BLE disconnection issue when channel map instant passed due to bad channels on ESP32-C3 and ESP32-S3

Classic Bluetooth

Fixed

• Fixed that link key is not sent to host after re-pairing in legacy pairing mode on ESP32
• Fixed the exhaustion of ACL buffer in case of connection-disconnection stress test
• Fixed the duplicated reports of HCI_Connection_Request event from the same Bluetooth device

Bluedroid

Added

• Added new OSI utility "osi_event" to avoid duplicated message posting and thus reducing the workqueue size for HCI thread
• Added new OSI utilities "pkt_queue" and "fixed_pkt_queue" to for data buffer management and reduce the frequent allocation/free of small memory fragments compared with previous "fixed_queue"

Changed

• Modified the implementation of the workqueue of osi_thread using freeRTOS queue instead of fixed_queue, to reduce the use of system heap, and thus becoming more robust against memory allocation failure, and achieving better execution performance, with an increase of memory footprint by about 1600 Bytes during Bluedroid inititalization.

Fixed

• Fixed the linker error of functions not defined when enable memory debuging functionality
• Fixed deadlock due to wrong parameter when calling btc_transfer_context() after calling esp_bluedroid_disable().(#9672)
• Fixed the build warning in using strncpy after toolchain is upgraded

Classic Bluetooth

Fixed

• HFP: fixed the failure of 'connect audio' operation in HFP examples with default SDK configuration
• A2DP: fixed sink device not being able to accept and decode mono channel audio stream

Bluetooth Low Energy

Added

• Support BLE Micro definition in a header file

Changed

• Optimized BLE legacy advertising report datapath and advertising report flow control mechanism, make it more robust in case of heap exahustion.
• Modified the bluetooth device name length limits
• Updated BLE enum with the long form of value IR and ER

Fixed

• Fixed bluedroid host memory overflow
• Fixed set extend advertising parameters failed when stop extend advertising
• Fixed extend advertising set remove failed
• Fixed calling esp_ble_get_cur_sendable_packets_num() sometimes crashes when bluetooth is disconnecting
• Fixed extend ADV TX power range error
• Fixed repeatedly data length set error
• Fixed second bonding fail issue

NimBLE

Added

• Added check to deregister stack callback with controller during stack deinit

Changed

• Enable ANS service by default in nimble peripheral example
• Updated debug level for a print to avoid unwanted console log

Fixed

• Fixed memory corruption introduced in reconnection attempt code

ESP-BLE-Mesh

• Added an option for LPN to subscribe all-nodes-address automatically
• Fixed Friend not relay LPN message when relay feature is disabled
• Fixed handling continuously received secure update in friend queue
• Fixed using wrong range for Heartbeat Publication Period Log value
• Fixed using wrong count_log when Heartbeat Subscription Status is sent
• Fixed not ignoring connectable PB-ADV PDU containing a Link Open message
• Fixed ignoring KR flag within Secure Network Beacon from non-primary subnet
• Fixed the sequence of checking invalid Provisioning PDU type
• Fixed not checking invalid link flag during PB-GATT provisioning
• Fixed wrongly overwritten the expect_ack_for flag after send_pub_key
• Fixed not checking if AppKey is bound to model during model publication set
• Fixed the regression introduced in the btc_transfer_context changes

Wi-Fi

Added

• Added support for SAE H2E for station

Changed

• Optimized station power save when beacon loss happens
• Optimized noise check timer process, align it to TBTT time
• Updated wifi country code docs

Fixed

• Fixed crash by calling API esp_wifi_set_ant_gpio on esp32s2/esp32c3/esp32c3.
• Fixed write to null pointer if malloc failed
• Fixed possible memory leak if log level not set
• Fixed pairwise cipher tkip pmf compability issue
• Installed gtk before send group key handshake message 2
• Fixed disconnection when set country
• Fixed set country code before wifi start issue
• Fixed repeated scans causing bss overwrite in connect process
• Fixed fail to scan after recv disassoc/deauth for ESP32-S2.
• Fixed deinit return wrong value.
• Fixed get wrong channel value when use esp_wifi_get_config.
• Fixed bug of missing unlock when wifi stop in fail case.
• Fixed annotation error of api esp_wifi_connect.

Security

Fixed

• esp_rsa_sign_alt: Fixed the behaviour of esp_ds_init_data_ctx API when ds_data is provided directly from the flash.

Peripheral Drivers

Added

• ESP_LCD: Added SPI read support into the esp_lcd component
• ESP_LCD: Write I2C can send without param (when it is -1)
• RGB_LCD: Support PCLK fractional divisor for RGB LCD

Fixed

• ADC: Fixed wrong ADC continuous mode sampling frequency issue on ESP32
• ADC: Fixed wrong ADC bytes per conversion on ESP32-S2
• ADC: Fixed wrong ADC output resolution issue on ESP32-S3
• I2C: Reduced the delay between transactions
• I2C: Correct I2C clock frequency on ESP32-C3, ESP32-S3
• I2S: Fixed the bugs in only_right format and left_right format on ESP32.
• I2S: Fixed PDM RX sample rate doubled issue (#8660)
• I2S: Fixed the i2s event queue Q_OVF event condition
• I2S: Fixed the gap in the i2s_adc_dac example (#9389)
• RTC I2C: Corrected the register base addr reference for RTC I2C on esp32s3
• PSRAM: Fixed 40MHz PSRAM CS signal glitch issue on ESP32
• PSRAM: Fixed heap pool reservation for DMA/internal usage fail issue
• esp_hw_support: Fixed wrong RC_FAST and RC_SLOW clock frequency values on ESP32-C3 and ESP32-S3
• esp_hw_support: Auto-adjust LDO voltage to reduce the power consumption of ESP32S3 chips
• GPIO: Fixed the issue on ESP32 that GPIO can't hold on after deep sleep
• GPIO: Fixed the bug that ESP32-S3 GPIO48 does not support hold function
• GPIO: Fixed the issue that USB DP pullup can't be disabled when it's used as a normal GPIO (#9495)
• Timer: Propagate interrupt service allocation error (#9651)
• MCPWM: Fixed multiplication overflow in mcpwm_set_duty_in_us (#9648)
• Temperature Sensor: Fixed the issue that the value is not accurate on ESP32-S3
• ESP LCD: Fixed incorrect bpp size of RGB666 color format (#9729)
• SPI Master: Fixed an issue on ESP32-S2, ESP32-S3, ESP32-C3 that more than 3 devices can't be added to the SPI2 Host(#8876)
• SPI Bus: Fixed a concurrency issue leading to spi_device_polling_end assertion fail (https://github.com/espressif/esp-idf/issues/...

ESP-IDF Release v4.3.4

Documentation for IDF v4.3.4 is available at https://docs.espressif.com/projects/esp-idf/en/v4.3.4/

ESP-IDF v4.3.4 is a bugfix update for ESP-IDF v4.3. ESP-IDF v4.4.2 is the latest stable release at the time of writing.

Obtaining v4.3.4

For full installation instructions, see the ESP-IDF Programming Guide.

The source files attached to this release will not work due to our use of git submodules. Use one of the following methods instead:

Using git

To get this release, use the following commands:

git clone -b v4.3.4 --recursive https://github.com/espressif/esp-idf.git esp-idf-v4.3.4
cd esp-idf-v4.3.4/

This is the recommended way of obtaining v4.3.4 of ESP-IDF.

Download an archive with submodules included

Attached to this release is an esp-idf-v4.3.4.zip archive. It includes .git directory and all the submodules, so can be used out of the box. This archive is provided for users who have connectivity issues preventing them from cloning from GitHub.

This archive can also be downloaded from Espressif's download server: https://dl.espressif.com/github_assets/espressif/esp-idf/releases/download/v4.3.4/esp-idf-v4.3.4.zip

Major changes

This is the list of changes since release v4.3.3:

Major Bug Fixes

• efuse (ESP32): Fixed burn operation when data was written directly to regs. This was regression from v4.3.3 release and it was causing secure boot workflow to fail. Please see #9290 and #9333 for more details.

Breaking Changes

• esp_crt_bundle: "esp_crt_bundle_set" API now has additional argument bundle_size and now returns esp_err_t.

Changelog

This is the list of changes since release v4.3.3.

Bluetooth

Controller

Added

• Added UHCI example to ESP32-C3, used for Bluetooth Controller only mode through HCI UART transport
• Added support to use main crystal as Bluetooth sleep clock to be used in SoC light sleep on ESP32-C3
• Power down Bluetooth module upon de-initializaing Bluetooth controller for ESP32-C3 and ESP32-S3

Changed

• Initialize all elements of esp_bt_controller_config_t. (#9073)

Fixed

• Fixed that functions used in light sleep wake-up procedure are not put in IRAM, which causes RTC watchdog timeout on ESP32-C3
• Fixed that FreeRTOS semaphores and queues used by Bluetooth Controller are created in SPIRAM, which causes software crash when handling ISRs
• Fixed missing in processing VHCI interrupt caused by lack of protection against race conditions in accessing VHCI environment variables on ESP32

• Fixed the issue of Bluetooth disconnection due to not backing up Bluetooth AGC related registers when light sleep is enabled and baseband power down on ESP32-C3 and ESP32-S3

Bluetooth Low Energy

Added

• Add description for de-initialize bt controller API

Fixed

• Fixed BLE got disconnected when when modem sleep is disabled and Bluetooth is initialized after Wi-Fi on ESP32-C3 and ESP32-S3
• Fixed BLE ke_mem.c assert on ESP32
• Fixed BLE ke_mem.c assert on ESP32-C3
• Fixed BLE advertising report on ESP32-C3

Classic Bluetooth

Fixed

• Fixed the issue during legacy pairing procedure that controller does not report link key to Host on ESP32
• Fixed the task watchdog issue during controller initialization due to invalid hardware state after system reset on ESP32-C3
• Fixed the assertion in function em_bt_clkoff1_setf when clock overflow happened, the overflow can be safely ignored
• Allow max supported feature page lower than current feature page when handle with the respond of extend features to support for some devices which generate wrongly LMP respond.
• Fixed the EDR mode wrongly cleared by a successful role switch which caused that the 2M/3M package type can not be selected for use.
• Fixed the crash in accessing bt_util_buf_env buffer list due to lack of protection against race condition when operating on the linked list in context of both task and interrupt service routine

Bluedroid

Added

• Added new OSI utility "osi_event" to avoid duplicated message posting and thus reducing the workqueue size for HCI thread.
• Added new OSI utilities "pkt_queue" and "fixed_pkt_queue" to for data buffer management and reduce the frequent allocation/free of small memory fragments compared with previous "fixed_queue".

Changed

• Modified the implementation of the workqueue of osi_thread using freeRTOS queue instead of fixed_queue, to reduce the use of system heap, and thus becoming more robust against memory allocation failure, and achieving better execution performance, with an increase of memory footprint by about 1600 Bytes during Bluedroid inititalization.

Fixed

• Fixed the linker error of functions not defined when memory debug is enabled

Classic Bluetooth

Added

• Added Bluetooth device address field in the parameter structure of ESP_BT_GAP_READ_REMOTE_NAME_EVT callback event

Changed

• Updated HFP_AG version to 1.7.2

Fixed

• A2DP: Fixed AVDTP general reject format error
• A2DP: Fixed the A2DP source example application state machine in the processing of inquiry response, which can result in the failure of stopping device discovery
• A2DP: Fixed A2DP sink example that audio playback is clogged due to higher priority of application task in case of heavy workload from the task
• Fixed the default sdkconfig file for HFP examples that causes failure of 'connect audio' operation
• Fixed type redefinitions in btc_spp.h and btc_hd.h/btc_hh.h

Bluetooth Low Energy

Changed

• Optimized BLE legacy advertising report datapath and advertising report flow control mechanism, make it more robust in case of heap exahustion.

Fixed

• Fixed BLE sync periodic advertising report will lose data
• Fixed bluedroid BLE extend advertising parameters detection
• Fixed bluedroid host memory overflow
• Fixed compilation error when BLE5.0 is enabled
• Fixed the linker error of functions not defined when enable memory debug. The according function definitions is included by a macro but the .c file has no access to the macro. Solve the problem by including the macro definition

NimBLE

Added

• Added changes for mbedTLS v3.1.0

Fixed

• Added check to free keypair if already allocated to avoid memory leak
• Corrected function declaration in crypto header.
• Fixed rep-airing issue by clearing device record.
• Sync sending Host Number of Completed Packets command

Blufi

Fixed

• Fixed an issue that Softap mode do not assign ip
• Fixed an issue that SoftAP current connection always show 0

ESP-BLE-Mesh

• Fixed continuously putting secure update into friend queue
• Fixed friend relay lpn message when relay feature is disable
• Fixed the count_log field should be 0 when HBS is sent
• Fixed not ignoring connectable PB-ADV PDU with Link Open
• Fixed key refresh from non-primary subnet been ignored
• Fixed the sequence of invalid provisioning pdu type check
• Fixed not checking invalid link flag during PB-GATT
• Fixed overwriting the expect_ack_for after sending Public Key
• Added a check if AppKey is bound to model while setting publication
• Fixed the Heartbeat Publication Period Log value range

PHY

Fixed

• Fixed memory leak in phy
• Init phy data to default if invalid in flash partition to avoid bootloops

Wi-Fi

Added

• Added APIs to check for BTM, RRM support of connected AP
• Added changes for unicast key renew for TKIP mic failure
• Added ht40 support for esp_wifi_80211_tx.
• Connect example: Add scan mode config

Changed

• Optimized example of wifi station
• Updated Wi-Fi CSI docs
• Updated Wi-Fi beacon timeout docs
• Updated Wi-Fi multiple antennas docs
• Updated wpa2_enterprise certificates

Fixed

• Fixed a possible packet miss caused PTK install delay
• Fixed a bug that if sniffer not closed wifi stop will fail
• Fixed a bug that QoS Null updated the BA SSN which cause some packets lost
• Fixed wrong default static TX buffer number when not configured
• Clear old keys before going for new connection
• Do not use pmkid caching when SSID is changed
• Fixed a bug when ftm used with ps enabled
• Fixed a potential issue to allocate PSRAM to wifi stack where internal RAM is required
• Fixed crashed when esp_wifi_set_ant_gpio() called on chip esp32s2/esp32c3
• Fixed deep sleep can't reconnect to ap when pmf enable
• Fixed esp-now recv unencrypted packets issue
• Fixed the wrong suggestion of method in NAK for all the methods (#7769)
• Fixed handling of key RSC
• Fixed issue of default ap ssid is not getting set
• Fixed linker script issue where noflash scheme was applied to wifi_apb80m_request() and wifi_apb80m_release() even when CONFIG_PM_ENABLE was not enabled
• Fixed not update phy according to country code.
• Fixed possible memory leak if report level not set
• Fixed potential fail to scan AP after receiving disassoc/deauth from AP on ESP32-S2
• Fixed phy init failure when wifi deinit
• Fixed smartconfig esptouch v2 found none fail issue
• Fixed some ap will ignore auth when rx deauth for a while
• Fixed static analysis issues
• Fixed WAPI Key mgmt compatible issue
• Fixed Wi-Fi and bt power domain leakage current in light sleep
• Fixed write to null pointer if malloc failed
• Ignore unauthenticated encrypted EAPOL-Key data
• Multiple bugfixes in SoftAP and Station PMF
• Reset beacon timeout timer when keep alive null works or hw drop beacon

Peripheral Drivers

Changed

• I2C_MASTER: Output clock frequency calculation is optimized to be more accurate (#8770)
• I2...

ESP-IDF Release v4.2.4

Documentation for IDF v4.2.4 is available at https://docs.espressif.com/projects/esp-idf/en/v4.2.4/

ESP-IDF v4.2.4 is a bugfix update for ESP-IDF v4.2.

Obtaining v4.2.4

For full installation instructions, see the ESP-IDF Programming Guide.

The source files attached to this release will not work due to our use of git submodules. Use one of the following methods instead:

Using git

To get this release, use the following commands:

git clone -b v4.2.4 --recursive https://github.com/espressif/esp-idf.git esp-idf-v4.2.4
cd esp-idf-v4.2.4/

This is the recommended way of obtaining v4.2.4 of ESP-IDF.

Download an archive with submodules included

Attached to this release is an esp-idf-v4.2.4.zip archive. It includes .git directory and all the submodules, so can be used out of the box. This archive is provided for users who have connectivity issues preventing them from cloning from GitHub.

This archive can also be downloaded from Espressif's download server:
https://dl.espressif.com/github_assets/espressif/esp-idf/releases/download/v4.2.4/esp-idf-v4.2.4.zip

Major changes

This is the list of changes since release v4.2.3:

Major Bug Fixes

• efuse: Validate written data after burning and re-burns it if necessary. This avoids potential and rare issue with incorrect efuse programming on some modules (it was observed with failure rate 0.59% on one of the production site)

Breaking Changes

• WI-FI: Disabling PMF in Station configuration no longer possible, Station will always connect in PMF Mode if AP advertises support

Changelog

Bluetooth

Controller

Fixed

• Fixed missing in processing VHCI interrupt caused by lack of protection against race conditions in accessing VHCI environment variables
• Make sure semphr/queue used in interrupt is in DRAM

Bluetooth Low Energy

Fixed

• Fixed BLE ke_mem.c assert on ESP32

Classic Bluetooth

Fixed

• Fixed the crash issue in handling HCI_Exit_Sniff_Request command from Host when controller just switches to active mode
• Fixed the EDR mode wrongly cleared by a successful role switch which caused that the 2M/3M package type can not be selected for use
• Fixed LMP extended features exchange handling, allow max supported feature page number that is lower than current feature page number, to support wrong LMP response from specific devices

Bluedroid

Fixed

• Fixed the linker error of functions not defined when memory debug is enabled

Classic Bluetooth

Changed

• HF: Updated HFP_AG version to 1.7.2
• HF: Updated HFP_HF version to 1.7.2

Fixed

• A2DP: Fixed AVDTP general reject format error
• A2DP: Fixed in A2DP sink example that audio playback is clogged due to higher priority of application task in case of heavy workload from the task
• A2DP: Fixed the A2DP source example application state machine in the processing of inquiry response, which can result in the failure of stopping device discovery
• HID: Resolved type redefinitions in btc_spp.h and btc_hd.h/btc_hh.h
• SPP: Fixed SPP initiator can not free resources when the connection fails
• SPP: Fixed SPP crash after calling esp_spp_deinit
• SPP: Fixed SPP initialization failure without free mutex
• GAP: Added Bluetooth address field in the parameter structure of ESP_BT_GAP_READ_REMOTE_NAME_EVT callback event

Bluetooth Low Energy

Fixed

• Fixed bluedroid host memory overflow

ESP-BLE-Mesh

• Fixed not checking the oversized SegN during provisioning

Wi-Fi

Added

• Always connect Station in PMF mode if possible, added a separate PMF disable API

Changed

• Updated wpa2_enterprise certificates
• Updated wifi CSI docs
• Updated wifi multiple antennas docs
• Updated wifi header file

Fixed

• Added changes for unicast key renew for TKIP mic failure
• Fixed the bug that wifi not stopped correctly if sniffer mode not disabled
• Fixed the bug that QoS Null updated BA SSN
• Fixed the bug that the wrong default static TX buffer number if it is not configured
• Do not use pmkid caching when SSID is changed
• Fixed Assoc comeback causing invalid state bug
• Fixed clearing default wifi netif procedure
• Fixed deep sleep can't reconnect to ap when pmf enable
• Fixed handling of key RSC
• Fixed issue reported by static analyser
• Fixed some ap will ignore auth when rx deauth for a while
• Fixed static analysis issues
• Fixed the wrong suggestion of method in NAK for all the methods (#7769)
• Fixed write to null pointer if malloc failed
• Ignore unauthenticated encrypted EAPOL-Key data
• Multiple bugfixes in SoftAP and Station PMF

ESP-WIFI-MESH

Added

• Added non mesh connections access

Peripheral Drivers

Added

• Freemodbus: Added the FMB_PORT_TASK_AFFINITY kconfig option for modbus tasks (#6700)

Changed

• Freemodbus: Changed the default value of FMB_TIMER_PORT_ENABLED to disabled
• SPI Flash: Decrease the IRAM usage of SPI Flash driver

Fixed

• ADC: Fixed ADC calibration error after waking up from light sleep
• Freemodbus: Fixed uart_set_pin() check error in modbus master serial example
• Freemodbus: Fixed master and slave use the same timer group index (#4699)
• Freemodbus: Fixed slave destroy bug when master and slave init simultaneously
• GPIO: Fixed the issue that config struct is not properly initialized
• GPIO: Fixed some gpio pin num errors on ESP32-S2
• I2S: Fixed the write failure issue in 32bit slave mode
• LEDC: Fixed ledc_set_duty failed to take effect when called frequently (#7288)
• LEDC: Fixed incorrect fading behaviour with LEDC_FADE_NO_WAIT fade mode (#6710)
• PSRAM: Fixed heap pool reservation for DMA/internal usage fail issue.
• SDIO Slave: Fixed the issue that interrupt may be cleared with finished trans unhandled
• SPI: Fixed crash calling spi_bus_free when not initialized (#8642)
• SPI: Fixed master HD DMA mode cannot correctly receive data when a TX (no RX) transaction is done
• SPI Master: Fixed the error log when using SPI_TRANS_USE_TXDATA or SPI_TRANS_USE_RXDATA with data longer than expect
• Timer Group: Reset timer group peripheral in timer_init() function (#6466)
• TWAI: Added detection and handling of RX FIFO overrun condition
• TWAI: Added workarounds for hardware errata on the ESP32 (#2519)
• UART: Fixed the incorrect channel num on ESP32-S2
• UART: Fixed RTS mis-reset before sending caused by context switch (#4178)
• USB: Fixed issue that swapped pins not working through HAL
• XTAL: Fixed xtal 32k not oscillate or oscillate too slowly issue for ESP32

Core System

Fixed

• efuse: Validate written data after burning and re-burns it if necessary
• efuse (ESP32): Fixed burn operation when data was written directly to regs
• Fixed peripheral clock being undesirably disabled during cpu reset for ESP32-S2
• Fixed pm lock bug in dual core mode

FreeRTOS

Fixed

• Fixed bug in Xtensa FreeRTOS port where extra threadptr CPU was not being saved on solicited context switches
• Fixed bug in event group functions where the blocked task list was being accessed without acquiring the task list spinlock

Power Management

Fixed

• Fixed cannot lightsleep again after a wakeup from ULP (#6229)
• Fixed driver using wrong print function in a critical section (#7942)
• Fixed _rtc_slow_length being incorrectly optimized by compiler
• pm_impl: Fixed neither enter light sleep nor enter "waiti" state in idle task

LWIP

Fixed

• Fixed that IPv6 DNS can not work

Bootloader

Added

• SPI Flash: Added unlock function patch in bootloader to make GD flash more stable
• SPI Flash: Support unlock for ISSI chips
• SPI Flash: Support unlock for MXIC chips

Changed

• Enable write protection to flash at end of bootloader to increase stability
• Improved XMC flash stabilities as main flash

Fixed

• Avoid unnecessary WRSR operation to flash to increase stability
• Fixed the issue custom uart gpio doesn't take effect

Removed

Storage

Fixed

• mmap: Fixed the issue mmap cannot be called with pointers to psram
• nvs: Fixed issues found by Coverity

Tools

Added

• Docker: Added build arguments to reduce the image size: IDF_CLONE_SHALLOW and IDF_INSTALL_TARGETS
• idf.py: Added IDF component manager beta version. Dependencies listed in idf_component.yml manifest are downloaded automatically.

Fixed

• IDF Monitor should flash with the same and unmodified port it was invoked with (#8432)

Build System

Changed

• Enable the component manager for pure CMake builds by default

Documentation

Fixed

• FreeRTOS: Fixed broken links in queue.h

ESP-IDF Pre-release v5.0-beta1

Documentation for pre-release v5.0-beta1 is available at https://docs.espressif.com/projects/esp-idf/en/v5.0-beta1/

ESP-IDF v5.0 is a major update for ESP-IDF v4.x. Release v5.0 is mostly compatible with apps written for ESP-IDF v4.x, but there are some breaking changes (please consult the list below) and removal of deprecated functionality which will require code changes when updating projects.

We highly recommend referring to the migration guide while moving your apps from ESP-IDF v4.4 to v5.0 release.

Obtaining v5.0-beta1

For full installation instructions, see the ESP-IDF Programming Guide.

The source files attached to this release will not work due to our use of git submodules. Use one of the following methods instead:

Using git

To get this release, use the following commands:

git clone -b v5.0-beta1 --recursive https://github.com/espressif/esp-idf.git esp-idf-v5.0-beta1
cd esp-idf-v5.0-beta1/

This is the recommended way of obtaining v5.0-beta1 of ESP-IDF.

Download an archive with submodules included

Attached to this release is an esp-idf-v5.0-beta1.zip archive. It includes .git directory and all the submodules, so can be used out of the box. This archive is provided for users who have connectivity issues preventing them from cloning from GitHub.

This archive can also be downloaded from Espressif's download server:
https://dl.espressif.com/github_assets/espressif/esp-idf/releases/download/v5.0/esp-idf-v5.0-beta1.zip

Major changes

This is the list of changes since release v4.4:

Major New Features

Support of new SoCs

Support for ESP32-C2 SoC

• Wi-Fi
  • 802.11 bgn mode
  • Station, SoftAP, sniffer mode
  • ESP-NOW
  • TX/RX AMPDU, TX/RX AMSDU
  • TX Fragment, TXOP
  • WEP/TKIP/CCMP
  • WPA/WPA2-PSK/WPA2-ENT/WPA3-PSK/WPA3-ENT
  • ESP-Touch v1/v2
  • Device Provisioning Protocol(DPP)
  • Network-assisted roaming using 802.11k (Radio Measurements), 802.11v (BTM) specifications and 802.11r (Fast BSS Transition)
  • Wi-Fi modem sleep and light sleep
• Bluetooth
  • BLE 5.0 Controller
  • HCI
  • NimBLE host with BLE 5.0
  • BLE modem sleep and light sleep
• Wi-Fi & BLE coexistence
  • Hardware arbiter based coexistence mechanism
  • Application scenarios based scheme coexistence mechanism
• Security
  • Secure boot
  • Flash encryption
  • ECC accelerator
  • RNG
• Peripherals
  • LCD driver
  • GDMA
  • GPIO driver
  • I2C
  • LEDC driver
  • memory copy by DMA
  • Dedicated GPIO driver
  • GPTimer driver
  • SPI Flash driver
  • GPSPI
  • UART
  • Temperature Sensor driver
• Power management
  • Dynamic Frequency Scaling
  • Light Sleep
  • Deep Sleep
  • Auto Light Sleep
• Security Features
  • Secure boot
  • Flash encryption
  • ECC accelerator
  • SHA accelerator
  • RNG
• System features
  • MMU
  • Efuse controller driver
  • Cache
  • Brownout Detector
  • OTA
• Tools
  • idf.py
  • esptool.py
• Debugging
  • JTAG debugging with OpenOCD
• Protocols
  • Provisioning

Preview support for ESP32-H2 SoC

• Added support for ESP32-H2-beta2

Extended support of existing SoCs

ESP32-S3 SoC

• Added PMS bus-based memory access protection for ESP32-S3
• Added temperature sensor support on ESP32-S3
• PSRAM: Supported .bss on PSRAM on ESP32-S3
• Added support for ULP FSM for ESP32-S3
• trax: Added ESP32-S3 Support
• apptrace: Added ESP32-S3 Support
• Added support for using touch sensor in sleep modes on ESP32-S3

ESP32-C3 SoC

• Added support for ESP32-C3 ECO4
• Added support for semihosting on ESP32-C3

ESP32-S2 SoC

• PHY: Added support for ESP32-S2-ECO1 silicon

ESP32 SoC

• PSRAM: Added support on ESP32-D0WDR2-V3

Other features

• Included FreeRTOS SMP Kernel (upstream AWS version)
• New Wi-Fi features:
  • 802.11r (Fast BSS Transition)
  • PMF support for softAP
  • WPS registrar support in softAP
  • WPA3 OWE support for station
  • WPA3 SAE H2E support for station
• Toolchain updated to use GCC 11.2, GDB 11.2. Default language standards were upgraded from C11 to C17 and from C++11 to C++20.
• Added a tool to generate FAT filesystem images as part of the build process.

Major Bug Fixes

• USB_SERIAL_JTAG: Can print through USB_SERIAL_JTAG port without changing the config option from UART.
• Heap: Fixed a bug in the TLSF allocator returning a chunk of memory smaller than requested
• tcp-transport: Fixed potential null dereference if esp_transport_tcp_init is used separately.
• efuse: Fixed eFuse time settings issue on ESP32-C3
• efuse: Fixed eFuse times settings for ESP32-S3 chip
• I2C Master: Fixed watchdog timeout issue (#8543, #8120, #7281)
• Fixed POWER ON reset when using RTC IO as input in deepsleep on ESP32-S3.
• Fixed RTC memory lost in high temperature in deepsleep on ESP32-S3.
• Reduce power consumption in lightsleep when using 8MD256 as RTC slow clock, but not using LEDC clock source on ESP32-S3.
• Decreased power consumption in different use cases on ESP32-S3.
• Fixed dangerous power parameters in sleep modes on ESP32-S3.

Breaking Changes

Bluetooth

• Bluedroid: Changed API parameter for esp_bt_hf_init & esp_bt_hf_deinit
• Bluedroid: Renamed some macros/types/functions typos (see Bluetooth migration notes)
• NimBLE: Now esp_nimble_hci_and_controller_init is not accepted any more, just use nimble_port_init is ok, consistent with native nimble operations.

Build System

• The "make" build system was deprecated in v4.0 in favor of idf.py (cmake). The remaining support is removed in v5.0.
• driver component is not included by components/esp32* anymore. Applications using driver shall now explicitly require it in their CMakeLists.txt file
• efuse component is not included by components/esp32* anymore. Applications using efuse shall now explicitly require it in their CMakeLists.txt file
• Removed COMPILER_DISABLE_GCC8_WARNINGS option
• Adding non-existent directories to COMPONENT_DIRS or EXTRA_COMPONENT_DIRS is no longer supported and will result in an error.
• Kconfig option CONFIG_SDK_TOOLCHAIN_SUPPORTS_TIME_WIDE_64_BITS has been removed. The size of time_t type in the toolchain is determined automatically now. See "System Time" chapter of API reference for more information on 64/32-bit time_t support.
• Components which use esp_timer must add esp_timer to the requirements when calling idf_component_register
• Components which use lwip, vfs, esp_wifi, esp_event, esp_netif, esp_eth must add add these dependencies to the requirements list when calling idf_component_register.
• Removed Kconfig option SDK_TOOLPREFIX. Now the toolchain prefix can be fetched by CMake variable _CMAKE_TOOLCHAIN_PREFIX
• Removed the target components (e.g. esp32), it is no longer necessary to require this component in any CMakeLists.txt
• It is now necessary to specify PRIVATE, PUBLIC or INTERFACE in target_link_libraries calls to project_elf instead of leaving the default behavior
• Using CMake versions lower than 3.16 is not supported anymore. Run "tools/idf_tools.py install cmake" to install a suitable version if your OS versions doesn't have one.
• ESP-IDF v5.0 reorders the applying order of target-specific config files and other files listed in SDKCONFIG_DEFAULTS. Now, target-specific file will be applied right after the file bringing it in, before all latter files in SDKCONFIG_DEFAULTS. (see also ESP-IDF v5.0 migration guide)

Networking

• esp_https_server: Now servercert variable inherits role of cacert variable
• esp_https_server: Now cacert variable inherits role of client_verify_cert_pem variable
• esp_https_server: The return type of the httpd_ssl_stop API has been changed to esp_err_t from void.
• esp_http_server: http_server.h header is no longer available in esp_http_server.
• esp-netif: Removed tcpip_adapter compatibility layer, please use esp_netif component directly.
• esp_netif/esp_wifi: The API esp_netif_get_sta_list() from esp_netif component has been migrated to esp_wifi component and renamed to esp_wifi_ap_get_sta_list_with_ip()
• Ethernet: esp_eth_ioctl third argument always acts as untyped pointer to memory now
• Ethernet: esp_eth_phy_new_ksz8041 and esp_eth_phy_new_ksz8081 functions were removed, use esp_eth_phy_new_ksz80xx instead. esp_eth_phy_new_lan8720 was removed, use esp_eth_phy_new_lan87xx instead.
• Ethernet: Removed deprecated esp_eth_set_default_handlers and esp_eth_clear_default_handlers functions
• Ethernet: Updated internal EMAC's API esp_eth_mac_new_esp32() to pass two configuration parameters: One general driver's config of eth_mac_config_t type and the other one describes vendor specific options (eth_esp32_emac_t type), such as SMI IO, interface or clock.
• Ethernet: SPI Ethernet modules initialization changed
• http_parser: Create new component out of nghttp
• lwip: DHCP server callback has additional argument with client's info
• lwip: DHCP server API has been updated to accommodate object-oriented usage. All functions use DHCP server's handle pointer as their first parameter now.
• lwip: DHCP server API has been updated to return err_t error code in case of failure.
• nghttp: This component is now moved to idf-extra-components, will be used through component manager
• OpenSSL: Component has b...

ESP-IDF Release v4.4.2

Documentation for IDF v4.4.2 is available at https://docs.espressif.com/projects/esp-idf/en/v4.4.2/

ESP-IDF v4.4.2 is a bugfix update for ESP-IDF v4.4.

Obtaining v4.4.2

For full installation instructions, see the ESP-IDF Programming Guide.

The source files attached to this release will not work due to our use of git submodules. Use one of the following methods instead:

Using git

To get this release, use the following commands:

git clone -b v4.4.2 --recursive https://github.com/espressif/esp-idf.git esp-idf-v4.4.2
cd esp-idf-v4.4.2/

This is the recommended way of obtaining v4.4.2 of ESP-IDF.

Download an archive with submodules included

Attached to this release is an esp-idf-v4.4.2.zip archive. It includes .git directory and all the submodules, so can be used out of the box. This archive is provided for users who have connectivity issues preventing them from cloning from GitHub.

This archive can also be downloaded from Espressif's download server:
https://dl.espressif.com/github_assets/espressif/esp-idf/releases/download/v4.4.2/esp-idf-v4.4.2.zip

Major changes

This is the list of changes since release v4.4.1:

Major Bug Fixes

• LWIP: Added security fixes from upstream (CVE-2020-22283, CVE-2020-22284)

Breaking Changes

• esp_crt_bundle: esp_crt_bundle_set API now has additional argument bundle_size and now returns esp_err_t (#8397)
• Storage/VFS: 2nd parameter (absolute path) removed from the esp_vfs_semihost_register
• FreeRTOS: vTaskGetSnapshot now returns BaseType_t to indicate status

Known Issues

• On ESP32-S3, BLE may disconnect in extremely low temperature.

Changelog

This is the list of changes since release v4.4.1.

Bluetooth

Controller

Added

• Added critical protection for the operations on interrupt status of VHCI environment variables to avoid miss interrupt events.

Changed

• Reset Bluetooth baseband and MAC to fix the task watchdog triggered during controller initialization due to invalid hardware state after system reset on ESP32-C3 and ESP32-S3

Fixed

• Initialize all elements of esp_bt_controller_config_t
• Fixed BLE got disconnected when when modem sleep is disabled and Bluetooth is initialized after Wi-Fi on ESP32-C3 and ESP32-S3

Bluetooth Low Energy

Fixed

• Fixed the issue in libphy.a that Wi-Fi gets disconnected after Bluetooth is de-initialized
• Fixed BLE duplicate scan check error for mesh advertising report on ESP32-C3 and ESP32-S3
• Fixed BLE ke_mem.c assert on ESP32-C3 and ESP32-S3
• Fixed BLE ke_mem.c assert on ESP32

Classic Bluetooth

Fixed

• Fixed race condition when accessing bt_util_buf_env buffers in the context of both controller task and interrupt
• Fixed the EDR mode wrongly cleared by a successful role switch which caused that the 2M/3M package type can not be selected for use.
• Allow max supported feature page lower than current feature page when handle with the respond of extend features to support for some devices which generate wrongly LMP respond.
• Safely ignore the assert_err in em_bt_clkoff1_setf when the clock overflow

Bluedroid

Classic Bluetooth

Changed

• Updated HFP_AG version to 1.7.2
• Added bd_addr field to read_rmt_name_param

Fixed

• SPP: Fixed that SPP initiator can not free resources when the connection is failed
• A2DP: Fixed the failure of being reconnected in A2DP sink example due to the issue in using i2s driver
• HFP: Fixed the error in HFP(HF) example when performing audio disconnection (#7911)
• SPP: Fixed SPP crash after calling esp_spp_deinit
• SPP: Fixed SPP initialization failure without free mutex
• A2DP: Fixed AVDTP general reject format error
• A2DP: Fixed A2DP Sink wrong sniff parameters which caused by HID Porting
• A2DP: Fixed in A2DP sink example that audio playback is clogged due to higher priority of application task in case of heavy workload from the task
• Resolved type redefinitions in btc_spp.h and btc_hd.h/btc_hh.h
• HID: Fixed wrong parameter of get_report_by_id_and_type in bt_hidd.c
• Fixed the linker error of functions not defined when enable memory debug. The according function definitions is included by a macro but the .c file has no access to the macro. Solve the problem by including the macro definition.
• Fixed memory leak in esp_bt_hidh_dev_report_write and esp_bt_hidh_dev_set_report in bt_hidh.c
• Added status protection on the processing of inquiry scan result to avoid repeat discovery cancellation which may raise incorrect discovery

Bluetooth Low Energy

Added

• Added link role parameter for GATT disconnection event
• Added description for de-initialize bluetooth controller API

Fixed

• Fixed bluedroid BLE extend advertising parameters detection
• Fixed BLE extended advertising params check on bluedroid
• Fixed bluedroid host memory overflow
• Fixed BLE periodic advertising report will lose data
• Fixed compilation error when BLE v5.0 is enabled

NimBLE

Added

• Added check to free keypair if already allocated to avoid memory leak

Fixed

• Fixed bond not saved properly after re-pairing
• Sync sending Host Number of Completed Packets command

Blufi

Fixed

• Fixed an issue that SoftAP mode does not assign ip
• Fixed an issue that SoftAP current connection always shows 0

ESP-BLE-Mesh

• Added menuconfig for filtering packets with old SeqAuth
• Fixed not handling oversized SegN during provisioning

Wi-Fi

Added

• Added PMF disable API
• Added HT40 support for espnow & 80211_tx
• Added changes for unicast key renew for TKIP mic failure
• Added APIs to check for BTM, RRM support of connected AP

Changed

• Optimized PHY calibration time for ESP32-C3 and ESP32-S3
• Updated wpa2 enterprise certificates
• Enabled GCMP, GMAC for 192 bit configuration
• Updated wifi doc for espnow/LR/fix rate/disable 11b/multiple antennas
• Optimized example of wifi station
• esp_netif: Optimized the null pointer judgment of eb
• Updated regdomain max channel according to country info from nvs and/or AP
• Channel 14 is allowed only 11b mode
• Updated phy mode nvs when softap channel from 14 to other
• Updated wifi CSI docs
• Updated wifi beacon timeout docs

Fixed

• Added some BTM fixes
• Fixed issue reported by static analyser
• Fixed build warning for unused variables
• Fixed phy tx power limit for ESP32-S2/ESP32-C3/ESP32-S3
• Fixed scanning of AP's with mixed key management
• Fixed clearing default wifi netif procedure
• Fixed issue of default AP ssid not set
• Fixed data loose when WiFi power-save is enabled with Wi-Fi API being called
• Ignore unauthenticated encrypted EAPOL-Key data
• Fixed handling of key RSC
• Fixed smartconfig v2 bssid is zero issue
• Fixed static analysis issues
• Fixed the wrong suggestion of method in NAK for all the methods (#7769)
• Fixed memory leak in phy
• Fixed some issues related to SoftAP mode change and STA PMF
• Fixed stale PMF config in NVS issue
• Fixed linker script issue where noflash scheme was applied to wifi_apb80m_request() and wifi_apb80m_release() even when CONFIG_PM_ENABLE was not enabled
• Bugfix for close sniffer mode when wifi stop
• Fixed deep sleep can't reconnect to ap when pmf enable.
• Fixed some ap will ignore auth when rx deauth for a while
• Fixed espnow recv unencrypted packets issue
• Fixed not update phy according to country code
• Fixed an issue that check whether channel parameter is valid
• Reset beacon timeout timer when keep alive null works or hw drop beacon
• Bugfix for qos null update ba ssn
• Bugfix for wrong configuration of static txbuf
• Clear old keys before going for new connection
• Fixed sta reset beacon timeout timer trigger assert issue.
• Bugfix for optimize beacon timeout issue

Removed

• Removed group cipher check for PMF connection
• Remove CSA when switch channel from/to 14 channel

Security

Fixed

• Flash Encryption: Fixed issue that 4-line flash encryption cannot work normally when 8-line psram enabled (#9244; #9287)

Peripheral Drivers

Added

• esp_lcd: Support LSB first SPI LCD (#8790)
• Freemodbus: Add support of freemodbus component on ESP32-S2, ESP32-S3 and ESP32-C3.
• I80 LCD: Supports frame buffer in PSRAM (#8085)
• RGB LCD: Support the LCD mode of I2S1 on ESP32
• SPI_LCD: SPI LCD support trunked color data transfer (#8496)
• SPI_FLASH: Added support for 16MB octal flash MX25UW12345G (#7996)
• UART: Added new uart_get_tx_buffer_free_size API to get the free space size of tx ring buffer (#8932, #3078)
• Temperature Sensor: Added support on ESP32-S3 (#8086)

Changed

• ESP_LCD: Enabled read rx_param in esp_lcd with I2C transport

Fixed

• Fixed bbpll calibration fail bug in high temperature on ESP32-S3
• ADC Calibration: Fixed the assertion failure or returning wrong error code when ADC2 failed the arbitration
• freemodbus: Fixed uart_set_pin() check error in modbus master serial example
• GDMA: Fixed the issue that channel object was not allocated from internal memory when CONFIG_GDMA_CTRL_FUNC_IN_IRAM is true but CONFIG_GDMA_ISR_IRAM_SAFE is false
• GDMA: Fixed thread-safety of channel operations
• GPIO: Fixed wrong GPI...