ebus sdk - bentech taiwanpleora.bentech-taiwan.com/ebus_sdk.pdf · 2019. 10. 31. · it can be used...

4
eBUS SDK Feature-rich GigE Vision and USB3 Vision compliant software development kit Overview Built on decades of expertise in the vision market, eBUS SDK is the industry leading choice for image capture, display, and transmission in thousands of mission-critical automation, security & defense, and medical applications. eBUS SDK is a comprehensive solution, providing developers with a feature-rich platform that simplifies application development along with receive and transmit capabilities to streamline end-to-end data delivery between sensor devices and host applications. Image capture, display, and transmission through a simple API portable across Windows, Linux, and macOS - no need to support multiple APIs from different vendors Works with vision standard-compliant GigE, USB3, and GenICam imaging devices from any vendor eBUS Universal Pro driver delivers significant performance advantages, including low latency, low jitter, and low CPU utilization Accelerate application development eBUS Player Toolkit allows users to view streams while demonstrating pathway to incorporating advanced features into applications Sample applications provided in various programming languages and frameworks First-class development support, including Developer Support Subscription providing dedicated technical guidance, configuration support, and recommendations to ensure optimal performance Designed into quality inspection, 3D scanning, flat panel detector, robotics, drone, specialty camera, sports analysis, security applications and more eBUS SDK Features Device discovery, configuration, and control (master or slave) High-performance streaming (Tx and Rx) Buffer management Pixel format conversion Multicasting Action commands Network statistics Multiple payload types (image, raw, chunk, multi-part) Multiple IP configurations Dynamically generated GenICam XML Save acquired images (BMP , TIFF, raw binary, MP4 video format) Ethernet Network Embedded Vision Device Specialty/Smart Camera Standard Machine Vision Camera Distributed Image Processing/Analysis System Controller Smart Display eBUS Tx eBUS Tx eBUS Tx/Rx eBUS Rx eBUS Rx eBUS Tx

Upload: others

Post on 06-Mar-2021

4 views

Category:

Documents


0 download

TRANSCRIPT

Page 1: eBUS SDK - Bentech Taiwanpleora.bentech-taiwan.com/eBUS_SDK.pdf · 2019. 10. 31. · It can be used with either a GigE Vision camera or device, a USB3 Vision camera or device, or

eBUS SDKFeature-rich GigE Vision and USB3 Vision compliant software development kit

OverviewBuilt on decades of expertise in the vision market, eBUS SDK is the industry leading choice for image capture, display, and transmission in thousands of mission-critical automation, security & defense, and medical applications. eBUS SDK is a comprehensive solution, providing developers with a feature-rich platform that simplifies application development along with receive and transmit capabilities to streamline end-to-end data delivery between sensor devices and host applications.• Image capture, display, and transmission through a simple API portable across

Windows, Linux, and macOS - no need to support multiple APIs from different vendors

• Works with vision standard-compliant GigE, USB3, and GenICam imaging devices from any vendor

• eBUS Universal Pro driver delivers significant performance advantages, including low latency, low jitter, and low CPU utilization

• Accelerate application development• eBUS Player Toolkit allows users to view streams while demonstrating

pathway to incorporating advanced features into applications• Sample applications provided in various programming languages and

frameworks• First-class development support, including Developer Support Subscription

providing dedicated technical guidance, configuration support, and recommendations to ensure optimal performance

• Designed into quality inspection, 3D scanning, flat panel detector, robotics, drone, specialty camera, sports analysis, security applications and more

eBUS SDK Features• Device discovery, configuration, and

control (master or slave)• High-performance streaming (Tx and

Rx)• Buffer management• Pixel format conversion• Multicasting• Action commands• Network statistics• Multiple payload types (image, raw,

chunk, multi-part)• Multiple IP configurations• Dynamically generated GenICam XML• Save acquired images (BMP, TIFF, raw

binary, MP4 video format)

EthernetNetwork

EmbeddedVision Device

Specialty/SmartCamera

StandardMachine VisionCamera

Distributed ImageProcessing/Analysis

SystemController

Smart Display

eBUS Tx

eBUS Tx

eBUS Tx/Rx

eBUS Rx

eBUS Rx

eBUS Tx

Page 2: eBUS SDK - Bentech Taiwanpleora.bentech-taiwan.com/eBUS_SDK.pdf · 2019. 10. 31. · It can be used with either a GigE Vision camera or device, a USB3 Vision camera or device, or

eBUS SDKeBUS SDK is built on a single API to receive video over GigE, 10 GigE, and USB that is portable across Windows, Linux, and macOS operating systems. With a Developer Seat License, designers can develop production-ready software applications in the same environment as their end-users, and quickly and easily modify applications for different media, while avoiding supporting multiple APIs from various vendors. Compared to camera vendor provided SDKs, eBUS frees developers from being tied to a specific camera, and instead they can choose the device that is best for the application.

