Page 2
WITHOUT LIMITATION, MERCHANTABILITY, SATISFACTORY QUALITY, OR FITNESS FOR A PARTICULAR PURPOSE. THE USE OF THE PRODUCT BY YOU IS AT YOUR OWN RISK. IN NO EVENT WILL HIKROBOT BE LIABLE TO YOU FOR ANY SPECIAL, CONSEQUENTIAL, INCIDENTAL, OR INDIRECT DAMAGES,...
Page 3
TO ANY NUCLEAR EXPLOSIVE OR UNSAFE NUCLEAR FUEL-CYCLE, OR IN SUPPORT OF HUMAN RIGHTS ABUSES. THE PERFORMANCE DATA IN THIS PUBLICATION IS BASED ON HIKROBOT'S INTERNAL RESEARCH/EVALUATION. ACTUAL DATA MAY VARY DEPENDING ON SPECIFIC CONFIGURATIONS AND OPERATING CONDITIONS AND HIKROBOT SHALL NOT BEAR THE CONSEQUENCES ARISING THEREFROM.
Page 4
Indicates a hazard with a high level of risk, which if not avoided, will result in death or serious injury. Available Model This manual is applicable to the CoaXPress area scan camera. Safety Instructions These instructions are intended to ensure that the user can use the device correctly to avoid danger or property loss.
Page 5
CoaXPress Area Scan Camera User Manual · The device should be used in compliance with local laws, electrical safety regulations, and fire prevention regulations. Power Supply When wiring or dismounting, make sure that the device power is cut off, and do not operate under electrification.
Page 6
CoaXPress Area Scan Camera User Manual · human body may damage electrostatic sensitive components on circuit boards. When touching electrostatic sensitive components or devices, proper grounding measures must be taken. Put electrostatic sensitive components into anti-static bags for protection.
3.1 Interface Description ......................5 3.2 Indicator Description ......................6 3.2.1 Camera Indicator Status .................... 6 3.2.2 CoaXPress Linking Indicator Status ................6 Chapter 4 Installation ......................... 8 4.1 Installation Preparation ...................... 8 4.2 Install Camera and Connect Frame Grabber ..............8 Chapter 5 Camera Settings via Frame Grabber Client Software ..........
Page 8
CoaXPress Area Scan Camera User Manual · 7.5.1 Set Burst Frame Count .................... 25 7.5.2 Set Trigger Delay ..................... 25 7.5.3 Set Trigger Cache Enable ..................26 7.5.4 Set Trigger Activation ....................27 7.5.5 Set Trigger Debouncer ..................... 28 Chapter 8 I/O Output ....................... 30 8.1 Select Output Signal ......................
Page 9
11.1 Device Control ........................ 65 11.2 Save and Load User Set ....................67 11.3 Transport Layer Control ....................68 11.4 CoaXPress Parameters ....................69 11.5 Update Firmware ......................71 Chapter 12 FAQ ........................72 12.1 Why the client software is stuck when listing cameras? ..........72 12.2 Why the client software turns to the blue screen? ............
· Chapter 1 Overview 1.1 Introduction The CoaXPress (CXP) area scan camera uses CoaXPress interface to transmit non-compressed images in real time, and it acquires images and sets parameters via client software or SDK based on CoaXPress frame grabber. 1.2 Key Feature ...
CoaXPress Area Scan Camera User Manual · Chapter 2 Appearance TEC stands for Thermo-Electric Cooler that is able to keep the camera's sensor temperature around environment temperature to ensure the normal operation of the camera. For specific appearance and dimension, please refer to the camera's specification for details.
Page 12
CoaXPress Area Scan Camera User Manual · Figure 2-4 Appearance (Type IV) Figure 2-5 Appearance (Type V) Figure 2-6 Appearance (Type VI) Table 2-1 Component Description Interface Description It is used to install lens. Refer to the camera’s specification for Lens Mount details.
Page 13
Hirose Connector) input/output signal, etc. CoaXPress Interface It refers to the 4 CoaXPress interfaces for transmitting data. ● For type I, II, IV, V and VI cameras, they uses fan to cool. Fan or TEC ● For type III camera, it uses TEC (inside the camera) to cool.
CoaXPress Area Scan Camera User Manual · Chapter 3 Interface and Indicator 3.1 Interface Description For different models of cameras, they all have a 12-pin Hirose connector, and pin definitions are as follows. Figure 3-1 12-Pin Hirose Connector You should refer to the table below and the label attached to the power and I/O cable to wire the device.
3.2.2 CoaXPress Linking Indicator Status The CoaXPress linking indicator is used to display CoaXPress linking connection status via CoaXPress cable. For type III and type IV cameras, refer to the Table 3-3 for the status of CoaXPress linking indicator. When the indicator is flashing rapidly, flashing slowly, or flashing very slowly, its unlit interval is 0.08 s, 1 s, and 2 s respectively.
Page 16
Slow flashing green The camera is acquiring images in trigger mode. For type V and type VI cameras, refer to the Table 3-4 for the status of CoaXPress linking indicator. Table 3-4 CoaXPress Linking Indicator (Type V and Type VI Cameras)
Make sure all the related equipment is powered off during the installation. The camera has 4 CoaXPress interfaces, and it can transmit data via 1, 2 or 4 interface(s). If you need to use 1 interface, the corresponding interface number is CXP 1. If 2 interfaces are required, the corresponding interface number is CXP 1 and CXP 2.
Page 18
1. Fix the camera to the installation position. 2. Install the lens to the camera body. 3. Connect the camera to CoaXPress frame grabber via CoaXPress cable. 4. Connect the camera to a suitable power adapter via 12-pin power and I/O cable.
The CoaXPress frame grabber client software is used to connect camera, acquire image data, set camera parameters, etc. Here we take KAYA CoaXPress frame grabber client software as an example. For other frame grabber client software, please refer to the user manual of frame grabber client software you use for details.
· 5.2 Create or Open Project In KAYA CoaXPress frame grabber client software, you are required to set and save camera parameters in project file. For first time use, you need to create new project. Once you have saved camera parameters in project file, you can open existing project to load local project file.
Page 21
CoaXPress Area Scan Camera User Manual · Figure 5-3 Main Window Table 5-1 Description of the Main Window Name Description The menu bar displays function modules, including File, Menu Bar Device Control, View, Window, Help, and About. The control toolbar provides project operation buttons, Control Toolbar hardware selection and stream acquisition control buttons.
Page 22
You can set the parameters of transport layer of the camera. You can save or load the camera's parameters. You can set the User Set Control default parameter when running the frame grabber client software. CoaXPress You can set CoaXPress related parameters.
CoaXPress Area Scan Camera User Manual · Chapter 6 Camera Features 6.1 Global Shutter For camera that supports global shutter, its exposure starts and ends in each line simultaneously. After the exposure, data readout starts line by line. All pixels expose at the same time, then readout at different time.
CoaXPress Area Scan Camera User Manual · For camera that supports rolling shutter, it has global reset function. The global reset function allows all rows start integrating at the same time to eliminate the image distortion. Figure 6-3 Global Reset You can go to Acquisition Control >...
Page 25
CoaXPress Area Scan Camera User Manual · Overlap Exposure under Internal Trigger Mode Exposure 1 Exposure 2 Exposure 3 Sensor exposure Frame 1 Frame 2 Readout Readout Figure 6-5 Internal Trigger Overlap Exposure Overlap Exposure under External Trigger Mode...
Acquisition Frame Rate Control Enable. Figure 7-1 Set Frame Rate Here we take KAYA CoaXPress frame grabber client software as an example. For specific graphical user interface, refer to the actual interface you use. True stands for enabling Acquisition Frame Rate Control Enable and false stands for disabling.
CoaXPress Area Scan Camera User Manual · You can also click Acquisition Control > Resulting Frame Rate to view the camera’s resulting frame rate. Figure 7-2 View Resulting Frame Rate 7.2 Set Acquisition Mode The camera has 2 types of acquisition modes, including SingleFrame mode and Continuous mode.
Principle Source Software Trigger Acquisition Control > Software The software sends trigger signal Trigger Selector > to the camera via CoaXPress Trigger Source interface to acquire images. Hardware Trigger Acquisition Control > Line 0, Line 2 External device connects camera Trigger Selector >...
Click Trigger Selector > Trigger Source, and select Trigger Source according to actual demands. Figure 7-5 Select Trigger Source The figure above is the graphical user interface from Matrox CoaXPress frame grabber client software. 7.4.2 Set Software Trigger Steps: 1.
CoaXPress Area Scan Camera User Manual · Figure 7-6 Set Software Trigger 7.4.3 Set Hardware Trigger The camera has 1 opto-isolated input (Line 0), and 1 bi-directional I/O (Line 2) that can be configured as input signal. Click Digital IO Control, select Line 2 as Line Selector, and Input as Line Mode to set line 2 as input signal.
Page 31
CoaXPress Area Scan Camera User Manual · Figure 7-9 Set Counter Trigger When using counter trigger, you need to set relevant parameters of Counter And Timer Control. Table 7-2 Description of Counter And Timer Control Parameter Read/Write Description Counter Selector Read and write It selects counter source.
For different models of camera, the counter trigger function may differ, and the actual device you purchased shall prevail. 7.4.5 Set Link Trigger The camera supports trigger via CoaXPress frame grabber, and you can set related parameters as follows. Steps: 1.
User Manual · Figure 7-12 Set Free Trigger The figure above is the graphical user interface from Matrox CoaXPress frame grabber client software. 7.5 Trigger Related Parameters Under external trigger mode, you can set burst frame count, trigger delay, trigger cache enable, trigger activation and trigger debouncer.
CoaXPress Area Scan Camera User Manual · 7.5.1 Set Burst Frame Count Under external trigger mode, you can set burst frame count. Click Acquisition Control > Acquisition Burst Frame Count, enter Acquisition Burst Frame Count, and its range is from 1 to 1023.
CoaXPress Area Scan Camera User Manual · You can set Trigger Delay according to actual demands, and its range is from 0 μs to 16000000 μs. Figure 7-16 Set Trigger Delay 7.5.3 Set Trigger Cache Enable The camera has the function of Trigger Cache Enable. During the triggering process, if the camera receives new trigger signal, it will save and process the signal if you enable this function.
CoaXPress Area Scan Camera User Manual · 7.5.4 Set Trigger Activation The camera supports trigger acquisition in the rising edge, falling edge, level high, or level low of the external signal. The principle and parameter of trigger activation are as follows.
User Manual · Figure 7-18 Set Trigger Activation The figure above is the graphical user interface from Matrox CoaXPress frame grabber client software. 7.5.5 Set Trigger Debouncer The external trigger input signal of the camera may have signal bounce that may cause false trigger.
Page 38
CoaXPress Area Scan Camera User Manual · Figure 7-20 Set Trigger Debouncer...
CoaXPress Area Scan Camera User Manual · Chapter 8 I/O Output 8.1 Select Output Signal The camera has 1 opto-isolated output (Line 1), and 1 bi-directional I/O (Line 2) that can be configured as output signal. Here we take Line 2 as an example to introduce how to select output signal. You select Line 1 or Line 2 as line selector according to actual demands.
CoaXPress Area Scan Camera User Manual · 8.2.2 Enable Strobe Signal The strobe signal is used to directly output I/O signal to external devices when camera’s event source occurs. Click Digital IO Control, set ExposureActive as Line Source, and check Strobe Enable to enable it.
Page 41
CoaXPress Area Scan Camera User Manual · Name Description Count Active It refers to output one I/O edge signal when counter output is enabled. Timer Active It refers to output one I/O edge signal when timer output is enabled. Regarding strobe signal, you can also set its duration, delay and pre-delay.
Page 42
CoaXPress Area Scan Camera User Manual · Figure 8-5 Set Strobe Line Delay The sequence diagram of strobe line delay is shown below. Trigger_in 3 Trigger_in 2 Trigger_in 1 Trigger Trigger Trigger delay delay delay Strobe delay Duration Strobe Exposure...
Page 43
CoaXPress Area Scan Camera User Manual · Figure 8-7 Set Strobe Line Pre Delay The sequence diagram of strobe line pre delay is shown below. Trigger_in 3 Trigger_in 2 Trigger_in 1 Trigger Trigger Trigger delay delay delay Duration Strobe Exposure...
CoaXPress Area Scan Camera User Manual · Chapter 9 I/O Electrical Feature and Wiring 9.1 I/O Electrical Feature 9.1.1 Line 0 Opto-isolated Input Circuit The Line 0 opto-isolated input circuit in camera I/O control is shown below. Figure 9-1 Line 0 Internal Circuit The maximum input current of Line 0 is 25 mA.
CoaXPress Area Scan Camera User Manual · Table 9-1 Input Electrical Feature Parameter Name Parameter Symbol Value Input Logic Level Low 0 VDC to 1 VDC Input Logic Level High VH 1.5 VDC to 24 VDC Input Rising Delay 1.8 μs to 4.6 μs Input Falling Delay 16.8 μs to 22 μs...
CoaXPress Area Scan Camera User Manual · When the external voltage is 3.3 VDC and the external resistance is 1 K, opto-isolated output electric feature is shown in below Table 9-2 Output Electric Feature Parameter Name Parameter Symbol Value Output Logic Level Low...
Page 47
CoaXPress Area Scan Camera User Manual · Line 2 Figure 9-5 Line 2 Bi-direction I/O Circuit Line 2 Configured as Input With the condition of 100 Ω and 5 VDC, the logic level and electrical feature of configuring Line 2 as output are shown below.
Page 48
CoaXPress Area Scan Camera User Manual · To prevent damage to GPIO pin, please connect GND first and then input voltage in Line 2 pin. Line 2 Configured as Output The maximum current is 25 mA and the output impedance is 40 Ω.
CoaXPress Area Scan Camera User Manual · Table 9-6 Electrical Feature of Line 2 Output Parameter Name Parameter Symbol Value Output Rising Time 0.06 μs Output Falling Time 0.016 μs Output Rising Delay 0 μs to 4μs Output Falling Delay <...
Page 50
CoaXPress Area Scan Camera User Manual · Camera Power Device Power Supply Supply Signal Line PNP Device Opto Input Opto Signal Device Power Ground Ground Camera Power Ground GND of VCC GND of PWR Figure 9-9 Line 0 Connecting to PNP Device ...
CoaXPress Area Scan Camera User Manual · 9.2.2 Line 1 Wiring When the camera uses Line 1 as output signal, wirings are different with different external devices. PNP Device Camera Device Power Power Supply Supply PNP Device Opto Output...
Page 52
CoaXPress Area Scan Camera User Manual · Camera Power Device Power Supply Supply Bi-direction PNP Device Signal Line Camera Power Device Power Ground Ground GND of PWR and Figure 9-14 Line 2 Connecting to PNP Device as Input NPN Device If the VCC of NPN device is 24 VDC, and it is recommended to use 1 KΩ...
Page 53
CoaXPress Area Scan Camera User Manual · Line 2 Configured as Output When the camera uses Line 2 as output signal, wirings are different with different external devices. PNP Device Camera Power Device Power Supply Supply Bi-direction PNP Device...
CoaXPress Area Scan Camera User Manual · Chapter 10 Image Parameter 10.1 View Resolution Click Image Format Control, and view Width Max and Height Max. Width Max stands for the max. pixels per inch in width direction and Height Max stands for the max. pixels per inch in height direction.
CoaXPress Area Scan Camera User Manual · Figure 10-2 Set ROI The Width value plus Offset X value should not be larger than Width Max parameter value, Height value plus Offset Y value should not be larger than Height Max parameter value ...
CoaXPress Area Scan Camera User Manual · Figure 10-4 Image Reverse Comparison 10.4 Set Pixel Format The pixel format may differ by camera models. The relation among ADC bit depth, pixel format and pixel size is shown below. Click Image Format Control >...
CoaXPress Area Scan Camera User Manual · 10.5 Set Test Pattern The test pattern may differ by camera models. The camera supports test pattern function. When there is exception in real-time image, you can check whether image of test mode have similar problem to determine the reason. This function is disabled by default, and at this point, the outputted image by the camera is real-time image.
Page 58
CoaXPress Area Scan Camera User Manual · Figure 10-7 Checkboard Test Pattern Figure 10-8 Oblique Mono Bar Test Pattern Figure 10-9 Gradual Mono Bar Test Pattern...
CoaXPress Area Scan Camera User Manual · Figure 10-10 Vertical Color Bar Test Pattern Figure 10-11 Horizontal Color Bar Test Pattern Figure 10-12 Test Image 1 The pattern of the test image 1 may differ by camera models, and refer to the actual one you got.
Click Image Format Control, and set Decimation Horizontal and Decimation Vertical according to actual demands. Figure 10-14 Set Decimation The figure above is the graphical user interface from Matrox CoaXPress frame grabber client software. 10.8 Set Exposure Time Mode The camera supports exposure function, and exposure includes Ultrashort mode and Standard mode.
CoaXPress Area Scan Camera User Manual · Click Acquisition Control > Exposure Time Mode, and set UltraShort as Exposure Time Mode. Figure 10-15 Set Ultrashort Exposure Mode If the camera you got does not support Ultrashort exposure mode, and then there is no Exposure Time Mode parameter, and your camera supports Standard mode only by default.
CoaXPress Area Scan Camera User Manual · When the exposure auto is set as Once or Continuous, the exposure time should be within the range of Auto Exposure Time Lower Limit and Auto Exposure Time Upper Limit. Figure 10-16 Set Exposure Time under Once or Continuous Mode If the camera is under Continuous exposure method, and once external trigger mode is enabled, the camera will automatically switch to Off exposure method.
CoaXPress Area Scan Camera User Manual · Table 10-3 Analog Gain Mode and Principle Analog Gain Mode Parameter Parameter Value Principle Analog Control > The camera adjusts analog Gain Auto gain according to the value configured by user in Gain.
CoaXPress Area Scan Camera User Manual · Click Analog Control > Digital Shift Enable, check Digital Shift Enable to enable it, and enter proper value in Digital Shift according to actual demands. Figure 10-19 Set Digital Gain The digital gain function is disabled by default, and its range is from -6 dB to 6 dB.
CoaXPress Area Scan Camera User Manual · 10.12 Set Brightness The camera brightness refers to the brightness when the camera adjusts image under Once or Continuous exposure mode, or Once or Continuous gain mode. You should enable Once or Continuous exposure mode, or Once or Continuous gain mode first before setting brightness.
CoaXPress Area Scan Camera User Manual · For different models of camera, the black level range may be different, please refer to the actual one you got. 10.14 Set White Balance White balance is only available for color cameras. The white balance refers to the camera color adjustment depending on different light sources.
CoaXPress Area Scan Camera User Manual · Steps: 1. Select Off as Balance White Auto. At this time, Balance Ratio is 1024. 2. Find corresponding R/G/B channel in Balance Ratio Selector. Here we take Green as an example. 3. Find camera’s R/G/B value.
Page 68
CoaXPress Area Scan Camera User Manual · Steps: 1. Click Analog Control > Gamma Selector. 2. Select User as Gamma Selector. 3. Check Gamma Enable to enable it. 4. Enter proper value in Gamma according to actual demands, and its range is from 0 to 4.
CoaXPress Area Scan Camera User Manual · 10.16 Set Sharpness The camera supports sharpness function that can adjust the sharpness level of the image edge, You can set sharpness as shown below. Click Analog Control > Sharpness Enable, check Sharpness Enable to enable it, and enter proper value in Sharpness according to actual demands, and its range is from 0 to 100.
CoaXPress Area Scan Camera User Manual · The AOI function is available only when the camera’s exposure mode is set as Once or Continuous. For different models of camera, the AOI function may differ, and the actual device you purchased shall prevail.
CoaXPress Area Scan Camera User Manual · 10.20 Set Saturation Saturation is only available for color cameras. Adjusting the saturation changes the colorfulness of the colors. A higher saturation, for example, makes colors easier to distinguish. Click Color Transformation Control, check Color Transformation Enable, check Saturation Enable, and enter Saturation according to actual demands.
CoaXPress Area Scan Camera User Manual · 10.22 Set Shading Correction The camera supports shading correction function that improves the image uniformity when you acquire a non-uniformity image due to external conditions. The shading correction type includes LSC correction, FFC correction, NUC correction, FPNC correction, and PRNUC correction.
Page 73
CoaXPress Area Scan Camera User Manual · Figure 10-34 Set FCC Correction Other Corrections Other corrections include NUC, FPNC, and PRNUC correction. You can go to Shading Correction to set them. Click Shading Correction, enable NUC Enable, and FPNC Enable and PRNUC Enable will be enabled...
Device User ID Read and write your preference. Device Revision Read only It is CoaXPress protocol version. Device Manifest Size Read only It is the quantity of GenlCam XML in the camera. Device Manifest Selector Read and write It is the current ID of GenlCam XML.
Page 75
CoaXPress Area Scan Camera User Manual · Parameter Read/Write Description It is the period of time when device is powered Device Uptime (s) Read only Board Device Type Read only It is the device type. TEC Enable Read and write Check it to enable TEC function.
CoaXPress Area Scan Camera User Manual · Parameter Read/Write Description Device Reset Write only Click Execute to reset the device. 11.2 Save and Load User Set The camera supports 4 sets of parameters, including 1 default set and 3 user sets. The relation among 4 sets of parameters is shown below.
CoaXPress Area Scan Camera User Manual · Figure 11-3 Load User Set Loading parameters is available when connecting with camera, but without live view. Set User Default You can also set default parameter by selecting parameter from drop-down list of User Set Default, as shown below.
For different models of camera, the specific transport layer control parameters mentioned above may differ, please refer to the actual one you got. 11.4 CoaXPress Parameters You can go to CoaXPress attribute to set CoaXPress related parameters. Figure 11-6 CoaXPress Parameters Table 11-3 CoaXPress Parameter Description...
Page 79
CoaXPress Area Scan Camera User Manual · Parameter Read/Write Description It is the max. value of single control Control Packet Max Size Read only data package. Read, and write is available when the It is the max. value of single image...
CoaXPress Area Scan Camera User Manual · Figure 11-7 Set Link Configuration Mode 11.5 Update Firmware The camera supports updating firmware by using USB data cable. Steps: 1. Power on the camera, and connect the camera to the PC via USB data cable.
CoaXPress Area Scan Camera User Manual · Chapter 12 FAQ 12.1 Why the client software is stuck when listing cameras? Reason ● The camera is not connected correctly. ● The frame grabber is not installed firmly. Solution ● Check the wiring between the camera and the frame grabber.
CoaXPress Area Scan Camera User Manual · Solution When the change value of frame rate is larger than 0.5, the frame rate will update. 12.5 Why the live view image in the client software is abnormal? Reason The camera or frame grabber exception occurs.
CoaXPress Area Scan Camera User Manual · Appendix A Camera Parameter Index Table Appendix A-1 Camera Parameter Index Attribute Parameter Section Device Control Device Scan Type Section Device Control Device Vendor Name Device Model Name Manufacturer Info. Device Version Device Firmware Version...
Page 85
CoaXPress Area Scan Camera User Manual · Image Format Control Width Max Section View Resolution & Set ROI Height Max Region Selector Width Height Offset X Offset Y Reverse X Section Set Image Reverse Reverse Y ADC Bit Depth Section Set Pixel...
Page 86
CoaXPress Area Scan Camera User Manual · Trigger Selector Section External Trigger Mode Trigger Mode Trigger Software Trigger Source Trigger Activation Trigger Delay (µs) Trigger Cache Enable Sensor Shutter Mode Section Rolling Shutter Section Set Exposure Exposure Mode Time Mode &...
Page 87
CoaXPress Area Scan Camera User Manual · Balance White Auto Section Set White Balance AWB Color Temperature Mode Balance Ratio Selector Balance Ratio Section Set Gamma Gamma Correction Gamma Selector Gamma Enable Sharpness Section Set Sharpness Sharpness Enable Auto Function AOI Selector...
Page 88
CoaXPress Area Scan Camera User Manual · Shading Correction Shading Selector Section Set Shading Correction Activate Shading FFC Enable PRNUC Enable LSC Enable Counter And Timer Counter Selector Section Set Counter Control Trigger Counter Event Source Counter Reset Source Counter Reset...
Page 89
CoaXPress Area Scan Camera User Manual · User Set Control User Set Current Section Save and Load User Set User Set Selector User Set Load User Set Save User Set Default CoaXPress Device Connection ID Section CoaXPress Parameters Master Host Connection ID...
Need help?
Do you have a question about the CoaXPress and is the answer not in the manual?
Questions and answers