ESP-IDF Release v3.1

Documentation for release v3.1 is available at http://docs.espressif.com/projects/esp-idf/en/v3.1/.

Changes Since v3.0

This is the list of changes since release v3.0. ESP-IDF v3.1 is compatible with apps written for v3.0 (apart from one breaking change in esp_ping, see below).

Known Issues

• When modem sleep is enabled, multicast packets can be delayed - more than 80% received after more than 250ms delay. Can be an issue for mDNS/Bonjour discovery.
• When Wi-Fi & BLE are used with software coexistence enabled, BLE scan intervals should be 200ms or less to avoid truncated BLE scan time.
• When Wi-Fi & BLE are used with software coexistence enabled, BLE sometimes fails to send advertisements.
• Occasional exception when BLE creates more than 3 connections as master.

Breaking Changes

• esp_ping units are now milliseconds (in v3.0 ping units were undocumented but they were treated as seconds)

Major Changes

• Wi-Fi and Bluetooth modem sleep support
• Wi-Fi and Bluetooth coexistence support
• Bluetooth Hands Free Profile (HFP)
• Bluetooth Serial Port Profile (SPP)
• Bluetooth A2DP source support
• Automatic Light Sleep feature to reduce overall power consumption (including Tickless FreeRTOS). Average current in Wi-Fi Station mode, when connected to AP (DTIM=1) is 3.1mA. This is 10x lower than the average current in modem sleep mode under the same scenario (30mA).
• Multiple antenna support (automatic using external RF antenna switch)
• Wi-Fi mesh functionality (ESP-MESH)
  • Autonomous self-organizing Wi-Fi-based networking protocol
  • Self-healing mesh topology
  • Can connect to external IP network via a "root node" and route packets to external network
  • Supports mesh network data encryption via WPA2-PSK
  • Guide and API Reference
• OS adapter layer for Wi-Fi functionality (allows Wi-Fi libraries to run on other RTOS implementations)
• SDIO Slave peripheral driver
• Bootloader refactoring, configurable factory reset and test app trigger functionality
• Partition table can be relocated to allow a larger bootloader binary
• esp_https_ota: New simplified HTTPS OTA client feature
• Initial Experimental support for alternative CMake build system.

Bluetooth Low Energy

Link Layer

• Fix the smartphone compatibility bug caused by LL Feature Exchange timing issue
• New configuration option to deal with BLE queue congestion
• Send an L2CAP error response if an invalid GATT request is received
• Fix get incorrect adv packet sometimes
• Fix crash during BLE connection and disconnection stress testing

GATT Client

• Save GATTC cache in NVS and add an option to configure it through menuconfig
• A new parameter incl_srvc_e_handle is added to the struct esp_gattc_incl_svc_elem_t while getting include service information
• Fix the incorrect PID key result of the ESP_GAP_BLE_GET_BOND_DEV_COMPLETE_EVT event
• Fix advertising stopped during connection
• Fix error when advertising stops

GATT Server

• Fix a probable memory leak for BTA_GATTS_CONF_EVT event

GAP

• Fix the bug where the start/stop advertising completed events sometimes are not accurate
• Add the duplicate scan feature and add an option to configure the duplicate scan cache size through menuconfig
• New API esp_ble_gap_config_local_icon to set the local GAP appearance icon
• New API esp_ble_gap_get_local_used_addr to get the local address used (e.g. current random address used)
• Add a completed event ESP_GAP_BLE_SET_STATIC_RAND_ADDR_EVT for esp_ble_gap_set_rand_addr()

Security Manager Protocol (SMP)

• Fix slave cannot receive long packets when using SMP
• Fix the bug that lead to crash when deinit bluetooth with SMP disabled
• Fix the incorrect results of the esp_ble_get_bond_device_list which is called after reboot
• Fix Security Manager Protocol bonding failure with iPhones
• Fix memory leak in security server

Blufi

• New "get wifi list" command
• New "report internal error report to phone" command
• New "send/receive custom data" command

Examples

• Add A2DP and BLE GATTS coex Demo
• Add BLE Throughput Demo
• Add HID Device Demo
• Fix ble_spp_clientdemo error when SUPPORT_HEARTBEAT is enabled
• Fix crash when http2_request example send/recv fails

Performance optimization

• BLE throughput optimizations
• Automatic registration of GATTC service change notify

Bluetooth Common Parts

• Wi-Fi and Bluetooth coexistence support
• Bluetooth modem sleep mode
• Controller to Host Flow Control support
• Fix CVE-2018-5383 ("Bluetooth implementations may not sufficiently validate elliptic curve parameters during Diffie-Hellman key exchange")
• Fix incorrectly enabled erroneous data reporting in HCI layer
• Fixes for removing bonded devices on BLE and Classic BT
• Fix conflict reading RSSI in dual mode
• Fix for BT timer oneshot mode sometimes triggering twice

Classic BT

• HFP (Hands Free Profile) support
• GAP device and sevice discovery
• SPP profile (including VFS support to return a file descriptor)
• dynamic memory allocation
• A2DP: Source and sink functionality can be enabled/disabled at runtime (both cannot be enabled concurrently)
• A2DP: Performance improvements
• Allow setting BR/EDR TX power level
• Check support of AFH in remote slave device's LM feature when determine whether to send LMP_set_AFH
• Fix incorrect computation of PCM data buffer size in A2DP sink

Wi-Fi

New Functionality

• Wi-Fi and Bluetooth coexistence support
• Mesh feature
• Throughput optimizations
• Support for Channel State Information (CSI)
• Support to sniffer Wi-Fi control packets
• Add parts of WPA Supplicant source to ESP-IDF
• Fix some memory issues in WPA2 Enterprise support
• WPA2 Enterprise API is now thread safe
• New event mask API
• New esp_wifi_80211_tx function for sending 802.11 frames
• WPS: Support WPS in APSTA mode
• WPS: Add "set factory information" feature
• Allow creating the Wi-Fi task pinned to either core
• Internal refactor for Smartconfig

Bug Fixes

