Banner iVu Plus User Manual

iVu Plus BCR Communications User's Guide

Online Only - rev. A 1/7/2011

Contents

Contents

1 iVu Plus Communications ...................................................................................................3

1.1 iVu Plus Communications ........................................................................................................................3

1.1.1 Communication Channels ............................................................................................................3

1.1.2 Command Channel .......................................................................................................................3

1.1.3 Data Export ...................................................................................................................................4

1.1.4 Image Export ...............................................................................................................................5

1.2 Enabling Communications ........................................................................................................................6

1.2.1 Setting Up Ethernet Communications ...........................................................................................6

1.2.2 Setting Up Serial Communications .............................................................................................11

2 Testing and Troubleshooting iVu Plus Communications ...............................................16

2.1 Understanding the Communication Log .................................................................................................16

2.2 Ethernet I/O ............................................................................................................................................16

2.2.1 Ethernet I/O Status ....................................................................................................................16

2.3 Serial I/O .................................................................................................................................................17

2.3.1 Using the Port Status Screen for Testing RS-232 Communications ..........................................17

2.3.2 Using the iVu Command Channel Sample Application or a Terminal Program for Testing ........18

2.3.3 Verifying Basic Receive Functionality .........................................................................................18

3 Command Channel Primer ................................................................................................21

3.1 Command Channel Commands .............................................................................................................21

3.1.1 Command Flow ..........................................................................................................................21

3.1.2 String Delimiters and Escaping ...................................................................................................22

3.1.3 Command Channel Command Synopsis ....................................................................................22

3.2 Conventions Used for Examples ............................................................................................................23

3.3 Examples ................................................................................................................................................23

3.3.1 Example 1: How to Trigger the Sensor and Retrieve Barcode Data using the Command Channel

...................................................................................................................................................................23

3.3.2 Example 2: How to Modify Barcode Compare Data Using the Command Channel ...................23

3.4 iVu Plus Command Channel Reference ................................................................................................24

3.5 Command Channel Error Codes ............................................................................................................33

2 Online Only - rev. A

1 iVu Plus Communications

1.1 iVu Plus Communications

The iVu Plus provides for communicating with other devices via Ethernet or a UART serial communications port (RS-232). In order to
establish an Ethernet connection to the sensor, the external device must be configured with the correct IP address and correct TCP port
to communicate. If planning to use the serial communications connection, port settings for baud rate, data bits, parity, and stop bits must
be configured on the iVu Plus to match the settings of the external device.

1.1.1 Communication Channels

The iVu Plus BCR supports up to three communications channels. To access the channels, go to

• Command Channel — a bi-directional communication protocol that currently supports ASCII, and enables other devices to remotely
control the iVu Plus sensor and access sensor results

• Data Export — used to export selected inspection data to a remote device

• Image Export — used to export inspection images to a remote device

Data export and command channel can be configured for either Ethernet or Serial I/O (but not both); image export is only available over
Ethernet. The table below briefly summarizes valid communication channel configuration options.

Command Channels

Command Channel Yes No No Yes Yes No

Data Export Yes No Yes No No Yes

Image Export Yes No Yes No Yes No

Scenario #1 Scenario #2 Scenario #3

Ethernet Serial I/O Ethernet Serial I/O Ethernet Serial I/O

1.1.2 Command Channel

The iVu Plus BCR command channel is a bi-directional communication protocol that currently supports ASCII via either Ethernet or the
RS-232 serial interface, and enables other devices to remotely control the iVu sensor and access sensor results.

do trigger\x0D\x0A

A

B

OK\x0D\x0A

D

C

A Control Device, which can be a PLC, PC program, or a terminal C Response Frame

B Request Frame D iVu Plus Sensor

The following are some of the functionality available via the command channel:

Online Only - rev. A

www.bannerengineering.com - tel: [phone]

iVu Plus BCR Communications User's Guide

• Get sensor information (such as version and sensor name)

• Control "discrete" I/O (such as trigger and teach)

• Get sensor results (such as sensor status)

• Change the running inspection

1.1.2 Command Channel Sample Application

The iVu Plus BCR installation CD has a Command Channel sample application that provides an easy interface to execute commands. In
a production environment, you will need to create your own application for bi-directional communication with the sensor.

1.1.3 Data Export

The iVu Plus sensor provides for exporting user-selected inspection data via either Ethernet or the RS-232 serial interface. Inspection
data that can be exported includes:

• Pass/Fail Output

• Inspection Name

• Inspection Results

• Frame #

• Inspection Time (ms)

4 www.bannerengineering.com - tel: [phone] Online Only - rev. A

iVu Plus BCR Communications User's Guide

1.1.3 Sample Application

The iVu Plus BCR installation CD has a Data Export sample application that provides for viewing exported data while setting up the
sensor, etc. In a production environment, you will need to create your own application to process data exported from the sensor.

