Command Format - Scanivalve DSA5000 Series Operation And Service Manual

Section 5: Software

Command Format

All of the commands accepted by the DSA are explained with the following sections: command, syntax, parameters/argu-
ments, description, returns, examples, and default values and notes when applicable. The table below is the standard format
for describing all available commands in the DSA. Please review this for information on each section of each command.
COMMAND
TYPE
DESCRIPTION
SYNTAX
RETURNS
EXAMPLE
NOTES
Lists the name of the command.
Lists the type of command. There are three types of commands in the DSA:
Get - a Get type command retrieves information
Set - a Set type command will set configurations and variables. There commands typically
require one or more arguments or a value.
Function - a Function command will case the DSA to start a process or function. These com-
mands may not return any data.
A command can be one or more types.
Describes the function of the command.
Lists the format of the command. The following conventions are used:
BP - Boldface letters indicate command keywords and operators. Within the discussion of
syntax, bold type indicates that the text must be entered exactly as shown.
<parameter> - Words in < > indicate place holders for arguments, parameters, or values that
must be supplied.
[<parameter>] - Parameters in [ ] indicate place holders for optional arguments that are not
required.
data - Example return data is shown in italics.
data - Example commands are show in bold.
, - Commas separate options, only one of the options may be used.
Lists the format of the information that the unit returns to the host. This manual shows all exam-
ples as if PROMPT 3 > is configured. See the prompt variable or DSA Data Output Definitions for
more information.
Example commands and do not necessarily apply to all applications.
When "//" is used, this indicates a comment to explain the commands that proceed it and are not
used in the command sequence.
Additional comments or notes relevant to the command or arguments.
40
40
DSA5000