Pleora Technologies iPORT CL-Ten User manual

Installing, Uninstalling, and Starting the Software Applications a
PLEORA TECHNOLOGIES INC.
iPORT™ Advanced Features
User Guide

Copyright © 2018Pleora Technologies Inc.
These products are not intended for use in life support appliances, devices, or systems where malfunction of these products can
reasonably be expected to result in personal injury. Pleora Technologies Inc. (Pleora) customers using or selling these products for
use in such applications do so at their own risk and agree to indemnify Pleora for any damages resulting from such improper use or
sale.
Trademarks
PureGEV, eBUS, iPORT, vDisplay, AutoGEV, AutoGen, and all product logos are trademarks of Pleora Technologies. Third party
copyrights and trademarks are the property of their respective owners.
Notice of Rights
All information provided in this manual is believed to be accurate and reliable. No responsibility is assumed by Pleora for its use.
Pleora reserves the right to make changes to this information without notice. Redistribution of this manual in whole or in part, by
any means, is prohibited without obtaining prior permission from Pleora.
Document Number
EX001-000-0003, Version 3.0, 6/04/18

i
Table of Contents
About this Guide . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1
About this Guide . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2
Applicable Products . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2
Related Documents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3
About the Advanced Features . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .5
Introducing Pleora’s Video Interface Advanced Features . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6
Typical Advanced Feature Applications . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7
Configuring the Advanced Features . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7
Programmable Logic Controller (PLC) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .9
PLC Signal Routing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
Key PLC Functional Blocks and Signals. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
Configuring the PLC using eBUS Player . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
Signal Routing Block and the LUT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
General Syntax Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14
Example Equations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14
Equation Definitions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15
Signal Routing Block Boolean Expression Syntax. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16
Functional Blocks. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17
Enhanced Functional Blocks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24
PLC Signal Descriptions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26
Using the Event Queue . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29
Configuring Action Commands Using IEEE 1588 Precision Time Protocol (PTP) . . . . . . . . . . . . . . . 35
Using Action Commands. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36
About IEEE Precision Time Protocol (PTP) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37
Configuring Action Commands. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38
Broadcasting Action Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41
Extended Chunk Mode Support . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43
About the Extended Chunk Mode Feature. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44
MetaData Generated by the Camera . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44
PLC Metadata Generated by the Video Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49
Advanced Features Usage Examples. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53
Creating a Demonstration Environment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54
Setting up the Hardware . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55
Setting up the Software . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55
Controlling the Advanced Features from the Computer. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56
Using the Timer Feature to add a Pulse to a Signal . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56
Using the Timer Feature to Trigger a Single Pulse . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57
Using the Delayer Feature to Delay a Signal. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58
Using the Rescaler Feature to Change a Signal Frequency . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59
Using the Rescaler Feature with a Backup Signal . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60

ii iPORT Advanced Features User Guide
Using the Counter Feature. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61
Using the Event Control Feature . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62
Using the Scheduled Action Command Feature to Trigger a Pulse . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65
Technical Support . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67

About this Guide 1
Chapter 1
About this Guide
This chapter describes the purpose and scope of this guide and provides a list of complimentary guides.
The following topics are covered in this chapter:
•“About this Guide” on page 2
•“Applicable Products” on page 2
•“Related Documents” on page 3

2iPORT Advanced Features User Guide
About this Guide
This user guide provides you with the information you need to configure Pleora’s powerful, advanced
video interface features, which allow you to control and synchronize the external devices in your vision
system solution.
Using Pleora’s configuration tool, eBUS Player, you can trigger, route, time, and add data to the general
purpose inputs and outputs (GPIO) signals that interface to camera heads and industrial sensors.
Applicable Products
The advanced features are available in the following Pleora iPORT products:
•iPORT CL-Ten External Frame Grabber
•iPORT NTx-Ten Embedded Video Interface
•iPORT NTx-U3 Embedded Video Interface
•iPORT NTx-GigE Embedded Video Interface
•iPORT SB-U3 External Frame Grabber
•iPORT SB-GigE External Frame Grabber
This guide describes all of Pleora’s video interface advanced features. Depending on the video interface
you are using and the firmware version on the video interface, you may not have access to the full set of
advanced features. Please refer to the corresponding user guide for your video interface to view the list of
advanced features supported.

