5 Command Channel Primer
5.1 Command Channel Commands
All iVu command channel request command frames use the following syntax:
>> command group item value
<EOF>
Notes
<EOF> is the end-of-frame delimiter. See below for a description.
All commands are in ASCII and are case-insensitive
command
An action to be performed on a particular iVu group; for example, get, set, do, login, or logout.
group
Identifies the iVu group that the command should act upon; for example, info, system, trigger, or bcr_input.
item
Further qualifies the action by specifying an item within the identified group; for example, comparedata or status.
value
For set commands, this identifies the data that must be set for the specified group item.
Note: Item is not used with get commands.
<EOF>
Identifies the end-of-frame for the command so that the iVu knows to begin processing. The iVu will return a
response that includes the end-of-frame delimiter. The options for the <EOF> are set in the iVu Serial I/O menu,
and are as follows:
•
<comma>
•
<colon>
•
<semicolon>
•
<CR>
•
<CR><LF>
•
<LF><CR>
•
<ETX>
NOTE: When data is displayed on iVu screens such as the Port Status screen, printable
delimiters are displayed as expected. Non-printable characters, such as <CR> are
displayed in hex notation (\x0D).
5.1.1 Command Flow
The command flow should be such that a new command request should not be issued until the iVu command channel
acknowledges the previous command request.
For example, the following is a series of command requests and responses. The first request sets the trigger mode to
command and, once the sensor responds with an "OK," the next command request is issued to do (or execute) the trigger.
>>
set trigger mode command
\x0D\x0A
<<
OK\x0D\x0A
>>
do trigger
\x0D\x0A
<<
OK\x0D\x0A
5.1.2 String Delimiters and Escaping
By default setting, all strings used in commands are enclosed in quotation marks (""). All text in quotes is part of the
command. Quotes (") or back-slashes (\) that are part of the string must be escapted with a back-slash. For example:
"abc\"def\"ghi\\jkl"
Set the String Delimiter parameters to 'None' if strings should not be enclosed in quotation marks.
5.1.3 Command Channel Command Synopsis
There are a number of general types of commands to do, set, and get sensor data.
iVu Plus BCR Communications
18
