Used for environment variable management, particularly for storing OpenAI API keys and other sensitive configuration
Integrated testing framework for validating Q-SYS component interactions and connection functionality
Package management for running and testing the MCP server application
Planned integration for Phase 3 to enable AI-powered natural language processing for voice commands to control Q-SYS systems
Provides a strongly-typed environment for the MCP server implementation using TypeScript 5.8.4
Integration with Zoom Room components in the Q-SYS system for conference room audio/video control
MCP Voice/Text-Controlled Q-SYS Demo
✅ PHASE 1 COMPLETE - AI-powered voice and text control for Q-SYS audio systems using the official @q-sys/qrwc SDK and Model Context Protocol.
🎉 BREAKTHROUGH: Q-SYS Connection SUCCESS!
We've successfully connected to a live Q-SYS Core with 42 components and 3,074+ controls!
🏆 Phase 1 Achievements
- ✅ Official @q-sys/qrwc SDK Integration - Using Q-SYS's official WebSocket library
- ✅ Live Q-SYS Core Connection - Connected to professional AV system at 192.168.50.150:443
- ✅ 42 Components Discovered - Full access to audio, video, and control systems
- ✅ 3,074+ Controls Available - Real-time control and monitoring of all Q-SYS components
- ✅ WSS Protocol Working - Secure WebSocket connection established
- ✅ Real-time Events - Live update events from Q-SYS components verified
- ✅ Professional Error Handling - Robust connection management and logging
🎛️ Connected Q-SYS System Overview
Your Q-SYS system includes:
- Audio: 15 components (mixers, gain controls, mics, soundbar)
- Video: 8 components (displays, video switching, cameras, HDMI routing)
- Conference: 5 components (Zoom Room, Microsoft Teams integration)
- Control: 9 components (touchpanels, UCI controllers, encoders)
- Building: 9 components (HVAC, status monitoring, date/time)
🚀 Quick Start
Test the Q-SYS Connection
Setup Your Q-SYS Core
- Follow the setup guides:
QRWC_SETUP_GUIDE.md
- Complete Q-SYS Core configurationQSYS_SETUP.md
- Quick setup instructions
- Configure your Core IP:
- Edit
qsys-core.config.json
with your Q-SYS Core's IP address - The application will automatically load your configuration
- Edit
Development
🔧 Configuration
Q-SYS Core Configuration
Edit qsys-core.config.json
:
Configuration Setup (No Duplication!)
We use separate files for different configuration:
File | Purpose |
---|---|
qsys-core.config.json | Q-SYS Core connection settings |
.env | OpenAI API key, environment variables |
See OPENAI_SETUP.md
for complete setup instructions.
📊 Project Status
✅ Phase 1: Q-SYS Remote WebSocket Control (QRWC) - COMPLETE
- ✅ 1.1: Project Setup & Infrastructure
- ✅ 1.2: Official @q-sys/qrwc SDK Integration
- ✅ 1.3: WebSocket Connection (WSS on port 443)
- ✅ 1.4: Component Discovery & Access (42 components found)
- ✅ 1.5: Real-time Event Handling
- ✅ 1.6: Error Handling & Reconnection Logic
- ✅ 1.7: Configuration System (JSON + Environment)
- ✅ 1.8: Testing & Verification
🔄 Phase 2: MCP Server Implementation - READY
- ⏳ MCP tools for Q-SYS component control
- ⏳ Real-time component monitoring
- ⏳ Voice command processing integration
🔄 Phase 3: AI Integration - READY
- ⏳ OpenAI integration for voice processing
- ⏳ Natural language Q-SYS control
- ⏳ Conversational AV system management
🛠️ Technology Stack
Core Technologies
- TypeScript 5.8.4 - Strict typing and modern JavaScript
- @q-sys/qrwc 0.4.1-beta - Official Q-SYS Remote WebSocket Control SDK
- WebSocket (WSS) - Secure WebSocket connection to Q-SYS Core
- Winston - Structured logging with metadata
- Jest - Testing framework with async support
Q-SYS Integration
- Official Q-SYS SDK - Using @q-sys/qrwc for WebSocket communication
- Real-time Events - Component state updates and control changes
- Professional Audio/Video Control - Full access to Q-SYS design components
- SSL/HTTPS Support - Secure connections with self-signed certificate support
📁 Project Structure
🧪 Testing & Verification
Connection Tests
Application Tests
📖 Documentation
Setup & Configuration
- QRWC Setup Guide - Complete Q-SYS Core configuration
- Q-SYS Setup - Quick setup instructions
- OpenAI Setup - OpenAI API key configuration for Phase 3
- Run Instructions - Development setup
Technical Documentation
- Implementation Plan - Complete technical implementation
- Project Checklist - Phase completion tracking
- QRC Overview - Q-SYS Remote Control overview
- Component Control - Component interaction guide
Project Management
- PRD Document - Product requirements
- Cursor Rules - Development guidelines
🎯 Key Discovery: WSS Protocol
Critical Technical Breakthrough: Q-SYS Cores require Secure WebSocket (WSS) connections, not standard WebSocket (WS).
🏆 Live System Results
Connected to professional Q-SYS installation:
📄 License
MIT License - see LICENSE file for details.
🎉 Phase 1 Complete! The Q-SYS QRWC integration is fully functional and ready for MCP Server development in Phase 2.
This server cannot be installed
AI-powered system that enables voice and text control for Q-SYS audio systems using OpenAI Agents SDK and Model Context Protocol.
Related MCP Servers
- -securityFlicense-qualityA Model Context Protocol server that enables AI assistants to utilize AivisSpeech Engine's high-quality voice synthesis capabilities through a standardized API interface.Last updated -TypeScript
- -securityAlicense-qualityAn MCP server that enables LLMs to generate spoken audio from text using OpenAI's Text-to-Speech API, supporting various voices, models, and audio formats.Last updated -41JavaScriptMIT License
- -securityAlicense-qualityA Model Context Protocol server that enables AI assistants like Claude to initiate and manage real-time voice calls using Twilio and OpenAI's voice models.Last updated -44TypeScriptMIT License
- AsecurityAlicenseAqualityA Model Context Protocol server for macOS that enables AI assistants to play system sounds for audio feedback, offering informational, warning, and error sound options.Last updated -3JavaScriptMIT License