1.1.4 Image Export

Image export is only supported on Ethernet ports. Inspection images are a maximum 8-bits per pixel grayscale images in Windows BMP
format that represent all the data in a full Field of View (FOV).

Each exported image is comprised of a header (64 bytes) followed by the image data (approximately ). All 16- and 32-bit numeric entries
are little endian.

The header includes the following information:

NOTE: If FOV's are adjusted so that they are smaller, the bitmaps will also be smaller.

1.1.4 Image Export Sample Application

The iVu Plus BCR installation CD has a Image Export sample application that provides a way to save exported images. In a production
environment, you will need to write your own application to process exported images, for example to display them on an HMI or to save
them to disk.

Online Only - rev. A www.bannerengineering.com - tel: [phone]

iVu Plus BCR Communications User's Guide

1.2 Enabling Communications

1.2.1 Setting Up Ethernet Communications

The following is the general flow for setting up for Ethernet communications between the iVu Plus sensor and a remote device:

NOTE: These instructions assume that the remote device is a PC running Windows XP.

On the Windows PC, configure the IP address as follows:

Windows XP Windows 7

1. Open Network Properties on the PC (right-click on the Net­work Neighborhood icon).

2. On the Local Area Connection, right-click on Properties..

3. In the dialog, click on Internet Protocol (TCP/IP) and click
the Properties button.

1. Open Network Connections by clicking on the Start button,
then selecting the Control Panel followed by Network and In­ternet, and clicking Manage network connections.

2. Right-click the connection you want to change, then click
Properties. If you are prompted for an administrator pass­word or confirmation, type the password or provide confirma­tion.

3. In the Networking dialog, click on Internet Protocol Version
4(TCP/IPv4) and click the Properties button.

6 www.bannerengineering.com - tel: [phone] Online Only - rev. A

iVu Plus BCR Communications User's Guide

Windows XP Windows 7

4. In the Internet Protocol (TCP/IP) Properties dialog, select
Use the following IP address and make sure that the IP

address is 192.168.0.2, and the subnet mask is

255.255.255.0.

On the iVu sensor:

4. In the Internet Protocol (TCP/IPv4) Properties dialog, se­lect Use the following IP address and make sure that the
IP address is 192.168.0.2, and the subnet mask is

255.255.255.0.

1. Go to Main Menu > System > Communications > Ethernet I/O and make sure that the sensor is configured as shown below.

Online Only - rev. A www.bannerengineering.com - tel: [phone]

iVu Plus BCR Communications User's Guide

2. To enable the command channel over Ethernet:

a. Go to Main Menu > System > Communications > Command Channel > Connection , and select Ethernet [IP Port #

32000].

b. Configure the field and end-of-frame delimiters. Go to Main Menu > System > Communications > Command Channel >

Delimiters .

8 www.bannerengineering.com - tel: [phone] Online Only - rev. A

iVu Plus BCR Communications User's Guide

Valid end-of-frame delimiters are: <comma>, <colon>, <semicolon>, <CR>, <CR><LF>, <LF><CR>, or <ETX>.

c. Verify that the iVu receives and transmits data correctly.

3. To enable Data Export over Ethernet:

a. Go to Main Menu > System > Communications > Data Export > Connection and select Serial I/O from the drop-down.

Online Only - rev. A www.bannerengineering.com - tel: [phone]

iVu Plus BCR Communications User's Guide

b. Go to Main Menu > System > Communications > Data Export > Data To Export and select the inspection data to export.

c. Go to Main Menu > System > Communications > Data Export > Output Format and select the Start String, Delimiter, and

End String.

d. Go to Main Menu > System > Communications > Data Export > Advanced .

10 www.bannerengineering.com - tel: [phone] Online Only - rev. A

iVu Plus BCR Communications User's Guide

During the Data and Image export operation the sensor's output channels might become full. This can occur if the sensor is
producing export data (frames) faster than the data can be exported from the device (due to bandwidth limitations) or faster
than the client is reading the channel export data.

This setting affects how the sensor will behave in this situation.

• Select Hold READY to ensure that all frames are transmitted. In this case, the READY signal will remain inactive (sensor
is busy) until the new frame has been added to the channel for transmission. Triggers might be missed during this time.

• Select Do not hold READY to cause the sensor to discard the new frame if the channel is full and thus activate the
READY signal immediately after the current inspection is complete. In this case, the discarded frames will not be trans­mitted.

Communications Channel Ports

The following are the default Ethernet port settings for the communications channels:

• Command Channel — 32200

• Data Export — 32100

• Image Export — 32000

1.2.2 Setting Up Serial Communications

The general flow for setting up for serial communications:

1. Prepare the connection — RS-232 wiring.

Electrically connect the control device and the iVu sensor. On the iVu, the pins/wire colors used for serial communications via
RS-232 are shown in the table below.