eBUS SDK complies fully with the GigE Vision, USB3 Vision and GenICam standards. It interoperates seamlessly with Pleora’s extensive portfolio of video interface products, as well as with standards-compliant products from other manufacturers. Purchasing the eBUS SDK (Developer Seat License) includes access to online support and technical documentation. For dedicated technical expertise, including installation and configuration support, a Developer Support Subscription is available.

eBUS Tx for Sensor Devices

eBUS Tx is a software implementation of a full device level GigE Vision transmitter, without requiring any additional hardware. Adding eBUS Tx to a CPU’s software stack turns it into a fully compliant GigE Vision device that supports image transmission and enables the device to respond to control requests from a host controller. eBUS Tx is GigE Vision and GenICam compliant, meaning end-users can use any standards-compliant third-party image processing system. eBUS Tx currently supports the GigE Vision standard, contact Pleora if USB3 Vision image transmission is required.

eBUS Rx for Host ApplicationseBUS Rx manages high-speed reception of images or data into buffers for hand-off to the end application for further analysis. Developers can write applications that run on a host computer to seamlessly control and configure an unlimited number of GigE Vision or USB3 Vision and GenICam compliant sensors.

The eBUS Universal Pro driver reduces CPU usage when receiving images or data, leaving more processing power for analysis and inspection applications while helping meet latency and throughput requirements for real-time applications. The eBUS Universal Pro driver is easily integrated into third-party processing software to bring performance advantages to end-user applications.

Application

eBUS Tx eBUS Rx

eBUS Tx(GVSP Tx)

Image Sensor Application

eBUS Rx(GVSP Rx)eBUS

UniversalPro

Driver eBUS & 3rd PartyController

(GVCP)

NetworkInterface

NetworkInterface

GigE Vision Stream

GigE Vision Control

Query/Events

Grab Images

Con�gure Sensor

eBUS DeviceControl (GVCP)

Page 3: eBUS SDK - Bentech Taiwanpleora.bentech-taiwan.com/eBUS_SDK.pdf · 2019. 10. 31. · It can be used with either a GigE Vision camera or device, a USB3 Vision camera or device, or

eBUS Player ToolkitThe eBUS Player Toolkit, which is included with the purchase of a Developer Seat license and can be freely downloaded as a standalone application from the Pleora website, includes useful applications to assist with setup, configuration, and troubleshooting. It includes:• eBUS Player: Allows users to control the parameters of GigE Vision and USB3 Vision compliant devices. The player receives video

and allows users to view streaming data and adjust device configuration settings to determine optimal settings for the vision system. Note: the source code for eBUS Player is included as one of the code samples in the SDK.

• eBUS Universal Pro Driver: Assists in transferring video from a GigE Vision stream to vision system applications, ensuring delivery with low, consistent latency while reducing CPU resource utilization.

• Raw Image Viewer: View raw binary images saved with eBUS Player. • Camera Link Setup Assistant: Specify location of CL Protocol DLL files and automatically generates (or updates) GENICAM_

CLPROTOCOL environment variable.

Developer Support SubscriptionThe Developer Support Subscription provides one year (365 days) of functional support for the eBUS SDK by a dedicated team of senior application engineers. This support offering is suited for customers requiring ongoing support for during testing and development stages. The subscription includes:• Best practice guidance and troubleshooting support during basic installation and setup • Configuration support, analysis, and recommendations to ensure optimal performance • Source code samples to help speed design time• Access to dedicated technical support and documentation

LicensingApplications written with eBUS libraries will require a runtime license for deployment to target device. Unlicensed Rx applications will introduce a watermark, whereas unlicensed Tx applications will stop streaming after 15 minutes.

Supported Standards

Protocols • GigE Vision 2.1 (and earlier), USB3 Vision 1.0.1

Supported Development Environments

• C# .NET, and VB .NET using Visual Studio 2012 and higher, and .NET Framework version 4

• C++ using Visual Studio 2008 and higher• C++ using GCC on Red Hat Linux and Ubuntu• Objective-C and C++ using Xcode

Supported Operating Systems

GigE Vision 2.1 USB3 Vision 1.0.1

Microsoft Windows 7 SP1+*, 8.1 and 10 (32-bit, or 64-bit) on x86 architecture

• Supported • Supported

Red Hat Enterprise LInux 7 (64- bit) and CentOS 7 (64-bit) on x86 architecture

• Supported • Supported

Ubuntu 14.04 LTS, 16.04 LTS and 18.04 LTS (32-bit or 64-bit) on x86 architecture

