CONFIGURATION_REFERENCE

Configuration Reference Guide

This guide provides a complete cross-reference between configuration options and their corresponding managers, helping you understand exactly what each setting does and where to find detailed documentation.

Quick Configuration Lookup

Core System Settings

Configuration Section	Manager	Documentation	Purpose
clock	Clock Manager	Complete Manager Guide	Time display
display	Display Manager	Complete Manager Guide	Hardware control
schedule	Display Controller	Web UI Guide	Display timing
timezone	System-wide	Configuration Guide	Global timezone
location	System-wide	Configuration Guide	Geographic location

Weather & Environment

Configuration Section	Manager	Documentation	Purpose
weather	Weather Manager	Complete Manager Guide	Weather display

Financial Data

Configuration Section	Manager	Documentation	Purpose
stocks	Stock Manager	Complete Manager Guide	Stock ticker
crypto	Stock Manager	Complete Manager Guide	Cryptocurrency
stock_news	Stock News Manager	Complete Manager Guide	Financial news

Sports Leagues

Configuration Section	Manager	Documentation	Purpose
nhl_scoreboard	NHL Managers	Complete Manager Guide	NHL games
nba_scoreboard	NBA Managers	Complete Manager Guide	NBA games
mlb	MLB Managers	Complete Manager Guide	MLB games
nfl_scoreboard	NFL Managers	Complete Manager Guide	NFL games
soccer_scoreboard	Soccer Managers	Complete Manager Guide	Soccer matches
ncaa_fb_scoreboard	NCAA FB Managers	Complete Manager Guide	College football
ncaa_baseball_scoreboard	NCAA Baseball Managers	Complete Manager Guide	College baseball
ncaam_basketball_scoreboard	NCAA Basketball Managers	Complete Manager Guide	College basketball
milb	MiLB Manager	Complete Manager Guide	Minor league baseball

Content & Media

Configuration Section	Manager	Documentation	Purpose
music	Music Manager	Complete Manager Guide	Music display
youtube	YouTube Display	Complete Manager Guide	YouTube stats
text_display	Text Display	Complete Manager Guide	Custom messages
calendar	Calendar Manager	Complete Manager Guide	Calendar events
news_manager	News Manager	Complete Manager Guide	RSS news feeds
of_the_day	Of The Day Manager	Complete Manager Guide	Daily content

Utilities & Analysis

Configuration Section	Manager	Documentation	Purpose
odds_ticker	Odds Ticker Manager	Complete Manager Guide	Betting odds
leaderboard	Leaderboard Manager	Complete Manager Guide	League standings

---

Configuration by Feature Type

🕐 Time & Scheduling

Clock Display:

{
  "clock": {
    "enabled": true,
    "format": "%I:%M %p",
    "update_interval": 1
  }
}

📖 Documentation: Clock Manager

Display Schedule:

{
  "schedule": {
    "enabled": true,
    "start_time": "07:00",
    "end_time": "23:00"
  }
}

📖 Documentation: Web UI Schedule Tab

Global Timezone:

{
  "timezone": "America/Chicago"
}

🖥️ Display Hardware

Hardware Configuration:

{
  "display": {
    "hardware": {
      "rows": 32,
      "cols": 64,
      "chain_length": 2,
      "brightness": 95,
      "hardware_mapping": "adafruit-hat-pwm"
    },
    "runtime": {
      "gpio_slowdown": 3
    },
    "display_durations": {
      "clock": 15,
      "weather": 30,
      "stocks": 30
    }
  }
}

📖 Documentation: Display Manager

🌤️ Weather & Location

Weather Display:

{
  "weather": {
    "enabled": true,
    "api_key": "your_openweathermap_api_key",
    "update_interval": 1800,
    "units": "imperial",
    "show_feels_like": true,
    "show_humidity": true,
    "show_wind": true,
    "show_uv_index": true
  }
}

📖 Documentation: Weather Manager

Location Settings:

{
  "location": {
    "city": "Dallas",
    "state": "Texas",
    "country": "US"
  }
}

💰 Financial Data

Stock Ticker:

{
  "stocks": {
    "enabled": true,
    "symbols": ["AAPL", "MSFT", "GOOGL", "TSLA"],
    "update_interval": 600,
    "scroll_speed": 1,
    "dynamic_duration": true
  }
}

📖 Documentation: Stock Manager

Cryptocurrency:

{
  "crypto": {
    "enabled": true,
    "symbols": ["BTC-USD", "ETH-USD", "ADA-USD"],
    "update_interval": 300
  }
}

📖 Documentation: Stock Manager

Financial News:

{
  "stock_news": {
    "enabled": true,
    "scroll_speed": 1,
    "max_headlines_per_symbol": 1,
    "dynamic_duration": true
  }
}

📖 Documentation: Stock News Manager

🏈 Sports Configuration

NHL Hockey:

{
  "nhl_scoreboard": {
    "enabled": true,
    "favorite_teams": ["TB", "FLA"],
    "show_odds": true,
    "show_records": true,
    "live_priority": true,
    "live_update_interval": 60
  }
}

📖 Documentation: NHL Managers

NBA Basketball:

{
  "nba_scoreboard": {
    "enabled": true,
    "favorite_teams": ["MIA", "LAL"],
    "show_odds": true,
    "show_records": true,
    "live_priority": true
  }
}

📖 Documentation: NBA Managers

MLB Baseball:

{
  "mlb": {
    "enabled": true,
    "favorite_teams": ["TB", "NYY"],
    "show_odds": true,
    "live_priority": true
  }
}

📖 Documentation: MLB Managers

NFL Football:

{
  "nfl_scoreboard": {
    "enabled": true,
    "favorite_teams": ["TB", "MIA"],
    "show_odds": true,
    "show_records": true,
    "live_priority": true
  }
}

