Allied Vision Technologies GigE Cameras User manual

Installation Manual
GigE Vision Cameras
V1.2.0
20 March 2015
Allied Vision Technologies GmbH
Taschenweg 2a
D-07646 Stadtroda, Germany
Allied Vision GigE Cameras

AVT GigE Cameras Installation Manual V1.2.0
2
Legal notice
Trademarks
Microsoft, Windows, and Windows 7 are either registered trademarks or trade-
marks of Microsoft Corporation in the United States and/or other countries.
Unless stated otherwise, all trademarks appearing in this document of Allied
Vision Technologies are brands protected by law.
Warranty
The information provided by Allied Vision Technologies is supplied without any
guarantees or warranty whatsoever, be it specific or implicit. Also, excluded are
all implicit warranties concerning the negotiability, the suitability for specific
applications or the non-breaking of laws and patents. Even if we assume that
the information supplied to us is accurate, errors and inaccuracy may still occur.
Copyright
All texts, pictures and graphics are protected by copyright and other laws pro-
tecting intellectual property. It is not permitted to copy or modify them for
trade use or transfer, nor may they be used on websites.
Allied Vision Technologies GmbH 03/2015
All rights reserved.
Managing Director: Mr. Frank Grube
Tax ID: DE 184383113
Headquarters:
Taschenweg 2a
D-07646 Stadtroda, Germany
Tel: [phone]
Fax: [phone]
e-mail: [email protected]

AVT GigE Cameras Installation Manual V1.1.0
3
Contents
Contacting Allied Vision .................................................................................. 5
Introduction ............................................................................................................ 6
Document history............................................................................................................ 6
Manual conventions......................................................................................................... 7
Styles ....................................................................................................................... 7
Symbols.................................................................................................................... 7
Additional information..................................................................................................... 8
Allied Vision accessories............................................................................................... 8
Allied Vision software .................................................................................................. 8
Safety instructions ............................................................................................10
General safety instructions.............................................................................................. 10
Sensor safety instructions............................................................................................... 11
Changing filters safety instructions................................................................................... 11
Safety instructions for board level cameras (only Manta and Prosilica GB) ................................ 12
Getting started.....................................................................................................14
GigE Vision camera.................................................................................................... 14
Optics..................................................................................................................... 14
GigE Vision software .................................................................................................. 15
Overview of installation.................................................................................................. 15
Installing hardware............................................................................................16
Installing Gigabit Ethernet network card............................................................................ 16
Configuring Ethernet adapter .......................................................................................... 17
Installing Ethernet adapter driver ................................................................................ 17
Modifying Ethernet adapter IP address .......................................................................... 17
Optimizing Ethernet adapter ....................................................................................... 19
Installing camera software...........................................................................22
Overview of software installation...................................................................................... 22
Downloading camera drivers............................................................................................ 22
Installing VIMBA Viewer ................................................................................................. 22
Installing GigE Sample Viewer.......................................................................................... 24
Starting the camera ..........................................................................................25
Power up ..................................................................................................................... 25
Connect to host application............................................................................................. 25
Using Allied Vision viewer applications ................................................26
Using VIMBA Viewer....................................................................................................... 26
Launching application ............................................................................................... 26

AVT GigE Cameras Installation Manual V1.1.0
4
Opening live view: Viewer toolbar................................................................................. 27
Adjusting camera controls: Controller window ................................................................ 28
Camera information: Information window ...................................................................... 28
Live histogram ......................................................................................................... 29
Using GigE Sample Viewer ............................................................................................... 30
Launching application ............................................................................................... 30
Opening live view...................................................................................................... 30
Adjusting camera controls .......................................................................................... 31
Live histogram ......................................................................................................... 31
Camera information................................................................................................... 31
Event channel .......................................................................................................... 32
RS232 serial interface................................................................................................ 33
Seek camera ............................................................................................................ 33
Exporting camera settings .......................................................................................... 34
Modifying camera IP address ....................................................................35
For VIMBA users ............................................................................................................ 35
For PvAPI users ............................................................................................................. 36
Using multiple cameras..................................................................................38
Single Ethernet port .................................................................................................. 39
Multiple Ethernet ports .............................................................................................. 40
Implementing link aggregation ..................................................................42
When is LAG needed? ..................................................................................................... 42
Configuring Link Aggregation .......................................................................................... 43
Multicasting configuration............................................................................46
Troubleshooting ..................................................................................................47
Is the camera getting power? ...................................................................................... 47
Is the camera powered, but not detected in viewer? ......................................................... 47
Is the camera listed in Viewer but can't acquire images? ................................................... 49
How to minimize/eliminate dropped packets? ................................................................ 50
Troubleshooting for Bigeye G cameras only (IOD mode) .................................................... 51
Additional references ......................................................................................52
Index...........................................................................................................................53

