Dalsa Xtium-CL PX4 User manual

Xtium-CL PX4™
User's Manual
Edition 1.11
P/N: OC-Y4CM-PUSR0
www.teledynedalsa.com
sensors | cameras | frame grabbers | processors | software | vision solutions

NOTICE
© 2014-16 Teledyne DALSA, inc. All rights reserved.
This document may not be reproduced nor transmitted in any form or by any means, either
electronic or mechanical, without the express written permission of TELEDYNE DALSA. Every effort
is made to ensure the information in this manual is accurate and reliable. Use of the products
described herein is understood to be at the user’s risk. TELEDYNE DALSA assumes no liability
whatsoever for the use of the products detailed in this document and reserves the right to make
changes in specifications at any time and without notice.
Microsoft® is a registered trademark; Windows®, Windows® 7, Windows® 8 are trademarks of
Microsoft Corporation.
All other trademarks or intellectual property mentioned herein belongs to their respective owners.
Edition 1.11 released on February 8, 2016
Document Number: OC-Y4CM-PUSR0
Printed in Canada
About Teledyne DALSA
Teledyne DALSA is an international high performance semiconductor and electronics company that
designs, develops, manufactures, and markets digital imaging products and solutions, in addition
to providing wafer foundry services.
Teledyne DALSA Digital Imaging offers the widest range of machine vision components in the
world. From industry-leading image sensors through powerful and sophisticated cameras, frame
grabbers, vision processors and software to easy-to-use vision appliances and custom vision
modules.

Xtium-CL PX4 User's Manual Contents
•
i
Contents
OVERVIEW 6
PRODUCT PART NUMBERS 6
ABOUT THE XTIUM-CL PX4 FRAME GRABBER 7
Series Key Features 7
User Programmable Configurations 7
ACUPlus: Acquisition Control Unit 7
DTE: Intelligent Data Transfer Engine 8
PCI Express x4 Gen2 Interface 8
Advanced Controls Overview 8
DEVELOPMENT SOFTWARE OVERVIEW 9
Sapera++ LT Library 9
Sapera Processing Library 9
INSTALLING XTIUM-CL PX4 10
WARNING!(GROUNDING INSTRUCTIONS) 10
INSTALLATION 10
Sapera LT Library & Xtium-CL PX4 Driver Installation 10
Xtium-CL PX4 Firmware Loader 11
Firmware Update: Automatic Mode 11
Firmware Update: Manual Mode 11
Executing the Firmware Loader from the Start Menu 12
REQUIREMENTS FOR A SILENT INSTALL 13
Silent Mode Installation 13
Creating a Response File 13
Running a Silent Mode Installation 13
Silent Mode Uninstall 14
Creating a Response File 14
Running a Silent Mode Uninstall 14
Silent Mode Installation Return Code 14
Installation Setup with CorAppLauncher.exe 14
Custom Driver Installation using install.ini 15
Creating the install.ini File 15
Run the Installation using install.ini 15
UPGRADING SAPERA OR BOARD DRIVER 16
Board Driver Upgrade Only 16
Upgrading both Sapera and Board Driver 16
USING THE CAMERA LINK SERIAL CONTROL PORT 17
COM Port Assignment 17
DISPLAYING XTIUM-CL PX4 BOARD INFORMATION 18
Device Manager – Board Viewer 18
Information Field Description 18
CONFIGURING SAPERA 20
Viewing Installed Sapera Servers 20
Increasing Contiguous Memory for Sapera Resources 20
Contiguous Memory for Sapera Messaging 21
TROUBLESHOOTING PROBLEMS 22
OVERVIEW 22
PROBLEM TYPE SUMMARY 22
First Step: Check the Status LED 22
Possible Installation Problems 22
Possible Functional Problems 23