iVu RS-232 Connections

Pin # Wire Color Description

10 Light-Blue TX

11 Black Signal Ground

12 Violet RX

2. Configure port settings (baud rate, data bits, parity, and stop bits) on the iVu to match the settings on the control device. Go to
Main Menu > System > Communications > Serial I/O .

Online Only - rev. A www.bannerengineering.com - tel: [phone]

iVu Plus BCR Communications User's Guide

3. To enable the command channel over the serial connection:

a. Go to Main Menu > System > Communications > Command Channel > Connection and select Serial I/O.
b. Configure the field and end-of-frame delimiters. Go to Main Menu > System > Communications > Command Channel >

Delimiters .

Valid end-of-frame delimiters are: <comma>, <colon>, <semicolon>, <CR>, <CR><LF>, <LF><CR>, or <ETX>.

c. Optionally, if you want to trigger the iVu from the control device, set the trigger mode to Command (go to Main Menu >

Imager > Trigger and select Command from the drop-down).

12 www.bannerengineering.com - tel: [phone] Online Only - rev. A

iVu Plus BCR Communications User's Guide

d. Verify that the iVu receives and transmits data correctly.

4. To enable Data Export over the serial connection:

a. Go to Main Menu > System > Communications > Data Export > Connection and select Serial I/O from the drop-down.

Online Only - rev. A www.bannerengineering.com - tel: [phone]

iVu Plus BCR Communications User's Guide

b. Go to Main Menu > System > Communications > Data Export > Data To Export and select the inspection data to export.

c. Go to Main Menu > System > Communications > Data Export > Output Format and select the Start String, Delimiter, and

End String.

d. Go to Main Menu > System > Communications > Data Export > Advanced .

14 www.bannerengineering.com - tel: [phone] Online Only - rev. A

iVu Plus BCR Communications User's Guide

During the Data and Image export operation the sensor's output channels might become full. This can occur if the sensor is
producing export data (frames) faster than the data can be exported from the device (due to bandwidth limitations) or faster
than the client is reading the channel export data.

This setting affects how the sensor will behave in this situation.

• Select Hold READY to ensure that all frames are transmitted. In this case, the READY signal will remain inactive (sensor
is busy) until the new frame has been added to the channel for transmission. Triggers might be missed during this time.

• Select Do not hold READY to cause the sensor to discard the new frame if the channel is full and thus activate the
READY signal immediately after the current inspection is complete. In this case, the discarded frames will not be trans­mitted.

Online Only - rev. A www.bannerengineering.com - tel: [phone]

iVu Plus BCR Communications User's Guide

2 Testing and Troubleshooting iVu Plus Communications

2.1 Understanding the Communication Log

The iVu Plus sensor includes the following Communication Logs:

• Command Channel Log that can be used to ensure that commands are properly formed (syntax is correct), and provides a history of
commands issued along with responses to these commands. To access the Command Channel Log, go to Main Menu > Logs >
Communication Logs > Command Channel .

• Data Export and Image Output logs that are purely output logs (that is, there is no receive activity to log).

Some notes about the logs:

• To see an expanded view of each entry, click on the small right-triangle control on each entry.

• To save the log, click the save icon. The saved communication log can be loaded into the emulator for troubleshooting offline.

The table below describes the icons used in the Communication Log, the up-arrow indicates an incoming request to the iVu from the
control device; the down-arrow indicates an outgoing response from the iVu to the control device.

Icon Description

Port opened.

Port closed.

For Ethernet channels:

• The channel's log will show an Enabled entry that indicates which port is being listened to.

• When a client connects, a log entry is added that indicates which IP address connected.

• When a client closes the connection, a log entry indicates that the channel is no longer being listened to.

Indicates that the command has been processed without errors.

Indicates that the incoming entry is stalled (no new bytes), or end-of-frame delimiter was not re­ceived, or client is not reading data on ethernet.

If the response frame contains an error or is dropped, the log entry icons for the request and the
response frames will be colored red, and the displayed error count will increment by one.

If the command takes a long time to process, the last long entry will change to an hourglass (for
example, during trigger of long inspections).

2.2 Ethernet I/O

2.2.1 Ethernet I/O Status

The Ethernet I/O Status screen can be used to verify that the Ethernet wiring has been correctly set up. In addition to determining if the
link has been established, incoming and outgoing traffic can be monitored.

16 www.bannerengineering.com - tel: [phone] Online Only - rev. A

iVu Plus BCR Communications User's Guide

Example:

Link Status Connected

Speed 100 Mbps

Mode Full Duplex

MAC Address 00:23:D9:00:AB:CD

Packets Sent 195

Packets Received 324

2.3 Serial I/O

2.3.1 Using the Port Status Screen for Testing RS-232 Communications