AVT GigE Cameras Installation Manual V1.1.0
5
Contacting Allied Vision
Contacting Allied Vision
Info

•Technical information:
http://www.alliedvision.com
•Support:
[e-mail]
Allied Vision Technologies GmbH (Headquarters)
Taschenweg 2a
07646 Stadtroda, Germany
Tel.: [phone]
Fax: [phone]
e-mail: [e-mail]
Allied Vision Technologies Canada Inc.
101-3750 North Fraser Way
Burnaby, BC, V5J 5E9, Canada
Tel.: [phone]
Fax: [phone]
e-mail: [e-mail]
Allied Vision Technologies Inc.
38 Washington Street
Newburyport, MA 01950, USA
Toll Free number +1 877-USA-1394
Tel.: [phone]
Fax: [phone]
e-mail: [e-mail]
Allied Vision Technologies Asia Pte. Ltd.
82 Playfair Road
#07-02 D’Lithium
Singapore 368001
Tel.: [phone]
Fax: [phone]
e-mail: [e-mail]
Allied Vision Technologies (Shanghai) Co., Ltd.
2-2109 Hongwell International Plaza
1602# ZhongShanXi Road
Shanghai 200235, China
Tel.: [phone]
Fax: [phone]
e-mail: [e-mail]

AVT GigE Cameras Installation Manual V1.1.0
6
Introduction
Introduction
This GigE Installation Manual provides instructions for first time use of Allied
Vision GigE cameras. Powering up the camera, installing Allied Vision drivers
and related software, and enabling users to get the camera up and running are
the focus of this document.
For information on camera dimensions, feature overview, I/O definition, trigger
timing waveforms, frame rate performance, and camera cleaning instructions
please refer to the Allied Vision Technical Manuals unique for each camera
family.
For detailed information on camera features and controls specific to the Allied
Vision GigE cameras refer to the GigE Camera and Driver Attributes and GigE
Features Reference documents.
Document history
www

Allied Vision product literature:
http://www.alliedvision.com/en/support/technical-
documentation
Version Date Remarks
V1.0.0 2013-Jul-04 New Manual – RELEASE Status
V1.0.1 2013-Oct-02 • Added information on how to minimize/eliminate dropped packets on
page 50
• Removed camera cleaning section from the manual
• Updated links for PvAPI SDK and Gigabit Ethernet cameras home page
throughout the manual
V1.1.0 2014-Jul-22 • Added Goldeye G
• Updated Index
V1.2.0 2015-Mar-20 • Updated Allied Vision logo
• Replaced old links with new Allied Vision website links
• Changed file name from ‘GigE Camera and Driver Features’ to ‘GigE Fea-
tures Reference’
Table 1: Document history

AVT GigE Cameras Installation Manual V1.1.0
7
Introduction
Manual conventions
To give this manual an easily understood layout and to emphasize important
information, the following typographical styles and symbols are used:
Styles
Symbols
Style Function Example
Bold Programs, inputs, or
highlighting important
information
bold
Courier Code listings etc. Input
Upper case Register REGISTER
Italics Modes, fields Mode
Parentheses and/or blue Links (Link)
Table 2: Styles
Note

This symbol highlights important information.
Caution

This symbol highlights important instructions.
You have to follow these instructions to avoid
malfunctions.
www

This symbol highlights URLs for further information.
The URL itself is shown in blue.
Example:
http://www.alliedvision.com

