github/ESPTimeCast
1
1
Fork 0
mirror of https://github.com/mfactory-osaka/ESPTimeCast.git synced 2026-02-19 11:54:56 -05:00
Code Issues Packages Projects Releases Wiki Activity

Update README.md

Browse Source
This commit is contained in:
M-Factory
2025-12-01 11:57:03 +09:00
committed by GitHub
parent 3b204b2f0a
commit d66c8f1a1a
1 changed files with 28 additions and 29 deletions
Download Patch File Download Diff File Expand all files Collapse all files

57
README.md
View File

@@ -18,14 +18,14 @@ It combines real-time NTP time sync, live OpenWeatherMap updates, and a modern w
To help support the project’s development, the official **ESPTimeCast** case design is available as a **paid STL download** (see links below).
If you prefer a free option, there are many compatible **MAX7219 LED matrix enclosures** shared by the community — you can find plenty by searching for “MAX7219 case” on Printables, Cults3D, or similar sites.
If you prefer a free option, there are many compatible **MAX7219 LED matrix enclosures** shared by the community - you can find plenty by searching for “MAX7219 case” on Printables, Cults3D, or similar sites.
<img src="assets/image01.png" alt="3D Printable Case V1" width="640" />
<img src="assets/image02.png" alt="3D Printable Case V2" width="640" />
<p align="left">
<a href="https://www.printables.com/model/1344276-esptimecast-wi-fi-clock-weather-display">
<img src="https://img.shields.io/badge/Printables-320%20Downloads-orange?logo=prusa" width="210">
<img src="https://img.shields.io/badge/Printables-324%20Downloads-orange?logo=prusa" width="210">
</a>
<br>
<a href="https://cults3d.com/en/3d-model/gadget/wifi-connected-led-matrix-clock-and-weather-station-esp8266-and-max7219">
@@ -127,18 +127,6 @@ This change improves **brightness**, **stability**, and protects the **onboard v
> **Tip:** Always double-check that VCC (5V), GND, and DIN/CS/CLK match your MAX7219 module’s pin order — different modules sometimes label them differently.
&nbsp;
## 🌐 Web UI & Configuration
The built-in web interface provides full configuration for:
- **WiFi settings** (SSID & Password)
- **Weather settings** (OpenWeatherMap API key, City, Country, Coordinates)
- **Time zone** (will auto-populate if TZ is found)
- **Day of the Week and Weather Description** languages
- **Display durations** for clock and weather (milliseconds)
- **Custom Scroll Text** - set a persistent scrolling message on the display directly from the Web UI
- **Advanced Settings** (see below)
&nbsp;
## First-time Setup / AP Mode
@@ -154,6 +142,28 @@ The built-in web interface provides full configuration for:
> External links and the "Get My Location" button require internet access.
They won't work while the device is in AP Mode - connect to WiFi first.
&nbsp;
## 🌐 Web UI & Configuration
ESPTimeCast includes a built-in Web UI that lets you fully configure the device from any browser — no apps required.
#### You can open the Web UI using either:
- http://esptimecast.local
mDNS / Bonjour - Works on macOS, iOS, Windows with Bonjour, and most modern browsers.
- The device’s **local IP address**
→ On every reboot, ESPTimeCast shows its IP on the LED display so you can easily connect.
#### The Web UI gives you control over:
- **WiFi settings** (SSID & Password)
- **Weather settings** (OpenWeatherMap API key, City, Country, Coordinates)
- **Time zone** (will auto-populate if TZ is found)
- **Day of the Week and Weather Description** languages
- **Display durations** for clock and weather (milliseconds)
- **Custom Scroll Text** - set a persistent scrolling message on the display directly from the Web UI
- **Advanced Settings** (see below)
&nbsp;
## UI Example:
<img src="assets/webui7.png" alt="Web Interface" width="640">
@@ -220,20 +230,7 @@ Follow these steps to prepare your Arduino IDE for ESP8266 development:
* `ArduinoJson` by Benoit Blanchon
* `MD_Parola` by majicDesigns (this will typically also install its dependency: `MD_MAX72xx`)
* `ESPAsyncTCP` by ESP32Async
* `ESPAsyncWebServer` by ESP32Async (**3.8.1**)
**⚠️ ESP8266 Library Compatibility Notice**
Due to internal changes in **ESPAsyncWebServer 3.9.0**, large files served from SPIFFS/LittleFS may fail to load on ESP8266 (blank page).
Version **3.8.1** is currently the most stable release for ESP8266, and is recommended for this project.
Install version **3.8.1** manually:
* Arduino IDE → Tools → Manage Libraries
* Search: ESPAsyncWebServer
* Install version 3.8.1
>Future versions may fix this, but for now 3.8.1 ensures full compatibility.
* `ESPAsyncWebServer` by ESP32Async (**3.8.1 or 3.9.1**)
&nbsp;
#### ⚙️ ESP32 Setup
@@ -251,7 +248,8 @@ Follow these steps to prepare your Arduino IDE for ESP32 development:
* `MD_Parola` by majicDesigns (this will typically also install its dependency: `MD_MAX72xx`)
* `AsyncTCP` by ESP32Async
* `ESPAsyncWebServer` by ESP32Async
&nbsp;
#### ⬆️ Uploading the Code and Data
Once your IDE is ready:
@@ -609,5 +607,6 @@ If you'd like to go further, you can also support development through the option