The Port Status screen can be used to ensure data is entering and exiting the sensor. This can be useful for debugging issues such as
improper wiring, mismatched baud rates, or other serial I/O issues. To access the Port Status screen, go to Main Menu > System >
Communications > Serial I/O and click on the Status button.

• The upper field shows the bytes received (request frame) on the iVu from the control device.

• The lower field shows the bytes sent (response frame) from the iVu to the control device.

Online Only - rev. A www.bannerengineering.com - tel: [phone]

Port Errors

iVu Plus BCR Communications User's Guide

The Port Errors screen can help to debug communications channel issues: Parity, Break, and Framing indicate mismatched port settings
or, in the case of Break, incorrect cabling.

2.3.2 Using the iVu Command Channel Sample Application or a Terminal Program for Test­ing

The easiest way to test that the iVu command channel is correctly receiving and transmitting data is to use either the iVu Command
Channel Sample App (available on the installation CD) or to use a terminal program running on a PC:

If using a terminal program, in the terminal program's configuration:

• Set new-line transmit to <CR><LF> (and set the end-of-frame delimiters on the iVu to match).

• Enable local echo.

• Set the Serial port set up so that the PC port number's baud rate, data, parity, and stop bits match those setup on the iVu.

2.3.3 Verifying Basic Receive Functionality

To verify the iVu can receive request frames from the requesting device:

1. On the iVu Sensor, go to the Main Menu > System > Communications > Serial I/O > Port Status screen.

18 www.bannerengineering.com - tel: [phone] Online Only - rev. A

iVu Plus BCR Communications User's Guide

2. On the requesting device, transmit one or more bytes to the iVu sensor.

• If the data byte values appear correct and the number sent by the requesting device matches the number received by the iVu
sensor, then the transmit/receive functionality is working properly.

• If the connection is incorrect (electrically) or if the baud rate is mismatched, no bytes will appear in the upper field on the Port
Status screen.

• If the connection is correct (electrically), bytes will appear in the upper field of the Port Status screen in the order they were
received.

• If the Port Status: Errors at the bottom of the Port Status screen highlights red, then the connection is correct electrically but
there is likely a settings mismatch between the iVu sensor and the requesting device. Verify the settings on both devices.

• If the bytes appear with no errors but appear incorrect or there are too many or too few, then the port settings (for example,
baud rate) are likely mismatched in a way that does not generate serial hardware errors. Verify the settings on both devices
match exactly.

Verifying Basic Transmit Functionality

The iVu command channel will only send response frames to the requesting device if it receives a valid end-of-frame delimiter from the
requesting device. To verify transmit functionality:

1. Transmit an end-of-frame delimiter sequence from the requesting device to the iVu sensor. For example, in a terminal program,
simply hit Enter.

If a valid end-of-frame delimiter is received, the iVu sensor will immediately transmit a short error message back to the requesting
device (for example, ERROR 10000_COMMAND_MISSING).

2. Verify that the number of bytes sent by the requesting device are the same as the number shown in the lower field of the Port
Status screen on the iVu sensor. Go to the Main Menu > System > Communications > Serial I/O > Port Status screen.

Online Only - rev. A www.bannerengineering.com - tel: [phone]

iVu Plus BCR Communications User's Guide

3. If the byte count does not match, re-verify that the settings on both devices match exactly. If no bytes are received, re-check the
wiring.

If the correct response frame is received, then basic electrical and port settings are correct.

20 www.bannerengineering.com - tel: [phone] Online Only - rev. A

3 Command Channel Primer

3.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).

3.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.

Online Only - rev. A

www.bannerengineering.com - tel: [phone]

>> set trigger mode command\x0D\x0A
<< OK\x0D\x0A

>> do trigger\x0D\x0A
<< OK\x0D\x0A

iVu Plus BCR Communications User's Guide

3.1.2 String Delimiters and Escaping

Strings used in commands are always 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"

3.1.3 Command Channel Command Synopsis

There are a number of general types of commands to do, set, and get sensor data.

Command Channel Response Frames

The iVu responds to all request frames with one or two responses depending on the type of command.

Do commands

All do commands are followed by one response that identifies the command status. For example:

>> do trigger\x0D\x0A
<< OK\x0D\x0A

Get commands

All get commands are followed by two responses: the first identifies the status of the command, and the second contains the
retrieved information. For example:

>> get bcr_input comparedata\x0D\x0A
<< OK\x0D\x0A
<< "012345ABCDEF"\x0D\x0A

Set commands

All set commands are followed by one response that identifies the command status. For example:

>> set bcr_input comparedata "012345ABCDEF"\x0D\x0A
<< OK\x0D\x0A

Command Channel Command Status

The command status is either OK or ERROR. If OK, then the command has fully and successfully completed. If an error is returned it is in
the form ERROR nnnnn_ERROR_IDENTIFIER (for example ERROR 10001_COMMAND_NOT_RECOGNIZED). Refer to 3.5 Command

