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-07-20 14:23:24 +09:00
committed by GitHub
parent 919b1741ae
commit 276e43b5f5
1 changed files with 9 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
README.md
View File

@@ -26,13 +26,13 @@ Get the 3D printable case!
- **Weather Fetching** from OpenWeatherMap (every 5 minutes, temp/humidity/description)
- **Fallback AP Mode** for easy first-time setup or configuration
- **Timezone Selection** from IANA names (DST integrated on backend)
- **Get My Location** button to get yoy aproximate Lat/Long.
- **Get My Location** button to get your aproximate Lat/Long.
- **Week Day and Weather Description display** in multiple languages
- **Persistent Config** stored in LittleFS, with backup/restore system
- **Status Animations** for WiFi conection, AP mode, time syncing.
- **Advanced Settings** panel with:
- Custom **Primary/Secondary NTP server** input
- Display **Day of the Week** toggle (defualt in on)
- Display **Day of the Week** toggle (default is on)
- **24/12h clock mode** toggle (24-hour default)
- **Imperial Units (°F)** toggle (metric °C defaults)
- Show **Humidity** toggle (display Humidity besides Temperature)
@@ -103,7 +103,7 @@ Click the **cog icon** next to “Advanced Settings” in the web UI to reveal e
- **Primary NTP Server**: Override the default NTP server (e.g. `pool.ntp.org`)
- **Secondary NTP Server**: Fallback NTP server (e.g. `time.nist.gov`)
- **Day of the Week**: Display Day of the Week in the disered language
- **Day of the Week**: Display Day of the Week in the desired language
- **24/12h Clock**: Switch between 24-hour and 12-hour time formats (24-hour default)
- **Imperial Units (°F)** toggle (metric °C defaults)
- **Humidity**: Display Humidity besides Temperature
@@ -113,13 +113,15 @@ Click the **cog icon** next to “Advanced Settings” in the web UI to reveal e
- **Dimming Feature**: Start time, end time and desired brightness selection
*Non-English characters converted to their closest English alphabet.
Tip: Dont't forget to press the save button to keep your settings
Tip: Don't forget to press the save button to keep your settings
---
## 📝 Configuration Notes
- **OpenWeatherMap API Key:** [Get yours here]([https://home.openweathermap.org/users/sign_up])
- **OpenWeatherMap API Key:**
- [Make an account here](https://home.openweathermap.org/users/sign_up)
- [Check your API key here](https://home.openweathermap.org/api_keys)
- **City Name:** e.g. `Tokyo`, `London`, etc.
- **Country Code:** 2-letter code (e.g., `JP`, `GB`)
- **ZIP Code:** Enter your ZIP code in the city field and US in the country field (US only)
@@ -168,7 +170,7 @@ Install the [LittleFS Uploader](https://randomnerdtutorials.com/arduino-ide-2-in
## 📺 Display Behavior
**ESPTimeCast** automatically switches between two display modes: Clock and Weather.
If "Show Weather Description" is eneabled a third mode (Description) will display with a duration of 3 seconds, if the description is too long to fit on the display the description will scroll from right to left once.
If "Show Weather Description" is enabled a third mode (Description) will display with a duration of 3 seconds, if the description is too long to fit on the display the description will scroll from right to left once.
What you see on the LED matrix depends on whether the device has successfully fetched the current time (via NTP) and weather (via OpenWeatherMap).
The following table summarizes what will appear on the display in each scenario:
@@ -184,7 +186,7 @@ The following table summarizes what will appear on the display in each scenario:
### **How it works:**
- The display automatically alternates between **Clock** and **Weather** modes (the duration for each is configurable).
- If "Show Weather Description" is eneabled a third mode **Description** will display after the **Weather** display with a duration of 3 seconds.
- If "Show Weather Description" is enabled a third mode **Description** will display after the **Weather** display with a duration of 3 seconds.
- In **Clock** mode, if NTP time is available, you’ll see the current time plus a unique day-of-week icon. If NTP is not available, you'll see `! NTP`.
- In **Weather** mode, if weather is available, you’ll see the temperature (like `23ºC`). If weather is not available but time is, it falls back to showing the clock. If neither is available, you’ll see `! TEMP`.
- All status/error messages (`! NTP`, `! TEMP`) are big icons shown on the dsiplay.