How keralots/animatedpixelclock works
AnimatedPixelClock is ESP32-S3 firmware for a 128×64 animated LED-matrix clock, with a desktop companion mode for live PC metrics. The main user workflow is selecting a clock or metrics display, configuring it through the web interface or companion app, and rendering the result on the matrix. Separate capabilities include weather, ambient animations, audio visualization, notifications, and an addressable LED strip. The README documents the product flows; source excerpts and the index support selected internal links, while unsampled implementation details are left unconnected.
Main entry points: pc_stats_monitor_v4.py Desktop companion · display.cpp Matrix display · main.cpp Firmware runtime · metrics.cpp Metrics renderer
Components 23
Clock firmware
- Firmware runtime
src/main.cpp - Clock styles
src/clocks - Ambient modes
src/ambient - Matrix display
src/display/display.cpp - Wi-Fi and time
src/network/network.cpp - Metrics renderer
src/metrics/metrics.cpp
Settings and interface
- Persistent settings
src/config/settings.cpp - Device web API
src/web/web.cpp - Browser interface
src/web/web_pages.h
PC companion
- Desktop companion
PC-Companion-App-v4/win-companion/pc_stats_monitor_v4.py - Linux companion
PC-Companion-App-v4/linux-companion/pc_stats_monitor_v4_linux.py - Layout engine
PC-Companion-App-v4/companion-common/layout_engine.py - Companion web server
PC-Companion-App-v4/companion-common/server.py - Animation transfer
PC-Companion-App-v4/companion-common/animation_service.py
Additional features
- Weather service
src/weather/weather.cpp - Audio visualizer
src/viz/visualizer.cpp - LED strip effects
src/led/led_strip.cpp - Notifications
src/notify/notify.cpp - Animation storage
src/ambient/anim_store.cpp
Other components
- Clock owner
- RGB matrix panels
- PC sensors
- Weather provider
Connections 26
- Clock owner → Browser interface: configures
- Browser interface → Device web API: submits settings
- Device web API → Persistent settings: saves settings
- Firmware runtime → Persistent settings: loads settings
src/main.cpp - Firmware runtime → Animation storage: mounts storage
src/main.cpp - Firmware runtime → Matrix display: initializes display
src/main.cpp - Firmware runtime → Clock styles: selects renderer
src/main.cpp - Clock styles → Matrix display: draws clock
- Ambient modes → Matrix display: draws effects
- Matrix display → RGB matrix panels: renders pixels
- Clock owner → Desktop companion: configures monitoring
- PC sensors → Desktop companion: provides readings
- PC sensors → Linux companion: provides readings
- Desktop companion → Layout engine: builds layout
PC-Companion-App-v4/win-companion/pc_stats_monitor_v4.py - Layout engine → Desktop companion: returns layout
PC-Companion-App-v4/companion-common/layout_engine.py - Desktop companion → Metrics renderer: sends stats
- Linux companion → Metrics renderer: sends stats
- Metrics renderer → Matrix display: renders metrics
- Clock owner → Weather service: enables weather
- Weather service → Weather provider: fetches forecast
- Audio visualizer → LED strip effects: provides audio levels
src/led/led_strip.cpp - Clock owner → Notifications: sends alerts
- Desktop companion → Companion web server: uses companion UI
PC-Companion-App-v4/companion-common/server.py - Clock owner → Animation transfer: uploads animation
- Animation transfer → Animation storage: transfers animation
- Wi-Fi and time → Device web API: hosts web service