Summary of Contents for Pleora Technologies iPORT CL-Ten
Page 1
PLEORA TECHNOLOGIES INC. iPORT™ Advanced Features User Guide Installing, Uninstalling, and Starting the Software Applications...
Page 2
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.
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 •...
(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 • •...
You are planning to integrate your software to developers who are integrating the with the Pleora eBUS SDK and want to view Programmer’s Guide Pleora Technologies’ eBUS SDK with sample code and including Application their own application in order to Programming Interface (API) class communicate with Pleora’s GigE...
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 •...
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: •...
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) •...
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”...
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. PLC Inputs PLC Outputs GPIOIn Block...
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.
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.
Page 17
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.
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. You can comment out full equations by adding // to the beginning of the equation.
Equation Definitions The sections provide descriptions for the elements of equations: Equations Equations are written using the following format: Variable out = expression You can use an equation empty by using NULL in place of the equation. Expressions An expression can be made up of the following elements: •...
Binary Operators The following table provides descriptions for binary operators. Table 7: Binary Operator Descriptions Operators (Increasing Precedence) Description & Logical AND Logical OR Logical XOR Variable Out Defined names for all PLC outputs or enhanced functions inputs. Variable In Defined names for all PLC LUT inputs.
Page 22
Grabber Control Block The grabber control block allows you to configure the image LVAL, FVAL, and TRIG signals used by the video interface’s image grabber. You can use the signals exactly as they come from the camera or you can manipulate them to create your own signal.
Page 23
Modifying Grabber Control Block Signal Selection Using the eBUS Player Device Control dialog box, you can configure the grabber control block to grab specified combinations or arrangements of signals from the PLC. You can configure the selection of the following three signals: Grabber Input FVAL •...
Page 24
Grabber Input LVAL • In the PixelBusLineValidFunctionSelect list, select from the options shown in the following image. iPORT Advanced Features User Guide...
Page 25
Grabber Input MVAL In the PixelBusMetadataFunctionSelect list, select from the options shown in the following image. • When you first open the Device Control dialog box, the default values for the signals as they are transmitted from the video source are shown. Using the BufferWM0/BufferWM1 Signals The acquisition block tracks the on-board memory used by the image block data that has not yet been transmitted on the Ethernet link.
Page 26
Multiple PLC Interconnection Blocks The multiple PLC interconnection block can receive up to two outputs from a second PLC. Remote Control Inputs The remote control inputs let you send inputs from your host computer to the video interface. You can control this block using eBUS Player.
Page 27
Input Debouncing Block The input debouncing block filters spurious transitions from input signals. Each input signal can be independently configured to hold signal transitions between 480 ns and ~31 ms. While holding the first transition, the input debouncing block ignores further transitions for the configured duration. The hold times can be configured in increments of 480 ns (16 cycles of the video interface system clock).
Enhanced Functional Blocks The following sections provide descriptions of the enhanced functional blocks. Timer The timer generates a pulsed digital signal with a configurated frequency and duty cycle. The timer can be configured to emit a continuous (periodic) pulse. The timer can also be configured to emit a single pulse after receiving an input trigger signal.
Page 29
Rescaler You can use the rescaler to change the frequency of a periodic input signal. The rescaler can multiply the period by up to 4096 or divide it by up to 4095. The rescaler samples the frequency of the input signal, calculates the new output frequency, and emits a clock with a 50% duty cycle.
The delayer uses the rising edges of a periodic reference signal for timing. On each rising edge of the reference signal, the delayer samples the input signal. After n pulses (up to 65535) of the reference signal, the delay outputs the sampled value. The delayer can store up to 128 transitions (64 pulses). Because the delayer uses the reference timing signal for sampling, input pulses that are shorter than the period of the reference timing signal could be missed.
Page 31
Table 9: PLC Signal Descriptions Primary Signal PLC Equation Description Name Usage Pb1Spare Input Channel #2 Pixel Bus Spare Input signals. For one-channel products, this input is tied to zero. GpioIn[7:0] Input GPIO Input lines. Unused most significant bits are tied to zero. BufferWM0 Input Channel #1 Grabber Water Mark Almost Full Status...
Page 32
Table 9: PLC Signal Descriptions Primary Signal PLC Equation Description Name Usage PlcCascOut[1:0] Input, Output PLC Cascade Output signals. Allow to connect up to two outputs to another instance of a PLC in the video interface. When there is no other PLC, then these outputs are left unconnected.
Chapter 4 Using the Event Queue You can generate an interrupt on the host computer using the event queue feature. When the rising edge of the event signal occurs, the video interface sends a GenICam event packet containing the following: •...
Page 34
In the EventSelector section of the EventControl category, select On in the EventNotification list. iPORT Advanced Features User Guide...
Page 35
In the SignalRouting section of the Plc category, select an available equation, and enter an equation, such event0 = plcctrl0, as the one shown in the image below. Using the Event Queue...
Page 36
Click the PlcEquationApply button. In the ControlBits section, select True in the PlcCtrlValue list. iPORT Advanced Features User Guide...
Page 37
You can view the event status in the PlcEventQueueData section of the EventControl section. Using the Event Queue...
Chapter 5 Configuring Action Commands Using IEEE 1588 Precision Time Protocol (PTP) This chapter describes how to configure and send actions commands using the IEEE 1588 precision time protocol (PTP). The following topics are covered in this chapter: • “Using Action Commands” on page 36 •...
Using Action Commands Action commands allow you to trigger an action on one or several devices at the same time using the value of the video interface timestamp counter. When the 64-bit timestamp is equal or greater than the configured time value, the action trigger generator emits a signal on up to two outputs. These signals are routed into the signal routing block and can be used to trigger other events or actions.
You can implement the IEEE 1588 PTP on Pleora’s video interfaces using any of the following methods: PTP Daemons running on the Windows or Linux operating system • Network switch that supports IEEE 1588 PTP • • All video interfaces connected to one NIC (with multiple ports) that supports IEEE 1588 PTP •...
In the TransportLayerControl category, select True. Configuring Action Commands You can configure a video interface to send action commands to one or several devices using the following procedure. To configure the video interface to perform an action command Start eBUS Player and connect to the video interface. Under Parameters and Controls, click Device control.
Page 43
Group Mask. Defines a subset of the group of devices on which the action command is executed. The masks for the action command and the device settings cannot have the AND operation evaluate to zero.If the AND operation evaluates to zero, the action will not be performed. To send an action command Start eBUS Player and connect to the video interface.
Page 44
The Device Key and Group Mask must match the value you specified in step 5 of “To configure the video interface to perform an action command” on page 38. Optionally, you can select the Scheduled check box and specify the time at which you want the action command to be executed in the Scheduled Time box.
Table 10: Action Command Acknowledgement Descriptions Acknowledgement Description The action command was sent and received and will be executed at the specified scheduled time. Overflow The PlcActionTrigQueue buffer is full (32 commands are stored in the queue) To configure a video interface to send an action command acknowledgement Start eBUS Player and connect to the video interface.
Page 46
Broadcasting from a Secondary Computer Action commands can also be sent by a second eBUS Player application running on a secondary computer or another device on the same subnet, as shown in the following diagram. Figure 2: Broadcasting Action Commands from a Secondary Computer ActionUnconditionalMode You can use eBUS Player, connected on a network, to send action commands to devices when eBUS Player is not directly connected to the devices if you first take the following steps:...
Chapter 6 Extended Chunk Mode Support This chapter describes the extended chunk mode feature of your video interface. The following topics are covered in this chapter: “About the Extended Chunk Mode Feature” on page 44 • “MetaData Generated by the Camera” on page 44 •...
About the Extended Chunk Mode Feature The extended chunk mode feature allows you to append metadata to some of the payload types, such as an image payload, as chunk data. For example, when the extended chunk feature is enabled, you can attach the position of the conveyor belt (metadata) to the image of the product on the conveyor belt.
Page 49
The DVAL signal can be used to throttle metadata, if required. Chunk data on pixel bus can only be 8 bits wide using Data [7:0], the lowest 8 bits of the pixel data bit. The following diagram shows an example of a chunk and its content transmitted using 8-bits on the pixel bus.
Page 50
To configure metadata generated by the camera Start eBUS Player and connect to the video interface. For more information, see the eBUS Player User Guide. Under Parameters and Controls, click Device control. Click Expert in the Visibility list. In the In the ChunkDataControl section, click True in the ChunkModeActive list. iPORT Advanced Features User Guide...
Page 51
In the PixelBusInterfaceControl section, select an option from the PixelBusMetadaDataValidFunctionSelect list. Extended Chunk Mode Support...
Page 52
In the ChunkSelector list, select PixelBusMetadata. iPORT Advanced Features User Guide...
In the ChunkEnable list, select True. PLC Metadata Generated by the Video Interface When the extended chunk feature is enabled, you can append the following PLC metadata, generated by the video interface, to the payload (image payload): • PLCLutInputValue (returns the value of the 8-bit LUT inputs) •...
Page 54
In the ChunkSelector list, click the chunk data that you want to include and enable each of the types. iPORT Advanced Features User Guide...
Page 55
In the ChunkEnable list, click True. Extended Chunk Mode Support...
Chapter 7 Advanced Features Usage Examples This chapter provides examples of how to configure the advanced features described in the previous chapters. The following topics are covered in this chapter: • “Creating a Demonstration Environment” on page 54 “Setting up the Hardware” on page 55 •...
Creating a Demonstration Environment You can use the example provided in the following diagram to create a demonstration environment that allows you to follow and test the procedures provided in this chapter. Figure 3: PLC Demonstration Example Camera Video Interface Object Object Conveyor...
The advanced feature usage examples provided in this guide are based on the use of the following hardware: Pleora Technologies’ video interface with power supply • Computer, with 10-GigE NIC installed, running the latest version of the eBUS SDK with eBUS •...
Controlling the Advanced Features from the Computer The following procedure demonstrates how you can control the PLC and other advanced features from a computer, connected to the video interface, using the control bits that make up the remote control block. To control the PLC remotely Connect the hardware as shown in the “PLC Demonstration Example”...
In the SignalRouting section, select one of the equations, for example, PlcEquation0, and enter the following Boolean expression: GpioOut0 = Timer0Out. Click PlcEquationApply to apply the equation. In the ControlBits section of the Plc category, select one of the inputs from the PlcCtrlSelector list, for example, PlcCtrl0.
Using the Delayer Feature to Delay a Signal The following procedure demonstrates how you can configure the delayer feature to delay a signal for three seconds. The delayer feature operates by sampling the signal and then delaying it by a number of configured sampling intervals.
Using the Rescaler Feature to Change a Signal Frequency The following procedure demonstrates how you can configure the rescaler feature to change a 16 Hz pulse to a 1.6 Hz pulse. The PlcCtrl0 control bit is used to stop and start the 16 Hz input to the rescaler. The rescaler requires a timing signal to perform the conversion.
Using the Rescaler Feature with a Backup Signal The following procedure demonstrates how you can configure the rescaler feature to change a 1017 Hz signal into an approximately 4 Hz signal and, if interrupted, to emit a backup signal. In the following example, Timer0 generates the 1017 Hz signal that the rescaler uses as its primary input. The rescaler divides the signal frequency and outputs a rescaled 4 Hz pulse.
Select PlcRescalerBackupSwitchoverDelay and enter 4095. In the PlcRescalerBackupInputSignal list, select Timer1Out. In the ControlBits section of the Plc category, select one of the inputs from the PlcCtrlSelector list, for example, PlcCtrl0. In the PlcCtrlValue list, click True to set the signal state to high, or False to set the signal state to low.
Using the Event Control Feature The following procedure demonstrates how you can configure the event control feature to send interrupt requests to the host computer. You can use the Event Monitor in eBUS Player to view the events. You should clear any existing events first.
Page 67
In the Event Monitor window, click Clear log. To configure events Follow steps 1-5 in the procedure, “To control the PLC remotely” on page 56. In the EventControl section, select On from the PlcEventQueue0 list. Continue to select On from the PlcEventQueue1, PlcEventQueue2, and PlcEventQueue3 lists. In the SignalRouting section, select four of the available equations, for example, PlcEquation0, PlcEquation1, PlcEquation2, and PlcEquation3 and enter one of the following Boolean equations in each equation field:...
Page 68
• Event3 = PlcCtrl3 Click PlcEquationApply to apply the equations. In the ControlBits section of the Plc category, select PlcCtrl0 from the PlcCtrlSelector list. In the PlcCtrlValue list, first select True and then False. Repeat steps 6 and 7 for PlcCtrl1, PlcCtrl2, and PlcCtrl3. When PlcCtrl0, PlcCtrl1, PlcCtrl2 and PlcCtrl3were set to True, the video interface sent interrupt requests to the host computer.
Using the Scheduled Action Command Feature to Trigger a Pulse The following procedure demonstrates how you can configure the action command feature to trigger a pulse on the GpioOut0 signal at a scheduled time. You must enable the IEEE 1588 Precision Time Protocol (PTP) to synchronize the time between the devices on the network.
Page 70
The GigE Vision Action Command window is updated as shown in the following image. Enter a time in the Scheduled Time box. This value must be greater than the value shown in the GevTimestampValue box in the Device Control window, referenced in step 12 above. Click Send.
Chapter 8 Technical Support On the Pleora Support Center, you can: Download the latest software. • Log a support issue. • View documentation for current and past releases. • • Browse for solutions to problems other customers have encountered. • Get presentations and application notes.
Need help?
Do you have a question about the iPORT CL-Ten and is the answer not in the manual?
Questions and answers