Files
zonebridge/.vscode/ESP_SETUP.md

1.6 KiB

ESP-IDF Project Setup Guide

Your zonebridge project is configured to use ESP-IDF v5.5.1 located at /Users/brent/esp/v5.5.1/esp-idf.

Environment Setup

Option 1: Per-Session Setup (Quick)

Run this in your terminal before building:

export IDF_PATH=/Users/brent/esp/v5.5.1/esp-idf
export IDF_TOOLS_PATH=/Users/brent/.espressif
. $IDF_PATH/export.sh

Option 2: Permanent Shell Profile Setup

Add this to your ~/.zshrc file:

# ESP-IDF Setup
export IDF_PATH="/Users/brent/esp/v5.5.1/esp-idf"
export IDF_TOOLS_PATH="/Users/brent/.espressif"

# Source ESP-IDF export script
if [ -f "$IDF_PATH/export.sh" ]; then
    . "$IDF_PATH/export.sh"
fi

Then reload your shell:

source ~/.zshrc

Project Configuration

Your project is already configured with:

  • ESP-IDF Setup: /Users/brent/esp/v5.5.1/esp-idf
  • Target: ESP32-S3
  • Toolchain: xtensa-esp-elf-gcc (in ~/.espressif/tools/)
  • Clangd: Located at ~/.espressif/tools/esp-clang/

Building the Project

Once environment variables are set, you can:

  1. Build with VS Code: Use Command Palette (Cmd+Shift+P) → "ESP-IDF: Build Project"
  2. Build from Terminal:
    cd /Users/brent/zonebridge/zonebridge
    idf.py build
    

Flashing & Monitoring

idf.py flash monitor        # Flash and monitor output
idf.py menuconfig          # Open SDK configuration
idf.py clean               # Clean build artifacts

Troubleshooting

If you see "IDF_PATH not set" errors:

  1. Verify the export.sh script was sourced
  2. Check that echo $IDF_PATH returns /Users/brent/esp/v5.5.1/esp-idf
  3. Run idf.py doctor to diagnose any issues