13.4 Command Channel Primer
13.4.1 Command Channel Commands
All iVu BCR 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 an iVu BCR group. For example, get, set, do, login, or logout.
group
Identifies the iVu BCR 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 BCR knows to begin processing. The iVu BCR will
return a response that includes the end-of-frame delimiter. The options for the <EOF> are set in the iVu BCR Serial
I/O screen, and are:
• <comma>
• <colon>
• <semicolon>
• <CR>
• <CR><LF>
• <LF><CR>
• <ETX>
Note: When data displays on iVu BCR screens, such as the Port Status screen, printable
delimiters display as expected. Non-printable characters, such as <CR> are displayed in
hex notation (\x0D).
Command Flow
The command flow should be such that a new command request should not be issued until the iVu BCR 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 iVu BCR 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
String Delimiters and Escaping
By default, 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"
iVu Plus BCR Gen2 Series Sensor
www.bannerengineering.com - Tel: + 1 888 373 6767
83