Channel Error Codes on page 33 for a list of errors.

22 www.bannerengineering.com - tel: [phone] Online Only - rev. A

iVu Plus BCR Communications User's Guide

3.2 Conventions Used for Examples

There are a number of command channel examples included here, and the following are the conventions used in the examples:

• All examples use <CR><LF> for the end-of-frame delimiter, and this delimiter is always denoted in hex (\x0D\x0A) since that is what

is displayed in the iVu logs and, for example, the Port Status screen.

• All commands are in bold text.

• For each example, a command request to the iVu sensor is prefaced with a >>, and a command response frame from the iVu sensor

is prefaced by a << as shown below. These are only used to make the documentation clearer.

>> get info companyname\x0D\x0A
<< OK\x0D\x0A
<< "Banner Engineering Corp."\x0D\x0A

3.3 Examples

3.3.1 Example 1: How to Trigger the Sensor and Retrieve Barcode Data using the Com­mand Channel

To trigger the sensor and retrieve barcode data, do the following

1. Set Trigger to Command. Go to the Main Menu > Imager > Trigger screen, and from the drop-down select Command

2. Issue a trigger command as follows:

>> do trigger\x0D\x0A
<< OK\x0D\x0A

3. Check that the inspection passed.

>> get inspection status\x0D\x0A
<< OK\x0D\x0A
<< Pass\x0D\x0A

4. Get the barcode data read by the iVu sensor.

>> get bcr_result\x0D\x0A
<< OK\x0D\x0A
<< "0043000011201"x0D\x0A

3.3.2 Example 2: How to Modify Barcode Compare Data Using the Command Channel

1. Set Trigger to Command. Go to the Main Menu > Imager > Trigger screen, and from the drop-down select Command

2. Set the compare data.

>> set bcr_input comparedata "0043000011201"\x0D\x0A
<< OK\x0D\x0A

Online Only - rev. A www.bannerengineering.com - tel: [phone]

iVu Plus BCR Communications User's Guide

3. Trigger the sensor.

>> do trigger\x0D\x0A
<< OK\x0D\x0A

4. Check that the inspection passed.

>> get inspection status\x0D\x0A
<< OK\x0D\x0A
<< Pass\x0D\x0A

5. Get the barcode data read by the iVu sensor.

>> get bcr_result data\x0D\x0A
<< OK\x0D\x0A
<< "0043000011201"\x0D\x0A

3.4 iVu Plus Command Channel Reference

3.4 Info Command Group

Command Group Item Description

Get Info CompanyName The company name as a string.

Get Info ModelNumber The sensor model number as a

string.

Get Info FirmwareVersion The sensor firmware version as

a string.

Get Info SerialNumber The sensor serial number as a

string.

Get Info Name The sensor name as a string.

Get Info BootNumber The number of sensor bootups

Get Info UpTimer The elapsed time the sensor

has been running in the format
hh:mm:ss:msec.

Get Info HourCount The number of hours the sensor

has been running.

Get Info RemoteConnected The remote display connected

status as a boolean value (true
or false)

Get Info RemoteModelNumber The model number of the re-

Get Info RemoteSerialNumber The serial number of the remote

24 www.bannerengineering.com - tel: [phone] Online Only - rev. A

mote display as a string.

display as a string.

iVu Plus BCR Communications User's Guide

Examples

>> get info companyname\x0D\x0A
<< OK\x0D\x0A
<< "Banner Engineering Corp."\x0D\x0A

>> get info bootnumber\x0D\x0A
<< OK\x0D\x0A
<< 42\x0D\x0A

>> get info uptimer\x0D\x0A
<< OK\x0D\x0A
<< 4:42:42:324\x0D\x0A

3.4 System Command Group

Command Group Item Description

Do System Reboot Reboots the sensor. Pre-empts

other commands except Save.

Do System Save Saves inspection and configura-

tion parameters. Blocks until fin­ished. Should be used sparing­ly.

Examples

>> do system save\x0D\x0A
<< OK\x0D\x0A

3.4 Status Command Group

Command Group Item Description

Get Status Ready Flag indicating whether the sys-

tem is ready to trigger (true) or
busy (false)

Get Status SystemError Flag indicating whether a sys-

tem error is active (true) or
cleared (false)

Do Status ClearSystemError Clears the system error LED

and sets the internal flag to
false.

Examples

>> get status ready\x0D\x0A
<< OK\x0D\x0A
<< True\x0D\x0A

>> get status systemerror\x0D\x0A

Online Only - rev. A www.bannerengineering.com - tel: [phone]

iVu Plus BCR Communications User's Guide

<< OK\x0D\x0A
<< False\x0D\x0A

>> do status clearsystemerror\x0D\x0A
<< OK\x0D\x0A

3.4 Trigger Command Group

Command Group Item Description

Get Trigger Mode The sensor's triggering mode.

