README.org

Energos’s ESP32 Misadventures

Official Espressif Documentation

• ESP-IDF - IoT Development Framework
• ESP-IDF Getting Started
  • ESP-IDF Programming Guide - ESP32
  • ESP-IDF Programming Guide - ESP32-C3
  • ESP-IDF Programming Guide - ESP32-C6
• ESP-IDF Setup for Windows
• ESP-IDF Setup for Linux and macOS
• Updating ESP-IDF
• IDF Frontend - idf.py
• IDF Component Registry

ESP-IDF Linux Installation

Install Prerequisites

Void Linux

xbps-install git wget flex bison gperf python3 python3-pip python3-virtualenv cmake ninja ccache libffi-devel libssl3 dfu-util libusb

Debian

apt 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

Gentoo

emerge -avn dev-vcs/git wget flex bison gperf python dev-python/pip virtualenv cmake dev-util/ninja ccache libffi openssl dfu-util dev-libs/libusb

Download and Setup

mkdir -p ~/esp
cd ~/esp
git clone -b release/v5.2 --recursive https://github.com/espressif/esp-idf.git
cd ~/esp/esp-idf
./install.sh all

Update the environment

. ~/esp/esp-idf/export.sh
export ESPPORT=/dev/ttyUSB0

Add to your ~/.bashrc

alias idf_env='. $HOME/esp/esp-idf/export.sh ; export ESPPORT=/dev/ttyUSB0'

Upgrade

cd ~/esp/esp-idf
git fetch
git checkout v5.1.1
git submodule update --init --recursive
./install.sh all

ESP-IDF Usage

idf.py help
idf.py --list-targets
idf.py set-target esp32
idf.py menuconfig
idf.py build
idf.py -p /dev/ttyUSB0 flash
idf.py flash  # set ESPPORT environment variable first
idf.py monitor

Create or update .gitignore

cat >> .gitignore << EOF
build/
sdkconfig
sdkconfig.old
EOF

Create a new empty project

idf_env
idf.py create-project 00_empty
cd 00_empty
idf.py set-target esp32
idf.py menuconfig
idf.py build
idf.py flash
idf.py monitor

Down through the Rabbit Hole

• Simple Led Blinking