HikRobot USB3.0 User manual

USB3.0 Board Level Camera
User Manual

USB3.0 Board Level Camera·User Manual
ii
Legal Information
© 2021 Hangzhou Hikrobot Technology Co., Ltd. All rights reserved.
About This Manual
The Manual includes instructions for using and managing the Product. Pictures, charts,
images and all other information hereinafter are for description and explanation only. The
information contained in the Manual is subject to change, without notice, due to firmware
updates or other reasons. Please find the latest version of this Manual at the Hikrobot
website (https://en.hikrobotics.com/). Please use this Manual with the guidance and
assistance of professionals trained in supporting the Product.
Trademarks
and other Hikrobot's trademarks and logos are the properties of Hikrobot in
various jurisdictions. Other trademarks and logos mentioned are the properties of their respective
owners.
Disclaimer
TO THE MAXIMUM EXTENT PERMITTED BY APPLICABLE LAW, THIS MANUAL AND THE PRODUCT
DESCRIBED, WITH ITS HARDWARE, SOFTWARE AND FIRMWARE, ARE PROVIDED "AS IS" AND "WITH
ALL FAULTS AND ERRORS". HIKROBOT MAKES NO WARRANTIES, EXPRESS OR IMPLIED, INCLUDING
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,
INCLUDING, AMONG OTHERS, DAMAGES FOR LOSS OF BUSINESS PROFITS, BUSINESS
INTERRUPTION, OR LOSS OF DATA, CORRUPTION OF SYSTEMS, OR LOSS OF DOCUMENTATION,
WHETHER BASED ON BREACH OF CONTRACT, TORT (INCLUDING NEGLIGENCE), PRODUCT LIABILITY,
OR OTHERWISE, IN CONNECTION WITH THE USE OF THE PRODUCT, EVEN IF HIKROBOT HAS BEEN
ADVISED OF THE POSSIBILITY OF SUCH DAMAGES OR LOSS.
YOU ACKNOWLEDGE THAT THE NATURE OF INTERNET PROVIDES FOR INHERENT SECURITY RISKS,
AND HIKROBOT SHALL NOT TAKE ANY RESPONSIBILITIES FOR ABNORMAL OPERATION, PRIVACY
LEAKAGE OR OTHER DAMAGES RESULTING FROM CYBER-ATTACK, HACKER ATTACK, VIRUS
INFECTION, OR OTHER INTERNET SECURITY RISKS; HOWEVER, HIKROBOT WILL PROVIDE TIMELY
TECHNICAL SUPPORT IF REQUIRED.
YOU AGREE TO USE THIS PRODUCT IN COMPLIANCE WITH ALL APPLICABLE LAWS, AND YOU ARE
SOLELY RESPONSIBLE FOR ENSURING THAT YOUR USE CONFORMS TO THE APPLICABLE LAW.
ESPECIALLY, YOU ARE RESPONSIBLE, FOR USING THIS PRODUCT IN A MANNER THAT DOES NOT
INFRINGE ON THE RIGHTS OF THIRD PARTIES, INCLUDING WITHOUT LIMITATION, RIGHTS OF
PUBLICITY, INTELLECTUAL PROPERTY RIGHTS, OR DATA PROTECTION AND OTHER PRIVACY RIGHTS.
YOU SHALL NOT USE THIS PRODUCT FOR ANY PROHIBITED END-USES, INCLUDING THE
DEVELOPMENT OR PRODUCTION OF WEAPONS OF MASS DESTRUCTION, THE DEVELOPMENT OR
PRODUCTION OF CHEMICAL OR BIOLOGICAL WEAPONS, ANY ACTIVITIES IN THE CONTEXT RELATED

USB3.0 Board Level Camera·User Manual
iii
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. IN THE EVENT OF ANY CONFLICTS BETWEEN THIS MANUAL AND THE APPLICABLE
LAW, THE LATTER PREVAILS.
Regulatory Information
FCC Information
Please take attention that changes or modification not expressly approved by the party responsible
for compliance could void the user's authority to operate the equipment.
FCC compliance: This equipment has been tested and found to comply with the limits for a Class A
digital device, pursuant to part 15 of the FCC Rules. These limits are designed to provide
reasonable protection against harmful interference when the equipment is operated in a
commercial environment. This equipment generates, uses, and can radiate radio frequency energy
and, if not installed and used in accordance with the instruction manual, may cause harmful
interference to radio communications. Operation of this equipment in a residential area is likely to
cause harmful interference in which case the user will be required to correct the interference at his
own expense.
FCC Conditions
This device complies with part 15 of the FCC Rules. Operation is subject to the following two
conditions:
1. This device may not cause harmful interference.
2. This device must accept any interference received, including interference that may cause
undesired operation.
EU Conformity Statement
This product and - if applicable - the supplied accessories too are marked with "CE" and
comply therefore with the applicable harmonized European standards listed under the
EMC Directive 2014/30/EU, the LVD Directive 2014/35/EU, the RoHS Directive 2011/65/EU.
2012/19/EU (WEEE directive): Products marked with this symbol cannot be disposed of as
unsorted municipal waste in the European Union. For proper recycling, return this
product to your local supplier upon the purchase of equivalent new equipment, or

USB3.0 Board Level Camera·User Manual
iv
dispose of it at designated collection points. For more information see: www.recyclethis.info
2006/66/EC (battery directive): This product contains a battery that cannot be
disposed of as unsorted municipal waste in the European Union. See the product
documentation for specific battery information. The battery is marked with this
symbol, which may include lettering to indicate cadmium (Cd), lead (Pb), or mercury (Hg).
For proper recycling, return the battery to your supplier or to a designated collection point.
For more information see: www.recyclethis.info
Korea Certification
.
Symbol Convention
The symbols that may be found in this document are defined as follows.
Symbol
Description
Provides additional information to emphasize or supplement important
points of the main text.
Indicates a potentially hazardous situation, which if not avoided, could
result in equipment damage, data loss, performance degradation, or
unexpected results.
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.
Laws and Regulations
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

USB3.0 Board Level Camera·User Manual
v
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.
Make sure the plug is properly connected to the power socket.
Transportation
The device contains precision optical components and electronic components. During
transportation, storage and installation, incorrect operations like heavy pressure and violent
vibration should be avoided. Otherwise, the device may be damaged.
Avoid sudden collision, and pack the device with the accompanied carton and cushioning
material or similar package.
Using Environment
In order to reduce the risk of fire or electric shock, do not let the device get wet or damp.
Do not drop objects onto the device and avoid vigorous vibration.
Keep the device away from magnetic interference.
Do not use the device in extremely heat, extremely cold, dusty environment, corrosive
environment or high humidity environment.
Do not aim the device lens at objects of strong light, such as the sun and incandescent lamp.
Otherwise, the lens may be damaged.
The device should be stored in dry environment without corrosive gas. Avoid placing the
device in direct sunlight and poorly ventilated locations, or near heat sources such as heater or
heating (ignoring this warning may lead to fire hazards).
Do not operate in explosive environment.
Keep the surrounding area well ventilated to avoid heat accumulation. Do not contact the
radiator directly to avoid scald.
Electrostatic Protection
Remove all conductive objects (such as jewelry, watch, etc.) on the device body before
touching the device, and touch the grounding metal bracket by hand to release the static
electricity.
It is suggested to wear anti-static suit to prevent damage to the equipment caused by static
electricity.
When installing or maintaining the device, wear anti-static wristband or anti-static gloves.
Make sure that the wristband is tightly attached to the skin and is reliably grounded.
It is forbidden to touch exposed circuit boards with bare hands. Static electricity generated by
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.
It is suggested to place humidifier in dry environment to maintain suitable humidity and
reduce static electricity generation.

USB3.0 Board Level Camera·User Manual
vi
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).
Properly preserve all the original packaging materials of the device so that when problems
arise, the device can be packed with packaging materials and sent to the agent or returned to
the manufacturer for processing. The company does not bear any liability for accidental
damage during transportation caused by non-original packaging.
This device is a precision electronic device, no components can be maintained by user, do not
disassemble the device arbitrarily.
Cleaning
Do not touch the image sensor directly. If the sensor needs to be cleaned, use a clean rag and wet
it with alcohol, then gently wipe off the dirt; if the device is not in use, cover the image sensor with
dust cover for protection.
Installation
Do not install the device on vibrating surface or places that are vulnerable to impact.
Personnel Requirement
Quality requirements for installation and maintenance personnel: qualification certificate or
working experience in weak current system installation and maintenance, and relevant working
experience and qualifications. Besides, the personnel must possess the following knowledge and
operation skills:
The basic knowledge and operation skills of low voltage wiring and low voltage electronic
circuit connection.
The ability to comprehend the contents of this manual.
Contact Information
Hangzhou Hikrobot Technology Co., Ltd.
No. 399 Danfeng Road, Binjiang District, Hangzhou, 310051, China
E-mail: [e-mail]
Website: https://en.hikrobotics.com/