This value must match the
modes supported by the sensor.
This value can be modified us­ing the sensor's touchscreen.
This remotely modified value is
not persisted to the sensors per­manent memory. The 'Save' op­eration is required to persist this
value.

Set Trigger Mode The sensor's triggering mode.

This value must match the
modes supported by the sensor.
This value can be modified us­ing the sensor's touchscreen.
This remotely modified value is
not persisted to the sensors per­manent memory. The 'Save' op­eration is required to persist this
value.

Do Trigger Immediate This command initiates a single

trigger and inspection. The sen­sor does not transmit a re­sponse until the sensor has
completed the action and re­turned to the READY state. This
command requires the 'Com­mand' trigger mode. The sensor
must be in the ready state to
perform the desired operation.

Do Trigger Gated This command initiates the ga-

ted triggering mode. Images are
repeatedly acquired until a valid
object is detected or this mode
is aborted. The sensor does not
transmit a response until the
sensor has completed the ac­tion and returned to the READY
state. This command requires
the 'Command' trigger mode.
The sensor must be in the ready
state to perform the desired op­eration.

26 www.bannerengineering.com - tel: [phone] Online Only - rev. A

iVu Plus BCR Communications User's Guide

Command Group Item Description

Do Trigger AbortGated This command aborts the gated

triggering mode. The sensor
does not transmit a response
until the gated triggering option
has been aborted and the sen­sor has returned to the READY
state. This command requires
the 'Command' trigger mode.

Examples

3.4 Imager Command Group

Command Group Item Description

Get Imager Gain The sensor's value used to

electronically brighten all image
pixels This value can be modi­fied using the sensor's
touchscreen. This remotely
modified value is not persisted
to the sensors permanent mem­ory. The 'Save' operation is re­quired to persist this value.

Set Imager Gain The sensor's value used to

electronically brighten all image
pixels This value can be modi­fied using the sensor's
touchscreen. This remotely
modified value is not persisted
to the sensors permanent mem­ory. The 'Save' operation is re­quired to persist this value.

Get Imager Exposure The sensor's value used to con-

trol the amount of time the im­ager is allowed to gather light
for the image. This value can be
modified using the sensor's
touchscreen. This remotely
modified value is not persisted
to the sensors permanent mem­ory. The 'Save' operation is re­quired to persist this value.

Set Imager Exposure The sensor's value used to con-

trol the amount of time the im­ager is allowed to gather light
for the image. This value can be
modified using the sensor's
touchscreen. This remotely
modified value is not persisted
to the sensors permanent mem-

Online Only - rev. A www.bannerengineering.com - tel: [phone]

iVu Plus BCR Communications User's Guide

Command Group Item Description

ory. The 'Save' operation is re­quired to persist this value.

Examples

>> get imager exposure\x0D\x0A
<< OK\x0D\x0A
<< Command\x0D\x0A

>> set imager exposure"11900"\x0D\x0A
<< OK\x0D\x0A

3.4 Teach Command Group

Command Group Item Description

Do Teach NextTrigger This commands forces the sen-

sor to perform the Remote
Teach operation on the next
trigger. This command can be
performed using the sensor's
touchscreen.

Examples

>> do teach\x0D\x0A
<< OK\x0D\x0A

3.4 ProductChange Command Group

Command Group Item Description

Do ProductChange [Name ] Forces the sensor to switch to

the specified inspection. The
sensor does not transmit a re­sponse until the sensor has
completed the action. Inspec­tions results will be invalid until
the next trigger.

Get ProductChange InspectionNames List of all inspections stored in

the sensor

Examples

>> get productchange inspectionnames\x0D\x0A
<< OK\x0D\x0A

>> do productchange "inspection2"\x0D\x0A
<< OK\x0D\x0A

28 www.bannerengineering.com - tel: [phone] Online Only - rev. A

iVu Plus BCR Communications User's Guide

3.4 History Command Group

Command Group Item Description

Get History Passed This value indicates the number

of passed inspections for the
active inspection. This value is
cleared (reset) whenever history
is cleared. This value is cleared
(reset) when the device starts
up or is rebooted.

Get History Failed This value indicates the number

of failed inspections for the ac­tive inspection. This value is
cleared (reset) whenever history
is cleared. This value is cleared
(reset) when the device starts
up or is rebooted.

Get History MissedTriggers This value indicates the number

of missed triggers for the active
inspection. This value is cleared
(reset) whenever history is
cleared. This value is cleared
(reset) when the device starts
up or is rebooted.

Get History StartFrameNumber This value indicates the starting

frame number for the active in­spection. This value is cleared
(reset) whenever history is
cleared. This value is cleared
(reset) when the device starts
up or is rebooted.

Get History EndFrameNumber This value indicates the latest

frame number for the active in­spection. This value is cleared
(reset) whenever history is
cleared. This value is cleared
(reset) when the device starts
up or is rebooted.

