Custom Controls

The Custom Controls component allows you to create a component with various types of Controls that can be used to control other components in your design through use of the Control Pins.

The Custom Controls component has only Control Pin Input and Output, no audio inputs or outputs.
You can create a Custom component with the type and number of controls you want.
Controls of the same type are in Groups. You cannot have duplicate Groups in the same Component.
You can have up to 10 different types, or Groups, of controls.
Each Group can have up to 32 controls (of the same type).
Each Group can have a different number of controls.
You can give a label to the Custom Controls component by selecting the component in the Schematic and simply start typing and press enter or click off of the component when you're finished. You cannot "edit" the label once it has been entered, but you can replace the label in the same way it was entered initially.

Properties

Custom Controls Properties

Type

Selects the type of control for the Group.

Initially, there is only one Group visible. When you select a Type for the first Group, a second Group is displayed, and so on until you have 10 Groups.

When you select a Type, Control Pins for each control of that Type, display below the Component in the Schematic, and below the Properties in the Control Pins Section.

Count

Selects the number of controls for the Group. Each Group can have a different Count. The options are 1 to 32.

Default Range Message

Some of the Control Types have variable ranges. This message gives the default range for the specific Control. If there is no range, as with a Toggle Button, there is no message.

Customize Range

Specifies if you want to customize the Control's range or not.

Minimum

If you set the Customize Range to Yes, enter the minimum of the desired range.

Maximum

If you set the Customize Range to Yes, enter the maximum of the desired range.

Graphic Properties

Label

Use the Label property to change the name of the component in the schematic. The Label property defaults to the component name. To learn more about renaming schematic elements, see Organizing Your Design.

Position

The coordinates reference a specific place in the schematic - for example,"100,100" (horizontal, vertical). 0,0 is the upper left corner of the schematic.

Fill

Sets the fill color of the component in the schematic.

Script Access Properties

Code Name

Displays the currently assign name for control access. You can use the auto-assigned name or customize it. Q-SYS will automatically check all Code Names in the design to ensure name is unique.

Script Access

Defines whether the component will be accessible by script and/or externally, or not at all. Choices include All, External, None (default), and Script.

None (default) - Not accessible by any script, plugin, or by Q-SYS Remote Control Protocol (QRC).
Script - Can be accessed by scripts, such as Text Controller, Block Controllers, and plugins only.
External - Can only be accessed by 3rd party controls systems using component commands from the Q-SYS Remote Control Protocol (QRC).
All - No restrictions, can be accessed by 3rd party control systems via Q-SYS Remote Control Protocol (QRC), or script objects or plugin objects.

Tip: Use Script Programmer Mode to quickly view the Script Access setting directly on the component in the design schematic without the need to disconnect from the Q-SYS Core processor.

Controls

The available Controls are listed in the Available Controls, and Ranges table under Properties. Their individual functions depend on how you use them. In some cases, the ranges of the Controls can be customized.

Available Controls, and Ranges

Type	Default / Range	Custom
Type	Default / Range	Minimum	Maximum
Distance knob (meters)	0 to 100	0	999
Frequency knob (Hz)	20 to 20000	0.1	20000
Generic float knob	0 to 1	-1,000,000,000	1,000,000,000
Generic integer knob	0 to 1	-2,147,483,648	2,147,483,647
Hexadecimal knob	0x0 to FFFFFF	0	8 bits (24)
LED	Off / On	—	—
Level fader w/taper (dBFS)	-100 to 10	—	—
Level knob (dBFS)	-100 to 20	-100	100
Meter (dB)	-100 to 20	—	—
Momentary button (Click, hold, release)	Off / On	—	—
Mute button (Toggle)	Off / On	—	—
Pan knob	-1 to 1	—	—
Percent knob (%)	0 to 100	0	100
Position knob	0 to 1	—	—
Status Display	0 = OK - Green 1 = Compromised - Orange 2 = Fault - Red 3 = Not Present - Gray 4 = Missing - Red 5 = Initializing - Blue	—	—
Text display	—	—	—
Text edit	—	—	—
Time knob (seconds)	0 to 1	0	86,400
Toggle button	Off / On	—	—
Trigger button (single pulse)	Off / On	—	—
<Remove> (Can only be used on the last in list)	—	—	—