USB3.0 Board Level Camera·User Manual
vii
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.....................................................................................................4
3.1.2 4-Pin I/O Interface.....................................................................................................4
3.2 Indicator .............................................................................................................................5
Chapter 4 Camera Installation.............................................................................................................7
4.1 Installation Preparation......................................................................................................7
4.2 Install Camera.....................................................................................................................7
Chapter 5 Camera Connection ............................................................................................................8
5.1 Install MVS Client ...............................................................................................................8
5.2 Turn off Firewall .................................................................................................................9
5.3 Check Driver .....................................................................................................................10
5.4 Connect Camera to Client Software.................................................................................10
Chapter 6 Client Software Layout .....................................................................................................11
Chapter 7 Camera Features ...............................................................................................................13
7.1 Global Shutter ..................................................................................................................13
7.2 Rolling Shutter..................................................................................................................13
7.3 Sensor Shutter Mode .......................................................................................................14
7.4 Non-Overlap Exposure and Overlap Exposure.................................................................14
7.4.1 Non-Overlap Exposure ............................................................................................15
7.4.2 Overlap Exposure ....................................................................................................15
Chapter 8 Image Acquisition.............................................................................................................17
8.1 Set Frame Rate .................................................................................................................17
8.2 Set Overlap Mode.............................................................................................................18
8.3 Set Trigger Mode..............................................................................................................18
8.4 Set Acquisition Mode .......................................................................................................19
8.5 External Trigger Mode......................................................................................................19
8.5.1 Set External Trigger Source .....................................................................................19

