Skip to main content

ESP-IDF Installation and Usage Guide

Official Documentation​

Refer to the official documentation for detailed instructions:


Installation​

Windows​

esp

  • Open the installer and select all available board options.

esp

Creating and Configuring a Project - Espressif-IDE​

  1. Open the Espressif-IDE.

  2. Create a new project example.

esp

  1. Select the ESP32-C6 board.

esp

  1. Configure the project settings:

    • Set the clock speed to 40MHz.
    • Set the flash memory to 4MB.

  2. Build the project.

esp

  1. Flash the firmware to the board.

GNU/Linux (Ubuntu)​

Requirements​

Ensure Python3 is installed:

python3 --version

Install the required dependencies:

sudo apt-get install git wget flex bison gperf python3 python3-pip python3-venv cmake ninja-build ccache libffi-dev libssl-dev dfu-util libusb-1.0-0

Setting Up the Environment​

  1. Create a directory for ESP-IDF:

    mkdir -p ~/esp
    cd ~/esp
    git clone -b v5.3 --recursive https://github.com/espressif/esp-idf.git

  2. Install ESP32-C6 example:

    cd ~/esp/esp-idf
    ./install.sh esp32c6
note

To develop for multiple boards:

./install.sh esp32,esp32s2

You can also install all boards at once:

./install.sh all

Configuring Environment Variables​

Set up environment variables:

. $HOME/esp/esp-idf/export.sh

For frequent usage, create an alias:

alias get_idf='. $HOME/esp/esp-idf/export.sh'

Creating and Configuring a Project​

  1. Copy the "hello_world" example:

    cd ~/esp
    cp -r $IDF_PATH/examples/get-started/hello_world .

  2. Enter the project directory and configure the target board:

    cd ~/esp/hello_world
    idf.py set-target esp32c6
    idf.py menuconfig

    esp

    • Navigate to Serial flasher config.

    • Set clock speed to 40MHz and flash memory to 4MB.

  3. Build the project:

    idf.py build

  4. Flash the firmware:

    idf.py -p /dev/ttyACM0 flash

Uploading Firmware​

  1. Verify the device connection:

    lsusb
    dmesg | grep ttyACM*
    [ 6497.689351] cdc_acm 1-1:1.0: ttyACM0: USB ACM device

  2. Flash the firmware:

    idf.py -p /dev/ttyACM0 flash

esp_linux

  1. Confirm successful upload.

Using WSL​

  1. Open a terminal (PowerShell in administrator mode is recommended).
  2. Use usbipd to view connected USB devices and create a communication link.
  3. Attach the device: 
    usbipd attach --busid <bus-id>
  4. Verify the device in your Linux console.

To unlink the device:

  • Detach the device in PowerShell: 
    usbipd detach --busid <bus-id>
  • Unbind the device for Windows use: 
    usbipd unbind --busid <bus-id>

Additional Notes​

  • Always ensure the correct paths are used for your environment.
  • Refer to the official documentation for troubleshooting and advanced configurations.
  • For frequent commands, consider creating aliases to streamline your workflow.
  • Use idf.py commands for building, flashing, and managing projects.