• Fix issue where esp_wifi_stop never returns if start/stop is run repeatedly
• Fix for connecting to WEP APs
• Fix for de-authing station if Soft AP already has maximum connected
• Thread safety fixes in Wi-Fi library
• Fix issue that smartconfig crashes when switching channel
• Fix smartconfig crash issue with SPI RAM
• Fix the issue that esp_wifi_connect returns ESP_OK, but no system event posted (ap_loss) ([#1797](esp_wifi_connect returns ESP_OK, but no system event posted (ap_loss)))
• WPA2 Enterprise PEAP connection fixes ([#1887](Enterprise PEAP connection issue))
• Fix ESPNOW bug when add node in AP+STA mode
• Fix for scanning during connect process
• Fix Wi-Fi RX STBC issue, the fix improves the stability of STBC packet receiving
• Fix Wi-Fi TX bug which improves the Wi-Fi TX stability
• Reorder MPDU as AMPDU (fixes situation where AP alternates between sending each type)
• Fix for receiving duplicating MPDU and AMPDU frames
• Fix for soft-AP de-authes the wrong station when station's inactivity timer is expired
• Fix for Wi-Fi asserts the system when receiving empty MCS in association response frame
• Fix for Wi-Fi crashes when receiving invalid beacon in Modem sleep
• Fix for Wi-Fi scan causes Wi-Fi re-connect not work
• Fix for beacon information doesn't update after user scan
• Fix for the station may connect to wrong AP in all channel scan
• Fix for Wi-Fi ap loss ([#1797](esp_wifi_connect() returns ESP_OK, but no system event posted (ap_loss)))
• Add country code into scan result ([#1483](Country code in scan result))
• Add scan_method, sort_method and threshold when invoke esp_wifi_get_config ([#1723](esp_wifi_get_config not setting necessary parameters / documentation unclear about how to use))
• Add RSSI of each station in soft-AP list ([#1095](Enhance esp_wifi_ap_get_sta_list / wifi_sta_info_t to include RSSI, protocol))
• Add noise floor info in sniffer receiving packets
• Fix CCMP encryption compatibility issue
• Mark esp_wifi_set_auto_connect as deprecated
• Fix for esp_wifi_disconnect() error when wifi is not started or initialized
• ESPNOW: Fix for ESPNOW watchdog when modify it's configured parameters
• Examples: Remove performance example since they are replaced by iperf example
• Examples: Replace simple_wifi example with two new examples: the station example and soft-AP example ([#1433](Simple Wi-Fi examples))

LWIP

New Functionality

• Add VFS file descriptors in select
• Add event SYSTEM_EVENT_AP_STAIPASSIGNED
• By default don't automatically trust MAC entries of received IP packets, always send an ARP request (configurable)
• Port LWIP timer implementation from LWIP v2.0.3
• Add source IP based route for unicast packet

Bug Fixes

• Fix the issue that TCP connections don't abort when IP address is changed
• Modify default value of MTU in dhcp offer to 1500
• Fix the assertion issue caused by tcp_pcb_purge()
• Fix assertion when closing a non-blocking socket
• Fix compilation with AutoIP enabled

RF PHY

• Fix for full calibration accidentally running twice
• PHY performance improvements

Ethernet

Bug Fixes

• Set direction of SMI MDC and MDIO pins correctly

Network Functionality

• New esp-tls library (on top of mbedTLS) for high level TLS (SSL) functionality
• New esp_http_client library for HTTP/S client functionality
• mbedTLS: Update to v2.9.0
• dhcpserver: Fix maximum number of leases (was one less than configured)
• dhcpserver: Increase DHCP offer MTU size to 1500

Smartconfig

• Moved to its own comp...

ESP-IDF Pre-release v3.1-rc2

Documentation for release v3.1-rc2 is available at http://docs.espressif.com/projects/esp-idf/en/v3.1-rc2/.

This is a pre-release release candidate version. The current release version is v3.0.3.

This is the list of changes since v3.1 Release Candidate 1:

Build System

• Initial Experimental CMake support added (alternative to the default GNU Make build system which is the same as previous versions.)

WiFi

• Reorder MPDU as AMPDU (fixes situation where AP alternates between sending each type)
• Fix for scanning during connect process
• Add check for beacon length in modem sleep
• Fix for SoftAP sometimes deauthing wrong station when inactivity timer expires
• Fix the system assert when receiving empty MCS in association response frame

Bluetooth

• Fix a probable memory leak for BTA_GATTS_CONF_EVT event
• Fix for BT timer oneshot mode sometimes triggering twice
• Check support of AFH in remote slave device's LM feature when determine whether to send LMP_set_AFH
• Fix memory leak in security server
• BLE: Fix get incorrect adv packet sometimes
• Fix incorrect computation of PCM data buffer size in A2DP sink

LWIP

• Backport LWIP timer implementation from LWIP v2.0.3

Drivers

• SPI driver: Fix issue that SPI cannot be used when flash is disabled.

For the list of changes since earlier releases, see v3.1 Release Candidate 1.

ESP-IDF Pre-release v3.1-rc1

Documentation for release v3.1-rc1 is available at http://docs.espressif.com/projects/esp-idf/en/v3.1-rc1/.

This is a pre-release release candidate version. The current release version is v3.0.3.

Changes Since v3.1-beta1

This is the list of changes since v3.1 Beta 1:

Known Issues

• Dynamic Frequency Scaling and Bluetooth modem sleep are not compatible. DFS will be automatically disabled if Bluetooth modem sleep is in use.

Bluetooth

Bluetooth Controller / Bluedroid

• Add Controller to Host Flow Control support
• Fixes and performance improvement when WiFi coexistence is enabled, including when modem sleep also enabled
• Fix lock protection when setting interrupts
• Fix conflict reading RSSI in dual mode
• Fix assertion failure in time conversion functions
• Fixes for removing bonded devices on BLE & Classic BT
• Fix incorrectly enabled erroneous data reporting in HCI layer
• Fix controller critical sections when called from ISR context
• Fix controller crash when controller is disabled and re-enabled under some circumstances

BLE

• New configuration option to deal with BLE queue congestion
• Fix CVE-2018-5383 ("Bluetooth implementations may not sufficiently validate elliptic curve parameters during Diffie-Hellman key exchange")
• Fix slave cannot receive long packets when using SMP
• Fix connection stability with modem sleep enabled
• Fix advertising stopped during connection
• Send an L2CAP error response if an invalid GATT request is received
• Fix error when advertising stops
• Fix service notification when registering multi GATTC
• Fix GATTC get count
• Fix Security Manager Protocol bonding failure with iPhones
• Fix get bond list error when connection is unbonded
• Fix pointer arithmetic errors in GAP

BT Classic

• Fix invalid SCO handle in HCI number_of_completed_packets event
• Fix crash on end of SCO link after link supervision timeout
• Retrieve disconnection reason in AVDT when ACL-U link is disconnected
• Fix SPP crash on reset
• Fix invalid retransmission setting for SCO link in HFP

WiFi

• Restore null mode configuration setting
• WiFi library memory use improvements: reduced WiFi stack size, freed some static memory usage, reduced some internal buffers
• Channel state information buffer changed to signed values
• Fix beacon information not updating after user scan
• Fix AMPDU duplicate frame issue
• WiFi coexistence fixes
• Decreate phy_init time from 900us to 347us when waking from sleep
• Fix interrupt watchdog issue when setting channel
• Fix bug where wrong AP was connected after an all channel scan

WPA2 Enterprise

• Fix memory corruption bug
• Fix memory leak bug
• WPA2 Enterprise API now thread safe

ESP-MESH

• New API to set/get announce interval
• New API to enable/disable minimum data rate limited to 6Mbps
• New API to set/get RSSI thresholds for self organization
• Fixes for AP loss handling
• Modify parent switch mechanism

LWIP

• Fix assertion in tcp_pcb_purge()
• Fix assertion when closing an non-blocking TCP socket
• By default don't automatically trust MAC entries of received IP packets, always send an ARP request (configurable)
• Add source IP based routing for unicast packets
• Fix compilation with AutoIP enabled

mDNS

• Send "Goodbye" packet when removing service as "Authoritative"
• Fix a portion of queries are issued with the wildcard query type

System

• freertos: Queue Sets are now multi-CPU safe
• Fix rtc_gpio_desc values for GPIOs 35, 37, 38, 39
• Fix for flushing UART output on deep sleep
• Fix addresses of some libgcc functions in ESP32 ROM
• Fix "make flash" arguments when partition table has no factory partition
• Fix idf_monitor interactive console performance
• Mark XTHAL_GET_INTERRUPT & XTHAL_GET_CCOUNT as volatile
• NVS Partition Generator: Support base64 encoded binary data
• Fix incorrect pad reported in esp_sleep_get_touchpad_wakeup_status() for touchpad wakeup
• spi_flash_mmap(): Allocate mmap pages array in internal memory (fixes crash when using SPIRAM)
• Improve spinlock performance when assertions are enabled

Bootloader

• Fixes for factory reset pin GPIO option
• Fixes when compiling with assertions disabled
• Fix boot error for uncommon case where partition table has no OTA app partitions but a non-empty ota_data partition
• Support QIO mode for XM25QU64A flash chip

Secure Boot

• Fix regression in secure boot & flash encryption functionality
• Partition table no longer has its signature verified as part of Secure Boot
• Pad app images to a 64KB boundary to ensure no unverified data is mapped into the address space

Drivers

• GPIO: Fix bitmask overflow in gpio_reset_pin for pin > 31
• GPIO: Fix bug clearing interrupt status when enabling interrupts for GPIO numbers > 31
• LEDC: Fix ledc_set_duty_and_update() to return immediately if duty is already set
• LEDC: Fix ledc_set_freq() for low speed mode
• PCNT: Add some additional parameter checks and improve example
• RMT: Reduce rmt_mem_num memory block limit to 8 (correct value)
• SDIO Slave: Fix race condition with high frequency interrupts
• SDIO Slave: Fix some return values, improve high speed & 4 bit mode configuration
• SDMMC: Disable all pulldowns used by SDMMC host
• SDMMC: Enable host auto stop only for certain commands
• Touchpad: New API touch_pad_get_wakeup_status()
• UART: Fix UART tx_empty interrupt wdt timeout bug
• UART: Fix timeout bug when UART clock source is ref_tick

Storage

• nvs_flash: Add version compatibility checks for NVS storage
• spiffs: Fix stackoverflow due to recursion in vfs_spiffs_readdir_r

Documentation

• New page with information about ESP-IDF versions
• Eclipse setup: Fix some inconsistent information on Windows English & Chinese Eclipse setup page, simplify description of some steps.

Examples

• ble_hid_device: Fix bugs with HID Information & HID Control characteristics
• ble_throughput: Improve default example configuration
• http2_request: Fix a crash when send/receive fails
• ULP example: Fix RTC IOs

ULP

• Expand documentation for JUMPS instruction, ULP binary format
• Add missing include in ulp.h header
• Fix calculation of ulp_run argument

esp_http_client

• Fix HTTP chunked encoding
• Fix for reading data from TLS connection
• API support for getting transport type
• Fix exception on 401 error without www-authenticate header set

External libraries

• mbedTLS: Updated to v2.12.0

Changes Since v3.0

This is the list of changes since release v3.0. ESP-IDF v3.1 is compatible with apps written for v3.0 (apart from one breaking change in esp_ping, see below).

Known Issues

• Dynamic Frequency Scaling and Bluetooth modem sleep are not compatible. DFS will be automatically disabled if Bluetooth modem sleep is in use.

Breaking Changes

• esp_ping units are now milliseconds (in v3.0 ping units were undocumented but they were treated as seconds)

Major Changes

• Support for Wi-Fi & Bluetooth modem sleep
• Support for Automatic Light Sleep to reduce overall power consumption (including Tickless FreeRTOS)
• Multiple antenna support (automatic using external RF antenna switch)
• Wi-Fi mesh functionality (ESP-MESH)
  • Autonomous self-organizing Wi-Fi-based networking protocol
  • Self-healing mesh topology
  • Can connect to external IP network via a "root node" and transparently route mesh packets to external network
  • Supports mesh network data encryption via WPA-PSK
  • Guide and API Reference
• OS adapter layer for Wi-Fi functionality (allows Wi-Fi libraries to run on other RTOS implementations)
• SDIO Slave peripheral driver
• Bootloader refactoring, configurable factory reset and test app trigger functionality
• Partition table can be relocated to allow a larger bootloader binary
• esp_https_ota: New simplified HTTPS OTA client feature

BLE

Link Layer

• Fix the smartphone compatibility bug caused by LL Feature Exchange timing issue
• New configuration option to deal with BLE queue congestion
• Send an L2CAP error response if an invalid GATT request is received

GATT Client

• Save GATTC cache in NVS and add an option to configure it through menuconfig
• A new parameter incl_srvc_e_handle is added to the struct esp_gattc_incl_svc_elem_t while getting include service information
• Fix the incorrect PID key result of the ESP_GAP_BLE_GET_BOND_DEV_COMPLETE_EVT event
• Fix advertising stopped during connection
• Fix error when advertising stops

GAP

• Fix the bug where the start/stop advertising completed events sometimes are not accurate
• Add the duplicate scan feature and add an option to configure the duplicate scan cache size through menuconfig
• New API esp_ble_gap_config_local_icon to set the local GAP appearance icon
• New API esp_ble_gap_get_local_used_addr to get the local address used (e.g. current random address used)

Security Manager Protocol (SMP)

• Fix CVE-2018-5383 ("Bluetooth implementations may not sufficiently validate elliptic curve parameters during Diffie-Hellman key exchange")
• Fix slave cannot receive long packets when using SMP
• Fix the bug that lead to crash when deinit bluetooth with SMP disabled
• Fix the incorrect results of the esp_ble_get_bond_device_list which is called after reboot
• Fix Security Manager Protocol bonding failure with iPhones

Blufi

• New "get wifi list" comman...

ESP-IDF Release v3.0.3

Documentation for release v3.0.3 is available at https://docs.espressif.com/projects/esp-idf/en/v3.0.3/

ESP-IDF v3.0.3 is a bugfix-only update for ESP-IDF v3.0.2. Release v3.0.3 is compatible with apps written for ESP-IDF v3.0.x.

This is the list of changes since release v3.0.2:

Bluetooth Related

• Add "scan duplicate for BLE Mesh" feature
• Fix BLE slave can't receive long packets in Security Manager Protocol

LWIP Related

• lwip: Disable default trusting of IP MAC addresses (ie not automatically adding to the ARP table without sending an ARP request)
• lwip: Fix assertion in tcp_pcb_purge()
• lwip: Add source based IP routing for unicast packets

WiFi Related

• Fix duplicate AMPDU issue

System Related

• esp_timer: Fix bug where timer overflow could cause WDT interrupt in esp_timer_impl_set_alarm() (#1891)
• freertos: Fix SMP safety issues with queue sets

Driver Related

• uart: Fix UART timeout bug when using ref_tick clock source

Obtaining v3.0.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 v3.0.3 --recursive https://github.com/espressif/esp-idf.git esp-idf-v3.0.3
cd esp-idf-v3.0.3/

This is the recommended way of obtaining v3.0.3 of ESP-IDF.

Download an archive with submodules included

Attached to this release is an esp-idf-v3.0.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/dl/esp-idf/releases/esp-idf-v3.0.3.zip

ESP-IDF Release v3.0.2

Documentation for release v3.0.2 is available at https://docs.espressif.com/projects/esp-idf/en/v3.0.2/

ESP-IDF v3.0.2 is a bugfix-only update for ESP-IDF v3.0.1. Release v3.0.2 is compatible with apps written for ESP-IDF v3.0 & v3.0.1.

This is the list of changes since release v3.0.1:

Wi-Fi Related

• Refactor locks to avoid rare interrupt watchdog crash.
• Reduce Wi-Fi stack memory usage.

LWIP Related

• Fix assert in tcp_pcb_purge()
• Fix bug that stale TCP connections don't close when IP changes (ie Wi-Fi STA disassociates and reassociates).

System Related

• Move esp_crosscore_isr_handle_yield() to IRAM. Fixes occasional crashes when writing to flash.
• nvs: Don't expect items with bad CRC to be in cache

Documentation

• Clarify some Eclipse setup steps

Obtaining v3.0.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 v3.0.2 --recursive https://github.com/espressif/esp-idf.git esp-idf-v3.0.2
cd esp-idf-v3.0.2/

This is the recommended way of obtaining v3.0.2 of ESP-IDF.

Download an archive with submodules included

Attached to this release is an esp-idf-v3.0.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.

ESP-IDF Release v3.0.1

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

ESP-IDF v3.0.1 is a bugfix-only update for ESP-IDF v3.0. Release v3.0 is compatible with apps written for ESP-IDF v3.0.

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

Known Issues

(These bugs are scheduled for v3.0.2.)

• Rare Wi-Fi interrupt WDT crash
• Rare crash when writing to or erasing flash
• When Wi-Fi STA disassociates and reassociates, stale TCP connections are not automatically closed

Bluetooth

• Fix A2DP connection issues with iPhone 7
• Fix notify memory leak
• Fix crash on malloc failure
• Fix esp_ble_gap_set_security_param() memory leak

Wi-Fi Related

• Fix the issue that station fails to receive data in modem sleep mode if association ID is bigger than seven
• Fix smartconfig crash issue with SPI RAM
• Fix the issue that esp_wifi_connect() returns ESP_OK, but no system event posted (ap_loss) ([#1797](esp_wifi_connect() returns ESP_OK, but no system event posted (ap_loss)))

LWIP Related

• Fix assertion issue in tcp_pcb_purge()

RF PHY

• Log an error if storing PHY calibration data fails
• Fix some situations where PHY calibration data may not be stored correctly
• Reduce libphy IRAM usage

Drivers

• I2S: Fix broken I2S ADC mode
• UART: Fix uart buffer_full flag always being set

Obtaining v3.0.1

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 https://github.com/espressif/esp-idf.git esp-idf-v3.0.1
cd esp-idf-v3.0.1/
git checkout v3.0.1
git submodule update --init --recursive

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

Download an archive with submodules included

Attached to this release is an esp-idf-v3.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.

ESP-IDF Prerelease v3.1-beta1

Documentation for release v3.1-beta1 is available at http://docs.espressif.com/projects/esp-idf/en/v3.1-beta1/.

This is a prerelease version with known issues (see below). The current release version is v3.0.1.

This is the list of changes since release v3.0. ESP-IDF v3.1 is compatible with apps written for v3.0 (apart from one breaking change in esp_ping, see below).

Known Issues

• Bluetooth modem sleep mode (disabled by default) has stability issues
• Bluetooth modem sleep mode can't work with Dynamic Frequency Scaling
• Wi-Fi NULL mode is currently non-functional
• When using BLE and Wi-Fi together, BLE advertising or scanning has a small chance of failing
• Wi-Fi performance is not good when signal is weak

Breaking Changes

• esp_ping units are now milliseconds (in v3.0 ping units were undocumented but they were treated as seconds)

Major Changes

• Support for Wi-Fi & Bluetooth modem sleep
• Support for Automatic Light Sleep to reduce overall power consumption (including Tickless FreeRTOS)
• Multiple antenna support (automatic using external RF antenna switch)
• Wi-Fi mesh functionality
• OS adapter layer for Wi-Fi functionality (allows Wi-Fi libraries to run on other RTOS implementations)
• SDIO Slave peripheral driver
• Bootloader refactoring, configurable factory reset and test app trigger functionality
• Partition table can be relocated to allow a larger bootloader binary

BLE

Link Layer

• Fix the smartphone compatibility bug caused by LL Feature Exchange timing issue

GATT Client

• Save GATTC cache in NVS and add an option to configure it through menuconfig
• A new parameter incl_srvc_e_handle is added to the struct esp_gattc_incl_svc_elem_t while getting include service information
• Fix the incorrect PID key result of the ESP_GAP_BLE_GET_BOND_DEV_COMPLETE_EVT event

GAP

• Fix the bug where the start/stop advertising completed events sometimes are not accurate
• Add the duplicate scan feature and add an option to configure the duplicate scan cache size through menuconfig
• New API esp_ble_gap_config_local_icon to set the local GAP appearance icon
• New API esp_ble_gap_get_local_used_addr to get the local address used (e.g. current random address used)

SMP

• Fix the bug that lead to crash when deinit bluetooth with SMP disabled
• Fix the incorrect results of the esp_ble_get_bond_device_list which is called after reboot

Blufi

• New "get wifi list" command
• New "report internal error report to phone" command
• New "send/receive custom data" command

Examples

• Add A2DP and BLE GATTS coex Demo
• Add BLE Throughput Demo
• Add HID Device Demo
• Fix ble_spp_clientdemo error when SUPPORT_HEARTBEAT is enabled

Performance optimization

• BLE throughput optimizations
• Automatic registration of GATTC service change notify

Bluetooth Common Parts

• Wi-Fi & Bluetooth coexistence support
• Bluetooth modem sleep mode

Classic BT

• HFP (Hands Free Profile) support
• GAP device and sevice discovery
• SPP profile (including VFS support to return a file descriptor)
• dynamic memory allocation
• A2DP: Source and sink functionality can be enabled/disabled at runtime (both cannot be enabled concurrently)
• A2DP: Performance improvements
• Allow setting BR/EDR TX power level

Wi-Fi

New Functionality

• Wi-Fi & Bluetooth coexistence support
• Modem sleep support
• Mesh feature
• Throughput optimizations
• Support for Channel State Information (CSI)
• Support to sniffer Wi-Fi control packets
• Add parts of WPA Supplicant source to ESP-IDF
• New event mask API
• New esp_wifi_80211_tx function for sending 802.11 frames
• WPS: Support WPS in APSTA mode
• WPS: Add "set factory information" feature
• Allow creating the Wi-Fi task pinned to either core

Bug Fixes

• Fix issue where esp_wifi_stop never returns if start/stop is run repeatedly
• Fix for connecting to WEP APs
• Fix for de-authing station if Soft AP already has maximum connected
• Thread safety fixes in Wi-Fi library
• Fix issue that smartconfig crashes when switching channel
• Fix smartconfig crash issue with SPI RAM
• Fix the issue that esp_wifi_connect returns ESP_OK, but no system event posted (ap_loss) ([#1797](esp_wifi_connect returns ESP_OK, but no system event posted (ap_loss)))
• WPA2 Enterprise PEAP connection fixes ([#1887](Enterprise PEAP connection issue))
• Fix ESPNOW bug when add node in AP+STA mode

LWIP

New Functionality

• Add VFS file descriptors in select
• Add event SYSTEM_EVENT_AP_STAIPASSIGNED

Bug Fixes

• Fix the issue that TCP connections don't abort when IP address is changed
• Modify default value of MTU in dhcp offer to 1500
• Fix the assertion issue caused by tcp_pcb_purge()

RF PHY

• Fix for full calibration accidentally running twice
• PHY performance improvements

Ethernet

Bug Fixes

• Set direction of SMI MDC & MDIO pins correctly

Network Functionality

• New esp-tls library (on top of mbedTLS) for high level TLS (SSL) functionality
• New esp_http_client library for HTTP/S client functionality
• mbedTLS: Update to v2.9.0
• dhcpserver: Fix maximum number of leases (was one less than configured)
• dhcpserver: Increase DHCP offer MTU size to 1500

Smartconfig

• Moved to its own component (no longer part of 'esp32')

Soc-Level Functionality

New Functionality

• Power Management: Support for automatic light sleep
• Dump stack of both cores when Interrupt watchdog timeout occurs
• New macros DMA_ATTR & WORD_ALIGNED_ATTR for declaring DMA-capable static buffers
• Add option to continue running if PSRAM was enabled but not detected at boot
• Support maximum CPU frequency rating efuse bits, if set from factory.
• Power Management: Allow disabling a deep sleep wakeup source
• Improve performance of DPORT access workaround
• Support __NOINIT_ATTR and RTC_NOINIT_ATTR for static memory not cleared on reset

Bug Fixes

• Power management: Dynamic frequency scaling stability improvements
• Fix for runtime configuration of PSRAM (improves stability for 80MHz PSRAM)
• Fix starting 32kHz crystal in some cases where crystal performance is borderline
• Fix loss of precision when estimating XTAL frequency
• Prevent Interrupt WDT from re-triggering in panic handler
• Heap: Fix tracing of newlib internal allocations (not all of these were being included in the trace)

Core System Libraries

New Functionality

• freeRTOS: Support tickless idle (works with Light Sleep)
• newlib: Add support for adjtime()
• New esp_err_to_name() function to look up error messages from esp_err_t codes.
• New API esp_intr_set_in_iram() to change interrupt "in IRAM" status
• pthreads: Allow configuring thread priority & stack size on creation
• C11 Thread Local Storage support
• Heap: New "record task" option for heap tracing
• esp_timer: Add a function to get next alarm time

Bug Fixes

• Remove debug logging from pthread conditional variables
• Remove duplicate definition of system_restore
• Increase default event task stack size by 256 bytes (prevent stack overflow at Debug log level)
• Fix for idle task stack overflow under some circumstances
• Refactors and stability fixes for ESP-IDF RingBuffers
• Fix busy loop in esp_timer_impl_set_alarm (could trigger interrupt watchdog)

Bootloader

New Functionality

• More modular bootloader. Minimal code in the bootloader component itself makes it easy to copy this component into a project to implement custom bootloader functionality.
• New "reset to factory" and "start test app" config options to watch a GPIO and trigger behaviour on reset
• Partition table can be relocated to allow a larger bootloader binary
• Partition table now generated with MD5 checksum, checked on boot

Bug Fixes

• Fix flash QIO mode configuration for some flash chips

Drivers

New Functionality

• esp_adc_cal: Read factory calibration data from eFuse if present in chip
• GPIO: Support digital pad hold function
• I2S: Support "fixed_mclk" configuration
• I2S: Support for expanding bit width for multi-data-bit input and output (not standard I2S)
• LEDC: New thread-safe duty cycle & fade API
• PCNT: Allow each unit to have its own interrupt handler
• RMT: New function rmt_register_tx_end_callback(). Called when RMT ISR has queued all outgoing items
• RMT: New API for sending generic uint8_t-typed data.
• SDIO Slave: New driver
• SDMMC: SDIO support at protocol layer
• SDMMC: Add support for reading CD & WP pins in driver
• SPI Master: Configuration item to place SPI send/receive code into IRAM for performance

Bug Fixes

• Always reset various communication peripherals (UART, I2C, etc) on CPU reset
• ADC: Fix bug where some peripherals (DAC, HALL) needed to be disabled before ADC conversion
• esp_adc_cal: Simplify lookup table mode, due to inferior performance compared to linear mode for attenuations 0-2
• GPIO: modify return value when gpio ISR service already exists.
• I2C: Concurrency fixes
• I2C: Add xQueue and xSemaphore static allocation support when intr_alloc_flag set to ESP_INTR_FLAG_IRAM.
• I2S: Fix I2S ADC mode
• LEDC: Fix duty cycle and fade overflow issues
• SPI master: perform clock calculations in initialization not ISR
• SPI master: Don't reconfigure peripheral if settings are unchanged
• SPI master: Fix issue using GPIO0
• SPI master: Fix issue with variable command and address flag
• SPI master: Fix typo in LSBFIRST macro value
• SPI master: Allow using GPIO34-39 as MISO
• RMT: Remove logging which skewed timing
• RMT: Fix for LoadProhibited crash
• RMT: Fix TX stop API issue
• SDMMC: Fix for slave sometimes falling into SPI mode
• SDMMC: Fix init sequence ordering
  ...

ESP-IDF Release v3.0

Documentation for release v3.0 is available at http://esp-idf.readthedocs.io/en/v3.0/.

This is the list of changes since release v3.0-rc1.

If upgrading from previous stable release V2.1, check the v3.0-rc1 release notes for changes which also apply.

Breaking Changes

Release v3.0 is largely compatible with apps written for ESP-IDF v3.0-rc1. However some breaking behaviour and significant API changes have been introduced:

• Some I2S APIs which mixed return values and error codes have been deprecated. New APIs have been introduced to replace them.

  • i2s_write should be used instead of i2s_write_bytes and i2s_push_sample, which are deprecated.
  • i2s_read should be used instead of i2s_read_bytes and i2s_pop_sample, which are deprecated

• A new parameter remote_addr_type is added for esp_ble_gattc_open() (esp_ble_gattc_open())

• Modify the parameter of the ESP_GATTS_ADD_CHAR_DESCR_EVT BLE GATTS event, renaming the char_uuid parameter of this event to descr_uuid (!1484)

• Modify the Classic BT AVRC events

  • Remove the feat_mask parameter from the ESP_AVRC_CT_CONNECTION_STATE_EVT event
  • Delete the ESP_AVRC_CT_MAX_EVT event
  • Add a new event ESP_AVRC_CT_REMOTE_FEATURES_EVT

Build System and tools

New functionality

• Support C++ source files with .cc extension
• idf_monitor now supports pausing log output from the console
• Support editorconfig for editing ESP-IDF source files
• Fix for reduced RTC core voltage when waking from sleep

Bug fixes

• Restore application compatibility with pre-IDF v2.1 bootloaders
• Fix SysView support when building in single core mode

Bootloader

• Disable logging before UART is reconfigured by second stage bootloader (possibly setting a custom baud rate)
• Always boost VDD_SDIO voltage 1.8V -> 1.9V if flash frequency is 80MHz

FreeRTOS

New Functionality

• Backported FreeRTOS V9.0.0 task deletion behaviour: a deleted task will be immediately cleaned up if it is not currently running.
• IDF ringbuffer: Add new APIs xRingbufferGetCurFreeSize(), xRingbufferIsNextItemWrapped(), xRingbufferCreateNoSplit()

Bug fixes

• Fix for cross-core deleted tasks not being cleaned up in some circumstances.

System Library Features

New Functionality

• spi_flash: New configuration options to detect invalid writes

Bug Fixes

• Fix esp_timer accuracy issues
• Fix realloc() behaviour when heap tracing is enabled
• Fix realloc() memory corruption bug when heap poisoning is enabled
• Fix memory fragmentation issue when splitting large free blocks
• Fix compilation error when RTC used as clock source
• Fix invalid SPIRAM clock changes by clock subsystem
• Fix clock initialization in single core mode
• Restrict linker size of DRAM to enforce static RAM limits, rather than erroring at runtime

Drivers

New functionality

• ADC eFuse factory calibration functionality
• I2S driver: New function i2s_write_expand() to automatically expand bit width of supplied samples to match hardware
• UART driver: Allow reading character pattern detection position without modifying the pattern detection queue

Bug fixes

• I2C driver: fixes for timeout recovery, thread safety
• I2C driver: allow NACKing last byte read
• I2S driver: fix inaccurate errors returned from some functions

TCP/IP

New Functionality

Bug Fixes

• Fix closing TCP socket causes system crash bug
• Fix the bug that incorrect event is posted when setting static IP of soft-AP or Ethernet

Known Issues

• Long time TCP traffic stability test causes LWIP assert, it is only found in dual core mode with PSRAM is enabled
• TCP traffic stability test causes Interrupt watchdog timeout, it is found in dual core mode and when the WiFi mode of the device is configured as WIFI_MODE_APSTA mode

WiFi

Bug Fixes

• Fix a bug that system crashes when station disconnects from AP.
• Fix the bug that receiving beacon time is not correct.
• Fix the bug that esp_wifi_restore() will cause a fail wifi connection.(#233)
• Fix the bug that in sniffer mode it asserts when receive misc data.(#1037,#1404)
• Fix a memory leak in espnow
• Fix the bug that wpa2 assert when disconnect from AP
• Fix QoS bug in 11g mode
• Fix esp_wifi_stop() never returns bug
• Fix esp_wifi_deinit() causes system assert bug
• Fix EAPOL retransmission causes system crash bug
• Fix WPS not work correctly on WIFI_MODE_APSTA bug (#1045)
• Fix sha256 signature of WPA2 causes system assert bug ([#1297](Unable to use wpa2_enterprise example on ESP32))

Performance Improvements

• Optimize WiFi retransmission and timeout mechanism

BLE

Known Issues

• Bluetooth controller will crash if ESP32 is overloaded, e.g. running the BLE throughput example and printing a lot of logs at the same time

Link Layer

• Fix the bug where the LL_LENGTH_REQ packet is sent even if the remote device doesn't support this feature

GATT Server

• Fix the incorrect result of the esp_ble_gatts_get_attr_value() event when the characteristic value that the event gets is written by the remote device using Prepare Write Request (#1612)

GAP

• Fix the bug where the start/stop advertising completed events sometimes are not accurate
• Fix the bug where the connection parameters update procedure sometimes fails in the period of pairing
• Fix the bug where the connection parameter update procedure sometimes leads to disconnection
• Fix the bug where the bonding list that read from the flash is not correct once the chip reboots

SMP

• Fix the bug where the reconnection sometimes fails when the device is already paired (#1561)

Performance optimization

• Improve the stability of the multi-connection

Bluetooth Common Parts

• Fix some bugs related to the memory leakage (BLE SMP, A2DP, Timer)
• Fix some bugs that may lead to crash (xQueueGenericSend, page scan procedure, etc)

Classic BT

• Add the option to configure the stack size of A2DP sink task through menuconfig
• Fix the bug where the restart of media task fails when the esp_a2d_sink_deinit() is called in the period of connection (#1522
  )
• Fix the incorrect disc_rsn parameter value of the ESP_A2D_CONNECTION_STATE_EVT event when the receiving device acts as a master
• Fix the incorrect remote_bda parameter value of the ESP_AVRC_CT_CONNECTION_STATE_EVT event
• Fix the bug that causes the initiating side to lose the link key notification event when the receiving device is repairing in simple_pairing mode(#1275)
• Fix the bug about string_to_bdaddr where the address of the device that read from the flash is not converted correctly when nano formatting options is enabled in the menuconfig

openssl wrapper

• Fix compilation error when ALPN is disabled in mbedTLS configuration

mbedTLS

Bug Fixes

• Backport security fixes from v2.8.0 to v2.6.0. Covers CVE-2018-0488, CVE-2018-0487, CVE-2017-18187, CVE-2018-9988, CVE-2018-9989.

Ultra Low Power Processor

Bug Fixes

• Fix I_DELAY macro error when using new toolchain
• Document execution time for ULP instructions

mDNS

Bug Fixes

• Produce TXT records compatible with all mDNS parsers
• Fix issue when mDNS service is NULL

External Libraries

• cJSON updated to v1.7.1, includes some memory corruption fixes

Documentation

• Add tutorials in some BLE examples
• Modify the readme files in some BLE/BT examples
• Improved RMT driver API documentation

Examples

New Examples

• New RMT driver example

Bug Fixes

• Fix some bugs for the Eddystone example (#1682)

Obtaining v3.0

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 pre-release, use the following commands:

git clone https://github.com/espressif/esp-idf.git esp-idf-v3.0
cd esp-idf-v3.0/
git checkout v3.0
git submodule update --init --recursive

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

Download an archive with submodules included

Attached to this release is an esp-idf-v3.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.

ESP-IDF Pre-release 3.0-rc1

Documentation for pre-release 3.0-rc1 is available at http://esp-idf.readthedocs.io/en/v3.0-rc1/.

This is the list of changes since release 2.1.

Breaking Changes

Release v3.0 is largely compatible with apps written for ESP-IDF v2.1. However some breaking behaviour and significant API changes have been introduced:

• Crystal frequency is now set to 40MHz by default (previously auto-detected). A warning is logged if the detected frequency doesn't match, but users of 26MHz boards such as Sparkfun ESP32 Thing will need to configure 26MHz manually. (documentation)

• Bluetooth controller reserved memory is now determined at run time. Applications with Bluetooth enabled can use the esp_bt_controller_mem_release) function to reclaim unused controller memory.

• New Task Watchdog API. esp_task_wdt_feed() has been replaced by esp_task_wdt_reset(). Tasks must now be explicitly added to the Task Watchdog. (documentation)

• FreeRTOS tick and idle hooks are now assigned per-core (#781)

• RMT peripheral function rmt_get_ringbuf_handler renamed to rmt_get_ringbuf_handle

• Interrupt allocation: Multiple interrupt handlers assigned to the same interrupt source must have the same flags

• By default, BASIC ROM Console fallback is permanently disabled (via efuse) on first boot, to avoid accidentally resetting to this mode

• SPI driver: a number of SPI master APIs, SPI master address format, etc. have changed. See Drivers section (below) for details

• tcpip_adapter_start function is now split into interface-specific tcpip_adapter_eth_start, tcpip_adapter_wifi_start, etc. (This is a breaking API change, but this function is not normally called directly by apps)

• WiFi initialization function, esp_wifi_init, no longer calls nvs_flash_init internally. Applications need to call nvs_flash_init before calling esp_wifi_init.

• esp_wifi_wps_enable is changed from esp_err_t esp_wifi_wps_enable(void) to esp_err_t esp_wifi_wps_enable(const esp_wps_config_t *config). Please check WPS example for details.

• esp_wifi_sta_wpa2_ent_enable is changed from esp_err_t esp_wifi_sta_wpa2_ent_enable(void) to esp_err_t esp_wifi_sta_wpa2_ent_enable(const esp_wpa2_config_t *config). Please check WPA2 example for details.

• Definition of wifi_country_t has been changed (documentation).

• When WiFi station disconnects from the AP, IP address does not get immediately reset to 0. If the station is disconnected for some time, SYSTEM_EVENT_STA_LOST_IP event is generated, and IP address is set to 0. The timeout can be set using CONFIG_IP_LOST_TIMER_INTERVAL option (120 seconds by default).

• New MTU API. esp_ble_gattc_config_mtu() has been replaced by esp_ble_gatt_set_local_mtu() and esp_ble_gattc_send_mtu_req(). The former API is used to set the local Rx MTU and the latter is used by GATTC to send MTU Request

• GATTC APIs esp_ble_gattc_get_characteristic() and esp_ble_gattc_get_descriptor() are removed

  • New API esp_ble_gattc_get_db() can be used to get the whole GATT database.(esp_ble_gattc_get_db)
  • Some other new APIs are provided to get the specific characteristics by UUID or handle, like esp_ble_gattc_get_char_by_uuid().

• The parameters of APIs used for the GATTC read/write operations are changed, handles are now used as identifiers instead of UUIDs.

  • esp_ble_gattc_read_char()
  • esp_ble_gattc_read_char_descr()
  • esp_ble_gattc_write_char()
  • esp_ble_gattc_write_char_descr()
  • esp_ble_gattc_prepare_write()
  • esp_ble_gattc_prepare_write_char_descr()

• Add an event for enabling or disabling privacy(ESP_GAP_BLE_SET_LOCAL_PRIVACY_COMPLETE_EVT)

• Add two GATTC events to indicate the physical connection status

  • ESP_GATTC_DISCONNECT_EVT
  • ESP_GATTC_CONNECT_EVT

• Modify two GATTS events (ESP_GATTS_CONNECT_EVT and ESP_GATTS_DISCONNECT_EVT) that indicate the physical connection status

  • Remove an unnecessary parameter is_connected
  • Add a new parameter reason in the ESP_GATTS_DISCONNECT_EVT event

• Modify GATTS event ESP_GATTS_CONF_EVT

  • Parameters len and value are added in the event to indicate the notification/indication that the event belongs to. These two parameters are valid only when the packet is not sent successflully.

• bt.h header file has been renamed to esp_bt.h.

• LWIP socket file descriptors now take higher numeric values (via the LWIP LWIP_SOCKET_OFFSET macro). BSD sockets code should mostly work as expected (and, new in V3.0, some standard POSIX functions can now be used with sockets). However any code which assumes a socket file descriptor is always a low numbered integer may need modifying to account for LWIP_SOCKET_OFFSET. Note that the common pattern of calling select(FD_SETSIZE, ....) will no longer work, as the set size is much smaller than the LWIP_SOCKET_OFFSET value. It is necessary to calculate the actual maximum fd numeric value.

Hardware Support

• Support for ESP32-PICO-D4 System In Package and ESP-32-PICO-KIT development board
• Support for external SPI-connected ESP-PSRAM32 chip (including options to enable heap in external PSRAM, with optional transparent malloc() for large buffers)

Build System and tools

New functionality

• Support gcc Stack Smashing protection feature
• GCOV support over JTAG
• Runtime analysis via the SEGGER SysView tool using JTAG app tracing (documentation)
• New make print_flash_cmd to print flashing command (can be redirected to a file)
• Partition Table: Allow variables to span multiple CSV fields (#841)
• Make now warns by default if undefined variables are expanded (#138)
• Private include directories are now ordered before public ones in include search path
• New "silent assertions" option to save app binary size while keeping assertions enabled
• More complete "make size" output, new "make size_components" and "make size_files" targets for analysing ELF file makeup.
• Each COMPONENTS_DIR can now either be a components directory, or a parent directory containing subdirectories which are components
• esptool.py now generates smaller app binary images (almost 128KB smaller in some cases)

Bug fixes

• Fix idf_monitor crash on Windows 10 since Fall Creators Update (#1136)
• Fix idf_monitor "cancel" behaviour to match pyserial TIOCSTI ioctl
• Apply component-level definitions via CPPFLAGS not CFLAGS (#1165)
• Eclipse documentation: Fix CDT GCC parser to correctly parse C++ commands (#929)
• Updating the project Makefile now triggers a full rebuild

Bootloader

• Option to boost 1.8V VDDSDIO internal regulator voltage to 1.9V to workaround flash voltage stability issues.
• Improved robustness and fallback options if OTA configuration is invalid or configured image not bootable.
• App images now have a SHA256 hash of all contents appended by default. Bootloader verifies this if present.
• Boot time optimisations. Can be close to twice as fast to boot an app in 80MHz QIO mode.
• Allow custom SPI flash pin configurations for QIO/QOUT mode.

FreeRTOS

New Functionality

• Previously "untested" (assertion failing) FreeRTOS 8.2.0 functions now fully supported (including Queue Registry, Task Notifications, eTaskGetState())
• FreeRTOS Runtime statistics support (configurable via menuconfig)
• Many FreeRTOS 9.0.0 features & API calls have been backported (documentation)
• FreeRTOS tick and idle hooks are now per-core
• Overhead of spinlocks (portMUX) reduced for improved performance in dual core mode

Bug fixes

• Ringbuffer fixes for sizes which are not a multiple of 4.
• Fix bug xTaskResumeAll() sometimes not resuming all tasks.

SoC-Level functions

New Functionality

• Power Management: Support for SoC Light Sleep
• Power Management: Support for dynamic runtime frequency scaling.
• Brownout detector functionality (documentation)
• New function to mmap non-contiguous flash pages to a contiguous memory space
• High level interrupt handlers are now weak-linked symbols so components can override them
• New SPI flash mutex API allows combining multiple SPI flash operations (writes, etc.) as an atomic operation with reference to other tasks
• SPI flash erase/write operations disallowed in dangerous regions (bootloader, partition table, running app)

Bug Fixes

• By default, BASIC ROM Console fallback is permanently disabled (via efuse) on first boot, to avoid hardware accidentally resetting to this mode.
• Raise CPU core voltage when the maximum 80MHz SPI flash frequency is used (improves stability)
• Fix for interrupt allocation not always assigning the same source (issue)
• Disable unused peripheral clocks after reset, drivers will re-enable as needed
• Fix crashes when more than 185KB of DRAM is statically allocated
• Remove unused .data sections that were incorrectly linked into the final binary increasing RAM usage
• F...

ESP-IDF Release 2.1.1

Release 2.1.1 is a bug fix release. It includes the fixes for KRACK and BlueBorne vulnerabilities.

Documentation for release 2.1.1 is available at http://esp-idf.readthedocs.io/en/v2.1.1/.

This is the list of changes since release 2.1.

Build system and tools

• Add workaround for "git submodule" stray output bug on Windows

Bootloader

• Optimize pin configuration for 80MHz flash frequency
• Raise core voltage when 80MHz flash frequency is used
• Add option to boost VDDSDIO regulator voltage to 1.9V (enabled by default)

FreeRTOS

• Fix an assert that erroneously triggered when popping a zero-byte payload from the end of the ringbuffer
• Make sure xPortGetCoreID and uxTopUsedPriority are placed into IRAM
• Fix copy-paste error in HOLD_FORCE field name for GPIO26

SoC functions

• By default, assume 40MHz crystal frequency (autodetection can still be enabed in menuconfig)
• Fix possible lock-up when switching to higher CPU frequency
• Fix possible race condition while stalling other CPU during esp_restart

WiFi

• Fix a bug which caused calibration current as high as 800mA in some cases
• Fix WPA/WPA2 PTK and GTK re-install vulnerability issue

LwIP

• Take portTICK_PERIOD_MS into account when calculating timeouts
• Broadcast IP route based on source IP address

BT/BLE

• Add continuation offset check to SDP server
• Fix BLE controller lock-up in long duration BLE scan
• PHY library changes to increase BT/BLE performance
• Disable role switch feature in Classic BT to increase compatibility
• Adjust some timing parameters in BT/BLE controller to increase its stability
• Fix controller to host flow control bug in HCI
• Fix bonding-related bugs
• Fix memory corruption caused by BT/BLE controller
• Fix thread safety issues in BT/BLE host
• Fix SMP-related bugs

Drivers

• Fix reads/writes to/from unaligned buffers in SDMMC driver
• Fix swapped reset bits of HSPI/VSPI peripherals

Storage

• Check CRC of items on full pages in NVS library.

Third party libraries

• nghttp2: Add submodule to COMPONENT_SUBMODULES, update to release v1.24, build port directory

Obtaining v2.1.1

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 https://github.com/espressif/esp-idf.git esp-idf-v2.1.1
cd esp-idf-v2.1.1/
git checkout v2.1.1
git submodule update --init --recursive

This is the recommended way of obtaining v2.1.1 of ESP-IDF.

Download an archive with submodules included

Attached to this release is an esp-idf-v2.1.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.