Command help, Predefined parameter values, Query the current setting – RGB Spectrum Quadra User's Guide User Manual

Page 62: Parameter ranges, Addressable commands

Advertising
background image

C O M M A N D L I N E I N T E R F A C E

Command Format

350-7951

Quadra User’s Guide

54

.

. .

.

.

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

To execute commands, each command line must be followed by a

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

carriage return (pressing

Enter

).

. . . . . . . . .

COMMAND HELP

S

Commands:

Help

There are two primary ways to use the Quadra’s help feature:

Type

HELP

to list all Quadra commands.

Type

HELP

followed by the command to get command-specific help.

S

Example: Type

H BRI

to get help on the Brightness

function.

S

Example: Type

H WSR

to get help on the Window Source

Rectangle function.

PREDEFINED

PARAMETER

. . . . . . . . .

VALUES

Some commands have predefined values, and only these may be used as
parameter choices. Predefined parameter choices are indicated as

<value1|value2|value3>

S

Example:

The choices for

BAUDrate

are:

<9600 | 19200 | 38400 | 57600 | 115200>

QUERY THE

. . . . . . . . .

CURRENT SETTING

When a command is entered without any parameters, Quadra reports back the
current settings of the selected parameter.

S

Example:

What is the current baud rate setting ?:

BAUDrate

would return:

9600

PARAMETER

. . . . . . . . .

RANGES

Parameter values may be a “range” of values, or a defined set of choices (as
described above in the “

Predefined Parameter Values

” section).

Ranges are indicated as:

<value1 ... value2>

S

Example

: The value of

BRIght

is a range of

<-500 ... 500>

ADDRESSABLE

. . . . . . . . .

COMMANDS

Commands such as

BAUDrate

do not need an explicit address, as Quadra has

only a single serial port. However, other commands can be applied to several
destinations. For example the “brightness” command can apply to all Quadra
inputs or to an individual input — depending upon how the command sequence
is structured.

Advertising