Skip to content

Commit 43a3992

Browse files
Update README.md
1 parent b012472 commit 43a3992

File tree

1 file changed

+59
-35
lines changed

1 file changed

+59
-35
lines changed

README.md

Lines changed: 59 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -1,49 +1,60 @@
11
# Wordclock 2.0
22
![compile esp8266 workflow](https://github.com/techniccontroller/wordclock_esp8266/actions/workflows/compile_esp8266.yml/badge.svg?branch=main)
33

4-
Wordclock 2.0 with ESP8266 and NTP time
4+
A modern Wi-Fi Word Clock powered by the ESP8266 and synchronized via NTP (Network Time Protocol).
5+
Displays time in words with support for multiple languages and colorful NeoPixel LED effects.
6+
Additional gaming modes, such as PONG, SNAKE, and TETRIS, can be played via an interactive Web UI.
57

6-
More details on my website: https://techniccontroller.com/word-clock-with-wifi-and-neopixel/
8+
**Project Details and Guide:**
79

10+
Full tutorial and build instructions on https://techniccontroller.com/word-clock-with-wifi-and-neopixel/
811

9-
**Languages**
10-
11-
The Wordclock is available in **German**, **English**, **Italian**, **French**, **Swiss German**, and **Javanese** language. By default the language is German.
12-
To use other languages like English or Italian please replace the file *wordclockfunctions.ino* with *wordclockfunctions.ino_english* or *wordclockfunctions.ino_italian*.
13-
The code compiles only with one file named *wordclockfunctions.ino*. So please rename the file you want to use to *wordclockfunctions.ino* and replace the existing file.
12+
## Features
13+
- 6 modes
14+
- Word Clock
15+
- Digital Clock
16+
- SPIRAL animation
17+
- TETRIS (playable via web interface)
18+
- SNAKE (playable via web interface)
19+
- PONG (playable via web interface)
20+
- Interactive Web-Based Games: Control PONG, TETRIS, and SNAKE directly through the built-in web UI
21+
- Real-time clock synchronized over Wi-Fi using NTP
22+
- Automatic daylight saving time (summer/winter) switching
23+
- Automatic timezone detection
24+
- Easy Wi-Fi setup with WiFiManager
25+
- Configurable color themes
26+
- Customizable night mode (start/end time)
27+
- Adjustable brightness settings
28+
- Automatic mode rotation
29+
- Web interface for configuration and control
30+
- Physical button for quick mode change or night mode toggle
31+
- Intelligent current limiting of LEDs
32+
- Dynamic color shifting mode
33+
34+
## Supported Languages
35+
36+
The WordClock currently supports the following languages:
37+
- **German (default)**
38+
- **English**
39+
- **Italian**
40+
- **French**
41+
- **Swiss German**
42+
- **Javanese**
43+
44+
**How to Change the Language**
45+
46+
To switch to another language:
47+
1. Go to the `wordclockfunctions.ino_<language>` file (e.g., `wordclockfunctions.ino_english`)
48+
2. Rename it to `wordclockfunctions.ino`
49+
3. Replace the existing `wordclockfunctions.ino` file
50+
4. Compile and upload the code to your ESP8266
51+
52+
Only one language file should be named wordclockfunctions.ino at any time for successful compilation.
1453

1554
Thank you to everyone who provided feedback on adding new languages and testing their accuracy — your efforts have been invaluable in making this project truly inclusive and reliable!
1655

17-
**Special Branches**
18-
19-
We've got some interesting branches in this repo inspired by user feedback. These branches explore unique features and experimental ideas. Some will stay updated with the main branch's features.
20-
21-
- [**hour_animation**](https://github.com/techniccontroller/wordclock_esp8266/tree/hour_animation): This branch replaces the spiral animation with some custom pattern animation defined as x/y coordinate pattern including custom color for each letter. Also, this animation is show ones per hour.
22-
![compile esp8266 workflow](https://github.com/techniccontroller/wordclock_esp8266/actions/workflows/compile_esp8266.yml/badge.svg?branch=hour_animation)
23-
- [**mode_seconds**](https://github.com/techniccontroller/wordclock_esp8266/tree/mode_seconds): This branch adds one additional mode to show the seconds as numbers on the clock. Thanks to [@Bram](https://github.com/BramWerbrouck)
24-
![compile esp8266 workflow](https://github.com/techniccontroller/wordclock_esp8266/actions/workflows/compile_esp8266.yml/badge.svg?branch=mode_seconds)
25-
- [**rgbw_leds**](https://github.com/techniccontroller/wordclock_esp8266/tree/rgbw_leds): This branch uses RGBW LEDs instead of RGB LEDs.
26-
![compile esp8266 workflow](https://github.com/techniccontroller/wordclock_esp8266/actions/workflows/compile_esp8266.yml/badge.svg?branch=rgbw_leds)
27-
- [**static_background_pattern**](https://github.com/techniccontroller/wordclock_esp8266/tree/static_background_pattern): This branch allows to light up specific letters always during clock mode. E.G., to display some special words in another color.
28-
![compile esp8266 workflow](https://github.com/techniccontroller/wordclock_esp8266/actions/workflows/compile_esp8266.yml/badge.svg?branch=static_background_pattern)
29-
3056

3157

32-
## Features
33-
- 6 modes (Clock, Digital Clock, SPIRAL animation, TETRIS, SNAKE, PONG)
34-
- time update via NTP server
35-
- automatic summer/wintertime change
36-
- automatic timezone selection
37-
- easy WIFI setup with WifiManager
38-
- configurable color
39-
- configurable night mode (start and end time)
40-
- configurable brightness
41-
- automatic mode change
42-
- webserver interface for configuration and control
43-
- physical button to change mode or enable night mode without webserver
44-
- automatic current limiting of LEDs
45-
- dynamic color shift mode
46-
4758
## Pictures of clock
4859
![modes_images2](https://user-images.githubusercontent.com/36072504/156947689-dd90874d-a887-4254-bede-4947152d85c1.png)
4960

@@ -68,6 +79,19 @@ We've got some interesting branches in this repo inspired by user feedback. Thes
6879

6980
<img src="https://techniccontroller.com/wp-content/uploads/filemanager1-1.png" height="300px" /> <img src="https://techniccontroller.com/wp-content/uploads/filemanager2-1.png" height="300px" /> <img src="https://techniccontroller.com/wp-content/uploads/filemanager3-1.png" height="300px" />
7081

82+
## Special Branches
83+
84+
We've got some interesting branches in this repo inspired by user feedback. These branches explore unique features and experimental ideas. Some will stay updated with the main branch's features.
85+
86+
- [**hour_animation**](https://github.com/techniccontroller/wordclock_esp8266/tree/hour_animation): This branch replaces the spiral animation with some custom pattern animation defined as x/y coordinate pattern including custom color for each letter. Also, this animation is show ones per hour.
87+
![compile esp8266 workflow](https://github.com/techniccontroller/wordclock_esp8266/actions/workflows/compile_esp8266.yml/badge.svg?branch=hour_animation)
88+
- [**mode_seconds**](https://github.com/techniccontroller/wordclock_esp8266/tree/mode_seconds): This branch adds one additional mode to show the seconds as numbers on the clock. Thanks to [@Bram](https://github.com/BramWerbrouck)
89+
![compile esp8266 workflow](https://github.com/techniccontroller/wordclock_esp8266/actions/workflows/compile_esp8266.yml/badge.svg?branch=mode_seconds)
90+
- [**rgbw_leds**](https://github.com/techniccontroller/wordclock_esp8266/tree/rgbw_leds): This branch uses RGBW LEDs instead of RGB LEDs.
91+
![compile esp8266 workflow](https://github.com/techniccontroller/wordclock_esp8266/actions/workflows/compile_esp8266.yml/badge.svg?branch=rgbw_leds)
92+
- [**static_background_pattern**](https://github.com/techniccontroller/wordclock_esp8266/tree/static_background_pattern): This branch allows to light up specific letters always during clock mode. E.G., to display some special words in another color.
93+
![compile esp8266 workflow](https://github.com/techniccontroller/wordclock_esp8266/actions/workflows/compile_esp8266.yml/badge.svg?branch=static_background_pattern)
94+
7195
## Install needed Libraries
7296

7397
Please download all these libraries as ZIP from GitHub, and extract them in the *libraries* folder of your Sketchbook location (see **File -> Preferences**):

0 commit comments

Comments
 (0)