Basic Remote Terminal Commands

Product:Composer Management Software

Type: Control

Basic Remote Terminal Commands

In the troubleshooting or information gathering process there may be times that certain commands become apparently beneficial to have at the ready. Here is a basic list of commands that can be used in Composer’s Remote Terminal (Tools > Launch Remote Terminal). Remember, the correct unit IP address must be specified in the top left “IP Address” field.

IMPORTANT NOTE: Some of these commands will require Remote Terminal be in Debug Mode (Ctrl+D or Options > Debug Mode). Use these commands exactly as shown and explained below. Remote Terminal sending/receiving false or incorrect command data can produce unintended negative results. Be aware of any currently passing signal that may be affected by any reboots or changes in parameter values as this could transfer to downstream equipment.

 

 

COMMANDDESCRIPTION
BR [<milliseconds>]Reboots the Audinate Brooklyn card, which controls all Dante operations.  If <milliseconds> is specified, it reboots the card immediately then stalls for the specified time.  Otherwise, it marks the card as needing to be rebooted and allows the state machine to reboot it when appropriate.
CC <controller> <Inc/Dec> <amount>CHANGE CONTROLLER:
Changes the specified (decimal) by (0-65535 or 0-100%). If = 1, then the amount is added to the current value. If = 0, the amount is subtracted. If changing by the amount specified would result in an under- or over-flow, the value is clamped to zero or 65535 respectively.
CMV <action>[<format>] <unit>.<module>.<feature>.<enumerator> [<value>]Changes a module and/or gets its current state.  This command is used for fixed modules, e.g. the Super Matrix.
<action> can be one of the following: Set, Get, Modify, Toggle, Reset
<format> allows specifying the format of <value> and of the returned data.  If no option is specified, it uses the native format for that particular control, i.e. dB for gains, 0/1 for Booleans, milliseconds for delay, and percentage for pans.  Other options are ‘P’ for percentage 0-100% and ‘L’ for the legacy 0-65535 range.
<unit> is the unit enumerator after the dash shown in the Composer above each unit, e.g. “Edge-1” means <unit> = 1.  If <unit> is 0, the unit receiving the command is used.
<module> specifies which module to control.  For the Super Matrix, the module number is always 1.
<feature> may be any of the following for the matrix mixer:
    CPGain            Crosspoint Gain
    CPConnect      Crosspoint Connect status
    CPDelay          Crosspoint Delay
    IMute               Input Mute
    IGain                Input Gain
    ISolo                 Input Solo
    IPan                  Input Pan
    OMute              Output Mute
    OGain               Output Gain
    OPre                  Output Pre/Post
<enumerator> specifies which crosspoint, input, output, etc. to control.
Matrix crosspoints, will be identified with an “IxOy” syntax, e.g. “I3O4” refers to input #3 output #4.
For parameters that refer only to an input or output and not a crosspoint, specify just the “I” or “O” part, e.g. “I3” or “O1”.
<enumerator> may also be specified as a contiguous range or arbitrary set of values.  This format is indicated by enclosing the enumerator in {curly brackets}.  For a range, a colon is used to separate the beginning and ends of the range.
For example “{I1O1:I3O4}” specifies a 3×4 rectangle of values with upper left of Input #1 Output #1and lower right at Input #3 Output #4.
Sets of values are specified using comma-delimited lists. For example “{I1O1,I3O3,I16O12}” specifies 3 different crosspoints at input 1/output 1, input 3/output 3, and input 16/output 12.
 Sets and ranges may be combined, so several ranges may be set in a single command.
<value> is only used for Set and Modify actions. It may be in 1 of 3 different formats described in the <format> field.
For percent and native mode, values may be floating-point of any precision. Legacy 16-bit mode uses integers between 0-65535.
In native mode, all gains are expressed in dB. Boolean parameters should be either 0 or 1.
Delay values are in fractional milliseconds.
Only one <Value> may be provided in each command, which will be applied to all parameters specified by the <enumerator>.

