Add ESP-IDF v6 setup instructions with get_idf() function

This commit is contained in:
Robert McMahon 2025-12-28 17:58:12 -08:00
parent 886cbf291a
commit 78a98d8ca6
1 changed files with 22 additions and 0 deletions

View File

@ -30,6 +30,28 @@ 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
### ESP-IDF Setup
Add this function to your `~/.bashrc` or `~/.zshrc` to activate ESP-IDF v6:
```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 ### Building
```bash ```bash