How circuitsetup/time-circuits-display works
The repository contains firmware for CircuitSetup’s Time Circuits Display. Its central workflow is device startup and clock/time-travel operation, with keypad or network configuration, time sources and peripheral inputs, then display and audio output. The graph also preserves documented networking, music, sensors and speedometer capabilities. Several implementation files are unsampled, so links for those subsystems are limited to README-documented behavior or marked unverified rather than inferred from filenames.
Main entry points: tc_main.cpp Clock runtime · tc_wifi.cpp Wi-Fi portal · tc_audio.cpp Audio features · tc_kpmenu.cpp Keypad menu
Components 22
Clock and controls
- Clock runtime
Software/src/tc_main.cpp - RTC and calendar
Software/src/rtc.cpp - Keypad input
Software/src/tc_keypad.cpp - Keypad menu
Software/src/tc_kpmenu.cpp
Display and peripherals
- Input peripherals
Software/src/input.cpp - GPS receiver
Software/src/gps.cpp - Environment sensors
Software/src/sensors.cpp - Speedometer
Software/src/speeddisplay.cpp - Time displays
Software/src/tcddisplay.cpp
Network and configuration
- Wi-Fi portal
Software/src/tc_wifi.cpp - Portal service
Software/src/src/WiFiManager/WiFiManager.cpp - MQTT messaging
Software/src/mqtt.cpp - NTP service
Audio playback
- Audio features
Software/src/tc_audio.cpp - Audio decoders
Software/src/src/ESP8266Audio/AudioGeneratorMP3.cpp - MP3 codec
Software/src/src/ESP8266Audio/libmad/layer3.c - I2S output
Software/src/src/ESP8266Audio/AudioOutputI2S.cpp
Media and settings
- SD card
Software/src/src/SD/SD.cpp - Settings manager
Software/src/tc_settings.cpp - Music files
Other components
- Device user
- Compatible props
Connections 26
- Device user → Keypad input: presses keys
- Device user → Wi-Fi portal: opens portal
- Keypad input → Keypad menu: routes input
Software/src/tc_keypad.cpp - Keypad menu → Clock runtime: changes settings
Software/src/tc_kpmenu.cpp - Clock runtime → RTC and calendar: uses timekeeping
- Clock runtime → Time displays: updates displays
- GPS receiver → Clock runtime: supplies time
- NTP service → Clock runtime: supplies NTP time
- Clock runtime → Wi-Fi portal: uses network
Software/src/tc_main.cpp - Wi-Fi portal → Portal service: configures portal
Software/src/tc_wifi.cpp - Wi-Fi portal → MQTT messaging: configures messaging
Software/src/tc_wifi.cpp - MQTT messaging → Compatible props: sends messages
- Compatible props → Clock runtime: triggers sequences
- Clock runtime → Input peripherals: handles peripherals
- Clock runtime → Environment sensors: uses sensor readings
- Clock runtime → Speedometer: updates speedometer
- Clock runtime → Audio features: requests sound
Software/src/tc_main.cpp - Audio features → Audio decoders: plays audio
- Audio decoders → MP3 codec: decodes MP3
Software/src/src/ESP8266Audio/AudioGeneratorMP3.cpp - Audio decoders → I2S output: renders audio
- Audio features → SD card: reads sound files
- Audio features → Music files: plays music
- SD card → Music files: stores files
- Settings manager → SD card: reads and writes
Software/src/tc_settings.cpp - Wi-Fi portal → Settings manager: saves portal settings
Software/src/tc_wifi.cpp - Keypad menu → Settings manager: edits settings
Software/src/tc_kpmenu.cpp