1. Manuals
  2. Brands
  3. HikRobot Manuals
  4. Digital Camera
  5. USB3.0
  6. User manual

HikRobot USB3.0 User Manual

Board level camera
Hide thumbs
Table of Contents

Advertisement

Quick Links

Download this manual
USB3.0 Board Level Camera
User Manual

Advertisement

Table of Contents
loading
Need help?

Need help?

Do you have a question about the USB3.0 and is the answer not in the manual?

Questions and answers

Related Manuals for HikRobot USB3.0

Summary of Contents for HikRobot USB3.0

  • Page 1 USB3.0 Board Level Camera User Manual...
  • 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 USB3.0 Board Level 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 USB3.0 Board Level Camera User Manual · under electrification.  Avoid contact with exposed circuit. When the device is powered on, avoid contact with exposed junctions and parts.  Use the power adapter provided by the regular manufacturer.  Do not connect multiple devices to one power adapter, to avoid over-heating or fire hazards caused by overload.
  • Page 6 USB3.0 Board Level Camera User Manual · Maintenance  If the device is not working properly, contact the store or the nearest service center. Do not disassemble or modify the device in any way. (The company does not bear any liability for any problem arising from unauthorized modification or maintenance).

  • Page 7: Table Of Contents

    USB3.0 Board Level Camera User Manual · Table of Contents Chapter 1 Overview ..........................1 1.1 Introduction........................1 1.2 Key Feature ......................... 1 Chapter 2 Appearance ......................... 2 Chapter 3 I/O Interface and Indicator....................4 3.1 I/O Interface ........................4 3.1.1 6-Pin I/O Interface .....................
  • Page 8 USB3.0 Board Level Camera User Manual · 8.5.2 Set Software Trigger ....................20 8.5.3 Set Hardware Trigger ....................21 8.5.4 Set Counter Trigger....................22 8.6 Trigger Related Parameters ....................23 8.6.1 Set Trigger Activation ....................24 8.6.2 Set Burst Frame Count .................... 25 8.6.3 Set Trigger Delay......................
  • Page 9 USB3.0 Board Level Camera User Manual · 11.12 Set White Balance ......................50 11.13 Set Gamma Correction ....................52 11.14 Set Sharpness ....................... 53 11.15 Set Hue ......................... 54 11.16 Set Saturation ....................... 54 11.17 Set AOI .......................... 54 11.18 Set LUT ......................... 55 11.19 Set HDR.........................

  • Page 10: Chapter 1 Overview

    · Chapter 1 Overview 1.1 Introduction The USB3.0 board level camera uses USB3.0 interface to transmit non-compressed images in real time, and it supports acquiring images and setting parameters via the client software or SDK. 1.2 Key Feature  Compact design for flexible installation.

  • Page 11: Chapter 2 Appearance

    · Chapter 2 Appearance The USB3.0 board level camera has 3 kinds of appearance as shown below. Type I is the single board structure, type II is the C-mount structure, and type III is the M12-mount structure. Appearances here are for reference only. Refer to the camera's specification for detailed dimension information.
  • Page 12 USB3.0 Board Level Camera User Manual · Table 2-1 Component Description Name Description Lens Mount It is used to install the lens. It is used to fix the camera to the installation position. You should use Screw Hole M2 screws.

  • Page 13: Chapter 3 I/O Interface And Indicator

    Chapter 3 I/O Interface and Indicator 3.1 I/O Interface The USB3.0 board level camera has 2 kinds of I/O interface, including 6-pin and 4-pin. 3.1.1 6-Pin I/O Interface Refer to the figure and table below for the pin definition of the 6-pin I/O interface.

  • Page 14: Indicator

    USB3.0 Board Level Camera User Manual · Figure 3-2 4-Pin I/O Interface Table 3-2 Pin Definition of 4-pin I/O Interface Signal I/O Signal Source Description Reserved Line 1/Line 2, Line 2/Line 5 Signal ground signal ground GPIO1 Line 1/Line 2 signal line...
  • Page 15 USB3.0 Board Level Camera User Manual · Indicator Status Description Very slow flash Unlit interval is 2000 ms. Table 3-4 Indicator Description Indicator Status Camera Status Description Very slow flashing red Connection error The data cable is disconnected. Solid red...

  • Page 16: Chapter 4 Camera Installation

    You are required to use USB3.0 cable to ensure the bandwidth for image transmission in real time. Steps: 1. Fix the camera to the installation position. 2. Install the lens to the camera. 3. Use the micro USB3.0 (type B) cable to connect the camera to the PC or other devices.

  • Page 17: Chapter 5 Camera Connection

    USB3.0 Board Level Camera User Manual · Chapter 5 Camera Connection Camera connection to the client software is required for camera's configuration and remote operations. This section introduces how to install the client software, check USB driver, connect the camera to the client software, etc.

  • Page 18: Turn Off Firewall

    USB3.0 Board Level Camera User Manual · Figure 5-2 Default Settings 5. Keep default settings, and click Next. 6. Finish the installation according to the interface prompts. 5.2 Turn off Firewall To ensure stable client running and image transmission, you are recommended turning off Windows firewall before using the client software.

  • Page 19: Check Driver

    If the installation of the driver is failed, you can install it manually. By default, the driver is located in C:\Program Files (x86)\Common Files\MVS\Drivers\Usb3.0. The specific path of driver location may differ by Windows version and the client software version you installed.

  • Page 20: Chapter 6 Client Software Layout

    USB3.0 Board Level Camera User Manual · Chapter 6 Client Software Layout After connecting to the camera, the client software can read the camera attributes and display them. Figure 6-1 Main Window For specific main window of the client software, please refer to the actual one you got.
  • Page 21 USB3.0 Board Level Camera User Manual · Area Name Description You can view and set features of the selected camera, and perform Feature Panel operations such as importing, exporting, and saving features. Click in the camera's feature panel to unfold the specific parameters, and set them according to actual demands.

  • Page 22: Chapter 7 Camera Features

    USB3.0 Board Level Camera User Manual · Chapter 7 Camera Features 7.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, as shown below.

  • Page 23: Sensor Shutter Mode

    USB3.0 Board Level Camera User Manual · 7.3 Sensor Shutter Mode  Only some models of cameras with rolling shutter and corresponding firmware support the sensor shutter mode. The actual product you purchased should prevail.  Stopping the real-time acquisition and setting Trigger Mode as On are required before setting the sensor shutter mode.

  • Page 24: Non-Overlap Exposure

    USB3.0 Board Level Camera User Manual · 7.4.1 Non-Overlap Exposure After completing the current frame’s exposure and readout, the next frame starts to expose and read out. This process is called non-overlap exposure. The non-overlap exposure’s frame period is larger than the sum of the exposure time and the readout time, as shown below.
  • Page 25 USB3.0 Board Level Camera User Manual · Exposure 1 Exposure 2 Exposure 3 Sensor Exposure Frame 1 Frame 2 Readout Readout Figure 7-7 Internal Trigger Overlap Exposure  Overlap Exposure under External Trigger Mode Trigger_in 1 Trigger_in 2 Trigger_in 3...

  • Page 26: Chapter 8 Image Acquisition

    USB3.0 Board Level Camera User Manual · Chapter 8 Image Acquisition 8.1 Set Frame Rate Frame rate refers to the image number that is acquired by the camera per second. The higher frame rate, and shorter time used for image acquisition will be. The following 4 factors determine the camera’s frame rate in real-time.

  • Page 27: Set Overlap Mode

    USB3.0 Board Level Camera User Manual · Figure 8-2 Resulting Frame Rate Set Overlap Mode The overlap mode function may differ by camera models. The camera supports overlap mode function by selecting On as Overlap Mode. Figure 8-3 Set Overlap Mode Set Trigger Mode The camera has 2 types of trigger mode, including internal trigger mode and external trigger mode.

  • Page 28: Set Acquisition Mode

    USB3.0 Board Level Camera User Manual · Off refers to the internal trigger mode, and On refers to the external trigger mode. Set Acquisition Mode Under the internal trigger mode, the camera supports 2 types of acquisition mode, including SingleFrame mode and Continuous mode.

  • Page 29: Set Software Trigger

    USB3.0 Board Level Camera User Manual · External Trigger Parameter Parameter Principle Source Value Trigger Source acquire images. Hardware trigger Line 1, Line 2 External device connects camera via camera I/O interface. External device sends trigger signal to camera to acquire images.

  • Page 30: Set Hardware Trigger

    USB3.0 Board Level Camera User Manual · Figure 8-7 Set Software Trigger 8.5.3 Set Hardware Trigger The camera has two bi-directional I/Os that can be configured to input signal. Here we take Line 2 as an example to introduce the hardware trigger settings. You select other bi-directional I/O as trigger source to set hardware trigger according to actual demands.

  • Page 31: Set Counter Trigger

    USB3.0 Board Level Camera User Manual · Figure 8-9 Set Hardware Trigger 8.5.4 Set Counter Trigger The counter trigger provides frequency division to the external trigger signal. You can set counter trigger as shown below. Steps: 1. Click Acquisition Control > Trigger Mode, and select On as Trigger Mode.

  • Page 32: Trigger Related Parameters

    USB3.0 Board Level Camera User Manual · Parameter Read/Write Description disabled by default. Counter Reset Source Read and write It selects the signal source of resetting counter. Software is available only. It is disabled by default. Counter Reset Write is available...

  • Page 33: Set Trigger Activation

    USB3.0 Board Level Camera User Manual · Sources Software Trigger Hardware Trigger Counter Trigger Parameters Trigger Cache Enable √ √ √ Trigger Debouncer × √ × × means that specific trigger parameters are not supported, and √ means that specific trigger parameters are supported.

  • Page 34: Set Burst Frame Count

    USB3.0 Board Level Camera User Manual · Figure 8-12 Set Trigger Activation 8.6.2 Set Burst Frame Count Under external trigger mode, you can set burst frame count as shown below. Click Acquisition Control > Acquisition Burst Frame Count, and enter Acquisition Burst Frame Count according to actual demands.

  • Page 35: Set Trigger Delay

    USB3.0 Board Level Camera User Manual · 8.6.3 Set Trigger Delay From camera receiving signal and responding, this period is trigger delay. Its sequence diagram is shown below. The figure below uses rising edge as trigger activation. Figure 8-15 Signal Delay Sequence Diagram You can enter Trigger Delay according to actual demands, and its range is from 0 μs to 16000000...
  • Page 36 USB3.0 Board Level Camera User Manual · Figure 8-17 Enable Trigger Cache Enable If the camera receives the 1st trigger signal first, and the camera receives the 2nd trigger signal during processing the 1st trigger signal.  Disable Trigger Cache Enable: the 2nd trigger signal will be filtered without processing.

  • Page 37: Set Trigger Debouncer

    USB3.0 Board Level Camera User Manual · If the 1st frame image’s exposure time of the 2nd trigger signal is earlier than the camera’s last frame creation time of the 1st trigger signal, and then the camera will delay this exposure time.
  • Page 38 USB3.0 Board Level Camera User Manual · Click Digital IO Control > Line Debouncer Time, and enter Line Debouncer Time according to actual demands. Figure 8-22 Set Trigger Debouncer...

  • Page 39: Chapter 9 I/O Output

    USB3.0 Board Level Camera User Manual · Chapter 9 I/O Output 9.1 Select Output Signal The camera has two bi-directional I/Os that can be configured to output signal. Here we take Line 2 as an example to introduce how to select output signal. You select other bi-directional I/O according to actual demands.

  • Page 40: Enable Strobe Signal

    USB3.0 Board Level Camera User Manual · The Line Inverter parameter is disabled by default. 9.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, select Exposure Active as Line Source, and enable Strobe Enable.
  • Page 41 USB3.0 Board Level Camera User Manual · Figure 9-4 Set Strobe Line Duration Figure 9-5 Strobe Diagram Sequence  Set Strobe Line Delay The camera supports setting strobe line delay to meet actual demands. When exposure starts, the strobe output doesn’t take effect immediately. Instead, the strobe output will delay according to the strobe line delay setting.
  • Page 42 USB3.0 Board Level Camera User Manual · Figure 9-6 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 USB3.0 Board Level Camera User Manual · Figure 9-8 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...

  • Page 44: Chapter 10 I/O Electrical Feature And Wiring

    USB3.0 Board Level Camera User Manual · Chapter 10 I/O Electrical Feature and Wiring 10.1 I/O Electrical Feature The camera has two bi-directional I/Os that can be configured to input signal or output signal. Its internal circuit is shown below.

  • Page 45: Configure Bi-Directional I/O To Output

    USB3.0 Board Level Camera User Manual · Parameter Name Parameter Symbol Value Input Logic Level High VH 3.3 VDC to 24 VDC Input Rising Delay < 0.66 μs Input Falling Delay < 0.05 μs  Make sure that the input voltage is not from 0.3 VDC to 3.3 VDC because the electric status between these two values are not stable.

  • Page 46: I/O Wiring

    USB3.0 Board Level Camera User Manual · Figure 10-3 Output Logic Level Table 10-3 Output Electrical Feature 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 47 USB3.0 Board Level Camera User Manual · PNP Power PNP Device Bi-direction I/O Signal Line ● PNP Power I/O Signal Ground ● ● Ground GND of VCC and I/O Signal Figure 10-4 Bi-directional I/O Connecting to PNP Device as Input ...

  • Page 48: Wiring Of Output Signal

    USB3.0 Board Level Camera User Manual · 10.2.2 Wiring of Output Signal When the camera uses bi-directional I/O as output signal, wirings are different with different external devices.  PNP Device PNP Power PNP Device Bi-direction I/O Signal Line PNP Power I/O Signal Ground ●...

  • Page 49: Chapter 11 Image Parameter

    USB3.0 Board Level Camera User Manual · Chapter 11 Image Parameter 11.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.

  • Page 50: Set Image Reverse

    USB3.0 Board Level Camera User Manual · Figure 11-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 ...

  • Page 51: Set Pixel Format

    USB3.0 Board Level Camera User Manual · Figure 11-4 Image Reverse Comparison 11.4 Set Pixel Format The pixel format may differ by camera models. Table 11-1 Pixel Format and Pixel Size Pixel Format Pixel Size (Bits/Pixel) Mono 8, Bayer 8...

  • Page 52: Set Test Pattern

    USB3.0 Board Level Camera User Manual · 11.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 53 USB3.0 Board Level Camera User Manual · Figure 11-8 Checkboard Figure 11-9 Oblique Mono Bar Figure 11-10 Gradual Mono Bar...

  • Page 54: Set Binning

    USB3.0 Board Level Camera User Manual · Figure 11-11 Vertical Color Bar Figure 11-12 Horizontal Color Bar Figure 11-13 Test Image 1 11.6 Set Binning The purpose of setting binning is to enhance sensibility. With binning, multiple sensor pixels are...

  • Page 55: Set Decimation

    USB3.0 Board Level Camera User Manual · Click Image Format Control, and set Binning Horizontal and Binning Vertical according to actual demands. Figure 11-14 Set Binning  Binning Horizontal refers to the image’s width, and Binning Vertical refers to the image’s height.

  • Page 56: Set Gain

    USB3.0 Board Level Camera User Manual · Table 11-2 Exposure Method and Principle Exposure Method Principle The camera exposures according to the value configured by user in Exposure Time. Once Adjust the exposure time automatically according to the image brightness. After adjusting, it will switch to Off Mode.

  • Page 57: Set Analog Gain

    USB3.0 Board Level Camera User Manual · is still dark after increasing exposure time and analog gain, at this time, you can increase digital gain. 11.9.1 Set Analog Gain The camera supports 3 types of analog gain modes: Off, Once and Continuous. Click Analog Control, and select Gain Auto according to actual demands.

  • Page 58: Set Brightness

    USB3.0 Board Level Camera User Manual · Figure 11-18 Set Digital Gain 11.10 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 can set brightness as shown below.

  • Page 59: Set Black Level

    USB3.0 Board Level Camera User Manual · After setting brightness, the camera will automatically adjust exposure time to let image brightness reach target one. Under Once or Continuous exposure mode, or Once or Continuous gain, the higher the brightness value, the brighter the image will be.
  • Page 60 USB3.0 Board Level Camera User Manual · Table 11-4 White Balance Status Description White Balance Mode Description You need to set the R, G, B value manually, between 1 and 4095. 1024 means ratio is 1.0 Once Automatic white balance once. Adjust the white balance for a certain amount of time then stop.

  • Page 61: Set Gamma Correction

    USB3.0 Board Level Camera User Manual · 11.13 Set Gamma Correction  The Gamma correction function may differ by camera models.  Bayer pixel format of color cameras does not support Gamma correction. The camera supports Gamma correction function. Generally, the output of the camera’s sensor is linear with the photons that are illuminated on the photosensitive surface of the sensor.

  • Page 62: Set Sharpness

    USB3.0 Board Level Camera User Manual · Figure 11-22 Set User Mode You can set sRGB mode as shown below. Steps: 1. Click Analog Control > Gamma Selector. 2. Select sRGB as Gamma Selector. 3. Enable Gamma Enable. Figure 11-23 Set sRGB Mode 11.14 Set Sharpness...

  • Page 63: Set Hue

    USB3.0 Board Level Camera User Manual · 11.15 Set Hue  Hue is only available for color cameras.  Make sure that the color camera’s pixel format is not in mono and Bayer pixel formats. Adjusting the hue shifts the colors of the image.

  • Page 64: Set Lut

    USB3.0 Board Level Camera User Manual · The camera supports AOI function that can adjust the brightness and white balance of the entire image based on the area you selected. Steps: 1. Click Analog Control > Auto Function AOI Selector, and select AOI 1 or AOI 2 Auto Function AOI Selector.

  • Page 65: Set Hdr

    USB3.0 Board Level Camera User Manual · Figure 11-28 Set LUT  You cannot use Gamma correction function and LUT function at the same time.  LUT function is not supported when the color camera is in Bayer pixel format.

  • Page 66: Set Shading Correction

    USB3.0 Board Level Camera User Manual · Figure 11-30 HDR Polling 11.20 Set Shading Correction The shading correction function may differ by camera models. 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 NUC correction, FPNC correction, and PRNUC correction.

  • Page 67: Chapter 12 Other Functions

    USB3.0 Board Level Camera User Manual · Chapter 12 Other Functions 12.1 Device Control The specific device control parameters may differ by camera models. In the Device Control attribute, you can view device information, edit device name, reset device, etc. The specific parameters in Device Control attribute are shown below.
  • Page 68 USB3.0 Board Level Camera User Manual · Parameter Read/Write Description Device SBRM Address Read only It is the base address register. Device Timestamp Read only It is the device timestamp. Device Timestamp Latch Read and Click Execute to get the device timestamp.

  • Page 69: Embedded Information In Image

    USB3.0 Board Level Camera User Manual · Parameter Read/Write Description Device Sensor Throughput Read and It controls device flow, and can be set according to actual Limit write bandwidth to avoid image lose. Device Command Timeout Read only It is the device max. response time.
  • Page 70 USB3.0 Board Level Camera User Manual · No. Information Type Byte Data Format Description Gain 4 Bytes 4 bytes are used to transfer the gain information. Each low 8 bits of the 4 valid data are combined to transfer the gain information.

  • Page 71: Transport Layer Control

    USB3.0 Board Level Camera User Manual · space in first line image, and then the collection information will be embedded into the second line image. Steps: 1. Click Image Format Control > Embedded Image Info Selector, select specific parameters as Embedded Image Info Selector.

  • Page 72: U3V Protocol Control

    USB3.0 Board Level Camera User Manual · Table 12-3 Transport Layer Control Description Parameter Read/Write Description Paylode Size Read only It is the camera’s load size. GenCP Version Major Read only It is the major version in GenCP version. GenCP Version Minor Read only It is the minor version in GenCP version.

  • Page 73: Save And Load User Set

    USB3.0 Board Level Camera User Manual · Go to Stream Control to view USB transfer size, transfer times, final 1 value and final 2 value. Table 12-4 Stream Control Parameters Parameter Read/Write Description U3V SI Payload Transfer Size Read only It is the batch transmission size of stream data.
  • Page 74 USB3.0 Board Level Camera User Manual · Figure 12-4 Save User Set  Load Parameters Steps: 1. Click User Set Control, and select a user set in User Set Selector. Here we take selecting User Set 1 as an example.

  • Page 75: Update Firmware

    USB3.0 Board Level Camera User Manual · Figure 12-6 Set User Default 12.6 Update Firmware The camera supports firmware updating via the MVS client software.  Before updating, make sure that USB 3.0 cable and others are properly connected.  Use the firmware package of the corresponding camera model for updating.
  • Page 76 USB3.0 Board Level Camera User Manual · Figure 12-7 Update Firmware  The camera will reboot automatically after updating the firmware.  The firmware updating process may take a few minutes, please wait patiently.  During firmware updating, do not disconnect the camera or switch off power.

  • Page 77: Chapter 13 Faq

    Check the camera’s power wiring (observe camera indicator), and check USB cable connection. 13.2 Why connect the camera failed via the client software? Reason Incorrect installation of the MVS client software, or the USB3.0 driver is not installed successfully. Solution Install the MVS client software or the USB3.0 driver again. 13.3...

  • Page 78: Why The Camera Cannot Get Images Required By The Algorithm Though Live View And Trigger Signal Are Normal

    USB3.0 Board Level Camera User Manual · 13.5 Why the camera cannot get images required by the algorithm though live view and trigger signal are normal? Reason Incorrect output format of images. Solution Check the image format required by the algorithm, and adjust the output format of images in the client software.

  • Page 79: Chapter 14 Revision History

    USB3.0 Board Level Camera User Manual · Chapter 14 Revision History Table 14-1 Revision History Version No. Document No. Date Revision Details Dec. 14, 2021  Add section Overview. V2.0.0 UD26615B  Modify section Appearance.  Modify section I/O Interface and Indicator.
  • Page 80 UD26615B...

Table of Contents