AVT GigE Cameras Installation Manual V1.1.0
8
Introduction
Additional information
This section provides information on accessories and available software for
Allied Vision GigE cameras.
Allied Vision accessories
Allied Vision software
All software packages provided by Allied Vision are free of charge and contain
the following components:
•Drivers
• Software Development Kit (SDK) for camera control and image acquisition
• Examples based on the provided APIs of the SDK
• Documentation and release notes
• Viewer application to operate/configure the cameras
Note

Allied Vision offers a wide range of accessories for the use of
Allied Vision GigE cameras and the easy integration in already
existing applications.
•Gigabit Ethernet accessories including standard GigE
components as well as PoE capable GigE components.
•Lenses for corresponding sensor sizes and resolutions.
(Contact Allied Vision Support for further information.)
www

Accessories:
Please contact Allied Vision sales representative or your local
Allied Vision dealer for information on accessories:
http://www.alliedvision.com/en/about-us/where-we-
are.html
For more information on third-party hardware components
tested with Allied Vision GigE cameras, read:
Application Note: Hardware Selection for Allied Vision GigE
Cameras:
http://www.alliedvision.com/fileadmin/content/documents/
products/cameras/various/appnote/
Hardware_Selection_for_Allied_Vision_GigE_Cameras.pdf
www

All software packages (including documentation and release
notes) provided by Allied Vision can be downloaded at:
http://www.alliedvision.com/en/support/software-
downloads

AVT GigE Cameras Installation Manual V1.1.0
9
Introduction
Third-party software
In addition to the software provided by Allied Vision, there are numerous GigE
Vision Standard compliant third-party software options available. In general,
third-party software provides increased functionality such as image processing
and video recording.
Allied Vision’s Vimba SDK is based on the GenICam standard. GenICam-based
third-party software automatically connects with Vimba's transport layers.
Additionally, Vimba includes the Cognex Adapter for VisionPro.

AVT GigE Cameras Installation Manual V1.1.0
10
Safety instructions
Safety instructions
This chapter describes safety instructions/cautions valid for Allied Vision GigE
cameras and special safety instructions/cautions depending on the camera
model used.
General safety instructions
Note

• There are no switches or parts inside the camera that
require adjustment. The guarantee becomes void upon
opening the camera casing.
• If the product is disassembled, reworked or repaired by
anyone other than a recommended service person, Allied
Vision or its suppliers are not responsible for the
subsequent performance or quality of the camera.
•Thecameradoesnot generate dangerous voltages inter-
nally.
Note

IR cut filters for visible light cameras:
All color models are equipped with an optical filter to elimi-
nate the influence of infrared light hitting the sensor. Please
be advised that, as a side effect, this filter reduces sensitivity
in the visible spectrum. See camera technical manual for the
location of IR cut filter.

AVT GigE Cameras Installation Manual V1.1.0
11
Safety instructions
Sensor safety instructions
Changing filters safety instructions
Caution

Sensor may be damaged
Light intensity or exposure time exceeding the saturation of
the sensor may damage the sensor irreparably.
This may occur in the following situations:
• Laser light hitting the sensor directly
• Bright light sources (e.g. sunlight) hitting the sensor
directly
• Camera is exposed to X-rays
Damages may be caused by:
• Overheating of color filters, microlenses or pixel struc-
tures
• Accelerated aging of color filters or pixel structures
Caution

To avoid sensor damage
• Use light source with lower intensity
• Use external shutter
• Use optical filters
• Use lens cap (when camera not in use)
• Vary local light spot / laser spot on sensor
•X-rays:
– Keep camera out of X-ray path. Guide light source via
mirrors to the sensor
– Use lead glass to protect lens and sensor
– Use lead jacket for the body of the camera
The warranty does not cover damaged cameras caused by
X-ray applications or too much light/laser light.
Caution

• Mount/dismount lenses and filters in a dust-free envi-
ronment, and do not use compressed air (which can push
dust into cameras and lenses).
•Useonlyoptical quality tissue/cloth if you must clean a
lens or filter.
Ask your dealer if you are not familiar with these procedures.

