Home

ESP32-TUX Documentation!

ESP32-TUX - A Touch UX template to get you started.

This project uses ESP-IDF 5.0 which is the official Espressif SDK.

How to install ESP-IDF

There are different ways to install ESP-IDF explained here

1. Through VS Code IDF extension
2. Install ESP-IDF manually and then once VS Code IDF extension is installed, it will automatically configure the paths from the extension configuration page.
3. Clone the IDF 5.0 release branch version of the IDF Github repo - only for experts.

On Windows make sure to install Windows Terminal from the Store for convenience. IDF installer will automatically create a shortcut in the Start menu. If Windows Terminal is installed, then an entry for IDF will be there as well. Drivers for devices are also installed automatically by the IDF installer.

Getting Started

Open IDF Terminal

• If IDF was installed through IDF VS Code Extension: Click on the bottom bar in VS Code to open IDF Terminal.
• If IDF was installed manually: Open IDF Terminal from shortcut menu.
  The above method is required to make sure the environment variables required for ESP-IDF are setup for compile, flashing etc

Device Configuration

Device Configuration using idf.py menuconfig

Using WT32-SC01 [ESP32]

# Configure device settings
idf.py menuconfig


# Navigate to `ESP32-TUX Configuration > Device Config > Select the device`
# Select Wireless-Tag WT32-SC01 from the device list
# Change `partitons/partition-8MB.csv` to `partitons/partition-4MB.csv` if your device came with 4MB Flash.

Device selection needs to be done from menuconfig and it will create sdkconfig file which will merge the content of device specific defaults in the root folder + the ones IDF has with additional configuration related to ESP32-TUX application.

# Build the firmware
idf.py build

# Flash the firmware and monitor serial output
idf.py -p <YOUR-SERIAL-PORT> flash monitor

Using WT32-SC01 Plus [ESP32-S3]

work in progress

Thanks to Zachary Vorhies for his doc contributions