Connect to a Q-SYS Core or to Q-SYS Designer running in Emulate mode (press F6 in Designer), over the QRC protocol (TCP). For a local emulator use host "127.0.0.1" and port 1710. Must be called before any other tool.

Get the Q-SYS engine status: platform, design name, run state, emulator flag.

List named components in the running/emulated design, with type and properties (Component.GetComponents). On large designs use filter/type/names_only to trim the response.

List a named component's controls and current values (Component.GetControls). Use filter/names_only to trim large components.

Get the current values of one or more Named Controls (Control.Get).

Get specific control values within a named component (Component.Get).

Set a Named Control value, optionally ramped over a number of seconds (Control.Set). This MUTATES the running/emulated system.

Set one or more control values within a named component, each optionally ramped (Component.Set). This MUTATES the running/emulated system.

Recall control settings from a saved snapshot bank/number, optionally ramped over seconds (Snapshot.Load). This MUTATES the running/emulated system.

Capture the current control settings into a snapshot bank/number (Snapshot.Save). This OVERWRITES the stored snapshot.

Create a change group (or add Named Controls to an existing one) so you can poll for changes (ChangeGroup.AddControl).

Poll a change group; returns the controls that changed since the last poll (ChangeGroup.Poll).

Add a named component's controls to a change group so you can poll them for changes (ChangeGroup.AddComponentControl).

Destroy a change group, freeing its server-side state (ChangeGroup.Destroy).

Remove Named Controls from a change group, leaving the group in place (ChangeGroup.Remove). Returns any unknown control names.

Remove all controls from a change group without destroying it (ChangeGroup.Clear).

Invalidate a change group so the next poll resends every watched control, not just the changes (ChangeGroup.Invalidate). Handy after a reconnect to force a full snapshot.

Close the QRC connection to the Core/emulator. A later qsys_connect is required before other tools.