AVT GigE Cameras Installation Manual V1.1.0
12
Safety instructions
Safety instructions for board level cameras (only
Manta and Prosilica GB)
Note

Read the Manta / Prosilica GB Technical Manual and these
safety instructions before use.
Abuse or misapplication of the camera may result in limited
warranty or cancellation of warranty.
Caution-ESD Board level cameras: ESD warnings
• Board level cameras are delivered without housing.
Handle the sensor board and main board with care. Do
not bend the boards. Do not touch the components or
contacts on a board. Hold a board by its edges.
• Sensor board and main board are sensitive to
electrostatic discharge. To avoid possible damage, handle
all static-sensitive boards and components in a static-
safe work area. Follow the procedures below.
• ESD (electrostatic discharge): Static electricity can
damage the sensor board or the main board of your board
level cameras. To prevent static damage, discharge static
electricity from your body before you touch any of your
broad level camera’s electronic components, such as
sensor board or main board. To do so, use a static-safe
work area with static-dissipative mat and wear a static-
dissipative wrist strap. Do not hold any components of
your board level cameras against your clothing. Even if
you are wearing a wrist strap, your body is grounded but
your clothes are not.
• Do not remove the sensor board and main board from its
anti-static packaging unless your body is grounded.
•ESD shielding: To protect the boards from radiation of
other modules or devices use a special ESD protective
housing.

AVT GigE Cameras Installation Manual V1.1.0
13
Safety instructions
Caution

Board level cameras: General warnings
• Be sure that all power to your board level camera is
switched off before mounting the sensor board or making
connections to the camera.
• Do not connect or disconnect any cables during an
electrical storm.
• Do not use your board level cameras during an electrical
storm.
• To help avoid possible damage to the sensor board or
main board, wait 5 seconds after power is switched off,
before connecting or disconnecting any cable to the
board level cameras.
• Keep your board level cameras away from radiators and
heat sources.
• Avoid contact of board level cameras with liquids.
Caution

Board level cameras: Loading
• Avoid any mechanical forces to the board level cameras,
the boards and its components, especially torsional, ten-
sile and compressive forces.
• To avoid damages of the boards, provide cables with an
external pull relief so that no force is applied to the con-
nectors itself.
Caution

Board level cameras: Dirty environments
• Always use clean boards.
• To protect the board level cameras from debris always use
in a clean environment or a protective housing.

AVT GigE Cameras Installation Manual V1.1.0
14
Getting started
Getting started
This chapter describes the components required for your camera system:
GigE Vision camera
Allied Vision offers the following GigE Vision camera families:
This guide can be applied to all of these families. Follow the links below to learn
more about GigE cameras from Allied Vision.
Optics
Allied Vision GigE cameras offer various mechanical interfaces for installing a
lens including C-Mount, CS-Mount, F-Mount, M12-Mount, M42-Mount, M58-
Mount, and Canon EF-Mount. Lenses can be purchased directly from Allied
Vision or from an Allied Vision distributor. Users need to select the desired focal
length and appropriate optical format for the target camera model.
–BigeyeG
– Goldeye G
–Mako
–Manta
–ProsilicaGB
–ProsilicaGC
–ProsilicaGE
–ProsilicaGS
–ProsilicaGT
–ProsilicaGX
www

Follow this link to learn about GigE cameras from Allied Vision.
http://www.alliedvision.com/en/products/cameras
www

See Modular Concept for more information on mechanical
interface options for specific Allied Vision GigE cameras:
http://www.alliedvision.com/fileadmin/content/documents/
products/cameras/various/modular-concept/
Modular_concept_external.pdf
www

Allied Vision offers a number of lenses.
• To purchase a lens, please contact Allied Vision sales rep-
resentative or your local Allied Vision dealer:
http://www.alliedvision.com/en/about-us/where-we-
are.html
• For assistance in choosing a suitable lens for your Allied
Vision GigE camera, please contact
suppor[email protected].