Basic Examples:
CMV Set 0.1.CPGain.I3O6 4.1 – Set the crosspoint gain for input #3 going to output #6 to 4.1 dB.
CMV Set 0.1.CPConnect.I13O76 1 – Turns on the crosspoint for input #13 going to output #76.
CS <controller> <value>Sets the specified <controller> to <value> (0-65535 or 0-100%). 
EH[T] <value>Turns serial port echo on or off. A <value> of zero value turns echo off. Any non-zero <value> turns it on. The default is 0. This setting is stored in flash. Turn echo off when using an AMX or Crestron control system with Symmetrix to avoid receiving the sent commands. Turn it on when using a terminal program for test and debug so you can see what you are typing. (Some terminal programs allow turning on local echo themselves, in which case you can turn it off in hardware.)
Adding the T option changes the setting only temporarily and does not store in flash (e.g. EHT 0).
FU [<count> <fast>]]Flashes the unit’s front panel LEDs <count> times. Used to identify units. If <count> is not specified, it defaults to 8.  A <count> of zero stops the flashing immediately.  If <fast> is a positive number, it flashes at a higher rate on supported hardware.
GCReturns the currently running configuration number. One, the normal case, indicates the saved (F4 pushed) configuration is running. Zero indicates the active configuration is not the saved configuration (i.e. something else F5 pushed from the host). –1 indicates that nothing has been pushed.
GDBR[V]Returns a detailed printout of all Dante devices discovered on the network, lower level “raw” data. If “V” is included, more verbose information is shown.
GPRReturns the last preset that was recalled (1-1024). Zero indicates that no preset has been loaded. If no configuration is running, the command fails.
GPU [<low> [<high>]]Get a list of controllers enabled for push. All controllers between <low> and <high> inclusive that are enabled for push are printed out in a list. If neither <low> or <high> are specified, the entire range is displayed. If only one parameter is specified, it is treated as <low> and the maximum value for <high> is used, i.e. all controllers greater than or equal to <low> are displayed. Special case: “GPU 0” displays global settings related to push rather than the list.
GS[2|3][%] <controller>Gets the controller value of the specified controller. If “%” is included, the returned value is a percentage between 0-100%. Otherwise it is a value between 0-65535.  The [2] option returns the controller number along with the value. The [3] option returns “GS3” then the controller number along with the value.
GSB[2|3] <controller> <count>Gets <count> consecutive controller values starting with the specified controller. If “%” is included, the returned values are percentages between 0-100%. Otherwise they are values between 0-65535. The [2] option returns the controller numbers plus the values. The [3] option returns “GSB3” then the controller numbers along with the values. The <count> parameter is limited to 256.
GSYSS <unit>.<resource>.<enum> [.<card>.<channel>]
Examples:
  GSYSS 1.1001.4.0  returns the name of speed dial #5 on unit 1, card A.  No <channel> specification is necessary.
  GSYSS 2.1003.1.3.1 returns the caller ID on unit 2 for line 2 appearance 2 on card D.		Gets the system string resource defined by the 5 parameters listed. Supported values for <resource> are 1000 for speed dial number, 1001 for speed dial name, 1002 for dialed number, and 1003 for caller ID.
