VRmagic USB Camera User manual

VRmagic
USB Camera
User Guide
Issued July 2014

USB Cameras – User Guide
Document version: 1.3
Date of issue: July 16, 2014
Applicable to: all USB cameras, SDK release ≥ 4.0
Subject to change without notice. Errors excepted.
This document is protected by copyright. All rights reserved. No part of this
document may be reproduced or transmitted for any purpose in any form
or by any means, electronically or mechanically, without expressly written
permission by VRmagic.
Windows®is a registered trademark of Microsoft®.
VRmagic GmbH
Augustaanlage 32
68165 Mannheim
Germany
Phone [phone]
Fax [phone]
[e-mail]
www.vrmagic-imaging.com

Table of Contents
1 General Information ..........................................................6
2 Overview.............................................................................7
2.1 Camera Models ...........................................................................................7
2.2 Connectors and Interfaces ........................................................................10
2.3 Accessories ............................................................................................... 13
3 Software Installation ......................................................14
3.1 Downloading the SDK ...............................................................................14
3.2 Installing the SDK ......................................................................................14
3.3 Contents of the SDK..................................................................................15
3.3.1 Windows....................................................................................... 15
3.3.2 Linux..............................................................................................16
4 Hardware Installation......................................................17
4.1 Connecting External Sensor Boards ......................................................... 17
4.2 Connecting the Interface Cables...............................................................19
4.2.1 General Information on the USB Connection...............................19
4.2.2 Cameras with Hirose DF14-15P Connector..................................20
4.2.3 Cameras with MPE Garry Micro-T Connector..............................22
4.2.4 Compact Single-Sensor Cameras ................................................23
4.3 Connecting to Power.................................................................................23
4.3.1 Power Supply via USB ..................................................................24
4.3.2 External Power Supply .................................................................25
5 First Steps ........................................................................26
5.1 Auto-Detection of the Camera ..................................................................26
5.2 Starting CamLab........................................................................................26
5.3 Accessing the Demo Applications ............................................................28
5.4 Using Trigger and Strobe ...........................................................................29
5.4.1 Trigger Input..................................................................................30
5.4.2 Strobe Output ...............................................................................31
USB Cameras – User Guide4
USB Components
Table of Contents

6 Firmware Update.............................................................32
7 Appendix.......................................................................... 34
7.1 Cable Plan VRmC-X OEM Interface Cable ................................................34
7.2 Cable Plan VRmDC/FC-X-DF14-Open.......................................................35
7.3 Cable Plan VRmC-X PRO Interface Cable .................................................36
7.4 Pinout 4-pin Header VRmC-X+ OEM/COB ...............................................37
7.5 Status LED Indications ..............................................................................38
8 Index..................................................................................39
5USB Cameras – User Guide
Table of Contents
USB Components

1 General Information
This guide applies to all USB cameras from VRmagic. Follow this guide chapter by
chapter to set up and understand your device. If a section of this document only applies
to certain camera models, this is indicated at the beginning of the respective section.
Symbols Used
This guide makes use of the following symbols and conventions:
Warning!
Indicates a situation which, if not avoided, could result in minor or moderate injury
and/or property damage or damage to the device.
Caution
Indicates a situation which, if not avoided, may result in minor damage to the
device, in malfunction of the device or in data loss.
Note
Notes provide information on special issues related to the device or provide infor-
mation that will make operation of the device easier.
This headline indicates the beginning of a procedure:
1. This number indicates the first step of a certain procedure you are expected to
follow. Following steps are numbered accordingly.
fThis arrow indicates an expected result of your action.
 This symbol indicates a reference to a different part of this manual or to external
documents.
USB Cameras – User Guide6
USB Components
General Information