USB3.0 Board Level Camera·User Manual
viii
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......................................................................................................26
8.6.4 Set Trigger Cache Enable.........................................................................................26
8.6.5 Set Trigger Debouncer.............................................................................................28
Chapter 9 I/O Output.........................................................................................................................30
9.1 Select Output Signal.........................................................................................................30
9.2 Set Output Signal..............................................................................................................30
9.2.1 Enable Level Inverter...............................................................................................30
9.2.2 Enable Strobe Signal................................................................................................31
Chapter 10 I/O Electrical Feature and Wiring ..................................................................................35
10.1 I/O Electrical Feature......................................................................................................35
10.1.1 Configure Bi-Directional I/O to Input....................................................................35
10.1.2 Configure Bi-Directional I/O to Output.................................................................36
10.2 I/O Wiring.......................................................................................................................37
10.2.1 Wiring of Input Signal ...........................................................................................37
10.2.2 Wiring of Output Signal.........................................................................................39
Chapter 11 Image Parameter ............................................................................................................40
11.1 View Resolution .............................................................................................................40
11.2 Set ROI ............................................................................................................................40
11.3 Set Image Reverse ..........................................................................................................41
11.4 Set Pixel Format..............................................................................................................42
11.5 Set Test Pattern ..............................................................................................................43
11.6 Set Binning......................................................................................................................45
11.7 Set Decimation...............................................................................................................46
11.8 Set Exposure Auto ..........................................................................................................46
11.9 Set Gain ..........................................................................................................................47
11.9.1 Set Analog Gain .....................................................................................................48
11.9.2 Set Digital Gain......................................................................................................48
11.10 Set Brightness...............................................................................................................49
11.11 Set Black Level..............................................................................................................50