Get History TotalFrames This value indicates the total

number inspections (frames) for
the active inspection. This value
is cleared (reset) whenever his­tory is cleared. This value is
cleared (reset) when the device
starts up or is rebooted.

Get History MinInspectionTime This value indicates the mini-

mum (fastest) inspection time
for the active inspection. This
value is cleared (reset) whenev­er history is cleared. This value
is cleared (reset) when the de­vice starts up or is rebooted.

Online Only - rev. A www.bannerengineering.com - tel: [phone]

iVu Plus BCR Communications User's Guide

Command Group Item Description

Get History MaxInspectionTime This value indicates the maxi-

mum (slowest) inspection time
for the active inspection. This
value is cleared (reset) whenev­er history is cleared. This value
is cleared (reset) when the de­vice starts up or is rebooted.

Get History MinBarcodeCount This value indicates the mini-

mum number of barcodes read
for the active inspection This
value is cleared (reset) whenev­er history is cleared. This value
is cleared (reset) when the de­vice starts up or is rebooted.

Get History MaxBarcodeCount This value indicates the maxi-

mum number of barcodes read
for the active inspection This
value is cleared (reset) whenev­er history is cleared. This value
is cleared (reset) when the de­vice starts up or is rebooted.

Do History Clear This command clears all history

fields for the active inspection.
History values include pass
count, fail count, execution
times and tool specific history
values. This command can be
performed using the sensor's
touchscreen.

Examples

>> get history passed\x0D\x0A
<< OK\x0D\x0A
<< 13\x0D\x0A

>> get history startframenumber\x0D\x0A
<< OK\x0D\x0A
<< 3\x0D\x0A

>> do history clear\x0D\x0A
<< OK\x0D\x0A

3.4 Inspection Command Group

Command Group Item Description

Get Inspection Status This status of the most recent

30 www.bannerengineering.com - tel: [phone] Online Only - rev. A

inspection either Pass, Fail, or
Idle (no triggers).

iVu Plus BCR Communications User's Guide

Command Group Item Description

Get Inspection Name The name of the active inspec-

tion.

Get Inspection FrameNumber The most recent inspection

frame number

Get Inspection ExecutionTime The most recent inspection exe-

cution time in msec.

Examples

>> get inspection status\x0D\x0A
<< OK\x0D\x0A
<< Fail\x0D\x0A

>> get inspection executiontime\x0D\x0A
<< OK\x0D\x0A
<< 37.739\x0D\x0A

3.4 BCR_INPUT Command Group

Command Group Item Description

Get BCR_INPUT CompareData The Barcode inspection com-

pare data string. This string
must start and end with the dou­ble quote character. This value
can be modified using the sen­sor's touchscreen. This remote­ly modified value is not persis­ted to the sensors permanent
memory. The 'Save' operation is
required to persist this value.

Set BCR_INPUT CompareData The Barcode inspection com-

pare data string. This string
must start and end with the dou­ble quote character. This value
can be modified using the sen­sor's touchscreen. This remote­ly modified value is not persis­ted to the sensors permanent
memory. The 'Save' operation is
required to persist this value.

Get BCR_INPUT CompareMask The Barcode inspection com-

Online Only - rev. A www.bannerengineering.com - tel: [phone]

pare string mask in binary for­mat; that is, masked characters
are indicated by a "1" and un­masked characters are "0."
Note that the mask character
string must match the length of
the compare string. This value

iVu Plus BCR Communications User's Guide

Command Group Item Description

can be modified using the sen­sor's touchscreen. This remote­ly modified value is not persis­ted to the sensors permanent
memory. The 'Save' operation is
required to persist this value.

Set BCR_INPUT CompareMask The Barcode inspection com-

pare string mask in binary for­mat; that is, masked characters
are indicated by a "1" and un­masked characters are "0."
Note that the mask character
string must match the length of
the compare string. This value
can be modified using the sen­sor's touchscreen. This remote­ly modified value is not persis­ted to the sensors permanent
memory. The 'Save' operation is
required to persist this value.

Examples

3.4 BCR_RESULT Command Group

Command Group Item Description

Get BCR_RESULT Count The total number of barcodes

found. The most recent inspec­tion value is used. Access to
this value requires a valid trig­ger.

Get BCR_RESULT Data The decoded barcode data

strings. Each string starts and
ends with the double quote
character. Multiple values are
seperated by the field delimiter
The most recent inspection val­ue is used. Access to this value
requires a valid trigger.

Get BCR_RESULT Type The decoded barcode symbol

type(s). Multiple values are se­perated by the field delimiter
The most recent inspection val­ue is used. Access to this value
requires a valid trigger.

Examples

32 www.bannerengineering.com - tel: [phone] Online Only - rev. A

iVu Plus BCR Communications User's Guide

3.4 BCR_HISTORY Command Group

