Time, date, and weather on a LILYGO T5-4.7 ESP32 e-paper display.
Developed with Platform.IO & Arduino framework.
- The "PH 2.0 holder" variant of this EPD module (manufacturer's page)
- This battery, 3.7V 10.5aH
- A JST PH 2.0 connector
- ~10cm of 22 AWG wire (for hanging)
On my EPD board, when viewing the board side, with the ESP32 module at the top-right, the positive pin of the JST PH 2.0 connector is on the left. Be careful to connect the battery to the correct pins on your board, which may be different from mine, and do not attempt to charge the battery until you're sure it's hooked up properly.
The wires on the battery that I'm using came unterminated. I just soldered the wires together with those of a pre-terminated pigtail. These are easy to find online, but I just used what I had on hand and can't vouch for this exact product. Or do it the proper way with a connector and crimper, if you've got them.
Create a file at src/config.h and populate it with the following:
#define WIFI_SSID "Your WiFi SSID goes here"
#define WIFI_PASS "Your WiFi password goes here"
#define OWM_KEY "Your OpenWeatherMap API key goes here"
#define OWM_LAT 43.69264
#define OWM_LON -79.38091
#define TZ_INFO "EST5EDT,M3.2.0,M11.1.0" // https://github.com/nayarsystems/posix_tz_db/blob/master/zones.csv
#define VOLTAGE_INTERVAL 1800 // Seconds between battery voltage updates
#define NTP_INTERVAL 3600 // Seconds between NTP updates
#define WEATHER_INTERVAL 1800 // Seconds between weather updates
#define REDRAW_INTERVAL 3600 // Seconds between screen redrawsCustomize as needed.
Get your OpenWeatherMap API key here.
The NTP update interval may be unnecessarily short by default. Would be worth trying different values and checking the time against a known good clock.
The display is cleared and redrawn entirely every REDRAW_INTERVAL seconds. Helps to get rid of ghosting and clean up the display, as parts that should be blank (white) tend to darken over time, and garbage occasionally appears in unexpected places.
I'm using the variant of this display with a JST battery connector, along with this battery. This allows for a thinner case and longer battery life than with the 18650 variant. Case STL and OpenSCAD source are in the enclosure/ directory.
The EPD is fully powered off, along with the obnoxious blue LED, except when actively drawing. (The blue LED is always on when on USB power, but not on battery.)
I initially used the Arduino Ticker library, and then TickTwo in order to schedule various timed events. It quickly became clear that the current consumption was unsuitable for a battery-powered device, even when turning WiFi off when it wasn't needed and limiting screen updates to a reasonable extent.
I'm now putting the ESP32 into deep sleep mode when it can sit idle, waking it up once per minute to update the clock. (The sleep interval is recalculated each time, so that it'll update as close to the start of the next minute as possible.) In this scenario, the loop() function is never called, and everything happens in setup(). Values are stored in RTC memory to persist between sleep/wake cycles. Some good info on this topic was found here.
The clock will update every minute, on the minute (ish), but there will be some slop among the other update intervals. They'll happen as scheduled (ish) but may lag by up to a minute, causing the schedule to drift over time. Bear this in mind if you're watching and expecting to see eg. a weather update at a particular time.
The leftmost button (viewing the display-side in landscape orientation), labelled S5, pulls the ESP32's RST line to ground. This restarts the device.
I've considered assigning functions to the rightmost three buttons, but the design of this device makes that a hassle when combined with deep sleep.
I've decided it's sufficient to be able to restart the device if something goes wrong. To that end I plan on leaving a hole in the enclosure so I can press the reset button with a pen or something if needed.
The second-leftmost button is connected to the ESP32's GPIO 0, probably to put it into flash mode when pressed along with RST, but I can't remember offhand.
The remaining three buttons are active low. Their GPIOs have pull-up resistors on them. The ESP32 has two GPIO-triggered wake-up modes. The first, ext0, requires you to assign one GPIO to trigger wake-up, and will wake the device whether this goes from low to high or high to low. The second, ext1, will wake the device if one of several GPIOs goes from low to high; unfortunately all three of our available switches are already pulled up. In order to use multiple buttons, we'd need to use ext0 to wake the device, then enter an input-handling routine for some amount of time. Not difficult to do, but not worth the hassle in my opinion.
Partial updating of the screen is used for speed and, presumably, to reduce power consumption. Steps are taken to update parts of the screen only as needed. This could probably be taken a bit further by updating single characters (eg. if only the minute has changed), but I'm not sure it's worth the bother. For now, the entire hours-and-minutes field is cleared and redrawn when the time changes even by a minute, likewise the date, the temperature, and so on.
Dushyant Ahuja's SimpleWeather was taken and adapted for use in this project.
The LilyGo EPD47 driver from Valentin Roland's EPDiy project via Xinyuan-LilyGO is used in this project.
Weather icons are from the Meteocons font by Alessio Atzeni. A font conversion script is included in the LilyGo EPD47 project and was used here.
The NTP client is from here via Arduino Libraries.
Probably others that I'm forgetting, and there's a whole stack of other people's hard work beneath all of that.