USB3.0 Board Level Camera·User Manual
ix
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.........................................................................................................................56
11.20 Set Shading Correction.................................................................................................57
Chapter 12 Other Functions ..............................................................................................................58
12.1 Device Control ................................................................................................................58
12.2 Embedded Information in Image ...................................................................................60
12.3 Transport Layer Control..................................................................................................62
12.4 U3V Protocol Control .....................................................................................................63
12.5 Save and Load User Set ..................................................................................................64
12.6 Update Firmware............................................................................................................66
Chapter 13 FAQ..................................................................................................................................68
13.1 Why the client software cannot list the camera? ..........................................................68
13.2 Why connect the camera failed via the client software?...............................................68
13.3 Why the live view window is black?...............................................................................68
13.4 Why the camera cannot be triggered? ..........................................................................68
13.5 Why the camera cannot get images required by the algorithm though live view and
trigger signal are normal? ......................................................................................................69
13.6 Why image streaming stops or image is splitted?..........................................................69
Chapter 14 Revision History..............................................................................................................70

USB3.0 Board Level Camera·User Manual
1
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.
Supports auto or manual adjustment of gain, exposure time, white balance, Gamma correction,
LUT, etc.
Adopts image interpolation algorithm for color cameras to have better color correction.
Adopts USB3.0 interface to provide power supply and transmit data.
Supports hardware trigger, software trigger, free run, etc.
Compatible with USB3 V ision Protocol, GenlCam standard, and third-party software based on
these protocol and standard.
Key features may differ by camera models.
Refer to the camera’s user manual for specific functions.

USB3.0 Board Level Camera·User Manual
2
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.
Figure 2-1 Appearance (Type I)
Figure 2-2 Appearance (Type II)
Figure 2-3 Appearance (Type III)

USB3.0 Board Level Camera·User Manual
3
Table 2-1 Component Description
No.
Name
Description
1
Lens Mount
It is used to install the lens.
2
Screw Hole
It is used to fix the camera to the installation position. You should use
M2 screws.
3
I/O Interface
It provides I/O function. Refer to section I/O Interface and Indicator
for details.
4
USB3.0 Interface
It provides power supply and transmits data.
5
Indicator
It indicates the camera's status. Refer to section I/O Interface and
Indicator for details.
The C-mount camera connects to a C-mount lens. Its back focal length is 17.45 mm ± 0.15 mm.

USB3.0 Board Level Camera·User Manual
4
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.
2
4
6
1
3
5
Figure 3-1 6-Pin I/O Interface
Table 3-1 Pin Definition of 6-pin I/O Interface
Pin
Signal
I/O Signal Source
Description
1
GPIO2
Line 2 signal line
Can be configured to input or output
2
Reserved
--
--
3
GPIO1
Line 1 signal line
Can be configured to input or output
4
GND
Line 1/Line 2 signal ground
Signal ground
5
Reserved
--
--
6
Reserved
--
--
Refer to the pin definition and labels attached to the I/O cable to wire the camera.
3.1.2 4-Pin I/O Interface
Refer to the figure and table below for the pin definition of the 4-pin I/O interface.

USB3.0 Board Level Camera·User Manual
5
1
2
3
4
Figure 3-2 4-Pin I/O Interface
Table 3-2 Pin Definition of 4-pin I/O Interface
Pin
Signal
I/O Signal Source
Description
1
Reserved
--
--
2
GND
Line 1/Line 2, Line 2/Line 5
signal ground
Signal ground
3
GPIO1
Line 1/Line 2 signal line
Can be configured to input or output
4
GPIO2
Line 2/Line 5 signal line
Can be configured to input or output
Refer to the pin definition and labels attached to the I/O cable to wire the camera.
The I/O signal source may differ by camera models, including Line 1/Line 2, and Line 2/Line 5.
Refer to the specification of the camera for details.
3.2 Indicator
The indicator is used to display the camera’s status. Refer to tables below for indicator status
definition and camera status.
Table 3-3 Indicator Status Definition
Indicator Status
Description
Light up
Indicator lights up for 5 seconds.
Solid
Indicator keeps solid.
Unlit
Indicator keeps unlit.
Fast flash
Unlit interval is 200 ms.
Slow flash
Unlit interval is 1000 ms.

