User's Manual

9. Get Started with ESP32-JCI-
R
9.1. Toolchain Setup
The quickest way to start development with ESP32 is by installing a prebuilt toolchain.
Pick up your OS below and follow provided instructions.
• Windows
• Linux
• Mac OS
Depending on your experience and preferences, instead of using a prebuilt toolchain,
you may want to customize your environment. To set up the system your own way go
to section Customized Setup of Toolchain.
Once you are done with setting up the toolchain then go to section Get ESP-IDF.
9.2. Get ESP-IDF
Besides the toolchain (that contains programs to compile and build the application),
you also need ESP32 specific API / libraries. They are provided by Espressif in ESP-
IDF repository.
To get it, open terminal, navigate to the directory you want to put ESP-IDF, and clone it
using git󰲧clone command:
ESP-IDF will be downloaded into ~/esp/esp-idf.
9.3. Set up Path to ESP-IDF
The toolchain programs access ESP-IDF using IDF_PATH environment variable. This
variable should be set up on your PC, otherwise projects will not build. Setting may be
done manually, each time PC is restarted. Another option is to set up it permanently by
defining IDF_PATH in user profile. To do so, follow instructions in Add IDF_PATH to
User Profile.
📖 Note:
We are using ~/esp directory to install the prebuilt toolchain, ESP-IDF and sample applications. You can
use different directory, but need to adjust respective commands.
cd󰲧~/esp
git󰲧clone󰲧--recursive󰲧https://github.com/espressif/esp-idf.git
📖 Note:
Do not miss the --recursive option. If you have already cloned ESP-IDF without this option, run
another command to get all the submodules:
cd󰲧~/esp/esp-idf
git󰲧submodule󰲧update󰲧--init