GPIO (CX-Q, CXD-Q, DPA-Q Series)
This topic describes how to configure and control the General Purpose Input Output (GPIO) hardware interface for CX-Q, CXD-Q, and DPA-Q amplifiers in Q-SYS Designer.
The GPIO Controller is used to integrate Q-SYS with custom or third-party controls. Using the GPIO, Q-SYS can control external hardware and certain aspects of Q-SYS can be controlled by external hardware.
The GPIO Interface is physical hardware, and is represented in Q-SYS Designer by the GPIO component. There are eight configurable GPIO pins on the GPIO component. You can configure these pins to be Digital Inputs, Digital Outputs, Analog Inputs, or PWM Output. Refer to the Properties section in this topic for details.
Properties
CX-Q Amplifier Properties
Name
The Name may contain ASCII letters 'a' through 'z' (case-insensitive), the digits '0' through '9', and the hyphen. Names cannot begin or end with a hyphen. No other symbols, punctuation characters, or blank spaces are permitted.
Note: This name must match the Hostname for the device as defined in Core Manager or Peripheral Manager.
Location
User-defined name that groups the component with other components in the same physical location – for example, "Rack 1" – or in the same organizational scheme.
Is Required
When enabled, and the device is not found on the network, the device is reported as 'Missing', which is an error condition. This is the default behavior. When disabled, and the device is not found on the network, the device is reported as 'Not Present', which is not an error condition.
Dynamically Paired
Indicates that this virtual component can be paired with the same type of hardware without changing the network ID of the hardware or the name of this component. Refer to the Q-SYS Core Manager Dynamic Pairing topic for more information. The default is 'No'.
What you select in the Properties determines the use of that GPIO pin, unused, input, output, or clock.
GPIO Pin Selections
Unused
Digital Input (TTL 3.3 VDC @ 2 mA)
Analog Input
Digital Output
PWM Output (Only available for pins 1-4 and 6.)
Channel Configuration
Select the configuration needed for your venue.
Note: Eight-channel models have two sets of four channels for configuration.
- 4 Channel, A B C D
- 3 Channel, A+B Bridged
- 2 Channel, A+B Bridged C+D Bridged
- 3 Channel, AB Parallel
- 2 Channel, AB Parallel C+D Bridged
- 2 Channel, A B Parallel C D Parallel
- 1 Channel, A B Parallel Bridged with CD Parallel
- 2 Channel, A B C Parallel
- 1 Channel, A B C D Parallel
Space between letters (A B C D) = single channels, "+" between letters (A+B) = bridged, no space between letters (ABCD) = parallel. When you make your selection, then run the design, the configuration is made available to the amplifier. Follow the instructions on the amplifier display.
Standalone Mode
Standalone Mode provides the capability to connect the inputs of an amplifier to the outputs when connection to the Core is lost. In addition you can boot the amplifier without a connection to the Core.
- Off – Turns Standalone Mode off.
- One-to-one – Each audio input is routed to its corresponding output Ch1 – Output A, Ch2 – Output B, Ch3 – Output C, Ch4 – Output D.
- One-to-all – Input Channel 1 is routed to all outputs.
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 Controls are displayed in GPIO Pin number order, 1 through 8, from left to right in the Control Panel. For each control the Euro-style connector pin number is listed under the GPIO pin numbers. Refer to the GPIO Interface section in this topic.
Digital In (Indicator)
This LED lights when there is a Digital input of 1 (3.3 V TTL) present.
Analog In Volts
This knob controls the analog input level up to 3.3 V
Digital Out
This toggle button supplies:
- 0 VDC output in the 0/Off position and
- 3.3 VDC output in the 1/On position.
PWM Duty %
Sets the duty cycle of the pulse.
PWM Invert
Inverts the PWM pulse.
PWM Frequency Hz
Sets the frequency of the pulse. If there are multiple PWM assignments for one amplifier, all are controlled by the same frequency control.
Relay
This button changes position of the internal relay.
Control Pins
There is one control pin for each GPIO pin that has either Digital Input, Analog Input or Digital Output selected in the Properties. The GPIO Pins that have Unused will not have a Control Pin associated with it. For PWM there is a Duty and Invert for each PWM selected in the Properties, and one PWM Frequency for all of the PWM Outputs are selected in the Properties.
|
Pin Name |
Value |
String |
Position |
Pins Available |
|---|---|---|---|---|
|
Digital Input |
0 1 |
false true |
0 1 |
Output |
|
Analog Input |
0 to 3.3 |
0.00 V to 3.3 V |
0 to 1.00 |
Output |
|
Digital Output |
0 1 |
false true |
0 1 |
Input / Output |
|
PWM Duty |
0 to 100 |
— |
0 to 1.00 |
Input / Output |
|
PWM Invert |
0 to 100 |
— |
0 to 1.00 |
Input / Output |
|
PWM Frequency |
5.00 to 1000 |
5.00 Hz to 50 kHz |
0 to 1.00 |
Input / Output |
|
Relay Out |
0 1.00 |
false (normal) true (activated) |
0 1.00 |
Input / Output |
GPIO Interface
|
Connector Pin |
GPIO # and Function |
Specification |
16-pin Euro Style Connector |
|---|---|---|---|
|
1 |
3.3 V |
100 mA max (power cycle to reset current limiting IC) |
|
|
2 |
GPIO 1 |
5mA in/out, 3.3V max, 127 Ohm resistor in series |
|
|
3 |
GPIO 2 |
5mA in/out, 3.3V max, 127 Ohm resistor in series |
|
|
4 |
GND |
Ground |
|
|
5 |
GPIO 3 |
5mA in/out, 3.3V max, 127 Ohm resistor in series |
|
|
6 |
GPIO 4 |
5mA in/out, 3.3V max, 127 Ohm resistor in series |
|
|
7 |
GND |
Ground |
|
|
8 |
GPIO 5 |
18mA in/out max, 3.3V max, 127 Ohm resistor in series |
|
|
9 |
RELAY NO |
Relay Normally Open |
|
|
10 |
RELAY COM |
Relay Common |
|
|
11 |
RELAY NC |
Relay Normally Closed |
|
|
12 |
GND |
Ground |
|
|
13 |
GPIO 6 |
18mA in/out max, 3.3V max, 127 Ohm resistor in series |
|
|
14 |
GPIO 7 |
18mA in/out max, 3.3V max, 127 Ohm resistor in series |
|
|
15 |
GND |
Ground |
|
|
16 |
GPIO 8 |
18mA in/out max, 3.3V max, 127 Ohm resistor in series |
Behavior During Boot-up and Redeploy
Q-SYS device GPIO output states are undefined during boot-up and design redeploy. In the following table, "While On" and "While Off" indicate the button setting as defined in the running design file. During a reboot or redeploy, the setting may toggle depending on the GPIO type before returning to the defined setting after the design starts running.
Bold text indicates a temporary GPIO setting during boot-up and redeploy.
Network Amplifier GPIO
|
GPIO Type |
While On |
While Off |
|---|---|---|
|
Digital Output |
Stays On |
Toggles to On |
