Dalsa Xtium-CL MX4 User manual
NOTICE
© 2018 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 and Windows® 10
are trademarks of Microsoft Corporation.
All other trademarks or intellectual property mentioned herein belongs to their respective owners.
Edition 1.20 released on April 27, 2018
Document Number: OC-Y4CM-MUSR0
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 MX4 User's Manual Contents •i
Contents
OVERVIEW 7
PRODUCT PART NUMBERS 7
ABOUT THE XTIUM-CL MX4 FRAME GRABBER 8
Series Key Features 8
Supported Camera Link Configurations 8
User Programmable Configurations 9
ACUPlus: Acquisition Control Unit 9
DTE: Intelligent Data Transfer Engine 10
PCI Express x4 Gen2 Interface 10
Advanced Controls Overview 10
Visual Indicators 10
External Event Synchronization 10
Camera Link Communications Ports 10
Quadrature Shaft Encoder 10
DEVELOPMENT SOFTWARE OVERVIEW 11
Sapera++ LT Library 11
Sapera Processing Library 11
QUICK START SETUP & INSTALLATION 12
INSTALLING XTIUM-CL MX4 16
WARNING!(GROUNDING INSTRUCTIONS) 16
INSTALLATION 16
Sapera LT Library & Xtium-CL MX4 Driver Installation 17
Teledyne DALSA Device Drivers 17
Installation Procedure 17
Xtium-CL MX4 Firmware Loader 18
Firmware Update: Automatic Mode 18
Firmware Update: Manual Mode 19
Performing a Manual Firmware Update 19
Executing the Firmware Loader from the Start Menu 20
UPGRADING SAPERA OR BOARD DRIVER 21
Board Driver Upgrade Only 21
Upgrading both Sapera and Board Driver 21
USING THE CAMERA LINK SERIAL CONTROL PORT 22
COM Port Assignment 22
DISPLAYING XTIUM-CL MX4 BOARD INFORMATION 23
Device Manager – Board Viewer 23
Information Field Description 24
Device Information Report 26
CONFIGURING SAPERA 27
Viewing Installed Sapera Servers 27
Increasing Contiguous Memory for Sapera Resources 27
Host Computer Frame Buffer Memory Limitations 28
Contiguous Memory for Sapera Messaging 28
CAMEXPERT QUICK START 29
INTERFACING CAMERAS WITH CAMEXPERT 29
SAPERA CAMERA CONFIGURATION FILES 31
Camera Types & Files 31
Camera Files Distributed with Sapera 31
Overview of Sapera Acquisition Parameter Files (*.ccf or *.cca/*.cvi) 31
ii •Contents Xtium-CL MX4 User's Manual
Concepts and Differences between the Parameter Files 31
CCF File Details 32
CCA File Details 32
CVI File Details 32
Saving a Camera File 32
Camera Interfacing Check List 33
USING CAMEXPERT WITH XTIUM-CL MX4 34
BASIC TIMING CATEGORY 35
Parameter Descriptions 35
ADVANCED CONTROL CATEGORY 37
Parameter Descriptions 37
EXTERNAL TRIGGER CATEGORY 39
Parameter Descriptions 39
IMAGE BUFFER AND ROI CATEGORY 41
Parameter Descriptions 41
USING THE FLAT FIELD CORRECTION TOOL 43
Xtium-CL MX4 Flat Field Support 43
Loading the Required Camera File 43
Set up Dark and Bright Acquisitions with the Histogram Tool 43
Verify a Dark Acquisition 43
Verify a Bright Acquisition 44
Flat Field Correction Calibration Procedure 45
Flat Field Calibration Window 45
Using Flat Field Correction 46
USING THE BAYER FILTER TOOL 47
Bayer Filter White Balance Calibration Procedure 47
Using the Bayer Filter 47
SAPERA DEMO APPLICATIONS 48
Grab Demo Overview 48
Grab Demo Workspace Details 48
Using the Grab Demo 49
Server Selection 49
CCF File Selection 49
Grab Demo Main Window 50
XTIUM-CL MX4 REFERENCE 51
BLOCK DIAGRAM 51
XTIUM-CL FLOW DIAGRAM 52
ACQUISITION TIMING 53
LINE TRIGGER SOURCE SELECTION FOR LINE SCAN APPLICATIONS 54
Parameter Values Specific to the Xtium-CL MX4 54
CVI/CCF File Parameters Used 54
SHAFT ENCODER INTERFACE TIMING 55
Dual Balanced Shaft Encoder RS-422 Inputs: 55
Example using any Encoder Input with Pulse-drop Counter 55
Example using Sequential Encoder Input 56
CVI/CCF File Parameters Used 56
VIRTUAL FRAME TRIGGER FOR LINE SCAN CAMERAS 57
Virtual Frame Trigger Timing Diagrams 57
Synchronization Signals for a 10 Line Virtual Frame 57
Synchronization Signals for Fixed Frame Length Acquisition 58
Synchronization Signals for Variable Frame Length Acquisition 59
SAPERA ACQUISITION METHODS 61
TRIGGER TO IMAGE RELIABILITY 61
Supported Events and Transfer Methods 62
Acquisition Events 62
Transfer Events 63
Xtium-CL MX4 User's Manual Contents •iii
Trigger Signal Validity 64
Supported Transfer Cycling Methods 64
OUTPUT LUT AVAILABILITY 65
METADATA:THEORY OF OPERATION 66
Metadata Data Structure 66
FLAT FIELD CORRECTION:THEORY OF OPERATION 67
Flat Field Correction Lists 67
Flat Field Correction Sets 68
Xtium-CL MX4 specific limitations 68
Programming the sets 68
XTIUM-CL MX4 SUPPORTED PARAMETERS 69
Camera Related Capabilities 69
Camera Related Parameters 70
VIC Related Parameters 75
ACQ Related Parameters 80
Transfer Related Capabilities 81
Transfer Related Parameters 82
General Outputs #1: Related Capabilities (GIO Module #0) 82
General Outputs #1: Related Parameters (GIO Module #0) 82
General Inputs #1: Related Capabilities (GIO Module #1) 83
General Inputs #1: Related Parameters (GIO Module #1) 83
Bidirectional General I/Os: Related Capabilities (GIO Module #2) 83
Bidirectional General I/Os: Related Parameters (GIO Module #2) 83
SAPERA SERVERS & RESOURCES 84
SERVERS AND RESOURCES 84
WINDOWS EMBEDDED 7INSTALLATION 85
TECHNICAL SPECIFICATIONS 86
XTIUM-CL MX4 BOARD SPECIFICATIONS 86
HOST SYSTEM REQUIREMENTS 88
EMI CERTIFICATIONS 89
CONNECTOR AND SWITCH LOCATIONS 90
Xtium-CL MX4 Board Layout Drawing 90
Connector / LED Description List 90
CONNECTOR AND SWITCH SPECIFICATIONS 91
Xtium-CL MX4 End Bracket Detail 91
Status LED Functional Description 92
J3: Camera Link Connector 1 93
J2: Camera Link Connector 2 94
Camera Link Camera Control Signal Overview 95
J1: External Signals Connector (Female DH60-27P) 96
J4: Internal I/O Signals Connector (26-pin SHF-113-01-L-D-RA) 96
Xtium-CL MX4 rev. A2 96
Xtium-CL MX4 rev. A1 97
Note 1: General Inputs / External Trigger Inputs Specifications 98
Block Diagram: Connecting External Drivers to General Inputs on J1 or J4 100
External Driver Electrical Requirements 101
Note 2: General Outputs /Strobe Output Specifications 102
Block Diagram: Connecting External Receivers to the General Outputs 103
External Receiver Electrical Requirements 104
Note 3: RS-422 Shaft Encoder Input Specifications 105
Note 3.1: Interfacing to an RS-422 Driver Output 106
Note 3.2: Interfacing to a TTL (also called Push-Pull) Output 107
Note 3.3: Interfacing to a Line Driver (also called Open Emitter) Output 107
Note 3.4: Interfacing to an Open Collector Output 108
J5: Multi-Board Sync / Bi-directional General I/Os 108
Hardware Preparation 108
iv •Contents Xtium-CL MX4 User's Manual
Configuration via Sapera Application Programming 108
Configuration via Sapera CamExpert 109
J7: Power Connector 110
DC Power Details 110
Differences between Rev A1 and Rev A2 110
CABLES &ACCESSORIES 111
DH40-27S Cable to Blunt End (OR-YXCC-27BE2M1, Rev B1) 111
DH40-27S Connector Kit for Custom Wiring 112
Cable assemblies for I/O connector J4 113
Teledyne DALSA I/O Cable (part #OR-YXCC-TIOF120) 113
Third Party I/O Cables for J4 113
Board Sync Cable Assembly OR-YXCC-BSYNC40 114
Power Cable Assembly OR-YXCC-PWRY00 115
CAMERA LINK INTERFACE 116
CAMERA LINK OVERVIEW 116
Rights and Trademarks 116
DATA PORT SUMMARY 116
CAMERA SIGNAL SUMMARY 117
Video Data 117
Camera Controls 117
Communication 117
CAMERA LINK CABLE MANUFACTURER CONTACT INFORMATION 117
APPENDIX A: SILENT INSTALLATION 118
Silent Mode Installation 118
Creating a Response File 118
Running a Silent Mode Installation 118
Silent Mode Uninstall 119
Creating a Response File 119
Running a Silent Mode Uninstall 119
Silent Mode Installation Return Code 119
Installation Setup with CorAppLauncher.exe 119
Custom Driver Installation using install.ini 120
Creating the install.ini File 120
Run the Installation using install.ini 120
APPENDIX B: TROUBLESHOOTING INSTALLATION PROBLEMS 121
OVERVIEW 121
PROBLEM TYPE SUMMARY 121
First Step: Check the Status LED 121
Possible Installation Problems 122
Possible Functional Problems 122
TROUBLESHOOTING PROCEDURES 123
Diagnostic Tool Overview 123
Diagnostic Tool Main Window 123
Diagnostic Tool Self Test Window 124
Diagnostic Tool Live Monitoring Window 125
Checking for PCI Bus Conflicts 125
Windows Device Manager 127
BSOD (blue screen) Following a Board Reset 127
Sapera and Hardware Windows Drivers 128
Recovering from a Firmware Update Error 128
Driver Information via the Device Manager Program 129
Teledyne DALSA Log Viewer 130
On-board Image Memory Requirements for Acquisitions 130
Dual Camera Input Configuration 130
Symptoms: CamExpert Detects no Boards 131
Xtium-CL MX4 User's Manual Contents •v
Troubleshooting Procedure 131
Symptoms: Xtium-CL MX4 Does Not Grab 131
Symptoms: Card grabs black 131
Symptoms: Card acquisition bandwidth is less than expected 132
Symptoms: PoCL does not power the camera 133
CONTACT INFORMATION 134
SALES INFORMATION 134
TECHNICAL SUPPORT 134
vi •Contents Xtium-CL MX4 User's Manual
Figures
Figure 1: Automatic Firmware Update 18
Figure 2: Manual Firmware Update 19
Figure 3: Firmware Update Progress 19
Figure 4: Start Menu Firmware Update Shortcut 20
Figure 5: Sapera Configuration Program 22
Figure 6: Board Information via Device Manager 23
Figure 7: Device Manager File Menu Save Device Info Command 26
Figure 8: CamExpert Program 29
Figure 9: Saving a New Camera File (.ccf) 33
Figure 10: Grab Demo – Server Selection 49
Figure 11: Grab Demo Main Window 50
Figure 12: Xtium-CL MX4 Model Block Diagram 51
Figure 13: Xtium-CL MX4 Flow Diagram 52
Figure 14: Acquisition Timing 53
Figure 15: Encoder Input with Pulse-drop Counter 55
Figure 16: Using Shaft Encoder Direction Parameter 56
Figure 17: Synchronization Signals for a 10 Line Virtual Frame 58
Figure 18: Line scan, Fixed Frame, No Trigger 58
Figure 19: Line scan, Fixed Frame, Edge Trigger 58
Figure 20: Line scan, Fixed Frame, Level Trigger (Roll-Over to Next Frame) 59
Figure 21: Line scan, Variable Frame, Edge Trigger (Active High determines Frame Length) 59
Figure 22: Line scan, Fixed Frame, Level Trigger ( Roll-Over) 59
Figure 23: EMI Certifications 89
Figure 24: Board Layout 90
Figure 25: End Bracket Details 91
Figure 26: CamExpert - Camera Link Controls 95
Figure 27: General Inputs Electrical Diagram 98
Figure 28: External Trigger Input Validation & Delay 99
Figure 29:Rev A2: External Signals Connection Diagram 100
Figure 30:Rev A1: External Signals Connection Diagram 101
Figure 31: General Outputs Electrical Diagram 102
Figure 32:Rev A2: Output Signals Connection Diagram 103
Figure 33:Rev A1: Output Signals Connection Diagram 104
Figure 34: RS-422 Shaft Encoder Input Electrical Diagram 105
Figure 35:External RS-422 Signals Connection Diagram 106
Figure 36: Interfacing TTL to RS-422 Shaft Encoder Inputs 107
Figure 37: DH60-27P Cable No. OR-YXCC-27BE2M1 Detail 111
Figure 38: Photo of cable OR-YXCC-27BE2M1 111
Figure 39: OR-YXCC-H270000 Custom Wiring Kit 112
Figure 40: I/O Cable #OR-YXCC-TIOF120 113
Figure 41: Photo of cable OR-YXCC-BSYNC40 114
Figure 42: Photo of cable assembly OR-YXCC-PWRY00 115
Figure 43: Create an install.ini File 120
Figure 44: Diagnostic Tool Main Window 123
Figure 45: Diagnostic Tool Self Test Window 124
Figure 46: PCI Diagnostic Tool Live Monitoring Window 125
Figure 47: PCI Diagnostic Program 126
Figure 48: PCI Diagnostic Program – PCI bus info 126
Figure 49: Using Windows Device Manager 127
Figure 50: Board Firmware Version 129
Figure 51: PCI Diagnostic – checking the BUS Master bit 132
Figure 52: CamExpert PoCL Parameter 133
Figure 53: CamExpert Video Status Bar 133
Xtium-CL MX4 User's Manual Overview •7
Overview
Product Part Numbers
Xtium-CL MX4 Board
Item Product Number
Xtium-CL MX4 OR-Y4C0-XMX00
For OEM clients, this manual in printed form, is available on request. OC-Y4CM-MUSR0
Xtium-CL MX4 Software
Item Product Number
Sapera LT version 8.20 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
Optional Xtium-CL MX4 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))
OR-YXCC-27BE2M1, Rev B1
Cable set to connect to J4 Internal I/O Signals connector
(J4: 26-pin SHF-113-01-L-D-RA) See suggested cables
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/J4 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
8•Overview Xtium-CL MX4 User's Manual
About the Xtium-CL MX4 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 line scan
•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
•Flat Field and Flat Line correction: pixel replacement using either neighborhood pixels or
3x2 cluster replacement.
•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)
Supported Camera Link Configurations
The Camera Link industry standard is maintained by the Automated Imaging Association (AIA).
Camera Link configurations are Base, Medium, Full and Deca (Extended-Full).
Configuration Data
Bits Maximum Throughput Cables
Base 24 255 MB/s 1
Medium 48 510 MB/s 2
Full 64 680 MB/s 2
Deca (80-bits) 80 850 MB/s 2
Xtium-CL MX4 User's Manual Overview •9
User Programmable Configurations
The Xtium-CL MX4 supports the following Camera Link configurations, using one of 3 available
firmware designs:
Firmware Supported Camera Link Configurations
One Full Camera Link Input
(installation default selection) •1 Base, 1 Medium or 1 Full Camera Link monochrome or bayer
camera, 1/2/3/4/8 tap segmented, 2 taps alternate, or 2/3/4/8
taps parallel.
•1 Base or 1 Medium Camera Link RGB camera, 1 tap and 2 taps
segmented/parallel.
•Full Camera Link packed RGB camera.
One 80-bit Camera Link
Input •One 10 Tap @ 8-bit monochrome or bayer camera
•One 8 Tap @ 10-bit monochrome or bayer camera
•One 80-bit packed RGB camera
•One 80-bit packed Bi-Color camera
Two Base Camera Link Input
(any 2 of the supported
configuration)
• Base Camera Link monochrome or Bayer camera, 1/2/3 tap
segmented, 2 taps alternate, 2/3 taps parallel.
• Base Camera Link RGB camera, 1 tap64
Use the Xtium-CL MX4 firmware 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).
ACUPlus: Acquisition Control Unit
ACUPlus consists of a grab controller, one pixel packer, and one time base generator per camera
input. 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.
10 •Overview Xtium-CL MX4 User's Manual
DTE: Intelligent Data Transfer Engine
The Xtium-CL MX4 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 MX4 is a universal PCI Express x4 Gen2 board, compliant with the PCI Express 2.0
specification. The Xtium-CL MX4 board achieves transfer rates up to 1.7 Gbytes/sec. to host
memory. Note that performance can be lower depending on PC and/or programmed configuration.
The Xtium-CL MX4 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 MX4 is in a Gen2
slot. Although the board will work in a Gen1 slot, only half the performance is achieved.
•The system motherboard BIOS should allow setting the PCIe maximum payload size to 256 MB
or higher. Systems with fixed settings of 128 MB will limit performance for transfers to host
memory.
•If the computer only has a PCI Express x16 slot, test directly or review the computer
documentation to verify if the Xtium-CL MX4 is supported since computer motherboards may
only support x16 graphic video board products in x16 slots.
Advanced Controls Overview
Visual Indicators
Xtium-CL MX4 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 per camera input 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 MX4 provides an RS-422
input that supports a tick rate of up to 5 MHz.
Xtium-CL MX4 User's Manual Overview •11
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.
12 •Quick Start Setup & Installation Xtium-CL MX4 User's Manual
Quick Start Setup & Installation
The following procedure outlines the basic steps required to install the Teledyne DALSA Xtium-CL
MX4. For complete installation details and information, see Installing Xtium-CL MX4.
Install the Xtium-CL MX4 in an available PCIe x4 (or x8) slot on the host computer.
If using PoCL, connect power to the board J7 connector.
Download and install the Sapera LT SDK software from the Teledyne DALSA website.
http://teledynedalsa.com/imaging/support/downloads/sdks/
Download and install the Xtium-CL MX4 device driver from the Teledyne DALSA website.
https://www.teledynedalsa.com/imaging/support/downloads/drivers/
Xtium-CL MX4 User's Manual Quick Start Setup & Installation •13
To complete the installation, update the Xtium-CL MX4 firmware when prompted; select
Automatic to update with the default configuration (Full Camera Link) or Manual to select
another option (2 Base Camera Link or 80-Bits Camera Link).
Reboot when all software and board drivers are installed.
Launch Sapera LT CamExpert to verify the installation; the board should be present in
the list of available devices.
Connect camera(s) to the board Camera Link connectors. Ensure cameras are properly
powered.
If using PoCL, use CamExpert to enable the PoCL feature in the the Basic Timing
category.
14 •Quick Start Setup & Installation Xtium-CL MX4 User's Manual
In CamExpert, click Detect Camera.
If the Detect Camera button is disabled, click Settings to open the the Communication
Settings dialog to configure CamExpert to detect attached cameras using a serial port.
When CamExpert detects a camera (if GenCP compliant), camera parameters are
displayed along with the board parameters.
When properly connected, the video status bar displays camera signals in green.
Xtium-CL MX4 User's Manual Quick Start Setup & Installation •15
Click Grab to acquire a test image to validate the setup.
Modify the board and camera parameters as necessary. When completed, save the
camera configuration file.
The Xtium-CL MX4 can be configured using the the parameter settings in this file when
using the Sapera LT API in your application to acquire images
Xtium-CL MX4 User's Manual Installing Xtium-CL MX4 •16
Installing Xtium-CL MX4
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 MX4 device driver.
The installation sequence is as follows:
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 MX4 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 MX4.
Connect a spare power supply connector to J7 for PoCL cameras or when DC power is required
on the external signals connector J1 or J4. 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 computer as administrator or with an account that has administrator privileges.
For information on performing a silent installation, refer to Appendix A: Silent Installation.
For troubleshooting installation problems, refer to Appendix B: Troubleshooting Installation
Problems
Xtium-CL MX4 User's Manual Installing Xtium-CL MX4 •17
Sapera LT Library & Xtium-CL MX4 Driver Installation
Sapera LT SDK (full version), the image acquisition and control SDK for Teledyne DALSA
cameras and frame grabbers is available for download from the Teledyne DALSA website:
http://teledynedalsa.com/imaging/support/downloads/sdks/
Run-time versions are also available for download at this location.
The Sapera LT SDK installation includes compiled demo and example programs, along with
project source code, in both C++ and .NET languages, for most Microsoft Visual Studio
development platforms. The Sapera LT ++ and Sapera LT .NET demo source code are
found in the Sapera\Demos directory.
Refer to Sapera LT User’s Manual for additional details about Sapera LT.
Teledyne DALSA Device Drivers
All Teledyne DALSA device drivers are available for download from the Teledyne DALSA website:
https://www.teledynedalsa.com/imaging/support/downloads/drivers/
Installation Procedure
Sapera LT is installed before Teledyne DALSA board drivers.
Download the Sapera LT SDK from the Teledyne DALSA website and run the executable file; the
installation menu is presented.
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.
Download the Xtium-CL MX4 device driver from the Teledyne DALSA website and run the
executable file; the installation menu is presented.
During the late stages of the installation, the Xtium-CL MX4 firmware loader application starts.
This is described in detail in the following section.
Reboot when all software and board drivers are installed.
If Windows displays any unexpected message concerning the board, power off
the system and verify the Xtium-CL MX4 is installed in the slot properly. You
should also note the board’s status LED color and compare it to the defined LED
states as described in D1: Boot-up/PCIe Status LED.
18 •Installing Xtium-CL MX4 Xtium-CL MX4 User's Manual
Xtium-CL MX4 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 MX4
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 MX4.
Important:In the rare case of firmware loader errors please see Recovering from a Firmware
Update Error.
Firmware Update: Automatic Mode
Click Automatic to update the Xtium-CL MX4 firmware. The Xtium-CL MX4 supports various
firmware configurations with the default being a Full, Medium, or Base camera.
for details on all supported modes, selected via a manual firmware update.
With multiple Xtium-CL MX4 boards in the system, all are updated with new firmware. If any
installed Xtium-CL MX4 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 MX4 Full board is installed
and ready for a firmware upgrade.
Figure 1: Automatic Firmware Update
Table of contents