AVT GigE Cameras Installation Manual V1.1.0
15
Getting started
GigE Vision software
Allied Vision provides several software packages that support our GigE Vision
cameras. User can target the following operating systems and a variety of CPU
architectures:
• Windows, Linux (supported by both VIMBA and PvAPI SDKs)
• QNX or OSX (supported by PvAPI SDK only)
Allied Vision GigE cameras are GigE Vision v1.2 compliant. This means they are
compatible with third-party software which offers a GigE Vision driver.
Overview of installation
This is an overview of the installation process: follow the hyperlinks to read the
step-by-step instructions.
• Install Gigabit Ethernet network card and configure network card (Jumbo
Frames, Receive Descriptors, Performance Options and IP address set-
tings):
See chapter Installing hardware on page 16.
• Install Allied Vision SDKs plus corresponding Viewers:
See chapter Installing camera software on page 22.
• Connect camera to PC or laptop and ensure that the camera is powered:
See chapter Starting the camera on page 25.
•AcquiringyourfirstimagewithVIMBA Viewer and GigE Sample Viewer:
Read chapter Using Allied Vision viewer applications on page 26.
www

VIMBA is Allied Vision's future-proof SDK for all current and
upcoming Allied Vision cameras with GigE Vision, FireWire
(IEEE 1394) and USB Vision interfaces. Visit the link below for
more information.
http://www.alliedvision.com/en/products/software
www

PvAPI SDK supports all GigE Vision cameras from Allied Vision
on various operating systems, including Windows, Linux, OSX
and QNX. See Legacy Software section of the following web
page for more information.
http://www.alliedvision.com/en/support/software-
downloads

AVT GigE Cameras Installation Manual V1.1.0
16
Installing hardware
Installing hardware
This chapter describes the hardware installation and configuration of Gigabit
Ethernet network cards (PC or laptop) for optimum system performance when
using a GigE Vision camera.
Installing Gigabit Ethernet network card
GigE Vision cameras can operate on 10/100, or Gigabit speed Ethernet adapt-
ers. In order to take advantage of maximum camera frame rates, a Gigabit speed
adapter is required.
If your host computer has an available Ethernet port, this can be used with
Allied Vision GigE cameras. We recommend that your camera system uses a ded-
icated Ethernet port not shared with internet or local area networks. If more
ports are needed, or your existing Ethernet adapter is unable to operate at Giga-
bit Ethernet speeds, installing additional hardware may be required.
For desktop systems Use a PCI Express bus Ethernet adapter.
For laptops Use an expansion slot via an ExpressCard.
Note

Verify that there is an available and compatible interface slot
on the host computer before purchasing the desired Ethernet
adapter card.
www

For a list of Ethernet adapters available for purchase from
Allied Vision, please contact Allied Vision sales representative
or your local Allied Vision dealer:
http://www.alliedvision.com/en/about-us/where-we-
are.html
www

A list of Allied Vision recommended Ethernet adapters is avail-
able on the Allied Vision website.
http://www.alliedvision.com/fileadmin/content/documents/
products/cameras/various/appnote/
Hardware_Selection_for_Allied_Vision_GigE_Cameras.pdf
Caution

Allied Vision recommends Category 6 or higher rated Ethernet
cables. A different rating may not sustain peak interface band-
width; leading to lost connectivity or image data coming from
the camera.

AVT GigE Cameras Installation Manual V1.1.0
17
Installing hardware
Configuring Ethernet adapter
1. PC: Install the (second) Gigabit Ethernet network card in your host computer
according to the instructions you got from your network card manufacturer.
Laptop: Insert the Gigabit Ethernet ExpressCard into your laptop.
2. Cancel the Found new Hardware Wizard window that may appear when Win-
dows detects your network card.
Installing Ethernet adapter driver
3. Install the network card driver from your network card manufacturer. This
manual references the Intel Gigabit CT series, an equivalent can be found from
other manufacturers.
Run installation application provided by driver manufacturer. If no installation
application is provided, update the driver manually:
[Windows 7]
–Start
–Control Panel
–Hardware and Sound
–Device Manager
–ExpandNetwork Adapter
– Right-click Adapter device name
–Properties
–Driver tab
–Update driver
–Install from specific location
(identify installation directory)
Modifying Ethernet adapter IP address
4. After initial Ethernet adapter hardware installation, connect the Ethernet
adapter directly to the camera. The default configuration assigns an IP address
automatically using the Link-Local Address range of 169.254.xxx.xxx or an
address defined the by the DHCP server, if present.
www

