Skip to content

Commit 91ec9dc

Browse files
committed
add initial docs for the icon256 word clock
1 parent 38b41a1 commit 91ec9dc

File tree

7 files changed

+218
-3
lines changed

7 files changed

+218
-3
lines changed

docs/guides/icon256-word-clock.md

Lines changed: 209 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,209 @@
1+
# Icon256 - Word Clock
2+
3+
How to set up and configure the [ThingPulse Icon256 - Word Clock](https://thingpulse.com/product/icon256-word-clock/).
4+
5+
---
6+
7+
![](../img/guides/icon256-word-clock/icon256-word-clock.jpg)
8+
9+
The Icon256 - Word Clock comes pre-programmed with a modified version of [WLED](https://kno.wled.ge/), a powerful and feature-rich firmware for controlling addressable LED strips. This guide will help you get your word clock up and running in minutes.
10+
11+
## Quick Start
12+
13+
### Power On
14+
15+
Connect the Icon256 - Word Clock to a USB-C power source (5V, at least 1A recommended). The word clock will power on automatically and display a default animation.
16+
17+
### Connect to WiFi
18+
19+
When powered on for the first time, the Icon256 creates its own WiFi access point for easy configuration.
20+
21+
1. **Quick connect with QR code**: Scan this QR code with your smartphone to connect automatically to the access point:
22+
23+
![Scan to connect to default access point](../img/guides/icon256-word-clock/default-ap-qr.png)
24+
25+
*Alternatively, if the QR code doesn't work:* Manually find and connect to the WiFi network named `WLED-AP` (or similar, may include the device's chip ID) using the password `wled1234`
26+
27+
2. **Open the configuration page**:
28+
- Your device should automatically open a captive portal
29+
- If not, open a web browser and navigate to `http://4.3.2.1`
30+
31+
![WLED settings interface](../img/guides/icon256-word-clock/setup/0-settings.webp)
32+
33+
3. **Configure WiFi settings**:
34+
- Click on the "WIFI SETUP" button
35+
- Select your home WiFi network from the list
36+
- Enter your WiFi password
37+
- Click "Save & Connect"
38+
4. **Reconnect to your home WiFi**: After a few seconds, the Icon256 will restart and connect to your home network
39+
- Reconnect your phone/computer to your regular WiFi network
40+
- The web interface will display the IP address assigned to your Icon256
41+
42+
!!! tip
43+
Write down the IP address shown on the configuration page. You can access the WLED interface anytime by entering this IP address in your browser while connected to the same WiFi network.
44+
45+
### Install the WLED App
46+
47+
For the best mobile experience, install the official WLED app on your smartphone:
48+
49+
**For iOS:**
50+
51+
1. Open the [App Store](https://apps.apple.com/ch/app/wled-native/id6446207239)
52+
2. Search for "WLED" by Christophe Ganier
53+
3. Download and install the app
54+
4. Open the app - it will automatically discover your Icon256 if it is on the same WiFi network
55+
56+
**For Android:**
57+
58+
1. Open the [Google Play Store](https://play.google.com/store/apps/details?id=ca.cgagnier.wlednativeandroid)
59+
2. Search for "WLED" by Christian Schwinne
60+
3. Download and install the app
61+
4. Open the app - it will automatically discover your Icon256 on the network
62+
63+
!!! note
64+
Make sure your phone is connected to the same WiFi network as your Icon256 - Word Clock.
65+
66+
### Select the Word Clock Effect
67+
68+
The Icon256 comes with a special word clock effect pre-configured. To activate it:
69+
70+
#### Using the Web Interface:
71+
72+
1. Open a web browser and enter the IP address of your Icon256
73+
2. In the main interface, click on the **Effects** tab (FX icon)
74+
3. Scroll through the effect list and select **"Word Clock"**
75+
4. The display will immediately switch to word clock mode, showing the current time
76+
77+
#### Using the WLED App:
78+
79+
1. Open the WLED app
80+
2. Tap on your Icon256 device from the discovered devices list
81+
3. Tap on the **Effects** button (star/sparkle icon)
82+
4. Scroll down and select **"Word Clock"**
83+
5. The time will now be displayed in words on your Icon256
84+
85+
### Set the Time Zone
86+
87+
For the word clock to display the correct time, you need to configure your time zone:
88+
89+
#### Using the Web Interface:
90+
91+
1. In the WLED web interface, click on the **Config** button (gear icon)
92+
2. Select **Time & Macros**
93+
3. In the **Time setup** section:
94+
- Enable **"Get time from NTP server"** checkbox
95+
- **NTP Server**: Use the default (`0.wled.pool.ntp.org`) or enter your preferred NTP server
96+
- **Timezone**: Enter your timezone offset in seconds, or use the UTC offset format
97+
- Example for PST (UTC-8): `-28800` or select from common timezone list
98+
- Example for CET (UTC+1): `3600`
99+
- Example for EST (UTC-5): `-18000`
100+
- **UTC offset**: Alternatively, set hours and minutes offset from UTC
101+
4. Click **Save** at the bottom of the page
102+
5. The Icon256 will synchronize with the NTP server and display the correct local time
103+
104+
#### Using the WLED App:
105+
106+
1. In the WLED app, tap on the device
107+
2. Tap the **Settings** icon (three dots or gear icon)
108+
3. Select **Time & Macros**
109+
4. Configure the same settings as described above
110+
5. Tap **Save**
111+
112+
!!! tip "Timezone Examples"
113+
- **Pacific Time (PST/PDT)**: UTC offset = -8 hours (-28800 seconds)
114+
- **Mountain Time (MST/MDT)**: UTC offset = -7 hours (-25200 seconds)
115+
- **Central Time (CST/CDT)**: UTC offset = -6 hours (-21600 seconds)
116+
- **Eastern Time (EST/EDT)**: UTC offset = -5 hours (-18000 seconds)
117+
- **Central European Time (CET/CEST)**: UTC offset = +1 hour (3600 seconds)
118+
- **UK Time (GMT/BST)**: UTC offset = 0 hours (0 seconds)
119+
120+
### Adjust Brightness
121+
122+
You can easily adjust the brightness to suit your environment:
123+
124+
- **Web Interface**: Use the brightness slider at the top of the main page
125+
- **WLED App**: Use the brightness slider in the main control screen
126+
- **Physical Button** (if your Icon256 has one): Short press to toggle on/off, long press to cycle through brightness levels
127+
128+
## Advanced Features
129+
130+
### Customization Options
131+
132+
The Word Clock effect offers several customization options:
133+
134+
1. **Color Selection**: Change the color of the displayed words
135+
- Tap the color palette icon
136+
- Choose your preferred color or create a custom one
137+
2. **Background Color**: Some word clock variants allow setting a background color for the non-lit words
138+
3. **Effect Intensity & Speed**: Adjust these sliders to modify the transition effects between time changes
139+
140+
### Presets
141+
142+
Save your favorite configurations as presets:
143+
144+
1. Configure the word clock effect with your preferred colors and settings
145+
2. Click on **Presets** (bookmark icon)
146+
3. Click **Save to ID** and choose an empty preset slot
147+
4. Give it a descriptive name (e.g., "Blue Word Clock")
148+
5. Access your presets anytime with one click
149+
150+
### Automatic Scheduling
151+
152+
You can schedule your word clock to turn on/off automatically:
153+
154+
1. Go to **Config** > **Time & Macros**
155+
2. Scroll to **Time-controlled presets**
156+
3. Set up to 10 different scheduled actions
157+
- Choose times and days of the week
158+
- Select presets or actions to trigger (e.g., turn off at night, turn on in the morning)
159+
160+
### Over-the-Air (OTA) Updates
161+
162+
Keep your WLED firmware up to date:
163+
164+
1. Go to **Config** > **Security & Updates**
165+
2. Click **Manual OTA Update**
166+
3. The system will check for updates and allow you to install the latest version
167+
168+
!!! warning
169+
Do not power off the device during an update. Ensure you have a stable power supply.
170+
171+
## Troubleshooting
172+
173+
### Word Clock Not Showing Correct Time
174+
175+
- Verify your timezone offset is correct
176+
- Ensure the Icon256 has internet access to reach the NTP server
177+
- Try manually syncing: Config > Time & Macros > click the sync button
178+
179+
### Cannot Connect to WiFi
180+
181+
- Ensure you entered the correct WiFi password
182+
- Check that your WiFi network uses 2.4GHz (the ESP32 does not support 5GHz networks)
183+
- Move the Icon256 closer to your WiFi router
184+
- Try resetting the WiFi settings by powering off, waiting 10 seconds, then powering back on
185+
186+
### Device Not Discovered in App
187+
188+
- Confirm both your phone and Icon256 are on the same WiFi network
189+
- Check your router settings - some routers isolate wireless clients from each other (AP isolation)
190+
- Try manually adding the device by IP address in the WLED app
191+
192+
### Reset to Factory Settings
193+
194+
If you need to completely reset your Icon256:
195+
196+
1. Go to **Config** > **Security & Updates**
197+
2. Click **Factory Reset**
198+
3. Confirm the action
199+
4. The device will restart with default settings
200+
201+
## Support
202+
203+
If you need help at any point with the Icon256 - Word Clock, please reach out to ThingPulse and their community through [https://support.thingpulse.com/](https://support.thingpulse.com/).
204+
205+
## Additional Resources
206+
207+
- [WLED Official Documentation](https://kno.wled.ge/)
208+
- [WLED GitHub Repository](https://github.com/Aircoookie/WLED)
209+
- [ThingPulse Support Portal](https://support.thingpulse.com/)
8.14 KB
Loading
184 KB
Loading
45.5 KB
Loading

docs/support.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,8 @@
11
# Support
22

3-
For its customers ThingPulse maintains a support forum at https://support.thingpulse.com. If you are stuck with any
3+
For its customers ThingPulse maintains a support forum at https://www.reddit.com/r/ThingPulse/. If you are stuck with any
44
of the guides or the how-tos you are welcome to ask for help there. While ThingPulse monitors activity in the forum
55
the community is encouraged to engage as well.
66

7-
It is quite likely that your question has been asked before by other customers. A quick search will unearth it.
7+
Please also check our old forum at https://support.thingpulse.com/ This is no longer maintained, but
8+
it is quite likely that your question has been asked before by other customers. A quick search will unearth it.

mkdocs.yml

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -66,6 +66,7 @@ nav:
6666
- Breathing Heart: guides/breathing-heart.md
6767
- AMo - CO2 Monitor: guides/amo-co2-monitor.md
6868
- Icon64 - ESP32 with RBG LED & audio: guides/icon64-esp32-rgb-led-audio.md
69+
- Icon256 - Word Clock: guides/icon256-word-clock.md
6970
- ESP8266 IoT Starter Kit: guides/iot-starter-kit.md
7071
- WiFi Color Display Kit: guides/wifi-color-display-kit.md
7172
- 2.9″ ESPaper Plus Kit: guides/espaper-plus-kit.md
@@ -80,6 +81,10 @@ nav:
8081
- WiFi Color Display Kit: specs/wifi-color-display-kit.md
8182
- 2.9" ESPaper Lite and Plus Kit: specs/2_9-espaper-kit-dimensions.md
8283

84+
watch:
85+
- docs/guides
86+
- mkdocs.yml
87+
8388
markdown_extensions:
8489
# https://squidfunk.github.io/mkdocs-material/reference/admonitions/
8590
- admonition

requirements.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
mkdocs==1.5.3
1+
mkdocs==1.6.1
22
mkdocs-material==9.5.13
33
markdown-include>=0.5.1
44
pymdown-extensions>=7.0

0 commit comments

Comments
 (0)