📖 Documentation: NFL Managers

Soccer:

{
  "soccer_scoreboard": {
    "enabled": true,
    "favorite_teams": ["Real Madrid", "Barcelona"],
    "target_leagues": ["uefa.champions", "eng.1", "esp.1"],
    "show_odds": true,
    "live_priority": true
  }
}

📖 Documentation: Soccer Managers

🎵 Music & Entertainment

Music Display:

{
  "music": {
    "enabled": true,
    "preferred_source": "spotify",
    "POLLING_INTERVAL_SECONDS": 2,
    "spotify": {
      "client_id": "your_spotify_client_id",
      "client_secret": "your_spotify_client_secret"
    }
  }
}

📖 Documentation: Music Manager

YouTube Stats:

{
  "youtube": {
    "enabled": true,
    "api_key": "your_youtube_api_key",
    "channels": [
      {
        "name": "Channel Name",
        "channel_id": "UCxxxxxxxxxx",
        "display_name": "Custom Name"
      }
    ]
  }
}

📖 Documentation: YouTube Display

📰 News & Information

News Manager:

{
  "news_manager": {
    "enabled": true,
    "enabled_feeds": ["NFL", "NBA", "TOP SPORTS"],
    "custom_feeds": {
      "TECH NEWS": "https://feeds.feedburner.com/TechCrunch"
    },
    "headlines_per_feed": 2,
    "scroll_speed": 2,
    "dynamic_duration": true
  }
}

📖 Documentation: News Manager

Text Display:

{
  "text_display": {
    "enabled": true,
    "messages": ["Welcome to LEDMatrix!", "Custom message"],
    "scroll_speed": 2,
    "text_color": [255, 255, 255]
  }
}

📖 Documentation: Text Display

Calendar Events:

{
  "calendar": {
    "enabled": true,
    "calendars": ["primary", "birthdays"],
    "max_events": 3,
    "update_interval": 300
  }
}

📖 Documentation: Calendar Manager

🎯 Utilities & Analysis

Odds Ticker:

{
  "odds_ticker": {
    "enabled": true,
    "enabled_leagues": ["nfl", "nba", "mlb"],
    "show_favorite_teams_only": false,
    "scroll_speed": 2,
    "dynamic_duration": true
  }
}

📖 Documentation: Odds Ticker Manager

Leaderboards:

{
  "leaderboard": {
    "enabled": true,
    "enabled_sports": {
      "nfl": {
        "enabled": true,
        "top_teams": 10
      }
    },
    "scroll_speed": 1,
    "dynamic_duration": true
  }
}

📖 Documentation: Leaderboard Manager

---

Web Interface Configuration

The web interface provides GUI controls for all configuration options:

Configuration Area	Web UI Tab	Documentation
System monitoring	Overview	Web UI Overview
Display timing	Schedule	Web UI Schedule
Hardware settings	Display	Web UI Display
Sports leagues	Sports	Web UI Sports
Weather service	Weather	Web UI Weather
Financial data	Stocks	Web UI Stocks
Additional features	Features	Web UI Features
Music integration	Music	Web UI Music
Calendar events	Calendar	Web UI Calendar
News feeds	News	Web UI News
API keys	API Keys	Web UI API Keys
Direct JSON editing	Raw JSON	Web UI Raw JSON

---

Configuration File Locations

Main Configuration

• File: config/config.json
• Purpose: All non-sensitive settings
• Documentation: Configuration Guide

Secrets Configuration

• File: config/config_secrets.json
• Purpose: API keys and sensitive credentials
• Documentation: Configuration Guide

Template Files

• Main Template: config/config.template.json
• Secrets Template: config/config_secrets.template.json
• Purpose: Default configuration examples

---

Common Configuration Patterns

Enable/Disable Pattern

Most managers use this pattern:

{
  "manager_name": {
    "enabled": true,
    "other_options": "..."
  }
}

Update Interval Pattern

Data-fetching managers use:

{
  "manager_name": {
    "update_interval": 600,
    "live_update_interval": 60
  }
}

Scrolling Display Pattern

Text-based displays use:

{
  "manager_name": {
    "scroll_speed": 2,
    "scroll_delay": 0.02,
    "dynamic_duration": true
  }
}

Favorite Teams Pattern

Sports managers use:

{
  "sport_scoreboard": {
    "favorite_teams": ["TEAM1", "TEAM2"],
    "live_priority": true
  }
}

---

Configuration Validation

JSON Validation

• Use the Raw JSON Tab for real-time validation
• Check syntax highlighting and error indicators
• Use the Format button for proper indentation

Manager-Specific Validation

• Each manager validates its own configuration section
• Invalid configurations are logged with detailed error messages
• Fallback to default values when possible

Web Interface Validation

• Client-side validation in web forms
• Server-side validation on submission
• Real-time feedback and error messages

---

Troubleshooting Configuration

Common Issues

1. JSON Syntax Errors: Use Raw JSON tab for validation
2. Missing API Keys: Check API Keys tab and secrets file
3. Invalid Team Names: Refer to Team Abbreviations Guide
4. Permission Errors: Run permission fix scripts
5. Service Not Starting: Check configuration syntax and required fields

Debug Tools

• Web UI Logs Tab: View real-time logs
• Raw JSON Tab: Validate configuration syntax
• System Actions: Restart services with new configuration
• Cache Management: Clear cache when configuration changes

Getting Help

• Troubleshooting Guide: General Troubleshooting
• Configuration Examples: Configuration Guide
• Manager Documentation: Complete Manager Guide
• Web Interface Help: Complete Web UI Guide

---

This reference guide connects every configuration option to its corresponding manager and documentation, making it easy to understand and configure your LEDMatrix system.