The purpose of this document is to provide a description of the Ximea cameras and to describe the correct way to install related software and drivers and run it successfully. Please read this manual thoroughly before operating your new Ximea cameras for the first time. Please follow all instructions and observe the warnings.
The xiX-Xtreme cameras comply with the requirements of the RoHS (Restriction of Hazardous Substances) Directive 2015/863/EU. WEEE conformity The xiX-Xtreme cameras comply with the requirements of the WEEE (waste electrical and electronic equipment) Directive 2012/19/EU. GenICam GenTL API GenICam standard transport layer interface, grabbing images.
Special sensor features like Dual ADC (HDR mode), short shutter interval time, and others The xiX-Xtreme cameras offer the opportunity to reach the full sensor specifications while still keeping the smallest possible form factor. Our innovative approach separates the sensor head from the readout electronics, facilitating integration into the most confined spaces.
• broadcasting • fast process capture, e.g. golf club swings • Intelligent Transportations Systems (ITS) and traffic monitoring • VR and AR • vinematography • sports • unmanned vehicles • UAV / drones etc XIMEA Technical Manual, Version: v230927...
C on housing, RH 80 % non-condensing, −25 to 60 C storage Operating systems Windows, Linux Ubuntu, macOS Software support xiAPI SDK, adapters and drivers for various image processing libraries Firmware updates field firmware update through xiCOP tool XIMEA Technical Manual, Version: v230927...
& white model Sensor technology Global shutter Vendor of the sensor Sony X4G3: Number of PCIe lanes used, 4 for these cameras PCIe generation, currently at Gen 3 for these cameras FireFly cable connection XIMEA Technical Manual, Version: v230927...
Housing temperature must not exceed 65 Note: The following parameters are not guaranteed if the cameras are operated outside the optimum range: • Dark current • Dynamic Range • Linearity • Acquisition • Readout noise • S/N ratio • Durability XIMEA Technical Manual, Version: v230927...
The maximum difference between the flange focal distance and back focal distance for C-mount lenses must not exceed 6mm. Otherwise, the lens could damage the protective sapphire glass inside the camera or the capability to focus to infinity could be limited. XIMEA Technical Manual, Version: v230927...
Optical path spot deviation from local average Size of the cosmetics defects lines Table 5: optical path Figure 5: xiX-xtreme optical path *FDD is flange focal distance between the front flange surface and the sensor active surface. XIMEA Technical Manual, Version: v230927...
Monochrome None MX203CG-SY-X4G3-FF Sony IMX531 Color BayerBG MX203MG-SY-X4G3-FF Sony IMX531 Monochrome None MX245CG-SY-X4G3-FF Sony IMX530 Color BayerBG MX245MG-SY-X4G3-FF Sony IMX530 Monochrome None Table 6: list of camera models and their respective sensor models and filters XIMEA Technical Manual, Version: v230927...
153.67 112.0 81.74 78.49 56.89 Pwr. consumption 14.6 Pwr. consumption max 14.9 Defined for maximal bandwidth. Minimal exposure and exposure step (Line Period) could be calculated Camera performance calculator Table 7: sensor and camera parameters XIMEA Technical Manual, Version: v230927...
Page 20
528.48 2656 × 1520 560.69 Only for cameras with monochrome sensor type Full res. Dual W/o combination Full res. Dual W combination Only for cameras with color sensor type Table 8: supported standard readout modes XIMEA Technical Manual, Version: v230927...
Page 21
55.58 53.38 36.65 Pwr. consumption 14.6 Pwr. consumption max 14.9 Defined for maximal bandwidth. Minimal exposure and exposure step (Line Period) could be calcu- lated in: Camera performance calculator Table 9: sensor and camera parameters XIMEA Technical Manual, Version: v230927...
Page 22
396.63 2256 × 2256 411.61 Only for cameras with monochrome sensor type Full res. Dual W/o combination Full res. Dual W combination Only for cameras with color sensor type Table 10: supported standard readout modes XIMEA Technical Manual, Version: v230927...
Page 23
54.6 52.4 38.0 Pwr. consumption 14.6 Pwr. consumption max 14.9 Defined for maximal bandwidth. Minimal exposure and exposure step (Line Period) could be cal- culated in: Camera performance calculator Table 11: sensor and camera parameters XIMEA Technical Manual, Version: v230927...
Page 24
365.1 2664 × 2304 387.9 Only for cameras with monochrome sensor type Full res. Dual W/o combination Full res. Dual W combination Only for cameras with color sensor type Table 12: supported standard readout modes XIMEA Technical Manual, Version: v230927...
MX161CG-SY-X4G3-FF, MX161MG-SY-X4G3-FF, MX203CG-SY-X4G3-FF, MX203MG-SY-X4G3-FF, MX245CG-SY- X4G3-FF and MX245MG-SY-X4G3-FF Width [ W ] Height [ H ] Depth [ D ] Mass [ M ] 70 mm 60 mm 55 mm 395 g without adapters Table 13: camera parameters XIMEA Technical Manual, Version: v230927...
PCIe connected (X2 or X1) Gen3 flash flash flash To identify, if the recovery firmware is loaded, please start xiCOP. See XIMEA control panel Table 15: LED output description during camera power up XIMEA Technical Manual, Version: v230927...
PCIe 4 Gen3; Power input; Optoisolated IO Mating connectors: Samtec ECUE, PCUO The interface connector is used for data transmission, camera control, power and IO FireFly connector location Figure 12: position status PCIe FireFly connector XIMEA Technical Manual, Version: v230927...
INOUT1 Non-isolated IO Common pole for non-isolated IO (same as power GND) INOUT2 Non-isolated IO INOUT3 Non-isolated IO Common pole for non-isolated IO (same as power GND) INOUT4 Non-isolated IO Table 20: pinout non-isolated IO XIMEA Technical Manual, Version: v230927...
Trigger - rising or falling edge are supported for trigger Table 21: optically isolated digital input, general info Digital input – Internal schematic The internal scheme of Digital Input signal flow inside the camera is below. Figure 17: digital input, interface schematic XIMEA Technical Manual, Version: v230927...
Following scheme is the internal scheme of the Digital Output signal flow inside the camera. Figure 19: digital output, interface schematic Digital output – Wiring Digital output has an open collector switching transistor with common IO Ground. In most cases a power source for external device must be provided. XIMEA Technical Manual, Version: v230927...
Not energized Figure 20: connecting digital output to a NPN-compatible PLC device input (biased) Note: If using this configuration, take into account that Common Ground connection may be biased by power supply for Digital Input! XIMEA Technical Manual, Version: v230927...
Figure 21: connecting digital output to a NPN-compatible PLC device input - more bidirectional inputs Note: In this case a bidirectional opto-isolated input must be used. Figure 22: connecting digital output to a NPN-compatible PLC device input - single input XIMEA Technical Manual, Version: v230927...
Must be higher than required input amplitude, V input is required input amplitude, Iinput is input driving current (corresponding to input amplitude). Remember to use the appropriate resistor power rating: ) × I P (R) > (V output input XIMEA Technical Manual, Version: v230927...
2.2 V Green 1.9 V 2.5 V Emerald Green 2.1 V 2.7 V Blue 2.5 V 3.7 V White 2.8 V 3.8 V Infra-Red 1.3 V 1.8 V Opto coupler Table 23: digital output, LED driving XIMEA Technical Manual, Version: v230927...
Keep in mind that this connection has an inverted logic. Current will flow through the load at the start of the camera. Figure 25: inductive load (Relay) driving (inverted logic) For positive logic you can use a second bipolar transistor. Figure 26: inductive load (Relay) driving (non-inverted logic) XIMEA Technical Manual, Version: v230927...
Non isolated Digital lines can be used as inputs or outputs compatible with TTL logic. These are high impedance pins so when used as output high impedance slave input has to be used. Figure 27: non isolated input/output, interface schematic XIMEA Technical Manual, Version: v230927...
MX X4G3 cameras can be connected to host via cable with FireFly connector. The EMI/EMC performance should be evaluated by customer. For connecting to different host via vast range of adapters. Please see website Cameras Adapters XIMEA Technical Manual, Version: v230927...
Figure 32: mounting fan cooling element CB-X8G3-FAN-COOLER Width [ W ] Height [ H ] Depth [ D ] Mass [ M ] 60 mm 70 mm 17 mm 20 g Table 27: mechanical parameters XIMEA Technical Manual, Version: v230927...
Figure 34: MECH-60MM-BRACKET-T Figure 35: MECH-60MM-BRACKET-T drawing Width [ W ] Height [ H ] Depth [ D ] Mass [ M ] 54 mm 20 mm 40 mm 20 g Table 28: parameters of MECH-60MM-BRACKET-T XIMEA Technical Manual, Version: v230927...
Brackets are delivered as kit with respective screws. There are two variants. Standard MQ-BRACKET-T-KIT with height of 5.5 mm and thick MQ-BRACKET-T-THICK-KIT for use with lenses with diameter > 37 mm37 Figure 37: MQ-BRACKET-T dimensional drawing Figure 38: MQ-BRACKET-T thick dimensional drawing XIMEA Technical Manual, Version: v230927...
2.12.9 ADPT-MX-X4G3-FF-X4G3-MTP Back part attachment to connect XIMEA Firefly cameras to MTP cable. Converts 1x PCIe Gen3 x4 camera. The camera adapter also offers power and IO connectors for synchronization and triggering. Figure 39: ADPT-MX-X4G3-FF-X4G3-MTP dimensional drawing XIMEA Technical Manual, Version: v230927...
2.12.11 FireFly MTP adapters Adapter to connect XIMEA FireFly cameras to MTP cable. The camera/s should be connected to these adapters over a FireFly ECUE copper cable (e.g. 10 cm - 3 m). The adapter has an integrated PCUI module, which allows connection to PC over optical MTP cable (e.g. 10 m). Adapters contain also connectors for power and GPI/GPO from the camera.
Supports PCIe Gen3 x4 lines and requires PCIe Gen.3 x8 slot on the computer side. Bandwidth of 32 Gbps. Cable lengths of up to 100 m. HA-1P-X4G3-MTP-X8G3 / HA-2P-X4G3-MTP-X8G3 PCIe MTP Gen3 x4 Host Adapter - single or dual port for MTP fiber optic cables. Figure 50: dimensions of host adapter HA-1P-X4G3-MTP-X8G3 XIMEA Technical Manual, Version: v230927...
When decimation is chosen, only every n-th pixel is used to create the output image. For example, with a 2x1 vertical skipping, every odd number line is used and every even number line is skipped, resulting in an image with half its original vertical resolution. Skipping is a faster downsampling mode, but also introduces more aliasing effects. XIMEA Technical Manual, Version: v230927...
When using Transport Data Format, the Image Processing block from XiAPI Image Data Flow is skipped and therefore the Transport format is the most effective data format in terms of CPU and RAM usage. Table 31: image formats XIMEA Technical Manual, Version: v230927...
A hardware trigger can be sent to the sensor using the digital input described in Optically isolated digital input Triggering by hardware is usually used to reduce latencies and jitter in applications that require the most accurate timing. XIMEA Technical Manual, Version: v230927...
) the following applies. The next trigger after one is processed needs to be applied so the end of the tper triggered exposure does not overlap with the readout of the previous frame. > max(t f ot XIMEA Technical Manual, Version: v230927...
The gain value influences the analog-to-digital conversion process of the image sensor pipeline and acts as a multiplier of the output signal. Using gain values greater than 0 will increase the pixel intensities but may also increase the overall noise level. For some camera models the gain can be set in discrete steps only. XIMEA Technical Manual, Version: v230927...
// Set gain to arbitrary value xiSetParamFloat(xiH, XI_PRM_GAIN, 0); // Set gain ratio to arbitrary value // depending on the gain value the range can be from 0--24 dB // with 6 dB increment xiSetParamFloat(xiH, XI_PRM_DUAL_ADC_GAIN_RATIO, 12); XIMEA Technical Manual, Version: v230927...
// or use any other formats to other to deliver merged from HG and xiSetParamInt(xiH, XI_PRM_IMAGE_DATA_FORMAT,XI_RAW16); // Set ADC bitdepth to desired value xiSetParamInt(xiH, XI_PRM_SENSOR_DATA_BIT_DEPTH,12); // Set image data bitdepth to desired value xiSetParamInt(xiH, XI_PRM_IMAGE_DATA_BIT_DEPTH,16); XIMEA Technical Manual, Version: v230927...
// Set up the start and gain (Slope C) of compression region 1 xiSetParamInt(xiH, XI_PRM_COMPRESSION_REGION_SELECTOR,1); xiSetParamFloat(xiH, XI_PRM_COMPRESSION_REGION_START,12.5); xiSetParamFloat(xiH, XI_PRM_COMPRESSION_REGION_GAIN,-12); // Set up the start and gain (Slope D) of compression region 2 xiSetParamInt(xiH, XI_PRM_COMPRESSION_REGION_SELECTOR,2); xiSetParamFloat(xiH, XI_PRM_COMPRESSION_REGION_START,50); xiSetParamFloat(xiH, XI_PRM_COMPRESSION_REGION_GAIN,-24); XIMEA Technical Manual, Version: v230927...
This list is then used for the correction of acquired images during operation. The correction is inactive by default, but can be turned on by the user if a non-processed output is required. XIMEA Technical Manual, Version: v230927...
• MacOS 10.8 or newer All XIMEA cameras are compatible with the most advanced Vision and Image Processing Libraries. See chapter XIMEA Software Packages for more information about the options to access cameras, as well as a list of currently supported libraries and frameworks supported in Windows.
XIMEA API Software Package can be installed on: Microsoft Windows 10, 11. Contents The package contains: • OS Drivers of all XIMEA camera types for OS Microsoft Windows, Windows Server 2008 R2 x86-64, Windows 10 32/64 bit • APIs (xiAPI, xiAPI.NET, xiApiPython •...
Page 71
Select the Software components you want to install. You can uncheck the components you don’t want to install, but it is recommended to leave them all checked • Specify the install location - you can leave the default location or change it to your desired location XIMEA Technical Manual, Version: v230927...
Page 72
• Now the XIMEA API Software Package should start copying files, updating System Variables and installing drivers if necessary • Installation is completed • Finish XIMEA Technical Manual, Version: v230927...
4.2.2 XIMEA Linux software package XIMEA Linux Software Package is tarred installer with files that can be run on Linux Ubuntu 14.04 and 16.04 (32 and 64 Bit) and newer releases. Contents The package contains: • Driver for XIMEA USB2 and USB3 cameras •...
Page 74
• Start installation script ./install Note: If logged in user is not root, you will be asked for your password to get root access, because the installation runs with root account using sudo. XIMEA Technical Manual, Version: v230927...
Installation Before installing XIMEA macOS Software Package it may be necessary to modify security settings on your computer. The new feature of OS X 10.8 called GateKeeper can prevent you from using our macOS Software Package due to the fact that the current version is unsigned.
Page 76
• Download XIMEA macOS Software: rhttp://www.ximea.com/downloads/recent/XIMEA_OSX_SP.dmg • Mount it by double-clicking this file in Finde • Run the install script to install XiAPI on your macOS system • A window with package contents will open XIMEA Technical Manual, Version: v230927...
Page 77
Short description The CamTool is a cross-platform application showcasing the features of all XIMEA camera families. It runs on Windows, Linux, macOS systems offering a substantial imaging tool set, which can be further extended with custom modules using a plugin infrastructure. CamTool is based on Qt for the UI and xiAPI for the camera control.
Description Control panel Image window Analytics tools Proccessing chain Camera control Functions • To see live image from multiple XIMEA cameras connected • Control the camera parameters • Store of camera image and video • Analyze the image properties •...
Suggests solution for diagnosed issues • Allows setting of User IDs to XIMEA cameras • One click to switch selected XIMEA cameras to USB3 Vision standard and back to XIMEA API • One click update to the latest XIMEA API Software Package •...
Supported vision libraries All XIMEA cameras are compatible with the most advanced vision and image processing libraries. For GUI based software packages, the cameras can be directly accessed without the need of programming. Code libraries are generally used in conjunction with one of our APIs, in order to add additional functionality (e.g.
On Windows: xiAPI is compiled into xiapi32.dll or xiapi64.dll • On Linux: xiAPI is compiled into /usr/lib/libm3api.so Installation xiAPI is part of all current XIMEA software packages for Windows, Linux and MacOS. For information on the software packages, see XIMEA Software Packages.
Page 82
(e.g. 106 - Parameter not supported). Note: Since xiAPI is a unified programming interface for all of XIMEA‘s cameras, not all of the described parameters apply for every camera and sensor model.
XI_PRM_GPI_MODE, XI_GPI_TRIGGER) // set digital output 1 mode xiSetParamInt(xiH, XI_PRM_GPO_SELECTOR, 1); xiSetParamInt(xiH, XI_PRM_GPO_MODE, XI_GPO_EXPOSURE_ACTIVE); xiStartAcquisition(handle1); // Trigger signal should start image exposure within timeout #define TIMEOUT_IMAGE_WAITING_MS 10000 xiGetImage(handle, TIMEOUT_IMAGE_WAITING_MS, &image); // process image here… XIMEA Technical Manual, Version: v230927...
Page 84
To disable ABC, the application should set parameter XI_PRM_AUTO_BANDWIDTH_CALCULATION to XI_OFF before the first xiOpenDevice is used. This setting disabled ABC and the camera stream is not limited. xiAPI.NET XIMEA Application Programming Interface for Dot Net - Microsoft Visual C#. xiAPI.NET is designed as a wrapper around xiAPI and therefore shares most of its functionality.
XIMEA xiCOP software (please see section 4.4). It will immediately start searching for connected cameras. Your camera will appear in the XIMEA camera list on the upper left side of the xiCOP window if it is connected properly and your USB interface meets the minimum system requirements described in section 4.1.
Step 5 – Waiting for service conclusion Once we have received the camera, we will send you a notification. The XIMEA Service will then check the status of the camera that you have sent for a possible repair. Depending on warranty conditions, product status and agreement one of the following operations will be...
High-energy laser light hitting the sensor directly • Bright light sources hitting the sensor directly (burn-in) • Camera is exposed to X-rays The warranty does not cover damaged cameras caused by X-ray applications or very high intensity light / laser light. XIMEA Technical Manual, Version: v230927...
• Always use clean boards. • To protect the boards from dirt like dust or liquids always use the board level cameras in clean room environment or use a protective housing. XIMEA Technical Manual, Version: v230927...
XIMEA warrants to the Original Purchaser that the Camera provided is guaranteed to be free from material and manufacturing defects for a period of two years. Should a unit fail during this period, XIMEA will, at its option, repair or replace the damaged unit. Repaired or replaced Products are covered for the remainder of the original Product warranty period.
Standard Terms & Conditions of XIMEA GmbH Printed here for your information is the version from May 2021. Please check the most current version at XIMEA General Terms and Conditions General Conditions for the Supply of Products and Services of the Electrical and Electronics Industry (“Grüne Lieferbedingungen” – GL)* for commercial transactions between businesses recommended by ZVEI-Zentralverband Elektrotechnik- und Elektronikindustrie e.
Page 91
Purchaser based on statute is limited to cases where the Supplier is responsible for the delay. The above provisions do not imply a change in the burden of proof to the detriment of the Purchaser. XIMEA Technical Manual, Version: v230927...
Page 92
The same consequences as upon acceptance arise if and when the Purchaser lets the two-week period expire or the Supplies are put to use after completion of agreed test phases, if any. Article VII: Receiving Supplies The Purchaser shall not refuse to receive Supplies due to minor defects. XIMEA Technical Manual, Version: v230927...
Page 93
Supplier. The above provisions do not imply a change in the burden of proof to the detriment of the Purchaser. Any other or additional claims of the Purchaser exceeding the claims provided for in this Article VIII, based on a Defect, are excluded. XIMEA Technical Manual, Version: v230927...
Page 94
1. Unless otherwise provided for in the present GL, the Purchaser has no claim for damages based on whatever legal reason, including infringement of duties arising in connection with the contract or tort. 2. This does not apply if liability is based on: XIMEA Technical Manual, Version: v230927...
Page 95
The legal invalidity of one or more provisions of this Agreement in no way affects the validity of the remaining provisions. This shall not apply if it would be unreasonably onerous for one of the parties to be obligated to continue the contract. XIMEA Technical Manual, Version: v230927...
List of Trademarks XIMEA, xiC, xiQ, xiMU, xiB, xiB-64, xiX, xiX-XL, xiX-Xtreme, xSWITCH, xPLATFORM, xEC, xEC2, xiCool, xiRAY, xiCe, xiSpec, xiFLY, xiD, xiJ, xiLAB, xiAPI, xiCamTool, xiCOP and CURRERA are trademarks or registered trademarks of XIMEA GmbH in Germany, Slovakia, USA and other countries.
Printed Circuit Board (same as PWB) PRNU Photo Response Non-Uniformity 12, 14, Product Service Request v, Region Of Interest Software Development Kit Signal to Noise (Ratio) 12, 14, To Be Determined – some parameters require further characterization ii, 10, XIMEA Technical Manual, Version: v230927...