USB3.0 Board Level Camera·User Manual
6
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
Updating firmware
failed or main error
Updating firmware failed, reading configuration file
failed, or other occurs occur.
Red indictor lights up
once
Indicate current
status
When executing Find Me function via the client
software, the indicator displays this status.
Solid blue
Idle status
The camera is in idle status. The data cable has
connected, and the camera is ready.
Fast flashing blue
Internal trigger
acquisition, U3
transmission status
The data cable has connected, and the camera is
acquiring images in internal trigger mode. Data
transmission speed reaches the rated speed of
USB3.0.
Slow flashing blue
Internal trigger
acquisition, U2
transmission status
The data cable has connected, and the camera is
acquiring images in internal trigger mode. Data
transmission speed reaches the rated speed of
USB2.0.
Very slow flashing blue
External trigger
acquisition status
The data cable has connected, and the camera is
acquiring images in external trigger mode.
Alternative flashing
red and blue
Updating firmware
The camera’s firmware is updating.

USB3.0 Board Level Camera·User Manual
7
Chapter 4 Camera Installation
4.1 Installation Preparation
You need to prepare following accessories before camera installation.
Table 4-1 Accessories
No.
Name
Quantity
Description
1
Lens
1
It refers to the suitable lens. You need to purchase separately.
2
USB3.0 Cable
1
It refers to the micro USB3.0 (type B) cable. You need to
purchase separately.
4.2 Install Camera
Before you start
Make sure that all related devices are powered off during the installation process.
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.

USB3.0 Board Level Camera·User Manual
8
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.
5.1 Install MVS Client
MVS client software is used to connect the camera, set its parameters, etc.
The MVS client software is compatible with 32/64-bit Windows XP/7/10, 32/64-bit Linux, and
64-bit MacOS operating systems. Here we take Windows as an example.
The graphic user interface may differ by different versions of the client software you use.
You can download the MVS client software from https://en.hikrobotics.com/.
Steps:
1. Double click the MVS installation package.
2. Select the language.
3. Read and check Terms of the License Agreement.
Figure 5-1 Installation Interface
4. Click Start Setup.

USB3.0 Board Level Camera·User Manual
9
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.
For different Windows versions, the path name or interface may differ.
Steps:
1. Go to Windows Firewall.
Windows XP system: Click Start > Control Panel > Security Center > Windows Firewall.
Windows 7 system: Click Start > Control Panel > Windows Firewall.
Windows 10 system: Click Start > Control Panel > System and Security > Windows Defender
Firewall.
2. Click Turn Windows Defender Firewall on or off on the left.
3. Select Turn off Windows Defender Firewall (not recommended).
Figure 5-3 Windows Defender Firewall
4. Click OK.

USB3.0 Board Level Camera·User Manual
10
5.3 Check Driver
Before using the camera, you need to make sure that the PC has installed the USB driver
correctly. Otherwise, the client software cannot find the camera.
After connecting the camera, the PC will automatically check and install the USB driver. After
installation, you can view the added driver in the device manager of the PC, and right click
Properties to view its properties.
Figure 5-4 Driver Properties
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.
5.4 Connect Camera to Client Software
After running the client software, double click the camera in the device list, or click to connect
the camera to the client software.

USB3.0 Board Level Camera·User Manual
11
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.
Table 6-1 Main Window Description
No.
Area Name
Description
1
Menu Bar
The menu bar displays function modules, including File, View, Settings,
Tool, and Help.
2
Control Toolbar
The control toolbar provides quick operations for cameras.
3
Device List Panel
This panel displays device list, and you can connect or disconnect
cameras.
4
Device
Information Panel
This panel displays the detailed camera information.
5
Display Window
This area displays acquisition images in real-time.