Allied Vision Technologies Vimba API Owner's manual

Vimba API
Vimba API
Feature Manual
V1.2
2013-Jun-25
Allied Vision Technologies GmbH
Taschenweg 2a
D-07646 Stadtroda / Germany

Legal Notice
Trademarks
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 protecting 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 06/2013
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: [e-mail]
Vimba API - Feature Manual
2 / 14

Contents
Contents
1 Contacting Allied Vision Technologies 4
2 Introduction 5
2.1 Documenthistory.................................... 5
2.2 Conventions used in this manual . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
2.2.1 Styles...................................... 5
2.2.2 Symbols..................................... 5
3 Vimba - Feature Overview 6
4 Vimba System 7
4.1 Info[AVT]........................................ 7
4.1.1 Elapsed[AVT].................................. 7
4.1.2 GeVTLIsPresent[AVT] .............................. 7
4.1.3 FiWTLIsPresent[AVT] .............................. 7
4.1.4 UsbTLIsPresent[AVT] .............................. 8
4.2 Discovery[AVT]..................................... 8
4.2.1 GeVDiscoveryAllOff [AVT] . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
4.2.2 GeVDiscoveryAllAuto [AVT] . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
4.2.3 GeVDiscoveryAllOnce [AVT] . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
4.2.4 DiscoveryCameraIdent [AVT] . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
4.2.5 DiscoveryCameraEvent [AVT] . . . . . . . . . . . . . . . . . . . . . . . . . . 9
4.2.6 DiscoveryInterfaceIdent [AVT] . . . . . . . . . . . . . . . . . . . . . . . . . . 9
4.2.7 DiscoveryInterfaceEvent [AVT] . . . . . . . . . . . . . . . . . . . . . . . . . 10
5 Vimba GigE IP Configuration 11
5.1 GigE[AVT] ....................................... 11
5.2 Current[AVT] ...................................... 11
5.2.1 GevCurrentIPAddress [AVT] . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
5.2.2 GevCurrentSubnetMask [AVT] . . . . . . . . . . . . . . . . . . . . . . . . . . 11
5.2.3 GevCurrentDefaultGateway [AVT] . . . . . . . . . . . . . . . . . . . . . . . . 12
5.3 Persistent[AVT]..................................... 12
5.3.1 GevPersistentIPAddress [AVT] . . . . . . . . . . . . . . . . . . . . . . . . . . 12
5.3.2 GevPersistentSubnetMask [AVT] . . . . . . . . . . . . . . . . . . . . . . . . . 12
5.3.3 GevPersistentDefaultGateway [AVT] . . . . . . . . . . . . . . . . . . . . . . . 12
5.4 Configuration[AVT]................................... 13
5.4.1 GevIPConfigurationMode [AVT] . . . . . . . . . . . . . . . . . . . . . . . . . 13
5.4.2 GevIPConfigurationApply [AVT] . . . . . . . . . . . . . . . . . . . . . . . . . 13
6 Vimba Events 14
6.1 EventData[AVT]..................................... 14
6.1.1 EventOverflowTimestamp [AVT] . . . . . . . . . . . . . . . . . . . . . . . . . 14
Vimba API - Feature Manual
3 / 14

Contents
6.1.2 EventOverflowFrameID [AVT] . . . . . . . . . . . . . . . . . . . . . . . . . . 14
6.1.3 EventErrorTimestamp [AVT] . . . . . . . . . . . . . . . . . . . . . . . . . . . 14
6.1.4 EventErrorFrameID [AVT] . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14
Vimba API - Feature Manual
4 / 14

1 Contacting Allied Vision Technologies
1 Contacting Allied Vision
Technologies
Note
L
•Technical Information
http://www.alliedvisiontec.com
•Support
[e-mail]
Allied Vision Technologies GmbH (Headquarters)
Taschenweg 2a
07646 Stadtroda, Germany
Tel.: [phone]
Fax.: [phone]
Email: [e-mail]
Allied Vision Technologies Canada Inc.
101-3750 North Fraser Way
Burnaby, BC, V5J 5E9, Canada
Tel: [phone]
Fax: [phone]
Email: [e-mail]
Allied Vision Technologies Inc.
38 Washington Street
Newburyport, MA 01950, USA
Toll Free number +1 877-USA-1394
Tel.: [phone]
Fax: [phone]
Email: [e-mail]
Allied Vision Technologies Asia Pte. Ltd.
82 Playfair Road
#07-02 D'Lithium
Singapore 368001
Tel. [phone]
Fax:[phone]
Email: [e-mail]
Allied Vision Technologies (Shanghai) Co., Ltd.
2-2109 Hongwell International Plaza
1602#ZhongShanXi Road
Shanghai 200235, China
Tel: [phone]
Fax: [phone]
Email: [e-mail]
Vimba API - Feature Manual
5 / 14

