Baumer-GAPI SDK Installation Guide for FireWire™ Microsoft

Baumer-GAPI SDK
Installation Guide for FireWire™
Microsoft® Windows®
Table of Contents
1. Introduction
3
2. Technical Background
3
2.1. Characteristics of Baumer-GAPI
2.1.1. Components of the Baumer-GAPI stack
3
3
3. System requirements
4
2.2. Installation procedure
4. Installation
4.1. Hardware installation
4.2. Software installation
4.2.1. Preliminary steps
4.2.2. Installation of Baumer-GAPI
4.2.3. Installation of 1394 Plugin
4.2.4. Installation of Baumer OHCI
4.2.5. Installation of Baumer Camera Driver
2
4
5
5
6
6
7
8
9
9
5. Additional Information
10
5.1. Documents Camera
5.1.1. Technical Data Sheets
5.1.2. Product Information
5.2. Documents Software
5.2.1. Programmers Guide
5.2.2. Help File
5.2.3. Source Code Examples
5.2.4. User’s Guide B-GAPI Viewer
5.3. Exit
10
10
10
10
10
10
10
10
10
5.4. E-Mail
Appendix
A1. Installation checklist
10
11
11
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.
2. Technical
Background
It implements one Application Programming Interface (API) for both
Gigabit Ethernet (GigE) and for
FireWire™.
Advantages of Baumer-GAPI:
▪▪ Works with Windows® and Linux®
▪▪ Not restricted to a single interface
▪▪ Support for multiple programming
languages such as C, C++, C#
▪▪ Scalable for new functions and
features
2.1.1. Components of the
Baumer-GAPI stack
2.1. Characteristics of
Baumer-GAPI
Baumer-GAPI stands for Baumer
“Generic Application Programming
Interface”. With this API Baumer offers an interface for optimal integration of Baumer cameras into your
software system.
Working with Baumer FireWire™
cameras requires the installation of matching hardware (A), a
FireWire™ board which supports
IEEE 1394a and/or IEEE 1394b,
on your PC. In order to establish
communications between hardware
Application (image processing interface written by the customer)
.NET™ Framework (module of OS)
Customer
Operating
system
Baumer-GAPI
C# module
C API
C++ API
Image
processing
bgapi.dll
Image Library
Color
management
and software, a OHCI (Open Host
Controller Interface) Driver (B) is
required. In case of FireWire™ b
Baumer recommends the employment of the Baumer OHCI Driver
which fixes a bug in Microsoft®
OCHI with regard to the communication in speed S800.
The Baumer 1394 Driver (C) is approved for optimal communication
between software and
FireWire™ devices.
After the hardware and its drivers
have been installed, the IEEE 1394
stack (D) which covers FireWire™
a and b is activated.
The FireWire™ plug-in (E) provides
interface-specific preprocessing of
Baumer-GAPI (F) commands. It
ensures a package structure in accordance with the IEEE 1394a and
IEEE 1394b standard.
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 v2.0 (G) is
required in order to work with C#. .
Algorithms
interface X
Plugin
FireWire™
Plugin
interface Y
Plugin
Baumer
Driver X
IEEE 1394
stack
Baumer
Driver Y
This Framework represents a
software platform, which provides
a runtime environment, an API and
several programmer services.
Baumer 1394 Driver
Hardware Driver
Hardware
Driver Y
Baumer
OHCI Driver
(optional)
Microsoft®
OHCI Driver
Hardware
Driver Y
Hardware
Baumer-GAPI stack
3
2.2. Installation procedure
Please install the software according to this installation guide. For more information to the installation procedure
or in terms of trouble shooting please see the appendix.
3. System requirements
CPU
Clock
RAM
Operating
system
Graphic
FireWire™
Framework
(optional)
4
Single-camera system
Multi-camera system
Minimum
Recommended
Minimum
Recommended
Intel® Pentium®4 or
®
Intel Core™ Duo comparable processor
comparable processor
2.5 GHz
> 2.5 GHz
2.5 GHz
3 GHz
1024 MB
2048 MB
2048 MB
4096 MB
Microsoft® Windows® XP incl. Service Pack 2 or higher
Microsoft® Windows® XP x64 incl. Service Pack 2 or higher
Microsoft® Windows Vista™ 32 / 64 bit systems
Linux® 32 / 64 bit systems from Kernel 2.6.xx
recommended resolution 1280 x 1024, color depth at least 16 bit
FireWire™ b compliant interface card
Windows® operating systems: .NET™ Framework 2.0 or higher
Linux® operating systems: Mono 1.2.4 or higher
4. Installation
power
supply
unit
side plate
4.1. Hardware installation
▪▪ Turn off the PC
▪▪ Disconnect the power supply
▪▪ Make sure that your body is grounded
▪▪ Open the PC housing
▪▪ Place the FireWire™ board into
an unused PCI port (If nessacary,
remove the interface slot cover)
▪▪ Close the PC housing
▪▪ Connect the camera by using an
appropriate
cable
to
the
FireWire™ board
▪▪ Connect a trigger and/or flash to
the M8 male connector 4pin, if necessary
▪▪ Connect the PC to power supply
PCI slots
Fig. 1: Installation of the FireWire™ board
open wire
▪▪ Turn on the PC
Fig. 2: Installation sample
1 - PCI board; 2 - FireWire™ cable; 3 - Cable for trigger and flash
5
4.2. Software installation
4.2.1. Preliminary steps
In preparation for the installation of
actual Baumer software package,
please examine the following items:
▫▫ Has any other version of the Baumer software already been installed on your system?
›› To check this, open “Start” →
“Control Panel” → “Add or Remove Programs”. If you see an entry
such as “Baumer-GAPI SDK for
Windows” a version has already
been installed. To determine the
version number, click on “Click
here for support information”. If
the installed version number is
less than that of the version provided on the CD, please remove it
and install the current software
version from the CD.
›› In order to use Baumer software,
we propose to uninstall older versions before installing the newest
release. Individual versions are installed in separate folders. Removal of previous versions helps
prevent an accumulation of files
on your hard drive.
▫▫ Which version of Microsoft® .
NET™ Framework is installed on
your system? Version 2.0 or higher is required in order to run the
Baumer-GAPI Viewer.
›› To check this, open “Start“ →
“Control Panel” → “Add or Remove Programs”. If one or more
entries are labeled “Microsoft
.NET™ Framework2.0”, the correct version has been installed.
Otherwise you can find the setup
tool for v 2.0 on the CD in the following folder:
X:\Addons\dotNet Framework\
YOUR SYSTEM TYPE\Version2.0\ dotnetfx.exe
Please install the Framework by
double-clicking the executable
file.
Fig. 3: Start Baumer-GAPI Installation
Fig. 4: Customer Information screen
To start the installation, simply insert the CD and the application will
run automatically.
Fig. 5: Choice of Destination Location for Baumer-GAPI
6
4.2.2. Installation of
Baumer-GAPI
▪▪ In order to install the Baumer
Generic
API
choose
“Baumer-GAPI Installation“ from
the “Install” menu (Fig. 3).
▪▪ Please follow the screen instructions!
▪▪ After selecting your preferred language and passing through the
welcome screen the program calls
up the license agreement.
▪▪ Please read this agreement carefully. Then click “Yes” to agree and
to go on to the information screen
which contains additional information on Gigabit Ethernet.
▪▪ After this the program calls up the
customer information screen
(Fig. 6). Please complete the requested data. This is necessary in
order to complete the installation.
▪▪ The next step is to select the installation destination path. Choose
“Browse...” to change the default
path to that for your desired location (Fig. 7).
▪▪ You can then select the setup type
(Fig. 8). Please select “Complete”
and click “Next ›”. (Selecting “Custom” allows the installation features to be modified, but this is
only recommended for experienced users.)
▪▪ After selecting a program folder in
Windows® start menu (Fig. 9) and
confirming the selection by clicking “Next ›”, the install process
begins. You can monitor the installation status in the progress bar.
▪▪ On the next screen simply click
“Finish” to complete the installation.
▪▪ Even though the setup itself is finished, some processes are still
running in the background. Please
permit the installation to be fully
completed by waiting until the
progress bar (Fig. 10) reaches its
end.
Fig. 6: Choice of Setup Type
Fig. 6: Selection of Program Folder in Windows® start menu
Fig. 8: Progress bar
7
4.2.3. Installation of
1394 Plugin
▪▪ In order to install this plug-in select “1394 PlugIn Installation” from
the
“Install”
menu
(Fig. 9).
▪▪ Please follow the screen instructions!
▪▪ After language selection and the
welcome screen, you will be taken
to the installation selection path
(Fig. 10). You can change the default installation path to the desired location by selecting
“Browse…”
▪▪ You are then taken to the setup
type screen. Please select “Complete” here and click on “Next ›”.
(Selecting “Custom” allows the installation features to be modified,
but this is only recommended for
experienced users.)
▪▪ After selecting the desired program folder in the Windows® start
menu and confirming it by clicking
“Next ›” the install process begins.
You can monitor the setup status
in the progress bar.
▪▪ In the next screen simply click
“Finish” to complete the installation.
▪▪ Even though the setup itself is finished, some processes are still
running in the background. Please
permit the installation to be fully
completed by waiting until the
progress bar (Fig. 11) reaches its
end.
Fig. 9: Start 1394 Plugin Installation
Fig. 10: Choice of Destination Location for 1394 Plugin
▪▪ Note: By clicking the help button
(? in Fig. 9) this Installation Guide
will be opened.
Fig. 11: Progress bar
8
4.2.4. Installation of Baumer
OHCI
▪▪ In order to install the Baumer
OHCI Driver doubleclick „Ohci“ in
„Drivers“ menu (Fig. 12).
▪▪ After that a DOS box will appear.
Here the driver gets installed.
▪▪ This may take a few moments.
›› Meanwhile
this
can be displayed
message
repeatedly.
Fig. 12: Driver selection
In this case click “Continue anyway”.
›› The number of repetitions depends on your pc.
▪▪ Once the installation process is
finished the command line “Press
any key to continue ...” is shown.
▪▪ After you pressed any key the installation is complete and the DOS
box gets closed.
4.2.5. Installation of Baumer
Camera Driver
▪▪ In order to install the Baumer
OHCI Driver doubleclick „Camera
Driver (signed)“ in „Drivers“ menu
(Fig. 12).
▪▪ After that a DOS box will appear.
Here the driver gets installed.
▪▪ This may take a few moments.
›› Meanwhile previously stated message may appear.
▪▪ Once the installation process is
finished the command line “Press
any key to continue ...” is shown.
▪▪ After you pressed any key the installation is complete and the DOS
box gets closed.
9
5. Additional
Information
Some installation tool items must
still be described.
The following provides you with the
required additional information.
5.1. Documents Camera
The “Documents Camera” (Fig. 13)
menu provides you with several
technical documents related to
Baumer Gigabit Ethernet cameras.
These documents are provided in
Portable Document Format (PDF).
5.1.1. Technical Data Sheets
Here you can find engineering
documents related to both Baumer
TXD and TXF cameras.
5.1.2. Product Information
Here some marketing documents
are deposited.
5.2. Documents Software
5.2.1. Programmers Guide
Here you will find the Programmer’s
Guide for Baumer-GAPI SDK in
PDF.
5.2.2. Help File
Here you will find the programming
reference for Baumer-GAPI in CHM
format.
5.2.3. Source Code Examples
Here you will find the programming
examples for Baumer-GAPI.
5.2.4. User’s Guide B-GAPI
Viewer
Here you will find the User’s Guide
for Baumer-GAPI Viewer in PDF.
5.3. Exit
From here you can exit the installation tool and return to your operating system.
5.4. E-Mail
Clicking on the E-Mail symbol
(envelope) opens your E-Mail client
and support@baumeroptronic.com
will be automatically entered as the
designated recipient.
10
Fig. 13: Menu „Documents“
Appendix
A1. Installation checklist
Checklist for installation of Baumer-GAPI for FireWire™ (Microsoft® Windows®)
 / - for help
Hardware
1 Does your pc fulfill the system requirements?
see 2.
2 Is a FireWire™ board installed to your pc?
see 3.1.
Software - Precautions
Pre 1 Is there any previously installed version of Baumer software on your system?
Pre 2
Is Microsoft® .NET Framework 2.0 (or higher) installed on your system?
(not compulsory)
see 4.2.1.
see 4.2.1.
Software - Installation
1 Do you have installed “Baumer-GAPI Installation”?
see 4.2.2.
2 Do you have installed “1394 Plugin”?
see 4.2.3.
3 Do you have installed “Baumer OHCI”? (not compulsory)
see 4.2.4.
4 Do you have installed “Baumer Camera Driver”? (not compulsory)
see 4.2.5.
11
Technical data has been fully checked, but accuracy of printed matter not guaranteed.
Subject to change without notice. Printed in Germany 03/10.
v1.0 11037653
Baumer Optronic GmbH
Badstrasse 30
DE-01454 Radeberg, Germany
Phone +49 (0)3528 4386 0 · Fax +49 (0)3528 4386 86
sales@baumeroptronic.com · www.baumer.com
Download PDF