3About this Guide
Related Documents
The iPORT Advanced Features User Guide is complemented by the following guides:
Table 1: Related Documents
Guide Details Consult this Guide When...
eBUS Player Quick Start
Guide
Provides introductory information to
familiarize you with the eBUS Player
software application and provides
initial setup steps.
You are using eBUS Player for the first time
and want information about performing
common tasks.
eBUS Player User Guide Provides in-depth details about
setting up and using the eBUS Player
software application to control your
GigE Vision compliant video
transmitters (cameras) and receivers.
You are familiar with eBUS Player and want to
know how to fully configure your IP engine
using all of eBUS Player’s functionality.
eBUS SDK
Programmer’s Guide
Provides information and instructions
to developers who are integrating the
Pleora Technologies’ eBUS SDK with
their own application in order to
communicate with Pleora’s GigE
Vision compliant products. In this
guide, you can review information
about the underlying technology being
used, along with a high-level view of
how the eBUS SDK fits into the system
and your application.
You are planning to integrate your software
with the Pleora eBUS SDK and want to view
sample code and including Application
Programming Interface (API) class
descriptions and design guidelines.

4iPORT Advanced Features User Guide

About the Advanced Features 5
Chapter 2
About the Advanced Features
This chapter provides an overview of Pleora’s video interface advanced features and typical applications.
The following topics are covered in this chapter:
•“Introducing Pleora’s Video Interface Advanced Features” on page 6
•“Typical Advanced Feature Applications” on page 7
•“Configuring the Advanced Features” on page 7

6iPORT Advanced Features User Guide
Introducing Pleora’s Video Interface Advanced Features
Pleora’s video interface advanced features are available in many of Pleora Technologies' embedded video
interfaces and external frame grabber products, allowing more camera and GPIO control through
simplified configuration.
The advanced features provide the following functionality:
•Simple boolean-based programming for routing of GPIO, camera control, video sync and internal
signals
•PLC enhanced functionality:
•Timers
•Counters
•Delayer
•Rescaler
•Input re-synchronization
•Input debouncing
•Event queues
•Action commands
•Chunk generators
As mentioned in the previous chapter, the available advanced features differ for each video interface.
Depending on the Pleora video interface you are using and the firmware version on the video interface, you
may not have access to the full set of advanced features. Please refer to the corresponding user guide for
your video interface to view the list of advanced features supported.

7About the Advanced Features
Typical Advanced Feature Applications
Pleora’s video interface advanced features are used in various vision system environments; the following
list captures the typical applications:
•Image acquisition control
•Frame acquisition
•Shutter control
•Trigger control
•Trigger source selection (external, software, internal)
•Trigger delay
•Synchronized action commands using IEEE 1588
•Strobe control
•Exposure control
•Readout control
•Iris control
Configuring the Advanced Features
The configuration instructions in this guide are written for Pleora’s eBUS Player application, which is
available as part of the eBUS SDK, available on the installation CD, or at supportcenter.pleora.com.
Once you are familiar with the advanced features, you have the option to create your own configuration
tool using the Pleora eBUS SDK.
For detailed configuration steps, see “Advanced Features Usage Examples” on page 53.

8iPORT Advanced Features User Guide

Programmable Logic Controller (PLC) 9
Chapter 3
Programmable Logic Controller (PLC)
This chapter describes the PLC block components and signals that you can route to synchronize the
elements of your vision system.
The following topics are covered in this chapter:
•“PLC Signal Routing” on page 10
•“Key PLC Functional Blocks and Signals” on page 11
•“Configuring the PLC using eBUS Player” on page 11
•“Signal Routing Block and the LUT” on page 12
•“General Syntax Rules” on page 14
•“Example Equations” on page 14
•“Equation Definitions” on page 15
•“Signal Routing Block Boolean Expression Syntax” on page 16
•“Functional Blocks” on page 17
•“Enhanced Functional Blocks” on page 24
•“PLC Signal Descriptions” on page 26