Command Group Item Description

Get BCR_HISTORY MinCount This value indicates the mini-

mum number of barcodes read
for the active inspection This
value is cleared (reset) whenev­er history is cleared. This value
is cleared (reset) when the de­vice starts up or is rebooted.

Get BCR_HISTORY MaxCount This value indicates the maxi-

mum number of barcodes read
for the active inspection This
value is cleared (reset) whenev­er history is cleared. This value
is cleared (reset) when the de­vice starts up or is rebooted.

Examples

3.5 Command Channel Error Codes

Numeric ID Text ID Description

00000 SUCCESS Command processed successfully

10000 EMPTY_FRAME_RECEIVED Indicates that the request was empty. The

command channel requires a command,
any arguments, and an end-of-frame delim­iter.

10001 COMMAND_NOT_RECOGNIZED The command specified is not recognized

10100 GROUP_MISSING A Group ID must be specified immediately

after the command

10101 GROUP_NOT_FOUND The specified Group ID is invalid / unknown

10102 GROUP_ITEM_MISSING A Group Item ID must be specified immedi-

ately after the Group ID

10103 GROUP_ITEM_NOT_FOUND The specified Group Item ID is invalid / un-

known

10152 NOT_READABLE Attempt to get a value that is not readable

10153 NOT_WRITEABLE Attempt to set a value that is not writeable

10250 NOT_A_METHOD Method ID specified is not a method

10251 WRONG_ARGUMENT_COUNT Total method arguments specified do not

10252 COMMAND_NOT_FINISHED Attempt to issue command when a previous

10300 INVALID_ARGUMENT_TYPE Item ID specified must be a item (not a

Online Only - rev. A www.bannerengineering.com - tel: [phone]

match method

command has not finished

group or method)

iVu Plus BCR Communications User's Guide

Numeric ID Text ID Description

10301 DATA_VALUE_MISSING Command missing item's data value

10350 ARGUMENTS_DETECTED Get command received with unneeded ar-

guments

10351 INVALID_ARGUMENT_TYPE Item ID specified must be a item (not a

group or method)

10340 MINIMUM_VALUE_EXCEEDED New item value is below the minimum

10341 MAXIMUM_VALUE_EXCEEDED New items value is above the maximum

10500 DATA_SET_EMPTY Data export operation returned no results.

10900 SENSOR_NOT_READY Command specified requires sensor to be

in the READY state.

10920 SENSOR_TYPE_NOT_ACTIVE Command specified belongs to a different

sensor type.

15000 VALUE_INVALID Text value is invalid / unknown

15050 VALUE_INVALID Text value is invalid - expecting True or

False

15100 STRING_TOO_LONG String value specified exceeds maximum

allowable length

20000 BARCODE_TIMEOUT Attempt to obtain Barcode result data when

decoder has timed out

20001 NO_BARCODES_FOUND Attempt to obtain Barcode result data when

no barcodes were found

20002 COMPARE_DATA_DISABLED Operation requires Barcode compare to be

enabled

20003 COMPARE_MASK_INVALID Compare mask invalid. Expecting string of

1's and 0's with length equal to compare
data string

20004 NUMBER_TO_FIND_NOT_ONE Barcode number to find must be set to one

for this operation.

80000 REMOTE_DISPLAY_NOT_CONNECTED Remote Display must be connected to ob-

tain this value

80001 REMOTE_DISPLAY_NOT_SUPPORTED This sensor does not have Remote Display

capability

80100 COMMAND_MODE_EXPECTED The Trigger Mode must be set to "Com-

mand" perform this operation

80101 COMMAND_TIMED_OUT The command timed out before finishing

80102 TRIGGER_REQUIRED Access to the specified data requires a trig-

80103 TRIGGER_NOT_GATED Command requires a active Gated Trigger

80150 COMMAND_TIMED_OUT The command timed out before finishing

34 www.bannerengineering.com - tel: [phone] Online Only - rev. A

gered inspection

iVu Plus BCR Communications User's Guide

Numeric ID Text ID Description

80200 SYSTEM_ERROR_NOT_ACTIVE The System Error must be active to exe-

cute this command

Online Only - rev. A www.bannerengineering.com - tel: [phone]

Index

Index

C

command channel

image export 5
command channel log 16
command channel sample application 4
command group

info 24

inspection 30

productchange 28

status 25

system 25
communication channel

command channel 3

data export 3

image export 3
communications channels 3

D

data export 3
data export log 16
data export sample application 5

E

Ethernet 3
ethernet communications 6

I

image export 3, 5

image export sample application 5
info command group 24
inspection command group 30

L

logs

command channel 16
data export 16

P

productchange command group 28

R

RS-232 3

S

sample application

command channel 4
data export 5

image export 5
status command group 25
system command group 25

36 www.bannerengineering.com - tel: [phone] Online Only - rev. A