2 Overview
2.1 Camera Models
Single-Sensor Cameras VRm(F)C-X
Single-sensor cameras are equipped with one image sensor. The sensor board is
mounted directly onto the camera base unit, thus forming one compact unit. Single-
sensor cameras are available as board-level cameras (OEM versions), board-level
cameras with optics (COB versions) and as cameras with aluminium housing (PRO
versions).
All cameras are equipped with a sensor board and an interface board. Depending on
the image sensor, the camera may be equipped with an additional FPGA board (VRm-
FC-X models).
Front View Side View Back View
Sensor
Fig. 1: USB single-sensor camera (OEM) with FPGA board
1 Sensor board with image sensor
2 FPGA board (VRmFC-X cameras only)
3 Interface board
7USB Cameras – User Guide
Overview
USB Components

Compact Single-Sensor Cameras VRmC-X+
Compact single-sensor cameras consist of one board only, making them very small.
They are equipped with one image sensor and are available as board-level cameras
(OEM versions), board-level cameras with optics (COB versions) and as cameras with
aluminium housing (PRO versions).
Front View Side View
USB
Sensor T
G
G
S
Fig. 2: Compact USB single-sensor camera (OEM)
Remote-Sensor Cameras VRmC-X-E
Remote-sensor cameras consist of a base unit and an external sensor board connected
to the base unit by flex-foil cable. Remote-sensor cameras are available as board-level
cameras (OEM versions) and board-level cameras with optics (COB versions).
The base unit consists of a sensor connection board and an interface board.
Back ViewFront View Side View
Fig. 3: Base unit of USB remote-sensor camera
1 Sensor connection board (external sensor board is connected via flex-foil cable)
2 Interface board
USB Cameras – User Guide8
USB Components
Overview

Multi-Sensor Cameras VRmMFC
Multi-sensor cameras consist of a base unit and up to four external sensor boards con-
nected to the base unit by flex-foil cables. They are available as board-level cameras
(OEM versions) and board-level cameras with optics (COB versions).
The base unit consists of a sensor connection board, an FPGA board, and an interface
board.
Front View Side View Back View
Fig. 4: Base unit of USB multi-sensor camera with standard interface board
1 Sensor connection board (external sensor boards are connected via flex-foil
cables)
2 FPGA board
3 Interface board
9USB Cameras – User Guide
Overview
USB Components

2.2 Connectors and Interfaces
Depending on your camera model, the available interfaces vary in type and position.
There are basically three different interface configurations, which are described in the
following.
Single-/Remote-/Multi-Sensor Cameras OEM and COB
Single-sensor cameras, remote-sensor cameras, and multi-sensor cameras in OEM
and COB versions are equipped with a USB connector, a Hirose DF14-15P connector
for trigger/strobe and external power supply, and a status LED (Fig. 5 on page10).
Back View Top View
Fig. 5: Interfaces of a single-sensor camera VRmFC-X OEM
1 USB Mini-B port
2 Status LED
3 DF14-15P connector for trigger, strobe, and external power supply
USB Cameras – User Guide10
USB Components
Overview

Single-Sensor Cameras PRO
Single-sensor cameras in PRO version are equipped with a USB connector, an MPE
Garry Micro-T connector for trigger/strobe and external power supply, and a status LED
(Fig. 6 on page11).
Side View Back View
Fig. 6: Interfaces of a single-sensor camera VRmC-X PRO
1 MPE Garry Micro-T 386-2-021-ZS0 connector for trigger, strobe, and external
power supply
2 USB Mini-B port
3 Status LED
11USB Cameras – User Guide
Overview
USB Components

Compact Single-Sensor Cameras
Compact single-sensor cameras: PRO variants are equipped with a USB connector
(Fig. 7 on page 12). OEM and COB variants also feature an additional 4-pin header
for trigger/strobe and a status LED (Fig. 7 on page12).
Front View Top View
Fig. 7: Interfaces of a compact single-sensor camera VRmC-X+ PRO
1 USB Mini-B port
Side View Back View
USB
Sensor T
G
G
S
Fig. 8: Interfaces of a compact single-sensor camera VRmC-X+ OEM
1 USB Mini-B port
2 4-pin header for trigger and strobe
3 Status LED
USB Cameras – User Guide12
USB Components
Overview

