Home

ESP32-TUX Documentation Wiki!

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 5.0 (released version)

Official ESP-IDF installation instructions link below

• Linux/Mac: https://docs.espressif.com/projects/esp-idf/en/v5.0/esp32/get-started/linux-macos-setup.html
• Windows: https://docs.espressif.com/projects/esp-idf/en/v5.0/esp32/get-started/windows-setup.html

There are different ways to install ESP-IDF for Windows, Linux and Mac.

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 - [Experts Only].

Drivers for devices are also installed automatically by the IDF installer.
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.

Getting Started with ESP32-TUX

Open IDF Terminal

• If ESP-IDF was installed through IDF VS Code Extension: Click on the bottom bar terminal icon in VS Code to open ESP-IDF Terminal.
• If ESP-IDF was installed manually: Open ESP-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

Watch the walkthrough which explains the 4 easy steps (clone, menuconfig, build, flash) required to get it working

Explore the remaining Configuration options

Run idf.py menuconfig to configure other settings under ESP32-TUX Configuration including

• WiFi Provisioning using Mobile App - Android App and iPhone App
• MQTT Config (work-in-progress)
• SNTP Config
• OTA Config
• Weather Config

Important customization configuration

• ESP32-TUX Configuration > SNTP Config > Timezone settings (Refer Wikipedia here)
• ESP32-TUX Configuration > OTA Config > OTA URL settings (use local python webserver.py)
• ESP32-TUX Configuration > Weather Config > Weather Location (Test the location here)
• ESP32-TUX Configuration > Weather Config > Weather Units
• ESP32-TUX Configuration > Weather Config > Weather API Key (Register for free API Key from OpenWeatherMap)

Thanks to Zachary Vorhies for his doc contributions