Q-SYS Lua Script Deployment Extension for VS Code

This extension allows you to edit Lua scripts in VS Code that are designed to run on a Q-SYS Core and automatically deploy them to either a running Q-SYS Core or a running instance of Q-SYS Designer in emulation mode. Big thanks to Patrick Gilligan for the inspiration for this extension.

Features

• Deploy scripts to Q-SYS Core(s) or Q-SYS Designer with a keyboard shortcut (Ctrl+Alt+D)
• Configure multiple cores with different IP addresses
• Map scripts to multiple components across multiple cores
• Support for authentication
• Validate component types before deployment

Changelog

0.3

• Enhanced "Deploy Current Script" command with interactive core and component selection:
  • When deploying to existing mapped scripts, you can now choose specific cores and components
  • "Select All" option provided at both core and component selection stages
• Reduced debug output verbosity for better readability
• Removed unused defaultCore setting

0.2

• Added support for deploying a single script to multiple Q-SYS Cores
• Added support for deploying a script to multiple components within a core
• Removed UI commands for configuration management (now done via settings.json)
• Configuration format updated to support multiple deployment targets

Requirements

• Visual Studio Code 1.60.0 or higher
• A running Q-SYS Core or Q-SYS Designer in emulation mode
• Text Controller components that have script access set to "External" or "All"

Extension Settings

This extension contributes the following settings:

• qsys-deploy.cores: Array of Q-SYS Core configurations
• qsys-deploy.scripts: Array of script deployment configurations

Example configuration:

{
  "qsys-deploy": {
    "cores": [
      {
        "name": "Main Auditorium",
        "ip": "192.168.1.100",
        "username": "admin",
        "password": "pass"
      },
      {
        "name": "Q-SYS Designer Emulation",
        "ip": "127.0.0.1"
      }
    ],
    "scripts": [
      {
        "filePath": "scripts/main-control.lua",
        "targets": [
          {
            "coreName": "Main Auditorium",
            "components": ["MainController", "SecondaryController"]
          },
          {
            "coreName": "Q-SYS Designer Emulation",
            "components": ["MainController"]
          }
        ]
      }
    ]
  }
}

Commands

This extension provides the following commands:

• Q-SYS: Deploy Current Script: Deploy the current script with interactive core and component selection
• Q-SYS: Test Core Connection: Test connection to a Q-SYS Core
• Q-SYS: Show Debug Output: Show the debug output panel with detailed logs

Debugging

If you encounter issues with deployment, you can use the debug output panel to troubleshoot:

1. Run the Q-SYS: Show Debug Output command to open the debug output panel
2. Try deploying a script or testing a connection
3. The debug output will show detailed logs of the QRC communication, including:
   • Connection attempts
   • Authentication
   • Component validation
   • Commands sent to the core
   • Responses received from the core

Usage

1. Open a Lua script file in VS Code
2. Configure your cores and script mappings in the settings.json file (see Example configuration above)
3. Edit your script and press Ctrl+Alt+D to deploy it:
   • For mapped scripts: You'll be prompted to select which cores and components to deploy to
   • For unmapped scripts: You'll be prompted to select a core and enter a component name

Todo

1. Create settings file helper - if deploying and no script/cores are defined, allow user to type and offer to add to settings.json file.
2. Improve TCP connection handling. Currently creates a TCP connection per script deployment even if deploying to multiple scripts in the same core.
3. Improve status bar connection info.

QRC Protocol

This extension uses the QRC protocol to communicate with Q-SYS Core. For more information about the QRC protocol, see:

• QRC Overview
• QRC Commands

License

This extension is licensed under the MIT License.