Add ESP32 Bluetooth relay integration documentation to README

This commit is contained in:
2025-12-15 16:25:58 +11:00
parent a2d8cc7b8d
commit 7ab41c17ce

View File

@@ -12,6 +12,12 @@ A sophisticated NFC-based video player system designed for an immersive drive-in
- **Unattend Mode**: Automatic cycling through content (3 trailers + 1 movie pattern) - **Unattend Mode**: Automatic cycling through content (3 trailers + 1 movie pattern)
- **Global NFC Capture**: Works even when video is fullscreen - **Global NFC Capture**: Works even when video is fullscreen
- **Multi-Device Support**: Control from desktop, mobile, or tablet - **Multi-Device Support**: Control from desktop, mobile, or tablet
- **ESP32 Bluetooth Relay Integration**: Automated theatre control (lights, speakers, effects)
- Auto-dim lights when movies start
- Power speakers on/off automatically
- Control up to 8 relay channels via Bluetooth
- Web dashboard relay controls
- See `docs/ESP32_RELAY_INTEGRATION.md` for setup guide
## 🚀 Quick Start ## 🚀 Quick Start
@@ -56,9 +62,13 @@ moonlight-drive-in/
├── enhanced_debug_console.py # Enhanced debug with web support ├── enhanced_debug_console.py # Enhanced debug with web support
├── web_interface.py # Flask web dashboard ├── web_interface.py # Flask web dashboard
├── web_mpv_main.py # Web-enabled entry point ├── web_mpv_main.py # Web-enabled entry point
├── esp32_relay_controller.py # ESP32 Bluetooth relay interface
├── theatre_automation.py # Theatre automation logic
├── *.bat # Windows launcher scripts ├── *.bat # Windows launcher scripts
├── dashboard.html # Web dashboard interface ├── dashboard.html # Web dashboard interface
├── validate_videos.py # Validation tool ├── validate_videos.py # Validation tool
├── docs/
│ └── ESP32_RELAY_INTEGRATION.md # Relay integration guide
└── videos/ └── videos/
├── trailers/ # Trailer video files ├── trailers/ # Trailer video files
├── specific/ # Single movie files ├── specific/ # Single movie files
@@ -93,6 +103,7 @@ Access the web dashboard for:
- 🎬 Manual video selection - 🎬 Manual video selection
- 📁 Folder management - 📁 Folder management
- ⚙️ System configuration - ⚙️ System configuration
- 💡 Theatre automation (relay controls)
### Debug Console ### Debug Console
@@ -105,6 +116,30 @@ The desktop debug console provides:
## 🛠️ Advanced Features ## 🛠️ Advanced Features
### ESP32 Theatre Automation
Control theatre equipment automatically via Bluetooth relay controller:
**Features:**
- Auto-dim house lights when movies start
- Auto-power speakers during playback
- Manual relay controls via web interface
- Programmable lighting effects
- Closing/intermission sequences
**Setup:**
1. Build ESP32 relay controller (see separate repository)
2. Pair ESP32 with computer via Bluetooth
3. Enable in `config.py`:
```python
RELAY_CONFIG = {
'enabled': True,
'auto_theatre_lights': True,
'auto_speaker_power': True,
}
```
4. Full documentation in `docs/ESP32_RELAY_INTEGRATION.md`
### Folder Sequences ### Folder Sequences
Create multi-video sequences that play in order: Create multi-video sequences that play in order:
@@ -138,6 +173,7 @@ Edit `config.py` to customize:
- Playback parameters - Playback parameters
- Display preferences - Display preferences
- Logging levels - Logging levels
- ESP32 relay automation
## 🐛 Troubleshooting ## 🐛 Troubleshooting
@@ -163,6 +199,8 @@ This checks:
**Folder sequences not advancing**: Check `folder_state.json` or reset via debug console **Folder sequences not advancing**: Check `folder_state.json` or reset via debug console
**ESP32 relay not responding**: See `docs/ESP32_RELAY_INTEGRATION.md` troubleshooting section
## 📊 System Requirements ## 📊 System Requirements
- **OS**: Windows (primary), Linux (experimental) - **OS**: Windows (primary), Linux (experimental)
@@ -170,14 +208,15 @@ This checks:
- **MPV**: Required for video playback - **MPV**: Required for video playback
- **NFC Reader**: ACS ACR122 or compatible - **NFC Reader**: ACS ACR122 or compatible
- **Network**: For web interface access - **Network**: For web interface access
- **ESP32** (optional): For theatre automation
## 🔮 Planned Features ## 🔮 Planned Features
- LEGO Dimensions Portal integration (7-zone NFC reading) - LEGO Dimensions Portal integration (7-zone NFC reading)
- Bluetooth LED controller integration
- Expanded capacity beyond 64 movies - Expanded capacity beyond 64 movies
- Additional automation patterns - Additional automation patterns
- Enhanced gallery interfaces - Enhanced gallery interfaces
- Advanced lighting effects and sequences
## 📝 License ## 📝 License