Follow the link below to download the latest drivers
for Intel adapters.
http://www.intel.com/p/en_US/support/detect
Figure 1: Adapter properties, driver tab,
Windows 7

AVT GigE Cameras Installation Manual V1.1.0
18
Installing hardware
Users can fix the adapter address to minimize the time required for a camera to
be recognized by the host application. Systems that employ multiple Ethernet
adapters connected to multiple cameras will also be required to fix the address
of the Ethernet adapter.
[Windows 7]
–Start, Control Panel
–Network and Internet
–View network status and tasks
–Change adapter settings
– Right-click Network Connection
–Properties
– Select Internet Protocol Version
4and click Properties
– Select Use the following IP
address:
IP Address: 169.254.100.1
Subnet mask: 255.255.0.0
Default gateway: blank
[Linux]
–Terminal: ifconfig
– Note eth# of NIC connected to
camera
–Terminal: sudo gedit /etc/net-
work/interfaces
–Add/edit:
auto eth6
iface eth6 inet static
address 169.254.100.1
netmask 255.255.0.0
Where, eth6 is name of NIC con-
nected to camera.
Figure 2: Windows - Fixed IP address,
Auto IP range
Figure 3: Interfaces file for static IP,
Linux Ubuntu 10.04

AVT GigE Cameras Installation Manual V1.1.0
19
Installing hardware
[OSX] (PvAPI only)
– System Preferences
–Network
– Select Ethernet, click Advanced
–TCP/IP tab:
Configure IPv4: Manually
IPv4 Address: 169.254.100.1
Subnet Mask: 255.255.0.0
Router: Blank
Optimizing Ethernet adapter
5. The Ethernet adapter should be adjusted to improve system performance when
using a GigE Vision camera. This performance is related to minimizing CPU
usage and dropped or resent packets.
Edit the Ethernet adapter driver properties according to the values in the table
below. The names and availability of the properties listed may vary depending
on adapter manufacturer and model.
Allied Vision GigE camera’s factory/default settings configure the camera
packet size to 8228. The host adapter needs to support a packet size of equal or
larger size to stream from the camera.
Properties Value
Packet size (MTU) 8228 or larger
Interrupt Moderation Rate Extreme
Transmit buffers 256 bytes
Receive buffers Max setting available
Table 3: Ethernet adapter performance settings
Note

If adapter packet size support is limited to 1500 bytes, as on
10/100 speed NICs, the camera packet size can be reduced
using VIMBA Viewer / GigE Sample Viewer and saved to an on
board camera power up config file.
PvAPI users: See ConfigFile in the GigE Camera and Driver
Attributes document.
VIMBA users: See SavedUserSets in the GigE Features Reference
document.
Figure 4: Interfaces file for static IP,
Linux Ubuntu 10.04

AVT GigE Cameras Installation Manual V1.1.0
20
Installing hardware
Adjusting camera packet size
[Windows 7, Intel Gigabit CT]
–Start, Control Panel
–Hardware and Sound
–Device Manager
–Network Adapter
– Right-click Adapter device name
–Properties
–Advanced tab
–Settings: Jumbo Packet - Value:
9014 Bytes
[Linux]
–Terminal: sudo gedit /etc/network/interfaces
–Add: mtu 8228 to appropriate interface.
– Or, to temporarily increase packet size:
Terminal: sudo ifconfig eth0 mtu 8228, where eth0 is the camera NIC.
Note

The settings list in the advanced adapter settings may be dif-
ferent between different types/brands of Gigabit Ethernet net-
work cards. Common expressions are Jumbo Frames or Jumbo
Packet.
If Jumbo Frames or Jumbo Packet does not appear in this list,
your network card may not support it. Without this capability,
you may not be able to achieve the full performance of the
camera.
Figure 5: Setting jumbo packets