NPM Library

Q-SYS Remote WebSocket Control (QRWC) is an Node Package (NPM) library designed to facilitate the interaction between third-party software and Q-SYS design controls. It enables developers to manage and control Q-SYS components through WebSocket connections, providing a seamless integration experience. For more detailed information, code examples, and package release, visit the Q-SYS NPM Package.

The QRWC repository is intended for developers integrating custom software with Q-SYS systems. It requires Q-SYS Designer Software version 10.0 or higher. The library offers tools for controlling and monitoring Q-SYS components, making it easier straightforward to build custom control front-ends and web applications.

  1. QDS Version 10.0 or newer.
  2. NodeJS.
  3. QRWC NPM package.
  4. Access Token - required when Access Control is enabled on the Core. See Access Management > Access Tokens.

To begin using QRWC, developers need to import the library and establish a WebSocket connection to the Q-SYS Core. The library provides methods for attaching WebSocket connections, starting the control process, and accessing updated components and controls. This setup allows for real-time communication and control adjustments, ensuring efficient and responsive integration.

To install QRWC using NPM, use the following PowerShell command in your JavaScript app directory:

npm install @q-sys/qrwc

Properties

Name

NPM Library Naming

Attribute

Comment

Polling Interval

pollingInterval

number

Interval in milliseconds for polling control changes. The default polling rate is 350, or roughly 3 times a second

Component Filter

componentFilter

(componentState: IComponentState) => boolean

Filter function callback to allow for connecting to only specific components in a design. The default is to discover all script access “External” or “All” components in the design.

Timeout Interval

timeout

number

Timeout interval in milliseconds for WebSocket messages. Default timeout is 5000.

API Access Token

apiKey

string

The access token generated in Core Manager, required when connecting to Cores with Access Control enabled.

If no options are provided for the following parameters, QRWC will initialize the socket to the default settings.

Because the QRWC library is continuously updated with new features and enhancements, please refer to the Q-SYS NPM Package.