Compare commits

...

2 Commits

Author SHA1 Message Date
Robert McMahon 2118556fbd Add note that get_idf must be run before all idf.py commands 2025-12-28 18:00:13 -08:00
Robert McMahon e0c9dc5f2a Add ESP-IDF v6 setup instructions with get_idf() function 2025-12-28 17:58:12 -08:00
1 changed files with 28 additions and 1 deletions

View File

@ -30,9 +30,36 @@ High-performance UDP traffic generator firmware for ESP32 devices with interacti
- Python 3.7+ (for deployment scripts) - Python 3.7+ (for deployment scripts)
- USB serial connection to ESP32 device - USB serial connection to ESP32 device
### Building ### ESP-IDF Setup
Add this function to your `~/.bashrc` or `~/.zshrc` to activate ESP-IDF v6:
```bash ```bash
# ESP-IDF v6 activator
get_idf() {
export IDF_PATH="$HOME/Code/esp32/esp-idf-v6"
export IDF_PYTHON_ENV_PATH="$HOME/.espressif/python_env/idf6.0_py3.11_env"
export IDF_TOOLS_PYTHON="$IDF_PYTHON_ENV_PATH/bin/python"
export PATH="$IDF_PYTHON_ENV_PATH/bin:$PATH"
export PYTHONNOUSERSITE=1
. "$IDF_PATH/export.sh"
hash -r
echo "ESP-IDF : $(idf.py --version 2>/dev/null)"
echo "python : $(python --version)"
echo "idf.py : $(command -v idf.py)"
}
```
After adding the function, reload your shell configuration and run `get_idf` to activate the ESP-IDF environment.
### Building
**Note:** All `idf.py` commands require the ESP-IDF environment to be activated first by running `get_idf`.
```bash
# Activate ESP-IDF environment (required before all idf.py commands)
get_idf
# Set target (e.g., esp32c5, esp32s3, esp32) # Set target (e.g., esp32c5, esp32s3, esp32)
idf.py set-target esp32c5 idf.py set-target esp32c5