mirror of
https://github.com/ChuckBuilds/LEDMatrix.git
synced 2026-04-10 13:02:59 +00:00
docs: refresh and correct stale documentation across repo (#306)
* docs: refresh and correct stale documentation across repo
Walked the README and docs/ tree against current code and fixed several
real bugs and many stale references. Highlights:
User-facing
- README.md: web interface install instructions referenced
install_web_service.sh at the repo root, but it actually lives at
scripts/install/install_web_service.sh.
- docs/GETTING_STARTED.md: every web UI port reference said 5050, but
the real server in web_interface/start.py:123 binds 5000. Same bug
was duplicated in docs/TROUBLESHOOTING.md (17 occurrences). Fixed
both.
- docs/GETTING_STARTED.md: rewrote tab-by-tab instructions. The doc
referenced "Plugin Store", "Plugin Management", "Sports Configuration",
"Durations", and "Font Management" tabs - none of which exist. Real
tabs (verified in web_interface/templates/v3/base.html) are: Overview,
General, WiFi, Schedule, Display, Config Editor, Fonts, Logs, Cache,
Operation History, Plugin Manager (+ per-plugin tabs).
- docs/GETTING_STARTED.md: removed references to a "Test Display"
button (doesn't exist) and "Show Now" / "Stop" plugin buttons. Real
controls are "Run On-Demand" / "Stop On-Demand" inside each plugin's
tab (partials/plugin_config.html:792).
- docs/TROUBLESHOOTING.md: removed dead reference to
troubleshoot_weather.sh (doesn't exist anywhere in the repo); weather
is now a plugin in ledmatrix-plugins.
Developer-facing
- docs/PLUGIN_API_REFERENCE.md: documented draw_image() doesn't exist
on DisplayManager. Real plugins paste onto display_manager.image
directly (verified in src/base_classes/{baseball,basketball,football,
hockey}.py). Replaced with the canonical pattern.
- docs/PLUGIN_API_REFERENCE.md: documented cache_manager.delete() doesn't
exist. Real method is clear_cache(key=None). Updated the section.
- docs/PLUGIN_API_REFERENCE.md: added 10 missing BasePlugin methods that
the doc never mentioned: dynamic-duration hooks, live-priority hooks,
and the full Vegas-mode interface.
- docs/PLUGIN_DEVELOPMENT_GUIDE.md: same draw_image fix.
- docs/DEVELOPMENT.md: corrected the "Plugin Submodules" section. Plugins
are NOT git submodules - .gitmodules only contains
rpi-rgb-led-matrix-master. Plugins are installed at runtime into the
plugins directory configured by plugin_system.plugins_directory
(default plugin-repos/). Both internal links in this doc were also
broken (missing relative path adjustment).
- docs/HOW_TO_RUN_TESTS.md: removed pytest-timeout from install line
(not in requirements.txt) and corrected the test/integration/ path
(real integration tests are at test/web_interface/integration/).
Replaced the fictional file structure diagram with the real one.
- docs/EMULATOR_SETUP_GUIDE.md: clone URL was a placeholder; default
pixel_size was documented as 16 but emulator_config.json ships with 5.
Index
- docs/README.md: rewrote. Old index claimed "16-17 files after
consolidation" but docs/ actually has 38 .md files. Four were missing
from the index entirely (CONFIG_DEBUGGING, DEV_PREVIEW,
PLUGIN_ERROR_HANDLING, STARLARK_APPS_GUIDE). Trimmed the navel-gazing
consolidation/statistics sections.
Out of scope but worth flagging:
- src/plugin_system/resource_monitor.py:343 and src/common/api_helper.py:287
call cache_manager.delete(key) but no such method exists on
CacheManager. Both call sites would AttributeError at runtime if hit.
Not fixed in this docs PR - either add a delete() shim or convert
callers to clear_cache().
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
* docs: fix WEB_INTERFACE_GUIDE and WIFI_NETWORK_SETUP
WEB_INTERFACE_GUIDE.md
- Web UI port: 5050 -> 5000 (4 occurrences)
- Tab list was almost entirely fictional. Documented tabs:
General Settings, Display Settings, Durations, Sports Configuration,
Plugin Management, Plugin Store, Font Management. None of these
exist. Real tabs (verified in web_interface/templates/v3/base.html:
935-1000): Overview, General, WiFi, Schedule, Display, Config Editor,
Fonts, Logs, Cache, Operation History, plus Plugin Manager and
per-plugin tabs in the second nav row. Rewrote the navigation
section, the General/Display/Plugin sections, and the Common Tasks
walkthroughs to match.
- Quick Actions list referenced "Test Display" button (doesn't exist).
Replaced with the real button list verified in
partials/overview.html:88-152: Start/Stop Display, Restart Display
Service, Restart Web Service, Update Code, Reboot, Shutdown.
- API endpoints used /api/* paths. The api_v3 blueprint mounts at
/api/v3 (web_interface/app.py:144), so the real paths are
/api/v3/config/main, /api/v3/system/status, etc. Fixed.
- Removed bogus "Sports Configuration tab" walkthrough; sports
favorites live inside each scoreboard plugin's own tab now.
- Plugin directory listed as /plugins/. Real default is plugin-repos/
(verified in config/config.template.json:130 and
display_controller.py:132); plugins/ is a fallback.
- Removed "Swipe navigation between tabs" mobile claim (not implemented).
WIFI_NETWORK_SETUP.md
- 21 occurrences of port 5050 -> 5000.
- All /api/wifi/* curl examples used the wrong path. The real wifi
API routes are at /api/v3/wifi/* (api_v3.py:6367-6609). Fixed.
- ap_password default was documented as "" (empty/open network) but
config/wifi_config.json ships with "ledmatrix123". Updated the
Quick Start, Configuration table, AP Mode Settings section, and
Security Recommendations to match. Also clarified that setting
ap_password to "" is the way to make it an open network.
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
* docs: fix ADVANCED_FEATURES and REST_API_REFERENCE
REST_API_REFERENCE.md
- Wrong path: /fonts/delete/<font_family> -> /fonts/<font_family>
(verified the real DELETE route in
web_interface/blueprints/api_v3.py).
- Diffed the documented routes against the real api_v3 blueprint
(92 routes vs the 71 documented). Added missing sections:
- Error tracking (/errors/summary, /errors/plugin/<id>, /errors/clear)
- Health (/health)
- Schedule dim/power (/config/dim-schedule GET/POST)
- Plugin-specific endpoints (calendar/list-calendars,
of-the-day/json/upload+delete, plugins/<id>/static/<path>)
- Starlark Apps (12 endpoints: status, install-pixlet, apps CRUD,
repository browse/install, upload)
- Font preview (/fonts/preview)
- Updated table of contents with the new sections.
- Added a footer note that the API blueprint mounts at /api/v3
(app.py:144) and that SSE stream endpoints are defined directly on
the Flask app at app.py:607-615.
ADVANCED_FEATURES.md
- Vegas Scroll Mode section was actually accurate (verified all
config keys match src/vegas_mode/config.py:15-30).
- On-Demand Display section had multiple bugs:
- 5 occurrences of port 5050 -> 5000
- All API paths missing /v3 (e.g. /api/display/on-demand/start
should be /api/v3/display/on-demand/start)
- "Settings -> Plugin Management -> Show Now Button" UI flow doesn't
exist. Real flow: open the plugin's tab in the second nav row,
click Run On-Demand / Stop On-Demand.
- "Python API Methods" section showed
controller.show_on_demand() / clear_on_demand() /
is_on_demand_active() / get_on_demand_info() — none of these
methods exist on DisplayController. The on-demand machinery is
all internal (_set_on_demand_*, _activate_on_demand, etc) and
is driven through the cache_manager. Replaced the section with
a note pointing to the REST API.
- All Use Case Examples used the same fictional Python calls.
Replaced with curl examples against the real API.
- Cache Management section claimed "On-demand display uses Redis cache
keys". LEDMatrix doesn't use Redis — verified with grep that
src/cache_manager.py has no redis import. The cache is file-based,
managed by CacheManager (file at /var/cache/ledmatrix/ or fallback
paths). Rewrote the manual recovery section:
- Removed redis-cli commands
- Replaced cache.delete() Python calls with cache.clear_cache()
(the real public method per the same bug already flagged in
PLUGIN_API_REFERENCE.md)
- Replaced "Settings -> Cache Management" with the real Cache tab
- Documented the actual cache directory candidates
- Background Data Service section:
- Used "nfl_scoreboard" as the plugin id in the example.
The real plugin is "football-scoreboard" (handles both NFL and
NCAA). Fixed.
- "Implementation Status: Phase 1 NFL only / Phase 2 planned"
section was severely outdated. The background service is now
used by all sports scoreboards (football, hockey, baseball,
basketball, soccer, lacrosse, F1, UFC), the odds ticker, and
the leaderboard plugin. Replaced with a current "Plugins using
the background service" note.
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
* docs: fix plugin config + store + dependency docs
PLUGIN_STORE_GUIDE.md
- 19 occurrences of port 5050 -> 5000
- All API paths missing /v3 (e.g. /api/plugins/install ->
/api/v3/plugins/install). Bulk fix.
PLUGIN_REGISTRY_SETUP_GUIDE.md
- Same port + /api/v3 fixes (3 occurrences each)
- "Go to Plugin Store tab" -> "Open the Plugin Manager tab and scroll
to the Install from GitHub section" (the real flow for registry
setup is the GitHub install section, not the Plugin Store search)
PLUGIN_CONFIG_QUICK_START.md
- Port 5001 -> 5000 (5001 is the dev_server.py default, not the web UI)
- "Plugin Store tab" install flow -> real Plugin Manager + Plugin Store
section + per-plugin tab in second nav row
- Removed reference to PLUGIN_CONFIG_TABS_SUMMARY.md (archived doc)
PLUGIN_CONFIGURATION_TABS.md
- "Plugin Management vs Configuration" section confusingly described
a "Plugins Tab" that doesn't exist as a single thing. Rewrote to
describe the real two-piece structure: Plugin Manager tab (browse,
install, toggle) vs per-plugin tabs (configure individual plugins).
PLUGIN_DEPENDENCY_GUIDE.md
- Port 5001 -> 5000
PLUGIN_DEPENDENCY_TROUBLESHOOTING.md
- Wrong port (8080) and wrong UI nav ("Plugin Store or Plugin
Management"). Fixed to the real flow.
PLUGIN_QUICK_REFERENCE.md
- "Plugin Location: ./plugins/ directory" -> default is plugin-repos/
(verified in config/config.template.json:130 and
display_controller.py:132). plugins/ is a fallback.
- File structure diagram showed plugins/ -> plugin-repos/.
- Web UI install flow: "Plugin Store tab" -> "Plugin Manager tab ->
Plugin Store section". Also fixed Configure ⚙️ button (doesn't
exist) and "Drag and drop reorder" (not implemented).
- API examples: replaced ad-hoc Python pseudocode with real curl
examples against /api/v3/plugins/* endpoints. Pointed at
REST_API_REFERENCE.md for the full list.
- "Migration Path Phase 1-5" was a roadmap written before the plugin
system shipped. The plugin system is now stable and live. Removed
the migration phases as they're history, not a roadmap.
- "Quick Migration" section called scripts/migrate_to_plugins.py
which doesn't exist anywhere in the repo. Removed.
- "Plugin Registry Structure" referenced
ChuckBuilds/ledmatrix-plugin-registry which doesn't exist. The
real registry is ChuckBuilds/ledmatrix-plugins. Fixed.
- "Next Steps" / "Questions to Resolve" sections were
pre-implementation planning notes. Replaced with a "Known
Limitations" section that documents the actually-real gaps
(sandboxing, resource limits, ratings, auto-updates).
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
* docs: fix misc remaining docs (architecture, dev quickref, sub-dir READMEs)
PLUGIN_ARCHITECTURE_SPEC.md
- Added a banner at the top noting this is a historical design doc
written before the plugin system shipped. The doc is ~1900 lines
with 13 stale /api/plugins/* paths (real is /api/v3/plugins/*),
references to web_interface_v2.py (current is app.py), and a
Migration Strategy / Implementation Roadmap that's now history.
Banner points readers at the current docs
(PLUGIN_DEVELOPMENT_GUIDE, PLUGIN_API_REFERENCE,
REST_API_REFERENCE) without needing to retrofit every section.
PLUGIN_CONFIG_ARCHITECTURE.md
- 10 occurrences of /api/plugins/* missing /v3 prefix. Bulk fixed.
DEVELOPER_QUICK_REFERENCE.md
- cache_manager.delete("key") -> cache_manager.clear_cache("key")
with comment noting delete() doesn't exist. Same bug already
documented in PLUGIN_API_REFERENCE.md.
SSH_UNAVAILABLE_AFTER_INSTALL.md
- 4 occurrences of port 5001 -> 5000 in AP-mode and Ethernet/WiFi
recovery instructions.
PLUGIN_CUSTOM_ICONS_FEATURE.md
- Port 5001 -> 5000.
CONFIG_DEBUGGING.md
- Documented /api/v3/config/plugin/<id> and /api/v3/config/validate
endpoints don't exist. Replaced with the real endpoints:
/api/v3/config/main, /api/v3/plugins/schema?plugin_id=,
/api/v3/plugins/config?plugin_id=. Added a note that validation
runs server-side automatically on POST.
STARLARK_APPS_GUIDE.md
- "Plugins -> Starlark Apps" UI navigation path doesn't exist (5
occurrences). Replaced with the real path: Plugin Manager tab,
then the per-plugin Starlark Apps tab in the second nav row.
- "Navigate to Plugins" install step -> Plugin Manager tab.
web_interface/README.md
- Documented several endpoints that don't exist in the api_v3
blueprint:
- GET /api/v3/plugins (list) -> /api/v3/plugins/installed
- GET /api/v3/plugins/<id> -> doesn't exist
- POST /api/v3/plugins/<id>/config -> POST /api/v3/plugins/config
- GET /api/v3/plugins/<id>/enable + /disable -> POST /api/v3/plugins/toggle
- GET /api/v3/store/plugins -> /api/v3/plugins/store/list
- POST /api/v3/store/install/<id> -> POST /api/v3/plugins/install
- POST /api/v3/store/uninstall/<id> -> POST /api/v3/plugins/uninstall
- POST /api/v3/store/update/<id> -> POST /api/v3/plugins/update
- POST /api/v3/display/start/stop/restart -> POST /api/v3/system/action
- GET /api/v3/display/status -> GET /api/v3/system/status
- Also fixed config/secrets.json -> config/config_secrets.json
- Replaced the per-section endpoint duplication with a current real
endpoint list and a pointer to docs/REST_API_REFERENCE.md.
- Documented that SSE stream endpoints are defined directly on the
Flask app at app.py:607-615, not in the api_v3 blueprint.
scripts/install/README.md
- Was missing 3 of the 9 install scripts in the directory:
one-shot-install.sh, configure_wifi_permissions.sh, and
debug_install.sh. Added them with brief descriptions.
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
* docs: clarify plugin paths and fix systemd manual install bug
PLUGIN_DEVELOPMENT_GUIDE.md
- Added a "Plugin directory note" callout near the top explaining
the plugins/ vs plugin-repos/ split:
- Dev workflow uses plugins/ (where dev_plugin_setup.sh creates
symlinks)
- Production / Plugin Store uses plugin-repos/ (the configurable
default per config.template.json:130)
- The plugin loader falls back to plugins/ so dev symlinks are
picked up automatically (schema_manager.py:77)
- User can set plugins_directory to "plugins" in the General tab
if they want both to share a directory
CLAUDE.md
- The Project Structure section had plugins/ and plugin-repos/
exactly reversed:
- Old: "plugins/ - Installed plugins directory (gitignored)"
"plugin-repos/ - Development symlinks to monorepo plugin dirs"
- Real: plugin-repos/ is the canonical Plugin Store install
location and is not gitignored. plugins/* IS gitignored
(verified in .gitignore) and is the legacy/dev location used by
scripts/dev/dev_plugin_setup.sh.
Reversed the descriptions and added line refs.
systemd/README.md
- "Manual Installation" section told users to copy the unit file
directly to /etc/systemd/system/. Verified the unit file in
systemd/ledmatrix.service contains __PROJECT_ROOT_DIR__
placeholders that the install scripts substitute at install time.
A user following the manual steps would get a service that fails
to start with "WorkingDirectory=__PROJECT_ROOT_DIR__" errors.
Added a clear warning and a sed snippet that substitutes the
placeholder before installing.
src/common/README.md
- Was missing 2 of the 11 utility modules in the directory
(verified with ls): permission_utils.py and cli.py. Added brief
descriptions for both.
Out-of-scope code bug found while auditing (flagged but not fixed):
- scripts/dev/dev_plugin_setup.sh:9 sets PROJECT_ROOT="$SCRIPT_DIR"
which resolves to scripts/dev/, not the project root. This means
the script's PLUGINS_DIR resolves to scripts/dev/plugins/ instead
of the project's plugins/ — confirmed by the existence of
scripts/dev/plugins/of-the-day/ from prior runs. Real fix is to
set PROJECT_ROOT="$(cd "$SCRIPT_DIR/../.." && pwd)". Not fixing in
this docs PR.
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
* docs: flag aspirational/regressed features in plugin docs
These docs describe features that exist as documented in the doc but
either never wired up or regressed when v3 shipped. Each gets a clear
status banner so plugin authors don't waste time chasing features that
don't actually work.
FONT_MANAGER.md
- The "For Plugin Developers / Plugin Font Registration" section
documents adding a "fonts" block to manifest.json that gets
registered via FontManager.register_plugin_fonts(). The method
exists at src/font_manager.py:150 but is **never called from
anywhere** in the codebase (verified: zero callers). A plugin
shipping a manifest "fonts" block has its fonts silently ignored.
Added a status warning and a note about how to actually ship plugin
fonts (regular files in the plugin dir, loaded directly).
PLUGIN_IMPLEMENTATION_SUMMARY.md
- Added a top-level status banner.
- Architecture diagram referenced src/plugin_system/registry_manager.py
(which doesn't exist) and listed plugins/ as the install location.
Replaced with the real file list (plugin_loader, schema_manager,
health_monitor, operation_queue, state_manager) and pointed at
plugin-repos/ as the default install location.
- "Dependency Management: Virtual Environments" — verified there's no
per-plugin venv. Removed the bullet and added a note that plugin
Python deps install into the system Python environment, with no
conflict resolution.
- "Permission System: File Access Control / Network Access /
Resource Limits / CPU and memory constraints" — none of these
exist. There's a resource_monitor.py and health_monitor.py for
metrics/warnings, but no hard caps or sandboxing. Replaced the
section with what's actually implemented and a clear note that
plugins run in the same process with full file/network access.
PLUGIN_CUSTOM_ICONS.md and PLUGIN_CUSTOM_ICONS_FEATURE.md
- The custom-icon feature was implemented in the v2 web interface
via a getPluginIcon() helper in templates/index_v2.html that read
the manifest "icon" field. When the v3 web interface was built,
that helper wasn't ported. Verified in
web_interface/templates/v3/base.html:515 and :774, plugin tab
icons are hardcoded to `fas fa-puzzle-piece`. The "icon" field in
plugin manifests is currently silently ignored (verified with grep
across web_interface/ and src/plugin_system/ — zero non-action-
related reads of plugin.icon or manifest.icon).
- Added a status banner to both docs noting the regression so plugin
authors don't think their custom icons are broken in their own
plugin code.
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
* docs: fix .cursor/ helper docs
The .cursor/ directory holds the dev-side helper docs that Cursor and
contributors using AI tooling rely on to bootstrap plugin development.
Several of them had the same bug patterns as the user-facing docs.
.cursor/plugin_templates/QUICK_START.md
- "Adding Image Rendering" section showed
display_manager.draw_image(image, x=0, y=0). That method doesn't
exist on DisplayManager (same bug as PLUGIN_API_REFERENCE.md and
PLUGIN_DEVELOPMENT_GUIDE.md). Replaced with the canonical
display_manager.image.paste((x,y)) pattern, including the
transparency-mask form.
.cursor/plugins_guide.md
- 10 occurrences of ./dev_plugin_setup.sh — the script lives at
scripts/dev/dev_plugin_setup.sh, so anyone copy-pasting these
examples gets "command not found". Bulk fixed via sed.
- "Test with emulator: python run.py --emulator" — there's no
--emulator flag. Replaced with the real options:
EMULATOR=true python3 run.py for the full display, or
scripts/dev_server.py for the dev preview.
- Secrets management section showed a fictional
"config_secrets": { "api_key": "my-plugin.api_key" } reference
field. Verified in src/config_manager.py:162-172 that secrets are
loaded by deep-merging config_secrets.json into the main config.
There is no separate reference field — just put the secret under
the same plugin namespace and read it from the merged config.
Rewrote the section with the real pattern.
- "ssh pi@raspberrypi" -> "ssh ledpi@your-pi-ip" (consistent with
the rest of LEDMatrix docs which use ledpi as the default user)
.cursor/README.md
- Same ./dev_plugin_setup.sh -> ./scripts/dev/dev_plugin_setup.sh
fix (×6 occurrences via replace_all).
- Same "python run.py --emulator" -> "EMULATOR=true python3 run.py"
fix. Also added a pointer to scripts/dev_server.py for previewing
plugins without running the full display.
- "Example Plugins: plugins/hockey-scoreboard/" — the canonical
source is the ledmatrix-plugins repo. Installed copies land in
plugin-repos/ or plugins/. Updated the line to point at the
ledmatrix-plugins repo and explain both local locations.
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
* docs: fix .cursorrules — the file Cursor auto-loads to learn the API
This is the file that Cursor reads to learn how plugin development
works. Stale entries here directly mislead AI-assisted plugin authors
on every new plugin. Several of the same bug patterns I've been
fixing in the user-facing docs were here too.
Display Manager section (highest impact)
- "draw_image(image, x, y): Draw PIL Image" — that method doesn't
exist on DisplayManager. Same bug already fixed in
PLUGIN_API_REFERENCE.md, PLUGIN_DEVELOPMENT_GUIDE.md,
ledmatrix-stocks/README.md, and .cursor/plugin_templates/QUICK_START.md.
Removed the bullet and replaced it with a paragraph explaining the
real pattern: paste onto display_manager.image directly, then
update_display(). Includes the transparency-mask form.
- Added the small_font/centered args to draw_text() since they're
the ones that matter most for new plugin authors
- Added draw_weather_icon since it's commonly used
Cache Manager section
- "delete(key): Remove cached value" — there's no delete() method
on CacheManager. The real method is clear_cache(key=None) (also
removes everything when called without args). Same bug as before.
- Added get_cached_data_with_strategy and get_background_cached_data
since contributors will hit these when working on sports plugins
Plugin System Overview
- "loaded from the plugins/ directory" — clarified that the default
is plugin-repos/ (per config.template.json:130) with plugins/ as
the dev fallback used by scripts/dev/dev_plugin_setup.sh
Plugin Development Workflow
- ./dev_plugin_setup.sh -> ./scripts/dev/dev_plugin_setup.sh (×2)
- Manual setup step "Create directory in plugins/<plugin-id>/" ->
plugin-repos/<plugin-id>/ as the canonical location
- "Use emulator: python run.py --emulator or ./run_emulator.sh"
— the --emulator flag doesn't exist; ./run_emulator.sh isn't at
root (it lives at scripts/dev/run_emulator.sh). Replaced with the
real options: scripts/dev_server.py for dev preview, or
EMULATOR=true python3 run.py for the full emulator path.
Configuration Management
- "Reference secrets via config_secrets key in main config" — this
is the same fictional reference syntax I just fixed in
.cursor/plugins_guide.md. Verified in src/config_manager.py:162-172
that secrets are deep-merged into the main config; there's no
separate reference field. Replaced with a clear explanation of
the deep-merge approach.
Code Organization
- "plugins/<plugin-id>/" -> the canonical location is
plugin-repos/<plugin-id>/ (or its dev-time symlink in plugins/)
- "see plugins/hockey-scoreboard/ as reference" — the canonical
source for example plugins is the ledmatrix-plugins repo. Updated
the pointer.
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
* Add LICENSE (GPL-3.0) and CONTRIBUTING.md
LICENSE
- The repository previously had no LICENSE file. The README and every
downstream plugin README already reference GPL-3.0 ("same as
LEDMatrix project"), but the canonical license text was missing —
contributors had no formal record of what they were contributing
under, and GitHub couldn't auto-detect the license for the repo
banner.
- Added the canonical GPL-3.0 text from
https://www.gnu.org/licenses/gpl-3.0.txt (verbatim, 674 lines).
- Compatibility verified: rpi-rgb-led-matrix is GPL-2.0-or-later
(per its COPYING file and README; the "or any later version" clause
in lib/*.h headers makes GPL-3.0 distribution legal).
CONTRIBUTING.md
- The repository had no CONTRIBUTING file. New contributors had to
reconstruct the dev setup from DEVELOPMENT.md, PLUGIN_DEVELOPMENT_GUIDE.md,
SUBMISSION.md, and the root README.
- Added a single page covering: dev environment setup (preview
server, emulator, hardware), running tests, PR submission flow,
commit message convention, plugin contribution pointer, and the
license terms contributors are agreeing to.
> Note for the maintainer: I (the AI assistant doing this audit) am
> selecting GPL-3.0 because every reference in the existing
> documentation already says GPL-3.0 — this commit just makes that
> declaration legally binding by adding the actual file. Please
> confirm during PR review that GPL-3.0 is what you want; if you
> prefer a different license, revert this commit before merging.
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
* Add CODE_OF_CONDUCT, SECURITY, PR template; link them from README
Tier 1 organizational files that any open-source project at
LEDMatrix's maturity is expected to have. None of these existed
before. They're additive — no existing content was rewritten.
CODE_OF_CONDUCT.md
- Contributor Covenant 2.1 (the de facto standard for open-source
projects). Mentions both the Discord and the GitHub Security
Advisories channel for reporting violations.
SECURITY.md
- Private vulnerability disclosure flow with two channels: GitHub
Security Advisories (preferred) and Discord DM.
- Documents the project's known security model as intentional
rather than vulnerabilities: no web UI auth, plugins run
unsandboxed, display service runs as root for GPIO access,
config_secrets.json is plaintext. These match the limitations
already called out in PLUGIN_QUICK_REFERENCE.md and the audit
flagging from earlier in this PR.
- Out-of-scope section points users at upstream
(rpi-rgb-led-matrix, third-party plugins) so reports land in the
right place.
.github/PULL_REQUEST_TEMPLATE.md
- 10-line checklist that prompts for the things that would have
caught the bugs in this very PR: did you load the changed plugin
once, did you update docs alongside code, are there any plugin
compatibility implications.
- Linked from CONTRIBUTING.md for the full flow.
README.md
- Added a License section near the bottom (the README previously
said nothing about the license despite the project being GPL-3.0).
- Added a Contributing section pointing at CONTRIBUTING.md and
SECURITY.md.
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
* Customize bug report template for LEDMatrix hardware
The bug_report.md template was the GitHub default and asked
"Desktop (OS/Browser/Version)" and "Smartphone (Device/OS)" — neither
of which is relevant for a project that runs on a Raspberry Pi with
hardware LED panels. A user filing a bug under the old template was
giving us none of the information we'd actually need to triage it.
Replaced with a LEDMatrix-aware template that prompts for:
- Pi model, OS/kernel, panel type, HAT/Bonnet, PWM jumper status,
display chain dimensions
- LEDMatrix git commit / release tag
- Plugin id and version (if the bug is plugin-related)
- Relevant config snippet (with redaction reminder for API keys)
- journalctl log excerpt with the exact command to capture it
- Optional photo of the actual display for visual issues
Kept feature_request.md as-is — generic content there is fine.
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
* docs: fix bare /api/plugins paths in PLUGIN_CONFIGURATION_TABS
Found 5 more bare /api/plugins/* paths in PLUGIN_CONFIGURATION_TABS.md
that I missed in the round 2 sweep — they're inside data flow diagrams
and prose ("loaded via /api/plugins/installed", etc.) so the earlier
grep over Markdown code blocks didn't catch them. Fixed all 5 to use
/api/v3/plugins/* (the api_v3 blueprint mount path verified at
web_interface/app.py:144).
Also added a status banner noting that the "Implementation Details"
section references the pre-v3 file layout (web_interface_v2.py,
templates/index_v2.html) which no longer exists. The current
implementation is in web_interface/app.py, blueprints/api_v3.py, and
templates/v3/. Same kind of historical drift I flagged in
PLUGIN_ARCHITECTURE_SPEC.md and the PLUGIN_CUSTOM_ICONS_FEATURE doc.
The user-facing parts of the doc (Overview, Features, Form Generation
Process) are still accurate.
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
* docs(widgets): list the 20 undocumented built-in widgets
The widget registry README documented 3 widgets (file-upload,
checkbox-group, custom-feeds) but the directory contains 23 registered
widgets total. A plugin author reading this doc would think those 3
were the only built-in options and either reach for a custom widget
unnecessarily or settle for a generic text input.
Verified the actual list with:
grep -h "register('" web_interface/static/v3/js/widgets/*.js \
| sed -E "s|.*register\\('([^']+)'.*|\\1|" | sort -u
Added an "Other Built-in Widgets" section after the 3 detailed
sections, listing the remaining 20 with one-line descriptions
organized by category:
- Inputs (6): text-input, textarea, number-input, email-input,
url-input, password-input
- Selectors (7): select-dropdown, radio-group, toggle-switch,
slider, color-picker, font-selector, timezone-selector
- Date/time/scheduling (4): date-picker, day-selector, time-range,
schedule-picker
- Composite/data-source (2): array-table, google-calendar-picker
- Internal (2): notification, base-widget
Pointed at the .js source files as the canonical source for each
widget's exact schema and options — keeps this list low-maintenance
since I'm not duplicating each widget's full options table.
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
* docs: fix README_NBA_LOGOS and PLUGIN_CONFIGURATION_GUIDE
scripts/README_NBA_LOGOS.md
- "python download_nba_logos.py" — wrong on two counts. The script
is at scripts/download_nba_logos.py (not the project root), and
"python" is Python 2 on most systems. Replaced all 4 occurrences
with "python3 scripts/download_nba_logos.py".
- The doc framed itself as the way to set up "the NBA leaderboard".
The basketball/leaderboard functionality is now in the
basketball-scoreboard and ledmatrix-leaderboard plugins (in the
ledmatrix-plugins repo), which auto-download logos on first run.
Reframed the script as a pre-population utility for offline / dev
use cases.
- Bumped the documented Python minimum from 3.7 to 3.9 to match
the rest of the project.
docs/PLUGIN_CONFIGURATION_GUIDE.md
- The "Plugin Manifest" example was missing 3 fields the plugin
loader actually requires: id, entry_point, and class_name. A
contributor copying this manifest verbatim would get
PluginError("No class_name in manifest") at load time — the same
loader bug already found in stock-news. Added all three.
- The same example showed config_schema as an inline object. The
loader expects config_schema to be a file path string (e.g.
"config_schema.json") with the actual schema in a separate JSON
file — verified earlier in this audit. Fixed.
- Added a paragraph explaining the loader's required fields and
the case-sensitivity rule on class_name (the bug that broke
hello-world's manifest before this PR fixed it).
- "Plugin Manager Class" example had the wrong constructor
signature: (config, display_manager, cache_manager, font_manager).
The real BasePlugin.__init__ at base_plugin.py:53-60 takes
(plugin_id, config, display_manager, cache_manager, plugin_manager).
A copy-pasted example would TypeError on instantiation. Fixed,
including a comment noting which attributes BasePlugin sets up.
- Renamed the example class from MyPluginManager to MyPlugin to
match the project convention (XxxPlugin / XxxScoreboardPlugin
in actual plugins).
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
* docs(requirements): document optional dependencies (scipy, psutil, Flask-Limiter)
A doc-vs-code crosscheck of every Python import in src/ and
web_interface/ against requirements.txt found 3 packages that the
code uses but requirements.txt doesn't list. Verified with grep that
all 3 are wrapped in try/except blocks with documented fallback
paths, so they're optional features rather than missing required
deps:
- scipy src/common/scroll_helper.py:26
→ from scipy.ndimage import shift; HAS_SCIPY flag.
Used for sub-pixel interpolation in scrolling.
Falls back to a simpler shift algorithm without it.
- psutil src/plugin_system/resource_monitor.py:15
→ import psutil; PSUTIL_AVAILABLE flag. Used for
per-plugin CPU/memory monitoring. Silently no-ops
without it.
- flask-limiter web_interface/app.py:42-43
→ from flask_limiter import Limiter; wrapped at the
caller. Used for accidental-abuse rate limiting on
the web interface (not security). Web interface
starts without rate limiting when missing.
These were latent in two ways:
1. A user reading requirements.txt thinks they have the full feature
set after `pip install -r requirements.txt`, but they don't get
smoother scrolling, plugin resource monitoring, or rate limiting.
2. A contributor who deletes one of the packages from their dev env
wouldn't know which feature they just lost — the fallbacks are
silent.
Added an "Optional dependencies" section at the bottom of
requirements.txt with the version constraint, the file:line where
each is used, the feature it enables, and the install command. The
comment-only format means `pip install -r requirements.txt` still
gives the minimal-feature install (preserving current behavior),
while users who want the full feature set can copy the explicit
pip install commands.
Other findings from the same scan that came back as false positives
or known issues:
- web_interface_v2: dead pattern flagged in earlier iteration
(still no real implementation; affects 11+ plugins via the same
try/except dead-fallback pattern)
- urllib3: comes with `requests` transitively
- All 'src.', 'web_interface.', 'rgbmatrix', 'RGBMatrixEmulator'
imports: internal modules
- base_plugin / plugin_manager / store_manager / mocks /
visual_display_manager: relative imports to local modules
- freetype: false positive (freetype-py is in requirements.txt
under the package name)
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
* docs: fix broken file references found by path-existence crosscheck
Ran a doc-vs-filesystem crosscheck: extracted every backtick-quoted
path with a file extension or known directory prefix from docs/*.md
and verified each exists. After filtering false positives
(placeholder paths, config keys mistaken for paths, paths inside
docs that already have historical-status banners), found 4 real
broken references — 3 fixed in docs, 1 fixed by creating the missing
file:
docs/HOW_TO_RUN_TESTS.md:339
- Claimed ".github/workflows/tests.yml" exists and runs pytest on
multiple Python versions in CI. There is no such workflow.
The only GitHub Actions file is security-audit.yml (bandit + semgrep).
- Pytest runs locally but is NOT gated on PRs.
- Replaced the fictional CI section with the actual state and a
note explaining how someone could contribute a real test workflow.
docs/MIGRATION_GUIDE.md:92
- Referenced scripts/fix_perms/README.md "(if exists)" — the
hedge betrays that the writer wasn't sure. The README didn't
exist. The 6 scripts in scripts/fix_perms/ were never documented.
- Created the missing scripts/fix_perms/README.md from scratch
with one-line descriptions of all 6 scripts (fix_assets,
fix_cache, fix_plugin, fix_web, fix_nhl_cache, safe_plugin_rm)
+ when-to-use-each guidance + usage examples.
- Updated MIGRATION_GUIDE link to drop the "(if exists)" hedge
since the file now exists.
docs/FONT_MANAGER.md:376
- "See test/font_manager_example.py for a complete working example"
— that file does not exist. Verified by listing test/ directory.
- Replaced with a pointer to src/font_manager.py itself and the
existing scoreboard base classes in src/base_classes/ that
actually use the font manager API in production.
Path-existence check methodology:
- Walked docs/ recursively, regex-extracted backtick-quoted paths
matching either /\.(py|sh|json|yml|yaml|md|txt|service|html|js|css|ttf|bdf|png)/
or paths starting with known directory prefixes (scripts/, src/,
config/, web_interface/, systemd/, assets/, docs/, test/, etc.)
- Filtered out URLs, absolute paths (placeholders), and paths
without slashes (likely not relative refs).
- Checked existence relative to project root.
- Out of 80 unique relative paths in docs/, 32 didn't exist on
disk. Most were false positives (configkeys mistaken for paths,
example placeholders like 'assets/myfont.ttf', historical
references inside docs that already have status banners). The 4
above were genuine broken refs.
This pattern is reusable for future iterations and worth wiring
into CI (link checker like lychee, scoped to fenced code paths
rather than just markdown links, would catch the same class).
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
* docs: address CodeRabbit review comments on #306
Reviewed all 12 CodeRabbit comments on PR #306, verified each against
the current code, and fixed the 11 valid ones. The 12th finding is a
real code bug (cache_manager.delete() calls in api_helper.py and
resource_monitor.py) that's already in the planned follow-up code-fix
PR, so it stays out of this docs PR.
Fixed:
.cursor/plugins_guide.md, .cursor/README.md, .cursorrules
- I claimed "there is no --emulator flag" in 3 places. Verified in
run.py:19-20 that the -e/--emulator flag is defined and functional
(it sets os.environ["EMULATOR"]="true" before the display imports).
Other docs I didn't touch (.cursor/plugin_templates/QUICK_START.md,
docs/PLUGIN_DEVELOPMENT_GUIDE.md) already use the flag correctly.
Replaced all 3 wrong statements with accurate guidance that
both forms work and explains the CLI flag's relationship to the
env var.
.cursorrules, docs/GETTING_STARTED.md, docs/WEB_INTERFACE_GUIDE.md,
docs/PLUGIN_DEVELOPMENT_GUIDE.md
- Four places claimed "the plugin loader also falls back to plugins/".
Verified that PluginManager.discover_plugins()
(src/plugin_system/plugin_manager.py:154) only scans the
configured directory — no fallback. The fallback to plugins/
exists only in two narrower places: store_manager.py:1700-1718
(store install/update/uninstall operations) and
schema_manager.py:70-80 (schema lookup for the web UI form
generator). Rewrote all four mentions with the precise scope.
Added a recommendation to set plugin_system.plugins_directory
to "plugins" for the smoothest dev workflow with
dev_plugin_setup.sh symlinks.
docs/FONT_MANAGER.md
- The "Status" warning told plugin authors to use
display_manager.font_manager.resolve_font(...) as a workaround for
loading plugin fonts. Verified in src/font_manager.py that
resolve_font() takes a family name, not a file path — so the
workaround as written doesn't actually work. Rewrote to tell
authors to load the font directly with PIL or freetype-py in their
plugin.
- The same section said "the user-facing font override system in the
Fonts tab still works for any element that's been registered via
register_manager_font()". Verified in
web_interface/blueprints/api_v3.py:5404-5428 that
/api/v3/fonts/overrides is a placeholder implementation that
returns empty arrays and contains "would integrate with the actual
font system" comments — the Fonts tab does not have functional
integration with register_manager_font() or the override system.
Removed the false claim and added an explicit note that the tab
is a placeholder.
docs/ADVANCED_FEATURES.md:523
- The on-demand section said REST/UI calls write a request "into the
cache manager (display_on_demand_config key)". Wrong — verified
via grep that api_v3.py:1622 and :1687 write to
display_on_demand_request, and display_on_demand_config is only
written by the controller during activation
(display_controller.py:1195, cleared at :1221). Corrected the key
name and added controller file:line references so future readers
can verify.
docs/ADVANCED_FEATURES.md:803
- "Plugins using the background service" paragraph listed all
scoreboard plugins but an orphaned "⏳ MLB (baseball)" bullet
remained below from the old version of the section. Removed the
orphan and added "baseball/MLB" to the inline list for clarity.
web_interface/README.md
- The POST /api/v3/system/action action list was incomplete. Verified
in web_interface/app.py:1383,1386 that enable_autostart and
disable_autostart are valid actions. Added both.
- The Plugin Store section was missing
GET /api/v3/plugins/store/github-status (verified at
api_v3.py:3296). Added it.
- The SSE line-range reference was app.py:607-615 but line 619
contains the "Exempt SSE streams from CSRF and add rate limiting"
block that's semantically part of the same feature. Extended the
range to 607-619.
docs/GETTING_STARTED.md
- Rows/Columns step said "Columns: 64 or 96 (match your hardware)".
The web UI's validation accepts any integer in 16-128. Clarified
that 64 and 96 are the common bundled-hardware values but the
valid range is wider.
Not addressed (out of scope for docs PR):
- .cursorrules:184 CodeRabbit comment flagged the non-existent
cache_manager.delete() calls in src/common/api_helper.py:287 and
src/plugin_system/resource_monitor.py:343. These are real CODE
bugs, not doc bugs, and they're the first item in the planned
post-docs-refresh code-cleanup PR (see
/home/chuck/.claude/plans/warm-imagining-river.md). The docs in
this PR correctly state that delete() doesn't exist on
CacheManager — the fix belongs in the follow-up code PR that
either adds a delete() shim or updates the two callers.
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
---------
Co-authored-by: Chuck <chuck@example.com>
Co-authored-by: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
This commit is contained in:
@@ -43,39 +43,48 @@ cp ../../.cursor/plugin_templates/*.template .
|
|||||||
2. **Using dev_plugin_setup.sh**:
|
2. **Using dev_plugin_setup.sh**:
|
||||||
```bash
|
```bash
|
||||||
# Link from GitHub
|
# Link from GitHub
|
||||||
./dev_plugin_setup.sh link-github my-plugin
|
./scripts/dev/dev_plugin_setup.sh link-github my-plugin
|
||||||
|
|
||||||
# Link local repo
|
# Link local repo
|
||||||
./dev_plugin_setup.sh link my-plugin /path/to/repo
|
./scripts/dev/dev_plugin_setup.sh link my-plugin /path/to/repo
|
||||||
```
|
```
|
||||||
|
|
||||||
### Running Plugins
|
### Running the Display
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
# Emulator (development)
|
# Emulator mode (development, no hardware required)
|
||||||
python run.py --emulator
|
python3 run.py --emulator
|
||||||
|
# (equivalent: EMULATOR=true python3 run.py)
|
||||||
|
|
||||||
# Hardware (production)
|
# Hardware (production, requires the rpi-rgb-led-matrix submodule built)
|
||||||
python run.py
|
python3 run.py
|
||||||
|
|
||||||
# As service
|
# As a systemd service
|
||||||
sudo systemctl start ledmatrix
|
sudo systemctl start ledmatrix
|
||||||
|
|
||||||
|
# Dev preview server (renders plugins to a browser without running run.py)
|
||||||
|
python3 scripts/dev_server.py # then open http://localhost:5001
|
||||||
```
|
```
|
||||||
|
|
||||||
|
The `-e`/`--emulator` CLI flag is defined in `run.py:19-20` and
|
||||||
|
sets `os.environ["EMULATOR"] = "true"` before any display imports,
|
||||||
|
which `src/display_manager.py:2` then reads to switch between the
|
||||||
|
hardware and emulator backends.
|
||||||
|
|
||||||
### Managing Plugins
|
### Managing Plugins
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
# List plugins
|
# List plugins
|
||||||
./dev_plugin_setup.sh list
|
./scripts/dev/dev_plugin_setup.sh list
|
||||||
|
|
||||||
# Check status
|
# Check status
|
||||||
./dev_plugin_setup.sh status
|
./scripts/dev/dev_plugin_setup.sh status
|
||||||
|
|
||||||
# Update plugin(s)
|
# Update plugin(s)
|
||||||
./dev_plugin_setup.sh update [plugin-name]
|
./scripts/dev/dev_plugin_setup.sh update [plugin-name]
|
||||||
|
|
||||||
# Unlink plugin
|
# Unlink plugin
|
||||||
./dev_plugin_setup.sh unlink <plugin-name>
|
./scripts/dev/dev_plugin_setup.sh unlink <plugin-name>
|
||||||
```
|
```
|
||||||
|
|
||||||
## Using These Files with Cursor
|
## Using These Files with Cursor
|
||||||
@@ -118,9 +127,13 @@ Refer to `plugins_guide.md` for:
|
|||||||
- **Plugin System**: `src/plugin_system/`
|
- **Plugin System**: `src/plugin_system/`
|
||||||
- **Base Plugin**: `src/plugin_system/base_plugin.py`
|
- **Base Plugin**: `src/plugin_system/base_plugin.py`
|
||||||
- **Plugin Manager**: `src/plugin_system/plugin_manager.py`
|
- **Plugin Manager**: `src/plugin_system/plugin_manager.py`
|
||||||
- **Example Plugins**: `plugins/hockey-scoreboard/`, `plugins/football-scoreboard/`
|
- **Example Plugins**: see the
|
||||||
|
[`ledmatrix-plugins`](https://github.com/ChuckBuilds/ledmatrix-plugins)
|
||||||
|
repo for canonical sources (e.g. `plugins/hockey-scoreboard/`,
|
||||||
|
`plugins/football-scoreboard/`). Installed plugins land in
|
||||||
|
`plugin-repos/` (default) or `plugins/` (dev fallback).
|
||||||
- **Architecture Docs**: `docs/PLUGIN_ARCHITECTURE_SPEC.md`
|
- **Architecture Docs**: `docs/PLUGIN_ARCHITECTURE_SPEC.md`
|
||||||
- **Development Setup**: `dev_plugin_setup.sh`
|
- **Development Setup**: `scripts/dev/dev_plugin_setup.sh`
|
||||||
|
|
||||||
## Getting Help
|
## Getting Help
|
||||||
|
|
||||||
|
|||||||
@@ -156,20 +156,34 @@ def _fetch_data(self):
|
|||||||
|
|
||||||
### Adding Image Rendering
|
### Adding Image Rendering
|
||||||
|
|
||||||
|
There is no `draw_image()` helper on `DisplayManager`. To render an
|
||||||
|
image, paste it directly onto the underlying PIL `Image`
|
||||||
|
(`display_manager.image`) and then call `update_display()`:
|
||||||
|
|
||||||
```python
|
```python
|
||||||
def _render_content(self):
|
def _render_content(self):
|
||||||
# Load and render image
|
# Load and paste image onto the display canvas
|
||||||
image = Image.open("assets/logo.png")
|
image = Image.open("assets/logo.png").convert("RGB")
|
||||||
self.display_manager.draw_image(image, x=0, y=0)
|
self.display_manager.image.paste(image, (0, 0))
|
||||||
|
|
||||||
# Draw text overlay
|
# Draw text overlay
|
||||||
self.display_manager.draw_text(
|
self.display_manager.draw_text(
|
||||||
"Text",
|
"Text",
|
||||||
x=10, y=20,
|
x=10, y=20,
|
||||||
color=(255, 255, 255)
|
color=(255, 255, 255)
|
||||||
)
|
)
|
||||||
|
|
||||||
|
self.display_manager.update_display()
|
||||||
```
|
```
|
||||||
|
|
||||||
|
For transparency, paste with a mask:
|
||||||
|
|
||||||
|
```python
|
||||||
|
icon = Image.open("assets/icon.png").convert("RGBA")
|
||||||
|
self.display_manager.image.paste(icon, (5, 5), icon)
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
### Adding Live Priority
|
### Adding Live Priority
|
||||||
|
|
||||||
1. Enable in config:
|
1. Enable in config:
|
||||||
|
|||||||
@@ -53,13 +53,13 @@ This method is best for plugins stored in separate Git repositories.
|
|||||||
|
|
||||||
```bash
|
```bash
|
||||||
# Link a plugin from GitHub (auto-detects URL)
|
# Link a plugin from GitHub (auto-detects URL)
|
||||||
./dev_plugin_setup.sh link-github <plugin-name>
|
./scripts/dev/dev_plugin_setup.sh link-github <plugin-name>
|
||||||
|
|
||||||
# Example: Link hockey-scoreboard plugin
|
# Example: Link hockey-scoreboard plugin
|
||||||
./dev_plugin_setup.sh link-github hockey-scoreboard
|
./scripts/dev/dev_plugin_setup.sh link-github hockey-scoreboard
|
||||||
|
|
||||||
# With custom URL
|
# With custom URL
|
||||||
./dev_plugin_setup.sh link-github <plugin-name> https://github.com/user/repo.git
|
./scripts/dev/dev_plugin_setup.sh link-github <plugin-name> https://github.com/user/repo.git
|
||||||
```
|
```
|
||||||
|
|
||||||
The script will:
|
The script will:
|
||||||
@@ -71,10 +71,10 @@ The script will:
|
|||||||
|
|
||||||
```bash
|
```bash
|
||||||
# Link a local plugin repository
|
# Link a local plugin repository
|
||||||
./dev_plugin_setup.sh link <plugin-name> <path-to-repo>
|
./scripts/dev/dev_plugin_setup.sh link <plugin-name> <path-to-repo>
|
||||||
|
|
||||||
# Example: Link a local plugin
|
# Example: Link a local plugin
|
||||||
./dev_plugin_setup.sh link my-plugin ../ledmatrix-my-plugin
|
./scripts/dev/dev_plugin_setup.sh link my-plugin ../ledmatrix-my-plugin
|
||||||
```
|
```
|
||||||
|
|
||||||
### Method 2: Manual Plugin Creation
|
### Method 2: Manual Plugin Creation
|
||||||
@@ -321,7 +321,8 @@ Each plugin has its own section in `config/config.json`:
|
|||||||
|
|
||||||
### Secrets Management
|
### Secrets Management
|
||||||
|
|
||||||
Store sensitive data (API keys, tokens) in `config/config_secrets.json`:
|
Store sensitive data (API keys, tokens) in `config/config_secrets.json`
|
||||||
|
under the same plugin id you use in `config/config.json`:
|
||||||
|
|
||||||
```json
|
```json
|
||||||
{
|
{
|
||||||
@@ -331,19 +332,21 @@ Store sensitive data (API keys, tokens) in `config/config_secrets.json`:
|
|||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
Reference secrets in main config:
|
At load time, the config manager deep-merges `config_secrets.json` into
|
||||||
|
the main config (verified at `src/config_manager.py:162-172`). So in
|
||||||
|
your plugin's code:
|
||||||
|
|
||||||
```json
|
```python
|
||||||
{
|
class MyPlugin(BasePlugin):
|
||||||
"my-plugin": {
|
def __init__(self, plugin_id, config, display_manager, cache_manager, plugin_manager):
|
||||||
"enabled": true,
|
super().__init__(plugin_id, config, display_manager, cache_manager, plugin_manager)
|
||||||
"config_secrets": {
|
self.api_key = config.get("api_key") # already merged from secrets
|
||||||
"api_key": "my-plugin.api_key"
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
```
|
```
|
||||||
|
|
||||||
|
There is no separate `config_secrets` reference field — just put the
|
||||||
|
secret value under the same plugin namespace and read it from the
|
||||||
|
merged config.
|
||||||
|
|
||||||
### Plugin Discovery
|
### Plugin Discovery
|
||||||
|
|
||||||
Plugins are automatically discovered when:
|
Plugins are automatically discovered when:
|
||||||
@@ -355,7 +358,7 @@ Check discovered plugins:
|
|||||||
|
|
||||||
```bash
|
```bash
|
||||||
# Using dev_plugin_setup.sh
|
# Using dev_plugin_setup.sh
|
||||||
./dev_plugin_setup.sh list
|
./scripts/dev/dev_plugin_setup.sh list
|
||||||
|
|
||||||
# Output shows:
|
# Output shows:
|
||||||
# ✓ plugin-name (symlink)
|
# ✓ plugin-name (symlink)
|
||||||
@@ -368,7 +371,7 @@ Check discovered plugins:
|
|||||||
Check plugin status and git information:
|
Check plugin status and git information:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
./dev_plugin_setup.sh status
|
./scripts/dev/dev_plugin_setup.sh status
|
||||||
|
|
||||||
# Output shows:
|
# Output shows:
|
||||||
# ✓ plugin-name
|
# ✓ plugin-name
|
||||||
@@ -391,13 +394,19 @@ cd ledmatrix-my-plugin
|
|||||||
|
|
||||||
# Link to LEDMatrix project
|
# Link to LEDMatrix project
|
||||||
cd /path/to/LEDMatrix
|
cd /path/to/LEDMatrix
|
||||||
./dev_plugin_setup.sh link my-plugin ../ledmatrix-my-plugin
|
./scripts/dev/dev_plugin_setup.sh link my-plugin ../ledmatrix-my-plugin
|
||||||
```
|
```
|
||||||
|
|
||||||
### 2. Development Cycle
|
### 2. Development Cycle
|
||||||
|
|
||||||
1. **Edit plugin code** in linked repository
|
1. **Edit plugin code** in linked repository
|
||||||
2. **Test with emulator**: `python run.py --emulator`
|
2. **Test with the dev preview server**:
|
||||||
|
`python3 scripts/dev_server.py` (then open `http://localhost:5001`).
|
||||||
|
Or run the full display in emulator mode with
|
||||||
|
`python3 run.py --emulator` (or equivalently
|
||||||
|
`EMULATOR=true python3 run.py`). The `-e`/`--emulator` CLI flag is
|
||||||
|
defined in `run.py:19-20` and sets the same `EMULATOR` environment
|
||||||
|
variable internally.
|
||||||
3. **Check logs** for errors or warnings
|
3. **Check logs** for errors or warnings
|
||||||
4. **Update configuration** in `config/config.json` if needed
|
4. **Update configuration** in `config/config.json` if needed
|
||||||
5. **Iterate** until plugin works correctly
|
5. **Iterate** until plugin works correctly
|
||||||
@@ -406,30 +415,30 @@ cd /path/to/LEDMatrix
|
|||||||
|
|
||||||
```bash
|
```bash
|
||||||
# Deploy to Raspberry Pi
|
# Deploy to Raspberry Pi
|
||||||
rsync -avz plugins/my-plugin/ pi@raspberrypi:/path/to/LEDMatrix/plugins/my-plugin/
|
rsync -avz plugins/my-plugin/ ledpi@your-pi-ip:/path/to/LEDMatrix/plugins/my-plugin/
|
||||||
|
|
||||||
# Or if using git, pull on Pi
|
# Or if using git, pull on Pi
|
||||||
ssh pi@raspberrypi "cd /path/to/LEDMatrix/plugins/my-plugin && git pull"
|
ssh ledpi@your-pi-ip "cd /path/to/LEDMatrix/plugins/my-plugin && git pull"
|
||||||
|
|
||||||
# Restart service
|
# Restart service
|
||||||
ssh pi@raspberrypi "sudo systemctl restart ledmatrix"
|
ssh ledpi@your-pi-ip "sudo systemctl restart ledmatrix"
|
||||||
```
|
```
|
||||||
|
|
||||||
### 4. Updating Plugins
|
### 4. Updating Plugins
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
# Update single plugin from git
|
# Update single plugin from git
|
||||||
./dev_plugin_setup.sh update my-plugin
|
./scripts/dev/dev_plugin_setup.sh update my-plugin
|
||||||
|
|
||||||
# Update all linked plugins
|
# Update all linked plugins
|
||||||
./dev_plugin_setup.sh update
|
./scripts/dev/dev_plugin_setup.sh update
|
||||||
```
|
```
|
||||||
|
|
||||||
### 5. Unlinking Plugins
|
### 5. Unlinking Plugins
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
# Remove symlink (preserves repository)
|
# Remove symlink (preserves repository)
|
||||||
./dev_plugin_setup.sh unlink my-plugin
|
./scripts/dev/dev_plugin_setup.sh unlink my-plugin
|
||||||
```
|
```
|
||||||
|
|
||||||
---
|
---
|
||||||
@@ -625,8 +634,8 @@ python run.py --emulator
|
|||||||
**Solutions**:
|
**Solutions**:
|
||||||
1. Check symlink: `ls -la plugins/my-plugin`
|
1. Check symlink: `ls -la plugins/my-plugin`
|
||||||
2. Verify target exists: `readlink -f plugins/my-plugin`
|
2. Verify target exists: `readlink -f plugins/my-plugin`
|
||||||
3. Update plugin: `./dev_plugin_setup.sh update my-plugin`
|
3. Update plugin: `./scripts/dev/dev_plugin_setup.sh update my-plugin`
|
||||||
4. Re-link plugin if needed: `./dev_plugin_setup.sh unlink my-plugin && ./dev_plugin_setup.sh link my-plugin <path>`
|
4. Re-link plugin if needed: `./scripts/dev/dev_plugin_setup.sh unlink my-plugin && ./scripts/dev/dev_plugin_setup.sh link my-plugin <path>`
|
||||||
5. Check git status: `cd plugins/my-plugin && git status`
|
5. Check git status: `cd plugins/my-plugin && git status`
|
||||||
|
|
||||||
---
|
---
|
||||||
@@ -697,22 +706,22 @@ python run.py --emulator
|
|||||||
|
|
||||||
```bash
|
```bash
|
||||||
# Link plugin from GitHub
|
# Link plugin from GitHub
|
||||||
./dev_plugin_setup.sh link-github <name>
|
./scripts/dev/dev_plugin_setup.sh link-github <name>
|
||||||
|
|
||||||
# Link local plugin
|
# Link local plugin
|
||||||
./dev_plugin_setup.sh link <name> <path>
|
./scripts/dev/dev_plugin_setup.sh link <name> <path>
|
||||||
|
|
||||||
# List all plugins
|
# List all plugins
|
||||||
./dev_plugin_setup.sh list
|
./scripts/dev/dev_plugin_setup.sh list
|
||||||
|
|
||||||
# Check plugin status
|
# Check plugin status
|
||||||
./dev_plugin_setup.sh status
|
./scripts/dev/dev_plugin_setup.sh status
|
||||||
|
|
||||||
# Update plugin(s)
|
# Update plugin(s)
|
||||||
./dev_plugin_setup.sh update [name]
|
./scripts/dev/dev_plugin_setup.sh update [name]
|
||||||
|
|
||||||
# Unlink plugin
|
# Unlink plugin
|
||||||
./dev_plugin_setup.sh unlink <name>
|
./scripts/dev/dev_plugin_setup.sh unlink <name>
|
||||||
|
|
||||||
# Run with emulator
|
# Run with emulator
|
||||||
python run.py --emulator
|
python run.py --emulator
|
||||||
|
|||||||
79
.cursorrules
79
.cursorrules
@@ -2,7 +2,31 @@
|
|||||||
|
|
||||||
## Plugin System Overview
|
## Plugin System Overview
|
||||||
|
|
||||||
The LEDMatrix project uses a plugin-based architecture. All display functionality (except core calendar) is implemented as plugins that are dynamically loaded from the `plugins/` directory.
|
The LEDMatrix project uses a plugin-based architecture. All display
|
||||||
|
functionality (except core calendar) is implemented as plugins that are
|
||||||
|
dynamically loaded from the directory configured by
|
||||||
|
`plugin_system.plugins_directory` in `config.json` — the default is
|
||||||
|
`plugin-repos/` (per `config/config.template.json:130`).
|
||||||
|
|
||||||
|
> **Fallback note (scoped):** `PluginManager.discover_plugins()`
|
||||||
|
> (`src/plugin_system/plugin_manager.py:154`) only scans the
|
||||||
|
> configured directory — there is no fallback to `plugins/` in the
|
||||||
|
> main discovery path. A fallback to `plugins/` does exist in two
|
||||||
|
> narrower places:
|
||||||
|
> - `store_manager.py:1700-1718` — store operations (install/update/
|
||||||
|
> uninstall) check `plugins/` if the plugin isn't found in the
|
||||||
|
> configured directory, so plugin-store flows work even when your
|
||||||
|
> dev symlinks live in `plugins/`.
|
||||||
|
> - `schema_manager.py:70-80` — `get_schema_path()` probes both
|
||||||
|
> `plugins/` and `plugin-repos/` for `config_schema.json` so the
|
||||||
|
> web UI form generation finds the schema regardless of where the
|
||||||
|
> plugin lives.
|
||||||
|
>
|
||||||
|
> The dev workflow in `scripts/dev/dev_plugin_setup.sh` creates
|
||||||
|
> symlinks under `plugins/`, which is why the store and schema
|
||||||
|
> fallbacks exist. For day-to-day development, set
|
||||||
|
> `plugin_system.plugins_directory` to `plugins` so the main
|
||||||
|
> discovery path picks up your symlinks.
|
||||||
|
|
||||||
## Plugin Structure
|
## Plugin Structure
|
||||||
|
|
||||||
@@ -27,14 +51,15 @@ The LEDMatrix project uses a plugin-based architecture. All display functionalit
|
|||||||
**Option A: Use dev_plugin_setup.sh (Recommended)**
|
**Option A: Use dev_plugin_setup.sh (Recommended)**
|
||||||
```bash
|
```bash
|
||||||
# Link from GitHub
|
# Link from GitHub
|
||||||
./dev_plugin_setup.sh link-github <plugin-name>
|
./scripts/dev/dev_plugin_setup.sh link-github <plugin-name>
|
||||||
|
|
||||||
# Link local repository
|
# Link local repository
|
||||||
./dev_plugin_setup.sh link <plugin-name> <path-to-repo>
|
./scripts/dev/dev_plugin_setup.sh link <plugin-name> <path-to-repo>
|
||||||
```
|
```
|
||||||
|
|
||||||
**Option B: Manual Setup**
|
**Option B: Manual Setup**
|
||||||
1. Create directory in `plugins/<plugin-id>/`
|
1. Create directory in `plugin-repos/<plugin-id>/` (or `plugins/<plugin-id>/`
|
||||||
|
if you're using the dev fallback location)
|
||||||
2. Add `manifest.json` with required fields
|
2. Add `manifest.json` with required fields
|
||||||
3. Create `manager.py` with plugin class
|
3. Create `manager.py` with plugin class
|
||||||
4. Add `config_schema.json` for configuration
|
4. Add `config_schema.json` for configuration
|
||||||
@@ -63,7 +88,13 @@ Plugins are configured in `config/config.json`:
|
|||||||
### 3. Testing Plugins
|
### 3. Testing Plugins
|
||||||
|
|
||||||
**On Development Machine:**
|
**On Development Machine:**
|
||||||
- Use emulator: `python run.py --emulator` or `./run_emulator.sh`
|
- Run the dev preview server: `python3 scripts/dev_server.py` (then
|
||||||
|
open `http://localhost:5001`) — renders plugins in the browser
|
||||||
|
without running the full display loop
|
||||||
|
- Or run the full display in emulator mode:
|
||||||
|
`python3 run.py --emulator` (or equivalently
|
||||||
|
`EMULATOR=true python3 run.py`, or `./scripts/dev/run_emulator.sh`).
|
||||||
|
The `-e`/`--emulator` CLI flag is defined in `run.py:19-20`.
|
||||||
- Test plugin loading: Check logs for plugin discovery and loading
|
- Test plugin loading: Check logs for plugin discovery and loading
|
||||||
- Validate configuration: Ensure config matches `config_schema.json`
|
- Validate configuration: Ensure config matches `config_schema.json`
|
||||||
|
|
||||||
@@ -75,15 +106,22 @@ Plugins are configured in `config/config.json`:
|
|||||||
### 4. Plugin Development Best Practices
|
### 4. Plugin Development Best Practices
|
||||||
|
|
||||||
**Code Organization:**
|
**Code Organization:**
|
||||||
- Keep plugin code in `plugins/<plugin-id>/`
|
- Keep plugin code in `plugin-repos/<plugin-id>/` (or its dev-time
|
||||||
|
symlink in `plugins/<plugin-id>/`)
|
||||||
- Use shared assets from `assets/` directory when possible
|
- Use shared assets from `assets/` directory when possible
|
||||||
- Follow existing plugin patterns (see `plugins/hockey-scoreboard/` as reference)
|
- Follow existing plugin patterns — canonical sources live in the
|
||||||
|
[`ledmatrix-plugins`](https://github.com/ChuckBuilds/ledmatrix-plugins)
|
||||||
|
repo (`plugins/hockey-scoreboard/`, `plugins/football-scoreboard/`,
|
||||||
|
`plugins/clock-simple/`, etc.)
|
||||||
- Place shared utilities in `src/common/` if reusable across plugins
|
- Place shared utilities in `src/common/` if reusable across plugins
|
||||||
|
|
||||||
**Configuration Management:**
|
**Configuration Management:**
|
||||||
- Use `config_schema.json` for validation
|
- Use `config_schema.json` for validation
|
||||||
- Store secrets in `config/config_secrets.json` (not in main config)
|
- Store secrets in `config/config_secrets.json` under the same plugin
|
||||||
- Reference secrets via `config_secrets` key in main config
|
id namespace as the main config — they're deep-merged into the main
|
||||||
|
config at load time (`src/config_manager.py:162-172`), so plugin
|
||||||
|
code reads them directly from `config.get(...)` like any other key
|
||||||
|
- There is no separate `config_secrets` reference field
|
||||||
- Validate all required fields in `validate_config()`
|
- Validate all required fields in `validate_config()`
|
||||||
|
|
||||||
**Error Handling:**
|
**Error Handling:**
|
||||||
@@ -138,18 +176,31 @@ Located in: `src/display_manager.py`
|
|||||||
|
|
||||||
**Key Methods:**
|
**Key Methods:**
|
||||||
- `clear()`: Clear the display
|
- `clear()`: Clear the display
|
||||||
- `draw_text(text, x, y, color, font)`: Draw text
|
- `draw_text(text, x, y, color, font, small_font, centered)`: Draw text
|
||||||
- `draw_image(image, x, y)`: Draw PIL Image
|
- `update_display()`: Push the buffer to the physical display
|
||||||
- `update_display()`: Update physical display
|
- `draw_weather_icon(condition, x, y, size)`: Draw a weather icon
|
||||||
- `width`, `height`: Display dimensions
|
- `width`, `height`: Display dimensions
|
||||||
|
|
||||||
|
**Image rendering**: there is no `draw_image()` helper. Paste directly
|
||||||
|
onto the underlying PIL Image:
|
||||||
|
```python
|
||||||
|
self.display_manager.image.paste(pil_image, (x, y))
|
||||||
|
self.display_manager.update_display()
|
||||||
|
```
|
||||||
|
For transparency, paste with a mask: `image.paste(rgba, (x, y), rgba)`.
|
||||||
|
|
||||||
### Cache Manager
|
### Cache Manager
|
||||||
Located in: `src/cache_manager.py`
|
Located in: `src/cache_manager.py`
|
||||||
|
|
||||||
**Key Methods:**
|
**Key Methods:**
|
||||||
- `get(key, max_age=None)`: Get cached value
|
- `get(key, max_age=300)`: Get cached value (returns None if missing/stale)
|
||||||
- `set(key, value, ttl=None)`: Cache a value
|
- `set(key, value, ttl=None)`: Cache a value
|
||||||
- `delete(key)`: Remove cached value
|
- `clear_cache(key=None)`: Remove a cache entry, or all entries if `key`
|
||||||
|
is omitted. There is no `delete()` method.
|
||||||
|
- `get_cached_data_with_strategy(key, data_type)`: Cache get with
|
||||||
|
data-type-aware TTL strategy
|
||||||
|
- `get_background_cached_data(key, sport_key)`: Cache get for the
|
||||||
|
background-fetch service path
|
||||||
|
|
||||||
## Plugin Manifest Schema
|
## Plugin Manifest Schema
|
||||||
|
|
||||||
|
|||||||
96
.github/ISSUE_TEMPLATE/bug_report.md
vendored
96
.github/ISSUE_TEMPLATE/bug_report.md
vendored
@@ -1,38 +1,84 @@
|
|||||||
---
|
---
|
||||||
name: Bug report
|
name: Bug report
|
||||||
about: Create a report to help us improve
|
about: Report a problem with LEDMatrix
|
||||||
title: ''
|
title: ''
|
||||||
labels: ''
|
labels: bug
|
||||||
assignees: ''
|
assignees: ''
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
**Describe the bug**
|
<!--
|
||||||
A clear and concise description of what the bug is.
|
Before filing: please check existing issues to see if this is already
|
||||||
|
reported. For security issues, see SECURITY.md and report privately.
|
||||||
|
-->
|
||||||
|
|
||||||
**To Reproduce**
|
## Describe the bug
|
||||||
Steps to reproduce the behavior:
|
|
||||||
1. Go to '...'
|
|
||||||
2. Click on '....'
|
|
||||||
3. Scroll down to '....'
|
|
||||||
4. See error
|
|
||||||
|
|
||||||
**Expected behavior**
|
<!-- A clear and concise description of what the bug is. -->
|
||||||
A clear and concise description of what you expected to happen.
|
|
||||||
|
|
||||||
**Screenshots**
|
## Steps to reproduce
|
||||||
If applicable, add screenshots to help explain your problem.
|
|
||||||
|
|
||||||
**Desktop (please complete the following information):**
|
1.
|
||||||
- OS: [e.g. iOS]
|
2.
|
||||||
- Browser [e.g. chrome, safari]
|
3.
|
||||||
- Version [e.g. 22]
|
|
||||||
|
|
||||||
**Smartphone (please complete the following information):**
|
## Expected behavior
|
||||||
- Device: [e.g. iPhone6]
|
|
||||||
- OS: [e.g. iOS8.1]
|
|
||||||
- Browser [e.g. stock browser, safari]
|
|
||||||
- Version [e.g. 22]
|
|
||||||
|
|
||||||
**Additional context**
|
<!-- What you expected to happen. -->
|
||||||
Add any other context about the problem here.
|
|
||||||
|
## Actual behavior
|
||||||
|
|
||||||
|
<!-- What actually happened. Include any error messages. -->
|
||||||
|
|
||||||
|
## Hardware
|
||||||
|
|
||||||
|
- **Raspberry Pi model**: <!-- e.g. Pi 3B+, Pi 4 8GB, Pi Zero 2W -->
|
||||||
|
- **OS / kernel**: <!-- output of `cat /etc/os-release` and `uname -a` -->
|
||||||
|
- **LED matrix panels**: <!-- e.g. 2x Adafruit 64x32, 1x Waveshare 96x48 -->
|
||||||
|
- **HAT / Bonnet**: <!-- e.g. Adafruit RGB Matrix Bonnet, Electrodragon HAT -->
|
||||||
|
- **PWM jumper mod soldered?**: <!-- yes / no -->
|
||||||
|
- **Display chain**: <!-- chain_length × parallel, e.g. "2x1" -->
|
||||||
|
|
||||||
|
## LEDMatrix version
|
||||||
|
|
||||||
|
<!-- Run `git rev-parse HEAD` in the LEDMatrix directory, or paste the
|
||||||
|
release tag if you installed from a release. -->
|
||||||
|
|
||||||
|
```
|
||||||
|
git commit:
|
||||||
|
```
|
||||||
|
|
||||||
|
## Plugin involved (if any)
|
||||||
|
|
||||||
|
- **Plugin id**:
|
||||||
|
- **Plugin version** (from `manifest.json`):
|
||||||
|
|
||||||
|
## Configuration
|
||||||
|
|
||||||
|
<!-- Paste the relevant section from config/config.json. Redact any
|
||||||
|
API keys before pasting. For display issues, the `display.hardware`
|
||||||
|
block is most relevant. For plugin issues, paste that plugin's section. -->
|
||||||
|
|
||||||
|
```json
|
||||||
|
```
|
||||||
|
|
||||||
|
## Logs
|
||||||
|
|
||||||
|
<!-- The first 50 lines of the relevant log are usually enough. Run:
|
||||||
|
sudo journalctl -u ledmatrix -n 100 --no-pager
|
||||||
|
or for the web service:
|
||||||
|
sudo journalctl -u ledmatrix-web -n 100 --no-pager
|
||||||
|
-->
|
||||||
|
|
||||||
|
```
|
||||||
|
```
|
||||||
|
|
||||||
|
## Screenshots / video (optional)
|
||||||
|
|
||||||
|
<!-- A photo of the actual display, or a screenshot of the web UI,
|
||||||
|
helps a lot for visual issues. -->
|
||||||
|
|
||||||
|
## Additional context
|
||||||
|
|
||||||
|
<!-- Anything else that might be relevant: when did this start happening,
|
||||||
|
what's different about your setup, what have you already tried, etc. -->
|
||||||
|
|||||||
62
.github/PULL_REQUEST_TEMPLATE.md
vendored
Normal file
62
.github/PULL_REQUEST_TEMPLATE.md
vendored
Normal file
@@ -0,0 +1,62 @@
|
|||||||
|
# Pull Request
|
||||||
|
|
||||||
|
## Summary
|
||||||
|
|
||||||
|
<!-- 1-3 sentences describing what this PR does and why. -->
|
||||||
|
|
||||||
|
## Type of change
|
||||||
|
|
||||||
|
<!-- Check all that apply. -->
|
||||||
|
|
||||||
|
- [ ] Bug fix
|
||||||
|
- [ ] New feature
|
||||||
|
- [ ] Documentation
|
||||||
|
- [ ] Refactor (no functional change)
|
||||||
|
- [ ] Build / CI
|
||||||
|
- [ ] Plugin work (link to the plugin)
|
||||||
|
|
||||||
|
## Related issues
|
||||||
|
|
||||||
|
<!-- "Fixes #123" or "Refs #123". Use "Fixes" for bug PRs so the issue
|
||||||
|
auto-closes when this merges. -->
|
||||||
|
|
||||||
|
## Test plan
|
||||||
|
|
||||||
|
<!-- How did you test this? Check all that apply. Add details for any
|
||||||
|
checked box. -->
|
||||||
|
|
||||||
|
- [ ] Ran on a real Raspberry Pi with hardware
|
||||||
|
- [ ] Ran in emulator mode (`EMULATOR=true python3 run.py`)
|
||||||
|
- [ ] Ran the dev preview server (`scripts/dev_server.py`)
|
||||||
|
- [ ] Ran the test suite (`pytest`)
|
||||||
|
- [ ] Manually verified the affected code path in the web UI
|
||||||
|
- [ ] N/A — documentation-only change
|
||||||
|
|
||||||
|
## Documentation
|
||||||
|
|
||||||
|
- [ ] I updated `README.md` if user-facing behavior changed
|
||||||
|
- [ ] I updated the relevant doc in `docs/` if developer behavior changed
|
||||||
|
- [ ] I added/updated docstrings on new public functions
|
||||||
|
- [ ] N/A — no docs needed
|
||||||
|
|
||||||
|
## Plugin compatibility
|
||||||
|
|
||||||
|
<!-- For changes to BasePlugin, the plugin loader, the web UI, or the
|
||||||
|
config schema. -->
|
||||||
|
|
||||||
|
- [ ] No plugin breakage expected
|
||||||
|
- [ ] Some plugins will need updates — listed below
|
||||||
|
- [ ] N/A — change doesn't touch the plugin system
|
||||||
|
|
||||||
|
## Checklist
|
||||||
|
|
||||||
|
- [ ] My commits follow the message convention in `CONTRIBUTING.md`
|
||||||
|
- [ ] I read `CONTRIBUTING.md` and `CODE_OF_CONDUCT.md`
|
||||||
|
- [ ] I've not committed any secrets or hardcoded API keys
|
||||||
|
- [ ] If this adds a new config key, the form in the web UI was
|
||||||
|
verified (the form is generated from `config_schema.json`)
|
||||||
|
|
||||||
|
## Notes for reviewer
|
||||||
|
|
||||||
|
<!-- Anything reviewers should know — gotchas, things you weren't
|
||||||
|
sure about, decisions you'd like a second opinion on. -->
|
||||||
10
CLAUDE.md
10
CLAUDE.md
@@ -4,8 +4,14 @@
|
|||||||
- `src/plugin_system/` — Plugin loader, manager, store manager, base plugin class
|
- `src/plugin_system/` — Plugin loader, manager, store manager, base plugin class
|
||||||
- `web_interface/` — Flask web UI (blueprints, templates, static JS)
|
- `web_interface/` — Flask web UI (blueprints, templates, static JS)
|
||||||
- `config/config.json` — User plugin configuration (persists across plugin reinstalls)
|
- `config/config.json` — User plugin configuration (persists across plugin reinstalls)
|
||||||
- `plugins/` — Installed plugins directory (gitignored)
|
- `plugin-repos/` — **Default** plugin install directory used by the
|
||||||
- `plugin-repos/` — Development symlinks to monorepo plugin dirs
|
Plugin Store, set by `plugin_system.plugins_directory` in
|
||||||
|
`config.json` (default per `config/config.template.json:130`).
|
||||||
|
Not gitignored.
|
||||||
|
- `plugins/` — Legacy/dev plugin location. Gitignored (`plugins/*`).
|
||||||
|
Used by `scripts/dev/dev_plugin_setup.sh` for symlinks. The plugin
|
||||||
|
loader falls back to it when something isn't found in `plugin-repos/`
|
||||||
|
(`src/plugin_system/schema_manager.py:77`).
|
||||||
|
|
||||||
## Plugin System
|
## Plugin System
|
||||||
- Plugins inherit from `BasePlugin` in `src/plugin_system/base_plugin.py`
|
- Plugins inherit from `BasePlugin` in `src/plugin_system/base_plugin.py`
|
||||||
|
|||||||
137
CODE_OF_CONDUCT.md
Normal file
137
CODE_OF_CONDUCT.md
Normal file
@@ -0,0 +1,137 @@
|
|||||||
|
# Contributor Covenant Code of Conduct
|
||||||
|
|
||||||
|
## Our Pledge
|
||||||
|
|
||||||
|
We as members, contributors, and leaders pledge to make participation in our
|
||||||
|
community a harassment-free experience for everyone, regardless of age, body
|
||||||
|
size, visible or invisible disability, ethnicity, sex characteristics, gender
|
||||||
|
identity and expression, level of experience, education, socio-economic status,
|
||||||
|
nationality, personal appearance, race, religion, or sexual identity
|
||||||
|
and orientation.
|
||||||
|
|
||||||
|
We pledge to act and interact in ways that contribute to an open, welcoming,
|
||||||
|
diverse, inclusive, and healthy community.
|
||||||
|
|
||||||
|
## Our Standards
|
||||||
|
|
||||||
|
Examples of behavior that contributes to a positive environment for our
|
||||||
|
community include:
|
||||||
|
|
||||||
|
* Demonstrating empathy and kindness toward other people
|
||||||
|
* Being respectful of differing opinions, viewpoints, and experiences
|
||||||
|
* Giving and gracefully accepting constructive feedback
|
||||||
|
* Accepting responsibility and apologizing to those affected by our mistakes,
|
||||||
|
and learning from the experience
|
||||||
|
* Focusing on what is best not just for us as individuals, but for the
|
||||||
|
overall community
|
||||||
|
|
||||||
|
Examples of unacceptable behavior include:
|
||||||
|
|
||||||
|
* The use of sexualized language or imagery, and sexual attention or
|
||||||
|
advances of any kind
|
||||||
|
* Trolling, insulting or derogatory comments, and personal or political attacks
|
||||||
|
* Public or private harassment
|
||||||
|
* Publishing others' private information, such as a physical or email
|
||||||
|
address, without their explicit permission
|
||||||
|
* Other conduct which could reasonably be considered inappropriate in a
|
||||||
|
professional setting
|
||||||
|
|
||||||
|
## Enforcement Responsibilities
|
||||||
|
|
||||||
|
Community leaders are responsible for clarifying and enforcing our standards of
|
||||||
|
acceptable behavior and will take appropriate and fair corrective action in
|
||||||
|
response to any behavior that they deem inappropriate, threatening, offensive,
|
||||||
|
or harmful.
|
||||||
|
|
||||||
|
Community leaders have the right and responsibility to remove, edit, or reject
|
||||||
|
comments, commits, code, wiki edits, issues, and other contributions that are
|
||||||
|
not aligned to this Code of Conduct, and will communicate reasons for moderation
|
||||||
|
decisions when appropriate.
|
||||||
|
|
||||||
|
## Scope
|
||||||
|
|
||||||
|
This Code of Conduct applies within all community spaces, and also applies when
|
||||||
|
an individual is officially representing the community in public spaces.
|
||||||
|
Examples of representing our community include using an official email address,
|
||||||
|
posting via an official social media account, or acting as an appointed
|
||||||
|
representative at an online or offline event.
|
||||||
|
|
||||||
|
This includes the LEDMatrix Discord server, GitHub repositories owned by
|
||||||
|
ChuckBuilds, and any other forums hosted by or affiliated with the project.
|
||||||
|
|
||||||
|
## Enforcement
|
||||||
|
|
||||||
|
Instances of abusive, harassing, or otherwise unacceptable behavior may be
|
||||||
|
reported to the community leaders responsible for enforcement on the
|
||||||
|
[LEDMatrix Discord](https://discord.gg/uW36dVAtcT) (DM a moderator or
|
||||||
|
ChuckBuilds directly) or by opening a private GitHub Security Advisory if
|
||||||
|
the issue involves account safety. All complaints will be reviewed and
|
||||||
|
investigated promptly and fairly.
|
||||||
|
|
||||||
|
All community leaders are obligated to respect the privacy and security of the
|
||||||
|
reporter of any incident.
|
||||||
|
|
||||||
|
## Enforcement Guidelines
|
||||||
|
|
||||||
|
Community leaders will follow these Community Impact Guidelines in determining
|
||||||
|
the consequences for any action they deem in violation of this Code of Conduct:
|
||||||
|
|
||||||
|
### 1. Correction
|
||||||
|
|
||||||
|
**Community Impact**: Use of inappropriate language or other behavior deemed
|
||||||
|
unprofessional or unwelcome in the community.
|
||||||
|
|
||||||
|
**Consequence**: A private, written warning from community leaders, providing
|
||||||
|
clarity around the nature of the violation and an explanation of why the
|
||||||
|
behavior was inappropriate. A public apology may be requested.
|
||||||
|
|
||||||
|
### 2. Warning
|
||||||
|
|
||||||
|
**Community Impact**: A violation through a single incident or series
|
||||||
|
of actions.
|
||||||
|
|
||||||
|
**Consequence**: A warning with consequences for continued behavior. No
|
||||||
|
interaction with the people involved, including unsolicited interaction with
|
||||||
|
those enforcing the Code of Conduct, for a specified period of time. This
|
||||||
|
includes avoiding interactions in community spaces as well as external channels
|
||||||
|
like social media. Violating these terms may lead to a temporary or
|
||||||
|
permanent ban.
|
||||||
|
|
||||||
|
### 3. Temporary Ban
|
||||||
|
|
||||||
|
**Community Impact**: A serious violation of community standards, including
|
||||||
|
sustained inappropriate behavior.
|
||||||
|
|
||||||
|
**Consequence**: A temporary ban from any sort of interaction or public
|
||||||
|
communication with the community for a specified period of time. No public or
|
||||||
|
private interaction with the people involved, including unsolicited interaction
|
||||||
|
with those enforcing the Code of Conduct, is allowed during this period.
|
||||||
|
Violating these terms may lead to a permanent ban.
|
||||||
|
|
||||||
|
### 4. Permanent Ban
|
||||||
|
|
||||||
|
**Community Impact**: Demonstrating a pattern of violation of community
|
||||||
|
standards, including sustained inappropriate behavior, harassment of an
|
||||||
|
individual, or aggression toward or disparagement of classes of individuals.
|
||||||
|
|
||||||
|
**Consequence**: A permanent ban from any sort of public interaction within
|
||||||
|
the community.
|
||||||
|
|
||||||
|
## Attribution
|
||||||
|
|
||||||
|
This Code of Conduct is adapted from the [Contributor Covenant][homepage],
|
||||||
|
version 2.1, available at
|
||||||
|
[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
|
||||||
|
|
||||||
|
Community Impact Guidelines were inspired by
|
||||||
|
[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
|
||||||
|
|
||||||
|
For answers to common questions about this code of conduct, see the FAQ at
|
||||||
|
[https://www.contributor-covenant.org/faq][FAQ]. Translations are available
|
||||||
|
at [https://www.contributor-covenant.org/translations][translations].
|
||||||
|
|
||||||
|
[homepage]: https://www.contributor-covenant.org
|
||||||
|
[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
|
||||||
|
[Mozilla CoC]: https://github.com/mozilla/diversity
|
||||||
|
[FAQ]: https://www.contributor-covenant.org/faq
|
||||||
|
[translations]: https://www.contributor-covenant.org/translations
|
||||||
113
CONTRIBUTING.md
Normal file
113
CONTRIBUTING.md
Normal file
@@ -0,0 +1,113 @@
|
|||||||
|
# Contributing to LEDMatrix
|
||||||
|
|
||||||
|
Thanks for considering a contribution! LEDMatrix is built with help from
|
||||||
|
the community and we welcome bug reports, plugins, documentation
|
||||||
|
improvements, and code changes.
|
||||||
|
|
||||||
|
## Quick links
|
||||||
|
|
||||||
|
- **Bugs / feature requests**: open an issue using one of the templates
|
||||||
|
in [`.github/ISSUE_TEMPLATE/`](.github/ISSUE_TEMPLATE/).
|
||||||
|
- **Real-time discussion**: the
|
||||||
|
[LEDMatrix Discord](https://discord.gg/uW36dVAtcT).
|
||||||
|
- **Plugin development**:
|
||||||
|
[`docs/PLUGIN_DEVELOPMENT_GUIDE.md`](docs/PLUGIN_DEVELOPMENT_GUIDE.md)
|
||||||
|
and the [`ledmatrix-plugins`](https://github.com/ChuckBuilds/ledmatrix-plugins)
|
||||||
|
repository.
|
||||||
|
- **Security issues**: see [`SECURITY.md`](SECURITY.md). Please don't
|
||||||
|
open public issues for vulnerabilities.
|
||||||
|
|
||||||
|
## Setting up a development environment
|
||||||
|
|
||||||
|
1. Clone with submodules:
|
||||||
|
```bash
|
||||||
|
git clone --recurse-submodules https://github.com/ChuckBuilds/LEDMatrix.git
|
||||||
|
cd LEDMatrix
|
||||||
|
```
|
||||||
|
2. For development without hardware, run the dev preview server:
|
||||||
|
```bash
|
||||||
|
python3 scripts/dev_server.py
|
||||||
|
# then open http://localhost:5001
|
||||||
|
```
|
||||||
|
See [`docs/DEV_PREVIEW.md`](docs/DEV_PREVIEW.md) for details.
|
||||||
|
3. To run the full display in emulator mode:
|
||||||
|
```bash
|
||||||
|
EMULATOR=true python3 run.py
|
||||||
|
```
|
||||||
|
4. To target real hardware on a Raspberry Pi, follow the install
|
||||||
|
instructions in the root [`README.md`](README.md).
|
||||||
|
|
||||||
|
## Running the tests
|
||||||
|
|
||||||
|
```bash
|
||||||
|
pip install -r requirements.txt
|
||||||
|
pytest
|
||||||
|
```
|
||||||
|
|
||||||
|
See [`docs/HOW_TO_RUN_TESTS.md`](docs/HOW_TO_RUN_TESTS.md) for details
|
||||||
|
on test markers, the per-plugin tests, and the web-interface
|
||||||
|
integration tests.
|
||||||
|
|
||||||
|
## Submitting changes
|
||||||
|
|
||||||
|
1. **Open an issue first** for non-trivial changes. This avoids
|
||||||
|
wasted work on PRs that don't fit the project direction.
|
||||||
|
2. **Create a topic branch** off `main`:
|
||||||
|
`feat/<short-description>`, `fix/<short-description>`,
|
||||||
|
`docs/<short-description>`.
|
||||||
|
3. **Keep PRs focused.** One conceptual change per PR. If you find
|
||||||
|
adjacent bugs while working, fix them in a separate PR.
|
||||||
|
4. **Follow the existing code style.** Python code uses standard
|
||||||
|
`black`/`ruff` conventions; HTML/JS in `web_interface/` follows the
|
||||||
|
patterns already in `templates/v3/` and `static/v3/`.
|
||||||
|
5. **Update documentation** alongside code changes. If you add a
|
||||||
|
config key, document it in the relevant `*.md` file (or, for
|
||||||
|
plugins, in `config_schema.json` so the form is auto-generated).
|
||||||
|
6. **Run the tests** locally before opening the PR.
|
||||||
|
7. **Use the PR template** — `.github/PULL_REQUEST_TEMPLATE.md` will
|
||||||
|
prompt you for what we need.
|
||||||
|
|
||||||
|
## Commit message convention
|
||||||
|
|
||||||
|
Conventional Commits is encouraged but not strictly enforced:
|
||||||
|
|
||||||
|
- `feat: add NHL playoff bracket display`
|
||||||
|
- `fix(plugin-loader): handle missing class_name in manifest`
|
||||||
|
- `docs: correct web UI port in TROUBLESHOOTING.md`
|
||||||
|
- `refactor(cache): consolidate strategy lookup`
|
||||||
|
|
||||||
|
Keep the subject under 72 characters; put the why in the body.
|
||||||
|
|
||||||
|
## Contributing a plugin
|
||||||
|
|
||||||
|
LEDMatrix plugins live in their own repository:
|
||||||
|
[`ledmatrix-plugins`](https://github.com/ChuckBuilds/ledmatrix-plugins).
|
||||||
|
Plugin contributions go through that repo's
|
||||||
|
[`SUBMISSION.md`](https://github.com/ChuckBuilds/ledmatrix-plugins/blob/main/SUBMISSION.md)
|
||||||
|
process. The
|
||||||
|
[`hello-world` plugin](https://github.com/ChuckBuilds/ledmatrix-plugins/tree/main/plugins/hello-world)
|
||||||
|
is the canonical starter template.
|
||||||
|
|
||||||
|
## Reviewing pull requests
|
||||||
|
|
||||||
|
Maintainer review is by [@ChuckBuilds](https://github.com/ChuckBuilds).
|
||||||
|
Community review is welcome on any open PR — leave constructive
|
||||||
|
comments, test on your hardware if applicable, and call out anything
|
||||||
|
unclear.
|
||||||
|
|
||||||
|
## Code of conduct
|
||||||
|
|
||||||
|
This project follows the [Contributor Covenant](CODE_OF_CONDUCT.md). By
|
||||||
|
participating you agree to abide by its terms.
|
||||||
|
|
||||||
|
## License
|
||||||
|
|
||||||
|
LEDMatrix is licensed under the [GNU General Public License v3.0 or
|
||||||
|
later](LICENSE). By submitting a contribution you agree to license it
|
||||||
|
under the same terms (the standard "inbound = outbound" rule that
|
||||||
|
GitHub applies by default).
|
||||||
|
|
||||||
|
LEDMatrix builds on
|
||||||
|
[`rpi-rgb-led-matrix`](https://github.com/hzeller/rpi-rgb-led-matrix),
|
||||||
|
which is GPL-2.0-or-later. The "or later" clause makes it compatible
|
||||||
|
with GPL-3.0 distribution.
|
||||||
674
LICENSE
Normal file
674
LICENSE
Normal file
@@ -0,0 +1,674 @@
|
|||||||
|
GNU GENERAL PUBLIC LICENSE
|
||||||
|
Version 3, 29 June 2007
|
||||||
|
|
||||||
|
Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
|
||||||
|
Everyone is permitted to copy and distribute verbatim copies
|
||||||
|
of this license document, but changing it is not allowed.
|
||||||
|
|
||||||
|
Preamble
|
||||||
|
|
||||||
|
The GNU General Public License is a free, copyleft license for
|
||||||
|
software and other kinds of works.
|
||||||
|
|
||||||
|
The licenses for most software and other practical works are designed
|
||||||
|
to take away your freedom to share and change the works. By contrast,
|
||||||
|
the GNU General Public License is intended to guarantee your freedom to
|
||||||
|
share and change all versions of a program--to make sure it remains free
|
||||||
|
software for all its users. We, the Free Software Foundation, use the
|
||||||
|
GNU General Public License for most of our software; it applies also to
|
||||||
|
any other work released this way by its authors. You can apply it to
|
||||||
|
your programs, too.
|
||||||
|
|
||||||
|
When we speak of free software, we are referring to freedom, not
|
||||||
|
price. Our General Public Licenses are designed to make sure that you
|
||||||
|
have the freedom to distribute copies of free software (and charge for
|
||||||
|
them if you wish), that you receive source code or can get it if you
|
||||||
|
want it, that you can change the software or use pieces of it in new
|
||||||
|
free programs, and that you know you can do these things.
|
||||||
|
|
||||||
|
To protect your rights, we need to prevent others from denying you
|
||||||
|
these rights or asking you to surrender the rights. Therefore, you have
|
||||||
|
certain responsibilities if you distribute copies of the software, or if
|
||||||
|
you modify it: responsibilities to respect the freedom of others.
|
||||||
|
|
||||||
|
For example, if you distribute copies of such a program, whether
|
||||||
|
gratis or for a fee, you must pass on to the recipients the same
|
||||||
|
freedoms that you received. You must make sure that they, too, receive
|
||||||
|
or can get the source code. And you must show them these terms so they
|
||||||
|
know their rights.
|
||||||
|
|
||||||
|
Developers that use the GNU GPL protect your rights with two steps:
|
||||||
|
(1) assert copyright on the software, and (2) offer you this License
|
||||||
|
giving you legal permission to copy, distribute and/or modify it.
|
||||||
|
|
||||||
|
For the developers' and authors' protection, the GPL clearly explains
|
||||||
|
that there is no warranty for this free software. For both users' and
|
||||||
|
authors' sake, the GPL requires that modified versions be marked as
|
||||||
|
changed, so that their problems will not be attributed erroneously to
|
||||||
|
authors of previous versions.
|
||||||
|
|
||||||
|
Some devices are designed to deny users access to install or run
|
||||||
|
modified versions of the software inside them, although the manufacturer
|
||||||
|
can do so. This is fundamentally incompatible with the aim of
|
||||||
|
protecting users' freedom to change the software. The systematic
|
||||||
|
pattern of such abuse occurs in the area of products for individuals to
|
||||||
|
use, which is precisely where it is most unacceptable. Therefore, we
|
||||||
|
have designed this version of the GPL to prohibit the practice for those
|
||||||
|
products. If such problems arise substantially in other domains, we
|
||||||
|
stand ready to extend this provision to those domains in future versions
|
||||||
|
of the GPL, as needed to protect the freedom of users.
|
||||||
|
|
||||||
|
Finally, every program is threatened constantly by software patents.
|
||||||
|
States should not allow patents to restrict development and use of
|
||||||
|
software on general-purpose computers, but in those that do, we wish to
|
||||||
|
avoid the special danger that patents applied to a free program could
|
||||||
|
make it effectively proprietary. To prevent this, the GPL assures that
|
||||||
|
patents cannot be used to render the program non-free.
|
||||||
|
|
||||||
|
The precise terms and conditions for copying, distribution and
|
||||||
|
modification follow.
|
||||||
|
|
||||||
|
TERMS AND CONDITIONS
|
||||||
|
|
||||||
|
0. Definitions.
|
||||||
|
|
||||||
|
"This License" refers to version 3 of the GNU General Public License.
|
||||||
|
|
||||||
|
"Copyright" also means copyright-like laws that apply to other kinds of
|
||||||
|
works, such as semiconductor masks.
|
||||||
|
|
||||||
|
"The Program" refers to any copyrightable work licensed under this
|
||||||
|
License. Each licensee is addressed as "you". "Licensees" and
|
||||||
|
"recipients" may be individuals or organizations.
|
||||||
|
|
||||||
|
To "modify" a work means to copy from or adapt all or part of the work
|
||||||
|
in a fashion requiring copyright permission, other than the making of an
|
||||||
|
exact copy. The resulting work is called a "modified version" of the
|
||||||
|
earlier work or a work "based on" the earlier work.
|
||||||
|
|
||||||
|
A "covered work" means either the unmodified Program or a work based
|
||||||
|
on the Program.
|
||||||
|
|
||||||
|
To "propagate" a work means to do anything with it that, without
|
||||||
|
permission, would make you directly or secondarily liable for
|
||||||
|
infringement under applicable copyright law, except executing it on a
|
||||||
|
computer or modifying a private copy. Propagation includes copying,
|
||||||
|
distribution (with or without modification), making available to the
|
||||||
|
public, and in some countries other activities as well.
|
||||||
|
|
||||||
|
To "convey" a work means any kind of propagation that enables other
|
||||||
|
parties to make or receive copies. Mere interaction with a user through
|
||||||
|
a computer network, with no transfer of a copy, is not conveying.
|
||||||
|
|
||||||
|
An interactive user interface displays "Appropriate Legal Notices"
|
||||||
|
to the extent that it includes a convenient and prominently visible
|
||||||
|
feature that (1) displays an appropriate copyright notice, and (2)
|
||||||
|
tells the user that there is no warranty for the work (except to the
|
||||||
|
extent that warranties are provided), that licensees may convey the
|
||||||
|
work under this License, and how to view a copy of this License. If
|
||||||
|
the interface presents a list of user commands or options, such as a
|
||||||
|
menu, a prominent item in the list meets this criterion.
|
||||||
|
|
||||||
|
1. Source Code.
|
||||||
|
|
||||||
|
The "source code" for a work means the preferred form of the work
|
||||||
|
for making modifications to it. "Object code" means any non-source
|
||||||
|
form of a work.
|
||||||
|
|
||||||
|
A "Standard Interface" means an interface that either is an official
|
||||||
|
standard defined by a recognized standards body, or, in the case of
|
||||||
|
interfaces specified for a particular programming language, one that
|
||||||
|
is widely used among developers working in that language.
|
||||||
|
|
||||||
|
The "System Libraries" of an executable work include anything, other
|
||||||
|
than the work as a whole, that (a) is included in the normal form of
|
||||||
|
packaging a Major Component, but which is not part of that Major
|
||||||
|
Component, and (b) serves only to enable use of the work with that
|
||||||
|
Major Component, or to implement a Standard Interface for which an
|
||||||
|
implementation is available to the public in source code form. A
|
||||||
|
"Major Component", in this context, means a major essential component
|
||||||
|
(kernel, window system, and so on) of the specific operating system
|
||||||
|
(if any) on which the executable work runs, or a compiler used to
|
||||||
|
produce the work, or an object code interpreter used to run it.
|
||||||
|
|
||||||
|
The "Corresponding Source" for a work in object code form means all
|
||||||
|
the source code needed to generate, install, and (for an executable
|
||||||
|
work) run the object code and to modify the work, including scripts to
|
||||||
|
control those activities. However, it does not include the work's
|
||||||
|
System Libraries, or general-purpose tools or generally available free
|
||||||
|
programs which are used unmodified in performing those activities but
|
||||||
|
which are not part of the work. For example, Corresponding Source
|
||||||
|
includes interface definition files associated with source files for
|
||||||
|
the work, and the source code for shared libraries and dynamically
|
||||||
|
linked subprograms that the work is specifically designed to require,
|
||||||
|
such as by intimate data communication or control flow between those
|
||||||
|
subprograms and other parts of the work.
|
||||||
|
|
||||||
|
The Corresponding Source need not include anything that users
|
||||||
|
can regenerate automatically from other parts of the Corresponding
|
||||||
|
Source.
|
||||||
|
|
||||||
|
The Corresponding Source for a work in source code form is that
|
||||||
|
same work.
|
||||||
|
|
||||||
|
2. Basic Permissions.
|
||||||
|
|
||||||
|
All rights granted under this License are granted for the term of
|
||||||
|
copyright on the Program, and are irrevocable provided the stated
|
||||||
|
conditions are met. This License explicitly affirms your unlimited
|
||||||
|
permission to run the unmodified Program. The output from running a
|
||||||
|
covered work is covered by this License only if the output, given its
|
||||||
|
content, constitutes a covered work. This License acknowledges your
|
||||||
|
rights of fair use or other equivalent, as provided by copyright law.
|
||||||
|
|
||||||
|
You may make, run and propagate covered works that you do not
|
||||||
|
convey, without conditions so long as your license otherwise remains
|
||||||
|
in force. You may convey covered works to others for the sole purpose
|
||||||
|
of having them make modifications exclusively for you, or provide you
|
||||||
|
with facilities for running those works, provided that you comply with
|
||||||
|
the terms of this License in conveying all material for which you do
|
||||||
|
not control copyright. Those thus making or running the covered works
|
||||||
|
for you must do so exclusively on your behalf, under your direction
|
||||||
|
and control, on terms that prohibit them from making any copies of
|
||||||
|
your copyrighted material outside their relationship with you.
|
||||||
|
|
||||||
|
Conveying under any other circumstances is permitted solely under
|
||||||
|
the conditions stated below. Sublicensing is not allowed; section 10
|
||||||
|
makes it unnecessary.
|
||||||
|
|
||||||
|
3. Protecting Users' Legal Rights From Anti-Circumvention Law.
|
||||||
|
|
||||||
|
No covered work shall be deemed part of an effective technological
|
||||||
|
measure under any applicable law fulfilling obligations under article
|
||||||
|
11 of the WIPO copyright treaty adopted on 20 December 1996, or
|
||||||
|
similar laws prohibiting or restricting circumvention of such
|
||||||
|
measures.
|
||||||
|
|
||||||
|
When you convey a covered work, you waive any legal power to forbid
|
||||||
|
circumvention of technological measures to the extent such circumvention
|
||||||
|
is effected by exercising rights under this License with respect to
|
||||||
|
the covered work, and you disclaim any intention to limit operation or
|
||||||
|
modification of the work as a means of enforcing, against the work's
|
||||||
|
users, your or third parties' legal rights to forbid circumvention of
|
||||||
|
technological measures.
|
||||||
|
|
||||||
|
4. Conveying Verbatim Copies.
|
||||||
|
|
||||||
|
You may convey verbatim copies of the Program's source code as you
|
||||||
|
receive it, in any medium, provided that you conspicuously and
|
||||||
|
appropriately publish on each copy an appropriate copyright notice;
|
||||||
|
keep intact all notices stating that this License and any
|
||||||
|
non-permissive terms added in accord with section 7 apply to the code;
|
||||||
|
keep intact all notices of the absence of any warranty; and give all
|
||||||
|
recipients a copy of this License along with the Program.
|
||||||
|
|
||||||
|
You may charge any price or no price for each copy that you convey,
|
||||||
|
and you may offer support or warranty protection for a fee.
|
||||||
|
|
||||||
|
5. Conveying Modified Source Versions.
|
||||||
|
|
||||||
|
You may convey a work based on the Program, or the modifications to
|
||||||
|
produce it from the Program, in the form of source code under the
|
||||||
|
terms of section 4, provided that you also meet all of these conditions:
|
||||||
|
|
||||||
|
a) The work must carry prominent notices stating that you modified
|
||||||
|
it, and giving a relevant date.
|
||||||
|
|
||||||
|
b) The work must carry prominent notices stating that it is
|
||||||
|
released under this License and any conditions added under section
|
||||||
|
7. This requirement modifies the requirement in section 4 to
|
||||||
|
"keep intact all notices".
|
||||||
|
|
||||||
|
c) You must license the entire work, as a whole, under this
|
||||||
|
License to anyone who comes into possession of a copy. This
|
||||||
|
License will therefore apply, along with any applicable section 7
|
||||||
|
additional terms, to the whole of the work, and all its parts,
|
||||||
|
regardless of how they are packaged. This License gives no
|
||||||
|
permission to license the work in any other way, but it does not
|
||||||
|
invalidate such permission if you have separately received it.
|
||||||
|
|
||||||
|
d) If the work has interactive user interfaces, each must display
|
||||||
|
Appropriate Legal Notices; however, if the Program has interactive
|
||||||
|
interfaces that do not display Appropriate Legal Notices, your
|
||||||
|
work need not make them do so.
|
||||||
|
|
||||||
|
A compilation of a covered work with other separate and independent
|
||||||
|
works, which are not by their nature extensions of the covered work,
|
||||||
|
and which are not combined with it such as to form a larger program,
|
||||||
|
in or on a volume of a storage or distribution medium, is called an
|
||||||
|
"aggregate" if the compilation and its resulting copyright are not
|
||||||
|
used to limit the access or legal rights of the compilation's users
|
||||||
|
beyond what the individual works permit. Inclusion of a covered work
|
||||||
|
in an aggregate does not cause this License to apply to the other
|
||||||
|
parts of the aggregate.
|
||||||
|
|
||||||
|
6. Conveying Non-Source Forms.
|
||||||
|
|
||||||
|
You may convey a covered work in object code form under the terms
|
||||||
|
of sections 4 and 5, provided that you also convey the
|
||||||
|
machine-readable Corresponding Source under the terms of this License,
|
||||||
|
in one of these ways:
|
||||||
|
|
||||||
|
a) Convey the object code in, or embodied in, a physical product
|
||||||
|
(including a physical distribution medium), accompanied by the
|
||||||
|
Corresponding Source fixed on a durable physical medium
|
||||||
|
customarily used for software interchange.
|
||||||
|
|
||||||
|
b) Convey the object code in, or embodied in, a physical product
|
||||||
|
(including a physical distribution medium), accompanied by a
|
||||||
|
written offer, valid for at least three years and valid for as
|
||||||
|
long as you offer spare parts or customer support for that product
|
||||||
|
model, to give anyone who possesses the object code either (1) a
|
||||||
|
copy of the Corresponding Source for all the software in the
|
||||||
|
product that is covered by this License, on a durable physical
|
||||||
|
medium customarily used for software interchange, for a price no
|
||||||
|
more than your reasonable cost of physically performing this
|
||||||
|
conveying of source, or (2) access to copy the
|
||||||
|
Corresponding Source from a network server at no charge.
|
||||||
|
|
||||||
|
c) Convey individual copies of the object code with a copy of the
|
||||||
|
written offer to provide the Corresponding Source. This
|
||||||
|
alternative is allowed only occasionally and noncommercially, and
|
||||||
|
only if you received the object code with such an offer, in accord
|
||||||
|
with subsection 6b.
|
||||||
|
|
||||||
|
d) Convey the object code by offering access from a designated
|
||||||
|
place (gratis or for a charge), and offer equivalent access to the
|
||||||
|
Corresponding Source in the same way through the same place at no
|
||||||
|
further charge. You need not require recipients to copy the
|
||||||
|
Corresponding Source along with the object code. If the place to
|
||||||
|
copy the object code is a network server, the Corresponding Source
|
||||||
|
may be on a different server (operated by you or a third party)
|
||||||
|
that supports equivalent copying facilities, provided you maintain
|
||||||
|
clear directions next to the object code saying where to find the
|
||||||
|
Corresponding Source. Regardless of what server hosts the
|
||||||
|
Corresponding Source, you remain obligated to ensure that it is
|
||||||
|
available for as long as needed to satisfy these requirements.
|
||||||
|
|
||||||
|
e) Convey the object code using peer-to-peer transmission, provided
|
||||||
|
you inform other peers where the object code and Corresponding
|
||||||
|
Source of the work are being offered to the general public at no
|
||||||
|
charge under subsection 6d.
|
||||||
|
|
||||||
|
A separable portion of the object code, whose source code is excluded
|
||||||
|
from the Corresponding Source as a System Library, need not be
|
||||||
|
included in conveying the object code work.
|
||||||
|
|
||||||
|
A "User Product" is either (1) a "consumer product", which means any
|
||||||
|
tangible personal property which is normally used for personal, family,
|
||||||
|
or household purposes, or (2) anything designed or sold for incorporation
|
||||||
|
into a dwelling. In determining whether a product is a consumer product,
|
||||||
|
doubtful cases shall be resolved in favor of coverage. For a particular
|
||||||
|
product received by a particular user, "normally used" refers to a
|
||||||
|
typical or common use of that class of product, regardless of the status
|
||||||
|
of the particular user or of the way in which the particular user
|
||||||
|
actually uses, or expects or is expected to use, the product. A product
|
||||||
|
is a consumer product regardless of whether the product has substantial
|
||||||
|
commercial, industrial or non-consumer uses, unless such uses represent
|
||||||
|
the only significant mode of use of the product.
|
||||||
|
|
||||||
|
"Installation Information" for a User Product means any methods,
|
||||||
|
procedures, authorization keys, or other information required to install
|
||||||
|
and execute modified versions of a covered work in that User Product from
|
||||||
|
a modified version of its Corresponding Source. The information must
|
||||||
|
suffice to ensure that the continued functioning of the modified object
|
||||||
|
code is in no case prevented or interfered with solely because
|
||||||
|
modification has been made.
|
||||||
|
|
||||||
|
If you convey an object code work under this section in, or with, or
|
||||||
|
specifically for use in, a User Product, and the conveying occurs as
|
||||||
|
part of a transaction in which the right of possession and use of the
|
||||||
|
User Product is transferred to the recipient in perpetuity or for a
|
||||||
|
fixed term (regardless of how the transaction is characterized), the
|
||||||
|
Corresponding Source conveyed under this section must be accompanied
|
||||||
|
by the Installation Information. But this requirement does not apply
|
||||||
|
if neither you nor any third party retains the ability to install
|
||||||
|
modified object code on the User Product (for example, the work has
|
||||||
|
been installed in ROM).
|
||||||
|
|
||||||
|
The requirement to provide Installation Information does not include a
|
||||||
|
requirement to continue to provide support service, warranty, or updates
|
||||||
|
for a work that has been modified or installed by the recipient, or for
|
||||||
|
the User Product in which it has been modified or installed. Access to a
|
||||||
|
network may be denied when the modification itself materially and
|
||||||
|
adversely affects the operation of the network or violates the rules and
|
||||||
|
protocols for communication across the network.
|
||||||
|
|
||||||
|
Corresponding Source conveyed, and Installation Information provided,
|
||||||
|
in accord with this section must be in a format that is publicly
|
||||||
|
documented (and with an implementation available to the public in
|
||||||
|
source code form), and must require no special password or key for
|
||||||
|
unpacking, reading or copying.
|
||||||
|
|
||||||
|
7. Additional Terms.
|
||||||
|
|
||||||
|
"Additional permissions" are terms that supplement the terms of this
|
||||||
|
License by making exceptions from one or more of its conditions.
|
||||||
|
Additional permissions that are applicable to the entire Program shall
|
||||||
|
be treated as though they were included in this License, to the extent
|
||||||
|
that they are valid under applicable law. If additional permissions
|
||||||
|
apply only to part of the Program, that part may be used separately
|
||||||
|
under those permissions, but the entire Program remains governed by
|
||||||
|
this License without regard to the additional permissions.
|
||||||
|
|
||||||
|
When you convey a copy of a covered work, you may at your option
|
||||||
|
remove any additional permissions from that copy, or from any part of
|
||||||
|
it. (Additional permissions may be written to require their own
|
||||||
|
removal in certain cases when you modify the work.) You may place
|
||||||
|
additional permissions on material, added by you to a covered work,
|
||||||
|
for which you have or can give appropriate copyright permission.
|
||||||
|
|
||||||
|
Notwithstanding any other provision of this License, for material you
|
||||||
|
add to a covered work, you may (if authorized by the copyright holders of
|
||||||
|
that material) supplement the terms of this License with terms:
|
||||||
|
|
||||||
|
a) Disclaiming warranty or limiting liability differently from the
|
||||||
|
terms of sections 15 and 16 of this License; or
|
||||||
|
|
||||||
|
b) Requiring preservation of specified reasonable legal notices or
|
||||||
|
author attributions in that material or in the Appropriate Legal
|
||||||
|
Notices displayed by works containing it; or
|
||||||
|
|
||||||
|
c) Prohibiting misrepresentation of the origin of that material, or
|
||||||
|
requiring that modified versions of such material be marked in
|
||||||
|
reasonable ways as different from the original version; or
|
||||||
|
|
||||||
|
d) Limiting the use for publicity purposes of names of licensors or
|
||||||
|
authors of the material; or
|
||||||
|
|
||||||
|
e) Declining to grant rights under trademark law for use of some
|
||||||
|
trade names, trademarks, or service marks; or
|
||||||
|
|
||||||
|
f) Requiring indemnification of licensors and authors of that
|
||||||
|
material by anyone who conveys the material (or modified versions of
|
||||||
|
it) with contractual assumptions of liability to the recipient, for
|
||||||
|
any liability that these contractual assumptions directly impose on
|
||||||
|
those licensors and authors.
|
||||||
|
|
||||||
|
All other non-permissive additional terms are considered "further
|
||||||
|
restrictions" within the meaning of section 10. If the Program as you
|
||||||
|
received it, or any part of it, contains a notice stating that it is
|
||||||
|
governed by this License along with a term that is a further
|
||||||
|
restriction, you may remove that term. If a license document contains
|
||||||
|
a further restriction but permits relicensing or conveying under this
|
||||||
|
License, you may add to a covered work material governed by the terms
|
||||||
|
of that license document, provided that the further restriction does
|
||||||
|
not survive such relicensing or conveying.
|
||||||
|
|
||||||
|
If you add terms to a covered work in accord with this section, you
|
||||||
|
must place, in the relevant source files, a statement of the
|
||||||
|
additional terms that apply to those files, or a notice indicating
|
||||||
|
where to find the applicable terms.
|
||||||
|
|
||||||
|
Additional terms, permissive or non-permissive, may be stated in the
|
||||||
|
form of a separately written license, or stated as exceptions;
|
||||||
|
the above requirements apply either way.
|
||||||
|
|
||||||
|
8. Termination.
|
||||||
|
|
||||||
|
You may not propagate or modify a covered work except as expressly
|
||||||
|
provided under this License. Any attempt otherwise to propagate or
|
||||||
|
modify it is void, and will automatically terminate your rights under
|
||||||
|
this License (including any patent licenses granted under the third
|
||||||
|
paragraph of section 11).
|
||||||
|
|
||||||
|
However, if you cease all violation of this License, then your
|
||||||
|
license from a particular copyright holder is reinstated (a)
|
||||||
|
provisionally, unless and until the copyright holder explicitly and
|
||||||
|
finally terminates your license, and (b) permanently, if the copyright
|
||||||
|
holder fails to notify you of the violation by some reasonable means
|
||||||
|
prior to 60 days after the cessation.
|
||||||
|
|
||||||
|
Moreover, your license from a particular copyright holder is
|
||||||
|
reinstated permanently if the copyright holder notifies you of the
|
||||||
|
violation by some reasonable means, this is the first time you have
|
||||||
|
received notice of violation of this License (for any work) from that
|
||||||
|
copyright holder, and you cure the violation prior to 30 days after
|
||||||
|
your receipt of the notice.
|
||||||
|
|
||||||
|
Termination of your rights under this section does not terminate the
|
||||||
|
licenses of parties who have received copies or rights from you under
|
||||||
|
this License. If your rights have been terminated and not permanently
|
||||||
|
reinstated, you do not qualify to receive new licenses for the same
|
||||||
|
material under section 10.
|
||||||
|
|
||||||
|
9. Acceptance Not Required for Having Copies.
|
||||||
|
|
||||||
|
You are not required to accept this License in order to receive or
|
||||||
|
run a copy of the Program. Ancillary propagation of a covered work
|
||||||
|
occurring solely as a consequence of using peer-to-peer transmission
|
||||||
|
to receive a copy likewise does not require acceptance. However,
|
||||||
|
nothing other than this License grants you permission to propagate or
|
||||||
|
modify any covered work. These actions infringe copyright if you do
|
||||||
|
not accept this License. Therefore, by modifying or propagating a
|
||||||
|
covered work, you indicate your acceptance of this License to do so.
|
||||||
|
|
||||||
|
10. Automatic Licensing of Downstream Recipients.
|
||||||
|
|
||||||
|
Each time you convey a covered work, the recipient automatically
|
||||||
|
receives a license from the original licensors, to run, modify and
|
||||||
|
propagate that work, subject to this License. You are not responsible
|
||||||
|
for enforcing compliance by third parties with this License.
|
||||||
|
|
||||||
|
An "entity transaction" is a transaction transferring control of an
|
||||||
|
organization, or substantially all assets of one, or subdividing an
|
||||||
|
organization, or merging organizations. If propagation of a covered
|
||||||
|
work results from an entity transaction, each party to that
|
||||||
|
transaction who receives a copy of the work also receives whatever
|
||||||
|
licenses to the work the party's predecessor in interest had or could
|
||||||
|
give under the previous paragraph, plus a right to possession of the
|
||||||
|
Corresponding Source of the work from the predecessor in interest, if
|
||||||
|
the predecessor has it or can get it with reasonable efforts.
|
||||||
|
|
||||||
|
You may not impose any further restrictions on the exercise of the
|
||||||
|
rights granted or affirmed under this License. For example, you may
|
||||||
|
not impose a license fee, royalty, or other charge for exercise of
|
||||||
|
rights granted under this License, and you may not initiate litigation
|
||||||
|
(including a cross-claim or counterclaim in a lawsuit) alleging that
|
||||||
|
any patent claim is infringed by making, using, selling, offering for
|
||||||
|
sale, or importing the Program or any portion of it.
|
||||||
|
|
||||||
|
11. Patents.
|
||||||
|
|
||||||
|
A "contributor" is a copyright holder who authorizes use under this
|
||||||
|
License of the Program or a work on which the Program is based. The
|
||||||
|
work thus licensed is called the contributor's "contributor version".
|
||||||
|
|
||||||
|
A contributor's "essential patent claims" are all patent claims
|
||||||
|
owned or controlled by the contributor, whether already acquired or
|
||||||
|
hereafter acquired, that would be infringed by some manner, permitted
|
||||||
|
by this License, of making, using, or selling its contributor version,
|
||||||
|
but do not include claims that would be infringed only as a
|
||||||
|
consequence of further modification of the contributor version. For
|
||||||
|
purposes of this definition, "control" includes the right to grant
|
||||||
|
patent sublicenses in a manner consistent with the requirements of
|
||||||
|
this License.
|
||||||
|
|
||||||
|
Each contributor grants you a non-exclusive, worldwide, royalty-free
|
||||||
|
patent license under the contributor's essential patent claims, to
|
||||||
|
make, use, sell, offer for sale, import and otherwise run, modify and
|
||||||
|
propagate the contents of its contributor version.
|
||||||
|
|
||||||
|
In the following three paragraphs, a "patent license" is any express
|
||||||
|
agreement or commitment, however denominated, not to enforce a patent
|
||||||
|
(such as an express permission to practice a patent or covenant not to
|
||||||
|
sue for patent infringement). To "grant" such a patent license to a
|
||||||
|
party means to make such an agreement or commitment not to enforce a
|
||||||
|
patent against the party.
|
||||||
|
|
||||||
|
If you convey a covered work, knowingly relying on a patent license,
|
||||||
|
and the Corresponding Source of the work is not available for anyone
|
||||||
|
to copy, free of charge and under the terms of this License, through a
|
||||||
|
publicly available network server or other readily accessible means,
|
||||||
|
then you must either (1) cause the Corresponding Source to be so
|
||||||
|
available, or (2) arrange to deprive yourself of the benefit of the
|
||||||
|
patent license for this particular work, or (3) arrange, in a manner
|
||||||
|
consistent with the requirements of this License, to extend the patent
|
||||||
|
license to downstream recipients. "Knowingly relying" means you have
|
||||||
|
actual knowledge that, but for the patent license, your conveying the
|
||||||
|
covered work in a country, or your recipient's use of the covered work
|
||||||
|
in a country, would infringe one or more identifiable patents in that
|
||||||
|
country that you have reason to believe are valid.
|
||||||
|
|
||||||
|
If, pursuant to or in connection with a single transaction or
|
||||||
|
arrangement, you convey, or propagate by procuring conveyance of, a
|
||||||
|
covered work, and grant a patent license to some of the parties
|
||||||
|
receiving the covered work authorizing them to use, propagate, modify
|
||||||
|
or convey a specific copy of the covered work, then the patent license
|
||||||
|
you grant is automatically extended to all recipients of the covered
|
||||||
|
work and works based on it.
|
||||||
|
|
||||||
|
A patent license is "discriminatory" if it does not include within
|
||||||
|
the scope of its coverage, prohibits the exercise of, or is
|
||||||
|
conditioned on the non-exercise of one or more of the rights that are
|
||||||
|
specifically granted under this License. You may not convey a covered
|
||||||
|
work if you are a party to an arrangement with a third party that is
|
||||||
|
in the business of distributing software, under which you make payment
|
||||||
|
to the third party based on the extent of your activity of conveying
|
||||||
|
the work, and under which the third party grants, to any of the
|
||||||
|
parties who would receive the covered work from you, a discriminatory
|
||||||
|
patent license (a) in connection with copies of the covered work
|
||||||
|
conveyed by you (or copies made from those copies), or (b) primarily
|
||||||
|
for and in connection with specific products or compilations that
|
||||||
|
contain the covered work, unless you entered into that arrangement,
|
||||||
|
or that patent license was granted, prior to 28 March 2007.
|
||||||
|
|
||||||
|
Nothing in this License shall be construed as excluding or limiting
|
||||||
|
any implied license or other defenses to infringement that may
|
||||||
|
otherwise be available to you under applicable patent law.
|
||||||
|
|
||||||
|
12. No Surrender of Others' Freedom.
|
||||||
|
|
||||||
|
If conditions are imposed on you (whether by court order, agreement or
|
||||||
|
otherwise) that contradict the conditions of this License, they do not
|
||||||
|
excuse you from the conditions of this License. If you cannot convey a
|
||||||
|
covered work so as to satisfy simultaneously your obligations under this
|
||||||
|
License and any other pertinent obligations, then as a consequence you may
|
||||||
|
not convey it at all. For example, if you agree to terms that obligate you
|
||||||
|
to collect a royalty for further conveying from those to whom you convey
|
||||||
|
the Program, the only way you could satisfy both those terms and this
|
||||||
|
License would be to refrain entirely from conveying the Program.
|
||||||
|
|
||||||
|
13. Use with the GNU Affero General Public License.
|
||||||
|
|
||||||
|
Notwithstanding any other provision of this License, you have
|
||||||
|
permission to link or combine any covered work with a work licensed
|
||||||
|
under version 3 of the GNU Affero General Public License into a single
|
||||||
|
combined work, and to convey the resulting work. The terms of this
|
||||||
|
License will continue to apply to the part which is the covered work,
|
||||||
|
but the special requirements of the GNU Affero General Public License,
|
||||||
|
section 13, concerning interaction through a network will apply to the
|
||||||
|
combination as such.
|
||||||
|
|
||||||
|
14. Revised Versions of this License.
|
||||||
|
|
||||||
|
The Free Software Foundation may publish revised and/or new versions of
|
||||||
|
the GNU General Public License from time to time. Such new versions will
|
||||||
|
be similar in spirit to the present version, but may differ in detail to
|
||||||
|
address new problems or concerns.
|
||||||
|
|
||||||
|
Each version is given a distinguishing version number. If the
|
||||||
|
Program specifies that a certain numbered version of the GNU General
|
||||||
|
Public License "or any later version" applies to it, you have the
|
||||||
|
option of following the terms and conditions either of that numbered
|
||||||
|
version or of any later version published by the Free Software
|
||||||
|
Foundation. If the Program does not specify a version number of the
|
||||||
|
GNU General Public License, you may choose any version ever published
|
||||||
|
by the Free Software Foundation.
|
||||||
|
|
||||||
|
If the Program specifies that a proxy can decide which future
|
||||||
|
versions of the GNU General Public License can be used, that proxy's
|
||||||
|
public statement of acceptance of a version permanently authorizes you
|
||||||
|
to choose that version for the Program.
|
||||||
|
|
||||||
|
Later license versions may give you additional or different
|
||||||
|
permissions. However, no additional obligations are imposed on any
|
||||||
|
author or copyright holder as a result of your choosing to follow a
|
||||||
|
later version.
|
||||||
|
|
||||||
|
15. Disclaimer of Warranty.
|
||||||
|
|
||||||
|
THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
|
||||||
|
APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
|
||||||
|
HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
|
||||||
|
OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
|
||||||
|
THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
|
||||||
|
PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
|
||||||
|
IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
|
||||||
|
ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
|
||||||
|
|
||||||
|
16. Limitation of Liability.
|
||||||
|
|
||||||
|
IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
|
||||||
|
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
|
||||||
|
THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
|
||||||
|
GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
|
||||||
|
USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
|
||||||
|
DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
|
||||||
|
PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
|
||||||
|
EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
|
||||||
|
SUCH DAMAGES.
|
||||||
|
|
||||||
|
17. Interpretation of Sections 15 and 16.
|
||||||
|
|
||||||
|
If the disclaimer of warranty and limitation of liability provided
|
||||||
|
above cannot be given local legal effect according to their terms,
|
||||||
|
reviewing courts shall apply local law that most closely approximates
|
||||||
|
an absolute waiver of all civil liability in connection with the
|
||||||
|
Program, unless a warranty or assumption of liability accompanies a
|
||||||
|
copy of the Program in return for a fee.
|
||||||
|
|
||||||
|
END OF TERMS AND CONDITIONS
|
||||||
|
|
||||||
|
How to Apply These Terms to Your New Programs
|
||||||
|
|
||||||
|
If you develop a new program, and you want it to be of the greatest
|
||||||
|
possible use to the public, the best way to achieve this is to make it
|
||||||
|
free software which everyone can redistribute and change under these terms.
|
||||||
|
|
||||||
|
To do so, attach the following notices to the program. It is safest
|
||||||
|
to attach them to the start of each source file to most effectively
|
||||||
|
state the exclusion of warranty; and each file should have at least
|
||||||
|
the "copyright" line and a pointer to where the full notice is found.
|
||||||
|
|
||||||
|
<one line to give the program's name and a brief idea of what it does.>
|
||||||
|
Copyright (C) <year> <name of author>
|
||||||
|
|
||||||
|
This program is free software: you can redistribute it and/or modify
|
||||||
|
it under the terms of the GNU General Public License as published by
|
||||||
|
the Free Software Foundation, either version 3 of the License, or
|
||||||
|
(at your option) any later version.
|
||||||
|
|
||||||
|
This program is distributed in the hope that it will be useful,
|
||||||
|
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||||
|
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||||
|
GNU General Public License for more details.
|
||||||
|
|
||||||
|
You should have received a copy of the GNU General Public License
|
||||||
|
along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||||
|
|
||||||
|
Also add information on how to contact you by electronic and paper mail.
|
||||||
|
|
||||||
|
If the program does terminal interaction, make it output a short
|
||||||
|
notice like this when it starts in an interactive mode:
|
||||||
|
|
||||||
|
<program> Copyright (C) <year> <name of author>
|
||||||
|
This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
|
||||||
|
This is free software, and you are welcome to redistribute it
|
||||||
|
under certain conditions; type `show c' for details.
|
||||||
|
|
||||||
|
The hypothetical commands `show w' and `show c' should show the appropriate
|
||||||
|
parts of the General Public License. Of course, your program's commands
|
||||||
|
might be different; for a GUI interface, you would use an "about box".
|
||||||
|
|
||||||
|
You should also get your employer (if you work as a programmer) or school,
|
||||||
|
if any, to sign a "copyright disclaimer" for the program, if necessary.
|
||||||
|
For more information on this, and how to apply and follow the GNU GPL, see
|
||||||
|
<https://www.gnu.org/licenses/>.
|
||||||
|
|
||||||
|
The GNU General Public License does not permit incorporating your program
|
||||||
|
into proprietary programs. If your program is a subroutine library, you
|
||||||
|
may consider it more useful to permit linking proprietary applications with
|
||||||
|
the library. If this is what you want to do, use the GNU Lesser General
|
||||||
|
Public License instead of this License. But first, please read
|
||||||
|
<https://www.gnu.org/licenses/why-not-lgpl.html>.
|
||||||
32
README.md
32
README.md
@@ -782,14 +782,18 @@ The LEDMatrix system includes Web Interface that runs on port 5000 and provides
|
|||||||
|
|
||||||
### Installing the Web Interface Service
|
### Installing the Web Interface Service
|
||||||
|
|
||||||
|
> The first-time installer (`first_time_install.sh`) already installs the
|
||||||
|
> web service. The steps below only apply if you need to (re)install it
|
||||||
|
> manually.
|
||||||
|
|
||||||
1. Make the install script executable:
|
1. Make the install script executable:
|
||||||
```bash
|
```bash
|
||||||
chmod +x install_web_service.sh
|
chmod +x scripts/install/install_web_service.sh
|
||||||
```
|
```
|
||||||
|
|
||||||
2. Run the install script with sudo:
|
2. Run the install script with sudo:
|
||||||
```bash
|
```bash
|
||||||
sudo ./install_web_service.sh
|
sudo ./scripts/install/install_web_service.sh
|
||||||
```
|
```
|
||||||
|
|
||||||
The script will:
|
The script will:
|
||||||
@@ -874,3 +878,27 @@ sudo systemctl enable ledmatrix-web.service
|
|||||||
|
|
||||||
|
|
||||||
### If you've read this far — thanks!
|
### If you've read this far — thanks!
|
||||||
|
|
||||||
|
-----------------------------------------------------------------------------------
|
||||||
|
|
||||||
|
## License
|
||||||
|
|
||||||
|
LEDMatrix is licensed under the
|
||||||
|
[GNU General Public License v3.0 or later](LICENSE).
|
||||||
|
|
||||||
|
LEDMatrix builds on
|
||||||
|
[`rpi-rgb-led-matrix`](https://github.com/hzeller/rpi-rgb-led-matrix),
|
||||||
|
which is GPL-2.0-or-later. The "or later" clause makes it compatible
|
||||||
|
with GPL-3.0 distribution.
|
||||||
|
|
||||||
|
Plugin contributions in
|
||||||
|
[`ledmatrix-plugins`](https://github.com/ChuckBuilds/ledmatrix-plugins)
|
||||||
|
are also GPL-3.0-or-later unless individual plugins specify otherwise.
|
||||||
|
|
||||||
|
## Contributing
|
||||||
|
|
||||||
|
See [CONTRIBUTING.md](CONTRIBUTING.md) for development setup, the PR
|
||||||
|
flow, and how to add a plugin. Bug reports and feature requests go in
|
||||||
|
the [issue tracker](https://github.com/ChuckBuilds/LEDMatrix/issues).
|
||||||
|
Security issues should be reported privately per
|
||||||
|
[SECURITY.md](SECURITY.md).
|
||||||
|
|||||||
86
SECURITY.md
Normal file
86
SECURITY.md
Normal file
@@ -0,0 +1,86 @@
|
|||||||
|
# Security Policy
|
||||||
|
|
||||||
|
## Reporting a vulnerability
|
||||||
|
|
||||||
|
If you've found a security issue in LEDMatrix, **please don't open a
|
||||||
|
public GitHub issue**. Disclose it privately so we can fix it before it's
|
||||||
|
exploited.
|
||||||
|
|
||||||
|
### How to report
|
||||||
|
|
||||||
|
Use one of these channels, in order of preference:
|
||||||
|
|
||||||
|
1. **GitHub Security Advisories** (preferred). On the LEDMatrix repo,
|
||||||
|
go to **Security → Advisories → Report a vulnerability**. This
|
||||||
|
creates a private discussion thread visible only to you and the
|
||||||
|
maintainer.
|
||||||
|
- Direct link: <https://github.com/ChuckBuilds/LEDMatrix/security/advisories/new>
|
||||||
|
2. **Discord DM**. Send a direct message to a moderator on the
|
||||||
|
[LEDMatrix Discord](https://discord.gg/uW36dVAtcT). Don't post in
|
||||||
|
public channels.
|
||||||
|
|
||||||
|
Please include:
|
||||||
|
|
||||||
|
- A description of the issue
|
||||||
|
- The version / commit hash you're testing against
|
||||||
|
- Steps to reproduce, ideally a minimal proof of concept
|
||||||
|
- The impact you can demonstrate
|
||||||
|
- Any suggested mitigation
|
||||||
|
|
||||||
|
### What to expect
|
||||||
|
|
||||||
|
- An acknowledgement within a few days (this is a hobby project, not
|
||||||
|
a 24/7 ops team).
|
||||||
|
- A discussion of the issue's severity and a plan for the fix.
|
||||||
|
- Credit in the release notes when the fix ships, unless you'd
|
||||||
|
prefer to remain anonymous.
|
||||||
|
- For high-severity issues affecting active deployments, we'll
|
||||||
|
coordinate disclosure timing with you.
|
||||||
|
|
||||||
|
## Scope
|
||||||
|
|
||||||
|
In scope for this policy:
|
||||||
|
|
||||||
|
- The LEDMatrix display controller, web interface, and plugin loader
|
||||||
|
in this repository
|
||||||
|
- The official plugins in
|
||||||
|
[`ledmatrix-plugins`](https://github.com/ChuckBuilds/ledmatrix-plugins)
|
||||||
|
- Installation scripts and systemd unit files
|
||||||
|
|
||||||
|
Out of scope (please report upstream):
|
||||||
|
|
||||||
|
- Vulnerabilities in `rpi-rgb-led-matrix` itself —
|
||||||
|
report to <https://github.com/hzeller/rpi-rgb-led-matrix>
|
||||||
|
- Vulnerabilities in Python packages we depend on — report to the
|
||||||
|
upstream package maintainer
|
||||||
|
- Issues in third-party plugins not in `ledmatrix-plugins` — report
|
||||||
|
to that plugin's repository
|
||||||
|
|
||||||
|
## Known security model
|
||||||
|
|
||||||
|
LEDMatrix is designed for trusted local networks. Several limitations
|
||||||
|
are intentional rather than vulnerabilities:
|
||||||
|
|
||||||
|
- **No web UI authentication.** The web interface assumes the network
|
||||||
|
it's running on is trusted. Don't expose port 5000 to the internet.
|
||||||
|
- **Plugins run unsandboxed.** Installed plugins execute in the same
|
||||||
|
Python process as the display loop with full file-system and
|
||||||
|
network access. Review plugin code (especially third-party plugins
|
||||||
|
from arbitrary GitHub URLs) before installing. The Plugin Store
|
||||||
|
marks community plugins as **Custom** to highlight this.
|
||||||
|
- **The display service runs as root** for hardware GPIO access. This
|
||||||
|
is required by `rpi-rgb-led-matrix`.
|
||||||
|
- **`config_secrets.json` is plaintext.** API keys and tokens are
|
||||||
|
stored unencrypted on the Pi. Lock down filesystem permissions on
|
||||||
|
the config directory if this matters for your deployment.
|
||||||
|
|
||||||
|
These are documented as known limitations rather than bugs. If you
|
||||||
|
have ideas for improving them while keeping the project usable on a
|
||||||
|
Pi, open a discussion — we're interested.
|
||||||
|
|
||||||
|
## Supported versions
|
||||||
|
|
||||||
|
LEDMatrix is rolling-release on `main`. Security fixes land on `main`
|
||||||
|
and become available the next time users run **Update Code** from the
|
||||||
|
web UI's Overview tab (which does a `git pull`). There are no LTS
|
||||||
|
branches.
|
||||||
@@ -437,26 +437,26 @@ When on-demand expires or is cleared, the display returns to the next highest pr
|
|||||||
|
|
||||||
### Web Interface Controls
|
### Web Interface Controls
|
||||||
|
|
||||||
**Access:** Navigate to Settings → Plugin Management
|
Each installed plugin has its own tab in the second nav row of the web
|
||||||
|
UI. Inside the plugin's tab, scroll to **On-Demand Controls**:
|
||||||
|
|
||||||
**Controls:**
|
- **Run On-Demand** — triggers the plugin immediately, even if it's
|
||||||
- **Show Now Button** - Triggers plugin immediately
|
disabled in the rotation
|
||||||
- **Duration Slider** - Set display time (0 = indefinite)
|
- **Stop On-Demand** — clears on-demand and returns to the normal
|
||||||
- **Pin Checkbox** - Keep showing until manually cleared
|
rotation
|
||||||
- **Stop Button** - Clear on-demand and return to rotation
|
|
||||||
- **Shift+Click Stop** - Stop the entire display service
|
|
||||||
|
|
||||||
**Status Card:**
|
The display service must be running. The status banner at the top of
|
||||||
- Real-time status updates
|
the plugin tab shows the active on-demand plugin, mode, and remaining
|
||||||
- Shows active plugin and remaining time
|
time when something is active.
|
||||||
- Pin status indicator
|
|
||||||
|
|
||||||
### REST API Reference
|
### REST API Reference
|
||||||
|
|
||||||
|
The API is mounted at `/api/v3` (`web_interface/app.py:144`).
|
||||||
|
|
||||||
#### Start On-Demand Display
|
#### Start On-Demand Display
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
POST /api/display/on-demand/start
|
POST /api/v3/display/on-demand/start
|
||||||
|
|
||||||
# Body:
|
# Body:
|
||||||
{
|
{
|
||||||
@@ -467,20 +467,20 @@ POST /api/display/on-demand/start
|
|||||||
|
|
||||||
# Examples:
|
# Examples:
|
||||||
# 30-second preview
|
# 30-second preview
|
||||||
curl -X POST http://localhost:5050/api/display/on-demand/start \
|
curl -X POST http://localhost:5000/api/v3/display/on-demand/start \
|
||||||
-H "Content-Type: application/json" \
|
-H "Content-Type: application/json" \
|
||||||
-d '{"plugin_id": "weather", "duration": 30}'
|
-d '{"plugin_id": "weather", "duration": 30}'
|
||||||
|
|
||||||
# Pin indefinitely
|
# Pin indefinitely
|
||||||
curl -X POST http://localhost:5050/api/display/on-demand/start \
|
curl -X POST http://localhost:5000/api/v3/display/on-demand/start \
|
||||||
-H "Content-Type: application/json" \
|
-H "Content-Type: application/json" \
|
||||||
-d '{"plugin_id": "hockey-scores", "pinned": true}'
|
-d '{"plugin_id": "hockey-scoreboard", "pinned": true}'
|
||||||
```
|
```
|
||||||
|
|
||||||
#### Stop On-Demand Display
|
#### Stop On-Demand Display
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
POST /api/display/on-demand/stop
|
POST /api/v3/display/on-demand/stop
|
||||||
|
|
||||||
# Body:
|
# Body:
|
||||||
{
|
{
|
||||||
@@ -489,10 +489,10 @@ POST /api/display/on-demand/stop
|
|||||||
|
|
||||||
# Examples:
|
# Examples:
|
||||||
# Clear on-demand
|
# Clear on-demand
|
||||||
curl -X POST http://localhost:5050/api/display/on-demand/stop
|
curl -X POST http://localhost:5000/api/v3/display/on-demand/stop
|
||||||
|
|
||||||
# Stop service too
|
# Stop service too
|
||||||
curl -X POST http://localhost:5050/api/display/on-demand/stop \
|
curl -X POST http://localhost:5000/api/v3/display/on-demand/stop \
|
||||||
-H "Content-Type: application/json" \
|
-H "Content-Type: application/json" \
|
||||||
-d '{"stop_service": true}'
|
-d '{"stop_service": true}'
|
||||||
```
|
```
|
||||||
@@ -500,10 +500,10 @@ curl -X POST http://localhost:5050/api/display/on-demand/stop \
|
|||||||
#### Get On-Demand Status
|
#### Get On-Demand Status
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
GET /api/display/on-demand/status
|
GET /api/v3/display/on-demand/status
|
||||||
|
|
||||||
# Example:
|
# Example:
|
||||||
curl http://localhost:5050/api/display/on-demand/status
|
curl http://localhost:5000/api/v3/display/on-demand/status
|
||||||
|
|
||||||
# Response:
|
# Response:
|
||||||
{
|
{
|
||||||
@@ -516,35 +516,15 @@ curl http://localhost:5050/api/display/on-demand/status
|
|||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
### Python API Methods
|
> There is no public Python on-demand API. The display controller's
|
||||||
|
> on-demand machinery is internal — drive it through the REST endpoints
|
||||||
```python
|
> above (or the web UI buttons), which write a request into the cache
|
||||||
from src.display_controller import DisplayController
|
> manager under the `display_on_demand_request` key
|
||||||
|
> (`web_interface/blueprints/api_v3.py:1622,1687`) that the controller
|
||||||
controller = DisplayController()
|
> polls at `src/display_controller.py:921`. A separate
|
||||||
|
> `display_on_demand_config` key is used by the controller itself
|
||||||
# Show plugin for 30 seconds
|
> during activation to track what's currently running (written at
|
||||||
controller.show_on_demand('weather', duration=30)
|
> `display_controller.py:1195`, cleared at `:1221`).
|
||||||
|
|
||||||
# Pin plugin until manually cleared
|
|
||||||
controller.show_on_demand('hockey-scores', pinned=True)
|
|
||||||
|
|
||||||
# Show indefinitely (not pinned, clears on expiry if duration set later)
|
|
||||||
controller.show_on_demand('weather', duration=0)
|
|
||||||
|
|
||||||
# Use plugin's default duration
|
|
||||||
controller.show_on_demand('weather')
|
|
||||||
|
|
||||||
# Clear on-demand
|
|
||||||
controller.clear_on_demand()
|
|
||||||
|
|
||||||
# Check status
|
|
||||||
is_active = controller.is_on_demand_active()
|
|
||||||
|
|
||||||
# Get detailed info
|
|
||||||
info = controller.get_on_demand_info()
|
|
||||||
# Returns: {'active': bool, 'mode': str, 'duration': float, 'remaining': float, 'pinned': bool}
|
|
||||||
```
|
|
||||||
|
|
||||||
### Duration Modes
|
### Duration Modes
|
||||||
|
|
||||||
@@ -557,27 +537,31 @@ info = controller.get_on_demand_info()
|
|||||||
|
|
||||||
### Use Case Examples
|
### Use Case Examples
|
||||||
|
|
||||||
**Quick Check (30-second preview):**
|
**Quick check (30-second preview):**
|
||||||
```python
|
```bash
|
||||||
controller.show_on_demand('weather', duration=30)
|
curl -X POST http://localhost:5000/api/v3/display/on-demand/start \
|
||||||
|
-H "Content-Type: application/json" \
|
||||||
|
-d '{"plugin_id": "ledmatrix-weather", "duration": 30}'
|
||||||
```
|
```
|
||||||
|
|
||||||
**Pin Important Information:**
|
**Pin important information:**
|
||||||
```python
|
```bash
|
||||||
controller.show_on_demand('game-score', pinned=True)
|
curl -X POST http://localhost:5000/api/v3/display/on-demand/start \
|
||||||
|
-H "Content-Type: application/json" \
|
||||||
|
-d '{"plugin_id": "hockey-scoreboard", "pinned": true}'
|
||||||
# ... later ...
|
# ... later ...
|
||||||
controller.clear_on_demand()
|
curl -X POST http://localhost:5000/api/v3/display/on-demand/stop
|
||||||
```
|
```
|
||||||
|
|
||||||
**Indefinite Display:**
|
**Indefinite display:**
|
||||||
```python
|
```bash
|
||||||
controller.show_on_demand('welcome-message', duration=0)
|
curl -X POST http://localhost:5000/api/v3/display/on-demand/start \
|
||||||
|
-H "Content-Type: application/json" \
|
||||||
|
-d '{"plugin_id": "text-display", "duration": 0}'
|
||||||
```
|
```
|
||||||
|
|
||||||
**Testing Plugin:**
|
**Testing a plugin during development:** the same call works, or just
|
||||||
```python
|
click **Run On-Demand** in the plugin's tab.
|
||||||
controller.show_on_demand('my-new-plugin', duration=60)
|
|
||||||
```
|
|
||||||
|
|
||||||
### Best Practices
|
### Best Practices
|
||||||
|
|
||||||
@@ -613,7 +597,10 @@ controller.show_on_demand('my-new-plugin', duration=60)
|
|||||||
|
|
||||||
### Overview
|
### Overview
|
||||||
|
|
||||||
On-demand display uses Redis cache keys to manage state across service restarts and coordinate between web interface and display controller. Understanding these keys helps troubleshoot stuck states.
|
On-demand display uses cache keys (managed by `src/cache_manager.py` —
|
||||||
|
file-based, not Redis) to coordinate state between the web interface
|
||||||
|
and the display controller across service restarts. Understanding these
|
||||||
|
keys helps troubleshoot stuck states.
|
||||||
|
|
||||||
### Cache Keys
|
### Cache Keys
|
||||||
|
|
||||||
@@ -688,19 +675,26 @@ On-demand display uses Redis cache keys to manage state across service restarts
|
|||||||
### Manual Recovery Procedures
|
### Manual Recovery Procedures
|
||||||
|
|
||||||
**Via Web Interface (Recommended):**
|
**Via Web Interface (Recommended):**
|
||||||
1. Navigate to Settings → Cache Management
|
1. Open the **Cache** tab in the web UI
|
||||||
2. Search for "on_demand" keys
|
2. Find the `display_on_demand_*` entries
|
||||||
3. Select keys to delete
|
3. Delete them
|
||||||
4. Click "Delete Selected"
|
4. Restart display: `sudo systemctl restart ledmatrix`
|
||||||
5. Restart display: `sudo systemctl restart ledmatrix`
|
|
||||||
|
|
||||||
**Via Command Line:**
|
**Via Command Line:**
|
||||||
```bash
|
|
||||||
# Clear specific key
|
|
||||||
redis-cli DEL display_on_demand_config
|
|
||||||
|
|
||||||
# Clear all on-demand keys
|
The cache is stored as JSON files under one of:
|
||||||
redis-cli KEYS "display_on_demand_*" | xargs redis-cli DEL
|
|
||||||
|
- `/var/cache/ledmatrix/` (preferred when the service has permission)
|
||||||
|
- `~/.cache/ledmatrix/`
|
||||||
|
- `/opt/ledmatrix/cache/`
|
||||||
|
- `/tmp/ledmatrix-cache/` (fallback)
|
||||||
|
|
||||||
|
```bash
|
||||||
|
# Find the cache dir actually in use
|
||||||
|
journalctl -u ledmatrix | grep -i "cache directory" | tail -1
|
||||||
|
|
||||||
|
# Clear all on-demand keys (replace path with the one above)
|
||||||
|
rm /var/cache/ledmatrix/display_on_demand_*
|
||||||
|
|
||||||
# Restart service
|
# Restart service
|
||||||
sudo systemctl restart ledmatrix
|
sudo systemctl restart ledmatrix
|
||||||
@@ -711,19 +705,22 @@ sudo systemctl restart ledmatrix
|
|||||||
from src.cache_manager import CacheManager
|
from src.cache_manager import CacheManager
|
||||||
|
|
||||||
cache = CacheManager()
|
cache = CacheManager()
|
||||||
cache.delete('display_on_demand_config')
|
cache.clear_cache('display_on_demand_config')
|
||||||
cache.delete('display_on_demand_state')
|
cache.clear_cache('display_on_demand_state')
|
||||||
cache.delete('display_on_demand_request')
|
cache.clear_cache('display_on_demand_request')
|
||||||
cache.delete('display_on_demand_processed_id')
|
cache.clear_cache('display_on_demand_processed_id')
|
||||||
```
|
```
|
||||||
|
|
||||||
|
> The actual public method is `clear_cache(key=None)` — there is no
|
||||||
|
> `delete()` method on `CacheManager`.
|
||||||
|
|
||||||
### Cache Impact on Running Service
|
### Cache Impact on Running Service
|
||||||
|
|
||||||
**IMPORTANT:** Clearing cache keys does NOT immediately affect the running controller in memory.
|
**IMPORTANT:** Clearing cache keys does NOT immediately affect the running controller in memory.
|
||||||
|
|
||||||
**To fully reset:**
|
**To fully reset:**
|
||||||
1. Stop the service: `sudo systemctl stop ledmatrix`
|
1. Stop the service: `sudo systemctl stop ledmatrix`
|
||||||
2. Clear cache keys (web UI or redis-cli)
|
2. Clear cache keys (web UI Cache tab or `rm` from the cache directory)
|
||||||
3. Clear systemd environment: `sudo systemctl daemon-reload`
|
3. Clear systemd environment: `sudo systemctl daemon-reload`
|
||||||
4. Start the service: `sudo systemctl start ledmatrix`
|
4. Start the service: `sudo systemctl start ledmatrix`
|
||||||
|
|
||||||
@@ -767,7 +764,7 @@ Enable background service per plugin in `config/config.json`:
|
|||||||
|
|
||||||
```json
|
```json
|
||||||
{
|
{
|
||||||
"nfl_scoreboard": {
|
"football-scoreboard": {
|
||||||
"enabled": true,
|
"enabled": true,
|
||||||
"background_service": {
|
"background_service": {
|
||||||
"enabled": true,
|
"enabled": true,
|
||||||
@@ -801,19 +798,13 @@ Enable background service per plugin in `config/config.json`:
|
|||||||
- Returns immediately: < 0.1 seconds
|
- Returns immediately: < 0.1 seconds
|
||||||
- Background refresh (if stale): async, no blocking
|
- Background refresh (if stale): async, no blocking
|
||||||
|
|
||||||
### Implementation Status
|
### Plugins using the background service
|
||||||
|
|
||||||
**Phase 1 (Complete):**
|
The background data service is used by all of the sports scoreboard
|
||||||
- ✅ NFL scoreboard implemented
|
plugins (football, hockey, baseball/MLB, basketball, soccer, lacrosse,
|
||||||
- ✅ Background threading architecture
|
F1, UFC), the odds ticker, and the leaderboard plugin. Each plugin's
|
||||||
- ✅ Cache integration
|
`background_service` block (under its own config namespace) follows the
|
||||||
- ✅ Error handling and retry logic
|
same shape as the example above.
|
||||||
|
|
||||||
**Phase 2 (Planned):**
|
|
||||||
- ⏳ NCAAFB (college football)
|
|
||||||
- ⏳ NBA (basketball)
|
|
||||||
- ⏳ NHL (hockey)
|
|
||||||
- ⏳ MLB (baseball)
|
|
||||||
|
|
||||||
### Error Handling & Fallback
|
### Error Handling & Fallback
|
||||||
|
|
||||||
|
|||||||
@@ -250,19 +250,29 @@ WARNING - Plugin ID 'Football-Scoreboard' may conflict with 'football-scoreboard
|
|||||||
|
|
||||||
## Checking Configuration via API
|
## Checking Configuration via API
|
||||||
|
|
||||||
|
The API blueprint mounts at `/api/v3` (`web_interface/app.py:144`).
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
# Get current config
|
# Get full main config (includes all plugin sections)
|
||||||
curl http://localhost:5000/api/v3/config
|
curl http://localhost:5000/api/v3/config/main
|
||||||
|
|
||||||
# Get specific plugin config
|
# Save updated main config
|
||||||
curl http://localhost:5000/api/v3/config/plugin/football-scoreboard
|
curl -X POST http://localhost:5000/api/v3/config/main \
|
||||||
|
|
||||||
# Validate config without saving
|
|
||||||
curl -X POST http://localhost:5000/api/v3/config/validate \
|
|
||||||
-H "Content-Type: application/json" \
|
-H "Content-Type: application/json" \
|
||||||
-d '{"football-scoreboard": {"enabled": true}}'
|
-d @new-config.json
|
||||||
|
|
||||||
|
# Get config schema for a specific plugin
|
||||||
|
curl "http://localhost:5000/api/v3/plugins/schema?plugin_id=football-scoreboard"
|
||||||
|
|
||||||
|
# Get a single plugin's current config
|
||||||
|
curl "http://localhost:5000/api/v3/plugins/config?plugin_id=football-scoreboard"
|
||||||
```
|
```
|
||||||
|
|
||||||
|
> There is no dedicated `/config/plugin/<id>` or `/config/validate`
|
||||||
|
> endpoint — config validation runs server-side automatically when you
|
||||||
|
> POST to `/config/main` or `/plugins/config`. See
|
||||||
|
> [REST_API_REFERENCE.md](REST_API_REFERENCE.md) for the full list.
|
||||||
|
|
||||||
## Backup and Recovery
|
## Backup and Recovery
|
||||||
|
|
||||||
### Manual Backup
|
### Manual Backup
|
||||||
|
|||||||
@@ -62,7 +62,7 @@ display_manager.defer_update(lambda: self.update_cache(), priority=0)
|
|||||||
# Basic caching
|
# Basic caching
|
||||||
cached = cache_manager.get("key", max_age=3600)
|
cached = cache_manager.get("key", max_age=3600)
|
||||||
cache_manager.set("key", data)
|
cache_manager.set("key", data)
|
||||||
cache_manager.delete("key")
|
cache_manager.clear_cache("key") # there is no delete() method
|
||||||
|
|
||||||
# Advanced caching
|
# Advanced caching
|
||||||
data = cache_manager.get_cached_data_with_strategy("key", data_type="weather")
|
data = cache_manager.get_cached_data_with_strategy("key", data_type="weather")
|
||||||
|
|||||||
@@ -141,19 +141,27 @@ stage('Checkout') {
|
|||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
## Plugin Submodules
|
## Plugins
|
||||||
|
|
||||||
Plugin submodules are located in the `plugins/` directory and are managed similarly:
|
Plugins are **not** git submodules of this repository. The plugins
|
||||||
|
directory (configured by `plugin_system.plugins_directory` in
|
||||||
|
`config/config.json`, default `plugin-repos/`) is populated at install
|
||||||
|
time by the plugin loader as users install plugins from the Plugin Store
|
||||||
|
or from a GitHub URL via the web interface. Plugin source lives in a
|
||||||
|
separate repository:
|
||||||
|
[ChuckBuilds/ledmatrix-plugins](https://github.com/ChuckBuilds/ledmatrix-plugins).
|
||||||
|
|
||||||
**Initialize all plugin submodules:**
|
To work on a plugin locally without going through the Plugin Store, clone
|
||||||
```bash
|
that repo and symlink (or copy) the plugin directory into your configured
|
||||||
git submodule update --init --recursive plugins/
|
plugins directory — by default `plugin-repos/<plugin-id>/`. The plugin
|
||||||
```
|
loader will pick it up on the next display restart. The directory name
|
||||||
|
must match the plugin's `id` in `manifest.json`.
|
||||||
|
|
||||||
**Initialize a specific plugin:**
|
For more information, see:
|
||||||
```bash
|
|
||||||
git submodule update --init --recursive plugins/hockey-scoreboard
|
|
||||||
```
|
|
||||||
|
|
||||||
For more information about plugins, see the [Plugin Development Guide](.cursor/plugins_guide.md) and [Plugin Architecture Specification](docs/PLUGIN_ARCHITECTURE_SPEC.md).
|
|
||||||
|
|
||||||
|
- [PLUGIN_DEVELOPMENT_GUIDE.md](PLUGIN_DEVELOPMENT_GUIDE.md) — end-to-end
|
||||||
|
plugin development workflow
|
||||||
|
- [PLUGIN_ARCHITECTURE_SPEC.md](PLUGIN_ARCHITECTURE_SPEC.md) — plugin system
|
||||||
|
specification
|
||||||
|
- [DEV_PREVIEW.md](DEV_PREVIEW.md) — preview plugins on a desktop without a
|
||||||
|
Pi
|
||||||
|
|||||||
@@ -32,10 +32,15 @@ The LEDMatrix emulator allows you to run and test LEDMatrix displays on your com
|
|||||||
### 1. Clone the Repository
|
### 1. Clone the Repository
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
git clone https://github.com/your-username/LEDMatrix.git
|
git clone --recurse-submodules https://github.com/ChuckBuilds/LEDMatrix.git
|
||||||
cd LEDMatrix
|
cd LEDMatrix
|
||||||
```
|
```
|
||||||
|
|
||||||
|
> The emulator does **not** require building the
|
||||||
|
> `rpi-rgb-led-matrix-master` submodule (it uses `RGBMatrixEmulator`
|
||||||
|
> instead), so `--recurse-submodules` is optional here. Run it anyway if
|
||||||
|
> you also want to test the real-hardware code path.
|
||||||
|
|
||||||
### 2. Install Emulator Dependencies
|
### 2. Install Emulator Dependencies
|
||||||
|
|
||||||
Install the emulator-specific requirements:
|
Install the emulator-specific requirements:
|
||||||
@@ -58,12 +63,13 @@ pip install -r requirements.txt
|
|||||||
|
|
||||||
### 1. Emulator Configuration File
|
### 1. Emulator Configuration File
|
||||||
|
|
||||||
The emulator uses `emulator_config.json` for configuration. Here's the default configuration:
|
The emulator uses `emulator_config.json` for configuration. Here's the
|
||||||
|
default configuration as it ships in the repo:
|
||||||
|
|
||||||
```json
|
```json
|
||||||
{
|
{
|
||||||
"pixel_outline": 0,
|
"pixel_outline": 0,
|
||||||
"pixel_size": 16,
|
"pixel_size": 5,
|
||||||
"pixel_style": "square",
|
"pixel_style": "square",
|
||||||
"pixel_glow": 6,
|
"pixel_glow": 6,
|
||||||
"display_adapter": "pygame",
|
"display_adapter": "pygame",
|
||||||
@@ -90,7 +96,7 @@ The emulator uses `emulator_config.json` for configuration. Here's the default c
|
|||||||
| Option | Description | Default | Values |
|
| Option | Description | Default | Values |
|
||||||
|--------|-------------|---------|--------|
|
|--------|-------------|---------|--------|
|
||||||
| `pixel_outline` | Pixel border thickness | 0 | 0-5 |
|
| `pixel_outline` | Pixel border thickness | 0 | 0-5 |
|
||||||
| `pixel_size` | Size of each pixel | 16 | 8-64 |
|
| `pixel_size` | Size of each pixel | 5 | 1-64 (8–16 is typical for testing) |
|
||||||
| `pixel_style` | Pixel shape | "square" | "square", "circle" |
|
| `pixel_style` | Pixel shape | "square" | "square", "circle" |
|
||||||
| `pixel_glow` | Glow effect intensity | 6 | 0-20 |
|
| `pixel_glow` | Glow effect intensity | 6 | 0-20 |
|
||||||
| `display_adapter` | Display backend | "pygame" | "pygame", "browser" |
|
| `display_adapter` | Display backend | "pygame" | "pygame", "browser" |
|
||||||
|
|||||||
@@ -138,7 +138,29 @@ font = self.font_manager.resolve_font(
|
|||||||
|
|
||||||
## For Plugin Developers
|
## For Plugin Developers
|
||||||
|
|
||||||
### Plugin Font Registration
|
> ⚠️ **Status**: the plugin-font registration described below is
|
||||||
|
> implemented in `src/font_manager.py:150` (`register_plugin_fonts()`)
|
||||||
|
> but is **not currently wired into the plugin loader**. Adding a
|
||||||
|
> `"fonts"` block to your plugin's `manifest.json` will silently have
|
||||||
|
> no effect — the FontManager method exists but nothing calls it.
|
||||||
|
>
|
||||||
|
> Until that's connected, plugin authors who need a custom font
|
||||||
|
> should load it directly with PIL (or `freetype-py` for BDF) in
|
||||||
|
> their plugin's `manager.py` — `FontManager.resolve_font(family=…,
|
||||||
|
> size_px=…)` takes a **family name**, not a file path, so it can't
|
||||||
|
> be used to pull a font from your plugin directory. The
|
||||||
|
> `plugin://…` source URIs described below are only honored by
|
||||||
|
> `register_plugin_fonts()` itself, which isn't wired up.
|
||||||
|
>
|
||||||
|
> The `/api/v3/fonts/overrides` endpoints and the **Fonts** tab in
|
||||||
|
> the web UI are currently **placeholder implementations** — they
|
||||||
|
> return empty arrays and contain "would integrate with the actual
|
||||||
|
> font system" comments. Manually registered manager fonts do
|
||||||
|
> **not** yet flow into that tab. If you need an override today,
|
||||||
|
> load the font directly in your plugin and skip the
|
||||||
|
> override system.
|
||||||
|
|
||||||
|
### Plugin Font Registration (planned)
|
||||||
|
|
||||||
In your plugin's `manifest.json`:
|
In your plugin's `manifest.json`:
|
||||||
|
|
||||||
@@ -359,5 +381,8 @@ self.font = self.font_manager.resolve_font(
|
|||||||
|
|
||||||
## Example: Complete Manager Implementation
|
## Example: Complete Manager Implementation
|
||||||
|
|
||||||
See `test/font_manager_example.py` for a complete working example.
|
For a working example of the font manager API in use, see
|
||||||
|
`src/font_manager.py` itself and the bundled scoreboard base classes
|
||||||
|
in `src/base_classes/` (e.g., `hockey.py`, `football.py`) which
|
||||||
|
register and resolve fonts via the patterns documented above.
|
||||||
|
|
||||||
|
|||||||
@@ -39,7 +39,7 @@ This guide will help you set up your LEDMatrix display for the first time and ge
|
|||||||
|
|
||||||
**If you see "LEDMatrix-Setup" WiFi network:**
|
**If you see "LEDMatrix-Setup" WiFi network:**
|
||||||
1. Connect your device to "LEDMatrix-Setup" (open network, no password)
|
1. Connect your device to "LEDMatrix-Setup" (open network, no password)
|
||||||
2. Open browser to: `http://192.168.4.1:5050`
|
2. Open browser to: `http://192.168.4.1:5000`
|
||||||
3. Navigate to the WiFi tab
|
3. Navigate to the WiFi tab
|
||||||
4. Click "Scan" to find your WiFi network
|
4. Click "Scan" to find your WiFi network
|
||||||
5. Select your network, enter password
|
5. Select your network, enter password
|
||||||
@@ -48,14 +48,14 @@ This guide will help you set up your LEDMatrix display for the first time and ge
|
|||||||
|
|
||||||
**If already connected to WiFi:**
|
**If already connected to WiFi:**
|
||||||
1. Find your Pi's IP address (check your router, or run `hostname -I` on the Pi)
|
1. Find your Pi's IP address (check your router, or run `hostname -I` on the Pi)
|
||||||
2. Open browser to: `http://your-pi-ip:5050`
|
2. Open browser to: `http://your-pi-ip:5000`
|
||||||
|
|
||||||
### 3. Access the Web Interface
|
### 3. Access the Web Interface
|
||||||
|
|
||||||
Once connected, access the web interface:
|
Once connected, access the web interface:
|
||||||
|
|
||||||
```
|
```
|
||||||
http://your-pi-ip:5050
|
http://your-pi-ip:5000
|
||||||
```
|
```
|
||||||
|
|
||||||
You should see:
|
You should see:
|
||||||
@@ -69,84 +69,84 @@ You should see:
|
|||||||
|
|
||||||
### Step 1: Configure Display Hardware
|
### Step 1: Configure Display Hardware
|
||||||
|
|
||||||
1. Navigate to Settings → **Display Settings**
|
1. Open the **Display** tab
|
||||||
2. Set your matrix configuration:
|
2. Set your matrix configuration:
|
||||||
- **Rows**: 32 or 64 (match your hardware)
|
- **Rows**: 32 or 64 (match your hardware)
|
||||||
- **Columns**: 64, 128, or 256 (match your hardware)
|
- **Columns**: commonly 64 or 96; the web UI accepts any integer
|
||||||
- **Chain Length**: Number of panels chained together
|
in the 16–128 range, but 64 and 96 are the values the bundled
|
||||||
- **Brightness**: 50-75% recommended for indoor use
|
panel hardware ships with
|
||||||
3. Click **Save Configuration**
|
- **Chain Length**: Number of panels chained horizontally
|
||||||
4. Click **Restart Display** to apply changes
|
- **Hardware Mapping**: usually `adafruit-hat-pwm` (with the PWM jumper
|
||||||
|
mod) or `adafruit-hat` (without). See the root README for the full list.
|
||||||
|
- **Brightness**: 70–90 is fine for indoor use
|
||||||
|
3. Click **Save**
|
||||||
|
4. From the **Overview** tab, click **Restart Display Service** to apply
|
||||||
|
|
||||||
**Tip:** If the display doesn't look right, try different hardware mapping options.
|
**Tip:** if the display shows garbage or nothing, the most common culprits
|
||||||
|
are an incorrect `hardware_mapping`, a `gpio_slowdown` value that doesn't
|
||||||
|
match your Pi model, or panels needing the E-line mod. See
|
||||||
|
[TROUBLESHOOTING.md](TROUBLESHOOTING.md).
|
||||||
|
|
||||||
### Step 2: Set Timezone and Location
|
### Step 2: Set Timezone and Location
|
||||||
|
|
||||||
1. Navigate to Settings → **General Settings**
|
1. Open the **General** tab
|
||||||
2. Set your timezone (e.g., "America/New_York")
|
2. Set your timezone (e.g., `America/New_York`) and location
|
||||||
3. Set your location (city, state, country)
|
3. Click **Save**
|
||||||
4. Click **Save Configuration**
|
|
||||||
|
|
||||||
**Why it matters:** Correct timezone ensures accurate time display. Location enables weather and location-based features.
|
Correct timezone ensures accurate time display, and location is used by
|
||||||
|
weather and other location-aware plugins.
|
||||||
|
|
||||||
### Step 3: Install Plugins
|
### Step 3: Install Plugins
|
||||||
|
|
||||||
1. Navigate to **Plugin Store** tab
|
1. Open the **Plugin Manager** tab
|
||||||
2. Browse available plugins:
|
2. Scroll to the **Plugin Store** section to browse available plugins
|
||||||
- **Time & Date**: Clock, calendar
|
3. Click **Install** on the plugins you want
|
||||||
- **Weather**: Weather forecasts
|
4. Wait for installation to finish — installed plugins appear in the
|
||||||
- **Sports**: NHL, NBA, NFL, MLB scores
|
**Installed Plugins** section above and get their own tab in the second
|
||||||
- **Finance**: Stocks, crypto
|
nav row
|
||||||
- **Custom**: Community plugins
|
5. Toggle the plugin to enabled
|
||||||
3. Click **Install** on desired plugins
|
6. From **Overview**, click **Restart Display Service**
|
||||||
4. Wait for installation to complete
|
|
||||||
5. Navigate to **Plugin Management** tab
|
|
||||||
6. Enable installed plugins (toggle switch)
|
|
||||||
7. Click **Restart Display**
|
|
||||||
|
|
||||||
**Popular First Plugins:**
|
You can also install community plugins straight from a GitHub URL using the
|
||||||
- `clock-simple` - Simple digital clock
|
**Install from GitHub** section further down the same tab — see
|
||||||
- `weather` - Weather forecast
|
[PLUGIN_STORE_GUIDE.md](PLUGIN_STORE_GUIDE.md) for details.
|
||||||
- `nhl-scores` - NHL scores (if you're a hockey fan)
|
|
||||||
|
|
||||||
### Step 4: Configure Plugins
|
### Step 4: Configure Plugins
|
||||||
|
|
||||||
1. Navigate to **Plugin Management** tab
|
1. Each installed plugin gets its own tab in the second navigation row
|
||||||
2. Find a plugin you installed
|
2. Open that plugin's tab to edit its settings (favorite teams, API keys,
|
||||||
3. Click the ⚙️ **Configure** button
|
update intervals, display duration, etc.)
|
||||||
4. Edit settings (e.g., favorite teams, update intervals)
|
3. Click **Save**
|
||||||
5. Click **Save**
|
4. Restart the display service from **Overview** so the new settings take
|
||||||
6. Click **Restart Display**
|
effect
|
||||||
|
|
||||||
**Example: Weather Plugin**
|
**Example: Weather Plugin**
|
||||||
- Set your location (city, state, country)
|
- Set your location (city, state, country)
|
||||||
- Add API key from OpenWeatherMap (free signup)
|
- Add an API key from OpenWeatherMap (free signup) to
|
||||||
- Set update interval (300 seconds recommended)
|
`config/config_secrets.json` or directly in the plugin's config screen
|
||||||
|
- Set the update interval (300 seconds is reasonable)
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
## Testing Your Display
|
## Testing Your Display
|
||||||
|
|
||||||
### Quick Test
|
### Run a single plugin on demand
|
||||||
|
|
||||||
1. Navigate to **Overview** tab
|
The fastest way to verify a plugin works without waiting for the rotation:
|
||||||
2. Click **Test Display** button
|
|
||||||
3. You should see a test pattern on your LED matrix
|
|
||||||
|
|
||||||
### Manual Plugin Trigger
|
1. Open the plugin's tab (second nav row)
|
||||||
|
2. Scroll to **On-Demand Controls**
|
||||||
|
3. Click **Run On-Demand** — the plugin runs immediately even if disabled
|
||||||
|
4. Click **Stop On-Demand** to return to the normal rotation
|
||||||
|
|
||||||
1. Navigate to **Plugin Management** tab
|
### Check the live preview and logs
|
||||||
2. Find a plugin
|
|
||||||
3. Click **Show Now** button
|
|
||||||
4. The plugin should display immediately
|
|
||||||
5. Click **Stop** to return to rotation
|
|
||||||
|
|
||||||
### Check Logs
|
- The **Overview** tab shows a **Live Display Preview** that mirrors what's
|
||||||
|
on the matrix in real time — handy for debugging without looking at the
|
||||||
1. Navigate to **Logs** tab
|
panel.
|
||||||
2. Watch real-time logs
|
- The **Logs** tab streams the display and web service logs. Look for
|
||||||
3. Look for any ERROR messages
|
`ERROR` lines if something isn't working; normal operation just shows
|
||||||
4. Normal operation shows INFO messages about plugin rotation
|
`INFO` messages about plugin rotation.
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
@@ -156,12 +156,12 @@ You should see:
|
|||||||
|
|
||||||
**Check:**
|
**Check:**
|
||||||
1. Power supply connected and adequate (5V, 4A minimum)
|
1. Power supply connected and adequate (5V, 4A minimum)
|
||||||
2. LED matrix connected to GPIO pins correctly
|
2. LED matrix connected to the bonnet/HAT correctly
|
||||||
3. Display service running: `sudo systemctl status ledmatrix`
|
3. Display service running: `sudo systemctl status ledmatrix`
|
||||||
4. Hardware configuration matches your matrix (rows/columns)
|
4. Hardware configuration matches your matrix (rows/cols/chain length)
|
||||||
|
|
||||||
**Fix:**
|
**Fix:**
|
||||||
1. Restart display: Settings → Overview → Restart Display
|
1. Restart from the **Overview** tab → **Restart Display Service**
|
||||||
2. Or via SSH: `sudo systemctl restart ledmatrix`
|
2. Or via SSH: `sudo systemctl restart ledmatrix`
|
||||||
|
|
||||||
### Web Interface Won't Load
|
### Web Interface Won't Load
|
||||||
@@ -169,8 +169,8 @@ You should see:
|
|||||||
**Check:**
|
**Check:**
|
||||||
1. Pi is connected to network: `ping your-pi-ip`
|
1. Pi is connected to network: `ping your-pi-ip`
|
||||||
2. Web service running: `sudo systemctl status ledmatrix-web`
|
2. Web service running: `sudo systemctl status ledmatrix-web`
|
||||||
3. Correct port: Use `:5050` not `:5000`
|
3. Correct port: the web UI listens on `:5000`
|
||||||
4. Firewall not blocking port 5050
|
4. Firewall not blocking port 5000
|
||||||
|
|
||||||
**Fix:**
|
**Fix:**
|
||||||
1. Restart web service: `sudo systemctl restart ledmatrix-web`
|
1. Restart web service: `sudo systemctl restart ledmatrix-web`
|
||||||
@@ -179,15 +179,15 @@ You should see:
|
|||||||
### Plugins Not Showing
|
### Plugins Not Showing
|
||||||
|
|
||||||
**Check:**
|
**Check:**
|
||||||
1. Plugins are enabled (toggle switch in Plugin Management)
|
1. Plugin is enabled (toggle on the **Plugin Manager** tab)
|
||||||
2. Display has been restarted after enabling
|
2. Display service was restarted after enabling
|
||||||
3. Plugin duration is reasonable (not too short)
|
3. Plugin's display duration is non-zero
|
||||||
4. No errors in logs for the plugin
|
4. No errors in the **Logs** tab for that plugin
|
||||||
|
|
||||||
**Fix:**
|
**Fix:**
|
||||||
1. Enable plugin in Plugin Management
|
1. Enable the plugin from **Plugin Manager**
|
||||||
2. Restart display
|
2. Click **Restart Display Service** on **Overview**
|
||||||
3. Check logs for plugin-specific errors
|
3. Check the **Logs** tab for plugin-specific errors
|
||||||
|
|
||||||
### Weather Plugin Shows "No Data"
|
### Weather Plugin Shows "No Data"
|
||||||
|
|
||||||
@@ -207,18 +207,18 @@ You should see:
|
|||||||
|
|
||||||
### Customize Your Display
|
### Customize Your Display
|
||||||
|
|
||||||
**Adjust Display Durations:**
|
**Adjust display durations:**
|
||||||
- Navigate to Settings → Durations
|
- Each plugin's tab has a **Display Duration (seconds)** field — set how
|
||||||
- Set how long each plugin displays
|
long that plugin stays on screen each rotation.
|
||||||
- Save and restart
|
|
||||||
|
|
||||||
**Organize Plugin Order:**
|
**Organize plugin order:**
|
||||||
- Use Plugin Management to enable/disable plugins
|
- Use the **Plugin Manager** tab to enable/disable plugins. The display
|
||||||
- Display cycles through enabled plugins in order
|
cycles through enabled plugins in the order they appear.
|
||||||
|
|
||||||
**Add More Plugins:**
|
**Add more plugins:**
|
||||||
- Check Plugin Store regularly for new plugins
|
- Check the **Plugin Store** section of **Plugin Manager** for new plugins.
|
||||||
- Install from GitHub URLs for custom/community plugins
|
- Install community plugins straight from a GitHub URL via
|
||||||
|
**Install from GitHub** on the same tab.
|
||||||
|
|
||||||
### Enable Advanced Features
|
### Enable Advanced Features
|
||||||
|
|
||||||
@@ -279,26 +279,39 @@ sudo journalctl -u ledmatrix-web -f
|
|||||||
│ ├── config.json # Main configuration
|
│ ├── config.json # Main configuration
|
||||||
│ ├── config_secrets.json # API keys and secrets
|
│ ├── config_secrets.json # API keys and secrets
|
||||||
│ └── wifi_config.json # WiFi settings
|
│ └── wifi_config.json # WiFi settings
|
||||||
├── plugins/ # Installed plugins
|
├── plugin-repos/ # Installed plugins (default location)
|
||||||
├── cache/ # Cached data
|
├── cache/ # Cached data
|
||||||
└── web_interface/ # Web interface files
|
└── web_interface/ # Web interface files
|
||||||
```
|
```
|
||||||
|
|
||||||
|
> The plugin install location is configurable via
|
||||||
|
> `plugin_system.plugins_directory` in `config.json`. The default is
|
||||||
|
> `plugin-repos/`. Plugin discovery (`PluginManager.discover_plugins()`)
|
||||||
|
> only scans the configured directory — it does not fall back to
|
||||||
|
> `plugins/`. However, the Plugin Store install/update path and the
|
||||||
|
> web UI's schema loader do also probe `plugins/` so the dev symlinks
|
||||||
|
> created by `scripts/dev/dev_plugin_setup.sh` keep working.
|
||||||
|
|
||||||
### Web Interface
|
### Web Interface
|
||||||
|
|
||||||
```
|
```
|
||||||
Main Interface: http://your-pi-ip:5050
|
Main Interface: http://your-pi-ip:5000
|
||||||
|
|
||||||
Tabs:
|
System tabs:
|
||||||
- Overview: System stats and quick actions
|
- Overview System stats, live preview, quick actions
|
||||||
- General Settings: Timezone, location, autostart
|
- General Timezone, location, plugin-system settings
|
||||||
- Display Settings: Hardware configuration
|
- WiFi Network selection and AP-mode setup
|
||||||
- Durations: Plugin display times
|
- Schedule Power and dim schedules
|
||||||
- Sports Configuration: Per-league settings
|
- Display Matrix hardware configuration
|
||||||
- Plugin Management: Enable/disable, configure
|
- Config Editor Raw config.json editor
|
||||||
- Plugin Store: Install new plugins
|
- Fonts Upload and manage fonts
|
||||||
- Font Management: Upload and manage fonts
|
- Logs Real-time log viewing
|
||||||
- Logs: Real-time log viewing
|
- Cache Cached data inspection and cleanup
|
||||||
|
- Operation History Recent service operations
|
||||||
|
|
||||||
|
Plugin tabs (second row):
|
||||||
|
- Plugin Manager Browse the Plugin Store, install/enable plugins
|
||||||
|
- <plugin-id> One tab per installed plugin for its config
|
||||||
```
|
```
|
||||||
|
|
||||||
### WiFi Access Point
|
### WiFi Access Point
|
||||||
@@ -306,7 +319,7 @@ Tabs:
|
|||||||
```
|
```
|
||||||
Network Name: LEDMatrix-Setup
|
Network Name: LEDMatrix-Setup
|
||||||
Password: (none - open network)
|
Password: (none - open network)
|
||||||
URL when connected: http://192.168.4.1:5050
|
URL when connected: http://192.168.4.1:5000
|
||||||
```
|
```
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|||||||
@@ -13,7 +13,7 @@ Make sure you have the testing packages installed:
|
|||||||
pip install -r requirements.txt
|
pip install -r requirements.txt
|
||||||
|
|
||||||
# Or install just the test dependencies
|
# Or install just the test dependencies
|
||||||
pip install pytest pytest-cov pytest-mock pytest-timeout
|
pip install pytest pytest-cov pytest-mock
|
||||||
```
|
```
|
||||||
|
|
||||||
### 2. Set Environment Variables
|
### 2. Set Environment Variables
|
||||||
@@ -85,8 +85,14 @@ pytest -m slow
|
|||||||
# Run all tests in the test directory
|
# Run all tests in the test directory
|
||||||
pytest test/
|
pytest test/
|
||||||
|
|
||||||
# Run all integration tests
|
# Run plugin tests only
|
||||||
pytest test/integration/
|
pytest test/plugins/
|
||||||
|
|
||||||
|
# Run web interface tests only
|
||||||
|
pytest test/web_interface/
|
||||||
|
|
||||||
|
# Run web interface integration tests
|
||||||
|
pytest test/web_interface/integration/
|
||||||
```
|
```
|
||||||
|
|
||||||
## Understanding Test Output
|
## Understanding Test Output
|
||||||
@@ -231,20 +237,41 @@ pytest --maxfail=3
|
|||||||
|
|
||||||
```
|
```
|
||||||
test/
|
test/
|
||||||
├── conftest.py # Shared fixtures and configuration
|
├── conftest.py # Shared fixtures and configuration
|
||||||
├── test_display_controller.py # Display controller tests
|
├── test_display_controller.py # Display controller tests
|
||||||
├── test_plugin_system.py # Plugin system tests
|
├── test_display_manager.py # Display manager tests
|
||||||
├── test_display_manager.py # Display manager tests
|
├── test_plugin_system.py # Plugin system tests
|
||||||
├── test_config_service.py # Config service tests
|
├── test_plugin_loader.py # Plugin discovery/loading tests
|
||||||
├── test_cache_manager.py # Cache manager tests
|
├── test_plugin_loading_failures.py # Plugin failure-mode tests
|
||||||
├── test_font_manager.py # Font manager tests
|
├── test_cache_manager.py # Cache manager tests
|
||||||
├── test_error_handling.py # Error handling tests
|
├── test_config_manager.py # Config manager tests
|
||||||
├── test_config_manager.py # Config manager tests
|
├── test_config_service.py # Config service tests
|
||||||
├── integration/ # Integration tests
|
├── test_config_validation_edge_cases.py # Config edge cases
|
||||||
│ ├── test_e2e.py # End-to-end tests
|
├── test_font_manager.py # Font manager tests
|
||||||
│ └── test_plugin_integration.py # Plugin integration tests
|
├── test_layout_manager.py # Layout manager tests
|
||||||
├── test_error_scenarios.py # Error scenario tests
|
├── test_text_helper.py # Text helper tests
|
||||||
└── test_edge_cases.py # Edge case tests
|
├── test_error_handling.py # Error handling tests
|
||||||
|
├── test_error_aggregator.py # Error aggregation tests
|
||||||
|
├── test_schema_manager.py # Schema manager tests
|
||||||
|
├── test_web_api.py # Web API tests
|
||||||
|
├── test_nba_*.py # NBA-specific test suites
|
||||||
|
├── plugins/ # Per-plugin test suites
|
||||||
|
│ ├── test_clock_simple.py
|
||||||
|
│ ├── test_calendar.py
|
||||||
|
│ ├── test_basketball_scoreboard.py
|
||||||
|
│ ├── test_soccer_scoreboard.py
|
||||||
|
│ ├── test_odds_ticker.py
|
||||||
|
│ ├── test_text_display.py
|
||||||
|
│ ├── test_visual_rendering.py
|
||||||
|
│ └── test_plugin_base.py
|
||||||
|
└── web_interface/
|
||||||
|
├── test_config_manager_atomic.py
|
||||||
|
├── test_state_reconciliation.py
|
||||||
|
├── test_plugin_operation_queue.py
|
||||||
|
├── test_dedup_unique_arrays.py
|
||||||
|
└── integration/ # Web interface integration tests
|
||||||
|
├── test_config_flows.py
|
||||||
|
└── test_plugin_operations.py
|
||||||
```
|
```
|
||||||
|
|
||||||
### Test Categories
|
### Test Categories
|
||||||
@@ -309,11 +336,15 @@ pytest --cov=src --cov-report=html
|
|||||||
|
|
||||||
## Continuous Integration
|
## Continuous Integration
|
||||||
|
|
||||||
Tests are configured to run automatically in CI/CD. The GitHub Actions workflow (`.github/workflows/tests.yml`) runs:
|
There is currently no CI test workflow in this repo — `pytest` runs
|
||||||
|
locally but is not gated on PRs. The only GitHub Actions workflow is
|
||||||
|
[`.github/workflows/security-audit.yml`](../.github/workflows/security-audit.yml),
|
||||||
|
which runs bandit and semgrep on every push.
|
||||||
|
|
||||||
- All tests on multiple Python versions (3.10, 3.11, 3.12)
|
If you'd like to add a test workflow, the recommended setup is a
|
||||||
- Coverage reporting
|
`.github/workflows/tests.yml` that runs `pytest` against the
|
||||||
- Uploads coverage to Codecov (if configured)
|
supported Python versions (3.10, 3.11, 3.12, 3.13 per
|
||||||
|
`requirements.txt`). Open an issue or PR if you want to contribute it.
|
||||||
|
|
||||||
## Best Practices
|
## Best Practices
|
||||||
|
|
||||||
|
|||||||
@@ -88,8 +88,8 @@ If you encounter issues during migration:
|
|||||||
|
|
||||||
1. Check the [README.md](README.md) for current installation and usage instructions
|
1. Check the [README.md](README.md) for current installation and usage instructions
|
||||||
2. Review script README files:
|
2. Review script README files:
|
||||||
- `scripts/install/README.md` - Installation scripts documentation
|
- [`scripts/install/README.md`](../scripts/install/README.md) - Installation scripts documentation
|
||||||
- `scripts/fix_perms/README.md` (if exists) - Permission scripts documentation
|
- [`scripts/fix_perms/README.md`](../scripts/fix_perms/README.md) - Permission scripts documentation
|
||||||
3. Check system logs: `journalctl -u ledmatrix -f` or `journalctl -u ledmatrix-web -f`
|
3. Check system logs: `journalctl -u ledmatrix -f` or `journalctl -u ledmatrix-web -f`
|
||||||
4. Review the troubleshooting section in the main README
|
4. Review the troubleshooting section in the main README
|
||||||
|
|
||||||
|
|||||||
@@ -114,6 +114,95 @@ Get display duration for this plugin. Can be overridden for dynamic durations.
|
|||||||
|
|
||||||
Return plugin info for display in web UI. Override to provide additional state information.
|
Return plugin info for display in web UI. Override to provide additional state information.
|
||||||
|
|
||||||
|
### Dynamic-duration hooks
|
||||||
|
|
||||||
|
Plugins that render multi-step content (e.g. cycling through several games)
|
||||||
|
can extend their display time until they've shown everything. To opt in,
|
||||||
|
either set `dynamic_duration.enabled: true` in the plugin's config or
|
||||||
|
override `supports_dynamic_duration()`.
|
||||||
|
|
||||||
|
#### `supports_dynamic_duration() -> bool`
|
||||||
|
|
||||||
|
Return `True` if this plugin should use dynamic durations. Default reads
|
||||||
|
`config["dynamic_duration"]["enabled"]`.
|
||||||
|
|
||||||
|
#### `get_dynamic_duration_cap() -> Optional[float]`
|
||||||
|
|
||||||
|
Maximum number of seconds the controller will keep this plugin on screen
|
||||||
|
in dynamic mode. Default reads
|
||||||
|
`config["dynamic_duration"]["max_duration_seconds"]`.
|
||||||
|
|
||||||
|
#### `is_cycle_complete() -> bool`
|
||||||
|
|
||||||
|
Override this to return `True` only after the plugin has rendered all of
|
||||||
|
its content for the current rotation. Default returns `True` immediately,
|
||||||
|
which means a single `display()` call counts as a full cycle.
|
||||||
|
|
||||||
|
#### `reset_cycle_state() -> None`
|
||||||
|
|
||||||
|
Called by the controller before each new dynamic-duration session. Reset
|
||||||
|
internal counters/iterators here.
|
||||||
|
|
||||||
|
### Live priority hooks
|
||||||
|
|
||||||
|
Live priority lets a plugin temporarily take over the rotation when it has
|
||||||
|
urgent content (live games, breaking news). Enable by setting
|
||||||
|
`live_priority: true` in the plugin's config and overriding
|
||||||
|
`has_live_content()`.
|
||||||
|
|
||||||
|
#### `has_live_priority() -> bool`
|
||||||
|
|
||||||
|
Whether live priority is enabled in config (default reads
|
||||||
|
`config["live_priority"]`).
|
||||||
|
|
||||||
|
#### `has_live_content() -> bool`
|
||||||
|
|
||||||
|
Override to return `True` when the plugin currently has urgent content.
|
||||||
|
Default returns `False`.
|
||||||
|
|
||||||
|
#### `get_live_modes() -> List[str]`
|
||||||
|
|
||||||
|
List of display modes to show during a live takeover. Default returns the
|
||||||
|
plugin's `display_modes` from its manifest.
|
||||||
|
|
||||||
|
### Vegas scroll hooks
|
||||||
|
|
||||||
|
Vegas mode shows multiple plugins as a single continuous scroll instead of
|
||||||
|
rotating one at a time. Plugins control how their content appears via
|
||||||
|
these hooks. See [ADVANCED_FEATURES.md](ADVANCED_FEATURES.md) for the user
|
||||||
|
side of Vegas mode.
|
||||||
|
|
||||||
|
#### `get_vegas_content() -> Optional[PIL.Image | List[PIL.Image] | None]`
|
||||||
|
|
||||||
|
Return content to inject into the scroll. Multi-item plugins (sports,
|
||||||
|
odds, news) should return a *list* of PIL Images so each item scrolls
|
||||||
|
independently. Static plugins (clock, weather) can return a single image.
|
||||||
|
Returning `None` falls back to capturing whatever `display()` produces.
|
||||||
|
|
||||||
|
#### `get_vegas_content_type() -> str`
|
||||||
|
|
||||||
|
`'multi'`, `'static'`, or `'none'`. Affects how Vegas mode treats the
|
||||||
|
plugin. Default `'static'`.
|
||||||
|
|
||||||
|
#### `get_vegas_display_mode() -> VegasDisplayMode`
|
||||||
|
|
||||||
|
Returns one of `VegasDisplayMode.SCROLL`, `FIXED_SEGMENT`, or `STATIC`.
|
||||||
|
Read from `config["vegas_mode"]` or override directly.
|
||||||
|
|
||||||
|
#### `get_supported_vegas_modes() -> List[VegasDisplayMode]`
|
||||||
|
|
||||||
|
The set of Vegas modes this plugin can render. Used by the UI to populate
|
||||||
|
the mode selector for this plugin.
|
||||||
|
|
||||||
|
#### `get_vegas_segment_width() -> Optional[int]`
|
||||||
|
|
||||||
|
For `FIXED_SEGMENT` plugins, the width in pixels of the segment they
|
||||||
|
occupy in the scroll. `None` lets the controller pick a default.
|
||||||
|
|
||||||
|
> The full source for `BasePlugin` lives in
|
||||||
|
> `src/plugin_system/base_plugin.py`. If a method here disagrees with the
|
||||||
|
> source, the source wins — please open an issue or PR to fix the doc.
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
## Display Manager
|
## Display Manager
|
||||||
@@ -228,23 +317,31 @@ date_str = self.display_manager.format_date_with_ordinal(datetime.now())
|
|||||||
|
|
||||||
### Image Rendering
|
### Image Rendering
|
||||||
|
|
||||||
#### `draw_image(image: PIL.Image, x: int, y: int) -> None`
|
The display manager doesn't provide a dedicated `draw_image()` method.
|
||||||
|
Instead, plugins paste directly onto the underlying PIL Image
|
||||||
|
(`display_manager.image`), then call `update_display()` to push the buffer
|
||||||
|
to the matrix.
|
||||||
|
|
||||||
Draw a PIL Image object on the canvas.
|
|
||||||
|
|
||||||
**Parameters**:
|
|
||||||
- `image`: PIL Image object
|
|
||||||
- `x` (int): X position (left edge)
|
|
||||||
- `y` (int): Y position (top edge)
|
|
||||||
|
|
||||||
**Example**:
|
|
||||||
```python
|
```python
|
||||||
from PIL import Image
|
from PIL import Image
|
||||||
logo = Image.open("assets/logo.png")
|
|
||||||
self.display_manager.draw_image(logo, x=10, y=10)
|
logo = Image.open("assets/logo.png").convert("RGB")
|
||||||
|
self.display_manager.image.paste(logo, (10, 10))
|
||||||
self.display_manager.update_display()
|
self.display_manager.update_display()
|
||||||
```
|
```
|
||||||
|
|
||||||
|
For transparency support, paste using a mask:
|
||||||
|
|
||||||
|
```python
|
||||||
|
icon = Image.open("assets/icon.png").convert("RGBA")
|
||||||
|
self.display_manager.image.paste(icon, (5, 5), icon)
|
||||||
|
self.display_manager.update_display()
|
||||||
|
```
|
||||||
|
|
||||||
|
This is the same pattern the bundled scoreboard base classes
|
||||||
|
(`src/base_classes/baseball.py`, `basketball.py`, `football.py`,
|
||||||
|
`hockey.py`) use, so it's the canonical way to render arbitrary images.
|
||||||
|
|
||||||
### Weather Icons
|
### Weather Icons
|
||||||
|
|
||||||
#### `draw_weather_icon(condition: str, x: int, y: int, size: int = 16) -> None`
|
#### `draw_weather_icon(condition: str, x: int, y: int, size: int = 16) -> None`
|
||||||
@@ -440,12 +537,23 @@ self.cache_manager.set("weather_data", {
|
|||||||
})
|
})
|
||||||
```
|
```
|
||||||
|
|
||||||
#### `delete(key: str) -> None`
|
#### `clear_cache(key: Optional[str] = None) -> None`
|
||||||
|
|
||||||
Remove a specific cache entry.
|
Remove a specific cache entry, or all cache entries when called without
|
||||||
|
arguments.
|
||||||
|
|
||||||
**Parameters**:
|
**Parameters**:
|
||||||
- `key` (str): Cache key to delete
|
- `key` (str, optional): Cache key to delete. If omitted, every cached
|
||||||
|
entry (memory + disk) is cleared.
|
||||||
|
|
||||||
|
**Example**:
|
||||||
|
```python
|
||||||
|
# Drop one stale entry
|
||||||
|
self.cache_manager.clear_cache("weather_data")
|
||||||
|
|
||||||
|
# Nuke everything (rare — typically only used by maintenance tooling)
|
||||||
|
self.cache_manager.clear_cache()
|
||||||
|
```
|
||||||
|
|
||||||
### Advanced Methods
|
### Advanced Methods
|
||||||
|
|
||||||
|
|||||||
@@ -1,5 +1,24 @@
|
|||||||
# LEDMatrix Plugin Architecture Specification
|
# LEDMatrix Plugin Architecture Specification
|
||||||
|
|
||||||
|
> **Historical design document.** This spec was written *before* the
|
||||||
|
> plugin system was built. Most of it is still architecturally
|
||||||
|
> accurate, but specific details have drifted from the shipped
|
||||||
|
> implementation:
|
||||||
|
>
|
||||||
|
> - Code paths reference `web_interface_v2.py`; the current web UI is
|
||||||
|
> `web_interface/app.py` with v3 Blueprint-based templates.
|
||||||
|
> - The example Flask routes use `/api/plugins/*`; the real API
|
||||||
|
> blueprint is mounted at `/api/v3` (`web_interface/app.py:144`).
|
||||||
|
> - The default plugin location is `plugin-repos/` (configurable via
|
||||||
|
> `plugin_system.plugins_directory`), not `./plugins/`.
|
||||||
|
> - The "Migration Strategy" and "Implementation Roadmap" sections
|
||||||
|
> describe work that has now shipped.
|
||||||
|
>
|
||||||
|
> For the current system, see:
|
||||||
|
> [PLUGIN_DEVELOPMENT_GUIDE.md](PLUGIN_DEVELOPMENT_GUIDE.md),
|
||||||
|
> [PLUGIN_API_REFERENCE.md](PLUGIN_API_REFERENCE.md), and
|
||||||
|
> [REST_API_REFERENCE.md](REST_API_REFERENCE.md).
|
||||||
|
|
||||||
## Executive Summary
|
## Executive Summary
|
||||||
|
|
||||||
This document outlines the transformation of the LEDMatrix project into a modular, plugin-based architecture that enables user-created displays. The goal is to create a flexible, extensible system similar to Home Assistant Community Store (HACS) where users can discover, install, and manage custom display managers from GitHub repositories.
|
This document outlines the transformation of the LEDMatrix project into a modular, plugin-based architecture that enables user-created displays. The goal is to create a flexible, extensible system similar to Home Assistant Community Store (HACS) where users can discover, install, and manage custom display managers from GitHub repositories.
|
||||||
@@ -9,7 +28,7 @@ This document outlines the transformation of the LEDMatrix project into a modula
|
|||||||
1. **Gradual Migration**: Existing managers remain in core while new plugin infrastructure is built
|
1. **Gradual Migration**: Existing managers remain in core while new plugin infrastructure is built
|
||||||
2. **Migration Required**: Breaking changes with migration tools provided
|
2. **Migration Required**: Breaking changes with migration tools provided
|
||||||
3. **GitHub-Based Store**: Simple discovery system, packages served from GitHub repos
|
3. **GitHub-Based Store**: Simple discovery system, packages served from GitHub repos
|
||||||
4. **Plugin Location**: `./plugins/` directory in project root
|
4. **Plugin Location**: `./plugins/` directory in project root *(actual default is now `plugin-repos/`)*
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
|
|||||||
@@ -184,37 +184,45 @@ plugin-repos/
|
|||||||
|
|
||||||
```json
|
```json
|
||||||
{
|
{
|
||||||
|
"id": "my-plugin",
|
||||||
"name": "My Plugin",
|
"name": "My Plugin",
|
||||||
"version": "1.0.0",
|
"version": "1.0.0",
|
||||||
"description": "Plugin description",
|
"description": "Plugin description",
|
||||||
"author": "Your Name",
|
"author": "Your Name",
|
||||||
|
"entry_point": "manager.py",
|
||||||
|
"class_name": "MyPlugin",
|
||||||
"display_modes": ["my_plugin"],
|
"display_modes": ["my_plugin"],
|
||||||
"config_schema": {
|
"config_schema": "config_schema.json"
|
||||||
"type": "object",
|
|
||||||
"properties": {
|
|
||||||
"enabled": {"type": "boolean", "default": false},
|
|
||||||
"update_interval": {"type": "integer", "default": 3600}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
|
The required fields the plugin loader will check for are `id`,
|
||||||
|
`name`, `version`, `class_name`, and `display_modes`. `entry_point`
|
||||||
|
defaults to `manager.py` if omitted. `config_schema` must be a
|
||||||
|
**file path** (relative to the plugin directory) — the schema itself
|
||||||
|
lives in a separate JSON file, not inline in the manifest. The
|
||||||
|
`class_name` value must match the actual class defined in the entry
|
||||||
|
point file **exactly** (case-sensitive, no spaces); otherwise the
|
||||||
|
loader fails with `AttributeError` at load time.
|
||||||
|
|
||||||
### Plugin Manager Class
|
### Plugin Manager Class
|
||||||
|
|
||||||
```python
|
```python
|
||||||
from src.plugin_system.base_plugin import BasePlugin
|
from src.plugin_system.base_plugin import BasePlugin
|
||||||
|
|
||||||
class MyPluginManager(BasePlugin):
|
class MyPlugin(BasePlugin):
|
||||||
def __init__(self, config, display_manager, cache_manager, font_manager):
|
def __init__(self, plugin_id, config, display_manager, cache_manager, plugin_manager):
|
||||||
super().__init__(config, display_manager, cache_manager, font_manager)
|
super().__init__(plugin_id, config, display_manager, cache_manager, plugin_manager)
|
||||||
self.enabled = config.get('enabled', False)
|
# self.config, self.display_manager, self.cache_manager,
|
||||||
|
# self.plugin_manager, self.logger, and self.enabled are
|
||||||
|
# all set up by BasePlugin.__init__.
|
||||||
|
|
||||||
def update(self):
|
def update(self):
|
||||||
"""Update plugin data"""
|
"""Fetch/update data. Called based on update_interval."""
|
||||||
pass
|
pass
|
||||||
|
|
||||||
def display(self, force_clear=False):
|
def display(self, force_clear=False):
|
||||||
"""Display plugin content"""
|
"""Render plugin content to the LED matrix."""
|
||||||
pass
|
pass
|
||||||
|
|
||||||
def get_duration(self):
|
def get_duration(self):
|
||||||
|
|||||||
@@ -1,5 +1,15 @@
|
|||||||
# Plugin Configuration Tabs
|
# Plugin Configuration Tabs
|
||||||
|
|
||||||
|
> **Status note:** this doc was written during the rollout of the
|
||||||
|
> per-plugin configuration tab feature. The feature itself is shipped
|
||||||
|
> and working in the current v3 web interface, but a few file paths
|
||||||
|
> in the "Implementation Details" section below still reference the
|
||||||
|
> pre-v3 file layout (`web_interface_v2.py`, `templates/index_v2.html`).
|
||||||
|
> The current implementation lives in `web_interface/app.py`,
|
||||||
|
> `web_interface/blueprints/api_v3.py`, and `web_interface/templates/v3/`.
|
||||||
|
> The user-facing description (Overview, Features, Form Generation
|
||||||
|
> Process) is still accurate.
|
||||||
|
|
||||||
## Overview
|
## Overview
|
||||||
|
|
||||||
Each installed plugin now gets its own dedicated configuration tab in the web interface. This provides a clean, organized way to configure plugins without cluttering the main Plugins management tab.
|
Each installed plugin now gets its own dedicated configuration tab in the web interface. This provides a clean, organized way to configure plugins without cluttering the main Plugins management tab.
|
||||||
@@ -29,10 +39,14 @@ Each installed plugin now gets its own dedicated configuration tab in the web in
|
|||||||
3. Click **Save Configuration**
|
3. Click **Save Configuration**
|
||||||
4. Restart the display service to apply changes
|
4. Restart the display service to apply changes
|
||||||
|
|
||||||
### Plugin Management vs Configuration
|
### Plugin Manager vs Per-Plugin Configuration
|
||||||
|
|
||||||
- **Plugins Tab**: Used for plugin management (install, enable/disable, update, uninstall)
|
- **Plugin Manager tab** (second nav row): used for browsing the
|
||||||
- **Plugin-Specific Tabs**: Used for configuring plugin behavior and settings
|
Plugin Store, installing plugins, toggling installed plugins on/off,
|
||||||
|
and updating/uninstalling them
|
||||||
|
- **Per-plugin tabs** (one per installed plugin, also in the second
|
||||||
|
nav row): used for configuring that specific plugin's behavior and
|
||||||
|
settings via a form auto-generated from its `config_schema.json`
|
||||||
|
|
||||||
## For Plugin Developers
|
## For Plugin Developers
|
||||||
|
|
||||||
@@ -194,12 +208,12 @@ Renders as: Dropdown select
|
|||||||
|
|
||||||
### Form Generation Process
|
### Form Generation Process
|
||||||
|
|
||||||
1. Web UI loads installed plugins via `/api/plugins/installed`
|
1. Web UI loads installed plugins via `/api/v3/plugins/installed`
|
||||||
2. For each plugin, the backend loads its `config_schema.json`
|
2. For each plugin, the backend loads its `config_schema.json`
|
||||||
3. Frontend generates a tab button with plugin name
|
3. Frontend generates a tab button with plugin name
|
||||||
4. Frontend generates a form based on the JSON Schema
|
4. Frontend generates a form based on the JSON Schema
|
||||||
5. Current config values from `config.json` are populated
|
5. Current config values from `config.json` are populated
|
||||||
6. When saved, each field is sent to `/api/plugins/config` endpoint
|
6. When saved, each field is sent to `/api/v3/plugins/config` endpoint
|
||||||
|
|
||||||
## Implementation Details
|
## Implementation Details
|
||||||
|
|
||||||
@@ -207,7 +221,7 @@ Renders as: Dropdown select
|
|||||||
|
|
||||||
**File**: `web_interface_v2.py`
|
**File**: `web_interface_v2.py`
|
||||||
|
|
||||||
- Modified `/api/plugins/installed` endpoint to include `config_schema_data`
|
- Modified `/api/v3/plugins/installed` endpoint to include `config_schema_data`
|
||||||
- Loads each plugin's `config_schema.json` if it exists
|
- Loads each plugin's `config_schema.json` if it exists
|
||||||
- Returns schema data along with plugin info
|
- Returns schema data along with plugin info
|
||||||
|
|
||||||
@@ -227,7 +241,7 @@ New Functions:
|
|||||||
```
|
```
|
||||||
Page Load
|
Page Load
|
||||||
→ refreshPlugins()
|
→ refreshPlugins()
|
||||||
→ /api/plugins/installed
|
→ /api/v3/plugins/installed
|
||||||
→ Returns plugins with config_schema_data
|
→ Returns plugins with config_schema_data
|
||||||
→ generatePluginTabs()
|
→ generatePluginTabs()
|
||||||
→ Creates tab buttons
|
→ Creates tab buttons
|
||||||
@@ -241,7 +255,7 @@ User Saves
|
|||||||
→ savePluginConfiguration()
|
→ savePluginConfiguration()
|
||||||
→ Reads form data
|
→ Reads form data
|
||||||
→ Converts types per schema
|
→ Converts types per schema
|
||||||
→ Sends to /api/plugins/config
|
→ Sends to /api/v3/plugins/config
|
||||||
→ Updates config.json
|
→ Updates config.json
|
||||||
→ Shows success notification
|
→ Shows success notification
|
||||||
```
|
```
|
||||||
|
|||||||
@@ -31,7 +31,7 @@
|
|||||||
┌─────────────────────────────────────────────────────────────────┐
|
┌─────────────────────────────────────────────────────────────────┐
|
||||||
│ Flask Backend │
|
│ Flask Backend │
|
||||||
│ ┌───────────────────────────────────────────────────────┐ │
|
│ ┌───────────────────────────────────────────────────────┐ │
|
||||||
│ │ /api/plugins/installed │ │
|
│ │ /api/v3/plugins/installed │ │
|
||||||
│ │ • Discover plugins in plugins/ directory │ │
|
│ │ • Discover plugins in plugins/ directory │ │
|
||||||
│ │ • Load manifest.json for each plugin │ │
|
│ │ • Load manifest.json for each plugin │ │
|
||||||
│ │ • Load config_schema.json if exists │ │
|
│ │ • Load config_schema.json if exists │ │
|
||||||
@@ -40,7 +40,7 @@
|
|||||||
│ └───────────────────────────────────────────────────────┘ │
|
│ └───────────────────────────────────────────────────────┘ │
|
||||||
│ │
|
│ │
|
||||||
│ ┌───────────────────────────────────────────────────────┐ │
|
│ ┌───────────────────────────────────────────────────────┐ │
|
||||||
│ │ /api/plugins/config │ │
|
│ │ /api/v3/plugins/config │ │
|
||||||
│ │ • Receive key-value pair │ │
|
│ │ • Receive key-value pair │ │
|
||||||
│ │ • Update config.json │ │
|
│ │ • Update config.json │ │
|
||||||
│ │ • Return success/error │ │
|
│ │ • Return success/error │ │
|
||||||
@@ -88,7 +88,7 @@ DOMContentLoaded Event
|
|||||||
refreshPlugins()
|
refreshPlugins()
|
||||||
│
|
│
|
||||||
▼
|
▼
|
||||||
GET /api/plugins/installed
|
GET /api/v3/plugins/installed
|
||||||
│
|
│
|
||||||
├─→ For each plugin directory:
|
├─→ For each plugin directory:
|
||||||
│ ├─→ Read manifest.json
|
│ ├─→ Read manifest.json
|
||||||
@@ -146,7 +146,7 @@ savePluginConfiguration(pluginId)
|
|||||||
│ │ • array: split(',')
|
│ │ • array: split(',')
|
||||||
│ │ • string: as-is
|
│ │ • string: as-is
|
||||||
│ │
|
│ │
|
||||||
│ └─→ POST /api/plugins/config
|
│ └─→ POST /api/v3/plugins/config
|
||||||
│ {
|
│ {
|
||||||
│ plugin_id: "hello-world",
|
│ plugin_id: "hello-world",
|
||||||
│ key: "message",
|
│ key: "message",
|
||||||
@@ -174,7 +174,7 @@ Refresh Plugins
|
|||||||
Window Load
|
Window Load
|
||||||
└── DOMContentLoaded
|
└── DOMContentLoaded
|
||||||
└── refreshPlugins()
|
└── refreshPlugins()
|
||||||
├── fetch('/api/plugins/installed')
|
├── fetch('/api/v3/plugins/installed')
|
||||||
├── renderInstalledPlugins(plugins)
|
├── renderInstalledPlugins(plugins)
|
||||||
└── generatePluginTabs(plugins)
|
└── generatePluginTabs(plugins)
|
||||||
└── For each plugin:
|
└── For each plugin:
|
||||||
@@ -198,19 +198,19 @@ User Interactions
|
|||||||
│ ├── Process form data
|
│ ├── Process form data
|
||||||
│ ├── Convert types per schema
|
│ ├── Convert types per schema
|
||||||
│ └── For each field:
|
│ └── For each field:
|
||||||
│ └── POST /api/plugins/config
|
│ └── POST /api/v3/plugins/config
|
||||||
│
|
│
|
||||||
└── resetPluginConfig(pluginId)
|
└── resetPluginConfig(pluginId)
|
||||||
├── Get schema defaults
|
├── Get schema defaults
|
||||||
└── For each field:
|
└── For each field:
|
||||||
└── POST /api/plugins/config
|
└── POST /api/v3/plugins/config
|
||||||
```
|
```
|
||||||
|
|
||||||
### Backend (Python)
|
### Backend (Python)
|
||||||
|
|
||||||
```
|
```
|
||||||
Flask Routes
|
Flask Routes
|
||||||
├── /api/plugins/installed (GET)
|
├── /api/v3/plugins/installed (GET)
|
||||||
│ └── api_plugins_installed()
|
│ └── api_plugins_installed()
|
||||||
│ ├── PluginManager.discover_plugins()
|
│ ├── PluginManager.discover_plugins()
|
||||||
│ ├── For each plugin:
|
│ ├── For each plugin:
|
||||||
@@ -219,7 +219,7 @@ Flask Routes
|
|||||||
│ │ └── Load config from config.json
|
│ │ └── Load config from config.json
|
||||||
│ └── Return JSON response
|
│ └── Return JSON response
|
||||||
│
|
│
|
||||||
└── /api/plugins/config (POST)
|
└── /api/v3/plugins/config (POST)
|
||||||
└── api_plugin_config()
|
└── api_plugin_config()
|
||||||
├── Parse request JSON
|
├── Parse request JSON
|
||||||
├── Load current config
|
├── Load current config
|
||||||
@@ -279,7 +279,7 @@ LEDMatrix/
|
|||||||
### 3. Individual Config Updates
|
### 3. Individual Config Updates
|
||||||
|
|
||||||
**Why**: Simplifies backend API
|
**Why**: Simplifies backend API
|
||||||
**How**: Each field saved separately via `/api/plugins/config`
|
**How**: Each field saved separately via `/api/v3/plugins/config`
|
||||||
**Benefit**: Atomic updates, easier error handling
|
**Benefit**: Atomic updates, easier error handling
|
||||||
|
|
||||||
### 4. Type Conversion in Frontend
|
### 4. Type Conversion in Frontend
|
||||||
|
|||||||
@@ -4,13 +4,14 @@
|
|||||||
|
|
||||||
### For Users
|
### For Users
|
||||||
|
|
||||||
1. Open the web interface: `http://your-pi-ip:5001`
|
1. Open the web interface: `http://your-pi-ip:5000`
|
||||||
2. Go to the **Plugin Store** tab
|
2. Open the **Plugin Manager** tab
|
||||||
3. Install a plugin (e.g., "Hello World")
|
3. Find a plugin in the **Plugin Store** section (e.g., "Hello World")
|
||||||
4. Notice a new tab appears with the plugin's name
|
and click **Install**
|
||||||
5. Click on the plugin's tab to configure it
|
4. Notice a new tab appears in the second nav row with the plugin's name
|
||||||
6. Modify settings and click **Save Configuration**
|
5. Click that tab to configure the plugin
|
||||||
7. Restart the display to see changes
|
6. Modify settings and click **Save**
|
||||||
|
7. From **Overview**, click **Restart Display Service** to see changes
|
||||||
|
|
||||||
That's it! Each installed plugin automatically gets its own configuration tab.
|
That's it! Each installed plugin automatically gets its own configuration tab.
|
||||||
|
|
||||||
@@ -171,9 +172,11 @@ User enters: `255, 0, 0`
|
|||||||
### For Users
|
### For Users
|
||||||
|
|
||||||
1. **Reset Anytime**: Use "Reset to Defaults" to restore original settings
|
1. **Reset Anytime**: Use "Reset to Defaults" to restore original settings
|
||||||
2. **Navigate Back**: Click "Back to Plugin Management" to return to Plugins tab
|
2. **Navigate Back**: Switch to the **Plugin Manager** tab to see the
|
||||||
|
full list of installed plugins
|
||||||
3. **Check Help Text**: Each field has a description explaining what it does
|
3. **Check Help Text**: Each field has a description explaining what it does
|
||||||
4. **Restart Required**: Remember to restart the display after saving
|
4. **Restart Required**: Remember to restart the display service from
|
||||||
|
**Overview** after saving
|
||||||
|
|
||||||
### For Developers
|
### For Developers
|
||||||
|
|
||||||
@@ -206,8 +209,10 @@ User enters: `255, 0, 0`
|
|||||||
## 📚 Next Steps
|
## 📚 Next Steps
|
||||||
|
|
||||||
- Read the full documentation: [PLUGIN_CONFIGURATION_TABS.md](PLUGIN_CONFIGURATION_TABS.md)
|
- Read the full documentation: [PLUGIN_CONFIGURATION_TABS.md](PLUGIN_CONFIGURATION_TABS.md)
|
||||||
- Check implementation details: [PLUGIN_CONFIG_TABS_SUMMARY.md](PLUGIN_CONFIG_TABS_SUMMARY.md)
|
- Check the configuration architecture: [PLUGIN_CONFIG_ARCHITECTURE.md](PLUGIN_CONFIG_ARCHITECTURE.md)
|
||||||
- Browse example plugins: `plugins/hello-world/`, `plugins/clock-simple/`
|
- Browse example plugins in the
|
||||||
|
[ledmatrix-plugins](https://github.com/ChuckBuilds/ledmatrix-plugins)
|
||||||
|
repo, especially `plugins/hello-world/` and `plugins/clock-simple/`
|
||||||
- Join the community for help and suggestions
|
- Join the community for help and suggestions
|
||||||
|
|
||||||
## 🎉 That's It!
|
## 🎉 That's It!
|
||||||
|
|||||||
@@ -1,5 +1,16 @@
|
|||||||
# Plugin Custom Icons Guide
|
# Plugin Custom Icons Guide
|
||||||
|
|
||||||
|
> ⚠️ **Status:** the `icon` field in `manifest.json` is currently
|
||||||
|
> **not honored by the v3 web interface**. Plugin tab icons are
|
||||||
|
> hardcoded to `fas fa-puzzle-piece` in
|
||||||
|
> `web_interface/templates/v3/base.html:515` and `:774`. The icon
|
||||||
|
> field was originally read by a `getPluginIcon()` helper in the v2
|
||||||
|
> templates, but that helper wasn't ported to v3. Setting `icon` in a
|
||||||
|
> manifest is harmless (it's just ignored) so plugin authors can leave
|
||||||
|
> it in place for when this regression is fixed.
|
||||||
|
>
|
||||||
|
> Tracking issue: see the LEDMatrix repo for the open ticket.
|
||||||
|
|
||||||
## Overview
|
## Overview
|
||||||
|
|
||||||
Plugins can specify custom icons that appear next to their name in the web interface tabs. This makes your plugin instantly recognizable and adds visual polish to the UI.
|
Plugins can specify custom icons that appear next to their name in the web interface tabs. This makes your plugin instantly recognizable and adds visual polish to the UI.
|
||||||
|
|||||||
@@ -1,4 +1,13 @@
|
|||||||
# ✅ Plugin Custom Icons Feature - Complete
|
# Plugin Custom Icons Feature
|
||||||
|
|
||||||
|
> ⚠️ **Status:** this doc describes the v2 web interface
|
||||||
|
> implementation of plugin custom icons. The feature **regressed when
|
||||||
|
> the v3 web interface was built** — the `getPluginIcon()` helper
|
||||||
|
> referenced below lived in `templates/index_v2.html` (which is now
|
||||||
|
> archived) and was not ported to the v3 templates. Plugin tab icons
|
||||||
|
> in v3 are hardcoded to `fas fa-puzzle-piece`
|
||||||
|
> (`web_interface/templates/v3/base.html:515` and `:774`). The
|
||||||
|
> `icon` field in `manifest.json` is currently silently ignored.
|
||||||
|
|
||||||
## What Was Implemented
|
## What Was Implemented
|
||||||
|
|
||||||
@@ -304,7 +313,7 @@ Result: `[logo] Company Metrics` tab
|
|||||||
|
|
||||||
To test custom icons:
|
To test custom icons:
|
||||||
|
|
||||||
1. **Open web interface** at `http://your-pi:5001`
|
1. **Open web interface** at `http://your-pi-ip:5000`
|
||||||
2. **Check installed plugins**:
|
2. **Check installed plugins**:
|
||||||
- Hello World should show 👋
|
- Hello World should show 👋
|
||||||
- Clock Simple should show 🕐
|
- Clock Simple should show 🕐
|
||||||
|
|||||||
@@ -37,7 +37,7 @@ sudo systemctl start ledmatrix-web
|
|||||||
|
|
||||||
### ✅ Scenario 2: Web Interface Plugin Installation
|
### ✅ Scenario 2: Web Interface Plugin Installation
|
||||||
|
|
||||||
**What:** Installing/enabling plugins via web interface at `http://pi-ip:5001`
|
**What:** Installing/enabling plugins via web interface at `http://pi-ip:5000`
|
||||||
|
|
||||||
- **Web service runs as:** root (ledmatrix-web.service)
|
- **Web service runs as:** root (ledmatrix-web.service)
|
||||||
- **Installs to:** System-wide
|
- **Installs to:** System-wide
|
||||||
|
|||||||
@@ -77,10 +77,12 @@ sudo chmod -R 755 /root/.cache
|
|||||||
|
|
||||||
The web interface handles dependency installation correctly in the service context:
|
The web interface handles dependency installation correctly in the service context:
|
||||||
|
|
||||||
1. Access the web interface (usually http://ledpi:8080)
|
1. Access the web interface (`http://ledpi:5000` or `http://your-pi-ip:5000`)
|
||||||
2. Navigate to Plugin Store or Plugin Management
|
2. Open the **Plugin Manager** tab (use the **Plugin Store** section to
|
||||||
3. Install plugins through the web UI
|
find the plugin, or **Install from GitHub**)
|
||||||
4. The system will automatically handle dependencies
|
3. Install the plugin through the web UI
|
||||||
|
4. The system automatically handles dependency installation in the
|
||||||
|
service context (which has the right permissions)
|
||||||
|
|
||||||
## Prevention
|
## Prevention
|
||||||
|
|
||||||
|
|||||||
@@ -12,6 +12,21 @@ When developing plugins in separate repositories, you need a way to:
|
|||||||
|
|
||||||
The solution uses **symbolic links** to connect plugin repositories to the `plugins/` directory, combined with a helper script to manage the linking process.
|
The solution uses **symbolic links** to connect plugin repositories to the `plugins/` directory, combined with a helper script to manage the linking process.
|
||||||
|
|
||||||
|
> **Plugin directory note:** the dev workflow described here puts
|
||||||
|
> symlinks in `plugins/`. The plugin loader's *production* default is
|
||||||
|
> `plugin-repos/` (set by `plugin_system.plugins_directory` in
|
||||||
|
> `config.json`). Importantly, the main discovery path
|
||||||
|
> (`PluginManager.discover_plugins()`) only scans the configured
|
||||||
|
> directory — it does **not** fall back to `plugins/`. Two narrower
|
||||||
|
> paths do: the Plugin Store install/update logic in `store_manager.py`,
|
||||||
|
> and `schema_manager.get_schema_path()` (which the web UI form
|
||||||
|
> generator uses to find `config_schema.json`). That's why plugins
|
||||||
|
> installed via the Plugin Store still work even with symlinks in
|
||||||
|
> `plugins/`, but your own dev plugin won't appear in the rotation
|
||||||
|
> until you either move it to `plugin-repos/` or change
|
||||||
|
> `plugin_system.plugins_directory` to `plugins` in the General tab
|
||||||
|
> of the web UI. The latter is the smoother dev setup.
|
||||||
|
|
||||||
## Quick Start
|
## Quick Start
|
||||||
|
|
||||||
### 1. Link a Plugin from GitHub
|
### 1. Link a Plugin from GitHub
|
||||||
@@ -466,7 +481,9 @@ When developing plugins, you'll need to use the APIs provided by the LEDMatrix s
|
|||||||
|
|
||||||
**Display Manager** (`self.display_manager`):
|
**Display Manager** (`self.display_manager`):
|
||||||
- `clear()`, `update_display()` - Core display operations
|
- `clear()`, `update_display()` - Core display operations
|
||||||
- `draw_text()`, `draw_image()` - Rendering methods
|
- `draw_text()` - Text rendering. For images, paste directly onto
|
||||||
|
`display_manager.image` (a PIL Image) and call `update_display()`;
|
||||||
|
there is no `draw_image()` helper method.
|
||||||
- `draw_weather_icon()`, `draw_sun()`, `draw_cloud()` - Weather icons
|
- `draw_weather_icon()`, `draw_sun()`, `draw_cloud()` - Weather icons
|
||||||
- `get_text_width()`, `get_font_height()` - Text utilities
|
- `get_text_width()`, `get_font_height()` - Text utilities
|
||||||
- `set_scrolling_state()`, `defer_update()` - Scrolling state management
|
- `set_scrolling_state()`, `defer_update()` - Scrolling state management
|
||||||
|
|||||||
@@ -1,5 +1,11 @@
|
|||||||
# LEDMatrix Plugin System - Implementation Summary
|
# LEDMatrix Plugin System - Implementation Summary
|
||||||
|
|
||||||
|
> **Status note:** this is a high-level summary written during the
|
||||||
|
> initial plugin system rollout. Most of it is accurate, but a few
|
||||||
|
> sections describe features that are aspirational or only partially
|
||||||
|
> implemented (per-plugin virtual envs, resource limits, registry
|
||||||
|
> manager). Drift from current reality is called out inline.
|
||||||
|
|
||||||
This document provides a comprehensive overview of the plugin architecture implementation, consolidating details from multiple plugin-related implementation summaries.
|
This document provides a comprehensive overview of the plugin architecture implementation, consolidating details from multiple plugin-related implementation summaries.
|
||||||
|
|
||||||
## Executive Summary
|
## Executive Summary
|
||||||
@@ -14,16 +20,25 @@ The LEDMatrix plugin system transforms the project into a modular, extensible pl
|
|||||||
LEDMatrix/
|
LEDMatrix/
|
||||||
├── src/plugin_system/
|
├── src/plugin_system/
|
||||||
│ ├── base_plugin.py # Plugin interface contract
|
│ ├── base_plugin.py # Plugin interface contract
|
||||||
|
│ ├── plugin_loader.py # Discovery + dynamic import
|
||||||
│ ├── plugin_manager.py # Lifecycle management
|
│ ├── plugin_manager.py # Lifecycle management
|
||||||
│ ├── store_manager.py # GitHub integration
|
│ ├── store_manager.py # GitHub install / store integration
|
||||||
│ └── registry_manager.py # Plugin discovery
|
│ ├── schema_manager.py # Config schema validation
|
||||||
├── plugins/ # User-installed plugins
|
│ ├── health_monitor.py # Plugin health metrics
|
||||||
|
│ ├── operation_queue.py # Async install/update operations
|
||||||
|
│ └── state_manager.py # Persistent plugin state
|
||||||
|
├── plugin-repos/ # Default plugin install location
|
||||||
│ ├── football-scoreboard/
|
│ ├── football-scoreboard/
|
||||||
│ ├── ledmatrix-music/
|
│ ├── ledmatrix-music/
|
||||||
│ └── ledmatrix-stocks/
|
│ └── ledmatrix-stocks/
|
||||||
└── config/config.json # Plugin configurations
|
└── config/config.json # Plugin configurations
|
||||||
```
|
```
|
||||||
|
|
||||||
|
> Earlier drafts of this doc referenced `registry_manager.py`. It was
|
||||||
|
> never created — discovery happens in `plugin_loader.py`. The earlier
|
||||||
|
> default plugin location of `plugins/` has been replaced with
|
||||||
|
> `plugin-repos/` (see `config/config.template.json:130`).
|
||||||
|
|
||||||
### Key Design Decisions
|
### Key Design Decisions
|
||||||
|
|
||||||
✅ **Gradual Migration**: Plugin system added alongside existing managers
|
✅ **Gradual Migration**: Plugin system added alongside existing managers
|
||||||
@@ -77,14 +92,26 @@ LEDMatrix/
|
|||||||
- **Fallback System**: Default icons when custom ones unavailable
|
- **Fallback System**: Default icons when custom ones unavailable
|
||||||
|
|
||||||
#### Dependency Management
|
#### Dependency Management
|
||||||
- **Requirements.txt**: Per-plugin dependencies
|
- **Requirements.txt**: Per-plugin dependencies, installed system-wide
|
||||||
- **Virtual Environments**: Isolated dependency management
|
via pip on first plugin load
|
||||||
- **Version Pinning**: Explicit version constraints
|
- **Version Pinning**: Standard pip version constraints in
|
||||||
|
`requirements.txt`
|
||||||
|
|
||||||
#### Permission System
|
> Earlier plans called for per-plugin virtual environments. That isn't
|
||||||
- **File Access Control**: Configurable file system permissions
|
> implemented — plugin Python deps install into the system Python
|
||||||
- **Network Access**: Controlled API access
|
> environment (or whatever environment the LEDMatrix service is using).
|
||||||
- **Resource Limits**: CPU and memory constraints
|
> Conflicting versions across plugins are not auto-resolved.
|
||||||
|
|
||||||
|
#### Health monitoring
|
||||||
|
- **Resource Monitor** (`src/plugin_system/resource_monitor.py`): tracks
|
||||||
|
CPU and memory metrics per plugin and warns about slow plugins
|
||||||
|
- **Health Monitor** (`src/plugin_system/health_monitor.py`): tracks
|
||||||
|
plugin failures and last-success timestamps
|
||||||
|
|
||||||
|
> Earlier plans called for hard CPU/memory limits and a sandboxed
|
||||||
|
> permission system. Neither is implemented. Plugins run in the same
|
||||||
|
> process as the display loop with full file-system and network access
|
||||||
|
> — review third-party plugin code before installing.
|
||||||
|
|
||||||
## Plugin Development
|
## Plugin Development
|
||||||
|
|
||||||
|
|||||||
@@ -2,14 +2,20 @@
|
|||||||
|
|
||||||
## Overview
|
## Overview
|
||||||
|
|
||||||
Transform LEDMatrix into a modular, plugin-based system where users can create, share, and install custom displays via a GitHub-based store (similar to HACS for Home Assistant).
|
LEDMatrix is a modular, plugin-based system where users create, share,
|
||||||
|
and install custom displays via a GitHub-based store (similar in spirit
|
||||||
|
to HACS for Home Assistant). This page is a quick reference; for the
|
||||||
|
full design see [PLUGIN_ARCHITECTURE_SPEC.md](PLUGIN_ARCHITECTURE_SPEC.md)
|
||||||
|
and [PLUGIN_DEVELOPMENT_GUIDE.md](PLUGIN_DEVELOPMENT_GUIDE.md).
|
||||||
|
|
||||||
## Key Decisions
|
## Key Decisions
|
||||||
|
|
||||||
✅ **Gradual Migration**: Existing managers stay, plugins added alongside
|
✅ **Plugin-First**: All display features (calendar excepted) are now plugins
|
||||||
✅ **Migration Required**: Breaking changes in v3.0, tools provided
|
✅ **GitHub Store**: Discovery from `ledmatrix-plugins` registry plus
|
||||||
✅ **GitHub Store**: Simple discovery, packages from repos
|
any GitHub URL
|
||||||
✅ **Plugin Location**: `./plugins/` directory
|
✅ **Plugin Location**: configured by `plugin_system.plugins_directory`
|
||||||
|
in `config.json` (default `plugin-repos/`; the loader also searches
|
||||||
|
`plugins/` as a fallback)
|
||||||
|
|
||||||
## File Structure
|
## File Structure
|
||||||
|
|
||||||
@@ -19,15 +25,16 @@ LEDMatrix/
|
|||||||
│ └── plugin_system/
|
│ └── plugin_system/
|
||||||
│ ├── base_plugin.py # Plugin interface
|
│ ├── base_plugin.py # Plugin interface
|
||||||
│ ├── plugin_manager.py # Load/unload plugins
|
│ ├── plugin_manager.py # Load/unload plugins
|
||||||
|
│ ├── plugin_loader.py # Discovery + dynamic import
|
||||||
│ └── store_manager.py # Install from GitHub
|
│ └── store_manager.py # Install from GitHub
|
||||||
├── plugins/
|
├── plugin-repos/ # Default plugin install location
|
||||||
│ ├── clock-simple/
|
│ ├── clock-simple/
|
||||||
│ │ ├── manifest.json # Metadata
|
│ │ ├── manifest.json # Metadata
|
||||||
│ │ ├── manager.py # Main plugin class
|
│ │ ├── manager.py # Main plugin class
|
||||||
│ │ ├── requirements.txt # Dependencies
|
│ │ ├── requirements.txt # Dependencies
|
||||||
│ │ ├── config_schema.json # Validation
|
│ │ ├── config_schema.json # Validation
|
||||||
│ │ └── README.md
|
│ │ └── README.md
|
||||||
│ └── nhl-scores/
|
│ └── hockey-scoreboard/
|
||||||
│ └── ... (same structure)
|
│ └── ... (same structure)
|
||||||
└── config/config.json # Plugin configs
|
└── config/config.json # Plugin configs
|
||||||
```
|
```
|
||||||
@@ -109,100 +116,45 @@ git push origin v1.0.0
|
|||||||
|
|
||||||
### Web UI
|
### Web UI
|
||||||
|
|
||||||
1. **Browse Store**: Plugin Store tab → Search/filter
|
1. **Browse Store**: Plugin Manager tab → Plugin Store section → Search/filter
|
||||||
2. **Install**: Click "Install" button
|
2. **Install**: Click **Install** in the plugin's row
|
||||||
3. **Configure**: Plugin Manager → Click ⚙️ Configure
|
3. **Configure**: open the plugin's tab in the second nav row
|
||||||
4. **Enable/Disable**: Toggle switch
|
4. **Enable/Disable**: toggle switch in the **Installed Plugins** list
|
||||||
5. **Reorder**: Drag and drop in rotation list
|
5. **Reorder**: order is set by the position in `display_modes` /
|
||||||
|
plugin order; rearranging via drag-and-drop is not yet supported
|
||||||
|
|
||||||
### API
|
### REST API
|
||||||
|
|
||||||
```python
|
The API is mounted at `/api/v3` (`web_interface/app.py:144`).
|
||||||
# Install plugin
|
|
||||||
POST /api/plugins/install
|
|
||||||
{"plugin_id": "my-plugin"}
|
|
||||||
|
|
||||||
# Install from custom URL
|
|
||||||
POST /api/plugins/install-from-url
|
|
||||||
{"repo_url": "https://github.com/User/plugin"}
|
|
||||||
|
|
||||||
# List installed
|
|
||||||
GET /api/plugins/installed
|
|
||||||
|
|
||||||
# Toggle
|
|
||||||
POST /api/plugins/toggle
|
|
||||||
{"plugin_id": "my-plugin", "enabled": true}
|
|
||||||
```
|
|
||||||
|
|
||||||
### Command Line
|
|
||||||
|
|
||||||
```python
|
|
||||||
from src.plugin_system.store_manager import PluginStoreManager
|
|
||||||
|
|
||||||
store = PluginStoreManager()
|
|
||||||
|
|
||||||
# Install
|
|
||||||
store.install_plugin('nhl-scores')
|
|
||||||
|
|
||||||
# Install from URL
|
|
||||||
store.install_from_url('https://github.com/User/plugin')
|
|
||||||
|
|
||||||
# Update
|
|
||||||
store.update_plugin('nhl-scores')
|
|
||||||
|
|
||||||
# Uninstall
|
|
||||||
store.uninstall_plugin('nhl-scores')
|
|
||||||
```
|
|
||||||
|
|
||||||
## Migration Path
|
|
||||||
|
|
||||||
### Phase 1: v2.0.0 (Plugin Infrastructure)
|
|
||||||
- Plugin system alongside existing managers
|
|
||||||
- 100% backward compatible
|
|
||||||
- Web UI shows plugin store
|
|
||||||
|
|
||||||
### Phase 2: v2.1.0 (Example Plugins)
|
|
||||||
- Reference plugins created
|
|
||||||
- Migration examples
|
|
||||||
- Developer docs
|
|
||||||
|
|
||||||
### Phase 3: v2.2.0 (Migration Tools)
|
|
||||||
- Auto-migration script
|
|
||||||
- Config converter
|
|
||||||
- Testing tools
|
|
||||||
|
|
||||||
### Phase 4: v2.5.0 (Deprecation)
|
|
||||||
- Warnings on legacy managers
|
|
||||||
- Migration guide
|
|
||||||
- 95% backward compatible
|
|
||||||
|
|
||||||
### Phase 5: v3.0.0 (Plugin-Only)
|
|
||||||
- Legacy managers removed from core
|
|
||||||
- Packaged as official plugins
|
|
||||||
- **Breaking change - migration required**
|
|
||||||
|
|
||||||
## Quick Migration
|
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
# 1. Backup
|
# Install plugin from the registry
|
||||||
cp config/config.json config/config.json.backup
|
curl -X POST http://your-pi-ip:5000/api/v3/plugins/install \
|
||||||
|
-H "Content-Type: application/json" \
|
||||||
|
-d '{"plugin_id": "hockey-scoreboard"}'
|
||||||
|
|
||||||
# 2. Run migration
|
# Install from custom URL
|
||||||
python3 scripts/migrate_to_plugins.py
|
curl -X POST http://your-pi-ip:5000/api/v3/plugins/install-from-url \
|
||||||
|
-H "Content-Type: application/json" \
|
||||||
|
-d '{"repo_url": "https://github.com/User/plugin"}'
|
||||||
|
|
||||||
# 3. Review
|
# List installed
|
||||||
cat config/config.json.migrated
|
curl http://your-pi-ip:5000/api/v3/plugins/installed
|
||||||
|
|
||||||
# 4. Apply
|
# Toggle
|
||||||
mv config/config.json.migrated config/config.json
|
curl -X POST http://your-pi-ip:5000/api/v3/plugins/toggle \
|
||||||
|
-H "Content-Type: application/json" \
|
||||||
# 5. Restart
|
-d '{"plugin_id": "hockey-scoreboard", "enabled": true}'
|
||||||
sudo systemctl restart ledmatrix
|
|
||||||
```
|
```
|
||||||
|
|
||||||
|
See [REST_API_REFERENCE.md](REST_API_REFERENCE.md) for the full list.
|
||||||
|
|
||||||
## Plugin Registry Structure
|
## Plugin Registry Structure
|
||||||
|
|
||||||
**ChuckBuilds/ledmatrix-plugin-registry/plugins.json**:
|
The official registry lives at
|
||||||
|
[`ChuckBuilds/ledmatrix-plugins`](https://github.com/ChuckBuilds/ledmatrix-plugins).
|
||||||
|
The Plugin Store reads `plugins.json` at the root of that repo, which
|
||||||
|
follows this shape:
|
||||||
```json
|
```json
|
||||||
{
|
{
|
||||||
"plugins": [
|
"plugins": [
|
||||||
@@ -245,42 +197,30 @@ sudo systemctl restart ledmatrix
|
|||||||
- ✅ Community handles custom displays
|
- ✅ Community handles custom displays
|
||||||
- ✅ Easier to review changes
|
- ✅ Easier to review changes
|
||||||
|
|
||||||
## What's Missing?
|
## Known Limitations
|
||||||
|
|
||||||
This specification covers the technical architecture. Additional considerations:
|
The plugin system is shipped and stable, but some things are still
|
||||||
|
intentionally simple:
|
||||||
|
|
||||||
1. **Sandboxing**: Current design has no isolation (future enhancement)
|
1. **Sandboxing**: plugins run in the same process as the display loop;
|
||||||
2. **Resource Limits**: No CPU/memory limits per plugin (future)
|
there is no isolation. Review code before installing third-party
|
||||||
3. **Plugin Ratings**: Registry needs rating/review system
|
plugins.
|
||||||
4. **Auto-Updates**: Manual update only (could add auto-update)
|
2. **Resource limits**: there's a resource monitor that warns about
|
||||||
5. **Dependency Conflicts**: No automatic resolution
|
slow plugins, but no hard CPU/memory caps.
|
||||||
6. **Version Pinning**: Limited version constraint checking
|
3. **Plugin ratings**: not yet — the Plugin Store shows version,
|
||||||
7. **Plugin Testing**: No automated testing framework
|
author, and category but no community rating system.
|
||||||
8. **Marketplace**: No paid plugins (all free/open source)
|
4. **Auto-updates**: manual via the Plugin Manager tab; no automatic
|
||||||
|
background updates.
|
||||||
## Next Steps
|
5. **Dependency conflicts**: each plugin's `requirements.txt` is
|
||||||
|
installed via pip; conflicting versions across plugins are not
|
||||||
1. ✅ Review this specification
|
resolved automatically.
|
||||||
2. Start Phase 1 implementation
|
6. **Plugin testing framework**: see
|
||||||
3. Create first 3-4 example plugins
|
[HOW_TO_RUN_TESTS.md](HOW_TO_RUN_TESTS.md) and
|
||||||
4. Set up plugin registry repo
|
[DEV_PREVIEW.md](DEV_PREVIEW.md) — there are tools, but no
|
||||||
5. Build web UI components
|
mandatory test gate.
|
||||||
6. Test on Pi hardware
|
|
||||||
7. Release v2.0.0 alpha
|
|
||||||
|
|
||||||
## Questions to Resolve
|
|
||||||
|
|
||||||
Before implementing, consider:
|
|
||||||
|
|
||||||
1. Should we support plugin dependencies (plugin A requires plugin B)?
|
|
||||||
2. How to handle breaking changes in core display_manager API?
|
|
||||||
3. Should plugins be able to add new web UI pages?
|
|
||||||
4. What about plugins that need hardware beyond LED matrix?
|
|
||||||
5. How to prevent malicious plugins?
|
|
||||||
6. Should there be plugin quotas (max API calls, etc.)?
|
|
||||||
7. How to handle plugin conflicts (two clocks competing)?
|
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
**See PLUGIN_ARCHITECTURE_SPEC.md for full details**
|
**See [PLUGIN_ARCHITECTURE_SPEC.md](PLUGIN_ARCHITECTURE_SPEC.md) for the
|
||||||
|
full architectural specification.**
|
||||||
|
|
||||||
|
|||||||
@@ -95,14 +95,14 @@ Official plugin registry for [LEDMatrix](https://github.com/ChuckBuilds/LEDMatri
|
|||||||
|
|
||||||
All plugins can be installed through the LEDMatrix web interface:
|
All plugins can be installed through the LEDMatrix web interface:
|
||||||
|
|
||||||
1. Open web interface (http://your-pi-ip:5050)
|
1. Open web interface (http://your-pi-ip:5000)
|
||||||
2. Go to Plugin Store tab
|
2. Open the **Plugin Manager** tab
|
||||||
3. Browse or search for plugins
|
3. Browse or search the **Plugin Store** section
|
||||||
4. Click Install
|
4. Click **Install**
|
||||||
|
|
||||||
Or via API:
|
Or via API:
|
||||||
```bash
|
```bash
|
||||||
curl -X POST http://your-pi-ip:5050/api/plugins/install \
|
curl -X POST http://your-pi-ip:5000/api/v3/plugins/install \
|
||||||
-d '{"plugin_id": "clock-simple"}'
|
-d '{"plugin_id": "clock-simple"}'
|
||||||
```
|
```
|
||||||
|
|
||||||
@@ -152,7 +152,7 @@ Before submitting, ensure your plugin:
|
|||||||
1. **Test Your Plugin**
|
1. **Test Your Plugin**
|
||||||
```bash
|
```bash
|
||||||
# Install via URL on your Pi
|
# Install via URL on your Pi
|
||||||
curl -X POST http://your-pi:5050/api/plugins/install-from-url \
|
curl -X POST http://your-pi:5000/api/v3/plugins/install-from-url \
|
||||||
-d '{"repo_url": "https://github.com/you/ledmatrix-your-plugin"}'
|
-d '{"repo_url": "https://github.com/you/ledmatrix-your-plugin"}'
|
||||||
```
|
```
|
||||||
|
|
||||||
@@ -311,7 +311,7 @@ git push
|
|||||||
# 1. Receive PR on ledmatrix-plugins repo
|
# 1. Receive PR on ledmatrix-plugins repo
|
||||||
# 2. Review using VERIFICATION.md checklist
|
# 2. Review using VERIFICATION.md checklist
|
||||||
# 3. Test installation:
|
# 3. Test installation:
|
||||||
curl -X POST http://pi:5050/api/plugins/install-from-url \
|
curl -X POST http://pi:5000/api/v3/plugins/install-from-url \
|
||||||
-d '{"repo_url": "https://github.com/contributor/plugin"}'
|
-d '{"repo_url": "https://github.com/contributor/plugin"}'
|
||||||
|
|
||||||
# 4. If approved, merge PR
|
# 4. If approved, merge PR
|
||||||
|
|||||||
@@ -12,7 +12,7 @@ The LEDMatrix Plugin Store allows you to discover, install, and manage display p
|
|||||||
```bash
|
```bash
|
||||||
# Web UI: Plugin Store → Search → Click Install
|
# Web UI: Plugin Store → Search → Click Install
|
||||||
# API:
|
# API:
|
||||||
curl -X POST http://your-pi-ip:5050/api/plugins/install \
|
curl -X POST http://your-pi-ip:5000/api/v3/plugins/install \
|
||||||
-H "Content-Type: application/json" \
|
-H "Content-Type: application/json" \
|
||||||
-d '{"plugin_id": "clock-simple"}'
|
-d '{"plugin_id": "clock-simple"}'
|
||||||
```
|
```
|
||||||
@@ -21,7 +21,7 @@ curl -X POST http://your-pi-ip:5050/api/plugins/install \
|
|||||||
```bash
|
```bash
|
||||||
# Web UI: Plugin Store → "Install from URL" → Paste URL
|
# Web UI: Plugin Store → "Install from URL" → Paste URL
|
||||||
# API:
|
# API:
|
||||||
curl -X POST http://your-pi-ip:5050/api/plugins/install-from-url \
|
curl -X POST http://your-pi-ip:5000/api/v3/plugins/install-from-url \
|
||||||
-H "Content-Type: application/json" \
|
-H "Content-Type: application/json" \
|
||||||
-d '{"repo_url": "https://github.com/user/ledmatrix-plugin"}'
|
-d '{"repo_url": "https://github.com/user/ledmatrix-plugin"}'
|
||||||
```
|
```
|
||||||
@@ -29,20 +29,20 @@ curl -X POST http://your-pi-ip:5050/api/plugins/install-from-url \
|
|||||||
### Manage Plugins
|
### Manage Plugins
|
||||||
```bash
|
```bash
|
||||||
# List installed
|
# List installed
|
||||||
curl "http://your-pi-ip:5050/api/plugins/installed"
|
curl "http://your-pi-ip:5000/api/v3/plugins/installed"
|
||||||
|
|
||||||
# Enable/disable
|
# Enable/disable
|
||||||
curl -X POST http://your-pi-ip:5050/api/plugins/toggle \
|
curl -X POST http://your-pi-ip:5000/api/v3/plugins/toggle \
|
||||||
-H "Content-Type: application/json" \
|
-H "Content-Type: application/json" \
|
||||||
-d '{"plugin_id": "clock-simple", "enabled": true}'
|
-d '{"plugin_id": "clock-simple", "enabled": true}'
|
||||||
|
|
||||||
# Update
|
# Update
|
||||||
curl -X POST http://your-pi-ip:5050/api/plugins/update \
|
curl -X POST http://your-pi-ip:5000/api/v3/plugins/update \
|
||||||
-H "Content-Type: application/json" \
|
-H "Content-Type: application/json" \
|
||||||
-d '{"plugin_id": "clock-simple"}'
|
-d '{"plugin_id": "clock-simple"}'
|
||||||
|
|
||||||
# Uninstall
|
# Uninstall
|
||||||
curl -X POST http://your-pi-ip:5050/api/plugins/uninstall \
|
curl -X POST http://your-pi-ip:5000/api/v3/plugins/uninstall \
|
||||||
-H "Content-Type: application/json" \
|
-H "Content-Type: application/json" \
|
||||||
-d '{"plugin_id": "clock-simple"}'
|
-d '{"plugin_id": "clock-simple"}'
|
||||||
```
|
```
|
||||||
@@ -56,7 +56,7 @@ curl -X POST http://your-pi-ip:5050/api/plugins/uninstall \
|
|||||||
The official plugin store contains curated, verified plugins that have been reviewed by maintainers.
|
The official plugin store contains curated, verified plugins that have been reviewed by maintainers.
|
||||||
|
|
||||||
**Via Web Interface:**
|
**Via Web Interface:**
|
||||||
1. Open the web interface at http://your-pi-ip:5050
|
1. Open the web interface at http://your-pi-ip:5000
|
||||||
2. Navigate to the "Plugin Store" tab
|
2. Navigate to the "Plugin Store" tab
|
||||||
3. Browse or search for plugins
|
3. Browse or search for plugins
|
||||||
4. Click "Install" on the desired plugin
|
4. Click "Install" on the desired plugin
|
||||||
@@ -65,7 +65,7 @@ The official plugin store contains curated, verified plugins that have been revi
|
|||||||
|
|
||||||
**Via REST API:**
|
**Via REST API:**
|
||||||
```bash
|
```bash
|
||||||
curl -X POST http://your-pi-ip:5050/api/plugins/install \
|
curl -X POST http://your-pi-ip:5000/api/v3/plugins/install \
|
||||||
-H "Content-Type: application/json" \
|
-H "Content-Type: application/json" \
|
||||||
-d '{"plugin_id": "clock-simple"}'
|
-d '{"plugin_id": "clock-simple"}'
|
||||||
```
|
```
|
||||||
@@ -101,7 +101,7 @@ Install any plugin directly from a GitHub repository, even if it's not in the of
|
|||||||
|
|
||||||
**Via REST API:**
|
**Via REST API:**
|
||||||
```bash
|
```bash
|
||||||
curl -X POST http://your-pi-ip:5050/api/plugins/install-from-url \
|
curl -X POST http://your-pi-ip:5000/api/v3/plugins/install-from-url \
|
||||||
-H "Content-Type: application/json" \
|
-H "Content-Type: application/json" \
|
||||||
-d '{"repo_url": "https://github.com/user/ledmatrix-my-plugin"}'
|
-d '{"repo_url": "https://github.com/user/ledmatrix-my-plugin"}'
|
||||||
```
|
```
|
||||||
@@ -131,13 +131,13 @@ else:
|
|||||||
**Via REST API:**
|
**Via REST API:**
|
||||||
```bash
|
```bash
|
||||||
# Search by query
|
# Search by query
|
||||||
curl "http://your-pi-ip:5050/api/plugins/store/search?q=hockey"
|
curl "http://your-pi-ip:5000/api/v3/plugins/store/search?q=hockey"
|
||||||
|
|
||||||
# Filter by category
|
# Filter by category
|
||||||
curl "http://your-pi-ip:5050/api/plugins/store/search?category=sports"
|
curl "http://your-pi-ip:5000/api/v3/plugins/store/search?category=sports"
|
||||||
|
|
||||||
# Filter by tags
|
# Filter by tags
|
||||||
curl "http://your-pi-ip:5050/api/plugins/store/search?tags=nhl&tags=hockey"
|
curl "http://your-pi-ip:5000/api/v3/plugins/store/search?tags=nhl&tags=hockey"
|
||||||
```
|
```
|
||||||
|
|
||||||
**Via Python:**
|
**Via Python:**
|
||||||
@@ -168,7 +168,7 @@ results = store.search_plugins(tags=["nhl", "hockey"])
|
|||||||
|
|
||||||
**Via REST API:**
|
**Via REST API:**
|
||||||
```bash
|
```bash
|
||||||
curl "http://your-pi-ip:5050/api/plugins/installed"
|
curl "http://your-pi-ip:5000/api/v3/plugins/installed"
|
||||||
```
|
```
|
||||||
|
|
||||||
**Via Python:**
|
**Via Python:**
|
||||||
@@ -192,7 +192,7 @@ for plugin_id in installed:
|
|||||||
|
|
||||||
**Via REST API:**
|
**Via REST API:**
|
||||||
```bash
|
```bash
|
||||||
curl -X POST http://your-pi-ip:5050/api/plugins/toggle \
|
curl -X POST http://your-pi-ip:5000/api/v3/plugins/toggle \
|
||||||
-H "Content-Type: application/json" \
|
-H "Content-Type: application/json" \
|
||||||
-d '{"plugin_id": "clock-simple", "enabled": true}'
|
-d '{"plugin_id": "clock-simple", "enabled": true}'
|
||||||
```
|
```
|
||||||
@@ -207,7 +207,7 @@ curl -X POST http://your-pi-ip:5050/api/plugins/toggle \
|
|||||||
|
|
||||||
**Via REST API:**
|
**Via REST API:**
|
||||||
```bash
|
```bash
|
||||||
curl -X POST http://your-pi-ip:5050/api/plugins/update \
|
curl -X POST http://your-pi-ip:5000/api/v3/plugins/update \
|
||||||
-H "Content-Type: application/json" \
|
-H "Content-Type: application/json" \
|
||||||
-d '{"plugin_id": "clock-simple"}'
|
-d '{"plugin_id": "clock-simple"}'
|
||||||
```
|
```
|
||||||
@@ -230,7 +230,7 @@ success = store.update_plugin('clock-simple')
|
|||||||
|
|
||||||
**Via REST API:**
|
**Via REST API:**
|
||||||
```bash
|
```bash
|
||||||
curl -X POST http://your-pi-ip:5050/api/plugins/uninstall \
|
curl -X POST http://your-pi-ip:5000/api/v3/plugins/uninstall \
|
||||||
-H "Content-Type: application/json" \
|
-H "Content-Type: application/json" \
|
||||||
-d '{"plugin_id": "clock-simple"}'
|
-d '{"plugin_id": "clock-simple"}'
|
||||||
```
|
```
|
||||||
@@ -351,15 +351,15 @@ All API endpoints return JSON with this structure:
|
|||||||
|
|
||||||
| Method | Endpoint | Description |
|
| Method | Endpoint | Description |
|
||||||
|--------|----------|-------------|
|
|--------|----------|-------------|
|
||||||
| GET | `/api/plugins/store/list` | List all plugins in store |
|
| GET | `/api/v3/plugins/store/list` | List all plugins in store |
|
||||||
| GET | `/api/plugins/store/search` | Search for plugins |
|
| GET | `/api/v3/plugins/store/search` | Search for plugins |
|
||||||
| GET | `/api/plugins/installed` | List installed plugins |
|
| GET | `/api/v3/plugins/installed` | List installed plugins |
|
||||||
| POST | `/api/plugins/install` | Install from registry |
|
| POST | `/api/v3/plugins/install` | Install from registry |
|
||||||
| POST | `/api/plugins/install-from-url` | Install from GitHub URL |
|
| POST | `/api/v3/plugins/install-from-url` | Install from GitHub URL |
|
||||||
| POST | `/api/plugins/uninstall` | Uninstall plugin |
|
| POST | `/api/v3/plugins/uninstall` | Uninstall plugin |
|
||||||
| POST | `/api/plugins/update` | Update plugin |
|
| POST | `/api/v3/plugins/update` | Update plugin |
|
||||||
| POST | `/api/plugins/toggle` | Enable/disable plugin |
|
| POST | `/api/v3/plugins/toggle` | Enable/disable plugin |
|
||||||
| POST | `/api/plugins/config` | Update plugin config |
|
| POST | `/api/v3/plugins/config` | Update plugin config |
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
@@ -369,7 +369,7 @@ All API endpoints return JSON with this structure:
|
|||||||
|
|
||||||
```bash
|
```bash
|
||||||
# Install
|
# Install
|
||||||
curl -X POST http://192.168.1.100:5050/api/plugins/install \
|
curl -X POST http://192.168.1.100:5000/api/v3/plugins/install \
|
||||||
-H "Content-Type: application/json" \
|
-H "Content-Type: application/json" \
|
||||||
-d '{"plugin_id": "clock-simple"}'
|
-d '{"plugin_id": "clock-simple"}'
|
||||||
|
|
||||||
@@ -390,12 +390,12 @@ sudo systemctl restart ledmatrix
|
|||||||
|
|
||||||
```bash
|
```bash
|
||||||
# Install your own plugin during development
|
# Install your own plugin during development
|
||||||
curl -X POST http://192.168.1.100:5050/api/plugins/install-from-url \
|
curl -X POST http://192.168.1.100:5000/api/v3/plugins/install-from-url \
|
||||||
-H "Content-Type: application/json" \
|
-H "Content-Type: application/json" \
|
||||||
-d '{"repo_url": "https://github.com/myusername/ledmatrix-my-custom-plugin"}'
|
-d '{"repo_url": "https://github.com/myusername/ledmatrix-my-custom-plugin"}'
|
||||||
|
|
||||||
# Enable it
|
# Enable it
|
||||||
curl -X POST http://192.168.1.100:5050/api/plugins/toggle \
|
curl -X POST http://192.168.1.100:5000/api/v3/plugins/toggle \
|
||||||
-H "Content-Type: application/json" \
|
-H "Content-Type: application/json" \
|
||||||
-d '{"plugin_id": "my-custom-plugin", "enabled": true}'
|
-d '{"plugin_id": "my-custom-plugin", "enabled": true}'
|
||||||
|
|
||||||
|
|||||||
241
docs/README.md
241
docs/README.md
@@ -1,199 +1,84 @@
|
|||||||
# LEDMatrix Documentation
|
# LEDMatrix Documentation
|
||||||
|
|
||||||
Welcome to the LEDMatrix documentation! This directory contains comprehensive guides, specifications, and reference materials for the LEDMatrix project.
|
This directory contains guides, references, and architectural notes for the
|
||||||
|
LEDMatrix project. If you are setting up a Pi for the first time, start with
|
||||||
|
the [project root README](../README.md) — it covers hardware, OS imaging, and
|
||||||
|
the one-shot installer. The pages here go deeper.
|
||||||
|
|
||||||
## 📚 Documentation Overview
|
## I'm a new user
|
||||||
|
|
||||||
This documentation has been recently consolidated (January 2026) to reduce redundancy while maintaining comprehensive coverage. We've reduced from 51 main documents to 16-17 well-organized files (~68% reduction) by merging duplicates, archiving ephemeral content, and unifying writing styles.
|
1. [GETTING_STARTED.md](GETTING_STARTED.md) — first-time setup walkthrough
|
||||||
|
2. [WEB_INTERFACE_GUIDE.md](WEB_INTERFACE_GUIDE.md) — using the web UI
|
||||||
|
3. [PLUGIN_STORE_GUIDE.md](PLUGIN_STORE_GUIDE.md) — installing and managing plugins
|
||||||
|
4. [WIFI_NETWORK_SETUP.md](WIFI_NETWORK_SETUP.md) — WiFi and AP-mode setup
|
||||||
|
5. [TROUBLESHOOTING.md](TROUBLESHOOTING.md) — common issues and fixes
|
||||||
|
6. [SSH_UNAVAILABLE_AFTER_INSTALL.md](SSH_UNAVAILABLE_AFTER_INSTALL.md) — recovering SSH after install
|
||||||
|
7. [CONFIG_DEBUGGING.md](CONFIG_DEBUGGING.md) — diagnosing config problems
|
||||||
|
|
||||||
## 📖 Quick Start
|
## I want to write a plugin
|
||||||
|
|
||||||
### For New Users
|
Start here:
|
||||||
1. **Installation**: Follow the main [README.md](../README.md) in the project root
|
|
||||||
2. **First Setup**: See [GETTING_STARTED.md](GETTING_STARTED.md) for first-time setup guide
|
|
||||||
3. **Web Interface**: Use [WEB_INTERFACE_GUIDE.md](WEB_INTERFACE_GUIDE.md) to learn the control panel
|
|
||||||
4. **Troubleshooting**: Check [TROUBLESHOOTING.md](TROUBLESHOOTING.md) for common issues
|
|
||||||
|
|
||||||
### For Developers
|
1. [PLUGIN_DEVELOPMENT_GUIDE.md](PLUGIN_DEVELOPMENT_GUIDE.md) — end-to-end workflow
|
||||||
1. **Plugin Development**: See [PLUGIN_DEVELOPMENT_GUIDE.md](PLUGIN_DEVELOPMENT_GUIDE.md) for complete guide
|
2. [PLUGIN_QUICK_REFERENCE.md](PLUGIN_QUICK_REFERENCE.md) — cheat sheet
|
||||||
2. **Advanced Patterns**: Read [ADVANCED_PLUGIN_DEVELOPMENT.md](ADVANCED_PLUGIN_DEVELOPMENT.md) for advanced techniques
|
3. [PLUGIN_API_REFERENCE.md](PLUGIN_API_REFERENCE.md) — display, cache, and plugin-manager APIs
|
||||||
3. **API Reference**: Check [PLUGIN_API_REFERENCE.md](PLUGIN_API_REFERENCE.md) for available methods
|
4. [PLUGIN_ERROR_HANDLING.md](PLUGIN_ERROR_HANDLING.md) — error-handling patterns
|
||||||
4. **Configuration**: See [PLUGIN_CONFIGURATION_GUIDE.md](PLUGIN_CONFIGURATION_GUIDE.md) for config schemas
|
5. [DEV_PREVIEW.md](DEV_PREVIEW.md) — preview plugins on your dev machine without a Pi
|
||||||
|
6. [EMULATOR_SETUP_GUIDE.md](EMULATOR_SETUP_GUIDE.md) — running the matrix emulator
|
||||||
|
|
||||||
### For API Integration
|
Going deeper:
|
||||||
1. **REST API**: See [REST_API_REFERENCE.md](REST_API_REFERENCE.md) for all web interface endpoints
|
|
||||||
2. **Plugin API**: See [PLUGIN_API_REFERENCE.md](PLUGIN_API_REFERENCE.md) for plugin developer APIs
|
|
||||||
3. **Developer Reference**: See [DEVELOPER_QUICK_REFERENCE.md](DEVELOPER_QUICK_REFERENCE.md) for common tasks
|
|
||||||
|
|
||||||
## 📋 Documentation Categories
|
- [ADVANCED_PLUGIN_DEVELOPMENT.md](ADVANCED_PLUGIN_DEVELOPMENT.md) — advanced patterns
|
||||||
|
- [PLUGIN_ARCHITECTURE_SPEC.md](PLUGIN_ARCHITECTURE_SPEC.md) — full plugin-system spec
|
||||||
|
- [PLUGIN_DEPENDENCY_GUIDE.md](PLUGIN_DEPENDENCY_GUIDE.md) /
|
||||||
|
[PLUGIN_DEPENDENCY_TROUBLESHOOTING.md](PLUGIN_DEPENDENCY_TROUBLESHOOTING.md)
|
||||||
|
- [PLUGIN_WEB_UI_ACTIONS.md](PLUGIN_WEB_UI_ACTIONS.md) (+ [example JSON](PLUGIN_WEB_UI_ACTIONS_EXAMPLE.json))
|
||||||
|
- [PLUGIN_CUSTOM_ICONS.md](PLUGIN_CUSTOM_ICONS.md) /
|
||||||
|
[PLUGIN_CUSTOM_ICONS_FEATURE.md](PLUGIN_CUSTOM_ICONS_FEATURE.md)
|
||||||
|
- [PLUGIN_REGISTRY_SETUP_GUIDE.md](PLUGIN_REGISTRY_SETUP_GUIDE.md) (+ [registry template](plugin_registry_template.json))
|
||||||
|
- [STARLARK_APPS_GUIDE.md](STARLARK_APPS_GUIDE.md) — Starlark-based mini-apps
|
||||||
|
- [widget-guide.md](widget-guide.md) — widget development
|
||||||
|
|
||||||
### 🚀 Getting Started & User Guides
|
## Configuring plugins
|
||||||
- [GETTING_STARTED.md](GETTING_STARTED.md) - First-time setup and quick start guide
|
|
||||||
- [WEB_INTERFACE_GUIDE.md](WEB_INTERFACE_GUIDE.md) - Complete web interface user guide
|
|
||||||
- [WIFI_NETWORK_SETUP.md](WIFI_NETWORK_SETUP.md) - WiFi configuration and AP mode setup
|
|
||||||
- [PLUGIN_STORE_GUIDE.md](PLUGIN_STORE_GUIDE.md) - Installing and managing plugins
|
|
||||||
- [TROUBLESHOOTING.md](TROUBLESHOOTING.md) - Common issues and solutions
|
|
||||||
|
|
||||||
### ⚡ Advanced Features
|
- [PLUGIN_CONFIG_QUICK_START.md](PLUGIN_CONFIG_QUICK_START.md) — minimal config you need
|
||||||
- [ADVANCED_FEATURES.md](ADVANCED_FEATURES.md) - Vegas scroll mode, on-demand display, cache management, background services, permissions
|
- [PLUGIN_CONFIGURATION_GUIDE.md](PLUGIN_CONFIGURATION_GUIDE.md) — schema design
|
||||||
|
- [PLUGIN_CONFIGURATION_TABS.md](PLUGIN_CONFIGURATION_TABS.md) — multi-tab UI configs
|
||||||
|
- [PLUGIN_CONFIG_ARCHITECTURE.md](PLUGIN_CONFIG_ARCHITECTURE.md) — how the config system works
|
||||||
|
- [PLUGIN_CONFIG_CORE_PROPERTIES.md](PLUGIN_CONFIG_CORE_PROPERTIES.md) — properties every plugin honors
|
||||||
|
|
||||||
### 🔌 Plugin Development
|
## Advanced features
|
||||||
- [PLUGIN_DEVELOPMENT_GUIDE.md](PLUGIN_DEVELOPMENT_GUIDE.md) - Complete plugin development workflow
|
|
||||||
- [PLUGIN_QUICK_REFERENCE.md](PLUGIN_QUICK_REFERENCE.md) - Plugin development quick reference
|
|
||||||
- [ADVANCED_PLUGIN_DEVELOPMENT.md](ADVANCED_PLUGIN_DEVELOPMENT.md) - Advanced patterns and examples
|
|
||||||
- [PLUGIN_CONFIGURATION_GUIDE.md](PLUGIN_CONFIGURATION_GUIDE.md) - Configuration schema design
|
|
||||||
- [PLUGIN_CONFIGURATION_TABS.md](PLUGIN_CONFIGURATION_TABS.md) - Configuration tabs feature
|
|
||||||
- [PLUGIN_CONFIG_QUICK_START.md](PLUGIN_CONFIG_QUICK_START.md) - Quick configuration guide
|
|
||||||
- [PLUGIN_DEPENDENCY_GUIDE.md](PLUGIN_DEPENDENCY_GUIDE.md) - Managing plugin dependencies
|
|
||||||
- [PLUGIN_DEPENDENCY_TROUBLESHOOTING.md](PLUGIN_DEPENDENCY_TROUBLESHOOTING.md) - Dependency troubleshooting
|
|
||||||
|
|
||||||
### 🏗️ Plugin Features & Extensions
|
- [ADVANCED_FEATURES.md](ADVANCED_FEATURES.md) — Vegas scroll, on-demand display,
|
||||||
- [PLUGIN_CUSTOM_ICONS.md](PLUGIN_CUSTOM_ICONS.md) - Custom plugin icons
|
cache management, background services, permissions
|
||||||
- [PLUGIN_CUSTOM_ICONS_FEATURE.md](PLUGIN_CUSTOM_ICONS_FEATURE.md) - Custom icons implementation
|
- [FONT_MANAGER.md](FONT_MANAGER.md) — font system
|
||||||
- [PLUGIN_IMPLEMENTATION_SUMMARY.md](PLUGIN_IMPLEMENTATION_SUMMARY.md) - Plugin system implementation
|
|
||||||
- [PLUGIN_REGISTRY_SETUP_GUIDE.md](PLUGIN_REGISTRY_SETUP_GUIDE.md) - Setting up plugin registry
|
|
||||||
- [PLUGIN_WEB_UI_ACTIONS.md](PLUGIN_WEB_UI_ACTIONS.md) - Web UI actions for plugins
|
|
||||||
|
|
||||||
### 📡 API Reference
|
## Reference
|
||||||
- [REST_API_REFERENCE.md](REST_API_REFERENCE.md) - Complete REST API documentation (71+ endpoints)
|
|
||||||
- [PLUGIN_API_REFERENCE.md](PLUGIN_API_REFERENCE.md) - Plugin developer API (Display Manager, Cache Manager, Plugin Manager)
|
|
||||||
- [DEVELOPER_QUICK_REFERENCE.md](DEVELOPER_QUICK_REFERENCE.md) - Quick reference for common developer tasks
|
|
||||||
|
|
||||||
### 🏛️ Architecture & Design
|
- [REST_API_REFERENCE.md](REST_API_REFERENCE.md) — all web-interface HTTP endpoints
|
||||||
- [PLUGIN_ARCHITECTURE_SPEC.md](PLUGIN_ARCHITECTURE_SPEC.md) - Complete plugin system specification
|
- [PLUGIN_API_REFERENCE.md](PLUGIN_API_REFERENCE.md) — Python APIs available to plugins
|
||||||
- [PLUGIN_CONFIG_ARCHITECTURE.md](PLUGIN_CONFIG_ARCHITECTURE.md) - Configuration system architecture
|
- [DEVELOPER_QUICK_REFERENCE.md](DEVELOPER_QUICK_REFERENCE.md) — common dev tasks
|
||||||
- [PLUGIN_CONFIG_CORE_PROPERTIES.md](PLUGIN_CONFIG_CORE_PROPERTIES.md) - Core configuration properties
|
- [PLUGIN_IMPLEMENTATION_SUMMARY.md](PLUGIN_IMPLEMENTATION_SUMMARY.md) — what the plugin system actually does
|
||||||
|
|
||||||
### 🛠️ Development & Tools
|
## Contributing to LEDMatrix itself
|
||||||
- [DEVELOPMENT.md](DEVELOPMENT.md) - Development environment setup
|
|
||||||
- [EMULATOR_SETUP_GUIDE.md](EMULATOR_SETUP_GUIDE.md) - Set up development environment with emulator
|
|
||||||
- [HOW_TO_RUN_TESTS.md](HOW_TO_RUN_TESTS.md) - Testing documentation
|
|
||||||
- [MULTI_ROOT_WORKSPACE_SETUP.md](MULTI_ROOT_WORKSPACE_SETUP.md) - Multi-workspace development
|
|
||||||
- [FONT_MANAGER.md](FONT_MANAGER.md) - Font management system
|
|
||||||
|
|
||||||
### 🔄 Migration & Updates
|
- [DEVELOPMENT.md](DEVELOPMENT.md) — environment setup
|
||||||
- [MIGRATION_GUIDE.md](MIGRATION_GUIDE.md) - Breaking changes and migration instructions
|
- [HOW_TO_RUN_TESTS.md](HOW_TO_RUN_TESTS.md) — running the test suite
|
||||||
- [SSH_UNAVAILABLE_AFTER_INSTALL.md](SSH_UNAVAILABLE_AFTER_INSTALL.md) - SSH troubleshooting after install
|
- [MULTI_ROOT_WORKSPACE_SETUP.md](MULTI_ROOT_WORKSPACE_SETUP.md) — multi-repo workspace
|
||||||
|
- [MIGRATION_GUIDE.md](MIGRATION_GUIDE.md) — breaking changes between releases
|
||||||
|
|
||||||
### 📚 Miscellaneous
|
## Archive
|
||||||
- [widget-guide.md](widget-guide.md) - Widget development guide
|
|
||||||
- Template files:
|
|
||||||
- [plugin_registry_template.json](plugin_registry_template.json) - Plugin registry template
|
|
||||||
- [PLUGIN_WEB_UI_ACTIONS_EXAMPLE.json](PLUGIN_WEB_UI_ACTIONS_EXAMPLE.json) - Web UI actions example
|
|
||||||
|
|
||||||
## 🎯 Key Resources by Use Case
|
`docs/archive/` holds older guides that have been superseded or describe
|
||||||
|
features that have been removed. They are kept for historical context and
|
||||||
|
git history but should not be relied on.
|
||||||
|
|
||||||
### I'm new to LEDMatrix
|
## Contributing to the docs
|
||||||
1. [GETTING_STARTED.md](GETTING_STARTED.md) - Start here for first-time setup
|
|
||||||
2. [WEB_INTERFACE_GUIDE.md](WEB_INTERFACE_GUIDE.md) - Learn the control panel
|
|
||||||
3. [PLUGIN_STORE_GUIDE.md](PLUGIN_STORE_GUIDE.md) - Install plugins
|
|
||||||
|
|
||||||
### I want to create a plugin
|
- Markdown only, professional tone, minimal emoji.
|
||||||
1. [PLUGIN_DEVELOPMENT_GUIDE.md](PLUGIN_DEVELOPMENT_GUIDE.md) - Complete development guide
|
- Prefer adding to an existing page over creating a new one. If you add a
|
||||||
2. [PLUGIN_API_REFERENCE.md](PLUGIN_API_REFERENCE.md) - Available methods and APIs
|
new page, link it from this index in the section it belongs to.
|
||||||
3. [ADVANCED_PLUGIN_DEVELOPMENT.md](ADVANCED_PLUGIN_DEVELOPMENT.md) - Advanced patterns
|
- If a page becomes obsolete, move it to `docs/archive/` rather than
|
||||||
4. [PLUGIN_CONFIGURATION_GUIDE.md](PLUGIN_CONFIGURATION_GUIDE.md) - Configuration setup
|
deleting it, so links don't rot.
|
||||||
5. [PLUGIN_ARCHITECTURE_SPEC.md](PLUGIN_ARCHITECTURE_SPEC.md) - Complete specification
|
- Keep examples runnable — paths, commands, and config keys here should
|
||||||
|
match what's actually in the repo.
|
||||||
### I need to troubleshoot an issue
|
|
||||||
1. [TROUBLESHOOTING.md](TROUBLESHOOTING.md) - Comprehensive troubleshooting guide
|
|
||||||
2. [WIFI_NETWORK_SETUP.md](WIFI_NETWORK_SETUP.md) - WiFi/network issues
|
|
||||||
3. [PLUGIN_DEPENDENCY_TROUBLESHOOTING.md](PLUGIN_DEPENDENCY_TROUBLESHOOTING.md) - Dependency issues
|
|
||||||
|
|
||||||
### I want to use advanced features
|
|
||||||
1. [ADVANCED_FEATURES.md](ADVANCED_FEATURES.md) - Vegas scroll, on-demand display, background services
|
|
||||||
2. [FONT_MANAGER.md](FONT_MANAGER.md) - Font management
|
|
||||||
3. [REST_API_REFERENCE.md](REST_API_REFERENCE.md) - API integration
|
|
||||||
|
|
||||||
### I want to understand the architecture
|
|
||||||
1. [PLUGIN_ARCHITECTURE_SPEC.md](PLUGIN_ARCHITECTURE_SPEC.md) - System architecture
|
|
||||||
2. [PLUGIN_CONFIG_ARCHITECTURE.md](PLUGIN_CONFIG_ARCHITECTURE.md) - Configuration architecture
|
|
||||||
3. [PLUGIN_IMPLEMENTATION_SUMMARY.md](PLUGIN_IMPLEMENTATION_SUMMARY.md) - Implementation details
|
|
||||||
|
|
||||||
## 🔄 Recent Consolidations (January 2026)
|
|
||||||
|
|
||||||
### Major Consolidation Effort
|
|
||||||
- **Before**: 51 main documentation files
|
|
||||||
- **After**: 16-17 well-organized files
|
|
||||||
- **Reduction**: ~68% fewer files
|
|
||||||
- **Archived**: 33 files (consolidated sources + ephemeral docs)
|
|
||||||
|
|
||||||
### New Consolidated Guides
|
|
||||||
- **GETTING_STARTED.md** - New first-time user guide
|
|
||||||
- **WEB_INTERFACE_GUIDE.md** - Consolidated web interface documentation
|
|
||||||
- **WIFI_NETWORK_SETUP.md** - Consolidated WiFi setup (5 files → 1)
|
|
||||||
- **PLUGIN_STORE_GUIDE.md** - Consolidated plugin store guides (2 files → 1)
|
|
||||||
- **TROUBLESHOOTING.md** - Consolidated troubleshooting (4 files → 1)
|
|
||||||
- **ADVANCED_FEATURES.md** - Consolidated advanced features (6 files → 1)
|
|
||||||
|
|
||||||
### What Was Archived
|
|
||||||
- Ephemeral debug documents (DEBUG_WEB_ISSUE.md, BROWSER_ERRORS_EXPLANATION.md, etc.)
|
|
||||||
- Implementation summaries (PLUGIN_CONFIG_TABS_SUMMARY.md, STARTUP_OPTIMIZATION_SUMMARY.md, etc.)
|
|
||||||
- Consolidated source files (WIFI_SETUP.md, V3_INTERFACE_README.md, etc.)
|
|
||||||
- Testing documentation (CAPTIVE_PORTAL_TESTING.md, etc.)
|
|
||||||
|
|
||||||
All archived files are preserved in `docs/archive/` with full git history.
|
|
||||||
|
|
||||||
### Benefits
|
|
||||||
- ✅ Easier to find information (fewer files to search)
|
|
||||||
- ✅ No duplicate content
|
|
||||||
- ✅ Consistent writing style (professional technical)
|
|
||||||
- ✅ Updated outdated references
|
|
||||||
- ✅ Fixed broken internal links
|
|
||||||
- ✅ Better organization for users vs developers
|
|
||||||
|
|
||||||
## 📝 Contributing to Documentation
|
|
||||||
|
|
||||||
### Documentation Standards
|
|
||||||
- Use Markdown format with consistent headers
|
|
||||||
- Professional technical writing style
|
|
||||||
- Minimal emojis (1-2 per major section for navigation)
|
|
||||||
- Include code examples where helpful
|
|
||||||
- Provide both quick start and detailed reference sections
|
|
||||||
- Cross-reference related documentation
|
|
||||||
|
|
||||||
### Adding New Documentation
|
|
||||||
1. Consider if content should be added to existing docs first
|
|
||||||
2. Place in appropriate category (see sections above)
|
|
||||||
3. Update this README.md with the new document
|
|
||||||
4. Follow naming conventions (FEATURE_NAME.md)
|
|
||||||
5. Use consistent formatting and voice
|
|
||||||
|
|
||||||
### Consolidation Guidelines
|
|
||||||
- **User Guides**: Consolidate by topic (WiFi, troubleshooting, etc.)
|
|
||||||
- **Developer Guides**: Keep development vs reference vs architecture separate
|
|
||||||
- **Debug Documents**: Archive after issues are resolved
|
|
||||||
- **Implementation Summaries**: Archive completed implementation details
|
|
||||||
- **Ephemeral Content**: Archive, don't keep in main docs
|
|
||||||
|
|
||||||
## 🔗 Related Documentation
|
|
||||||
|
|
||||||
- [Main Project README](../README.md) - Installation and basic usage
|
|
||||||
- [Web Interface README](../web_interface/README.md) - Web interface details
|
|
||||||
- [GitHub Issues](https://github.com/ChuckBuilds/LEDMatrix/issues) - Bug reports and feature requests
|
|
||||||
- [GitHub Discussions](https://github.com/ChuckBuilds/LEDMatrix/discussions) - Community support
|
|
||||||
|
|
||||||
## 📊 Documentation Statistics
|
|
||||||
|
|
||||||
- **Main Documents**: 16-17 files (after consolidation)
|
|
||||||
- **Archived Documents**: 33 files (in docs/archive/)
|
|
||||||
- **Categories**: 9 major sections
|
|
||||||
- **Primary Language**: English
|
|
||||||
- **Format**: Markdown (.md)
|
|
||||||
- **Last Major Update**: January 2026
|
|
||||||
- **Coverage**: Installation, user guides, development, troubleshooting, architecture, API references
|
|
||||||
|
|
||||||
### Documentation Highlights
|
|
||||||
- ✅ Comprehensive user guides for first-time setup
|
|
||||||
- ✅ Complete REST API documentation (71+ endpoints)
|
|
||||||
- ✅ Complete Plugin API reference (Display Manager, Cache Manager, Plugin Manager)
|
|
||||||
- ✅ Advanced plugin development guide with examples
|
|
||||||
- ✅ Consolidated configuration documentation
|
|
||||||
- ✅ Professional technical writing throughout
|
|
||||||
- ✅ ~68% reduction in file count while maintaining coverage
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
*This documentation index was last updated: January 2026*
|
|
||||||
|
|
||||||
*For questions or suggestions about the documentation, please open an issue or start a discussion on GitHub.*
|
|
||||||
|
|||||||
@@ -24,6 +24,17 @@ All endpoints return JSON responses with a standard format:
|
|||||||
- [Cache](#cache)
|
- [Cache](#cache)
|
||||||
- [WiFi](#wifi)
|
- [WiFi](#wifi)
|
||||||
- [Streams](#streams)
|
- [Streams](#streams)
|
||||||
|
- [Logs](#logs)
|
||||||
|
- [Error tracking](#error-tracking)
|
||||||
|
- [Health](#health)
|
||||||
|
- [Schedule (dim/power)](#schedule-dimpower)
|
||||||
|
- [Plugin-specific endpoints](#plugin-specific-endpoints)
|
||||||
|
- [Starlark Apps](#starlark-apps)
|
||||||
|
|
||||||
|
> The API blueprint is mounted at `/api/v3` (`web_interface/app.py:144`).
|
||||||
|
> SSE stream endpoints (`/api/v3/stream/*`) are defined directly on the
|
||||||
|
> Flask app at `app.py:607-615`. There are about 92 routes total — see
|
||||||
|
> `web_interface/blueprints/api_v3.py` for the canonical list.
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
@@ -1201,10 +1212,16 @@ Upload a custom font file.
|
|||||||
|
|
||||||
### Delete Font
|
### Delete Font
|
||||||
|
|
||||||
**DELETE** `/api/v3/fonts/delete/<font_family>`
|
**DELETE** `/api/v3/fonts/<font_family>`
|
||||||
|
|
||||||
Delete an uploaded font.
|
Delete an uploaded font.
|
||||||
|
|
||||||
|
### Font Preview
|
||||||
|
|
||||||
|
**GET** `/api/v3/fonts/preview?family=<font_family>&text=<sample>`
|
||||||
|
|
||||||
|
Render a small preview image of a font for use in the web UI font picker.
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
## Cache
|
## Cache
|
||||||
@@ -1439,6 +1456,130 @@ Get recent log entries.
|
|||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
|
## Error tracking
|
||||||
|
|
||||||
|
### Get Error Summary
|
||||||
|
|
||||||
|
**GET** `/api/v3/errors/summary`
|
||||||
|
|
||||||
|
Aggregated counts of recent errors across all plugins and core
|
||||||
|
components, used by the web UI's error indicator.
|
||||||
|
|
||||||
|
### Get Plugin Errors
|
||||||
|
|
||||||
|
**GET** `/api/v3/errors/plugin/<plugin_id>`
|
||||||
|
|
||||||
|
Recent errors for a specific plugin.
|
||||||
|
|
||||||
|
### Clear Errors
|
||||||
|
|
||||||
|
**POST** `/api/v3/errors/clear`
|
||||||
|
|
||||||
|
Clear the in-memory error aggregator.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Health
|
||||||
|
|
||||||
|
### Health Check
|
||||||
|
|
||||||
|
**GET** `/api/v3/health`
|
||||||
|
|
||||||
|
Lightweight liveness check used by the WiFi monitor and external
|
||||||
|
monitoring tools.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Schedule (dim/power)
|
||||||
|
|
||||||
|
### Get Dim Schedule
|
||||||
|
|
||||||
|
**GET** `/api/v3/config/dim-schedule`
|
||||||
|
|
||||||
|
Read the dim/power schedule that automatically reduces brightness or
|
||||||
|
turns the display off at configured times.
|
||||||
|
|
||||||
|
### Update Dim Schedule
|
||||||
|
|
||||||
|
**POST** `/api/v3/config/dim-schedule`
|
||||||
|
|
||||||
|
Update the dim schedule. Body matches the structure returned by GET.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Plugin-specific endpoints
|
||||||
|
|
||||||
|
A handful of endpoints belong to individual built-in or shipped plugins.
|
||||||
|
|
||||||
|
### Calendar
|
||||||
|
|
||||||
|
**GET** `/api/v3/plugins/calendar/list-calendars`
|
||||||
|
|
||||||
|
List the calendars available on the authenticated Google account.
|
||||||
|
Used by the calendar plugin's config UI.
|
||||||
|
|
||||||
|
### Of The Day
|
||||||
|
|
||||||
|
**POST** `/api/v3/plugins/of-the-day/json/upload`
|
||||||
|
|
||||||
|
Upload a JSON data file for the Of-The-Day plugin's category data.
|
||||||
|
|
||||||
|
**POST** `/api/v3/plugins/of-the-day/json/delete`
|
||||||
|
|
||||||
|
Delete a previously uploaded Of-The-Day data file.
|
||||||
|
|
||||||
|
### Plugin Static Assets
|
||||||
|
|
||||||
|
**GET** `/api/v3/plugins/<plugin_id>/static/<path:file_path>`
|
||||||
|
|
||||||
|
Serve a static asset (image, font, etc.) from a plugin's directory.
|
||||||
|
Used internally by the web UI to render plugin previews and icons.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Starlark Apps
|
||||||
|
|
||||||
|
The Starlark plugin lets you run [Tronbyt](https://github.com/tronbyt/apps)
|
||||||
|
Starlark apps on the matrix. These endpoints expose its UI.
|
||||||
|
|
||||||
|
### Status
|
||||||
|
|
||||||
|
**GET** `/api/v3/starlark/status`
|
||||||
|
|
||||||
|
Returns whether the Pixlet binary is installed and the Starlark plugin
|
||||||
|
is operational.
|
||||||
|
|
||||||
|
### Install Pixlet
|
||||||
|
|
||||||
|
**POST** `/api/v3/starlark/install-pixlet`
|
||||||
|
|
||||||
|
Download and install the Pixlet binary on the Pi.
|
||||||
|
|
||||||
|
### Apps
|
||||||
|
|
||||||
|
**GET** `/api/v3/starlark/apps` — list installed Starlark apps
|
||||||
|
**GET** `/api/v3/starlark/apps/<app_id>` — get app details
|
||||||
|
**DELETE** `/api/v3/starlark/apps/<app_id>` — uninstall an app
|
||||||
|
**GET** `/api/v3/starlark/apps/<app_id>/config` — get app config schema
|
||||||
|
**PUT** `/api/v3/starlark/apps/<app_id>/config` — update app config
|
||||||
|
**POST** `/api/v3/starlark/apps/<app_id>/render` — render app to a frame
|
||||||
|
**POST** `/api/v3/starlark/apps/<app_id>/toggle` — enable/disable app
|
||||||
|
|
||||||
|
### Repository (Tronbyt community apps)
|
||||||
|
|
||||||
|
**GET** `/api/v3/starlark/repository/categories` — browse categories
|
||||||
|
**GET** `/api/v3/starlark/repository/browse?category=<cat>` — browse apps
|
||||||
|
**POST** `/api/v3/starlark/repository/install` — install an app from the
|
||||||
|
community repository
|
||||||
|
|
||||||
|
### Upload custom app
|
||||||
|
|
||||||
|
**POST** `/api/v3/starlark/upload`
|
||||||
|
|
||||||
|
Upload a custom Starlark `.star` file as a new app.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
## Error Responses
|
## Error Responses
|
||||||
|
|
||||||
All endpoints may return error responses in the following format:
|
All endpoints may return error responses in the following format:
|
||||||
|
|||||||
@@ -54,7 +54,7 @@ If the script reboots the Pi (which it recommends), network services may restart
|
|||||||
# Connect to your WiFi network (replace with your SSID and password)
|
# Connect to your WiFi network (replace with your SSID and password)
|
||||||
sudo nmcli device wifi connect "YourWiFiSSID" password "YourPassword"
|
sudo nmcli device wifi connect "YourWiFiSSID" password "YourPassword"
|
||||||
|
|
||||||
# Or use the web interface at http://192.168.4.1:5001
|
# Or use the web interface at http://192.168.4.1:5000
|
||||||
# Navigate to WiFi tab and connect to your network
|
# Navigate to WiFi tab and connect to your network
|
||||||
```
|
```
|
||||||
|
|
||||||
@@ -177,9 +177,9 @@ sudo systemctl restart NetworkManager
|
|||||||
|
|
||||||
Even if SSH is unavailable, you can access the web interface:
|
Even if SSH is unavailable, you can access the web interface:
|
||||||
|
|
||||||
1. **Via AP Mode**: Connect to **LEDMatrix-Setup** network and visit `http://192.168.4.1:5001`
|
1. **Via AP Mode**: Connect to **LEDMatrix-Setup** network and visit `http://192.168.4.1:5000`
|
||||||
2. **Via WiFi**: If WiFi is connected, visit `http://<pi-ip-address>:5001`
|
2. **Via WiFi**: If WiFi is connected, visit `http://<pi-ip-address>:5000`
|
||||||
3. **Via Ethernet**: Visit `http://<pi-ip-address>:5001`
|
3. **Via Ethernet**: Visit `http://<pi-ip-address>:5000`
|
||||||
|
|
||||||
The web interface allows you to:
|
The web interface allows you to:
|
||||||
- Configure WiFi connections
|
- Configure WiFi connections
|
||||||
|
|||||||
@@ -91,7 +91,7 @@ Pixlet is the rendering engine that executes Starlark apps. The plugin will atte
|
|||||||
|
|
||||||
#### Auto-Install via Web UI
|
#### Auto-Install via Web UI
|
||||||
|
|
||||||
Navigate to: **Plugins → Starlark Apps → Status → Install Pixlet**
|
Navigate to: **Plugin Manager → Starlark Apps tab (in the second nav row) → Status → Install Pixlet**
|
||||||
|
|
||||||
This runs the bundled installation script which downloads the appropriate binary for your platform.
|
This runs the bundled installation script which downloads the appropriate binary for your platform.
|
||||||
|
|
||||||
@@ -110,10 +110,10 @@ Verify installation:
|
|||||||
|
|
||||||
### 2. Enable the Starlark Apps Plugin
|
### 2. Enable the Starlark Apps Plugin
|
||||||
|
|
||||||
1. Open the web UI
|
1. Open the web UI (`http://your-pi-ip:5000`)
|
||||||
2. Navigate to **Plugins**
|
2. Open the **Plugin Manager** tab
|
||||||
3. Find **Starlark Apps** in the installed plugins list
|
3. Find **Starlark Apps** in the **Installed Plugins** list
|
||||||
4. Enable the plugin
|
4. Enable the plugin (it then gets its own tab in the second nav row)
|
||||||
5. Configure settings:
|
5. Configure settings:
|
||||||
- **Magnify**: Auto-calculated based on your display size (or set manually)
|
- **Magnify**: Auto-calculated based on your display size (or set manually)
|
||||||
- **Render Interval**: How often apps re-render (default: 300s)
|
- **Render Interval**: How often apps re-render (default: 300s)
|
||||||
@@ -122,7 +122,7 @@ Verify installation:
|
|||||||
|
|
||||||
### 3. Browse and Install Apps
|
### 3. Browse and Install Apps
|
||||||
|
|
||||||
1. Navigate to **Plugins → Starlark Apps → App Store**
|
1. Navigate to **Plugin Manager → Starlark Apps tab (in the second nav row) → App Store**
|
||||||
2. Browse available apps (974+ options)
|
2. Browse available apps (974+ options)
|
||||||
3. Filter by category: Weather, Sports, Finance, Games, Clocks, etc.
|
3. Filter by category: Weather, Sports, Finance, Games, Clocks, etc.
|
||||||
4. Click **Install** on desired apps
|
4. Click **Install** on desired apps
|
||||||
@@ -307,7 +307,7 @@ Many apps require API keys for external services:
|
|||||||
**Symptom**: "Pixlet binary not found" error
|
**Symptom**: "Pixlet binary not found" error
|
||||||
|
|
||||||
**Solutions**:
|
**Solutions**:
|
||||||
1. Run auto-installer: **Plugins → Starlark Apps → Install Pixlet**
|
1. Run auto-installer: **Plugin Manager → Starlark Apps tab (in the second nav row) → Install Pixlet**
|
||||||
2. Manual install: `bash scripts/download_pixlet.sh`
|
2. Manual install: `bash scripts/download_pixlet.sh`
|
||||||
3. Check permissions: `chmod +x bin/pixlet/pixlet-*`
|
3. Check permissions: `chmod +x bin/pixlet/pixlet-*`
|
||||||
4. Verify architecture: `uname -m` matches binary name
|
4. Verify architecture: `uname -m` matches binary name
|
||||||
@@ -338,7 +338,7 @@ Many apps require API keys for external services:
|
|||||||
**Symptom**: Content appears stretched, squished, or cropped
|
**Symptom**: Content appears stretched, squished, or cropped
|
||||||
|
|
||||||
**Solutions**:
|
**Solutions**:
|
||||||
1. Check magnify setting: **Plugins → Starlark Apps → Config**
|
1. Check magnify setting: **Plugin Manager → Starlark Apps tab (in the second nav row) → Config**
|
||||||
2. Try `center_small_output=true` to preserve aspect ratio
|
2. Try `center_small_output=true` to preserve aspect ratio
|
||||||
3. Adjust `magnify` manually (1-8) for your display size
|
3. Adjust `magnify` manually (1-8) for your display size
|
||||||
4. Some apps assume 64×32 - may not scale perfectly to all sizes
|
4. Some apps assume 64×32 - may not scale perfectly to all sizes
|
||||||
@@ -349,7 +349,7 @@ Many apps require API keys for external services:
|
|||||||
|
|
||||||
**Solutions**:
|
**Solutions**:
|
||||||
1. Check render interval: **App Config → Render Interval** (300s default)
|
1. Check render interval: **App Config → Render Interval** (300s default)
|
||||||
2. Force re-render: **Plugins → Starlark Apps → {App} → Render Now**
|
2. Force re-render: **Plugin Manager → Starlark Apps tab (in the second nav row) → {App} → Render Now**
|
||||||
3. Clear cache: Restart LEDMatrix service
|
3. Clear cache: Restart LEDMatrix service
|
||||||
4. API rate limits: Some services throttle requests
|
4. API rate limits: Some services throttle requests
|
||||||
5. Check app logs for API errors
|
5. Check app logs for API errors
|
||||||
|
|||||||
@@ -47,13 +47,15 @@ bash scripts/diagnose_web_interface.sh
|
|||||||
# WiFi setup verification
|
# WiFi setup verification
|
||||||
./scripts/verify_wifi_setup.sh
|
./scripts/verify_wifi_setup.sh
|
||||||
|
|
||||||
# Weather plugin troubleshooting
|
|
||||||
./troubleshoot_weather.sh
|
|
||||||
|
|
||||||
# Captive portal troubleshooting
|
# Captive portal troubleshooting
|
||||||
./scripts/troubleshoot_captive_portal.sh
|
./scripts/troubleshoot_captive_portal.sh
|
||||||
```
|
```
|
||||||
|
|
||||||
|
> Weather is provided by the `ledmatrix-weather` plugin (installed via the
|
||||||
|
> Plugin Store). To troubleshoot weather, check that plugin's tab in the
|
||||||
|
> web UI for its API key and recent error messages, then watch the
|
||||||
|
> **Logs** tab.
|
||||||
|
|
||||||
### 4. Check Configuration
|
### 4. Check Configuration
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
@@ -85,7 +87,7 @@ python3 web_interface/start.py
|
|||||||
#### Service Not Running/Starting
|
#### Service Not Running/Starting
|
||||||
|
|
||||||
**Symptoms:**
|
**Symptoms:**
|
||||||
- Cannot access web interface at http://your-pi-ip:5050
|
- Cannot access web interface at http://your-pi-ip:5000
|
||||||
- `systemctl status ledmatrix-web` shows `inactive (dead)`
|
- `systemctl status ledmatrix-web` shows `inactive (dead)`
|
||||||
|
|
||||||
**Solutions:**
|
**Solutions:**
|
||||||
@@ -157,13 +159,13 @@ sudo systemctl restart ledmatrix-web
|
|||||||
|
|
||||||
**Symptoms:**
|
**Symptoms:**
|
||||||
- Error: `Address already in use`
|
- Error: `Address already in use`
|
||||||
- Service fails to bind to port 5050
|
- Service fails to bind to port 5000
|
||||||
|
|
||||||
**Solutions:**
|
**Solutions:**
|
||||||
|
|
||||||
1. **Check what's using the port:**
|
1. **Check what's using the port:**
|
||||||
```bash
|
```bash
|
||||||
sudo lsof -i :5050
|
sudo lsof -i :5000
|
||||||
```
|
```
|
||||||
|
|
||||||
2. **Kill the conflicting process:**
|
2. **Kill the conflicting process:**
|
||||||
@@ -265,7 +267,7 @@ sudo systemctl cat ledmatrix-web | grep User
|
|||||||
6. **Manually enable AP mode:**
|
6. **Manually enable AP mode:**
|
||||||
```bash
|
```bash
|
||||||
# Via API
|
# Via API
|
||||||
curl -X POST http://localhost:5050/api/wifi/ap/enable
|
curl -X POST http://localhost:5000/api/wifi/ap/enable
|
||||||
|
|
||||||
# Via Python
|
# Via Python
|
||||||
python3 -c "
|
python3 -c "
|
||||||
@@ -291,9 +293,8 @@ sudo systemctl cat ledmatrix-web | grep User
|
|||||||
```
|
```
|
||||||
|
|
||||||
2. **Use correct IP address and port:**
|
2. **Use correct IP address and port:**
|
||||||
- Correct: `http://192.168.4.1:5050`
|
- Correct: `http://192.168.4.1:5000`
|
||||||
- NOT: `http://192.168.4.1` (port 80)
|
- NOT: `http://192.168.4.1` (port 80 — nothing listens there)
|
||||||
- NOT: `http://192.168.4.1:5000`
|
|
||||||
|
|
||||||
3. **Check wlan0 has correct IP:**
|
3. **Check wlan0 has correct IP:**
|
||||||
```bash
|
```bash
|
||||||
@@ -309,7 +310,7 @@ sudo systemctl cat ledmatrix-web | grep User
|
|||||||
|
|
||||||
5. **Test from the Pi itself:**
|
5. **Test from the Pi itself:**
|
||||||
```bash
|
```bash
|
||||||
curl http://192.168.4.1:5050
|
curl http://192.168.4.1:5000
|
||||||
# Should return HTML
|
# Should return HTML
|
||||||
```
|
```
|
||||||
|
|
||||||
@@ -340,11 +341,11 @@ sudo systemctl cat ledmatrix-web | grep User
|
|||||||
|
|
||||||
4. **Manual captive portal testing:**
|
4. **Manual captive portal testing:**
|
||||||
- Try these URLs manually:
|
- Try these URLs manually:
|
||||||
- `http://192.168.4.1:5050`
|
- `http://192.168.4.1:5000`
|
||||||
- `http://captive.apple.com`
|
- `http://captive.apple.com`
|
||||||
- `http://connectivitycheck.gstatic.com/generate_204`
|
- `http://connectivitycheck.gstatic.com/generate_204`
|
||||||
|
|
||||||
#### Firewall Blocking Port 5050
|
#### Firewall Blocking Port 5000
|
||||||
|
|
||||||
**Symptoms:**
|
**Symptoms:**
|
||||||
- Services running but cannot connect
|
- Services running but cannot connect
|
||||||
@@ -357,9 +358,9 @@ sudo systemctl cat ledmatrix-web | grep User
|
|||||||
sudo ufw status
|
sudo ufw status
|
||||||
```
|
```
|
||||||
|
|
||||||
2. **Allow port 5050:**
|
2. **Allow port 5000:**
|
||||||
```bash
|
```bash
|
||||||
sudo ufw allow 5050/tcp
|
sudo ufw allow 5000/tcp
|
||||||
```
|
```
|
||||||
|
|
||||||
3. **Check iptables:**
|
3. **Check iptables:**
|
||||||
@@ -372,7 +373,7 @@ sudo systemctl cat ledmatrix-web | grep User
|
|||||||
sudo ufw disable
|
sudo ufw disable
|
||||||
# Test if it works, then re-enable and add rule
|
# Test if it works, then re-enable and add rule
|
||||||
sudo ufw enable
|
sudo ufw enable
|
||||||
sudo ufw allow 5050/tcp
|
sudo ufw allow 5000/tcp
|
||||||
```
|
```
|
||||||
|
|
||||||
---
|
---
|
||||||
@@ -403,9 +404,9 @@ sudo systemctl cat ledmatrix-web | grep User
|
|||||||
```
|
```
|
||||||
|
|
||||||
3. **Verify in web interface:**
|
3. **Verify in web interface:**
|
||||||
- Navigate to Plugin Management tab
|
- Open the **Plugin Manager** tab
|
||||||
- Toggle the switch to enable
|
- Toggle the plugin switch to enable
|
||||||
- Restart display
|
- From **Overview**, click **Restart Display Service**
|
||||||
|
|
||||||
#### Plugin Not Loading
|
#### Plugin Not Loading
|
||||||
|
|
||||||
@@ -690,12 +691,12 @@ nslookup api.openweathermap.org
|
|||||||
dig api.openweathermap.org
|
dig api.openweathermap.org
|
||||||
|
|
||||||
# Test HTTP endpoint
|
# Test HTTP endpoint
|
||||||
curl -I http://your-pi-ip:5050
|
curl -I http://your-pi-ip:5000
|
||||||
curl http://192.168.4.1:5050
|
curl http://192.168.4.1:5000
|
||||||
|
|
||||||
# Check listening ports
|
# Check listening ports
|
||||||
sudo lsof -i :5050
|
sudo lsof -i :5000
|
||||||
sudo netstat -tuln | grep 5050
|
sudo netstat -tuln | grep 5000
|
||||||
|
|
||||||
# Check network interfaces
|
# Check network interfaces
|
||||||
ip addr show
|
ip addr show
|
||||||
@@ -808,7 +809,7 @@ echo ""
|
|||||||
|
|
||||||
echo "4. Network Status:"
|
echo "4. Network Status:"
|
||||||
ip addr show | grep -E "(wlan|eth|inet )"
|
ip addr show | grep -E "(wlan|eth|inet )"
|
||||||
curl -s http://localhost:5050 > /dev/null && echo "Web interface: OK" || echo "Web interface: FAILED"
|
curl -s http://localhost:5000 > /dev/null && echo "Web interface: OK" || echo "Web interface: FAILED"
|
||||||
echo ""
|
echo ""
|
||||||
|
|
||||||
echo "5. File Structure:"
|
echo "5. File Structure:"
|
||||||
@@ -837,22 +838,22 @@ A properly functioning system should show:
|
|||||||
```
|
```
|
||||||
|
|
||||||
2. **Web Interface Accessible:**
|
2. **Web Interface Accessible:**
|
||||||
- Navigate to http://your-pi-ip:5050
|
- Navigate to http://your-pi-ip:5000
|
||||||
- Page loads successfully
|
- Page loads successfully
|
||||||
- Display preview visible
|
- Display preview visible
|
||||||
|
|
||||||
3. **Logs Show Normal Operation:**
|
3. **Logs Show Normal Operation:**
|
||||||
```
|
```
|
||||||
INFO: Web interface started on port 5050
|
INFO: Web interface started on port 5000
|
||||||
INFO: Loaded X plugins
|
INFO: Loaded X plugins
|
||||||
INFO: Display rotation active
|
INFO: Display rotation active
|
||||||
```
|
```
|
||||||
|
|
||||||
4. **Process Listening on Port:**
|
4. **Process Listening on Port:**
|
||||||
```bash
|
```bash
|
||||||
$ sudo lsof -i :5050
|
$ sudo lsof -i :5000
|
||||||
COMMAND PID USER FD TYPE DEVICE SIZE/OFF NODE NAME
|
COMMAND PID USER FD TYPE DEVICE SIZE/OFF NODE NAME
|
||||||
python3 1234 ledpi 3u IPv4 12345 0t0 TCP *:5050 (LISTEN)
|
python3 1234 ledpi 3u IPv4 12345 0t0 TCP *:5000 (LISTEN)
|
||||||
```
|
```
|
||||||
|
|
||||||
5. **Plugins Loading:**
|
5. **Plugins Loading:**
|
||||||
|
|||||||
@@ -17,7 +17,7 @@ The LEDMatrix web interface provides a complete control panel for managing your
|
|||||||
|
|
||||||
2. Open a web browser and navigate to:
|
2. Open a web browser and navigate to:
|
||||||
```
|
```
|
||||||
http://your-pi-ip:5050
|
http://your-pi-ip:5000
|
||||||
```
|
```
|
||||||
|
|
||||||
3. The interface will load with the Overview tab displaying system stats and a live display preview.
|
3. The interface will load with the Overview tab displaying system stats and a live display preview.
|
||||||
@@ -31,17 +31,28 @@ sudo systemctl status ledmatrix-web
|
|||||||
|
|
||||||
## Navigation
|
## Navigation
|
||||||
|
|
||||||
The interface uses a tab-based layout for easy navigation between features:
|
The interface uses a two-row tab layout. The system tabs are always
|
||||||
|
present:
|
||||||
|
|
||||||
- **Overview** - System stats, quick actions, and display preview
|
- **Overview** — System stats, quick actions, live display preview
|
||||||
- **General Settings** - Timezone, location, and autostart configuration
|
- **General** — Timezone, location, plugin-system settings
|
||||||
- **Display Settings** - Hardware configuration, brightness, and display options
|
- **WiFi** — Network selection and AP-mode setup
|
||||||
- **Durations** - Display rotation timing configuration
|
- **Schedule** — Power and dim schedules
|
||||||
- **Sports Configuration** - Per-league settings and on-demand modes
|
- **Display** — Matrix hardware configuration (rows, cols, hardware
|
||||||
- **Plugin Management** - Install, configure, enable/disable plugins
|
mapping, GPIO slowdown, brightness, PWM)
|
||||||
- **Plugin Store** - Discover and install plugins
|
- **Config Editor** — Raw `config.json` editor with validation
|
||||||
- **Font Management** - Upload fonts, manage overrides, and preview
|
- **Fonts** — Upload and manage fonts
|
||||||
- **Logs** - Real-time log streaming with filtering and search
|
- **Logs** — Real-time log streaming
|
||||||
|
- **Cache** — Cached data inspection and cleanup
|
||||||
|
- **Operation History** — Recent service operations
|
||||||
|
|
||||||
|
A second nav row holds plugin tabs:
|
||||||
|
|
||||||
|
- **Plugin Manager** — browse the **Plugin Store** section, install
|
||||||
|
plugins from GitHub, enable/disable installed plugins
|
||||||
|
- **<plugin-id>** — one tab per installed plugin for its own
|
||||||
|
configuration form (auto-generated from the plugin's
|
||||||
|
`config_schema.json`)
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
@@ -57,131 +68,84 @@ The Overview tab provides at-a-glance information and quick actions:
|
|||||||
- Disk usage
|
- Disk usage
|
||||||
- Network status
|
- Network status
|
||||||
|
|
||||||
**Quick Actions:**
|
**Quick Actions** (verified in `web_interface/templates/v3/partials/overview.html`):
|
||||||
- **Start/Stop Display** - Control the display service
|
- **Start Display** / **Stop Display** — control the display service
|
||||||
- **Restart Display** - Restart to apply configuration changes
|
- **Restart Display Service** — apply configuration changes
|
||||||
- **Test Display** - Run a quick test pattern
|
- **Restart Web Service** — restart the web UI itself
|
||||||
|
- **Update Code** — `git pull` the latest version (stashes local changes)
|
||||||
|
- **Reboot System** / **Shutdown System** — confirm-gated power controls
|
||||||
|
|
||||||
**Display Preview:**
|
**Display Preview:**
|
||||||
- Live preview of what's currently shown on the LED matrix
|
- Live preview of what's currently shown on the LED matrix
|
||||||
- Updates in real-time
|
- Updates in real-time
|
||||||
- Useful for remote monitoring
|
- Useful for remote monitoring
|
||||||
|
|
||||||
### General Settings Tab
|
### General Tab
|
||||||
|
|
||||||
Configure basic system settings:
|
Configure basic system settings:
|
||||||
|
|
||||||
**Timezone:**
|
- **Timezone** — used by all time/date displays
|
||||||
- Set your local timezone for accurate time display
|
- **Location** — city/state/country for weather and other location-aware
|
||||||
- Auto-detects common timezones
|
plugins
|
||||||
|
- **Plugin System Settings** — including the `plugins_directory` (default
|
||||||
|
`plugin-repos/`) used by the plugin loader
|
||||||
|
- **Autostart** options for the display service
|
||||||
|
|
||||||
**Location:**
|
Click **Save** to write changes to `config/config.json`. Most changes
|
||||||
- Set latitude/longitude for location-based features
|
require a display service restart from **Overview**.
|
||||||
- Used by weather plugins and sunrise/sunset calculations
|
|
||||||
|
|
||||||
**Autostart:**
|
### Display Tab
|
||||||
- Enable/disable display autostart on boot
|
|
||||||
- Configure systemd service settings
|
|
||||||
|
|
||||||
**Save Changes:**
|
|
||||||
- Click "Save Configuration" to apply changes
|
|
||||||
- Restart the display for changes to take effect
|
|
||||||
|
|
||||||
### Display Settings Tab
|
|
||||||
|
|
||||||
Configure your LED matrix hardware:
|
Configure your LED matrix hardware:
|
||||||
|
|
||||||
**Matrix Configuration:**
|
**Matrix configuration:**
|
||||||
- Rows: Number of LED rows (typically 32 or 64)
|
- `rows` — LED rows (typically 32 or 64)
|
||||||
- Columns: Number of LED columns (typically 64, 128, or 256)
|
- `cols` — LED columns (typically 64 or 96)
|
||||||
- Chain Length: Number of chained panels
|
- `chain_length` — number of horizontally chained panels
|
||||||
- Parallel Chains: Number of parallel chains
|
- `parallel` — number of parallel chains
|
||||||
|
- `hardware_mapping` — `adafruit-hat-pwm` (with PWM jumper mod),
|
||||||
|
`adafruit-hat` (without), `regular`, or `regular-pi1`
|
||||||
|
- `gpio_slowdown` — must match your Pi model (3 for Pi 3, 4 for Pi 4, etc.)
|
||||||
|
- `brightness` — 0–100%
|
||||||
|
- `pwm_bits`, `pwm_lsb_nanoseconds`, `pwm_dither_bits` — PWM tuning
|
||||||
|
- Dynamic Duration — global cap for plugins that extend their display
|
||||||
|
time based on content
|
||||||
|
|
||||||
**Display Options:**
|
Changes require **Restart Display Service** from the Overview tab.
|
||||||
- Brightness: Adjust LED brightness (0-100%)
|
|
||||||
- Hardware Mapping: GPIO pin mapping
|
|
||||||
- Slowdown GPIO: Timing adjustment for compatibility
|
|
||||||
|
|
||||||
**Save and Apply:**
|
### Plugin Manager Tab
|
||||||
- Changes require a display restart
|
|
||||||
- Use "Test Display" to verify configuration
|
|
||||||
|
|
||||||
### Durations Tab
|
The Plugin Manager has three main sections:
|
||||||
|
|
||||||
Control how long each plugin displays:
|
1. **Installed Plugins** — toggle installed plugins on/off, see version
|
||||||
|
info. Each installed plugin also gets its own tab in the second nav
|
||||||
|
row for its configuration form.
|
||||||
|
2. **Plugin Store** — browse plugins from the official
|
||||||
|
`ledmatrix-plugins` registry. Click **Install** to fetch and
|
||||||
|
install. Filter by category and search.
|
||||||
|
3. **Install from GitHub** — install third-party plugins by pasting a
|
||||||
|
GitHub repository URL. **Install Single Plugin** for a single-plugin
|
||||||
|
repo, **Load Registry** for a multi-plugin monorepo.
|
||||||
|
|
||||||
**Global Settings:**
|
When a plugin is installed and enabled:
|
||||||
- Default Duration: Default time for plugins without specific durations
|
- A new tab for that plugin appears in the second nav row
|
||||||
- Transition Speed: Speed of transitions between plugins
|
- Open the tab to edit its config (auto-generated form from
|
||||||
|
`config_schema.json`)
|
||||||
|
- The tab also exposes **Run On-Demand** / **Stop On-Demand** controls
|
||||||
|
to render that plugin immediately, even if it's disabled in the
|
||||||
|
rotation
|
||||||
|
|
||||||
**Per-Plugin Durations:**
|
### Per-plugin Configuration Tabs
|
||||||
- Set custom display duration for each plugin
|
|
||||||
- Override global default for specific plugins
|
|
||||||
- Measured in seconds
|
|
||||||
|
|
||||||
### Sports Configuration Tab
|
Each installed plugin has its own tab in the second nav row. The form
|
||||||
|
fields are auto-generated from the plugin's `config_schema.json`, so
|
||||||
|
options always match the plugin's current code.
|
||||||
|
|
||||||
Configure sports-specific settings:
|
To temporarily run a plugin outside the normal rotation, use the
|
||||||
|
**Run On-Demand** / **Stop On-Demand** buttons inside its tab. This
|
||||||
|
works even when the plugin is disabled.
|
||||||
|
|
||||||
**Per-League Settings:**
|
### Fonts Tab
|
||||||
- Favorite teams
|
|
||||||
- Show favorite teams only
|
|
||||||
- Include scores/standings
|
|
||||||
- Refresh intervals
|
|
||||||
|
|
||||||
**On-Demand Modes:**
|
|
||||||
- Live Priority: Show live games immediately
|
|
||||||
- Game Day Mode: Enhanced display during game days
|
|
||||||
- Score Alerts: Highlight score changes
|
|
||||||
|
|
||||||
### Plugin Management Tab
|
|
||||||
|
|
||||||
Manage installed plugins:
|
|
||||||
|
|
||||||
**Plugin List:**
|
|
||||||
- View all installed plugins
|
|
||||||
- See plugin status (enabled/disabled)
|
|
||||||
- Check last update time
|
|
||||||
|
|
||||||
**Actions:**
|
|
||||||
- **Enable/Disable**: Toggle plugin using the switch
|
|
||||||
- **Configure**: Click ⚙️ to edit plugin settings
|
|
||||||
- **Update**: Update plugin to latest version
|
|
||||||
- **Uninstall**: Remove plugin completely
|
|
||||||
|
|
||||||
**Configuration:**
|
|
||||||
- Edit plugin-specific settings
|
|
||||||
- Changes are saved to `config/config.json`
|
|
||||||
- Restart display to apply changes
|
|
||||||
|
|
||||||
**Note:** See [PLUGIN_STORE_GUIDE.md](PLUGIN_STORE_GUIDE.md) for information on installing plugins.
|
|
||||||
|
|
||||||
### Plugin Store Tab
|
|
||||||
|
|
||||||
Discover and install new plugins:
|
|
||||||
|
|
||||||
**Browse Plugins:**
|
|
||||||
- View available plugins in the official store
|
|
||||||
- Filter by category (sports, weather, time, finance, etc.)
|
|
||||||
- Search by name, description, or author
|
|
||||||
|
|
||||||
**Install Plugins:**
|
|
||||||
- Click "Install" next to any plugin
|
|
||||||
- Wait for installation to complete
|
|
||||||
- Restart the display to activate
|
|
||||||
|
|
||||||
**Install from URL:**
|
|
||||||
- Install plugins from any GitHub repository
|
|
||||||
- Paste the repository URL in the "Install from URL" section
|
|
||||||
- Review the warning about unverified plugins
|
|
||||||
- Click "Install from URL"
|
|
||||||
|
|
||||||
**Plugin Information:**
|
|
||||||
- View plugin descriptions, ratings, and screenshots
|
|
||||||
- Check compatibility and requirements
|
|
||||||
- Read user reviews (when available)
|
|
||||||
|
|
||||||
### Font Management Tab
|
|
||||||
|
|
||||||
Manage fonts for your display:
|
Manage fonts for your display:
|
||||||
|
|
||||||
@@ -229,37 +193,37 @@ View real-time system logs:
|
|||||||
|
|
||||||
### Changing Display Brightness
|
### Changing Display Brightness
|
||||||
|
|
||||||
1. Navigate to the **Display Settings** tab
|
1. Open the **Display** tab
|
||||||
2. Adjust the **Brightness** slider (0-100%)
|
2. Adjust the **Brightness** slider (0–100)
|
||||||
3. Click **Save Configuration**
|
3. Click **Save**
|
||||||
4. Restart the display for changes to take effect
|
4. Click **Restart Display Service** on the **Overview** tab
|
||||||
|
|
||||||
### Installing a New Plugin
|
### Installing a New Plugin
|
||||||
|
|
||||||
1. Navigate to the **Plugin Store** tab
|
1. Open the **Plugin Manager** tab
|
||||||
2. Browse or search for the desired plugin
|
2. Scroll to the **Plugin Store** section and browse or search
|
||||||
3. Click **Install** next to the plugin
|
3. Click **Install** next to the plugin
|
||||||
4. Wait for installation to complete
|
4. Toggle the plugin on in **Installed Plugins**
|
||||||
5. Restart the display
|
5. Click **Restart Display Service** on **Overview**
|
||||||
6. Enable the plugin in the **Plugin Management** tab
|
|
||||||
|
|
||||||
### Configuring a Plugin
|
### Configuring a Plugin
|
||||||
|
|
||||||
1. Navigate to the **Plugin Management** tab
|
1. Open the plugin's tab in the second nav row (each installed plugin
|
||||||
2. Find the plugin you want to configure
|
has its own tab)
|
||||||
3. Click the ⚙️ **Configure** button
|
2. Edit the auto-generated form
|
||||||
4. Edit the settings in the form
|
3. Click **Save**
|
||||||
5. Click **Save**
|
4. Restart the display service from **Overview**
|
||||||
6. Restart the display to apply changes
|
|
||||||
|
|
||||||
### Setting Favorite Sports Teams
|
### Setting Favorite Sports Teams
|
||||||
|
|
||||||
1. Navigate to the **Sports Configuration** tab
|
Sports favorites live in the relevant plugin's tab — there is no
|
||||||
2. Select the league (NHL, NBA, MLB, NFL)
|
separate "Sports Configuration" tab. For example:
|
||||||
3. Choose your favorite teams from the dropdown
|
|
||||||
4. Enable "Show favorite teams only" if desired
|
1. Install **Hockey Scoreboard** from **Plugin Manager → Plugin Store**
|
||||||
5. Click **Save Configuration**
|
2. Open the **Hockey Scoreboard** tab in the second nav row
|
||||||
6. Restart the display
|
3. Add your favorites under `favorite_teams.<league>` (e.g.
|
||||||
|
`favorite_teams.nhl`)
|
||||||
|
4. Click **Save** and restart the display service
|
||||||
|
|
||||||
### Troubleshooting Display Issues
|
### Troubleshooting Display Issues
|
||||||
|
|
||||||
@@ -296,12 +260,10 @@ The interface is fully responsive and works on mobile devices:
|
|||||||
- Touch-friendly interface
|
- Touch-friendly interface
|
||||||
- Responsive layout adapts to screen size
|
- Responsive layout adapts to screen size
|
||||||
- All features available on mobile
|
- All features available on mobile
|
||||||
- Swipe navigation between tabs
|
|
||||||
|
|
||||||
**Tips for Mobile:**
|
**Tips for Mobile:**
|
||||||
- Use landscape mode for better visibility
|
- Use landscape mode for better visibility
|
||||||
- Pinch to zoom on display preview
|
- Pinch to zoom on display preview
|
||||||
- Long-press for context menus
|
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
@@ -322,15 +284,21 @@ The web interface is built on a REST API that you can access programmatically:
|
|||||||
|
|
||||||
**API Base URL:**
|
**API Base URL:**
|
||||||
```
|
```
|
||||||
http://your-pi-ip:5050/api
|
http://your-pi-ip:5000/api/v3
|
||||||
```
|
```
|
||||||
|
|
||||||
|
The API blueprint mounts at `/api/v3` (see
|
||||||
|
`web_interface/app.py:144`). All endpoints below are relative to that
|
||||||
|
base.
|
||||||
|
|
||||||
**Common Endpoints:**
|
**Common Endpoints:**
|
||||||
- `GET /api/config/main` - Get configuration
|
- `GET /api/v3/config/main` — Get main configuration
|
||||||
- `POST /api/config/main` - Update configuration
|
- `POST /api/v3/config/main` — Update main configuration
|
||||||
- `GET /api/system/status` - Get system status
|
- `GET /api/v3/system/status` — Get system status
|
||||||
- `POST /api/system/action` - Control display (start/stop/restart)
|
- `POST /api/v3/system/action` — Control display (start/stop/restart, reboot, etc.)
|
||||||
- `GET /api/plugins/installed` - List installed plugins
|
- `GET /api/v3/plugins/installed` — List installed plugins
|
||||||
|
- `POST /api/v3/plugins/install` — Install a plugin from the store
|
||||||
|
- `POST /api/v3/plugins/install-from-url` — Install a plugin from a GitHub URL
|
||||||
|
|
||||||
**Note:** See [REST_API_REFERENCE.md](REST_API_REFERENCE.md) for complete API documentation.
|
**Note:** See [REST_API_REFERENCE.md](REST_API_REFERENCE.md) for complete API documentation.
|
||||||
|
|
||||||
@@ -353,7 +321,7 @@ http://your-pi-ip:5050/api
|
|||||||
sudo systemctl start ledmatrix-web
|
sudo systemctl start ledmatrix-web
|
||||||
```
|
```
|
||||||
|
|
||||||
3. Check that port 5050 is not blocked by firewall
|
3. Check that port 5000 is not blocked by firewall
|
||||||
4. Verify the Pi's IP address is correct
|
4. Verify the Pi's IP address is correct
|
||||||
|
|
||||||
### Changes Not Applying
|
### Changes Not Applying
|
||||||
@@ -429,7 +397,12 @@ The web interface uses modern web technologies:
|
|||||||
- Web service: `sudo journalctl -u ledmatrix-web -f`
|
- Web service: `sudo journalctl -u ledmatrix-web -f`
|
||||||
|
|
||||||
**Plugins:**
|
**Plugins:**
|
||||||
- Plugin directory: `/plugins/`
|
- Plugin directory: configurable via
|
||||||
|
`plugin_system.plugins_directory` in `config.json` (default
|
||||||
|
`plugin-repos/`). Main plugin discovery only scans this directory;
|
||||||
|
the Plugin Store install flow and the schema loader additionally
|
||||||
|
probe `plugins/` so dev symlinks created by
|
||||||
|
`scripts/dev/dev_plugin_setup.sh` keep working.
|
||||||
- Plugin config: `/config/config.json` (per-plugin sections)
|
- Plugin config: `/config/config.json` (per-plugin sections)
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|||||||
@@ -21,13 +21,15 @@ The LEDMatrix WiFi system provides automatic network configuration with intellig
|
|||||||
|
|
||||||
**If not connected to WiFi:**
|
**If not connected to WiFi:**
|
||||||
1. Wait 90 seconds after boot (AP mode activation grace period)
|
1. Wait 90 seconds after boot (AP mode activation grace period)
|
||||||
2. Connect to WiFi network: **LEDMatrix-Setup** (open network)
|
2. Connect to WiFi network **LEDMatrix-Setup** (default password
|
||||||
3. Open browser to: `http://192.168.4.1:5050`
|
`ledmatrix123` — change it in `config/wifi_config.json` if you want
|
||||||
4. Navigate to the WiFi tab
|
an open network or a different password)
|
||||||
|
3. Open browser to: `http://192.168.4.1:5000`
|
||||||
|
4. Open the **WiFi** tab
|
||||||
5. Scan, select your network, and connect
|
5. Scan, select your network, and connect
|
||||||
|
|
||||||
**If already connected:**
|
**If already connected:**
|
||||||
1. Open browser to: `http://your-pi-ip:5050`
|
1. Open browser to: `http://your-pi-ip:5000`
|
||||||
2. Navigate to the WiFi tab
|
2. Navigate to the WiFi tab
|
||||||
3. Configure as needed
|
3. Configure as needed
|
||||||
|
|
||||||
@@ -76,7 +78,7 @@ WiFi settings are stored in `config/wifi_config.json`:
|
|||||||
```json
|
```json
|
||||||
{
|
{
|
||||||
"ap_ssid": "LEDMatrix-Setup",
|
"ap_ssid": "LEDMatrix-Setup",
|
||||||
"ap_password": "",
|
"ap_password": "ledmatrix123",
|
||||||
"ap_channel": 7,
|
"ap_channel": 7,
|
||||||
"auto_enable_ap_mode": true,
|
"auto_enable_ap_mode": true,
|
||||||
"saved_networks": [
|
"saved_networks": [
|
||||||
@@ -93,10 +95,10 @@ WiFi settings are stored in `config/wifi_config.json`:
|
|||||||
|
|
||||||
| Setting | Default | Description |
|
| Setting | Default | Description |
|
||||||
|---------|---------|-------------|
|
|---------|---------|-------------|
|
||||||
| `ap_ssid` | `LEDMatrix-Setup` | Network name for AP mode |
|
| `ap_ssid` | `LEDMatrix-Setup` | Network name broadcast in AP mode |
|
||||||
| `ap_password` | `` (empty) | AP password (empty = open network) |
|
| `ap_password` | `ledmatrix123` | AP password. Set to `""` to make the network open (no password). |
|
||||||
| `ap_channel` | `7` | WiFi channel (use 1, 6, or 11 for non-overlapping) |
|
| `ap_channel` | `7` | WiFi channel (1, 6, or 11 are non-overlapping) |
|
||||||
| `auto_enable_ap_mode` | `true` | Automatically enable AP mode when disconnected |
|
| `auto_enable_ap_mode` | `true` | Automatically enable AP mode when both WiFi and Ethernet are disconnected |
|
||||||
| `saved_networks` | `[]` | Array of saved WiFi credentials |
|
| `saved_networks` | `[]` | Array of saved WiFi credentials |
|
||||||
|
|
||||||
### Auto-Enable AP Mode Behavior
|
### Auto-Enable AP Mode Behavior
|
||||||
@@ -130,10 +132,10 @@ WiFi settings are stored in `config/wifi_config.json`:
|
|||||||
**Via API:**
|
**Via API:**
|
||||||
```bash
|
```bash
|
||||||
# Scan for networks
|
# Scan for networks
|
||||||
curl "http://your-pi-ip:5050/api/wifi/scan"
|
curl "http://your-pi-ip:5000/api/v3/wifi/scan"
|
||||||
|
|
||||||
# Connect to network
|
# Connect to network
|
||||||
curl -X POST http://your-pi-ip:5050/api/wifi/connect \
|
curl -X POST http://your-pi-ip:5000/api/v3/wifi/connect \
|
||||||
-H "Content-Type: application/json" \
|
-H "Content-Type: application/json" \
|
||||||
-d '{"ssid": "YourNetwork", "password": "your-password"}'
|
-d '{"ssid": "YourNetwork", "password": "your-password"}'
|
||||||
```
|
```
|
||||||
@@ -147,10 +149,10 @@ curl -X POST http://your-pi-ip:5050/api/wifi/connect \
|
|||||||
**Via API:**
|
**Via API:**
|
||||||
```bash
|
```bash
|
||||||
# Enable AP mode
|
# Enable AP mode
|
||||||
curl -X POST http://your-pi-ip:5050/api/wifi/ap/enable
|
curl -X POST http://your-pi-ip:5000/api/v3/wifi/ap/enable
|
||||||
|
|
||||||
# Disable AP mode
|
# Disable AP mode
|
||||||
curl -X POST http://your-pi-ip:5050/api/wifi/ap/disable
|
curl -X POST http://your-pi-ip:5000/api/v3/wifi/ap/disable
|
||||||
```
|
```
|
||||||
|
|
||||||
**Note:** Manual enable still requires both WiFi and Ethernet to be disconnected.
|
**Note:** Manual enable still requires both WiFi and Ethernet to be disconnected.
|
||||||
@@ -211,16 +213,17 @@ The system checks connections in this order:
|
|||||||
|
|
||||||
### AP Mode Settings
|
### AP Mode Settings
|
||||||
|
|
||||||
- **SSID**: LEDMatrix-Setup (configurable)
|
- **SSID**: `LEDMatrix-Setup` (configurable via `ap_ssid`)
|
||||||
- **Network**: Open (no password by default)
|
- **Network**: WPA2, default password `ledmatrix123` (configurable via
|
||||||
|
`ap_password` — set to `""` for an open network)
|
||||||
- **IP Address**: 192.168.4.1
|
- **IP Address**: 192.168.4.1
|
||||||
- **DHCP Range**: 192.168.4.2 - 192.168.4.20
|
- **DHCP Range**: 192.168.4.2 – 192.168.4.20
|
||||||
- **Channel**: 7 (configurable)
|
- **Channel**: 7 (configurable via `ap_channel`)
|
||||||
|
|
||||||
### Accessing Services in AP Mode
|
### Accessing Services in AP Mode
|
||||||
|
|
||||||
When AP mode is active:
|
When AP mode is active:
|
||||||
- Web Interface: `http://192.168.4.1:5050`
|
- Web Interface: `http://192.168.4.1:5000`
|
||||||
- SSH: `ssh ledpi@192.168.4.1`
|
- SSH: `ssh ledpi@192.168.4.1`
|
||||||
- Captive portal may automatically redirect browsers
|
- Captive portal may automatically redirect browsers
|
||||||
|
|
||||||
@@ -237,7 +240,9 @@ When AP mode is active:
|
|||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
**Note:** The default is an open network for easy initial setup. For deployments in public areas, consider adding a password.
|
**Note:** The default password is `ledmatrix123` for easy initial
|
||||||
|
setup. Change it for any deployment in a public area, or set
|
||||||
|
`ap_password` to `""` if you specifically want an open network.
|
||||||
|
|
||||||
**2. Use Non-Overlapping WiFi Channels:**
|
**2. Use Non-Overlapping WiFi Channels:**
|
||||||
- Channels 1, 6, 11 are non-overlapping (2.4GHz)
|
- Channels 1, 6, 11 are non-overlapping (2.4GHz)
|
||||||
@@ -398,7 +403,7 @@ Interface should exist
|
|||||||
|
|
||||||
**Check 4: Try Manual Enable**
|
**Check 4: Try Manual Enable**
|
||||||
- Use web interface: WiFi tab → Enable AP Mode
|
- Use web interface: WiFi tab → Enable AP Mode
|
||||||
- Or via API: `curl -X POST http://localhost:5050/api/wifi/ap/enable`
|
- Or via API: `curl -X POST http://localhost:5000/api/v3/wifi/ap/enable`
|
||||||
|
|
||||||
### Cannot Connect to WiFi Network
|
### Cannot Connect to WiFi Network
|
||||||
|
|
||||||
@@ -551,36 +556,36 @@ The WiFi setup feature exposes the following API endpoints:
|
|||||||
|
|
||||||
| Method | Endpoint | Description |
|
| Method | Endpoint | Description |
|
||||||
|--------|----------|-------------|
|
|--------|----------|-------------|
|
||||||
| GET | `/api/wifi/status` | Get current WiFi connection status |
|
| GET | `/api/v3/wifi/status` | Get current WiFi connection status |
|
||||||
| GET | `/api/wifi/scan` | Scan for available WiFi networks |
|
| GET | `/api/v3/wifi/scan` | Scan for available WiFi networks |
|
||||||
| POST | `/api/wifi/connect` | Connect to a WiFi network |
|
| POST | `/api/v3/wifi/connect` | Connect to a WiFi network |
|
||||||
| POST | `/api/wifi/ap/enable` | Enable access point mode |
|
| POST | `/api/v3/wifi/ap/enable` | Enable access point mode |
|
||||||
| POST | `/api/wifi/ap/disable` | Disable access point mode |
|
| POST | `/api/v3/wifi/ap/disable` | Disable access point mode |
|
||||||
| GET | `/api/wifi/ap/auto-enable` | Get auto-enable setting |
|
| GET | `/api/v3/wifi/ap/auto-enable` | Get auto-enable setting |
|
||||||
| POST | `/api/wifi/ap/auto-enable` | Set auto-enable setting |
|
| POST | `/api/v3/wifi/ap/auto-enable` | Set auto-enable setting |
|
||||||
|
|
||||||
### Example Usage
|
### Example Usage
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
# Get WiFi status
|
# Get WiFi status
|
||||||
curl "http://your-pi-ip:5050/api/wifi/status"
|
curl "http://your-pi-ip:5000/api/v3/wifi/status"
|
||||||
|
|
||||||
# Scan for networks
|
# Scan for networks
|
||||||
curl "http://your-pi-ip:5050/api/wifi/scan"
|
curl "http://your-pi-ip:5000/api/v3/wifi/scan"
|
||||||
|
|
||||||
# Connect to network
|
# Connect to network
|
||||||
curl -X POST http://your-pi-ip:5050/api/wifi/connect \
|
curl -X POST http://your-pi-ip:5000/api/v3/wifi/connect \
|
||||||
-H "Content-Type: application/json" \
|
-H "Content-Type: application/json" \
|
||||||
-d '{"ssid": "MyNetwork", "password": "mypassword"}'
|
-d '{"ssid": "MyNetwork", "password": "mypassword"}'
|
||||||
|
|
||||||
# Enable AP mode
|
# Enable AP mode
|
||||||
curl -X POST http://your-pi-ip:5050/api/wifi/ap/enable
|
curl -X POST http://your-pi-ip:5000/api/v3/wifi/ap/enable
|
||||||
|
|
||||||
# Check auto-enable setting
|
# Check auto-enable setting
|
||||||
curl "http://your-pi-ip:5050/api/wifi/ap/auto-enable"
|
curl "http://your-pi-ip:5000/api/v3/wifi/ap/auto-enable"
|
||||||
|
|
||||||
# Set auto-enable
|
# Set auto-enable
|
||||||
curl -X POST http://your-pi-ip:5050/api/wifi/ap/auto-enable \
|
curl -X POST http://your-pi-ip:5000/api/v3/wifi/ap/auto-enable \
|
||||||
-H "Content-Type: application/json" \
|
-H "Content-Type: application/json" \
|
||||||
-d '{"auto_enable_ap_mode": true}'
|
-d '{"auto_enable_ap_mode": true}'
|
||||||
```
|
```
|
||||||
|
|||||||
@@ -48,3 +48,25 @@ pytest>=7.4.0,<8.0.0
|
|||||||
pytest-cov>=4.1.0,<5.0.0
|
pytest-cov>=4.1.0,<5.0.0
|
||||||
pytest-mock>=3.11.0,<4.0.0
|
pytest-mock>=3.11.0,<4.0.0
|
||||||
mypy>=1.5.0,<2.0.0
|
mypy>=1.5.0,<2.0.0
|
||||||
|
|
||||||
|
# ───────────────────────────────────────────────────────────────────────
|
||||||
|
# Optional dependencies — the code imports these inside try/except
|
||||||
|
# blocks and gracefully degrades when missing. Install them for the
|
||||||
|
# full feature set, or skip them for a minimal install.
|
||||||
|
# ───────────────────────────────────────────────────────────────────────
|
||||||
|
#
|
||||||
|
# scipy — sub-pixel interpolation in
|
||||||
|
# src/common/scroll_helper.py for smoother
|
||||||
|
# scrolling. Falls back to a simpler shift algorithm.
|
||||||
|
# pip install 'scipy>=1.10.0,<2.0.0'
|
||||||
|
#
|
||||||
|
# psutil — per-plugin resource monitoring in
|
||||||
|
# src/plugin_system/resource_monitor.py. The monitor
|
||||||
|
# silently no-ops when missing (PSUTIL_AVAILABLE = False).
|
||||||
|
# pip install 'psutil>=5.9.0,<6.0.0'
|
||||||
|
#
|
||||||
|
# Flask-Limiter — request rate limiting in web_interface/app.py
|
||||||
|
# (accidental-abuse protection, not security). The
|
||||||
|
# web interface starts without rate limiting when
|
||||||
|
# this is missing.
|
||||||
|
# pip install 'Flask-Limiter>=3.5.0,<4.0.0'
|
||||||
|
|||||||
@@ -1,29 +1,40 @@
|
|||||||
# NBA Logo Downloader
|
# NBA Logo Downloader
|
||||||
|
|
||||||
This script downloads all NBA team logos from the ESPN API and saves them in the `assets/sports/nba_logos/` directory for use with the NBA leaderboard.
|
This script downloads all NBA team logos from the ESPN API and saves
|
||||||
|
them in the `assets/sports/nba_logos/` directory.
|
||||||
|
|
||||||
|
> **Heads up:** the NBA leaderboard and basketball scoreboards now
|
||||||
|
> live as plugins in the
|
||||||
|
> [`ledmatrix-plugins`](https://github.com/ChuckBuilds/ledmatrix-plugins)
|
||||||
|
> repo (`basketball-scoreboard`, `ledmatrix-leaderboard`). Those
|
||||||
|
> plugins download the logos they need automatically on first display.
|
||||||
|
> This standalone script is mainly useful when you want to pre-populate
|
||||||
|
> the assets directory ahead of time, or for development/debugging.
|
||||||
|
|
||||||
|
All commands below should be run from the LEDMatrix project root.
|
||||||
|
|
||||||
## Usage
|
## Usage
|
||||||
|
|
||||||
### Basic Usage
|
### Basic Usage
|
||||||
```bash
|
```bash
|
||||||
python download_nba_logos.py
|
python3 scripts/download_nba_logos.py
|
||||||
```
|
```
|
||||||
|
|
||||||
### Force Re-download
|
### Force Re-download
|
||||||
If you want to re-download all logos (even if they already exist):
|
If you want to re-download all logos (even if they already exist):
|
||||||
```bash
|
```bash
|
||||||
python download_nba_logos.py --force
|
python3 scripts/download_nba_logos.py --force
|
||||||
```
|
```
|
||||||
|
|
||||||
### Quiet Mode
|
### Quiet Mode
|
||||||
Reduce logging output:
|
Reduce logging output:
|
||||||
```bash
|
```bash
|
||||||
python download_nba_logos.py --quiet
|
python3 scripts/download_nba_logos.py --quiet
|
||||||
```
|
```
|
||||||
|
|
||||||
### Combined Options
|
### Combined Options
|
||||||
```bash
|
```bash
|
||||||
python download_nba_logos.py --force --quiet
|
python3 scripts/download_nba_logos.py --force --quiet
|
||||||
```
|
```
|
||||||
|
|
||||||
## What It Does
|
## What It Does
|
||||||
@@ -82,12 +93,14 @@ assets/sports/nba_logos/
|
|||||||
└── WAS.png # Washington Wizards
|
└── WAS.png # Washington Wizards
|
||||||
```
|
```
|
||||||
|
|
||||||
## Integration with NBA Leaderboard
|
## Integration with NBA plugins
|
||||||
|
|
||||||
Once the logos are downloaded, the NBA leaderboard will:
|
Once the logos are in `assets/sports/nba_logos/`, both the
|
||||||
- ✅ Use local logos instantly (no download delays)
|
`basketball-scoreboard` and `ledmatrix-leaderboard` plugins will pick
|
||||||
- ✅ Display team logos in the scrolling leaderboard
|
them up automatically and skip their own first-run download. This is
|
||||||
- ✅ Show proper team branding for all 30 NBA teams
|
useful if you want to deploy a Pi without internet access to ESPN, or
|
||||||
|
if you want to preview the display on your dev machine without
|
||||||
|
waiting for downloads.
|
||||||
|
|
||||||
## Troubleshooting
|
## Troubleshooting
|
||||||
|
|
||||||
@@ -102,6 +115,6 @@ This is normal - some teams might have temporary API issues or the ESPN API migh
|
|||||||
|
|
||||||
## Requirements
|
## Requirements
|
||||||
|
|
||||||
- Python 3.7+
|
- Python 3.9+ (matches the project's overall minimum)
|
||||||
- `requests` library (should be installed with the project)
|
- `requests` library (already in `requirements.txt`)
|
||||||
- Write access to `assets/sports/nba_logos/` directory
|
- Write access to `assets/sports/nba_logos/` directory
|
||||||
|
|||||||
70
scripts/fix_perms/README.md
Normal file
70
scripts/fix_perms/README.md
Normal file
@@ -0,0 +1,70 @@
|
|||||||
|
# Permission Fix Scripts
|
||||||
|
|
||||||
|
This directory contains shell scripts for repairing file/directory
|
||||||
|
permissions on a LEDMatrix installation. They're typically only needed
|
||||||
|
when something has gone wrong — for example, after running parts of the
|
||||||
|
install as the wrong user, after a manual file copy that didn't preserve
|
||||||
|
ownership, or after a permissions-related error from the display or
|
||||||
|
web service.
|
||||||
|
|
||||||
|
Most of these scripts require `sudo` since they touch directories
|
||||||
|
owned by the `ledmatrix` service user or by `root`.
|
||||||
|
|
||||||
|
## Scripts
|
||||||
|
|
||||||
|
- **`fix_assets_permissions.sh`** — Fixes ownership and write
|
||||||
|
permissions on the `assets/` tree so plugins can download and cache
|
||||||
|
team logos, fonts, and other static content.
|
||||||
|
|
||||||
|
- **`fix_cache_permissions.sh`** — Fixes permissions on every cache
|
||||||
|
directory the project may use (`/var/cache/ledmatrix/`,
|
||||||
|
`~/.cache/ledmatrix/`, `/opt/ledmatrix/cache/`, project-local
|
||||||
|
`cache/`). Also creates placeholder logo subdirectories used by the
|
||||||
|
sports plugins.
|
||||||
|
|
||||||
|
- **`fix_plugin_permissions.sh`** — Fixes ownership on the plugins
|
||||||
|
directory so both the root display service and the web service user
|
||||||
|
can read and write plugin files (manifests, configs, requirements
|
||||||
|
installs).
|
||||||
|
|
||||||
|
- **`fix_web_permissions.sh`** — Fixes permissions on log files,
|
||||||
|
systemd journal access, and the sudoers entries the web interface
|
||||||
|
needs to control the display service.
|
||||||
|
|
||||||
|
- **`fix_nhl_cache.sh`** — Targeted fix for NHL plugin cache issues
|
||||||
|
(clears the NHL cache and restarts the display service).
|
||||||
|
|
||||||
|
- **`safe_plugin_rm.sh`** — Validates that a plugin removal path is
|
||||||
|
inside an allowed base directory before deleting it. Used by the web
|
||||||
|
interface (via sudo) when a user clicks **Uninstall** on a plugin —
|
||||||
|
prevents path-traversal abuse from the web UI.
|
||||||
|
|
||||||
|
## When to use these
|
||||||
|
|
||||||
|
Most users never need to run these directly. The first-time installer
|
||||||
|
(`first_time_install.sh`) sets up permissions correctly, and the web
|
||||||
|
interface manages plugin install/uninstall through the sudoers entries
|
||||||
|
the installer creates.
|
||||||
|
|
||||||
|
Run these scripts only when:
|
||||||
|
|
||||||
|
- You see "Permission denied" errors in `journalctl -u ledmatrix` or
|
||||||
|
the web UI Logs tab.
|
||||||
|
- You manually copied files into the project directory as the wrong
|
||||||
|
user.
|
||||||
|
- You restored from a backup that didn't preserve ownership.
|
||||||
|
- You moved the LEDMatrix directory and need to re-anchor permissions.
|
||||||
|
|
||||||
|
## Usage
|
||||||
|
|
||||||
|
```bash
|
||||||
|
# Run from the project root
|
||||||
|
sudo ./scripts/fix_perms/fix_cache_permissions.sh
|
||||||
|
sudo ./scripts/fix_perms/fix_assets_permissions.sh
|
||||||
|
sudo ./scripts/fix_perms/fix_plugin_permissions.sh
|
||||||
|
sudo ./scripts/fix_perms/fix_web_permissions.sh
|
||||||
|
```
|
||||||
|
|
||||||
|
If you're not sure which one you need, run `fix_cache_permissions.sh`
|
||||||
|
first — it's the most commonly needed and creates several directories
|
||||||
|
the other scripts assume exist.
|
||||||
@@ -4,16 +4,26 @@ This directory contains scripts for installing and configuring the LEDMatrix sys
|
|||||||
|
|
||||||
## Scripts
|
## Scripts
|
||||||
|
|
||||||
|
- **`one-shot-install.sh`** - Single-command installer; clones the
|
||||||
|
repo, checks prerequisites, then runs `first_time_install.sh`.
|
||||||
|
Invoked via `curl ... | bash` from the project root README.
|
||||||
- **`install_service.sh`** - Installs the main LED Matrix display service (systemd)
|
- **`install_service.sh`** - Installs the main LED Matrix display service (systemd)
|
||||||
- **`install_web_service.sh`** - Installs the web interface service (systemd)
|
- **`install_web_service.sh`** - Installs the web interface service (systemd)
|
||||||
- **`install_wifi_monitor.sh`** - Installs the WiFi monitor daemon service
|
- **`install_wifi_monitor.sh`** - Installs the WiFi monitor daemon service
|
||||||
- **`setup_cache.sh`** - Sets up persistent cache directory with proper permissions
|
- **`setup_cache.sh`** - Sets up persistent cache directory with proper permissions
|
||||||
- **`configure_web_sudo.sh`** - Configures passwordless sudo access for web interface actions
|
- **`configure_web_sudo.sh`** - Configures passwordless sudo access for web interface actions
|
||||||
|
- **`configure_wifi_permissions.sh`** - Grants the `ledmatrix` user
|
||||||
|
the WiFi management permissions needed by the web interface and
|
||||||
|
the WiFi monitor service
|
||||||
- **`migrate_config.sh`** - Migrates configuration files to new formats (if needed)
|
- **`migrate_config.sh`** - Migrates configuration files to new formats (if needed)
|
||||||
|
- **`debug_install.sh`** - Diagnostic helper used when an install
|
||||||
|
fails; collects environment info and recent logs
|
||||||
|
|
||||||
## Usage
|
## Usage
|
||||||
|
|
||||||
These scripts are typically called by `first_time_install.sh` in the project root, but can also be run individually if needed.
|
These scripts are typically called by `first_time_install.sh` in the
|
||||||
|
project root (which itself is invoked by `one-shot-install.sh`), but
|
||||||
|
can also be run individually if needed.
|
||||||
|
|
||||||
**Note:** Most installation scripts require `sudo` privileges to install systemd services and configure system settings.
|
**Note:** Most installation scripts require `sudo` privileges to install systemd services and configure system settings.
|
||||||
|
|
||||||
|
|||||||
@@ -71,6 +71,17 @@ General-purpose utility functions:
|
|||||||
- Boolean parsing
|
- Boolean parsing
|
||||||
- Logger creation (deprecated - use `src.logging_config.get_logger()`)
|
- Logger creation (deprecated - use `src.logging_config.get_logger()`)
|
||||||
|
|
||||||
|
## Permission Utilities (`permission_utils.py`)
|
||||||
|
|
||||||
|
Helpers for ensuring directory permissions and ownership are correct
|
||||||
|
when running as a service (used by `CacheManager` to set up its
|
||||||
|
persistent cache directory).
|
||||||
|
|
||||||
|
## CLI Helpers (`cli.py`)
|
||||||
|
|
||||||
|
Shared CLI argument parsing helpers used by `scripts/dev/*` and other
|
||||||
|
command-line entry points.
|
||||||
|
|
||||||
## Best Practices
|
## Best Practices
|
||||||
|
|
||||||
1. **Use centralized logging**: Import from `src.logging_config` instead of creating loggers directly
|
1. **Use centralized logging**: Import from `src.logging_config` instead of creating loggers directly
|
||||||
|
|||||||
@@ -28,14 +28,29 @@ These service files are installed by the installation scripts in `scripts/instal
|
|||||||
|
|
||||||
## Manual Installation
|
## Manual Installation
|
||||||
|
|
||||||
If you need to install a service manually:
|
> **Important:** the unit files in this directory contain
|
||||||
|
> `__PROJECT_ROOT_DIR__` placeholders that the install scripts replace
|
||||||
```bash
|
> with the actual project directory at install time. Do **not** copy
|
||||||
sudo cp systemd/ledmatrix.service /etc/systemd/system/
|
> them directly to `/etc/systemd/system/` — the service will fail to
|
||||||
sudo systemctl daemon-reload
|
> start with `WorkingDirectory=__PROJECT_ROOT_DIR__` errors.
|
||||||
sudo systemctl enable ledmatrix.service
|
>
|
||||||
sudo systemctl start ledmatrix.service
|
> Always install via the helper script:
|
||||||
```
|
>
|
||||||
|
> ```bash
|
||||||
|
> sudo ./scripts/install/install_service.sh
|
||||||
|
> ```
|
||||||
|
>
|
||||||
|
> If you really need to do it by hand, substitute the placeholder
|
||||||
|
> first:
|
||||||
|
>
|
||||||
|
> ```bash
|
||||||
|
> PROJECT_ROOT="$(pwd)"
|
||||||
|
> sed "s|__PROJECT_ROOT_DIR__|$PROJECT_ROOT|g" systemd/ledmatrix.service \
|
||||||
|
> | sudo tee /etc/systemd/system/ledmatrix.service > /dev/null
|
||||||
|
> sudo systemctl daemon-reload
|
||||||
|
> sudo systemctl enable ledmatrix.service
|
||||||
|
> sudo systemctl start ledmatrix.service
|
||||||
|
> ```
|
||||||
|
|
||||||
## Service Management
|
## Service Management
|
||||||
|
|
||||||
|
|||||||
@@ -66,38 +66,53 @@ Once running, access the web interface at:
|
|||||||
|
|
||||||
The web interface reads configuration from:
|
The web interface reads configuration from:
|
||||||
- `config/config.json` - Main configuration
|
- `config/config.json` - Main configuration
|
||||||
- `config/secrets.json` - API keys and secrets
|
- `config/config_secrets.json` - API keys and secrets
|
||||||
|
|
||||||
## API Documentation
|
## API Documentation
|
||||||
|
|
||||||
The V3 API is available at `/api/v3/` with the following endpoints:
|
The V3 API is mounted at `/api/v3/` (`app.py:144`). For the complete
|
||||||
|
list and request/response formats, see
|
||||||
|
[`docs/REST_API_REFERENCE.md`](../docs/REST_API_REFERENCE.md). Quick
|
||||||
|
reference for the most common endpoints:
|
||||||
|
|
||||||
### Configuration
|
### Configuration
|
||||||
- `GET /api/v3/config/main` - Get main configuration
|
- `GET /api/v3/config/main` - Get main configuration
|
||||||
- `POST /api/v3/config/main` - Save main configuration
|
- `POST /api/v3/config/main` - Save main configuration
|
||||||
- `GET /api/v3/config/secrets` - Get secrets configuration
|
- `GET /api/v3/config/secrets` - Get secrets configuration
|
||||||
- `POST /api/v3/config/secrets` - Save secrets configuration
|
- `POST /api/v3/config/raw/main` - Save raw main config (Config Editor)
|
||||||
|
- `POST /api/v3/config/raw/secrets` - Save raw secrets
|
||||||
|
|
||||||
### Display Control
|
### Display & System Control
|
||||||
- `POST /api/v3/display/start` - Start display service
|
- `GET /api/v3/system/status` - System status
|
||||||
- `POST /api/v3/display/stop` - Stop display service
|
- `POST /api/v3/system/action` - Control display (action body:
|
||||||
- `POST /api/v3/display/restart` - Restart display service
|
`start_display`, `stop_display`, `restart_display_service`,
|
||||||
- `GET /api/v3/display/status` - Get display service status
|
`restart_web_service`, `git_pull`, `reboot_system`, `shutdown_system`,
|
||||||
|
`enable_autostart`, `disable_autostart`)
|
||||||
|
- `GET /api/v3/display/current` - Current display frame
|
||||||
|
- `GET /api/v3/display/on-demand/status` - On-demand status
|
||||||
|
- `POST /api/v3/display/on-demand/start` - Trigger on-demand display
|
||||||
|
- `POST /api/v3/display/on-demand/stop` - Clear on-demand
|
||||||
|
|
||||||
### Plugins
|
### Plugins
|
||||||
- `GET /api/v3/plugins` - List installed plugins
|
- `GET /api/v3/plugins/installed` - List installed plugins
|
||||||
- `GET /api/v3/plugins/<id>` - Get plugin details
|
- `GET /api/v3/plugins/config?plugin_id=<id>` - Get plugin config
|
||||||
- `POST /api/v3/plugins/<id>/config` - Update plugin configuration
|
- `POST /api/v3/plugins/config` - Update plugin configuration
|
||||||
- `GET /api/v3/plugins/<id>/enable` - Enable plugin
|
- `GET /api/v3/plugins/schema?plugin_id=<id>` - Get plugin schema
|
||||||
- `GET /api/v3/plugins/<id>/disable` - Disable plugin
|
- `POST /api/v3/plugins/toggle` - Enable/disable plugin
|
||||||
|
- `POST /api/v3/plugins/install` - Install from registry
|
||||||
|
- `POST /api/v3/plugins/install-from-url` - Install from GitHub URL
|
||||||
|
- `POST /api/v3/plugins/uninstall` - Uninstall plugin
|
||||||
|
- `POST /api/v3/plugins/update` - Update plugin
|
||||||
|
|
||||||
### Plugin Store
|
### Plugin Store
|
||||||
- `GET /api/v3/store/plugins` - List available plugins
|
- `GET /api/v3/plugins/store/list` - List available registry plugins
|
||||||
- `POST /api/v3/store/install/<id>` - Install plugin
|
- `GET /api/v3/plugins/store/github-status` - GitHub authentication status
|
||||||
- `POST /api/v3/store/uninstall/<id>` - Uninstall plugin
|
- `POST /api/v3/plugins/store/refresh` - Refresh registry from GitHub
|
||||||
- `POST /api/v3/store/update/<id>` - Update plugin
|
|
||||||
|
|
||||||
### Real-time Streams (SSE)
|
### Real-time Streams (SSE)
|
||||||
|
SSE stream endpoints are defined directly on the Flask app
|
||||||
|
(`app.py:607-619` — includes the CSRF exemption and rate-limit hookup
|
||||||
|
alongside the three route definitions), not on the api_v3 blueprint:
|
||||||
- `GET /api/v3/stream/stats` - System statistics stream
|
- `GET /api/v3/stream/stats` - System statistics stream
|
||||||
- `GET /api/v3/stream/display` - Display preview stream
|
- `GET /api/v3/stream/display` - Display preview stream
|
||||||
- `GET /api/v3/stream/logs` - Service logs stream
|
- `GET /api/v3/stream/logs` - Service logs stream
|
||||||
|
|||||||
@@ -90,6 +90,48 @@ Table-based RSS feed editor with logo uploads.
|
|||||||
- Enable/disable individual feeds
|
- Enable/disable individual feeds
|
||||||
- Automatic row re-indexing
|
- Automatic row re-indexing
|
||||||
|
|
||||||
|
### Other Built-in Widgets
|
||||||
|
|
||||||
|
In addition to the three documented above, these widgets are
|
||||||
|
registered and ready to use via `x-widget`:
|
||||||
|
|
||||||
|
**Inputs:**
|
||||||
|
- `text-input` — Plain text field with optional length constraints
|
||||||
|
- `textarea` — Multi-line text input
|
||||||
|
- `number-input` — Numeric input with min/max validation
|
||||||
|
- `email-input` — Email field with format validation
|
||||||
|
- `url-input` — URL field with format validation
|
||||||
|
- `password-input` — Password field with show/hide toggle
|
||||||
|
|
||||||
|
**Selectors:**
|
||||||
|
- `select-dropdown` — Single-select dropdown for `enum` fields
|
||||||
|
- `radio-group` — Radio buttons for `enum` fields (alternative to dropdown)
|
||||||
|
- `toggle-switch` — Boolean toggle (alternative to a checkbox)
|
||||||
|
- `slider` — Numeric range slider for `integer`/`number` with `min`/`max`
|
||||||
|
- `color-picker` — RGB color picker; outputs `[r, g, b]` arrays
|
||||||
|
- `font-selector` — Picks from fonts in `assets/fonts/` (TTF + BDF)
|
||||||
|
- `timezone-selector` — IANA timezone picker
|
||||||
|
|
||||||
|
**Date / time / scheduling:**
|
||||||
|
- `date-picker` — Single date input
|
||||||
|
- `day-selector` — Days-of-week multi-select (Mon–Sun checkboxes)
|
||||||
|
- `time-range` — Start/end time pair (e.g. for dim schedules)
|
||||||
|
- `schedule-picker` — Full cron-style or weekday/time schedule editor
|
||||||
|
|
||||||
|
**Composite / data-source:**
|
||||||
|
- `array-table` — Generic table editor for arrays of objects
|
||||||
|
- `google-calendar-picker` — Picks from the user's authenticated Google
|
||||||
|
Calendars (used by the calendar plugin)
|
||||||
|
|
||||||
|
**Internal (typically not used directly by plugins):**
|
||||||
|
- `notification` — Toast notification helper
|
||||||
|
- `base-widget` — Base class other widgets extend
|
||||||
|
|
||||||
|
The canonical source for each widget's exact schema and options is the
|
||||||
|
file in this directory (e.g., `slider.js`, `color-picker.js`). If you
|
||||||
|
need a feature one of these doesn't support, see "Creating Custom
|
||||||
|
Widgets" below.
|
||||||
|
|
||||||
## Using Existing Widgets
|
## Using Existing Widgets
|
||||||
|
|
||||||
To use an existing widget in your plugin's `config_schema.json`, simply add the `x-widget` property to your field definition:
|
To use an existing widget in your plugin's `config_schema.json`, simply add the `x-widget` property to your field definition:
|
||||||
|
|||||||
Reference in New Issue
Block a user