Scripts are organized into scripts/ (shell) and src/ (Python):
| Script | Syntax | Purpose |
|---|---|---|
scripts/runtheclock.sh |
./scripts/runtheclock.sh |
Fetch a quote and update the display (normally triggered by the systemd timer) |
src/eink_display.py |
python3 src/eink_display.py <subcommand> |
E-ink display utility (see subcommands below) |
src/clear.py |
python3 src/clear.py |
Clear the e-ink display to white |
src/wifi_provision.py |
python3 src/wifi_provision.py [flags] |
WiFi provisioning via captive portal hotspot |
scripts/update.sh |
./scripts/update.sh |
Pull latest code and apply updates in-place |
scripts/reset-setup.sh |
sudo ./scripts/reset-setup.sh [--yes] [--reboot] [--wipe-wifi] [--gift-mode] |
Reset configuration (see Resetting the Clock); --gift-mode preps the device for shipping with a welcome splash |
scripts/prepare-for-cloning.sh |
sudo ./scripts/prepare-for-cloning.sh |
Wipe config and credentials for SD card cloning (see Creating SD Cards) |
scripts/install.sh |
(removed) | Retired and deleted — flashing the released image is the only supported install path (litclock-dev#547) |
# Show a QR code
python3 src/eink_display.py qr <url> [--title TEXT] [--caption TEXT] [--save FILE]
# Show a status message
python3 src/eink_display.py status <title> [--message TEXT] [--submessage TEXT] [--save FILE]
# Clear the display
python3 src/eink_display.py clear [--save FILE]Pass --save FILE to write a PNG instead of sending to the display.
| Flag | Description |
|---|---|
--ssid NAME |
Hotspot SSID (default: LitClock-Setup) |
--timeout SECONDS |
Timeout in seconds (default: 300) |
--check-only |
Check WiFi status and exit (0 = connected, 1 = not) |
--no-display |
Don't update the e-ink display during provisioning |
--download-only |
Download the wifi-connect binary without running it |
These are invoked by systemd services and not meant to be run directly: scripts/boot-splash.sh, scripts/shutdown-splash.sh, scripts/first-boot.sh, src/setup_server.py.