2.3 Accessories
Accessory Description
VRmDC/FC-X-DF14-Open Interface cable with Hirose DF14 plug
on one end and open wires at the other
end (Fig. 13 on page21).
For all board-level cameras (OEM and
COB) except compact single-sensor
cameras.
VRmC-X OEM Interface Cable Interface cable with Hirose DF14 plug
on one end and different adapters on
the other end (Fig. 12 on page21).
For all board-level cameras (OEM and
COB) except compact single-sensor
cameras.
VRmC-X PRO Interface Cable Interface cable with MPE Garry
Micro-T plug on one end and dif-
ferent adapters on the other end
(Fig. 14 on page22).
For all housing cameras (PRO) except
compact single-sensor cameras.
1 Power supply 5 V / 15 W worldwide Power supply for all cameras except
compact single-sensor cameras.
13USB Cameras – User Guide
Overview
USB Components

3 Software Installation
3.1 Downloading the SDK
Downloading the software package:
1. Visit www.vrmagic.com/imaging/downloads/ .
fThe software for USB cameras can be found beneath the heading “Software
for USB Components”.
2. Dependent upon on the operating system of the target system (Linux or Win-
dows, 32 bit or 64 bit), download the .zip file VRmUsbCam DevKit for Windows
... or the .tar.bz2 file VRmUsbCam DevKit for Linux ... .
3. Unpack the downloaded file.
3.2 Installing the SDK
Note
You may install both the 32 bit version (X86) and the 64 bit version (X64) of the
SDK in parallel, if required.
Installing the software development kit (Windows):
1. Navigate into the directory created after unpacking the downloaded file.
2. To install the SDK, run setup.exe.
3. Follow the on-screen instructions.
fAfter successful installation a message is displayed. A new folder VRmagic
was created in your Windows start menu. Several folders were created on your
hard drive (3.3.1 on page 15).
Installing the software development kit (Linux):
1. Navigate into the directory created after unpacking the downloaded file.
2. To install the SDK, execute ./VRmUsbCamDevKitForLinuxX**-install as
root (**= 64 or 86). For further information, refer to the README file in the same
directory. Several folders were created on your hard drive (3.3.2 on page 16).
USB Cameras – User Guide14
USB Components
Software Installation

3.3 Contents of the SDK
3.3.1 Windows
The SDK installation will create the following directories on your PC. Drive letters and
paths may vary depending on your system and installation instructions.
32 bit: C:\Program Files (x86)\VRmagic\
64 bit: C:\Program Files\VRmagic\
USB driver VRmagic USB driver installation files
VRmUsbCam VRmUsbCam and tools
CamLab Camera application with control and viewer window
CamServer Camera application for Ethernet transmission
Install Install scripts for COM API & DirectShow, Ethernet
PnP enable script
weblinks Links to VRmagic website
32 bit: C:\Program Files (x86)\Common Files\VRmagic\VRmUsbCamSDK\
64 bit: C:\Program Files (x86)\Common Files\VRmagic\VRmUsbCamSDK\
demos Demo applications
docs Product documentation
include Include file for using the shared library
lib Shared library
vm_lib Library for image processing
vsprops Property Sheets for Visual Studio (C++)
wrappers C++ and .NET wrappers
15USB Cameras – User Guide
Software Installation
USB Components

3.3.2 Linux
Directory structure of the SDK distribution (Linux)
camlab Camera application with control and viewer window
vrmcamserver Camera application for Ethernet transmission
demos Demo applications
deviceinfo Demo application displaying device information
restorefactory
defaults
Demo application that restores all factory defaults
sdlviewer Demo application displaying the camera pictures in an
SDL widget
docs vrmusbcam API documentation
include Include file for using the shared library
lib Shared library
share
fpgaprogramfiles
setup Setup scripts, hotplug helper and ethernet enable/
disalbe scripts
udev udev rules file which invokes the hotplug helper
etc Potential contents of /etc/vrmagic
USB Cameras – User Guide16
USB Components
Software Installation

