mirror of
https://github.com/ChuckBuilds/LEDMatrix.git
synced 2026-10-10 17:16:36 +00:00
ChuckandClaude Opus 5.5
bc553b69d6
None of these is referenced by an installer, systemd unit, CI workflow, test, the web UI or src/: - utils/cleanup_venv.sh removes venv_web_v2, which nothing creates - utils/clear_python_cache.sh hardcodes ~/LEDMatrix and a .webassets-cache nothing uses - install/migrate_config.sh only copies the template, which the installer and ConfigManager already do - install/debug_install.sh, debug/debug_web_manual.py - diagnose_web_ui.sh and verify_web_ui.sh overlap diagnose_web_interface.sh, which the docs point to - fix_internet_connectivity.sh is iptables-only (stale on nftables) - diagnose_plugin_permissions.sh, dev/validate_python.py - download_nba_logos.py + README_NBA_LOGOS.md: logo_downloader fetches logos on demand - setup_plugin_repos.py linked into the production plugin-repos/ dir; the dev workflow is scripts/dev/dev_plugin_setup.sh, and MULTI_ROOT_WORKSPACE_SETUP.md now uses it Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
56 lines
2.4 KiB
Markdown
56 lines
2.4 KiB
Markdown
# 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`)
|
|
|
|
## Usage
|
|
|
|
### Clear Cache
|
|
```bash
|
|
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.
|
|
|
|
```bash
|
|
./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:
|
|
|
|
```bash
|
|
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.
|