Docs/consolidate documentation (#217)

* docs: rename FONT_MANAGER_USAGE.md to FONT_MANAGER.md Renamed for clearer naming convention. Part of documentation consolidation effort. * docs: consolidate Plugin Store guides (2→1) Merged: - PLUGIN_STORE_USER_GUIDE.md - PLUGIN_STORE_QUICK_REFERENCE.md Into: PLUGIN_STORE_GUIDE.md - Unified writing style to professional technical - Added Quick Reference section at top for easy access - Removed duplicate content - Added cross-references to related documentation - Updated formatting to match style guidelines * docs: create user-focused Web Interface Guide Created WEB_INTERFACE_GUIDE.md consolidating: - V3_INTERFACE_README.md (technical details) - User-facing interface documentation - Focused on end-user tasks and navigation - Removed technical implementation details - Added common tasks section - Included troubleshooting - Professional technical writing style * docs: consolidate WiFi setup guides (4→1) Merged: - WIFI_SETUP.md - OPTIMAL_WIFI_AP_FAILOVER_SETUP.md - AP_MODE_MANUAL_ENABLE.md - WIFI_ETHERNET_AP_MODE_FIX.md (behavior documentation) Into: WIFI_NETWORK_SETUP.md - Comprehensive coverage of WiFi setup and configuration - Clear explanation of AP mode failover and grace period - Configuration scenarios and best practices - Troubleshooting section combining all sources - Professional technical writing style - Added quick reference table for behavior * docs: consolidate troubleshooting guides (4→1) Merged: - TROUBLESHOOTING_QUICK_START.md - WEB_INTERFACE_TROUBLESHOOTING.md - CAPTIVE_PORTAL_TROUBLESHOOTING.md - WEATHER_TROUBLESHOOTING.md Into: TROUBLESHOOTING.md - Organized by issue category (web, WiFi, plugins) - Comprehensive diagnostic commands reference - Quick diagnosis steps at the top - Service file template preserved - Complete diagnostic script included - Professional technical writing style * docs: create consolidated Advanced Features guide Merged: - VEGAS_SCROLL_MODE.md - ON_DEMAND_DISPLAY_QUICK_START.md - ON_DEMAND_DISPLAY_API.md - ON_DEMAND_CACHE_MANAGEMENT.md - BACKGROUND_SERVICE_README.md - PERMISSION_MANAGEMENT_GUIDE.md Into: ADVANCED_FEATURES.md - Comprehensive guide covering all advanced features - Vegas scroll mode with integration examples - On-demand display with API reference - Cache management troubleshooting - Background service documentation - Permission management patterns - Professional technical writing style * docs: create Getting Started guide for first-time users Created GETTING_STARTED.md: - Quick start guide (5 minutes) - Initial configuration walkthrough - Common first-time issues and solutions - Next steps and quick reference - User-friendly tone for beginners - Links to detailed documentation * docs: archive consolidated source files and ephemeral docs Archived files that have been consolidated: - Plugin Store guides (2 files → PLUGIN_STORE_GUIDE.md) - Web Interface guide (V3_INTERFACE_README.md → WEB_INTERFACE_GUIDE.md) - WiFi Setup guides (4 files → WIFI_NETWORK_SETUP.md) - Troubleshooting guides (4 files → TROUBLESHOOTING.md) - Advanced Features (6 files → ADVANCED_FEATURES.md) Archived ephemeral/debug documentation: - DEBUG_WEB_ISSUE.md - BROWSER_ERRORS_EXPLANATION.md - FORM_VALIDATION_FIXES.md - WEB_UI_RELIABILITY_IMPROVEMENTS.md - CAPTIVE_PORTAL_TESTING.md - NEXT_STEPS_COMMANDS.md - STATIC_IMAGE_MULTI_UPLOAD_PLAN.md - RECONNECT_AFTER_CAPTIVE_PORTAL_TESTING.md Archived implementation summaries: - PLUGIN_CONFIG_TABS_SUMMARY.md - PLUGIN_CONFIG_SYSTEM_VERIFICATION.md - PLUGIN_SCHEMA_AUDIT_SUMMARY.md - STARTUP_OPTIMIZATION_SUMMARY.md - PLUGIN_DISPATCH_IMPLEMENTATION.md - NESTED_SCHEMA_IMPLEMENTATION.md - AP_MODE_MANUAL_ENABLE_CHANGES.md - PLUGIN_CONFIG_SYSTEM_EXPLANATION.md Total archived: 27 files Preserves git history while cleaning up main docs directory * docs: rename API_REFERENCE.md to REST_API_REFERENCE.md Renamed for clarity - this is specifically the REST API reference for the web interface, not a general API reference. * docs: update README.md to reflect consolidated documentation structure Updated documentation index: - Reflects new consolidated guides (51 → 16-17 files) - Updated Quick Start sections with new file names - Added consolidation history (January 2026) - Updated file references (API_REFERENCE → REST_API_REFERENCE) - Documented archival of 33 files - Added benefits of consolidation - Updated statistics and highlights - Removed outdated references - Professional writing style maintained throughout * docs: add Vegas scroll mode system architecture documentation Added comprehensive internal architecture section for Vegas mode: - Component overview with diagram - VegasModeCoordinator responsibilities and main loop - StreamManager buffering strategy and content flow - PluginAdapter integration and fallback behavior - RenderPipeline 125 FPS rendering process - Component interaction flows - Thread safety patterns - Performance characteristics Covers: - How the four components work together - Initialization and render loop flows - Config update handling - Frame rate management and optimization - Memory usage and CPU characteristics --------- Co-authored-by: Chuck <chuck@example.com>
2026-04-10 21:03:01 +00:00 · 2026-01-29 10:32:00 -05:00
parent 7524747e44
commit ddd300a117
42 changed files with 3954 additions and 95 deletions
--- a/docs/archive/PLUGIN_STORE_USER_GUIDE.md
+++ b/docs/archive/PLUGIN_STORE_USER_GUIDE.md
@@ -0,0 +1,450 @@
+# LEDMatrix Plugin Store - User Guide
+
+## Overview
+
+The LEDMatrix Plugin Store allows you to easily discover, install, and manage display plugins for your LED matrix. You can install curated plugins from the official registry or add custom plugins directly from any GitHub repository.
+
+## Two Ways to Install Plugins
+
+### Method 1: From Official Plugin Store (Recommended)
+
+The official plugin store contains curated, verified plugins that have been reviewed by maintainers.
+
+**Via Web UI:**
+1. Open the web interface (http://your-pi-ip:5050)
+2. Navigate to "Plugin Store" tab
+3. Browse or search for plugins
+4. Click "Install" on the plugin you want
+5. Wait for installation to complete
+6. Restart the display to activate the plugin
+
+**Via API:**
+```bash
+curl -X POST http://your-pi-ip:5050/api/plugins/install \
+  -H "Content-Type: application/json" \
+  -d '{"plugin_id": "clock-simple"}'
+```
+
+**Via Python:**
+```python
+from src.plugin_system.store_manager import PluginStoreManager
+
+store = PluginStoreManager()
+success = store.install_plugin('clock-simple')
+if success:
+    print("Plugin installed!")
+```
+
+### Method 2: From Custom GitHub URL
+
+Install any plugin directly from a GitHub repository, even if it's not in the official store. This is perfect for:
+- Testing your own plugins during development
+- Installing community plugins before they're in the official store
+- Using private plugins
+- Sharing plugins with specific users
+
+**Via Web UI:**
+1. Open the web interface
+2. Navigate to "Plugin Store" tab
+3. Find the "Install from URL" section at the bottom
+4. Paste the GitHub repository URL (e.g., `https://github.com/user/ledmatrix-my-plugin`)
+5. Click "Install from URL"
+6. Review the warning about unverified plugins
+7. Confirm installation
+8. Wait for installation to complete
+9. Restart the display
+
+**Via API:**
+```bash
+curl -X POST http://your-pi-ip:5050/api/plugins/install-from-url \
+  -H "Content-Type: application/json" \
+  -d '{"repo_url": "https://github.com/user/ledmatrix-my-plugin"}'
+```
+
+**Via Python:**
+```python
+from src.plugin_system.store_manager import PluginStoreManager
+
+store = PluginStoreManager()
+result = store.install_from_url('https://github.com/user/ledmatrix-my-plugin')
+
+if result['success']:
+    print(f"Installed: {result['plugin_id']}")
+else:
+    print(f"Error: {result['error']}")
+```
+
+## Searching for Plugins
+
+**Via Web UI:**
+- Use the search bar to search by name, description, or author
+- Filter by category (sports, weather, time, finance, etc.)
+- Click on tags to filter by specific tags
+
+**Via API:**
+```bash
+# Search by query
+curl "http://your-pi-ip:5050/api/plugins/store/search?q=hockey"
+
+# Filter by category
+curl "http://your-pi-ip:5050/api/plugins/store/search?category=sports"
+
+# Filter by tags
+curl "http://your-pi-ip:5050/api/plugins/store/search?tags=nhl&tags=hockey"
+```
+
+**Via Python:**
+```python
+from src.plugin_system.store_manager import PluginStoreManager
+
+store = PluginStoreManager()
+
+# Search by query
+results = store.search_plugins(query="hockey")
+
+# Filter by category
+results = store.search_plugins(category="sports")
+
+# Filter by tags
+results = store.search_plugins(tags=["nhl", "hockey"])
+```
+
+## Managing Installed Plugins
+
+### List Installed Plugins
+
+**Via Web UI:**
+- Navigate to "Plugin Manager" tab
+- See all installed plugins with their status
+
+**Via API:**
+```bash
+curl "http://your-pi-ip:5050/api/plugins/installed"
+```
+
+**Via Python:**
+```python
+from src.plugin_system.store_manager import PluginStoreManager
+
+store = PluginStoreManager()
+installed = store.list_installed_plugins()
+
+for plugin_id in installed:
+    info = store.get_installed_plugin_info(plugin_id)
+    print(f"{info['name']} (Last updated: {info.get('last_updated', 'unknown')})")
+```
+
+### Enable/Disable Plugins
+
+**Via Web UI:**
+1. Go to "Plugin Manager" tab
+2. Use the toggle switch next to each plugin
+3. Restart display to apply changes
+
+**Via API:**
+```bash
+curl -X POST http://your-pi-ip:5050/api/plugins/toggle \
+  -H "Content-Type: application/json" \
+  -d '{"plugin_id": "clock-simple", "enabled": true}'
+```
+
+### Update Plugins
+
+**Via Web UI:**
+1. Go to "Plugin Manager" tab
+2. Click "Update" button next to the plugin
+3. Wait for update to complete
+4. Restart display
+
+**Via API:**
+```bash
+curl -X POST http://your-pi-ip:5050/api/plugins/update \
+  -H "Content-Type: application/json" \
+  -d '{"plugin_id": "clock-simple"}'
+```
+
+**Via Python:**
+```python
+from src.plugin_system.store_manager import PluginStoreManager
+
+store = PluginStoreManager()
+success = store.update_plugin('clock-simple')
+```
+
+### Uninstall Plugins
+
+**Via Web UI:**
+1. Go to "Plugin Manager" tab
+2. Click "Uninstall" button next to the plugin
+3. Confirm removal
+4. Restart display
+
+**Via API:**
+```bash
+curl -X POST http://your-pi-ip:5050/api/plugins/uninstall \
+  -H "Content-Type: application/json" \
+  -d '{"plugin_id": "clock-simple"}'
+```
+
+**Via Python:**
+```python
+from src.plugin_system.store_manager import PluginStoreManager
+
+store = PluginStoreManager()
+success = store.uninstall_plugin('clock-simple')
+```
+
+## Configuring Plugins
+
+Each plugin can have its own configuration in `config/config.json`:
+
+```json
+{
+  "clock-simple": {
+    "enabled": true,
+    "display_duration": 15,
+    "color": [255, 255, 255],
+    "time_format": "12h"
+  },
+  "nhl-scores": {
+    "enabled": true,
+    "favorite_teams": ["TBL", "FLA"],
+    "show_favorite_teams_only": true
+  }
+}
+```
+
+**Via Web UI:**
+1. Go to "Plugin Manager" tab
+2. Click the ⚙️ Configure button next to the plugin
+3. Edit configuration in the form
+4. Save changes
+5. Restart display to apply
+
+## Safety and Security
+
+### Verified vs Unverified Plugins
+
+- **✓ Verified Plugins**: Reviewed by maintainers, follow best practices, no known security issues
+- **⚠ Unverified Plugins**: User-contributed, not reviewed, install at your own risk
+
+When installing from a custom GitHub URL, you'll see a warning:
+
+```
+⚠️ WARNING: Installing Unverified Plugin
+
+You are about to install a plugin from a custom GitHub URL that has not been 
+verified by the LEDMatrix maintainers. Only install plugins from sources you trust.
+
+Plugin will have access to:
+- Your display manager
+- Your cache manager
+- Configuration files
+- Network access (if plugin makes API calls)
+
+Repo: https://github.com/unknown-user/plugin-name
+```
+
+### Best Practices
+
+1. **Only install plugins from trusted sources**
+2. **Review plugin code before installing** (click "View on GitHub")
+3. **Check plugin ratings and reviews** (when available)
+4. **Keep plugins updated** for security patches
+5. **Report suspicious plugins** to maintainers
+
+## Troubleshooting
+
+### Plugin Won't Install
+
+**Problem:** Installation fails with "Failed to clone or download repository"
+
+**Solutions:**
+- Check that git is installed: `which git`
+- Verify the GitHub URL is correct
+- Check your internet connection
+- Try installing via download if git fails
+
+### Plugin Won't Load
+
+**Problem:** Plugin installed but doesn't appear in rotation
+
+**Solutions:**
+1. Check that plugin is enabled in config: `"enabled": true`
+2. Verify manifest.json exists and is valid
+3. Check logs for errors: `sudo journalctl -u ledmatrix -f`
+4. Restart the display service: `sudo systemctl restart ledmatrix`
+
+### Dependencies Failed
+
+**Problem:** "Error installing dependencies" message
+
+**Solutions:**
+- Check that pip3 is installed
+- Manually install: `pip3 install --break-system-packages -r plugins/plugin-id/requirements.txt`
+- Check for conflicting package versions
+
+### Plugin Shows Errors
+
+**Problem:** Plugin loads but shows error message on display
+
+**Solutions:**
+1. Check plugin configuration is correct
+2. Verify API keys are set (if plugin needs them)
+3. Check plugin logs: `sudo journalctl -u ledmatrix -f | grep plugin-id`
+4. Report issue to plugin developer on GitHub
+
+## Command-Line Usage
+
+For advanced users, you can manage plugins via command line:
+
+```bash
+# Install from registry
+python3 -c "
+from src.plugin_system.store_manager import PluginStoreManager
+store = PluginStoreManager()
+store.install_plugin('clock-simple')
+"
+
+# Install from URL
+python3 -c "
+from src.plugin_system.store_manager import PluginStoreManager
+store = PluginStoreManager()
+result = store.install_from_url('https://github.com/user/plugin')
+print(result)
+"
+
+# List installed
+python3 -c "
+from src.plugin_system.store_manager import PluginStoreManager
+store = PluginStoreManager()
+for plugin_id in store.list_installed_plugins():
+    info = store.get_installed_plugin_info(plugin_id)
+    print(f"{plugin_id}: {info['name']} (Last updated: {info.get('last_updated', 'unknown')})")
+"
+
+# Uninstall
+python3 -c "
+from src.plugin_system.store_manager import PluginStoreManager
+store = PluginStoreManager()
+store.uninstall_plugin('clock-simple')
+"
+```
+
+## API Reference
+
+All API endpoints return JSON with this structure:
+
+```json
+{
+  "status": "success" | "error",
+  "message": "Human-readable message",
+  "data": { ... }  // Varies by endpoint
+}
+```
+
+### Endpoints
+
+| Method | Endpoint | Description |
+|--------|----------|-------------|
+| GET | `/api/plugins/store/list` | List all plugins in store |
+| GET | `/api/plugins/store/search` | Search for plugins |
+| GET | `/api/plugins/installed` | List installed plugins |
+| POST | `/api/plugins/install` | Install from registry |
+| POST | `/api/plugins/install-from-url` | Install from GitHub URL |
+| POST | `/api/plugins/uninstall` | Uninstall plugin |
+| POST | `/api/plugins/update` | Update plugin |
+| POST | `/api/plugins/toggle` | Enable/disable plugin |
+| POST | `/api/plugins/config` | Update plugin config |
+
+## Examples
+
+### Example 1: Install Clock Plugin
+
+```bash
+# Install
+curl -X POST http://192.168.1.100:5050/api/plugins/install \
+  -H "Content-Type: application/json" \
+  -d '{"plugin_id": "clock-simple"}'
+
+# Configure
+cat >> config/config.json << EOF
+{
+  "clock-simple": {
+    "enabled": true,
+    "display_duration": 20,
+    "time_format": "24h"
+  }
+}
+EOF
+
+# Restart display
+sudo systemctl restart ledmatrix
+```
+
+### Example 2: Install Custom Plugin from GitHub
+
+```bash
+# Install your own plugin during development
+curl -X POST http://192.168.1.100:5050/api/plugins/install-from-url \
+  -H "Content-Type: application/json" \
+  -d '{"repo_url": "https://github.com/myusername/ledmatrix-my-custom-plugin"}'
+
+# Enable it
+curl -X POST http://192.168.1.100:5050/api/plugins/toggle \
+  -H "Content-Type: application/json" \
+  -d '{"plugin_id": "my-custom-plugin", "enabled": true}'
+
+# Restart
+sudo systemctl restart ledmatrix
+```
+
+### Example 3: Share Plugin with Others
+
+As a plugin developer, you can share your plugin with others even before it's in the official store:
+
+```markdown
+# Share this URL with users:
+https://github.com/yourusername/ledmatrix-awesome-plugin
+
+# Users install with:
+1. Go to LEDMatrix web interface
+2. Click "Plugin Store" tab
+3. Scroll to "Install from URL"
+4. Paste: https://github.com/yourusername/ledmatrix-awesome-plugin
+5. Click "Install from URL"
+```
+
+## FAQ
+
+**Q: Do I need to restart the display after installing a plugin?**  
+A: Yes, plugins are loaded when the display controller starts.
+
+**Q: Can I install plugins while the display is running?**  
+A: Yes, you can install anytime, but you must restart to load them.
+
+**Q: What happens if I install a plugin with the same ID as an existing one?**  
+A: The existing copy will be replaced with the latest code from the repository.
+
+**Q: Can I install multiple versions of the same plugin?**  
+A: No, each plugin ID maps to a single checkout of the repository's default branch.
+
+**Q: How do I update all plugins at once?**  
+A: Currently, you need to update each plugin individually. Bulk update is planned for a future release.
+
+**Q: Can plugins access my API keys from config_secrets.json?**  
+A: Yes, if a plugin needs API keys, it can access them like core managers do.
+
+**Q: How much disk space do plugins use?**  
+A: Most plugins are small (1-5MB). Check individual plugin documentation.
+
+**Q: Can I create my own plugin?**  
+A: Yes! See PLUGIN_DEVELOPER_GUIDE.md for instructions.
+
+## Support
+
+- **Documentation**: See PLUGIN_ARCHITECTURE_SPEC.md
+- **Issues**: Report bugs on GitHub
+- **Community**: Join discussions in Issues
+- **Developer Guide**: See PLUGIN_DEVELOPER_GUIDE.md for creating plugins
+