Baumer-GAPI 2 SDK
Installation Guide for Microsoft ® Windows ®
2
Table of Contents
1. Introduction
2. Technical Background
2.1 Interfaces
2.2 Baumer-GAPI2
2.2.1 Components of the Baumer-GAPI 2 stack
3. General System Requirements
4. Installation
4.1 Hardware Installation / Configuration
4.1.1 Hardware Driver for Intel ® Chipset
4.1.2 Configuration of Link Aggregation (LAG)
4.1.3 Receive Buffer Configuration
4.2 Software Installation
4.2.1 Preliminary steps
4.2.2 Installation of Baumer-GAPI2
4.2.3 Installation of Baumer Filter Driver
5. Removal
5.1 Removal Baumer Filter Driver
3
3
3
3
3
4
4
4
5
6
7
8
8
9
11
12
12
5.2 Removal of Baumer-GAPI2 13
6. Network Settings 14
6.1 IP Configuration 14
6.2 Configuration of “Jumbo Frames” 15
6.2.1 Configuration of “Jumbo Frames” - Single-GigE 15
6.2.2 Configuration of “Jumbo Frames” - Dual-GigE 16
7. Support 17
1. Introduction
This installation guide addresses both users who wish to change camera settings, make and view camera images as well as programmers who need to integrate Baumer cameras in their own software.
and to the .NET™ Framework on Windows ® operating systems respectively, which in turn allow the use of other languages such as C# or VB.NET.
The software package includes:
2. Technical
Background
▪
▪
Tools
Camera Explorer
▪
IP Config Tool Tool
GigE Driver Manager
2.1 Interfaces
BGAPI2 supports the following interfaces:
▪
▪
GigE Interface
Baumer GigE Filter Driver
GigE Producer
▪ GigE
▪
▪
SDK
C++, C# Interface
▪
Examples for C++, C#
Libraries
2.2 Baumer-GAPI2
Baumer-GAPI2 is the abbreviation for Baumer “ Generic Application
Programming Interface” in version
2. With this API Baumer provides an interface for optimal integration and control of Baumer cameras with Gigabit Ethernet(GigE) interface.
Baumer GAPI2 based on GenI-
Cam. GenICam is a standard and stands for Generic Interface for
Cameras. The goal of the standard is to decouple industrial camera interfaces technology from the user application programming interface
(API). Baumer GAPI2 has an GenI-
Cam interface.
It provides interfaces to several programming languages as C++
Application (image processing interface writ en by the customer)
▪
▪
▪
▪
Documentations
Programmer´s Guide
Installation Guide
Documentation IP Config Tool
Documentation Camera Explorer
2.2.1 Components of the
Baumer-GAPI 2 stack
Below is described the BGAPI stack by the use of GigE.
Working with Baumer Gigabit Ethernet cameras requires the installation of matching hardware ( A) and a network interface card (NIC) which supports GigE, on your PC.
Baumer recommends the employment of NICs with Intel ® chipset.
The hardware is delivered with a
Customer
C# module
Framework (OS module)
C# Component
Operating system
Baumer-GAPI2
GenTL Consumer hardware driver ( B) required in order to establish communications between hardware and software.
After the hardware and its driver have been installed, the TCP/IP stack ( C) which covers also the needed UDP is activated. This protocol family controls the data transfer between networked devices.
In standard, both control- and stream data pass through the
TCP/IP stack and are transfered to the interface plug-in - in this case a
Gigabit Ethernet Plug-in ( D).
This plug-in provides interface-specific preprocessing of Baumer-GAPI
( F) commands. The Gig Ethernet plug-in ensures a package structure in accordance with the GigE
Vision™ standard.
The Baumer Filter Driver ( E) offers the option of separating stream data form network and control data. In turn, this allows network and control data to continue to pass through the TCP/IP stack, but stream data are transferred directly to the Gigabit Ethernet plug-in.
Use of the Baumer Filter Driver increases your system’s performance and is therefore recommended.
As previously stated, Baumer-GAPI
( F) supports several programming languages in order to create an application ( H). Therefor the respective header file must be included to your project. In order to work with
.NET™ Framework from v4.0 ( G) is required in order to work with C#. .
This Framework represents a software platform, which provides a runtime environment, an API and several programmer services.
Image L brary
Image p ocessing
Color management
Algor thms
C++ API interface X
Plug in
Baumer GAPI2 Library
GenTL Producer
Baumer
Driver X
Hardware
Dr ver X
Gigabit E hernet
Plug in
TCP/IP stack
Baumer F lter Driver
(opt ona ) ver
Hardware
Driver NIC
Hardware Driver
Hardware
Hardware X
Fig. 1: BGAPI2-Stack
N twork Inte ace
Card (NIC)
3
5. General System Requirements
CPU
Clock
RAM
Operating system
(OS)
Graphics
Ethernet
Framework
(optional)
Single-camera system
Recommended
DUAL-Core, Intel ® Xeon ® W3503
2.4 GHz
4 GB
Multi-camera system
Recommended
DUAL-Core, Intel ® Xeon ® W3503
2.4 GHz
4 GB
Microsoft ® Windows ® 7 32 / 64 bit systems
Microsoft ® Windows ® 8 32 / 64 bit systems
Recommended resolution: 1280 x 1024; Color depth: at least 16 bit
Gigabit Ethernet compliant NIC (Recommended: Intel ® chipset)
Windows ® OS: .NET™ Framework 4.0 or higher for C# implementation
6. Installation
6.1 Hardware Installation /
Configuration
Caution
Observe precautions for handling electrostatic sensitive devices!
▪
▪
▪
▪
▪
▪
Network Card (see Fig. 1)
Switch the PC off (A).
Disconnect the power supply (B).
Open the PC housing (C).
Place the Network Card into an unused PCI port (If nessacary, remove the interface slot cover)
(D).
Close the PC housing (E).
Connect the power supply of the
PC (H).
▪
Camera (see Fig. 2)
▪
▪ Connect the camera to the GigE board (1) using an appropriate cable (at least Cat-5e).
If required, connect a trigger and/
▪ or flash to the Digial-IO supply
(3).
Connect the camera to power supply (4).
power supply unit
PCI slots
Fig. 1: Installation of the GigE board open wire
4
▪
▪
Feedback of the camera (e.g.SXG):
Power on: LED green
Readout active: LED yellow
Notice
To use the camera, the appropriate drivers for the network card must be installed.
Fig. 2: Installation example (Dual-GigE; e.g. HXG/SXG)
1 - Network Interface card (NIC); 2 - GigE cable;
3 - Process interface cable; 4 - Power cable side plate
6.1.1 Hardware Driver for Intel ®
Chipset
Because Windows ® does not include drivers for GigE boards with
Intel ® chipset, they need to downloaded from Intel ® Website.
Notice
Download the latest driver for your Operating System from: http://www.intel.com/support/network/sb/CS-006120.htm
▪ Start the downloaded file and follow the screen instructions.
→The setup program then extracts
the required files and opens a
welcome screen.
▪ Click “Next ›“ takes you to the license agreement. Read it carefully and place a checkmark next to the statement, “I accept the terms of the license agreement”, then click on “Next ›“.
▪ In this step (see Fig. 3) activate the checkboxes for:
▪ Intel ® PROSet for Windows*
Device Manager
▪ Advanced Network Services
The Simple Network Management
Protocol (SNMP) is not required.
▪ Click on “Next ›“ opens an information screen. Here, click on “Install” to start the installation process.
▪ Once the installation has been completed, click on “Finish”.
Fig. 3: Setup Options for the GigE hardware driver
5
6
6.1.2 Configuration of Link Aggregation (LAG)
Link Aggregation (LAG) allows grouping the two links of a Dual-GigE camera (e.g. HXG/SXG) to form a “virtual” link, enabling the camera to treat the LAG as if it was a single link.
To connect the a Dual-GigE camera to host using LAG will required two host Ethernet adapter ports. Follow the steps below to setup LAG under Windows 7.
1.
4.
5.
2.
3.
6.
7.
Press Start, then choose Control
Panel.
Click on Hardware and Sound.
Select Device Manager.
Click on the Network Adapter.
Make a right click on Adapter device
name.
Select Properties.
Choose the Teaming tab.
Notice
This tab is only available at Intel
Driver (e.g. Intel NIC Treiber 16.3
- 16.8 Win7), not in Win7-standard
Driver!
8.
9.
Select Team the adapter with other adapter.
Click on New Team.
The New Team Wizard window will open. Choose a team name. Click Next.
Select the desired adapters corresponding to the ports to be used by the camera and click Next.
Choose the team type: Static Link Aggregation.
Click Next.
→ The configurated adapter will now available in the Network Connection window.
8.
9.
6.
7.
3.
4.
1.
2.
5.
6.1.3 Receive Buffer Configuration
Use this setting to specify the number of Receive Buffers that the network adapter uses when copying data to memory. Increasing this value can enhance receive performance.
We recommend to increase the value. Make the settings for both network adapters!
Press Start, then choose Control Panel.
Click on Hardware and Sound.
Select Device Manager.
Click on the Network Adapter.
Make a right click on Adapter device
name1.
Select Properties.
Choose the tab Advanced.
Select Performance Options → Properties
Choose Receive Buffers and set the Value to 2048. Click OK.
10.
Repeat the process for Adapter device
name2.
7
8
6.2 Software Installation
6.2.1 Preliminary steps
In preparation for the installation of actual Baumer software package, examine the following items:
▫ Has any other version of the BGAPI 2 software already been installed on your system, we recommend to remove it.
Notice
Coexisting versions of BGAPI 1 and BGAPI 2 on the system represent no problem.
Checking the version of the Microsoft ® .NET™ Framework
Which version of Microsoft ® .NET™ Framework is installed on your system? Version 4.0 is required for the C# examples.
To check this, open “Start“ →
“Control Panel” → “Add or Remove
Programs”.
If one or more entries are labeled
“Microsoft .NET™ Framework
4”, the correct version has been installed.
Notice
You can download the version 4 of Microsoft ® .NET™ Framework from: http://www.microsoft.com/download/en/details.aspx?id=17718
Fig. 4 : Add or Remove Program screen
6.2.2 Installation of Baumer-
GAPI2
▪ Insert the BGAPI2-CD into the CD drive.
▪ If autorun not enabled, start the
BaumerGAPISDKInstaller_v2.xx.
exe from the CD.
→ BGAPI2 Start Screen appears.
▪ Click on the Button Next>.
▪ Accept the Licence Agreement and click on the button Next>.
Fig. 5: Start
▪ Choose a Setup Type.
Notice
The filter driver need to be installed with the Baumer Driver
Manager (see chapter 6.2.3, page
11).
Fig. 6: Licence
Fig. 7: Setup Type
9
▪ Choose whether a Desktop Icon and an entry in the Start menu will be created.
▪ Click on the Button Install.
▪ The installation progress is displayed with a progress bar.
Fig. 8: Installation
10
▪ Click on the Button Finish> to complete the installation.
Fig. 9: Progress bar
Fig. 10: Installation Finish
6.2.3 Installation of Baumer
Filter Driver
Notice
With Baumer Filter Driver the option of separating of stream data from network and control data is available.
In turn, this allows network and control data to continue to pass through the TCP/IP stack, but stream data are transferred directly to the GigE Vision™ plugin.
This increase the performance.
▪ In order to install the Baumer
Filter Driver you must start the
“Baumer Driver Manager”
Start → All Programs → Baumer
→ Baumer GAPI SDK → GigE
Driver Manager (e.g. Win 32)
▪ In order to properly configure the correct driver for your equipment, the installation tool needs to know which network adapters have been installed on your PC. Therefore, click on “Install” to call up a list of all available network adapters.
▪ This may take a few moments during which “Please wait” is displayed.
› Meanwhile the following message can be displayed repeatedly:
Fig. 11: Filter Driver Manager
Fig. 12: Driver selection
(and deselect all others).
▪ Click “Apply” to adopt your selection. After that click “OK” to run the installation process.
› In this case, simply click on “Install”
Notice
The number of repetitions depends on the number of network adapters on your PC.
▪ Once the network adapters have been detected, simply select the
Gigabit Ethernet adapter to which the camera has been connected
11
12
▪ Finally, the application may ask you to restart your PC. Click “OK” to initiate a restart.
7. Removal
7.1 Removal Baumer Filter
Driver
▪ In order to remove the Baumer
Filter Driver you must start the
“Baumer Driver Manager”
Start → All Programs → Baumer →
Baumer GAPI SDK → GigE Driver
Manager (e.g. Win 32)
▪ Select the Gigabit Ethernet adapter to which the camera has been connected (and deselect all others).
▪ Finally click the “Uninstall” button and the uninstalling process begins.
Fig. 13: Filter Driver Uninstall
7.2 Removal of Baumer-
GAPI2
Start → All Programs → Baumer
→ Baumer GAPI SDK → Modify,
Repair or Remove Program
▪ Click on the Button Remove.
▪ The Removal progress is displayed with a progress bar.
Fig. 14: Start
▪ Click on the Button Finish to finish the Removal Process.
Fig. 15: Progress bar
Fig. 16: Removal Finish
13
14
8. Network Settings
8.1 IP Configuration
In order to configure the network settings for the transfer of data between the camera and your PC, follow the steps listed below:
▪ Select “Start” → “Control Panel”
→ “Network Connections” to open the “Local Area Connection Properties” window.
▪ Double click on the camera’s network connection
Notice
Look for the “Device Name” of the network adapter to which the camera is connected.
▪
▪
Next, scroll to the bottom of the
“This connection uses the following items:” field in the “General” register and mark the “Internet
Protocol (TCP/IP)” entry before clicking the “Properties” button.
This calls up the “Internet Protocol
(TCP/IP) Properties” window.
Fig. 17: Local Area Connection Properties
▪
▪
Here, select the “Obtain an IP address automatically” and “Obtain
DNS server address automatically” items.
Confirm your selection by clicking
“OK”.
Notice
The camera uses the following
methods to request an IP adress:
1 st
2
3 nd rd
Persistent IP
DHCP (Dynamic Host
Configuration Protocol)
LLA (Link-Local Address)
Depending on which method is used, the allocation of the IP adress may take up to 2-3 minutes.
The assignment of a persistent
IP adress is facilitated by several tools such as the „Baumer-GAPI
Viewer“
Fig. 18: Internet Protocol (TCP/IP) Properties
▪ Connect the camera to the PC and wait until the IP adress has been allocated (max. 2-3 minutes).
8.2 Configuration of
“Jumbo Frames”
In order to increase camera system efficiency and performance, socalled “Jumbo Frames” need to be configured.
Notice
Jumbo Frames are Ethernet frames, which exceed the standard frame size of 1518 bytes.
Typical sizes include for example
4, 9, 12 or 16 KB.
However, there is no standard for
Jumbo Frames, their size depends on the manufacturer.
They are used to decrease the interrupt load of all involved network devices.
In order to use Jumbo Frames all network components must support this feature.
The Figure schematically shows
“Jumbo Frames” in comparison with standard Ethernet frames concerning throughput and CPU load.
8.2.1 Configuration of “Jumbo Frames” - Single-GigE
7.
8.
5.
6.
3.
4.
1.
2.
9.
Press Start, then choose Control Panel.
Click on View network status and tasks.
Click Local Area Connection.
Click on Button Properties.
Click on Configure....
Choose the tab Settings.
Click on the tab Advanced.
Choose Jumbo Packet and set the Value to highest possible value
Confirm this setting with OK.
Standar d E ther
Jumbo F net F rames rames
Troughput
Fig. 19 : Advantages of Jumbo Frames
You have set now the Jumbo Frames for the Single-GigE adapter.
15
16
8.2.2 Configuration of “Jumbo Frames” - Dual-GigE
3.
4.
1.
2.
5.
6.
7.
8.
Press Start, then choose Control Panel.
Click on View network status and tasks.
Click Local Area Connection.
Click on Button Properties.
Click on Configure....
Choose the tab Settings.
Click on the tab Advanced.
Choose Jumbo Packet and set the Value to 9014 Byte.
9.
All devices in a team must have the same value for Jumbo Packets. The value for adapter 2 will be set automatically.
Confirm the message with OK.
10.
Confirm the momentarily lose of the connectivity with Ok.
You have set now the Jumbo Frames for both adapters.
9. Support
If you have any problems with the installation, then feel free to contact our support.
Worldwide
Baumer Optronic GmbH
Badstrasse 30
DE-01454 Radeberg, Germany
Tel: +49 (0)3528 4386 845
Mail: [email protected]
Website: www.baumer.com
17
Baumer Optronic GmbH
Badstrasse 30
DE-01454 Radeberg, Germany
Phone +49 (0)3528 4386 0 · Fax +49 (0)3528 4386 86 [email protected] · www.baumer.com
