Building

Building from Source

The following are the steps required to compile this project:

1. Download and setup the ESP-IDF (currently V5.5.x).

2. Select you target ESP32 chip.

idf.py set-target <YOUR_ESP_TYPE>

3. Build the project and flash it to the ESP32.

idf.py build
idf.py flash monitor

A detailed instruction on how to build, configure and flash a ESP-IDF project can also be found the official ESP-IDF guide.

WT32-ETH01 (Ethernet Uplink) Build

The firmware supports the WT32-ETH01 board, which uses a wired Ethernet (LAN8720) uplink instead of WiFi STA. In this mode the ESP32 receives its upstream connection via the RJ45 Ethernet port and provides a WiFi AP for clients.

To build the Ethernet variant, pass the additional sdkconfig defaults file:

idf.py -B build_eth -D 'SDKCONFIG_DEFAULTS=sdkconfig.defaults;sdkconfig.defaults.wt32_eth01' build

To flash:

idf.py -B build_eth -p /dev/ttyUSB0 flash monitor

Differences from the standard WiFi build:

• Upstream connection is wired Ethernet (DHCP or static IP) instead of WiFi STA
• The set_sta, set_mac, and scan CLI commands are not available
• The web interface omits the "Getting Started" and "WiFi Scan" pages

Multi-Target Build Scripts

For automated building across multiple ESP32 targets with esp-idf, use the provided build scripts:

./build_all_targets.sh