Control Pins

For each Control you select, Input and Output Control Pins are supplied.

When you select a Control Type in the Properties, there are no "selectable" Control Pins in the right-side pane.

Note: The values in the following table are taken at the default setting of the Control.

Pin Name	Value	String	Position	Pins Available
Distance	0 to 100	—	0.00 to 1.00	Input / Output
Frequency knob (Hz)	0 to 25 and Infinity	10 Hz to 20.0 kHz	0.00 to 1.00	Input / Output
Generic float knob	0 to 1	0 to 1.00	0.00 to 1.00	Input / Output
Generic integer knob	0 1	0 or 1	0 1	Input / Output
Hexadecimal	0x0 to FFFFFF	—	0.00 to 1.00	Input / Output
LED	0 1	false true	0 1	Input / Output
Level fader (dBFS)	-100 to 20	-100dB to 20.0dB	0.00 to 1.00	Input / Output
Level knob (dBFS)	-100 to 20	-100dB to 20.0dB	0.00 to 1.00	Input / Output
Meter (dB)	-100 to 20	-100dB to 20.0dB	0.000 (-60 dB) 1.000	Input / Output
Momentary button	0 1	false true	0 1	Input / Output
Mute button	0 1	unmute mute	0 1	Input / Output
Pan knob	-1 to 1	-1.00 to 1.00	0.00 to 1.00	Input / Output
Percent knob	0 to 1		0 to 1	Input / Output
Position knob	0 to 1	—	0 to 1	Input / Output
Status display Component status is conveyed with the Status LED and Status box, which uses both color and text to indicate the current condition: OK: The device is functioning normally. Initializing: The device is in the process of a firmware or configuration update, or the design is starting. Compromised: The device is functioning, but a non-fatal problem exists. Refer to the Status box for details. Missing: The device cannot be discovered. Fault: The device is malfunctioning or is not properly configured. Refer to the Status box for details. Unknown: This status appears during a Core reboot (for example, during a firmware update), or when a design is being uploaded to the Core and before it has started running. Not Present: If applicable to the device, this status appears when the device is not connected to the network and its Is Required component property is set to 'No'. This status also appears if the device component's Dynamically Paired property is set to 'Yes', pairing has not been assigned in Core Manager, and the device component's Is Required property is set to 'Yes'. See Dynamic Pairing.	0 to 5	OK (Green) Compromised (Orange) Fault (Red) Not Present (Gray) Missing (Dark Red) Initializing (Blue)	N / A	Input / Output
Text display	¹	text	¹	Input / Output
Text edit	²	text	²	Input / Output
Time knob (seconds)	0.000 to 1.00	0 ms to 1 s	0.000 to 1.00	Input / Output
Toggle button	0 1	false true	0 1	Input / Output
Trigger button				Input / Output
1. If there is a value/position type input to a Text Display there will be a value, string, and position output as well. If there is a text input, there is no value or position output, only text. 2. If there is a numeric entered, or a value/position type input to a Text Edit box, there will be a value, string, and position output. If there is text entered, or input via the Control Pin, to a Text Edit box, the output is only text.

Custom Controls

Inputs and Outputs

Custom Controls Properties

Type

Count

Default Range Message

Customize Range

Minimum

Maximum

Graphic Properties

Label

Position

Fill

Script Access Properties

Code Name

Script Access

Available Controls, and Ranges

1. If there is a value/position type input to a Text Display there will be a value, string, and position output as well. If there is a text input, there is no value or position output, only text.

2. If there is a numeric entered, or a value/position type input to a Text Edit box, there will be a value, string, and position output. If there is text entered, or input via the Control Pin, to a Text Edit box, the output is only text.

Using Components with Snapshot Controller Ramp Time