Skip to content

Commit 99517c5

Browse files
committed
Refactor README.md for clarity and consistency; update feature list and enhance descriptions.
1 parent 80a2a24 commit 99517c5

1 file changed

Lines changed: 49 additions & 39 deletions

File tree

README.md

Lines changed: 49 additions & 39 deletions
Original file line numberDiff line numberDiff line change
@@ -17,56 +17,59 @@ Read the [feature enhancements below](#feature-enhancements)
1717
* Configurable scroll speed and LED brightness
1818
* Configurable data display and data update interval frequency
1919
* Configurable sleep / wake times
20-
* Configurable number of LED-matrix tiles (4 to >8) (compile option) and
20+
* Configurable number of LED-matrix tiles (4 to >8) and
2121
types of Clock Displays on larger panels, e.g. also display seconds or temperature
2222
* Video: https://youtu.be/DsThufRpoiQ
2323
* Build Video by Chris Riley: https://youtu.be/KqBiqJT9_lE
2424

2525
## Feature Enhancements
2626
Enhancements included in [THIS repository](https://github.com/rob040/LEDmatrixClock) [by rob040](https://github.com/rob040/) :
27-
* Removed the TimeZoneDB.com registration requirement.
28-
* Actual time zone information is used from OpenWeatherMap API.
29-
* Added Time NTP and more efficient time strings instead.
30-
* Update to new OpenWeatherMap.org API. Newly requested Free Service API-keys can no longer use the older call and structure.
27+
28+
* Updated to new OpenWeatherMap.org API. Newly requested Free Service API-keys can no longer use the older call and structure.
29+
* **Automatic timezone** is obtained from OpenWeatherMap API, using your configured location.
30+
* It is no longer required to register for TimeZoneDB.com. This provider has been removed from the code.
31+
* Add **Time NTP** to obtain regular time updates (original did not use NTP Network Time Protocol).
32+
* Use more efficient time strings. Also, all text strings are stored in program flash (PROGMEM).
3133
* Reduce RAM usage. The ESP8266 is an older WiFi processor with limited RAM (80kB), especially when compared to its newer ESP32 members.
32-
* Added MQTT support with basic Authentication, to get message to be displayed. Message is displayed immediately when display shows the time, and repeated every minute with default configuration.
33-
* Use VScode IDE with PlatformIO, for better development and maintenance experience and much better build environment and library version control.
34+
* Add **MQTT support** with basic Authentication, to get message to be displayed. Message is displayed immediately when display shows the time, and repeated every minute with default configuration.
35+
* Use **VS-Code IDE** with **PlatformIO**, for better development and maintenance experience and much better build environment and library version control.
3436
* Improved start-up on time synchronisation and weather data update.
3537
* Improved weather data display on webpage (minor changes).
36-
* Automatic timezone (from Local weather), hence no need for TimeZoneDB.
37-
* Added a favicon for easy recognition in your browser.
38-
* Support for different display sizes without re-compilation, via configuration page (device will reboot upon change).
39-
* Using the 'LittleFS' filesystem in stead of the deprecated 'SPIFFS' filesystem
40-
* Using ArduinoJson upgraded to version 7
41-
* Webpage now has switchable dark-mode view
42-
* Webpage now has switchable automatic page update
43-
* Instead of scrolling text, there is also a static display mode for short messages, date, temperature or humidity only next to the time display.
44-
* Weather Location lookup has been made simpler; there is no longer the need to lookup the City-ID code; just enter a (valid) city name with optional 2-letter country code. Also GPS coordinates are now allowed as location input.
45-
* Added a display QUIET time config option, where the display can be Off or Dimmed or Dimmed with no Motion (ie. no scrolling, no blinking)
46-
* Replaced Wifi_manager with ESP_WiFiManager_Lite library, which allows multiple WiFi Accesspoints (SSID's) to be (pre-)configured, which is handy for a portable device. It also provides a fallback if one WiFi station goes down.
47-
* Added user configurable temperature, wind speed and air pressure unit and conversions.
38+
* Add a **favicon** for easy recognition in your browser.
39+
* Support for **different matrix display sizes** without re-compilation, via configuration page (device will reboot upon change).
40+
* Using the 'LittleFS' filesystem in stead of the deprecated 'SPIFFS' filesystem.
41+
* Using ArduinoJson upgraded to version 7.
42+
* Webpage now has switchable **dark-mode view**.
43+
* Webpage now has switchable **automatic page update**.
44+
* Instead of scrolling text, there is also a **static display** mode for short messages, date, temperature or humidity, next to the time display.
45+
* Weather **Location** lookup has been made simpler; there is no longer the need to lookup the City-ID code; just enter a (valid) **city name** with optional 2-letter state or country code. Also **GPS coordinates** are now allowed as location input.
46+
* Added a display **QUIET time** config option, where the display can be Off or Dimmed or Dimmed with no Motion (ie. no scrolling, no blinking)
47+
* Replaced Wifi_manager with **ESP_WiFiManager_Lite** library, which allows **multiple WiFi Access Points** (SSID's) to be (pre-)configured, which is handy for a portable device. It also provides a fallback if one WiFi station goes down.
48+
* User **configurable units** for temperature (°C,°F,K), wind speed (m/s,kmh,mph,kn,Bft) and air pressure (mb,hPa,mmHg,inHg,psi,atm).
4849
* Removed the Imperial / Metric choice , with more customization freedom to the user.
4950
* The LED Display character font has been overhauled for more consistency and readability.
50-
* The hostname is now configurable. This hostname was "CLOCK-XXXXXX", where "XXXXXX" are device specific hex characters, which is still the default. A change will cause reboot, an empty entry will return to the default hostname.
51-
* The hostname is used for mDNS to access the webpage at <br>` http://hostname.local`
51+
* The hostname is now configurable. This hostname was "CLOCK-XXXXXX", where "XXXXXX" are device specific hex characters, which is still the default. An empty entry will return to the default hostname. A change will cause a reboot.
52+
* The hostname is used for mDNS to access the webpage at <br>` http://hostname.local`. This is shown at power-up.
5253
* The MQTT status message was changed and the publish frequency was reduced to once every hour, and after startup and after connection error recovery.
54+
* The used WiFi Access Point is shown at start-up and on main webpage.
55+
* The list of configured alternative WiFi Access Points, there can be 4, is shown on the main webpage.
56+
* The 'Forget Wifi' menu entry will enter the WifiManager, but the configured WiFi Access Points will NOT be forgotten, nor erased, meaning that when nothing is changed and all is still valid, a power-cycle will connect to the best available WiFi Access Point.
5357

54-
**NEW**
5558
* As of version 3.4.0, there is **multiple language support** for texts on the LED Matrix display. The web server pages will remain in English.
5659
* There is Language support for following languages:
57-
* => English
58-
* => Nederlands (Dutch)
59-
* => Deutsch (German)
60-
* => Français (French)
61-
* => Italiano (Italian)
62-
* => Español (Spanish)
63-
* => Português (Portuguese)
64-
* => Dansk (Danish)
65-
* => Norsk (Norwegian)
66-
* => Svenska (Swedish)
67-
* => Polski (Polish)
68-
* => Čeština (Czech)
69-
* => Slovenčina (Slovak)
60+
* => English
61+
* => Nederlands (Dutch)
62+
* => Deutsch (German)
63+
* => Français (French)
64+
* => Italiano (Italian)
65+
* => Español (Spanish)
66+
* => Português (Portuguese)
67+
* => Dansk (Danish)
68+
* => Norsk (Norwegian)
69+
* => Svenska (Swedish)
70+
* => Polski (Polish)
71+
* => Čeština (Czech)
72+
* => Slovenčina (Slovak)
7073

7174

7275
### known issues
@@ -76,9 +79,14 @@ Enhancements included in [THIS repository](https://github.com/rob040/LEDmatrixCl
7679

7780

7881
## Required Parts:
79-
* Wemos LOLIN D1 Mini ESP8266: https://www.wemos.cc/en/latest/d1/d1_mini.html
80-
Other EXP8266 boards based on [ESP12(-E,-F)](https://components101.com/sites/default/files/component_pin/ESP12E-Pinout.png) module, such as the NodeMCU, shall work equally well, only the 3D print models are more or less bound to the D1-mini physical dimensions.
81-
* MAX7219 LED Dot Matrix Module 4-in-1 Display (FC16) for Arduino. Commonly available from Chinese webshops, or Ebay or Amazon.com.
82+
* Wemos LOLIN D1 Mini ESP8266: https://www.wemos.cc/en/latest/d1/d1_mini.html <br>
83+
Other ESP8266 boards based on [ESP12(-E,-F)](https://components101.com/sites/default/files/component_pin/ESP12E-Pinout.png) module, such as the NodeMCU, shall work equally well, only the 3D print models are more or less bound to the D1-mini physical dimensions. <br>
84+
Get the D1 mini board from reputable source!
85+
There are clones around with sub-standard voltage regulators on board, that cannot supply the required 500mA. This can lead to unexpected hangups or resets when WiFi transmission is initiated. [See this](https://www.letscontrolit.com/forum/viewtopic.php?t=6603) and [this](https://github.com/bbqkees/Wemos-the-Clone-Wars#underpowered-ldo)
86+
* MAX7219 LED Dot Matrix Module 4-in-1 Display (FC16) for Arduino. Commonly available from Chinese webshops, or Ebay or Amazon.
87+
* A good 5V USB power supply
88+
* Optional Electrolytic Capacitor on the 5V rail of LED display. Capacity: 100 uF -- 1000 uF, Voltage: > 6 Volts, Low ESR.<br>
89+
This can be salvaged from disused electronic equipment, such as a power-supply or PC mother board. It must be of good quality though; at minimum, the top should not be bulged or broken.
8290

8391

8492
## Wiring for the Wemos D1 Mini to the MAX7218 LED Dot Matrix Display
@@ -97,6 +105,8 @@ The Connections in a picture:
97105
</p>
98106
Be aware that the display in above picture is actually upside-down. When viewed from front, the data input DIN is at the right hand side; the text on the PCB is usually upside-down.
99107

108+
Solder the Electrolytic Capacitor directly on the back of the LED display board, with (+) on VCC and (-) on GND.
109+
100110

101111
## 3D Printed Case by David Payne:
102112
Original Single Panel version: https://www.thingiverse.com/thing:2867294 <br>
@@ -127,7 +137,7 @@ Double Wide LED version: https://www.thingiverse.com/thing:2989552
127137

128138
From the .stl files posted on Thingiverse.com, a SketchUp model was re-created and new .stl with wider dotmatrix display module area was made. <br>
129139
Many [complained](https://www.thingiverse.com/thing:2867294/comments) that their dotmatrix display module didn't fit; some enlarged the X-axis in their slicer program to make it fit. Just too bad they needed to print it at least twice. <br>
130-
That was caused by the fact that the original .stl can only fit a matrix display module of 128.4 mm wide. <br>
140+
That was caused by the fact that the original .stl can only fit a matrix display module of 128.4 mm wide. (4x 32mm tight together) <br>
131141
The models available here will fit up to 132.0 mm wide display module. <br>
132142
Most other characteristics, such as the loosely fitting backplate, were left unchanged; the unmatched screw holes were fixed though.
133143

0 commit comments

Comments
 (0)