mirror of https://github.com/ChuckBuilds/LEDMatrix.git synced 2026-10-04 14:25:08 +00:00

Files

T

ChuckandClaude Opus 5.5 aeaeaa4e94 chore: make contributor tooling work; fix drifted docs (#648 )

- mypy.ini parses again (multi-line exclude and inline value comments made
  mypy reject the file); the mypy pre-commit hook is manual-only until the
  ~500 existing errors in src/ are paid down, and CONTRIBUTING says so
- .gitignore: ignore all of config/ except the templates (ytm_auth.json and
  others weren't ignored)
- .gitattributes: LF for .sh and .service
- claude-code-review: skip fork PRs, which have no secrets
- check_system_compatibility.sh: 3.13 supported, <3.10 an error
- docs/scripts drift: emulator guide, README API Metrics, route count,
  docs index, scripts README; pyflakes nits in dev scripts

Co-authored-by: Claude Opus 5.5 <noreply@anthropic.com>

2026-09-28 08:26:55 -04:00

apply_dns_single_request.sh

test: fix the emulator port collision behind the intermittent suite failures (#562 )

2026-09-11 15:45:13 -04:00

auto_update_verify.py

fix: September 16 core audit — partial saves, asset path safety, auto-update, display settings the library refuses, scroll speed (#595 )

2026-09-17 16:37:29 -04:00

clear_cache.py

Codebase audit: fix shipping bugs, remove verified-dead code, repair doc drift, add regression guards (#438 )

2026-08-06 14:04:23 -04:00

pixlet_config_editor.sh

feat(tools): MQTT bridge and Pixlet editor, ported onto the api_v3 split (#554 )

2026-09-11 11:32:12 -04:00

README.md

fix(security): re-harden root sudo helpers; installer fixes; ARCHITECTURE and PERMISSIONS docs (#640 )

2026-09-24 17:31:41 -04:00

start_web_conditionally.py

fix(web): default web_display_autostart to true, as the installer already does (#556 )

2026-09-10 17:42:00 -04:00

wifi_monitor_daemon.py

chore: make contributor tooling work; fix drifted docs (#648 )

2026-09-28 08:26:55 -04:00

README.md

Utility Scripts

This directory contains utility scripts for maintenance and system operations.

Scripts

clear_cache.py - Clears LEDMatrix cache data (specific keys or all cache)
start_web_conditionally.py - Conditionally starts the web interface based on config settings
wifi_monitor_daemon.py - Background daemon that monitors WiFi/Ethernet connection and manages access point mode
pixlet_config_editor.sh - Opens Pixlet's own config UI for one installed Starlark app
apply_dns_single_request.sh - Adds options single-request to the resolver (run by ledmatrix-dns-fix.service)
auto_update_verify.py - Health check after an automatic update, rolling back if it fails (the updater copies it to data/ before pulling and ledmatrix-update-verify.service runs that copy)

Usage

Clear Cache

python3 scripts/utils/clear_cache.py --list          # List cache keys
python3 scripts/utils/clear_cache.py --clear-all      # Clear all cache
python3 scripts/utils/clear_cache.py --clear <key>    # Clear specific key

Start Web Interface Conditionally

This script is typically called by the systemd service (ledmatrix-web.service) and checks the web_display_autostart setting in config/config.json before starting the web interface.

WiFi Monitor Daemon

This daemon is typically run as a systemd service (ledmatrix-wifi-monitor.service) and automatically manages WiFi access point mode based on network connectivity.

Pixlet Config Editor

Run it when you want Pixlet's own config form for a Starlark app -- live render preview, cascading dropdowns -- rather than the LEDMatrix one.

./scripts/utils/pixlet_config_editor.sh                 # list installed apps
./scripts/utils/pixlet_config_editor.sh penndot_signs   # edit, on localhost:8080

Deliberately not a service. It stops the display for the length of the session and pixlet serve listens with no authentication, so it should only be running while you are actually editing. It backs the config up first and restarts the display on exit, however it exits.

It binds loopback only, with no flag to change that: anything that can reach pixlet serve can rewrite the app's config, and a printed warning is not access control. To edit from another machine, forward the port -- SSH does the authenticating and nothing is left listening on the LAN:

ssh -L 8080:localhost:8080 pi@ledpi.local

Apply DNS Single-Request Fix

Installed and run by ledmatrix-dns-fix.service; see systemd/README.md. Safe to run by hand (sudo ./scripts/utils/apply_dns_single_request.sh) and idempotent.