Sarvesh Bodakhe
93347494b3
1. Remove redundant fixes in upstream wpa_supplicant for USD
- Upstream supplicant has mostly fixed the issues regarding the
unnecessary resetting pauseStateTimeout.
- Upstream supplicant still needs one fix to avoid resetting the
pauseStateTimeout when subscribe message is received from the peer
which had triggered the pauseStateTimeout previously.
2. Replace array-based channel list with bitmap for NaN-USD
Use `wifi_scan_channel_bitmap_t` to represent the channel list for NaN-USD
publisher and subscriber configurations. This replaces the previous approach
that used a large array to store allowed channels.
Also aligns with internal scan bitmap conventions across Wi-Fi stack.
3. call esp_wifi_nan_stop() after USD exchange or STA stop
Ensure esp_wifi_nan_stop() is called after publish/subscribe activity
completes or when WIFI_EVENT_STA_STOP is received. This prevents NAN stop
errors due to inactive interface. NaN-USD currently uses STA interface
for Tx/Rx.
4. Fix task watchdog timer triggered in active USD subscriber:
As both USD supplicant and offchan TX component gets executed
in the wifi task, it created a deadlock like scenario where offchan TX
done callback was never getting executed and supplicant 'nan_de_timer'
keeps running but failing to send any subscribe frame.
5. Make sure that device is able to recieve action management frames
of size more than 1400 bytes.
6. Update proto field in SSI to match Wi-Fi Aware (NaN) spec format
The 'proto' field in the 'wifi_nan_wfa_ssi_t' structure previously used an
enum (wifi_nan_svc_proto_t), resulting in a 32-bit field. According to
the Wi-Fi NAN Specification (Table 5.7), this field must be a single
octet (8 bits). This commit updates the type to uint8_t to ensure
compliance with the specification.
This mismatch previously triggered warnings but did not cause functional
errors.
7. Set `allow_broadcast` to true in USD Remain on channel
This enables the peer discovery as USD uses NAN-Network Multicast BSSID
as A3 address in publish frames.
8. Implement custom channel<->frequency conversion for NAN-USD
NaN-USD only permits 20 MHz bandwidth channels in the 2.4 GHz and 5 GHz bands
(as per section 4.5.3 of the Wi-Fi Aware Specification v4.0). To avoid linking
a large portion of upstream supplicant code for frequency-to-channel and
channel-to-frequency conversion, implement minimal custom helper functions.
9. Limit NAN_DE_MAX_SERVICE to 2 for ESP_SUPPLICANT
10. Note: Upstream clamps negative `os_reltime` deltas to zero in `nan_de_srv_time_to_next()`,
but our ESP_SUPPLICANT port keeps `os_time_t` unsigned, so that guard just provokes a
compiler warning. We skip it for now because the scheduling loop validates past timestamps
before computing the diff.
Co-authored-by: Shyamal Khachane <shyamal.khachane@espressif.com>
Espressif IoT Development Framework
ESP-IDF is the development framework for Espressif SoCs supported on Windows, Linux and macOS.
ESP-IDF Release Support Schedule
- Please read the support policy and the documentation for more information about ESP-IDF versions.
- Please see the End-of-Life Advisories for information about ESP-IDF releases with discontinued support.
ESP-IDF Release and SoC Compatibility
The following table shows ESP-IDF support of Espressif SoCs where 
| Chip | v5.1 | v5.2 | v5.3 | v5.4 | v5.5 | v6.0 | |
|---|---|---|---|---|---|---|---|
| ESP32 | |
|
|
|
|
|
|
| ESP32-S2 | |
|
|
|
|
|
|
| ESP32-C3 | |
|
|
|
|
|
|
| ESP32-S3 | |
|
|
|
|
|
Announcement |
| ESP32-C2 | |
|
|
|
|
|
Announcement |
| ESP32-C6 | |
|
|
|
|
|
Announcement |
| ESP32-H2 | |
|
|
|
|
|
Announcement |
| ESP32-P4 | |
|
|
|
Announcement | ||
| ESP32-C5 | |
|
Announcement | ||||
| ESP32-C61 | |
|
Announcement | ||||
| ESP32-H4 | |
Announcement |
There are variants of revisions for a series of chips. See Compatibility Between ESP-IDF Releases and Revisions of Espressif SoCs for the details of the compatibility between ESP-IDF and chip revisions.
Espressif SoCs released before 2016 (ESP8266 and ESP8285) are supported by RTOS SDK instead.
Developing With ESP-IDF
Setting Up ESP-IDF
See https://idf.espressif.com/ for links to detailed instructions on how to set up the ESP-IDF depending on chip you use.
Note: Each SoC series and each ESP-IDF release has its own documentation. Please see Section Versions on how to find documentation and how to checkout specific release of ESP-IDF.
Non-GitHub forks
ESP-IDF uses relative locations as its submodules URLs (.gitmodules). So they link to GitHub. If ESP-IDF is forked to a Git repository which is not on GitHub, you will need to run the script tools/set-submodules-to-github.sh after git clone.
The script sets absolute URLs for all submodules, allowing git submodule update --init --recursive to complete. If cloning ESP-IDF from GitHub, this step is not needed.
Finding a Project
As well as the esp-idf-template project mentioned in Getting Started, ESP-IDF comes with some example projects in the examples directory.
Once you've found the project you want to work with, change to its directory and you can configure and build it.
To start your own project based on an example, copy the example project directory outside of the ESP-IDF directory.
Quick Reference
See the Getting Started guide links above for a detailed setup guide. This is a quick reference for common commands when working with ESP-IDF projects:
Setup Build Environment
(See the Getting Started guide listed above for a full list of required steps with more details.)
- Install host build dependencies mentioned in the Getting Started guide.
- Run the install script to set up the build environment. The options include
install.batorinstall.ps1for Windows, andinstall.shorinstall.fishfor Unix shells. - Run the export script on Windows (
export.bat) or source it on Unix (source export.sh) in every shell environment before using ESP-IDF.
Configuring the Project
idf.py set-target <chip_name>sets the target of the project to<chip_name>. Runidf.py set-targetwithout any arguments to see a list of supported targets.idf.py menuconfigopens a text-based configuration menu where you can configure the project.
Compiling the Project
idf.py build
... will compile app, bootloader and generate a partition table based on the config.
Flashing the Project
When the build finishes, it will print a command line to use esptool to flash the chip. However you can also do this automatically by running:
idf.py -p PORT flash
Replace PORT with the name of your serial port (like COM3 on Windows, /dev/ttyUSB0 on Linux, or /dev/cu.usbserial-X on MacOS. If the -p option is left out, idf.py flash will try to flash the first available serial port.
This will flash the entire project (app, bootloader and partition table) to a new chip. The settings for serial port flashing can be configured with idf.py menuconfig.
You don't need to run idf.py build before running idf.py flash, idf.py flash will automatically rebuild anything which needs it.
Viewing Serial Output
The idf.py monitor target uses the esp-idf-monitor tool to display serial output from Espressif SoCs. esp-idf-monitor also has a range of features to decode crash output and interact with the device. Check the documentation page for details.
Exit the monitor by typing Ctrl-].
To build, flash and monitor output in one pass, you can run:
idf.py flash monitor
Compiling & Flashing Only the App
After the initial flash, you may just want to build and flash just your app, not the bootloader and partition table:
idf.py app- build just the app.idf.py app-flash- flash just the app.
idf.py app-flash will automatically rebuild the app if any source files have changed.
(In normal development there's no downside to reflashing the bootloader and partition table each time, if they haven't changed.)
Erasing Flash
The idf.py flash target does not erase the entire flash contents. However it is sometimes useful to set the device back to a totally erased state, particularly when making partition table changes or OTA app updates. To erase the entire flash, run idf.py erase-flash.
This can be combined with other targets, ie idf.py -p PORT erase-flash flash will erase everything and then re-flash the new app, bootloader and partition table.
Resources
-
Documentation for the latest version: https://docs.espressif.com/projects/esp-idf/. This documentation is built from the docs directory of this repository.
-
The esp32.com forum is a place to ask questions and find community resources.
-
Check the Issues section on github if you find a bug or have a feature request. Please check existing Issues before opening a new one.
-
If you're interested in contributing to ESP-IDF, please check the Contributions Guide.