4 Hardware Installation
4.1 Connecting External Sensor Boards
Note
This section only applies to remote-sensor cameras and multi-sensor cameras.
Caution
Possible malfunction of camera
Observe the correct orientation of the flex-foil cable contacts as indicated in the
instructions and the drawings. Otherwise the device will not function.
Connecting the flex-foil cable(s) to the base unit:
1. Pull out the lock of the connector on the base unit (Fig. 9 on page17).
2. Insert the flex-foil cable with the blue marker facing the board and the open con-
tacts facing you.
3. Secure the cable by pushing the lock back in.
4. Repeat steps 1 to 3 for further external sensor boards.
Multi-Sensor Base Unit
Remote-Sensor Base Unit
Fig. 9: Connecting the flex-foil cable to the base unit: contacts visible, blue marker not visible
17USB Cameras – User Guide
Hardware Installation
USB Components

Connecting the flex-foil cable(s) to the sensor board(s):
1. Pull out the lock of the connector on the sensor board (Fig. 10 on page18).
2. Insert the flex-foil cable with the blue marker facing you and the open contacts
facing towards the sensor board.
3. Secure the cable by pushing the lock back in.
4. Repeat steps 1 to 3 for further external sensor boards.
VRmMS-12
VRmS-9/12/14/16/18
Fig. 10: Connecting the flex-foil cable to the sensor board: contacts not visible, blue marker
visible
USB Cameras – User Guide18
USB Components
Hardware Installation

4.2 Connecting the Interface Cables
4.2.1 General Information on the USB Connection
VRmagic USB cameras are not compatible with USB 3.0 hosts. Always connect the
camera to a USB 2.0 host, otherwise is will not work properly.
Although there is no standard for the labeling or the color of USB ports, most manu-
facturers make use of the following color codes (Fig. 11 on page 19). Also pay
attention to possible labels or text next to USB connectors.
• Blue USB port: This is a USB 3.0 connector. Some USB 3.0 ports are additionally
labelled with a USB 3.0 logo. Do not connect the camera to USB 3.0 ports.
• Black USB port: This is a USB 2.0 connector. Some USB 2.0 ports are additionally
labelled with a USB 2.0 logo.
• Yellow USB port: This type of connector permanently supplies power to the con-
nected device, even if the host is switched off. Yellow USB ports may be USB 2.0
or USB 3.0 connectors. Pay attention to the label in order to find out.
USB 2.0 USB 2.0 USB 3.0 USB 3.0
Fig. 11: USB port colors
19USB Cameras – User Guide
Hardware Installation
USB Components

4.2.2 Cameras with Hirose DF14-15P Connector
Note
The following instructions apply to cameras equipped with a Hirose DF14 connec-
tor only. These are
• all multi-sensor cameras VRmMFC,
• all remote-sensor cameras VRmC-X-E,
• all board-level single-sensor cameras VRm(F)C-X.
It is assumed that you have ordered one of the optional cables “VRmDC/FC-X-
DF14-Open” or “VRmC-X OEM Interface Cable” (2.3 on page 13).
Connecting the camera:
1. Connect the supplied cable with the Hirose DF14 plug to the camera’s receptacle
(Fig. 5 on page10).
2. The other end of the cable splits into open ends or receptacles for trigger, strobe,
and external power supply, depending on the accessory kit you ordered (Fig. 10
on page18). Connect trigger and strobe, if required.
fView the cable plan for a detailed description (7.1 on page 34).
3. Connect the USB cable to the camera’s USB port.
4. Continue with 4.3 on page 23 and read the information on power supply.
USB Cameras – User Guide20
USB Components
Hardware Installation