LEDMatrix

1,760 Commits 32 Branches 11 Tags

3 Commits

Author	SHA1	Message	Date
ChuckandClaude Opus 4.6	49287bdd1a	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>	2026-04-06 21:55:34 -04:00
ChuckandClaude Opus 4.6	1d31465df0	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>	2026-04-06 21:39:11 -04:00
ChuckandClaude Opus 4.6	2a7a318cf7	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>	2026-04-06 20:45:19 -04:00

Author

SHA1

Message

Date

ChuckandClaude Opus 4.6

49287bdd1a

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>

2026-04-06 21:55:34 -04:00

ChuckandClaude Opus 4.6

1d31465df0

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>

2026-04-06 21:39:11 -04:00

ChuckandClaude Opus 4.6

2a7a318cf7

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>

2026-04-06 20:45:19 -04:00