{"id":24701633,"url":"https://github.com/smengerl/lcd_text_clock","last_synced_at":"2026-04-29T09:05:36.057Z","repository":{"id":273721236,"uuid":"911383928","full_name":"Smengerl/LCD_Text_Clock","owner":"Smengerl","description":"Multi purpose textual clock with LCD (HDD44780) based on ESP32","archived":false,"fork":false,"pushed_at":"2025-03-07T23:22:12.000Z","size":14420,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-06-15T18:20:41.300Z","etag":null,"topics":["3d-printing","esp32","esp32-arduino","hdd44780","maker"],"latest_commit_sha":null,"homepage":"","language":"C++","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Smengerl.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":".github/FUNDING.yml","license":"LICENSE.txt","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null},"funding":{"github":null,"patreon":null,"open_collective":null,"ko_fi":null,"tidelift":null,"community_bridge":null,"liberapay":null,"issuehunt":null,"otechie":null,"lfx_crowdfunding":null,"custom":["https://www.paypal.com/donate/?hosted_button_id=VANMS3GRBL4GY"]}},"created_at":"2025-01-02T22:19:46.000Z","updated_at":"2025-03-07T23:22:15.000Z","dependencies_parsed_at":"2025-03-08T00:21:31.809Z","dependency_job_id":"80537f90-9bf4-4f9d-80df-4e67ee4e119e","html_url":"https://github.com/Smengerl/LCD_Text_Clock","commit_stats":null,"previous_names":["smengerl/lcd_text_clock"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/Smengerl/LCD_Text_Clock","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Smengerl%2FLCD_Text_Clock","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Smengerl%2FLCD_Text_Clock/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Smengerl%2FLCD_Text_Clock/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Smengerl%2FLCD_Text_Clock/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Smengerl","download_url":"https://codeload.github.com/Smengerl/LCD_Text_Clock/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Smengerl%2FLCD_Text_Clock/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":261226178,"owners_count":23127275,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["3d-printing","esp32","esp32-arduino","hdd44780","maker"],"created_at":"2025-01-27T05:24:59.558Z","updated_at":"2026-04-29T09:05:36.041Z","avatar_url":"https://github.com/Smengerl.png","language":"C++","funding_links":["https://www.paypal.com/donate/?hosted_button_id=VANMS3GRBL4GY"],"categories":[],"sub_categories":[],"readme":"# LCD Text Clock\n\n[![3D Printing](https://img.shields.io/badge/3D_printing-STL-green)](#)\n[![ESPhome](https://img.shields.io/badge/homeassistant-ESPhome-green)](#)\n[![License](https://img.shields.io/badge/license-CC%20BY--SA%204.0-blue)](http://creativecommons.org/licenses/by-sa/4.0/)\n\nA text-based clock using an LCD display with I2C interface on an ESP microcontroller with automatic NTP time sync.\n\n## Table of Contents\n- [Mechanics](#mechanics)\n- [Electronics](#electronics)\n- [Software](#software)\n- [Usage](#usage)\n- [Customization Ideas](#customization-ideas)\n- [Acknowledgements](#acknowledgements)\n- [Development](#development)\n- [License](#license)\n- [Authors](#authors)\n\n- Displays the current time and date as text like \"five minutes to four\"\n- 16x2, 40*2 or 20x4 character LCD display support\n- Customizable animations\n- Supports buttons to flip between modes showing different informationwhich can be easily extended \n- Automatic backlight switching and dimming (optional feature) \n- Automatic time synchronization using NTP\n\nThe whole project rather serves as an example how text on a LCD display can be beautifully presented to users and can easily be extended/adapter to match your usecase.\n\n| Without pushbuttons | With 4 pushbuttons |\n| ---------------------------- | --------------------------------------------------------------------|\n| ![example_usage_nobuttons](./print/photos/example_usage_nobuttons.jpg)  | ![example_usage](./print/photos/example_usage.jpg) |\n\n\n\n# Index\n- [Mechanics](#Mechanics)\n- [Electronics](#Electronics)\n- [Software](#Software)\n- [Usage](#Usage)\n- [Customization ideas](#customization_ideas)\n- [Acknowledgements](#Acknowledgements)\n\n\n\n## Mechanics\n\nTwo different types of housings for 20*4 LCD displays are provided.\nUsing the acrylic plate on top of the LCD is optional but gives a cleaner look (not used in the example photos)\n\nVery simple housing that consist of a front and a back piece (Shown is the version with the pushbuttons)\n\n| Front                                                | Back                                                 | Isometric |\n| ---------------------------------------------------- | ---------------------------------------------------- | --------- |\n| \u003cimg src=\"./print/rendering/front.png\" alt=\"front\"/\u003e | \u003cimg src=\"./print/rendering/back.png\" alt=\"back\"/\u003e   | \u003cimg src=\"./print/rendering/iso.png\" alt=\"iso\"/\u003e |\n| \u003cimg src=\"./print/photos/front.jpg\" alt=\"front\"/\u003e    | \u003cimg src=\"./print/photos/back.jpg\" alt=\"back\"/\u003e      | \u003cimg src=\"./print/photos/iso.jpg\" alt=\"iso\"/\u003e |\n\n\n### 3D-Printed Parts\n\n1. Without pushbuttons:\n\n| Filename                           | Thumbnail                                                                            | Required | Notes |\n| ---------------------------------- | -------------------------------------------------------------------------------------| -------- | ------|\n| `./print/stl/Lower_part_nobuttons.stl` | \u003cimg src=\"./print/png/Lower_part_nobuttons.png\" alt=\"Lower part\" width=\"300\"/\u003e | 1        |       |\n| `./print/stl/Upper_part_nobuttons.stl` | \u003cimg src=\"./print/png/Upper_part_nobuttons.png\" alt=\"Upper part\" width=\"300\"/\u003e | 1        |       |\n\n\n2. With 4 pushbuttons:\n\n\n| Filename                       | Thumbnail                                                                              | Required | Notes |\n| ------------------------------ | ---------------------------------------------------------------------------------------| -------- | ------|\n| `./print/stl/Lower_part.stl`       | \u003cimg src=\"./print/png/Lower_part.png\" alt=\"Lower part\" width=\"300\"/\u003e             | 1        |       |\n| `./print/stl/Upper_part.stl`       | \u003cimg src=\"./print/png/Upper_part.png\" alt=\"Upper part\" width=\"300\"/\u003e             | 1        |       |\n| `./print/stl/Pushbutton_base.stl`  | \u003cimg src=\"./print/png/Pushbutton_base.png\" alt=\"Pushbutton_base\" width=\"300\"/\u003e   | 1        |       |\n| `./print/stl/Pushbutton_cover.stl` | \u003cimg src=\"./print/png/Pushbutton_cover.png\" alt=\"Pushbutton_cover\" width=\"300\"/\u003e | 1        |       |\n\n\nPrinter settings:\n- All printed parts designed for PETG. \n- Best experience on my printer was to print the front upside down (the actual front of the case facing the print bed) as this does not require any supports. For a cleaner look you can consider to print it reversed with ironing enabled but note that this requires a lot of support material. \n- Using fuzzy skin for all outside walls creates a nice look\n- Use ironing to get a nice clean look on top of the pushbutton baseplate and cover\n- No rafts/brim etc. reguired for any model.\n\n### Required parts\n\n| Name              | Spec                          | Required | Notes |\n| ----------------- | ----------------------------- | -------- | ------|\n| countersunk screw | M3 5mm, e.g. DIN EN ISO 4762  | 4        | To attach ESP to back of housing |\n| countersunk screw | M3 5mm, e.g. DIN EN ISO 4762  | 4        | To attach display to back of housing |\n| cylinder head screw | M3 10mm | 4        | To fix back and front of housing |\n| semi-transparent acrylic board | max 2mm, 95-100mm * 40-50mm | 1        | Optional, for cleaner look |\n\n\n\n\n### Assembly\n\n- The ESP is screwed to the back of the housing.\n- The acrylic plate is glued to the front (optional)\n- The LCD is then fixed via screws to the front\n- When using the pushbuttons, click the pushbutton PCB into the baseplate and snap-in the pushbutton top cover. Then slide it into the lower part of the housing  \n- Finally the lower and the upper part of the housing are assembled and tightened via the screws.\n- Consider using some hot glue to make sure everything stays in place\n\n\n\n![assembly](./print/assembly.gif)\n\n\n\n\n\n\n## Electronics\n\n### Part list\n\n| Unit price | Quantity | Partname                   | Example   | Notes |\n| ---------- | -------- | -------------------------- | --------- | ----- |\n| 5 USD      | 1        | ESP32 Dev module           | \u003ca href=\"https://de.aliexpress.com/item/1005006474308440.html\"\u003eAliExpress\u003c/a\u003e | USB-C Version |\n| 5 USD      | 1        | 2004 HD44780 character LCD module | \u003ca href=\"https://de.aliexpress.com/item/1005006656450425.html\"\u003eAliExpress\u003c/a\u003e | Consider \"negative\" LCD (colored fonts on black background), as this gives a clean look, esp. when placing under an acrylic plate |\n| 1-2 USD    | 1        | PCF8574 I2C module for LCD | \u003ca href=\"https://de.aliexpress.com/item/1005006686091415.html\"\u003eAliExpress\u003c/a\u003e | You might want to pick one that has a jumper to enable/disable backlight as we can \"misuse\" this to dim the backlight via GPIO |\n| 1-2 USD    | Optional | 4 button module            | \u003ca href=\"https://de.aliexpress.com/item/1005007272677522.html\"\u003eAliExpress\u003c/a\u003e | Optional | Unsolder SMD LED |\n\nTotal cost about 10-15 USD!\n\n\n\n### Schematics\n\n\u003cimg src=\"./schematics/schematics.png\" alt=\"schematics\"/\u003e\n\n\u003cimg src=\"./schematics/breadboard.png\" alt=\"schematics\"/\u003e\n\n\n## Software\n\n### Prerequisites\n\n- PlatformIO\n- LiquidCrystal_I2C (via PIO)\n- ESPDateTime (via PIO)\n- WiFiManager (via PIO)\n\n\n### Installation\n\n1. Clone the repository:\n   ```sh\n   git clone https://github.com/smengerl/LCD_Text_Clock.git\n2. Open the project in PlatformIO.\n3. Wait for PIO to configure and download the required libraries\n4. Compile and upload the project to your ESP32 microcontroller.\n\n\n## Usage\n- Power on the ESP32.\n- On first usage only: Configure the ESP to your local WiFi. For this, connect to the ESP's access point and use the default configuration page to enter your WLAN SSID and password \n- Wait for NTP sync\n- The current time will be displayed on the LCD display.\n- Use the (optional) buttons to flip through the pages and watch the animation\n\n\n## Customization ideas\n\n- Modify the text and backlight settings in the code to customize the display.\n- Adjust the NTP server and time zone settings as needed.\n- Add more pages, e.g. showing sensor data\n- Get weather forecast via internet and display it on the screen with custom characters\n- Write your own animations for text transitions\n\n\n## Acknowledgements\n- ESPDateTime library by mcxiaoke\n- WiFiManager by wnatth3\n- LiquidCrystal_I2C by marcoschwartz\n\n\n\n\n## Development\n\nContributions are welcome.  \nSee `CONTRIBUTING.md` for details and follow the `CODE_OF_CONDUCT.md` when contributing.\n\nAll .stl, .png, and assembly pictures are automatically exported via my Fusion add-in, see [here](https://github.com/smengerl/fusion-exporter)\n\n## License\n\nThis project is licensed under the Creative Commons Attribution-ShareAlike 4.0 International License (CC BY-SA 4.0) — see `LICENSE.txt` for details or visit http://creativecommons.org/licenses/by-sa/4.0/\n\n## Authors\n\n- Simon Gerlach \u003chttps://github.com/Smenger\u003e\n\n---\n\nIf something in this README is missing or unclear, please open an issue in the repository so the instructions can be improved.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsmengerl%2Flcd_text_clock","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsmengerl%2Flcd_text_clock","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsmengerl%2Flcd_text_clock/lists"}