10 iPORT Advanced Features User Guide
PLC Signal Routing
The following diagram provides you with a detailed view of how the video interface accepts signals from
various function blocks, routes them through the signal routing block, look-up table (LUT), enhanced
function block, and finally to the external outputs.
Important: While this diagram shows a certain number of timers and signals, this diagram is provided as an example.
For the timers and signals available for your video interface, see the user guide that accompanies it. User guides are
available on the Pleora Support Center at supportcenter.pleora.com.
Camera/Pixel Bus Block
*S
Pb0Fval, Pb0Lval
Pb0Dval, Pb0Spare
Pb1Fval, Pb1Lval
Pb1Dval, Pb1Spare
Grabber Control Block
*S
BufferWM0
BufferWM1
Grb0AcqActive
Grb1AcqActive
Feedback Block
***Eq[14:0]Out
Timer[3:0]Out
Rescaler0Out
Delayer0Out
Counter[1:0]Eq
Counter[1:0]Gt
ActionTrig[1:0]
Multiple PLC
Interconnection Block
GPIOIn Block
*S+D
GPiOIn[7:0]
Camera/Pixel Bus Block
Pb0CC[3:0]
Pb1CC[3:0]
Grabber Control Block
PlcFval[1:0]
PlcLval[1:0]
PlcMval[1:0]
PlcTrig[1:0]
Camera/Pixel Bus Blo
GPIOOut Block
PLC OutputsPLC Inputs
GPioOut[7:0]
Timestamp Control Block
PlcTimestampCtrl
Multiple PLC
Interconnection Block
PlcCascOut[1:0]
PlcCascIn[1:0]
Remote
Control Block
PlcCtrl[3:0]
64:1
64:1
64:1
64:1
64:1
64:1
64:1
64:1
Signal
Routing
Block
LUT
I[0]
I[1]
I[2]
I[3]
I[4]
I[5]
I[6]
I[7]
PlcEvent
Event[3:0]
LutInput[7:0]
PlcEventQueue
EventMask[3:0]
PlcEventQueue
Timestamp[63:0]
PlcEventQueue
TLutInputs[7:0]
ActionTrig[1:0]
ActionScheduled
Time[63.0]
Timestamp[63:0]
*S: Synchronization block
*S+D: Synchronization and debouncing block
***Eq[14]Out: Signal cannot be used directly in an equation
ActionCmd[3.0]
Enhanced Function Block
Rescaler
16-bit
Multiplier
Event Control Block
Action Command Block
2x
Counter
Delayer
Action
Trigger
Generator
Event
Queue
4x
Timer Timer[3:0]Out
Timer[3:0]Trig
Timer[3:0]Out
Timer[3:0]Out
Delayer0In
Counter[1:0]Reset
Counter[1:0]Inc
Counter[1:0]Dec
Rescaler0In
Rescaler0Out
Counter0[31:0]
Counter[1:0]Eq
Counter1[31:0]
Counter[1:0]Gt
Rescaler0Out
Delayer0Out

11Programmable Logic Controller (PLC)
Key PLC Functional Blocks and Signals
The following diagram provides a high-level view of the key PLC functional blocks and signals.
Configuring the PLC using eBUS Player
You can use Pleora’s eBUS Player, provided with the eBUS SDK, to enter simple Boolean equations to
configure the enhanced features of your video interface.
This guide describes the eBUS Player functionality used to configure the PLC and other advanced features.
For more detailed information about eBUS Player, see the eBUS Player User Guide.

12 iPORT Advanced Features User Guide
Signal Routing Block and the LUT
The signal routing block consists of 8 identical 64-to-1 multiplexers, which correspond to each of the 8
LUT inputs. The signal routing block supports up to 64 inputs including signals from a second video
source, and a second PLC.
The LUT allows you to program up to 15 logical PLC functions, using a maximum of 8 shared inputs
for all of the equations. Each logical function is defined through a Boolean equation. The equations
control how the signals are routed through the signal routing block to the LUT, and through the various
function blocks.
Typically, in vision systems, the signal routing block routes signals to the enhanced function blocks and
then feeds the signals back to the inputs (feedback inputs) for re-routing to the outputs.
To configure the signal routing block equations
1. Start eBUS Player and connect to the video interface.
2. Under Parameters and Controls, click Device control.
3. Click Guru in the Visibility list.
1. In the SignalRouting section, select one of the available equations and enter the Boolean equation
required to route the appropriate signals.
2. Click PlcEquationApply to apply the equation.

