Basic Info.
Model NO.
ESP-IDF Programming Guide
WiFi Antenna Type
Built-in
Transmission Rate
151-200Mbps
Certification
RoHS, FCC, CE
Product Description
If you need to buy more information about Espressif chip modules, solutions and other information, please feel free to send relevant information to our email,we will serve you wholeheartedly.
esp32 user agent esp32 zabbix agent espressif company ESP-IDF Programming GuideThis is the documentation for Espressif IoT Development Framework (esp-idf). ESP-IDF is the official development framework for the ESP32 chip. This document is intended to help you set up the software development environment for the hardware based on the ESP32 chip by Espressif.
After that, a simple example will show you how to use ESP-IDF (Espressif IoT Development Framework) for menu configuration, then building, and flashing firmware onto an ESP32 board.
Introduction
ESP32 is a system on a chip that integrates the following features:
Wi-Fi (2.4 GHz band)
Bluetooth 4.2
Dual high performance cores
Ultra Low Power co-processor
Several peripherals
Powered by 40 nm technology, ESP32 provides a robust, highly integrated platform, which helps meet the continuous demands for efficient power usage, compact design, security, high performance, and reliability.
Espressif provides basic hardware and software resources to help application developers realize their ideas using the ESP32 series hardware. The software development framework by Espressif is intended for development of Internet-of-Things (IoT) applications with Wi-Fi, Bluetooth, power management and several other system features.
What You Need
Hardware:
An ESP32 board
USB cable - USB A / micro USB B
Computer running Windows, Linux, or macOS
Software:
Toolchain to compile code for ESP32
Build tools - CMake and Ninja to build a full Application for ESP32
ESP-IDF that essentially contains API (software libraries and source code) for ESP32 and scripts to operate the Toolchain
Text editor to write programs (Projects) in C, e.g., Eclipse
Development Board Overviews
If you have one of ESP32 development boards listed below, you can click on the link to learn more about its hardware.
ESP32-DevKitC
ESP-WROVER-KIT
ESP32-PICO-KIT
ESP32-Ethernet-Kit
Installation Step by Step
This is a detailed roadmap to walk you through the installation process.
Setting up Development Environment
Step 1. Install prerequisites for Windows, Linux or macOS
Step 2. Get ESP-IDF
Step 3. Set up the tools
Step 4. Set up the environment variables
Creating Your First Project
Step 5. Start a Project
Step 6. Connect Your Device
Step 7. Configure
Step 8. Build the Project
Step 9. Flash onto the Device
Step 10. Monitor
Step 1. Install prerequisites
Some tools need to be installed on the computer before proceeding to the next steps. Follow the links below for the instructions for your OS
Step 2. Get ESP-IDF
To build applications for the ESP32, you need the software libraries provided by Espressif in ESP-IDF repository.
To get ESP-IDF, navigate to your installation directory and clone the repository with git clone, following instructions below specific to your operating system.
Linux and macOS
Open Terminal, and run the following commands:
cd ~/esp
git clone -b release/v4.1 --recursive https://github. com/espressif/esp-idf.git
ESP-IDF will be downloaded into ~/esp/esp-idf.
Consult ESP-IDF Versions for information about which ESP-IDF version to use in a given situation.
Windows
In addition to installing the tools, ESP-IDF Tools Installer for Windows introduced in Step 1 can also download a copy of ESP-IDF.
Consult ESP-IDF Versions for information about which ESP-IDF version to use in a given situation.
If you wish to download ESP-IDF without the help of ESP-IDF Tools Installer, refer to these instructions.
Step 3. Set up the tools
Aside from the ESP-IDF, you also need to install the tools used by ESP-IDF, such as the compiler, debugger, Python packages, etc.
Windows
ESP-IDF Tools Installer for Windows introduced in Step 1 installs all the required tools.
If you want to install the tools without the help of ESP-IDF Tools Installer, open the Command Prompt and follow these steps:
cd %userprofile%\esp\esp-idf
install.bat
or with Windows PowerShell
cd ~/esp/esp-idf
./install.ps1
Linux and macOS
cd ~/esp/esp-idf
./install.sh
Alternative File Downloads
The tools installer downloads a number of files attached to GitHub Releases. If accessing GitHub is slow then it is possible to set an environment variable to prefer Espressif's download server for GitHub asset downloads.
Windows
To prefer the Espressif download server when running the ESP-IDF Tools Installer or installing tools from the command line, open the System control panel, then click on Advanced Settings. Add a new Environment Variable (of type either User or System) with the name IDF_GITHUB_ASSETS and value /github_assets. Click OK once done.
If the command line window or ESP-IDF Tools Installer window was already open before you added the new environment variable, you will need to close and reopen it.
While this environment variable is still set, the ESP-IDF Tools Installer and the command line installer will prefer the Espressif download server.
Linux and macOS
To prefer the Espressif download server when installing tools, use the following sequence of commands when running install.sh:
cd ~/esp/esp-idf
export IDF_GITHUB_ASSETS="/github_assets"
./install.sh
Customizing the tools installation path
The scripts introduced in this step install compilation tools required by ESP-IDF inside the user home directory: $HOME/.espressif on Linux and macOS, %USERPROFILE%\.espressif on Windows. If you wish to install the tools into a different directory, set the environment variable IDF_TOOLS_PATH before running the installation scripts. Make sure that your user has sufficient permissions to read and write this path.
If changing the IDF_TOOLS_PATH, make sure it is set to the same value every time the Install script (install.bat, install.ps1 or install.sh) and an Export script (export.bat, export.ps1 or export.sh) are executed.
Step 4. Set up the environment variables
The installed tools are not yet added to the PATH environment variable. To make the tools usable from the command line, some environment variables must be set. ESP-IDF provides another script which does that.
Windows
ESP-IDF Tools Installer for Windows creates an "ESP-IDF Command Prompt" shortcut in the Start Menu. This shortcut opens the Command Prompt and sets up all the required environment variables. You can open this shortcut and proceed to the next step.
Alternatively, if you want to use ESP-IDF in an existing Command Prompt window, you can run:
%userprofile%\esp\esp-idf\export.bat
or with Windows PowerShell
.$HOME/esp/esp-idf/export.ps1
Linux and macOS
In the terminal where you are going to use ESP-IDF, run:
. $HOME/esp/esp-idf/export.sh
Note the space between the leading dot and the path!
If you plan to use esp-idf frequently, you can create an alias for executing export.sh:
Copy and paste the following command to your shell's profile (.profile, .bashrc, .zprofile, etc.)
alias get_idf='. $HOME/esp/esp-idf/export.sh'
Refresh the configuration by restarting the terminal session or by running source [path to profile], for example, source ~/.bashrc.
Now you can run get_idf to set up or refresh the esp-idf environment in any terminal session.
Technically, you can add export.sh to your shell's profile directly; however, it is not recommended. Doing so activates IDF virtual environment in every terminal session (including those where IDF is not needed), defeating the purpose of the virtual environment and likely affecting other software.
Step 5. Start a Project
Now you are ready to prepare your application for ESP32. You can start with get-started/hello_world project from examples directory in IDF.
Copy get-started/hello_world to ~/esp directory:
Linux and macOS
cd ~/esp
cp -r $IDF_PATH/examples/get-started/hello_world .
Windows
cd %userprofile%\esp
xcopy /e /i %IDF_PATH%\examples\get-started\hello_world hello_world
There is a range of example projects in the examples directory in ESP-IDF. You can copy any project in the same way as presented above and run it.
It is also possible to build examples in-place, without copying them first.
Step 6. Connect Your Device
Now connect your ESP32 board to the computer and check under what serial port the board is visible.
Serial ports have the following patterns in their names:
Windows: names like COM1
Linux: starting with /dev/tty
macOS: starting with /dev/cu.
If you are not sure how to check the serial port name, please refer to Establish Serial Connection with ESP32 for full details.
Step 7. Configure
Navigate to your hello_world directory from Step 5. Start a Project and run the project configuration utility menuconfig.
Linux and macOS
cd ~/esp/hello_world
idf.py menuconfig
Windows
cd %userprofile%\esp\hello_world
idf.py menuconfig
To navigate and use menuconfig, press the following keys:
Arrow keys for navigation
Enter to go into a submenu
Esc to go up one level or exit
? to see a help screen for menu or configuration item. Enter key exits the help screen
Space, or Y and N keys to enable (Yes) and disable (No) configuration items with checkboxes "[*]"
/ to find configuration items
Step 8. Build the Project
Build the project by running:
idf.py build
This command will compile the application and all ESP-IDF components, then it will generate the bootloader, partition table, and application binaries.
$ idf.py build
Running cmake in directory /path/to/hello_world/build
Executing "cmake -G Ninja --warn-uninitialized /path/to/hello_world"...
Warn about uninitialized values.
-- Found Git: /usr/bin/git (found version "2.17.0")
-- Building empty aws_iot component due to configuration
-- Component names: ...
-- Component paths: ...
... (more lines of build system output)
[527/527] Generating hello-world.bin
esptool.py v2.3.1
Project build complete. To flash, run this command:
../../../components/esptool_py/esptool/esptool.py -p (PORT) -b 921600 write_flash --flash_mode dio --flash_size detect --flash_freq 40m 0x10000 build/hello-world.bin build 0x1000 build/bootloader/bootloader.bin 0x8000 build/partition_table/partition-table.bin
or run 'idf.py -p PORT flash'
If there are no errors, the build will finish by generating the firmware binary .bin file.
Step 9. Flash onto the Device
Flash the binaries that you just built onto your ESP32 board by running:
idf.py -p PORT [-b BAUD] flash
Replace PORT with your ESP32 board's serial port name from Step 6. Connect Your Device.
You can also change the flasher baud rate by replacing BAUD with the baud rate you need. The default baud rate is 460800.
For more information on idf.py arguments, see idf.py.
Note
The option flash automatically builds and flashes the project, so running idf.py build is not necessary.
Running esptool.py in directory [...]/esp/hello_world
Executing "python [...]/esp-idf/components/esptool_py/esptool/esptool.py -b 460800 write_flash @flash_project_args"...
esptool.py -b 460800 write_flash --flash_mode dio --flash_size detect --flash_freq 40m 0x1000 bootloader/bootloader.bin 0x8000 partition_table/partition-table.bin 0x10000 hello-world.bin
esptool.py v2.3.1
Connecting....
Detecting chip type... ESP32
Chip is ESP32D0WDQ6 (revision 1)
Features: WiFi, BT, Dual Core
Uploading stub...
Running stub...
Stub running...
Changing baud rate to 460800
Changed.
Configuring flash size...
Auto-detected Flash size: 4MB
Flash params set to 0x0220
Compressed 22992 bytes to 13019...
Wrote 22992 bytes (13019 compressed) at 0x00001000 in 0.3 seconds (effective 558.9 kbit/s)...
Hash of data verified.
Compressed 3072 bytes to 82...
Wrote 3072 bytes (82 compressed) at 0x00008000 in 0.0 seconds (effective 5789.3 kbit/s)...
Hash of data verified.
Compressed 136672 bytes to 67544...
Wrote 136672 bytes (67544 compressed) at 0x00010000 in 1.9 seconds (effective 567.5 kbit/s)...
Hash of data verified.
Leaving...
Hard resetting via RTS pin...
If there are no issues by the end of the flash process, the module will be reset and the "hello_world" application will be running.
Step 10. Monitor
To check if "hello_world" is indeed running, type idf.py -p PORT monitor (Do not forget to replace PORT with your serial port name).
This command launches the IDF Monitor application:
$ idf.py -p /dev/ttyUSB0 monitor
Running idf_monitor in directory [...]/esp/hello_world/build
Executing "python [...]/esp-idf/tools/idf_monitor.py -b 115200 [...]/esp/hello_world/build/hello-world.elf"...
--- idf_monitor on /dev/ttyUSB0 115200 ---
--- Quit: Ctrl+] | Menu: Ctrl+T | Help: Ctrl+T followed by Ctrl+H ---
ets Jun 8 2016 00:22:57
rst:0x1 (POWERON_RESET),boot:0x13 (SPI_FAST_FLASH_BOOT)
ets Jun 8 2016 00:22:57
...
After startup and diagnostic logs scroll up, you should see "Hello world!" printed out by the application.
...
Hello world!
Restarting in 10 seconds...
I (211) cpu_start: Starting scheduler on APP CPU.
Restarting in 9 seconds...
Restarting in 8 seconds...
Restarting in 7 seconds...
To exit IDF monitor use the shortcut Ctrl+].
If IDF monitor fails shortly after the upload, or, if instead of the messages above, you see random garbage similar to what is given below, your board is likely using a 26MHz crystal. Most development board designs use 40MHz, so ESP-IDF uses this frequency as a default value.
Garbled output
If you have such a problem, do the following:
Exit the monitor.
Go back to menuconfig.
Go to Component config -> ESP32-specific -> Main XTAL frequency, then change CONFIG_ESP32_XTAL_FREQ_SEL to 26MHz.
After that, build and flash the application again.
See also:
IDF Monitor for handy shortcuts and more details on using IDF monitor.
idf.py for a full reference of idf.py commands and options.
That's all that you need to get started with ESP32!
Now you are ready to try some other examples, or go straight to developing your own applications.
Updating ESP-IDF
You should update ESP-IDF from time to time, as newer versions fix bugs and provide new features. The simplest way to do the update is to delete the existing esp-idf folder and clone it again, as if performing the initial installation described in Step 2. Get ESP-IDF.
Another solution is to update only what has changed. The update procedure depends on the version of ESP-IDF you are using.
After updating ESP-IDF, execute the Install script again, in case the new ESP-IDF version requires different versions of tools. See instructions at Step 3. Set up the tools.
Once the new tools are installed, update the environment using the Export script. See instructions at Step 4. Set up the environment variables.
Related Documents
Establish Serial Connection with ESP32
Build and Flash with Eclipse IDE
IDF Monitor
Customized Setup of Toolchain
Get Started (Legacy GNU Make)
API Reference
Bluetooth
Bluetooth Controller && VHCI
Bluetooth Common
Bluetooth LE
Bluetooth Classic
NimBLE
ESP-BLE-MESH
Networking
Wi-Fi
Ethernet
IP Network Layer
Application Layer
Peripherals
ADC
CAN
DAC
GPIO (including RTC low power I/O)
I2C
I2S
LED Control
MCPWM
Pulse Counter
Remote Control
SD Pull-up Requirements
SDMMC Host
SD SPI Host
SDIO Slave
Sigma-delta Modulation
SPI Master
SPI Slave
Temp sensor
Timer
Touch Sensor
UART
Protocols
ASIO
ESP-MQTT
ESP-TLS
HTTP Client
HTTP Server
HTTPS Server
ICMP Echo
Local Control
mDNS
Modbus
Websocket Client
ESP Serial Slave Link
IP Network Layer
Provisioning
Protocol Communication
Unified Provisioning
Wi-Fi Provisioning
Storage
FAT Filesystem
Mass Manufacturing Utility
Non-Volatile Storage
NVS Partition Generation Utility
SD/SDIO/MMC Driver
SPI Flash and Partition APIs
SPIFFS Filesystem
Virtual Filesystem
Wear Levelling
System
App image format
Application Level Tracing
eFuse Manager
Error Codes and Helper Functions
ESP HTTPS OTA
ESP pthread
Event Loop Library
FreeRTOS
FreeRTOS Additions
Heap Memory Allocation
Heap Memory Debugging
High Resolution Timer
Himem (large external SPI RAM) API
Inter-Processor Call
Call function with external stack
Interrupt Allocation
Logging
Miscellaneous System APIs
Over The Air Updates (OTA)
Performance Monitor
Power Management
Sleep Modes
Watchdogs
System Time
Configuration Options
Introduction
Project Configuration Menu
Using sdkconfig.defaults
Kconfig Formatting Rules
Backward Compatibility of Kconfig Options
Configuration Options Reference
Customisations
Error Codes Reference
ESP32 Hardware Reference
Technical Reference Manual (PDF)
Datasheet (PDF)
Hardware Design Guidelines (PDF)
Silicon Errata (PDF)
Modules and Boards
Modules
ESP32-WROOM-32
ESP32-WROOM-32D / ESP32-WROOM-32U
ESP32-SOLO-1
ESP32-WROVER series
ESP32-PICO-D4
Development Boards
ESP32-PICO-KIT V4.1
ESP32 DevKitC V4
ESP-WROVER-KIT V4.1
Related Documents
Previous Versions of Modules and Boards
Modules (No updated or discontinued modules)
Development Boards
ESP32-PICO-KIT V4
ESP32-PICO-KIT V3
ESP32 Core Board V2 / ESP32 DevKitC
ESP-WROVER-KIT V3
ESP-WROVER-KIT V2
ESP-WROVER-KIT V1 / ESP32 DevKitJ V1
ESP32 Demo Board V2
Related Documents
Espressif Products Ordering Information (PDF)
Regulatory Certificates
API Guides
Application Level Tracing
BluFi
Bootloader
Build System
Build System (Legacy GNU Make)
Console Component
Deep Sleep Wake Stubs
Error Handling
ESP-BLE-MESH
ESP-MESH (Wi-Fi)
ESP32 Core Dump
Event Handling
External SPI-connected RAM
Fatal Errors
Flash Encryption
FreeRTOS SMP Changes
General Notes
High Level Interrupts
JTAG Debugging
Linker Script Generation
lwIP TCP/IP Stack
Partition Tables
RF Calibration
ROM debug console
Secure Boot
Secure Boot V2
Thread Local Storage
Tools
ULP Coprocessor
ULP Coprocessor (Legacy GNU Make)
Unit Testing (Legacy GNU Make)
Unit Testing
WiFi Driver
Contributions Guide
We welcome contributions to the esp-idf project!
How to Contribute
Contributions to esp-idf - fixing bugs, adding features, adding documentation - are welcome. We accept contributions via Github Pull Requests.
Before Contributing
Before sending us a Pull Request, please consider this list of points:
Is the contribution entirely your own work, or already licensed under an Apache License 2.0 compatible Open Source License? If not then we unfortunately cannot accept it.
Does any new code conform to the esp-idf Style Guide?
Does the code documentation follow requirements in Documenting Code?
Is the code adequately commented for people to understand how it is structured?
Is there documentation or examples that go with code contributions? There are additional suggestions for writing good examples in examples readme.
Are comments and documentation written in clear English, with no spelling or grammar errors?
Example contributions are also welcome. Please check the Creating Examples guide for these.
If the contribution contains multiple commits, are they grouped together into logical changes (one major change per pull request)? Are any commits with names like "fixed typo" squashed into previous commits?
If you're unsure about any of these points, please open the Pull Request anyhow and then ask us for feedback.
Pull Request Process
After you open the Pull Request, there will probably be some discussion in the comments field of the request itself.
Once the Pull Request is ready to merge, it will first be merged into our internal git system for in-house automated testing.
If this process passes, it will be merged onto the public github repository.
Legal Part
Before a contribution can be accepted, you will need to sign our Contributor Agreement. You will be prompted for this automatically as part of the Pull Request process.
Related Documents
Espressif IoT Development Framework Style Guide
Documenting Code
Documentation Add-ons and Extensions Reference
Creating Examples
API Documentation Template
Contributor Agreement