2 Introduction
2 Introduction
2.1 Document history
Version Date Changes
1.0 2013-Feb-20 Initial version
1.1 2013-Mar-07 Different document generation, small changes
1.2 2013-Jun-13 Small corrections, layout changes
2.2 Conventions used in this manual
To give this manual an easily understood layout and to emphasize important information, the following
typographical styles and symbols are used:
2.2.1 Styles
Style Function Example
Bold Programs, inputs or highlight-
ing important things
bold
Courier Code listings etc. Input
Upper case Constants CONSTANT
Italics Modes, fields Mode
Parentheses and/or blue Links ( Link )
2.2.2 Symbols
Note
LThis symbol highlights important information.
Caution
aThis symbol highlights important instructions. You have to follow these instruc-
tions to avoid malfunctions.
www
Ý
This symbol highlights URLs for further information. The URL itself is shown in
blue.
Example: http://www.alliedvisiontec.com
Vimba API - Feature Manual
6 / 14

3 Vimba - Feature Overview
3 Vimba - Feature Overview
Vimba's feature interface provides functionality that is not covered directly by the functional interface.
Features can only be accessed via modules inside of Vimba. The modules of Vimba are
• Vimba System
• Camera
• Data Stream: Features may be accessed via the camera.
• Interface
• AncillaryData
The features for these modules are described in the following places:
• Vimba System features (for the Vimba System module) in chapter Vimba System.
• Additional GigE features for IP configuration of the camera in chapter Vimba GigE IP Configuration.
• Additional GigE features for camera event handling in chapter Vimba Events.
• Camera features, Data Stream features and Interface features are primarily described in the
Transport Layer documents for the AVT1394 Transport Layer and the AVTGigE Transport Layer
Vimba API - Feature Manual
7 / 14

4 Vimba System
4 Vimba System
This chapter lists features that are potentially available in this module. Some features are only available
under certain circumstances.
The following categories can be found below the Root category:
• Info
• Discovery
4.1 Info [AVT]
4.1.1 Elapsed [AVT]
Name Elapsed
Interface IFloat
Access Read/Write
Visibility Beginner
Values 0.0..
Elapsed time since the API was initialized.
4.1.2 GeVTLIsPresent [AVT]
Name GeV TL is present
Interface IBoolean
Access Read/Write
Visibility Beginner
The GigE Vision Transport Layer is present and working.
4.1.3 FiWTLIsPresent [AVT]
Name FiW TL is present
Interface IBoolean
Access Read/Write
Visibility Beginner
The FireWire Transport Layer is present and working.
Vimba API - Feature Manual
8 / 14

4 Vimba System
4.1.4 UsbTLIsPresent [AVT]
Name Usb TL is present
Interface IBoolean
Access Read/Write
Visibility Beginner
The USB3 Transport Layer is present and working.
4.2 Discovery [AVT]
4.2.1 GeVDiscoveryAllOff [AVT]
Name GeV Discovery All Off
Interface ICommand
Access Read/Write
Visibility Beginner
Turns devices discovery OFF for all GigE interfaces.
4.2.2 GeVDiscoveryAllAuto [AVT]
Name GeV Discovery All Auto
Interface ICommand
Access Read/Write
Visibility Beginner
Turns devices discovery ON for all GigE interfaces.
4.2.3 GeVDiscoveryAllOnce [AVT]
Name GeV Discovery All Once
Interface ICommand
Access Read/Write
Visibility Beginner
Turns devices discovery temporary ON for all GigE interfaces.
Vimba API - Feature Manual
9 / 14

