SEPTENTRIO PolaRx5TR, Reference Manual

Page: 74 / 512

3 Command Line Reference
3.1 Command Line Interface Outline
The receiver outputs a prompt when it is ready to accept a user command. The prompt is of
the form:
CD>
where
CD
is the connection descriptor of the current connection, e.g. COM1 (see sec-
tion1.1.5).
The prompt indicates the termination of the processing of a given command. When send-
ing multiple commands to the receiver, it is necessary to wait for the prompt between each
command.
Sometimes a connection is not configured to accept user commands, for example because
it is put into differential correction input mode. A way to force a connection to accept com-
mands is to send a succession of ten “S” characters to that connection and then to press the
enter key (
SSSSSSSSSS<CR>
). See also the description of the
setDataInOut
command.
3.1.1 Command Types
Most commands fall into one of the following categories:
set
-commands to change one or more configuration parameters;
get
-commands to get the current value of one or more configuration parameters;
exe
-commands to initiate some action;
lst
-commands to retrieve the contents of internal files or list the commands.
Each
set
-command has its
get
-counterpart, but the opposite is not true. For in-
stance, the
setNMEAOutput
command has a corresponding
getNMEAOutput
, but
getReceiverCapabilities
has no
set
-counterpart. Each
exe
-command also has its
get
-counterpart which can be used to retrieve the parameters of the last invocation of the
command.
3.1.2 Command Line Syntax
Each ASCII command line consists of a command name optionally followed by a list of ar-
guments and terminated by <CR>, <LF> or <CR><LF> character(s) usually corresponding to
pressing the "Enter" key on the keyboard.
To minimize typing effort when sending commands by hand, the command name can
be replaced by its 3-5 character mnemonic. For instance,
grc
can be used instead of
getReceiverCapabilities
.
The receiver is case insensitive when interpreting a command line.
74