13Programmable Logic Controller (PLC)
Equation Status
The PlcEquationsStatus feature displays the first of any errors that occur as the video interface processes
the Boolean equations. The status appears if errors occur after you click the PlcEquationApply button.
If no errors occur, the status displays OK.
The following table provides descriptions of the possible equation errors displayed in the
PlcEquationsStatus box.
Table 2: Equation Error Status Descriptions
Equation Error Status Description
LUT now out of sync with PlcEquations:
PlcEquationApply required
The equations have been updated and are no longer
synchronized with the LUT contents.
You must click PlcEquationApply to fix this error.
PlcEquation <equation number>: identifier too large at
column <column number
The identifier used for the equation, identified in the
error message by number, is too large
PlcEquation <equation number>: Undefined identifier
<string> at column <column number
The equation does not include a valid signal name
PlcEquation <equation number>: Output signal is
already assigned
The equation at that location is attempting to use an
output that has already been assigned a value
PlcEquation<equation number>: = expected at column
<column number
The equation at that location is missing an “=”
PlcEquation <equation number>: Number of expression
elements exceeds maximum number of <element limit>
The equation at that location contains too many
expression elements. You need to simplify the
expression.
Too many input variables in use at PlcEquation
<equation number
Number of LUT input variables exceeds maximum
possible LUT inputs
PlcEquation <equation number>: expression too
complicated for PLC
The equation at that location is too complicated to be
evaluated. You need to simplify the expression.
PlcEquation <equation number>: illegal expression The equation at that location does not have valid syntax
PlcEquation <equation number>: No matching ( " The equation at that location is missing a “(“
PlcEquation <equation number>: Unmatched (at
column <column number>
The equation is missing a “)” to match the “(“ at that
location

14 iPORT Advanced Features User Guide
General Syntax Rules
The following table provides rules you must follow for entering syntax. Input signals are shown as I0-I7,
and output signals are shown as Q0-Q17. The length of each expression is limited to 1000 bytes.
Comments can be added to the end of expressions by using // before the comment.
Example Equations
Your video interface can process up to 15 advanced feature equations at one time. eBUS Player provides
configuration fields for equations 0-14.
The following table provides some example equations you can enter.
You can comment out full equations by adding // to the beginning of the equation.
Table 3: Syntax Rules
Rule Incorrect Syntax Correct Syntax
The output must be on the left hand side of the equation (the
value is being assigned to Q4, not I5).
I5 = Q4 Q4 = I5
Outputs may not be on the right hand side of the equation. Q1 = I7 & I8 Q1 = I7 & I8
Q2 = Q1 | I5 Q2 = (I7 & I8) | I5
Equations must be separated by a carriage return or an EOL
symbol.
Q3 = I7,Q15=I8 Q3 = I7
Q15 = I8
Table 4: Example Equations
Feature Equation
PlcEquation0 GpioOut0 = GpioIn0 // Comments
PlcEquation1 Timer0Trig = GpioIn1 & PlcCtrl0
PlcEquation2 Pb0CC0 = (Timer0Out & PlcCtrl1) | (Timer0Trig & !PlcCtrl1)

15Programmable Logic Controller (PLC)
Equation Definitions
The sections provide descriptions for the elements of equations:
Equations
Equations are written using the following format:
Variable out = expression
Expressions
An expression can be made up of the following elements:
•Primary operator
•Unary operator
•Binary operator
Primary Operators
A primary operator can be made up of the following elements:
•Literal Operator
•Variable_In
•Expression
Literal Operators
The following table provides descriptions for Literal operators.
Unary Operators
The following table provides descriptions for unary operators
You can use an equation empty by using NULL in place of the equation.
Table 5: Literal Operator Descriptions
Operators (Increasing Precedence) Description
1 True / On
0False / Off
Table 6: Unary Operator Descriptions
Operator Description
! Logical Negotiation

16 iPORT Advanced Features User Guide
Binary Operators
The following table provides descriptions for binary operators.
Variable Out
Defined names for all PLC outputs or enhanced functions inputs.
Variable In
Defined names for all PLC LUT inputs. A variable_in can also be equal to variable_out.
Null Operator
A Null operator is an empty string.
Signal Routing Block Boolean Expression Syntax
The following table provides examples of the Boolean expressions used to configure the Signal Routing
block.
Table 7: Binary Operator Descriptions
Operators (Increasing Precedence) Description
& Logical AND
ILogical OR
^ Logical XOR
Table 8: Signal Routing Block Boolean Expression Syntax
Syntax Valid Construction Example Line
Line Output = Expression EOL (end of line)
Boolean operators & (and) Q14 = I4 & I6
| (or) Q15 = I3 | I5
^ (xor) Q9 = I1 ^ I8
Not ! (not) Q0 = !I0
Q10 = !(I8 & I5)
Delimiter ( ) Q0 = !(I0)
Q3 = !(I1 | (I7 ^ I5))
Q6 = (I3 | I5) ^ (I1 & I2)
Boolean constants 1, true, TRUE Q0 = 1