Files
LEDMatrix/WIKI_HOME.md
ChuckBuilds 3a81e16490 wiki updates
2025-07-26 18:20:39 -05:00

4.5 KiB

LEDMatrix Wiki

Welcome to the LEDMatrix Wiki! This comprehensive documentation will help you understand, configure, and customize your LED matrix display system.

🏠 Home - You are here

The main wiki page with overview and navigation.

📋 Quick Start Guide

Get your LEDMatrix up and running in minutes with this step-by-step guide.

🏗️ System Architecture

Understand how the LEDMatrix system is organized and how all components work together.

⚙️ Configuration Guide

Complete guide to configuring all aspects of your LEDMatrix system.

🎯 Display Managers

Detailed documentation for each display manager and their configuration options.

🎨 Display Manager Details

In-depth technical details about each display manager's functionality and API integration.

🔧 Hardware Setup

Complete hardware requirements, assembly instructions, and troubleshooting.

🐧 Raspberry Pi Setup

Step-by-step instructions for setting up your Raspberry Pi for LEDMatrix.

🚀 Installation & Deployment

Complete installation process, service setup, and deployment options.

🔐 API Authentication

How to set up API keys and authentication for all supported services.

🎵 Music Integration

Complete guide to Spotify and YouTube Music integration.

🏈 Sports Integration

Detailed documentation for all sports leagues and their configuration.

💰 Financial Data

Stock ticker, crypto, and financial news display configuration.

🌤️ Weather Display

Weather current conditions, forecasts, and icon system.

📅 Calendar Integration

Google Calendar integration and event display.

🎨 Custom Displays

Text display, YouTube stats, and custom content creation.

🔧 Troubleshooting

Common issues, solutions, and debugging techniques.

🛠️ Development Guide

How to extend the system, add new features, and contribute.

📚 API Reference

Technical reference for all classes, methods, and configuration options.


Quick Navigation

Core Features

Integrations

Technical


About LEDMatrix

LEDMatrix is a comprehensive LED matrix display system that provides real-time information display capabilities for various data sources. The system is highly configurable and supports multiple display modes that can be enabled or disabled based on user preferences.

Key Features

  • Modular Design: Each feature is a separate manager that can be enabled/disabled
  • Real-time Updates: Live data from APIs with intelligent caching
  • Multiple Sports: NHL, NBA, MLB, NFL, NCAA, Soccer, and more
  • Financial Data: Stock ticker, crypto prices, and financial news
  • Weather: Current conditions, hourly and daily forecasts
  • Music: Spotify and YouTube Music integration
  • Custom Content: Text display, YouTube stats, and more
  • Scheduling: Configurable display rotation and timing
  • Caching: Intelligent caching to reduce API calls

System Requirements

  • Raspberry Pi 3B+ or 4 (NOT Pi 5)
  • Adafruit RGB Matrix Bonnet/HAT
  • 2x LED Matrix panels (64x32)
  • 5V 4A DC Power Supply
  • Internet connection for API access

This wiki is designed to help you get the most out of your LEDMatrix system. Each page contains detailed information, configuration examples, and troubleshooting tips.