wordclock

This repository contains the firmware for the wordclock project.

Hardware

This project is designed for the A1-SLWF-03; user manual.

Prerequisites

1. Install Visual Studio Code

2. Install the PlatformIO extension in VS Code:

3. Clone this repository to your local machine.

4. Open the project folder in VS Code.

Set Wi-Fi Credentials

1. Open src/secrets.h.
2. Replace YOUR_WIFI_SSID_HERE and YOUR_WIFI_PASSWORD_HERE with your actual Wi-Fi SSID and password.

Building and Flashing

1. Open this project folder in VS Code.
2. In the PlatformIO sidebar (left), click PROJECT TASKS/esp32dev/General/Build
3. Connect your A1-SLWF-03 via a data-capable USB-C cable. Ensure the correct serial/port is selected in the bottom bar or in the PlatformIO configuration.
4. Click PROJECT TASKS/esp32dev/General/Upload to flash the device.

Building Documentation

Doxygen Documentation can be generated by following these steps:

1. Install doxygen and graphviz on your system.
2. From the root of the project, run:

   doxygen Doxyfile

3. The generated documentation will be in the doc/html folder. Open index.html in a web browser to view it.