ii
•
Contents Xtium-CL PX4 User's Manual
TROUBLESHOOTING PROCEDURES 23
Checking for PCI Bus Conflicts 23
Windows Device Manager 24
BSOD (blue screen) Following a Board Reset 25
Sapera and Hardware Windows Drivers 25
Recovering from a Firmware Update Error 26
Driver Information via the Device Manager Program 26
Teledyne DALSA Log Viewer 27
On-board Image Memory Requirements for Acquisitions 27
Symptoms: CamExpert Detects no Boards 27
Troubleshooting Procedure 27
Symptoms: Xtium-CL PX4 Does Not Grab 28
Symptoms: Card grabs black 28
Symptoms: Card acquisition bandwidth is less than expected 29
CAMEXPERT QUICK START 30
INTERFACING CAMERAS WITH CAMEXPERT 30
CamExpert Example with a Monochrome Camera 30
CAMEXPERT DEMONSTRATION AND TEST TOOLS 31
Camera Types & Files 31
Overview of Sapera Acquisition Parameter Files (*.ccf or *.cca/*.cvi) 32
Saving a Camera File 33
Camera Interfacing Check List 33
SAPERA DEMO APPLICATIONS 34
GRAB DEMO OVERVIEW 34
Using the Grab Demo 34
XTIUM-CL PX4 REFERENCE 36
BLOCK DIAGRAM 36
XTIUM-CL FLOW DIAGRAM 37
ACQUISITION TIMING 38
LINE TRIGGER SOURCE SELECTION FOR LINE SCAN APPLICATIONS 39
Parameter Values Specific to the Xtium-CL PX4 39
SHAFT ENCODER INTERFACE TIMING 39
VIRTUAL FRAME TRIGGER FOR LINE SCAN CAMERAS 41
Synchronization Signals for a 10 Line Virtual Frame 41
SAPERA ACQUISITION METHODS 43
TRIGGER TO IMAGE RELIABILITY 43
Supported Events and Transfer Methods 43
Trigger Signal Validity 45
Supported Transfer Cycling Methods 45
OUTPUT LUT AVAILABILITY 46
XTIUM-CL PX4 SUPPORTED PARAMETERS 46
Camera Related Capabilities 46
Camera Related Parameters 47
VIC Related Parameters 50
ACQ Related Parameters 55
Transfer Related Capabilities 56
Transfer Related Parameters 56
General Outputs #1: Related Capabilities (for GIO Module #0) 56
General Outputs #1: Related Parameters (for GIO Module #0) 57
General Inputs #1: Related Capabilities (for GIO Module #1) 57
General Inputs #1: Related Parameters (for GIO Module #1) 57
Bidirectional General I/Os: Related Capabilities (for GIO Module #2) 57
Bidirectional General I/Os: Related Parameters (for GIO Module #2) 58

Xtium-CL PX4 User's Manual Contents
•
iii
SAPERA SERVERS & RESOURCES 58
SERVERS AND RESOURCES 58
WINDOWS EMBEDDED 7INSTALLATION 59
TECHNICAL SPECIFICATIONS 60
XTIUM-CL PX4 BOARD SPECIFICATIONS 60
HOST SYSTEM REQUIREMENTS 61
EMI CERTIFICATIONS 62
CONNECTOR AND SWITCH LOCATIONS 63
Xtium-CL PX4 Board Layout Drawing 63
Connector / LED Description List 63
CONNECTOR AND SWITCH SPECIFICATIONS 64
Xtium-CL PX4 End Bracket Detail 64
Status LED Functional Description 65
J3: Camera Link Connector 1 66
J2: Camera Link Connector 2 67
Camera Link Camera Control Signal Overview 68
J1: External Signals Connector (Female DH60-27P) 69
Note 1: General Inputs / External Trigger Inputs Specifications 69
Block Diagram: Connecting External Drivers to General Inputs on J1 71
External Driver Electrical Requirements 71
Note 2: General Outputs /Strobe Output Specifications 72
Block Diagram: Connecting External Receivers to the General Outputs 73
External Receiver Electrical Requirements 73
Note 3: RS-422 Shaft Encoder Input Specifications 74
Note 3.1: Interfacing to an RS-422 Driver Output 75
Note 3.2: Interfacing to a TTL (also called Push-Pull) Output 75
Note 3.3: Interfacing to a Line Driver (also called Open Emitter) Output 76
Note 3.4: Interfacing to an Open Collector Output 76
J5: Multi-Board Sync / Bi-directional General I/Os 77
Hardware Preparation 77
Configuration via Sapera Application Programming 77
Configuration via Sapera CamExpert 77
J7: Power Connector 78
DC Power Details 78
CABLES &ACCESSORIES 79
DH40-27S Cable to Blunt End (OR-YXCC-27BE2M1, Rev B1) 79
DH40-27S Connector Kit for Custom Wiring 80
Board Sync Cable Assembly OR-YXCC-BSYNC40 81
Power Cable Assembly OR-YXCC-PWRY00 82
CAMERA LINK INTERFACE 83
CAMERA LINK OVERVIEW 83
Rights and Trademarks 83
DATA PORT SUMMARY 83
CAMERA SIGNAL SUMMARY 84
Video Data 84
Camera Controls 84
Communication 84
CAMERA LINK CABLES 84
CONTACT INFORMATION 85
SALES INFORMATION 85
TECHNICAL SUPPORT 85
INDEX 86

iv
•
Contents Xtium-CL PX4 User's Manual
Tables
Table 1: Xtium-CL PX4 Board Product Numbers .......................................................................6
Table 2: Xtium-CL PX4 Software Product Numbers ...................................................................6
Table 3: Xtium-CL PX4 Cables & Accessories ...........................................................................6
Table 4: Xtium-CL PX4 Device Drivers .................................................................................25
Table 5: Grab Demo Workspace Details ................................................................................34
Table 6: Acquisition Timing Specifications .............................................................................38
Table 7: CORACQ_PRM_EXT_LINE_TRIGGER_SOURCE – Parameter Values ...............................39
Table 8: Output LUT Availability...........................................................................................46
Table 9: Camera Related Capabilities....................................................................................46
Table 10: Camera Related Parameters ..................................................................................50
Table 11: VIC Related Parameters........................................................................................55
Table 12: Acquisition Related Parameters..............................................................................55
Table 13: Transfer Related Capabilities .................................................................................56
Table 14: Transfer Related Parameters .................................................................................56
Table 15: GIO-0 Related Capabilities ....................................................................................56
Table 16: GIO-0 Related Parameters ....................................................................................57
Table 17: GIO-1 Related Capabilities ....................................................................................57
Table 18: GIO-1 Related Parameters ....................................................................................57
Table 19: GIO-2 Related Capabilities ....................................................................................57
Table 20: GIO-2 Related Parameters ....................................................................................58
Table 13: Xtium-CL PX4 - Servers and Resources...................................................................58
Table 14: Board Specifications.............................................................................................61
Table 15: Environment Specifications ...................................................................................61
Table 16: Power Specifications.............................................................................................61
Table 17: Board Connector List ............................................................................................63
Table 18: D1 Boot-up/PCIe Status LED .................................................................................65
Table 19: Camera Link LED Status ......................................................................................65
Table 20: Camera Link Connector 1......................................................................................66
Table 21: Camera Link Connector 2......................................................................................67
Table 22: DH60-27P Connector Signals.................................................................................69
Table 23: External Trigger Timing Specifications ....................................................................70
Table 34: OR-YXCC-H270000 Custom Wiring Kit ....................................................................80
Table 25: Camera Link Cables Suppliers................................................................................84

Xtium-CL PX4 User's Manual Contents
•
v
Figures
Figure 1: Automatic Firmware Update...................................................................................11
Figure 2: Manual Firmware Update.......................................................................................12
Figure 3: Create an install.ini File.........................................................................................15
Figure 4: Sapera Configuration Program ...............................................................................17
Figure 5: Board Information via Device Manager....................................................................18
Figure 6: PCI Diagnostic Program.........................................................................................24
Figure 7: PCI Diagnostic Program – PCI bus info ....................................................................24
Figure 8: Using Windows Device Manager .............................................................................25
Figure 9: Board Firmware Version ........................................................................................26
Figure 10: PCI Diagnostic – checking the BUS Master bit.........................................................28
Figure 11: CamExpert Program............................................................................................30
Figure 12: Saving a New Camera File (.ccf)...........................................................................33
Figure 13: Grab Demo – Server Selection..............................................................................34
Figure 14: Grab Demo Main Window.....................................................................................35
Figure 15: Xtium-CL PX4 Model Block Diagram .....................................................................36
Figure 16: Acquisition Timing...............................................................................................38
Figure 17: Encoder Input with Pulse-drop Counter..................................................................40
Figure 18: Using Shaft Encoder Direction Parameter...............................................................40
Figure 19: Synchronization Signals for a 10 Line Virtual Frame ................................................42
Figure 20: EMI Certifications................................................................................................62
Figure 21: Board Layout......................................................................................................63
Figure 22: End Bracket Details.............................................................................................64
Figure 23: CamExpert - Camera Link Controls .......................................................................68
Figure 24: General Inputs Electrical Diagram.........................................................................69
Figure 25: External Trigger Input Validation & Delay...............................................................70
Figure 26: General Outputs Electrical Diagram.......................................................................72
Figure 27: RS-422 Shaft Encoder Input Electrical Diagram ......................................................74
Figure 32:External RS-422 Signals Connection Diagram..........................................................75
Figure 33: Interfacing TTL to RS-422 Shaft Encoder Inputs .....................................................75
Figure 34: DH60-27P Cable No. OR-YXCC-27BE2M1 Detail ......................................................79
Figure 35: Photo of cable OR-YXCC-27BE2M1 ........................................................................79
Figure 32: Photo of cable OR-YXCC-BSYNC40 ........................................................................81
Figure 33: Photo of cable assembly OR-YXCC-PWRY00............................................................82

Xtium-CL PX4 User's Manual Overview
•
6
Overview
Product Part Numbers
Xtium-CL PX4 Board
Item Product Number
Xtium-CL PX4 OR-Y4C0-XPX00
For OEM clients, this manual in printed form, is available on request OC-Y4CM-PUSR0
Table 1: Xtium-CL PX4 Board Product Numbers
Xtium-CL PX4 Software
Item Product Number
Sapera LT version 7.40 or later for full feature support (required but sold
separately)
1. Sapera LT: Provides everything needed to build imaging
application.
2. Current Sapera compliant board hardware drivers
3. Sapera documentation (compiled HTML help, Adobe Acrobat®
(PDF)
OC-SL00-0000000
(optional) Sapera Processing Imaging Development Library includes over 600
optimized image-processing routines. Contact Sales at Teledyne DALSA
Table 2: Xtium-CL PX4 Software Product Numbers
Optional Xtium-CL PX4 Cables & Accessories
Item Product Number
DH60-27S cable assembly to blunt end:
6 ft cable I/O 27 pin Hirose connector to blunt end.
This cable assembly connects to J1.
(see "J1: External Signals Connector (Female DH60-27P)" on page 69)
OR-YXCC-27BE2M1, Rev B1
DH40-27S Connector Kit for Custom Wiring:
Comprised of a DH40-27S connector plus screw lock housing kit OR-YXCC-H270000
Cable assembly to connect to J5 (Board Sync)
Connecting 2 boards
Connection 3 or 4 boards
OR-YXCC-BSYNC20
OR-YXCC-BSYNC40
Power interface cable required when supplying power to cameras and/or J1 OR-YXCC-PWRY00
Power Over Camera Link (PoCL) Video Input Cable
2 meter HDR to MDR
2 meter HDR to HDR
OR-COMC-POCLD2
OR-COMC-POCLDH
Table 3: Xtium-CL PX4 Cables & Accessories

Xtium-CL PX4 User's Manual Overview
•
7
About the Xtium-CL PX4 Frame Grabber
Series Key Features
•Compliant with Camera Link specification version 2.0
•Uses a PCIe x4 Gen2 slot to maximize transfers to host computer buffers
•Acquire from Monochrome, RGB, Bayer and Bi-Color cameras, both area scan and linescan
•Supports multiple tap formats, in multiple pixels depths
•Pixel clock range from 20 to 85 MHz
•Output lookup tables
•White Balance Gain for RGB pixels
•Vertical and Horizontal Flip supported on board
•External Input Triggers and Shaft Encoder inputs, along with Strobe outputs
•Supports a number of acquisition events in compliance with "Trigger to Image Reliability"
•RoHS compliant
•Supports Power Over Camera Link (PoCL)
See “Technical Specifications” on page 60 for detailed information.
User Programmable Configurations
Use the Xtium-CL PX4 firmware loader function in the Teledyne DALSA Device manager utility to
select firmware for one of the supported modes. Firmware selection is made either during driver
installation or manually later on (see "Firmware Update: Manual Mode" on page 11).
Full Configurations: Firmware choices are:
•One Full Camera Link Input with up to 8 Taps parallel (installation default selection):
Support for 1 Base, 1 Medium or 1 Full Camera Link camera, 1 tap segmented, 2 taps
alternate, or 2/3/4/8 taps parallel — monochrome.
•Support for 1 Base or 1 Medium Camera Link camera, 1 tap and 2 taps parallel RGB.
•One Full Camera Link Bayer Input with up to 8 Taps parallel:
Support for 1 Base, 1 Medium or 1 Full Camera Link Bayer camera, 1 tap segmented, 2 taps
alternate, or 2/3/4/8 taps parallel. Note that horizontal flipping is not available with this
configuration.
•One 80-bit Camera Link Input:
Support for one 10 Tap @ 8-bit monochrome, one 8 Tap @ 10-bit monochrome camera, one
80-bit packed RGB, or one 80-bit packed Bi-Color camera.
•One 80-bit Camera Link Bayer Input:
Support for one 10 Tap @ 8-bit Bayer camera or one 8 Tap @ 10-bit Bayer camera. Note that
horizontal flipping is not available with this configuration.
ACUPlus: Acquisition Control Unit
ACUPlus consists of a grab controller, one pixel packer, and one time base generator. ACUPlus
delivers a flexible acquisition front end and supports pixel clock rates of up to 85MHz.
ACUPlus acquires variable frame sizes up to 64KB per horizontal line and up to 16 million lines per
frame. ACUPlus can also capture an infinite number of lines from a line scan camera without losing
a single line of data.

8
•
Overview Xtium-CL PX4 User's Manual
DTE: Intelligent Data Transfer Engine
The Xtium-CL PX4 intelligent Data Transfer Engine ensures fast image data transfers between the
board and the host computer with zero CPU usage. The DTE provides a high degree of data
integrity during continuous image acquisition in a non-real time operating system like Windows.
DTE consists of multiple independent DMA units, Tap Descriptor Tables, and Auto-loading Scatter-
Gather tables.
PCI Express x4 Gen2 Interface
The Xtium-CL PX4 is a universal PCI Express x4 Gen2 board, compliant with the PCI Express 2.0
specification. The Xtium-CL PX4 board achieves transfer rates up to 1.8Gbytes/sec. to host
memory. Note that performance can be lower depending on PC and/or programmed configuration.
The Xtium-CL PX4 board occupies one PCI Express x4 Gen2 expansion slot and one chassis
opening.
Important:
•To obtain maximum transfer rate to host memory, make sure the Xtium-CL PX4 is in a Gen2
slot. Although the board will work in a Gen1 slot, only half the performance is achieved.
•If the computer only has a PCI Express x16 slot, test directly or review the computer
documentation to know if the Xtium-CL PX4 is supported. Many computer motherboards only
support x16 products in x16 slots, which are commonly graphic video boards.
Advanced Controls Overview
Visual Indicators
Xtium-CL PX4 features 3 LED indicators to facilitate system installation and setup. These indicators
provide visual feedback on the board status and camera status.
External Event Synchronization
Trigger inputs and strobe signals precisely synchronize image captures with external events.
Camera Link Communications Ports
One PC independent communication port provides Camera Link camera configuration. This port
does not require addition PC resources like free interrupts or I/O address space. Accessible via the
board device driver, the communication port presents a seamless interface to Windows-based
standard communication applications like HyperTerminal, etc. The communication port is accessible
directly from the Camera Link connectors.
Quadrature Shaft Encoder
An important feature for web scanning applications, the Quadrature Shaft Encoder inputs allow
synchronized line captures from external web encoders. The Xtium-CL PX4 provides an RS-422
input that supports a tick rate of up to 5 MHz.

Xtium-CL PX4 User's Manual Overview
•
9
Development Software Overview
Sapera++ LT Library
Sapera++ LT is a powerful development library for image acquisition and control. Sapera++ LT
provides a single API across all current and future Teledyne DALSA hardware. Sapera++ LT
delivers a comprehensive feature set including program portability, versatile camera controls,
flexible display functionality and management, plus easy to use application development wizards.
Applications are developed using either C++ or .NET frameworks.
Sapera++ LT comes bundled with CamExpert, an easy to use camera configuration utility to create
new, or modify existing camera configuration files.
Sapera Processing Library
Sapera Processing is a comprehensive set of C++ classes or .NET classes for image processing and
analysis. Sapera Processing offers highly optimized tools for image processing, blob analysis,
search (pattern recognition), OCR and barcode decoding.

Xtium-CL PX4 User's Manual Installing Xtium-CL PX4
•
10
Installing Xtium-CL PX4
Warning! (Grounding Instructions)
Static electricity can damage electronic components. Please discharge any static electrical charge
by touching a grounded surface, such as the metal computer chassis, before performing any
hardware installation. If you do not feel comfortable performing the installation, please consult a
qualified computer technician.
Important: Never remove or install any hardware component with the computer power
on. Disconnect the power cord from the computer to disable the power standby mode.
This prevents the case where some computers unexpectedly power up when a board is
installed.
Installation
The Sapera LT Development Library (or ‘runtime library’ if application execution without
development is preferred) must be installed before the Xtium-CL PX4 device driver.
Turn the computer off, disconnect the power cord (disables power standby mode), and open the
computer chassis to allow access to the expansion slot area.
Install the Xtium-CL PX4 into a free PCI Express x4 Gen2 expansion slot (or an available x8
slot). Note that some computer's x16 slot may support the Xtium-CL PX4.
Connect a spare power supply connector to J7 for PoCL cameras or when DC power is required
on the external signals connector J1. See Power Cable Assembly OR-YXCC-PWRY00 for
information about an adapter for older computers.
Close the computer chassis and turn the computer on.
Logon to the workstation as administrator or with an account that has administrator privileges.
Windows will find the Xtium-CL PX4 and start its Found New Hardware Wizard. Click on the
Cancel button to close the Wizard.
Sapera LT Library & Xtium-CL PX4 Driver Installation
Insert the Teledyne DALSA Sapera Essential CD-ROM. If AUTORUN is enabled on your
computer, the installation menu is presented.
If AUTORUN is not enabled, use Windows Explorer and browse to the root directory of the CD-
ROM. Execute autorun.exe to start the installation menu.
From the CD Browser menu, select the Software Installation menu to install the required
Sapera components. Select the Xtium-CL PX4 Driver and required Sapera package. Click the
Next button to cycle through the various board product families.
If the installation of Sapera and Board Drivers is not done through the CD Browse applet, make
sure Sapera LT is installed before any board drivers.
The installation program may prompt to reboot the computer. It is not necessary to reboot the
computer between the installation of Sapera LT and the board driver. Simply reboot once all the
software and board drivers are installed.
During the late stages of the installation, the Xtium-CL PX4 firmware loader application starts.
This is described in detail in the following section.
If Windows displays any unexpected message concerning the installed board, power off the
system and verify the Xtium-CL PX4 is installed in the slot properly.
Refer to Sapera LT User’s Manual for additional details about Sapera LT.

Xtium-CL PX4 User's Manual Installing Xtium-CL PX4
•
11
Xtium-CL PX4 Firmware Loader
The Device Manager-Firmware Loader program automatically executes at the end of the driver
installation and on every subsequent reboot of the computer. It will determine if the Xtium-CL PX4
requires a firmware update. If firmware is required, a dialog displays. This dialog also allows the
user to load firmware for alternate operational modes of the Xtium-CL PX4.
Important:In the rare case of firmware loader errors please see "Recovering from a Firmware
Update Error" on page 26.
Firmware Update: Automatic Mode
Click Automatic to update the Xtium-CL PX4 firmware. The Xtium-CL PX4 supports various
firmware configurations with the default being a Full, Medium, or Base camera.
See “Series Key Features” on page 7and “User Programmable Configurations” on page 7for details
on all supported modes, selected via a manual firmware update.
With multiple Xtium-CL PX4 boards in the system, all are updated with new firmware. If any
installed Xtium-CL PX4 board installed in a system already has the correct firmware version, an
update is not required. In the following screen shot, a single Xtium-CL PX4 Full board is installed
and ready for a firmware upgrade.
Figure 1: Automatic Firmware Update
Firmware Update: Manual Mode
Select Manual mode to load firmware other then the default version or when, in the case of
multiple Xtium-CL PX4 boards in the same system, if each requires different firmware.
The following figure shows the Device Manager manual firmware screen. Displayed is information
on all installed Xtium-CL PX4 boards, their serial numbers, and their firmware components.
Do a manual firmware update as follows:
•Select the Xtium-CL PX4 to update via the board selection box (if there are multiple boards
in the system)
•From the Configuration field drop menu select the firmware version required (typical
required to support different cameras)
•Click on the Start Update button
•Observe the firmware update progress in the message output window
•Close the Device manager program when the device reset complete message is shown

12
•
Installing Xtium-CL PX4 Xtium-CL PX4 User's Manual
Figure 2: Manual Firmware Update
Executing the Firmware Loader from the Start Menu
If required, the Xtium-CL PX4 Firmware Loader program is executed via the Windows Start Menu
shortcut Start • Programs • Teledyne DALSA • Xtium-CL PX4 Driver • Firmware Update. A
firmware change after installation would be required to select a different configuration mode. See
"User Programmable Configurations" on page 7.

Xtium-CL PX4 User's Manual Installing Xtium-CL PX4
•
13
Requirements for a Silent Install
Both Sapera LT and the Xtium-CL PX4 driver installations share the same installer technology.
When the installations of Teledyne DALSA products are embedded within a third party’s product
installation, the mode can either have user interaction or be completely silent. The following
installation mode descriptions apply to both Sapera and the hardware driver.
Note: You must reboot after the installation of Sapera LT. However, to streamline the
installation process, Sapera LT can be installed without rebooting before installing the board
hardware device drivers. The installations then complete with a single final system reboot.
Perform Teledyne DALSA embedded installations in either of these two ways:
Normal Mode
The default mode is interactive. This is identical to running the setup.exe program manually
from Windows (either run from Windows Explorer or the Windows command line).
Silent Mode
This mode requires no user interaction. A preconfigured “response” file provides the user input.
The installer displays nothing.
Silent Mode Installation
A Silent Mode installation is recommended when integrating Teledyne DALSA products into your
software installation. The silent installation mode allows the device driver installation to proceed
without the need for mouse clicks or other input from a user.
Preparing a Silent Mode Installation requires two steps:
Prepare the response file, which emulates a user.
Invoke the device driver installer with command options to use the prepared response file.
Creating a Response File
Create the installer response file by performing a device driver installation with a command line
switch "-r". The response file is automatically named setup.iss and is saved in the \windows
folder. If a specific directory is desired, the switch –f1 is used.
As an example, to save a response file in the same directory as the installation executable of the
Xtium-CL PX4, the command line would be:
Xtium-CL_PX4_1.00.00.0000 –r –f1”.\setup.iss”
Running a Silent Mode Installation
A device driver silent installation, whether done alone or within a larger software installation
requires the device driver executable and the generated response file setup.iss.
Execute the device driver installer with the following command line:
Xtium-CL_PX4_1.00.00.0000 -s -f1".\setup.iss"
Where the –s switch specifies the silent mode and the –f1 switch specifies the location of the
response file. In this example, the switch –f1".\setup.iss" specifies that the setup.iss file be in the
same folder as the device driver installer.
Note: On Windows 7 and 8, the Windows Security dialog box will appear unless one has already
notified Windows to ‘Always trust software from “Teledyne DALSA Inc.” during a previous
installation of a driver.

14
•
Installing Xtium-CL PX4 Xtium-CL PX4 User's Manual
Silent Mode Uninstall
Similar to a silent installation, a response file must be prepared first as follows.
Creating a Response File
The installer response file is created by performing a device driver un-installation with a command
line switch "-r". The response file is automatically named setup_uninstall.iss which is saved in
the \windows folder. If a specific directory is desired, the switch “–f1” is used.
As an example, to save a response file in the same directory as the installation executable of the
Xtium-CL PX4, the command line would be:
Xtium-CL_PX4_1.00.00.0000 –r –f1”.\setup_uninstall.iss”
Running a Silent Mode Uninstall
Similar to the device driver silent mode installation, the un-installation requires the device driver
executable and the generated response file setup.iss.
Execute the device driver installer with the following command line:
Xtium-CL_PX4_1.00.00.0000 -s -f1".\setup_uninstall.iss"
Where the –s switch specifies the silent mode and the –f1 switch specifies the location of the
response file. In this example, the switch –f1".\setup_uninstall.iss" specifies that the
setup_uninstall.iss file be in the same folder as the device driver installer.
Silent Mode Installation Return Code
A silent mode installation creates a file “corinstall.ini” in the Windows directory. A section called
[SetupResult] contains the ‘status’ of the installation. A value of 1 indicates that the installation has
started and a value of 2 indicates that the installation has terminated.
A silent mode installation also creates a log file “setup.log” which by default is created in the same
directory and with the same name (except for the extension) as the response file. The /f2 option
enables you to specify an alternative log file location and file name, as in
Setup.exe /s /f2"C:\Setup.log".
The “setup.log” file contains three sections. The first section, [InstallShield Silent], identifies the
version of InstallShield used in the silent installation. It also identifies the file as a log file. The
second section, [Application], identifies the installed application name, version, and the company
name. The third section, [ResponseResult], contains the ‘ResultCode’ indicating whether the silent
installation succeeded. A value of 0 means the installation was successful.
Installation Setup with CorAppLauncher.exe
The installation setup can be run with the CorAppLauncher.exe tool provided with the driver.
Install the board driver and get CorAppLauncher.exe from the \bin directory of the installation.
When running the installation, CorAppLauncher.exe will return only when the installation is
finished.
When run from within a batch file, obtain the installation exit code from the ERRORLEVEL value.
The arguments to CorAppLauncher.exe are
-l: Launch application
-f: Application to launch. Specify a fully qualified path.
As an example:
CorAppLauncher –l –f”c:\driver_install\Xtium-cl_PX4_1.00.00.0000.exe”
IF %ERRORLEVEL% NEQ 0 goto launch error

Xtium-CL PX4 User's Manual Installing Xtium-CL PX4
•
15
Note: There is a 32-bit and 64-bit version of CorAppLauncher.exe. When installing the driver, only
the version related to the OS is installed. However, the 32-bit version is usable on either 32-bit or
64-bit Windows.
Custom Driver Installation using install.ini
Customize the driver installation by parameters defined in the file “install.ini”. By using this file, the
user can:
Select the user default configuration.
Select different configurations for systems with multiple boards.
Assign a standard Serial COM port to board.
Creating the install.ini File
Install the driver in the target computer. All Xtium-CL PX4 boards required in the system must
be installed.
Configure each board’s acquisition firmware using the Teledyne DALSA Device Manager tool
(see Device Manager – Board Viewer).
If a standard Serial COM port is required for any board, use the Sapera Configuration tool (see
COM Port Assignment).
When each board setup is complete, using the Teledyne DALSA Device Manager tool, click on
the Save Config File button. This will create the “install.ini” file.
Figure 3: Create an install.ini File
Run the Installation using install.ini
Copy the install.ini file into the same directory as the setup installation file. Run the setup
installation as normal. The installation will automatically check for an install.ini file and if found, use
the configuration defined in it.

16
•
Installing Xtium-CL PX4 Xtium-CL PX4 User's Manual
Upgrading Sapera or Board Driver
When installing a new version of Sapera or a Teledyne DALSA acquisition board driver in a
computer with a previous installation, the current version must be un-installed first. Described
below are two upgrade situations. Note that if the board is installed in a different slot, the new
hardware wizard opens. Answer as instructed in section “Installation” on page 10.
Board Driver Upgrade Only
Minor upgrades to acquisition board drivers are distributed as ZIP files available in the Teledyne
DALSA web site www.teledynedalsa.com/mv/support. Board driver revisions are also available on
the next release of the Sapera Essential CD-ROM.
Often minor board driver upgrades do not require a new revision of Sapera. To confirm that the
current Sapera version will work with the new board driver:
•Check the new board driver ReadMe file before installing, for information on the minimum
Sapera version required.
•If the ReadMe file does not specify the Sapera version required, contact Teledyne DALSA
Technical Support (see "Technical Support" on page 85 ).
To upgrade the board driver only:
•Logon the computer as an administrator or with an account that has administrator
privileges.
•In Windows 7, from the start menu select Start • Settings • Control Panel • Programs
and Features. Double-click the Teledyne DALSA Xcelera board driver and click Remove.
•Install the new board driver. Run Setup.exe if installing manually from a downloaded driver
file.
•In Windows 8 & Windows 10, just type Control Panel while in the start screen, or click
the arrow in the lower left side to bring up the all applications window. Select Programs and
Features, then double-click the Teledyne DALSA Xcelera board driver and click Remove.
•If the new driver is on a Sapera Essential CD-ROM follow the installation procedure
described in "& Xtium-CL PX4 Driver" on page 10.
•Important: You cannot install a Teledyne DALSA board driver without Sapera LT installed
on the computer.
Upgrading both Sapera and Board Driver
When upgrading both Sapera and the acquisition board driver, follow the procedure described
below.
•Logon the computer as an administrator or with an account that has administrator
privileges.
•In Windows 7, from the start menu select Start • Settings • Control Panel • Programs
and Features. Double-click the Teledyne DALSA Xcelera board driver and click Remove.
Follow by also removing the older version of Sapera LT.
•In Windows 8 & Windows 10, just type Control Panel while in the start screen, or click
the arrow in the lower left side to bring up the all applications window. Select Programs
and Features, then double-click the Teledyne DALSA Xcelera board driver and click
Remove.
•Reboot the computer and logon the computer as an administrator again.
•Install the new versions of Sapera and the board driver as if this was a first time
installation. See "Sapera LT Library & Xtium-CL PX4 Driver Installation" on page 10 and "&
Xtium-CL PX4 Driver" on page 10 for installation procedures.

Xtium-CL PX4 User's Manual Installing Xtium-CL PX4
•
17
Using the Camera Link Serial Control Port
The Camera Link cabling specification includes a serial communication port for direct camera
control by the frame grabber (see "J3: Camera Link Connector 1 " on page 66). The Xtium-CL PX4
driver supports this serial communication port either directly (such as the Serial Command window
in CamExpert) or by mapping it to a host computer COM port. Any serial port communication
program, such as Windows HyperTerminal, can connect to the camera in use and modify its
function modes via its serial port controls. The Xtium-CL PX4 serial port supports communication
speeds from 9600 to 921600bps. The serial port is created by the kernel driver, so it will be
available even if no Sapera LT application has started.
Note: if the serial communication program can directly select the Xtium-CL PX4 serial port then
mapping to a system COM port is not necessary.
When required, map the Xtium-CL PX4 serial port to an available COM port by using the Sapera
Configuration tool. Run the program from the Windows start menu: Start • Programs • DALSA •
Sapera LT • Sapera Configuration.
COM Port Assignment
The lower section of the Sapera Configuration program screen contains the serial port configuration
menu. Configure as follows:
•Use the Physical Port drop menu to select the Sapera board device from all available
Sapera boards with serial ports (when more then one board is in the system).
•Use the Optional COM Ports Mapping drop menu to assign an available COM number to
that Sapera board serial port.
•Click on the Save Settings Now button then the Close button. Reboot the computer at the
prompt to enable the serial port mapping.
Figure 4: Sapera Configuration Program

18
•
Installing Xtium-CL PX4 Xtium-CL PX4 User's Manual
Displaying Xtium-CL PX4 Board Information
The Device Manager program also displays information about the Xtium-CL PX4 boards installed in
the system. To view board information run the program via the Windows Start Menu shortcut Start
• Programs • Teledyne DALSA • Xtium-CL PX4 Device Driver • Device Manager.
Device Manager – Board Viewer
The following screen image shows the Device Manager program with the Information/Firmware tab
active. The left window displays all Teledyne DALSA boards in the system and their individual
device components. The right window displays the information stored in the selected board device.
This example screen shows the Xtium-CL PX4 board information.
Generate the Xtium-CL PX4 device manager report file (BoardInfo.txt) by clicking File • Save
Device Info. Teledyne DALSA Technical Support may request this report to aid in troubleshooting
installation or operational problems.
Figure 5: Board Information via Device Manager
Information Field Description
Serial Number [Read-Only]: Serial Number of the board
Hardware ID [Read-Only]: This field will identify future hardware changes that affect the
operation of the board. Currently there are no such changes.
Hardware Configuration [Read-Only]: This field will state the presence or absence of optional
components. Currently there are no optional components available.
User Data [Read/Write]: This is a 64 byte general purpose user storage area. For information
on how to read/write this field at the application level, contact Teledyne DALSA Technical
Support.
User Interface GIOs Reservation [Read/Write]: Use this field to reserve User Interface GIOs
for use by the acquisition module. By default, boards are shipped with User Interface General
Inputs 1 & 2 reserved for External Triggers and User Interface General Outputs 1 & 2 reserved
for Strobe Outputs.
Click on the ‘Value’ field to open the dialog box show below. Disable any GIO reservations that