-
-
Notifications
You must be signed in to change notification settings - Fork 55
Home
_ESP32-TUX - A Touch UX template to get you started.
This project uses ESP-IDF 5.0
which is the official Espressif SDK.
Official ESP-IDF installation instructions 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.
- Through VS Code IDF extension
- Install ESP-IDF manually and then once VS Code IDF extension is installed, it will automatically configure the paths from the extension configuration page.
- Clone the
IDF 5.0 release
branch version of the IDF Github repo - only for experts.
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.
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
Watch the walkthrough which explains the 3 easy steps required to get it working
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
- 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
ESP32-TUX Web Installer - tux.sukesh.me
By Sukesh Ashok Kumar - Website