• Supported • Supported

Ubuntu 18.04 LTS (64 bit) on NVIDIA Jetson Nano, TX2, TX2i, and AGX Xavier

• Supported • Supported

macOS Mojave* • Supported • Supported

*Note: For Windows7 SP1+ and macOS, eBUS Tx not recommended for new designs

Page 4: eBUS SDK - Bentech Taiwanpleora.bentech-taiwan.com/eBUS_SDK.pdf · 2019. 10. 31. · It can be used with either a GigE Vision camera or device, a USB3 Vision camera or device, or

Ordering InformationOrder Code Description

990-1024 • Developer Seat license for eBUS SDK. Entitles a single user access to all available eBUS GigE Vision and USB Vision modules (GEV-Tx, GEV-Rx and U3V-Rx). Includes one year maintenance for access to all eBUS SDK updates. Required for use with eBUS 6.0 onwards.

• GEV-Tx module is available for Windows and Linux only, not available for macOS.• Developer Support Subscription sold separately.

990-1001 • Developer Support Subscription. Entitles developers to baseline functionality support for one year of the eBUS SDK based on sample code.

990-1023 • GEV-Tx License File. A GigE Vision transmitter runtime license required for applications which need to transmit GigE Vision streams on a camera or device that uses Pleora’s eBUS GEV-Tx module. One license per camera or device is required to avoid disconnection after 15 minutes. No limit to number of transmit streams per camera or device. Includes encrypted authorization algorithm such that any applications written using eBUS GEV-Rx module will not need an GEV-Rx license to receive the stream. Requires eBUS SDK 6.0 or higher.

990-1000 • GEV-Rx License File. A GigE Vision receiver runtime license required for applications which need to receive GigE Vision streams from a camera or device that does not contain Pleora transmitter technology. One license per device required to remove a watermark from the video or image. No limit to number of receive streams per device. Requires eBUS SDK 3.1 or higher. Not required for images coming from Pleora hardware devices, IP cores and eBUS GEV-Tx licensed transmitters.

990-1005 • U3V-Rx License File. A USB3 Vision runtime license required for applications which need to receive USB3 Vision streams from a camera or device that does not contain Pleora transmitter technology. One license per device required to remove a watermark from the video or image. No limit to number of receive streams per device. Requires eBUS SDK 3.1 or higher. Not required for images coming from Pleora hardware devices and IP Cores.

990-1018 • GEV/U3V-Rx Dongle. A USB micro-dongle containing single-channel GigE Vision and USB3 Vision receiver licenses required for Windows applications which need to receive video from a camera or device that does not contain Pleora transmitter technology. The licenses removes a watermark from the video or image. It can be used with either a GigE Vision camera or device, a USB3 Vision camera or device, or with both simultaneously. Requires eBUS SDK 5.0 or higher. Not required for images coming from Pleora hardware devices, IP cores and eBUS GEV-Tx licensed transmitters. Dongle not supported on Linux and macOS. If you need to use Linux or macOS, install the license file which is available for purchase online.

Pleora Technologies Inc.340 Terry Fox Drive, Suite 300Kanata, Ontario Canada, K2K 3A2

Tel: +1.613.270.0625Fax: +1.613.270.1425 Email: [email protected] www.pleora.com

© 2019 Pleora Technologies Inc. eBUS, iPORT, vDisplay, and NetCommand are trademarks of Pleora Technologies Inc. Information in this document is provided in connection with Pleora Technologies products. No license, express or implied, by estoppels or otherwise, to any intellectual property rights is granted by this document. Pleora may make changes to specifications and product descriptions at any time, without notice. Other names and brands may be claimed as the property of others. EX002-017-0001 v10.0 8/12/19

eBUS SDK

Software Includes

• eBUS SDK - Provides versatile, robust, and easy-to-understand classes, methods, and properties that allow developers to quickly build high-performance vision applications. Support for high performance image acquisition using eBUS Universal Pro Driver or NIC manufacturer’s driver.

• eBUS Universal Pro driver – Enhances existing general-purpose drivers shipped with NICs and USB 3.0 controllers. Increases image acquisi-tion throughput and performance, decreases latency and jitter, while minimizing CPU utilization.

• DirectShow filter – Enables easy integration of GigE Vision and USB3 Vision cameras with image display, analysis, and compression filters in the DirectShow ecosystem.

• OEM Integration - Includes merge modules for inclusion in installation packages built with Microsoft Visual Studio, or with applications such as Flexera Installshield

• Quick Start Guides• Class and method documentation• eBUS Player Toolkit• Sample applications – Demonstrates advanced networking topics, such as GigE Vision compliant image stream transmission, multicast

communication, and link recovery.