Develop your software wherever you go. It'll be there, in the cloud, right where you left it. Use your browser to develop with hosted workspaces or install desktop packaging to experience a modern development environment for Java, JavaScript, CSS, and HTML.
The ESP32 integrates Wi-Fi and Bluetooth on a single chip, along with dual high-performance cores, ultra-low power co-processor and several peripherals that make it a very robust chip as compared to the ESP8266. You can develop applications for the ESP32 using the Arduino IDE or the Eclipse IDE. This instructable is concerned with the later. Eclipse IDE for C/C Developers Version: 2018-09 (4.9.0) Build id: 201 OS: Windows 7, v.6.1, x8664 / win32 Java version: 1.8.0121. From the marketplace I installed the Eclipse C IDE for Arduino 3.0. In the Arduino Preferences I specified the package source for the ESP32 platform: I have set up an Ardiuno target with Board type: ESP32 Dev Model. In Output Parser add xtensa-esp32-elf- at the beginning of the line. Now click on apply again,then click on Ok button. Now we can build the project. To Flash the compiled code to the dev board, we need define a target. Select Build Target on right side of the IDE, right click on the project, select new. Provide target name as flash and click ok. Installing the Eclipse IDE The Eclipse IDE gives you a graphical integrated development environment (IDE) for writing, compiling and debugging ESP-IDF projects. It is quite a bit easier to use than the command line ESP-IDF provided by Espressif. It is also more sophisticated and better suited to larger projects than the Arduino IDE. Bugs & Feature Requests¶. If you face an issue with certain feature of VS Code or VS Code in general we recommend to ask your question in the forum, or open a github issue for our dev teams to review. We also welcome new feature request, most of the features we have today is result of people asking it to implement, or improve certain aspect of the extension, raise your feature request on github.
Tools
Extend the extensible platform.
An impressive collection of tools can be easily installed into your Eclipse desktop IDE, including GUI builders and tools for modeling, charting and reporting, testing, and more.
Marketplace
Customize and extend Eclipse and make it your own.
Use the Eclipse Marketplace Client to find, install, and vote for new plug-ins from our vast ecosystem of providers.
Extend
Join the Community.
Extend the desktop and web-based IDEs by writing your own plug-ins using the Plug-in Development Environment (PDE), or mash up features to build the web IDE of your dreams.
Discover
![Esp32 ide windows Esp32 ide windows](/uploads/1/3/7/4/137430204/988220952.jpg)
Find an Eclipse open source project.
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 for building and flashing firmware onto an ESP32 board.
Note
This is documentation for stable version v4.2.1 of ESP-IDF. Other ESP-IDF Versions are also available.
Introduction¶
ESP32 is a system on a chip that integrates the following features:
- Wi-Fi (2.4 GHz band)
- Bluetooth
- Dual high performance cores
- Ultra Low Power co-processor
- Multiple 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: War thunder german plane tree.
You have a choice to either download and install the following software manually
- Toolchain to compile code for ESP32
- Build tools - CMake and Ninja to build a full Application for ESP32 Desi tv series.
- ESP-IDF that essentially contains API (software libraries and source code) for ESP32 and scripts to operate the Toolchain
or get through the onboarding process using the following official plugins for integrated development environments (IDE) described in separate documents
- Eclipse Plugin (installation link)
- VS Code Extension (onboarding)
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.
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
Creating Your First Project¶
Step 1. Install prerequisites¶
Esp32 Eclipse Ideas
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
gitclone
, following instructions below specific to your operating system.Note
This guide uses the directory
~/esp
on Linux and macOS or %userprofile%esp
on Windows as an installation folder for ESP-IDF. You can use any directory, but you will need to adjust paths for the commands respectively. Keep in mind that ESP-IDF does not support spaces in paths.Linux and macOS¶
Open Terminal, and run the following commands:
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:
or with Windows PowerShell
Linux and macOS¶
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 account 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:
or with Windows PowerShell
Linux and macOS¶
In the terminal where you are going to use ESP-IDF, run:
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.) - Refresh the configuration by restarting the terminal session or by running
source[pathtoprofile]
, 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 the project get-started/hello_world to
~/esp
directory:Linux and macOS¶
Windows¶
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.
Important
The ESP-IDF build system does not support spaces in the paths to either ESP-IDF or to projects.
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.
Note
Keep the port name handy as you will need it in the next steps.
Step 7. Configure¶
Navigate to your
hello_world
directory from Step 5. Start a Project, set ESP32 chip as the target and run the project configuration utility menuconfig
.Linux and macOS¶
Windows¶
Setting the target with
idf.pyset-targetesp32
should be done once, after opening a new project. If the project contains some existing builds and configuration, they will be cleared and initialized. The target may be saved in environment variable to skip this step at all. See Selecting the Target for additional information.If the previous steps have been done correctly, the following menu appears:
Project configuration - Home window¶
You are using this menu to set up project specific variables, e.g. Wi-Fi network name and password, the processor speed, etc. Setting up the project with menuconfig may be skipped for “hello_word”. This example will run with default configuration.
Attention
If you use ESP32-DevKitC board with the ESP32-SOLO-1 module, enable single core mode (CONFIG_FREERTOS_UNICORE) in menuconfig before flashing examples.
Note
The colors of the menu could be different in your terminal. You can change the appearance with the option
--style
. Please run idf.pymenuconfig--help
for further information.Step 8. Build the Project¶
Build the project by running:
This command will compile the application and all ESP-IDF components, then it will generate the bootloader, partition table, and application binaries.
If there are no errors, the build will finish by generating the firmware binary .bin files.
Step 9. Flash onto the Device¶
Flash the binaries that you just built (bootloader.bin, partition-table.bin and hello-world.bin) onto your ESP32 board by running:
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.pybuild
is not necessary.Encountered Issues While Flashing?¶
If you run the given command and see errors such as “Failed to connect”, there might be several reasons for this. One of the reasons might be issues encountered by
esptool.py
, the utility that is called by the build system to reset the chip, interact with the ROM bootloader, and flash firmware. One simple solution to try is manual reset described below, and if it does not help you can find more details about possible issues in Troubleshooting.esptool.py
resets ESP32 automatically by asserting DTR and RTS control lines of the USB to serial converter chip, i.e., FTDI or CP210x (for more information, see Establish Serial Connection with ESP32). The DTR and RTS control lines are in turn connected to GPIO0
and CHIP_PU
(EN) pins of ESP32, thus changes in the voltage levels of DTR and RTS will boot ESP32 into Firmware Download mode. As an example, check the schematic for the ESP32 DevKitC development board.In general, you should have no problems with the official esp-idf development boards. However,
esptool.py
is not able to reset your hardware automatically in the following cases:- Your hardware does not have the DTR and RTS lines connected to
GPIO0
andCIHP_PU
- The DTR and RTS lines are configured differently
- There are no such serial control lines at all
Depending on the kind of hardware you have, it may also be possible to manually put your ESP32 board into Firmware Download mode (reset).
- For development boards produced by Espressif, this information can be found in the respective getting started guides or user guides. For example, to manually reset an esp-idf development board, hold down the Boot button (
GPIO0
) and press the EN button (CHIP_PU
). - For other types of hardware, try pulling
GPIO0
down.
Normal Operation¶
When flashing, you will see the output log similar to the following:
If there are no issues by the end of the flash process, the board will reboot and start up the “hello_world” application.
If you’d like to use the Eclipse or VS Code IDE instead of running
idf.py
, check out the Eclipse guide, VS Code guide.Step 10. Monitor¶
To check if “hello_world” is indeed running, type
idf.py-pPORTmonitor
(Do not forget to replace PORT with your serial port name).This command launches the IDF Monitor application:
Arduino Ide Esp32
After startup and diagnostic logs scroll up, you should see “Hello world!” printed out by the application.
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 26 MHz crystal. Most development board designs use 40 MHz, so ESP-IDF uses this frequency as a default value.
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 26 MHz.
- After that, build and flash the application again.
Note
You can combine building, flashing and monitoring into one step by running:
Esp32 Ide Windows
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.
Important
Some of examples do not support ESP32 because required hardware is not included in ESP32 so it cannot be supported.
If building an example, please check the README file for the
SupportedTargets
table. If this is present including ESP32 target, or the table does not exist at all, the example will work on ESP32.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.