<unit> is the unit enumerator after the dash shown in the Composer above each unit, e.g. “Edge-1” means <unit> = 1. If <unit> is 0, the unit receiving the command is used.
<enum> is zero based, 0-19 for speed dials, 0-1 for VoIP call appearances.  <card> is 0-3 for A-D, 0 where not applicable.
<channel> is zero based, 0 where not applicable. <card> and <channel> may be omitted.
HELPReturns detailed help on a particular command or a brief description.
INFO [<option>]Displays detailed system information about the unit including firmware version, network settings, temperature, etc.. An <option> may be specified to limit information to a specific type.
Examples:
INFO CARDS – Get I/O card information
INFO DANTE – Get Dante card and network information
INFO TIME – Get time/date information
INFO POWER – Get power rail information
LP[G] <preset>Load preset #<preset>, a number between 1 and 1000. If “G” for global is specified, the unit that receives the command will distribute it to other units in the system with the same site ID to load the preset globally.
PUE [<low> [<high>]]Enable controllers for push. All matching controllers between <low> and <high> inclusive are enabled for push.  The range is additive. If neither <low> nor <high> are specified, the entire range is enabled.  If only one parameter is specified, just that single controller is enabled.
PUC [<low> [<high>]]Clears the “changed” state of RS-232 push data. This command would typically be executed with push disabled, and then when it is enabled, would prevent any previous changes from being pushed, starting fresh. <low> optionally sets the lowest controller number to clear and <high> optionally sets the highest controller number to clear. If neither is specified, the entire range will be cleared. You may specify <low> without <high> but not vice versa. If executed on a ring master, this command will be broadcast to all other units.
PUD [<low> [<high>]]Disable controllers for push.  All matching controllers between <low> and <high> inclusive are disabled for push. The range is subtractive. If neither <low> nor <high> are specified, the entire range is disabled. If only one parameter is specified, just that single controller is disabled.
PUE [<low> [<high>]]Enable controllers for push. All matching controllers between <low> and <high> inclusive are enabled for push. The range is additive. If neither <low> nor <high> are specified, the entire range is enabled. If only one parameter is specified, just that single controller is enabled.
PUI <milliseconds>Sets the push update interval, that is, how often the master unit polls a single unit for new data to push. This used to be fixed at 100 ms, but now with Ethernet push, this can be faster since we aren’t necessarily limited by the RS-232 baud rate. <milliseconds> sets the update time in milliseconds between 20 and 30,000 (30 seconds).
PUR [<low> [<high>]]Push Refresh PUR [ []] Forces a refresh and push of RS-232 push data. optionally sets the lowest controller number to refresh and optionally sets the highest controller number to refresh. If neither is specified, the entire range will be refreshed. If only one parameter is specified, it will be interpreted as the value and all controllers from this value to 10,000 will be refreshed. To refresh a single controller, specify that for both and . If executed on a ring master, this command will be broadcast to all other units.
PUT [<parameters> [<meters>]]Sets the push threshold, that is, how often much the current value must differ from the previous pushed value in order to push again. The values for meters and all other parameters may be set independently. If specified, <parameters> sets the threshold for parameters other than meters, between 0 and 65,535. If specified, <meters> sets the threshold for meters. If only one parameter is specified, it is used for both. If no parameters are specified, the default of 1 is used for both. A value of zero means that the value will be pushed if there is any change to the underlying DSP parameter, and was the default behavior prior to SND V7.0.
R!Resets the main processor and forces re-initialization of most hardware.
R!!Resets the main processor and forces re-initialization of all hardware including rebooting the Brooklyn card.
SB <baud>Sets the baud rate of the debug serial port (normally the rear serial port) to the value specified by <baud> in bits/second. Valid values for <baud> are 1200, 2400, 4800, 9600, 19200, 31250, 38400, 57600, 115200, and 230400. The default 57600. This setting is stored in flash. A reset is required for this to take effect.
SQ[T] <value>Turns quiet mode on or off. A <value> of zero value turns quiet mode off. Any non-zero <value> turns it on. The default is 1. This setting is stored in flash. When quiet mode is on, abbreviated responses are returned for easy machine parsing. Otherwise, lengthy human-readable responses are returned. Use quiet mode when using an AMX or Crestron control system with SymNet. Turn it off when using a terminal program for test and debug.
Adding the T option changes the setting only temporarily and does not store in flash (e.g. SQT 0).
SSYSS <unit>.<resource>.<enum> [.<card>.<channel>]=[<value>]
Examples:
  SSYSS 1.1001.2.0.0=Acme Inc. sets the name of speed dial #3 on card A to “Acme Inc.”.
  SSYSS 3.1000.20.3.0=555-1234 sets the number of speed dial #19 on card D to “555-1234”.		Sets the system string defined by the 5 parameters above to <value>.  If <value> is omitted, the string is cleared. <unit> is the unit enumerator after the dash shown in the Composer above each unit, e.g. “Edge-1” means <unit> = 1. If <unit> is 0, the unit receiving the command is used. Supported values for <resource> are 1000 for speed dial number, 1001 for speed dial name, 1004 for VoIP direct dial. <enum> is zero based, 0-19 for speed dials.  <card> is 0-3 for A-D, 0 if not applicable. <channel> is zero based, 0 if not applicable.
SV [C<card>] <I/O> <level>Sets the analog volume control of the specified I/O, 1-8 = input, 101-108 = output, 0 = all inputs, 100 = all outputs, 1000 = all inputs and outputs on I/O card <card>. <card> can be 1-4 or A-D. If not given, card A is assumed. For units without separate cards, omit this parameter.
VReturns the current hardware revision and firmware version/build date.