mirror of https://github.com/ChuckBuilds/LEDMatrix.git synced 2026-04-11 05:13:01 +00:00

Files

Chuck b88842e672 fix(array-objects): Fix schema lookup, reindexing, and disable file upload

Address PR review feedback for array-of-objects helpers:

1. Schema resolution: Use getSchemaProperty() instead of manual traversal
   - Fixes nested array-of-objects schema lookup (e.g., news.custom_feeds)
   - Now properly descends through .properties for nested objects

2. Reindexing: Replace brittle regex with targeted patterns
   - Only replace index in bracket notation [0], [1], etc. for names
   - Only replace _item_<digits> pattern for IDs (not arbitrary digits)
   - Use specific function parameter patterns for onclick handlers
   - Prevents corruption of fieldId, pluginId, or other numeric values

3. File upload: Disable widget until properly implemented
   - Hide/disable upload button with clear message
   - Show existing logos if present but disable upload functionality
   - Prevents silent failures when users attempt to upload files
   - Added TODO comments for future implementation

Also fixes exit code handling in one-shot-install.sh to properly capture
first_time_install.sh exit status before error trap fires.

2026-01-08 12:26:08 -05:00

blueprints

Add fallback fix for feeds.custom_feeds dict-to-array conversion

2026-01-05 15:05:13 -05:00

static/v3

fix(array-objects): Fix schema lookup, reindexing, and disable file upload

2026-01-08 12:26:08 -05:00

templates/v3

feat(web): Add checkbox-group widget support for plugin config arrays

2026-01-06 17:51:26 -05:00

__init__.py

Plugins (#145 )

2025-12-27 14:15:49 -05:00

app.py

fix(web-ui): Fix file upload widget and plugin action buttons (#165 )

2025-12-30 19:04:21 -05:00

cache.py

Plugins (#145 )

2025-12-27 14:15:49 -05:00

logging_config.py

Plugins (#145 )

2025-12-27 14:15:49 -05:00

README.md

Plugins (#145 )

2025-12-27 14:15:49 -05:00

requirements.txt

Plugins (#145 )

2025-12-27 14:15:49 -05:00

run.sh

Plugins (#145 )

2025-12-27 14:15:49 -05:00

start.py

Plugins (#145 )

2025-12-27 14:15:49 -05:00

README.md

LED Matrix Web Interface V3

Modern, production web interface for controlling the LED Matrix display.

Overview

This directory contains the active V3 web interface with the following features:

Real-time display preview via Server-Sent Events (SSE)
Plugin management and configuration
System monitoring and logs
Modern, responsive UI
RESTful API

Directory Structure

web_interface/
├── app.py                    # Main Flask application
├── start.py                  # Startup script
├── run.sh                    # Shell runner script
├── requirements.txt          # Python dependencies
├── blueprints/               # Flask blueprints
│   ├── api_v3.py            # API endpoints
│   └── pages_v3.py          # Page routes
├── templates/                # HTML templates
│   └── v3/
│       ├── base.html
│       ├── index.html
│       └── partials/
└── static/                   # CSS/JS assets
    └── v3/
        ├── app.css
        └── app.js

Running the Web Interface

Standalone (Development)

From the project root:

python3 web_interface/start.py

Or using the shell script:

./web_interface/run.sh

As a Service (Production)

The web interface can run as a systemd service that starts automatically based on the web_display_autostart configuration setting:

sudo systemctl start ledmatrix-web
sudo systemctl enable ledmatrix-web  # Start on boot

Accessing the Interface

Once running, access the web interface at:

Local: http://localhost:5000
Network: http://:5000

Configuration

The web interface reads configuration from:

config/config.json - Main configuration
config/secrets.json - API keys and secrets

API Documentation

The V3 API is available at /api/v3/ with the following endpoints:

Configuration

GET /api/v3/config/main - Get main configuration
POST /api/v3/config/main - Save main configuration
GET /api/v3/config/secrets - Get secrets configuration
POST /api/v3/config/secrets - Save secrets configuration

Display Control

POST /api/v3/display/start - Start display service
POST /api/v3/display/stop - Stop display service
POST /api/v3/display/restart - Restart display service
GET /api/v3/display/status - Get display service status

Plugins

GET /api/v3/plugins - List installed plugins
GET /api/v3/plugins/<id> - Get plugin details
POST /api/v3/plugins/<id>/config - Update plugin configuration
GET /api/v3/plugins/<id>/enable - Enable plugin
GET /api/v3/plugins/<id>/disable - Disable plugin

Plugin Store

GET /api/v3/store/plugins - List available plugins
POST /api/v3/store/install/<id> - Install plugin
POST /api/v3/store/uninstall/<id> - Uninstall plugin
POST /api/v3/store/update/<id> - Update plugin

Real-time Streams (SSE)

GET /api/v3/stream/stats - System statistics stream
GET /api/v3/stream/display - Display preview stream
GET /api/v3/stream/logs - Service logs stream

Development

When making changes to the web interface:

Edit files in this directory
Test changes by running python3 web_interface/start.py
Restart the service if running: sudo systemctl restart ledmatrix-web

Notes

Templates and static files use the v3/ prefix to allow for future versions
The interface uses Flask blueprints for modular organization
SSE streams provide real-time updates without polling