Skip to content

Latest commit

 

History

History
83 lines (61 loc) · 1.57 KB

QUICKSTART.md

File metadata and controls

83 lines (61 loc) · 1.57 KB

🚀 Quick Start Guide

Step 1: Setup Project

# Clone or download project
cd screen-light-sync

# Run setup script
./setup.sh

Step 2: Configuration

# Copy example environment file
cp .env.example .env

# Edit configuration with your favorite editor
nano .env
# or
code .env

Edit these variables in .env:

  • HA_URL: Your Home Assistant URL
  • HA_TOKEN: Long-lived access token from HA
  • LIGHT_ENTITY: Your smart light entity ID

Step 3: Test Connection

# Activate virtual environment
source venv/bin/activate

# Test connection
python main.py --test

Step 4: Run Application

Using helper script:

./run.sh

Or manually:

# Basic mode
python main.py

# Fast mode
python main.py --fast

# Dominant color mode
python main.py --mode dominant

# Custom interval
python main.py --interval 1.0

🎯 Quick Tips

  • High performance: Use --fast mode
  • Accurate colors: Use --mode dominant
  • Low CPU: Increase --interval to 1.0 or higher
  • Multiple monitors: Use --monitor 2 (for second monitor)

🆘 Quick Troubleshooting

Issue Solution
Import error pip install -r requirements.txt
Connection failed Check URL & token in .env file
Entity not found Verify entity ID in Home Assistant
Performance slow Use --fast mode

📱 Home Assistant Setup

  1. Settings → People → Users → [Your user] → Security
  2. Create "Long-Lived Access Token"
  3. Copy token to HA_TOKEN in .env file
  4. Find entity ID in Developer Tools → States