explaingit

lagerpun/esp32-cyd-aquarium

Analysis updated 2026-05-18

21C++Audience · developerComplexity · 2/5LicenseSetup · moderate

TLDR

Firmware that turns a cheap ESP32 touchscreen board into a self-running animated desk aquarium with fish, plants, a clock, and optional Wi-Fi time sync.

Mindmap

mindmap
  root((esp32-cyd-aquarium))
    What it does
      Animated fish scene
      Auto backlight dimming
      Optional Wi-Fi clock sync
    Tech stack
      C++
      ESP32
      PlatformIO
    Use cases
      Desk decoration
      Cheap Yellow Display projects
      Offline clock display
    Audience
      Hobbyist makers

Code map

Detail Auto

An interactive map of this repo's files and how they connect — its source is parsed live in your browser. Click Visualize to build it.

filefunction / class

What do people build with it?

USE CASE 1

Flash a Cheap Yellow Display board to run as a self-contained animated desk aquarium.

USE CASE 2

Show a 12-hour clock overlaid on the aquarium scene, synced via optional Wi-Fi.

USE CASE 3

Let the board auto-dim its backlight based on ambient light using its built-in sensor.

USE CASE 4

Tap the touchscreen to trigger a feeding animation for the fish.

What is it built with?

C++ESP32PlatformIO

How does it compare?

lagerpun/esp32-cyd-aquariumjdduke/fpcppmegadroidgames/forza-horizon-6-rx-580-fh201-fh205-fix
Stars212121
LanguageC++C++C++
Last pushed2012-06-01
MaintenanceDormant
Setup difficultymoderateeasyeasy
Complexity2/52/52/5
Audiencedeveloperdevelopergeneral

Figures from each repo's GitHub metadata at analysis time.

How do you get it running?

Difficulty · moderate Time to first run · 30min

Requires PlatformIO to compile and flash firmware onto the specific ESP32-2432S028R board.

AGPL-3.0: you can use and modify it, but any modified version you distribute or run as a network service must also be released under AGPL-3.0.

In plain English

This project turns a small, inexpensive touchscreen board into a self-running animated aquarium you can leave on your desk. The board it targets is the ESP32-2432S028R, sometimes called the Cheap Yellow Display, a 2.8-inch color screen with a built-in microcontroller that costs a few dollars. Once you flash this firmware onto the board, it boots straight into an aquarium scene and runs on its own without any further input. The aquarium scene plays out on the screen as if it were a tiny LED grid. Fish, turtles, snakes, octopuses, and smaller drifting creatures move around autonomously. Plants sway in the background, food particles drift downward, and animated water fills the scene. A 12-hour clock with the date is overlaid on the display at all times. The board dims its own backlight automatically based on ambient light, using a sensor already built into the hardware. Wi-Fi is entirely optional. If you provide your home network credentials before flashing, the board connects briefly to sync the time from the internet and then disconnects. If you skip Wi-Fi entirely, the clock falls back to the time the firmware was compiled, which is close enough for a desk decoration. Optionally, tapping the touchscreen triggers a feeding animation. Installing it requires a free tool called PlatformIO, which handles downloading the right libraries and compiling the code for this specific board. The README includes commands for building and flashing, along with separate documentation pages covering hardware quirks, Wi-Fi setup, and troubleshooting for boards that behave slightly differently from the tested model. The project is adapted from an earlier open-source aquarium animation made for a different type of LED panel. The author reworked it for the Cheap Yellow Display hardware. The license is AGPL-3.0, inherited from that upstream project.

Copy-paste prompts

Prompt 1
Help me install PlatformIO and flash esp32-cyd-aquarium onto a Cheap Yellow Display board.
Prompt 2
Explain how esp32-cyd-aquarium keeps time accurate without Wi-Fi versus with Wi-Fi enabled.
Prompt 3
Show me how to set up Wi-Fi credentials before flashing so the clock syncs from the internet.
Prompt 4
Walk me through the troubleshooting docs for boards that behave differently from the tested model.

Frequently asked questions

What is esp32-cyd-aquarium?

Firmware that turns a cheap ESP32 touchscreen board into a self-running animated desk aquarium with fish, plants, a clock, and optional Wi-Fi time sync.

What language is esp32-cyd-aquarium written in?

Mainly C++. The stack also includes C++, ESP32, PlatformIO.

What license does esp32-cyd-aquarium use?

AGPL-3.0: you can use and modify it, but any modified version you distribute or run as a network service must also be released under AGPL-3.0.

How hard is esp32-cyd-aquarium to set up?

Setup difficulty is rated moderate, with roughly 30min to a first successful run.

Who is esp32-cyd-aquarium for?

Mainly developer.

Open on GitHub → Explain another repo

This repo across BitVibe Labs

Verify against the repo before relying on details.