ESP-IDF Setup Guide for ESP32-WROOM and ESP32-S3 Projects

This guide explains how to install and set up the Espressif IoT Development Framework (ESP-IDF) for ESP32-WROOM and ESP32-S3 modules.

Prerequisites

• Supported OS: Windows, macOS, or Linux
• Python 3.7 or newer

1. Install ESP-IDF

Using ESP-IDF Tools Installer (Windows)

1. Download the ESP-IDF Tools Installer.
2. Run the installer and follow the prompts to install ESP-IDF and required tools.

Using Git and Command Line (All Platforms)

git clone --recursive https://github.com/espressif/esp-idf.git
cd esp-idf
git checkout v5.1  # Or your preferred version
./install.sh       # For Linux/macOS
install.bat        # For Windows

2. Set Up Environment

• On Windows, use the "ESP-IDF Command Prompt" from the Start menu.
• On Linux/macOS, run:

. ./export.sh

3. Create and Build a Project

idf.py create-project my_project
cd my_project
idf.py set-target esp32      # For ESP32-WROOM
idf.py set-target esp32s3    # For ESP32-S3
idf.py menuconfig
idf.py build
idf.py flash

Note: By default, SPI and I2C sensor data collection are disabled. To enable them, add the following options to your build command:

• For I2C sensor support: -DI2C_SENSOR_ENABLED=ON
• For SPI SD card support: -DSPI_SD_CARD_ENABLED=ON

Example:

idf.py build -DI2C_SENSOR_ENABLED=ON -DSPI_SD_CARD_ENABLED=ON

4. Contributing to This Branch

To contribute changes, follow these steps:

1. Create a new branch:

   git checkout -b your-feature-branch

2. Make your changes and commit:

   git add .
   git commit -m "Describe your changes"

3. Push your branch to the remote repository:

   git push origin your-feature-branch

4. Create a Pull Request:
   • Go to the repository on GitHub.
   • Click "Compare & pull request" for your branch.
   • Add a description and submit the pull request for review and approval.

5. Additional Resources

• ESP-IDF Programming Guide
• ESP32-WROOM Datasheet
• ESP32-S3 Datasheet
• ESP32 Technical Reference Manual