4 Vimba System
4.2.4 DiscoveryCameraIdent [AVT]
Name Discovery Camera Ident
Interface IString
Access Read/Write
Visibility Beginner
Identifier of the camera that triggered the last discovery event.
4.2.5 DiscoveryCameraEvent [AVT]
Name Discovery Camera Event
Interface IEnumeration
Access Read/Write
Visibility Beginner
Values Missing
Detected
Reachable
Unreachable
Indicates the last camera discovery event.
Possible values:
• Missing: The camera is missing.
• Detected: The camera was detected.
• Reachable: The camera is reachable (can be talked to).
• Unreachable: The camera is unreachable (cannot be talked to).
4.2.6 DiscoveryInterfaceIdent [AVT]
Name Discovery Interface Ident
Interface IString
Access Read/Write
Visibility Beginner
Identifier of the interface that triggered the last discovery event.
Vimba API - Feature Manual
10 / 14

4 Vimba System
4.2.7 DiscoveryInterfaceEvent [AVT]
Name Discovery Interface Event
Interface IEnumeration
Access Read/Write
Visibility Beginner
Values Unavailable
Available
Indicates the last interface discovery event.
Vimba API - Feature Manual
11 / 14

5 Vimba GigE IP Configuration
5 Vimba GigE IP Configuration
This chapter lists features that are potentially available for GigEVision cameras. Some features are only
available under certain circumstances.
The following categories can be found below the Root category:
• GigE
–Current
–Persistent
–Configuration
5.1 GigE [AVT]
5.2 Current [AVT]
5.2.1 GevCurrentIPAddress [AVT]
Name Current IP Address
Interface IInteger
Access Read/Write
Visibility Beginner
Values 0..0xFFFFFFFF
Current IP address of the device.
5.2.2 GevCurrentSubnetMask [AVT]
Name Current Subnet Mask
Interface IInteger
Access Read/Write
Visibility Beginner
Values 0..0xFFFFFFFF
Current Subnet Mask of the device.
Vimba API - Feature Manual
12 / 14

5 Vimba GigE IP Configuration
5.2.3 GevCurrentDefaultGateway [AVT]
Name Current Default Gateway
Interface IInteger
Access Read/Write
Visibility Beginner
Values 0..0xFFFFFFFF
Current Default Gateway of the device.
5.3 Persistent [AVT]
5.3.1 GevPersistentIPAddress [AVT]
Name Persistent IP Address
Interface IInteger
Access Read/Write
Visibility Beginner
Values 0..0xFFFFFFFF
Persistent IP address of the device.
5.3.2 GevPersistentSubnetMask [AVT]
Name Persistent Subnet Mask
Interface IInteger
Access Read/Write
Visibility Beginner
Values 0..0xFFFFFFFF
Persistent Subnet Mask of the device.
5.3.3 GevPersistentDefaultGateway [AVT]
Name Persistent Default Gateway
Interface IInteger
Access Read/Write
Visibility Beginner
Values 0..0xFFFFFFFF
Persistent Default Gateway of the device.
Vimba API - Feature Manual
13 / 14

5 Vimba GigE IP Configuration
5.4 Configuration [AVT]
5.4.1 GevIPConfigurationMode [AVT]
Name IP Configuration Mode
Interface IEnumeration
Access Read/Write
Visibility Beginner
Values LLA
DHCP
Persistent
Current IP configuration mode.
5.4.2 GevIPConfigurationApply [AVT]
Name IP Configuration Apply
Interface ICommand
Access Read/Write
Visibility Beginner
Apply the IP configuration.
Vimba API - Feature Manual
14 / 14

6 Vimba Events
6 Vimba Events
This chapter lists features that are potentially available for GigEVision cameras. Some features are only
available under certain circumstances.
The following categories can be found below the Root category:
• EventData
6.1 EventData [AVT]
6.1.1 EventOverflowTimestamp [AVT]
Name EventOverflowTimestamp
Interface IInteger
Access Read/Write
Visibility Beginner
6.1.2 EventOverflowFrameID [AVT]
Name EventOverflowFrameID
Interface IInteger
Access Read/Write
Visibility Beginner
6.1.3 EventErrorTimestamp [AVT]
Name EventErrorTimestamp
Interface IInteger
Access Read/Write
Visibility Beginner
6.1.4 EventErrorFrameID [AVT]
Name EventErrorFrameID
Interface IInteger
Access Read/Write
Visibility Beginner
Vimba API - Feature Manual
15 / 14