User guide

Chapter 3 - RATC2
34 Version 1.7.2.0 March 27, 2015
.
controlGet command
Command
controlGet
Shortcut
cg
Arguments
control alias
Availability
when logged in
Purpose
To read the current value and position of a control
Notes
This command returns the control alias name, the string value of the
control (such as "6.2dB"), and the positional value (0.000 through 1.000).
When the control name has spaces, the argument should be enclosed in
double-quotes, as in: controlGet "Master Gain"
Response
Something like this: valueIs "Master Gain" -90.0dB 0.100
Usage Example
The client issues:
controlGet "Main Gain"\r
or
cg "Main Gain"\r
The Control Alias name is enclosed in quotes to support names with embedded spaces. In fact,
the quotes are not required for the command argument if the Control name has no embedded
spaces.
Response
valueIs "Main Gain" 1.99dB 0.864\r\n
Note: The positional scale of 0.864 is on a 0.000 to 1.000 scale, but can be read as 86.4% of the
control's range. The first value after the alias name is the exact reading of the control (known
as the "string value") and will differ, depending on the control type, however, all responses use
this 0.000 to 1.000 scale for the last element of the response.
Possible Error Messages
\aBadArgumentCount\r\n
\anotLoggedIn\r\n
\aUnlistedControl "AliasName"\r\n
\aOverflow\r\n