eCapture Pro and eSDK
Questions?


Get in touch with us today and our team of imaging professionals will be pleased to assist you.

Contact Us

eCapture Pro and eSDK Quick Start Guide

The eCapture Pro and eSDK Quick Start Guide explains how to start using eCapture Pro and the Emergent SDK, powerful software for managing and integrating Emergent Vision Technologies' high-speed cameras.

The guide includes:

Follow the instructions carefully to ensure a smooth setup and optimal performance of your camera system.

Figure 1: An Emergent high-speed camera and eCapture Pro integrated into a machine-vision system

Hardware and software requirements

The following components are needed to use eCapture Pro in a basic vision system consisting of a single Emergent camera directly connected to a computer or server.

  • Emergent camera: Any Emergent camera
  • Camera power: Only use an Emergent-supplied or approved power supply to avoid potential damage
  • Camera lens: Any lens compatible with the camera (a lens mount adapter might be required)
  • Supported operating systems:
    • Microsoft Windows 10 Pro, 11 Pro
    • Microsoft Windows Server 2016, 2019
    • Linux distributions: Ubuntu 20.04 LTS, 22.04 LTS; CentOS Stream 8.4, 9.5; Red Hat Enterprise Linux 8.4, 9.5
  • Emergent software: The newest version of the eSDK and eCapture Pro (check their release notes to confirm that their versions are mutually compatible).
  • Computer/Server:
    • 64 GB RAM recommended
    • The NIC requires a PCIe slot that mechanically and electrically supports at least eight lanes (x8). It can also use an x16 slot wired for at least x8 lanes. However, some slots may appear to be x16 or x8 but are electrically configured with only x4 lanes, which would limit performance.
    • For optimal performance, the motherboard should support the NIC's maximum speed and lane width. For example, if the NIC supports Gen 5 speed and x8 lanes, the motherboard should match these specifications to prevent performance bottlenecks. Use a tool like HWInfo64 to check the motherboard's current link width and speed.
  • Network Interface Card (NIC): A supported NIC from Emergent, NVIDIA, Broadcom, AMD, Intel*, or AMD/Xilinx* installed in the PCIe slot
    * NICs with RDMA/RoCEv2
  • Data interface cables and connectors: Compatible with the camera and NIC ports

Hardware installation

Before installing and using eCapture Pro, install the required hardware.

  1. Install a compatible NIC in the computer/server:
    • As with any PCIe card installation, power down the computer or server and follow electrostatic discharge precautions.
    • Driver installation for these NICs is handled during the Emergent software installation. So don't download NIC drivers from the manufacturer's website, as this can cause compatibility issues.
  2. Connect the camera to the NIC:
    The cable type and connection method depend on the camera’s data interface:
    • RJ45 CAT cables: Use CAT cables with RJ45 connectors for 10GBase-T Ethernet. Insert the connectors into the camera and NIC ports until you hear a "click." To remove, press the release tab.
    • SFP+, SFP28, or QSFP28 Direct Attach Cables: Insert the connectors into the camera and NIC ports until you hear a "click." To remove, pull the release tab.
    • SFP+, SFP28, or QSFP28 Fiber Transceivers and Cables: Insert the LC fiber into the transceivers, then insert the transceivers into the camera and NIC ports. To remove, release the LC-LC fiber, then pull the transceiver latch.
    • Note: Different vendors use varying latch mechanisms, so check the instructions for your specific cable.
  3. Connect power to the camera:
    • Always use Emergent-approved power supplies. Non-approved power supplies might damage the camera and void the warranty.
    • Insert the HR12 connector into the camera’s HR12 GPIO port, pull back on the outer shell, rotate, and push until it clicks.
    • The green LED on the back of the camera will light when power is connected.‍
    • Note: Emergent’s Eros cameras have HR8 connectors instead of HR12 connectors. Eros cameras have a single LED that's green when the camera has power and flickers yellow to indicate Ethernet activity. Eros cameras with RJ45 data interfaces support Power-over-Ethernet (PoE).

Software installation

After installing the hardware, download and install the eSDK and eCapture Pro for either Windows or Linux (Ubuntu).

Notes:

  • You can use eCapture Pro in trial mode with up to two cameras without an eCapture Pro license.
  • The eSDK and eCapture Pro have separate installers packaged in individual ZIP archives. The eSDK installer installs the eSDK and eCapture but not eCapture Pro.
  • eCapture Pro depends on the drivers and dependencies that the eSDK provides. Don't try to install these from other sources, otherwise incompatibilities could arise.
  • The installers provide options to install drivers, tools, and other dependencies. We recommend that you install all of them.
  • During eSDK installation, the computer/server must be connected to the internet because the installer needs to download files.
Downloading the eSDK and eCapture Pro installers

Prerequisite: Register for an Emergent account on the Emergent website's Register page. You need the account to download the eSDK and eCapture Pro software installers.

To download the eSDK and eCapture Pro installers:

  1. On the Emergent website, go the the Login page and log in to your Emergent account.
  2. On the top navigation bar, go to the Resources menu and select Downloads. The Downloads page opens.
  3. Under Resources by Category, click Software. The Software tab opens (see Figure 2 below).
  4. In the eCapture Pro section, download the newest version of the eCapture Pro installer archive.
  5. Click the Release Notes link adjacent to the Download link. The release notes open.
  6. In the release notes, go to the eCapture Pro section. Find which version of the eSDK that's compatible with the verson of eCapture Pro that you downloaded (see the example in Figure 3 below.)
  7. Back on the Software tab of the Downloads page, open the eSDK section and download the version of the eSDK installer archive that's compatible with your version of eCapture Pro.
    Note: The name of the eSDK installer archive indicates the versions of the SDK and eCapture (not eCapture Pro), and the OS. For example, the eSDK archive file eSDK_2_55_01_eCap_2_11_04_Windows.zip contains the installer for eSDK 2.55.01 and eCapture 2.11.04 and runs on Windows.
On the Software tab of the Emergent website's Download page, download the eCapture Pro and eSDK installers

Figure 2: On the Software tab of the Emergent website's Download page, download the eCapture Pro and eSDK installers

The release notes show which version of the eSDK is compatible with your version of eCapture Pro

Figure 3: The release notes show which version of the eSDK is compatible with your version of eCapture Pro

Installing the eSDK and eCapture Pro

After you download the eSDK and eCapture Pro installers, use one of the following procedures to install them on Windows or Linux.

To install the eSDK and eCapture Pro on Windows:

  1. Install the eSDK:
    a. Extract the files from the eSDK installer's zip archive (for example, eSDK_2_55_01_eCap_2_11_04_Windows.zip).
    b. Run the eSDK installer (for example, eSDK_2_55_01_eCap_2_11_04_Windows.exe) and follow its instructions.
    c. If the installer finds previously installed eSDK or eCapture files, including NIC drivers, it will ask your approval to uninstall them. After it uninstalls them, run the installer again.
  2. Install eCapture Pro:
    a. Extract the files from the eCapture Pro installer's zip archive (for example, eCapturePro_0_1_32_Windows.zip).
    b. Run the eCapture Pro installer (for example, eCaptureProInstaller_0_1_32_Windows.exe) and follow its instructions (see Figure 4 below).

After installing the software, you can start using eCapture Pro, as described below in Basic eCapture Pro usage.

eCapture Pro installer

Figure 4: The eCapture Pro installer

To install the eSDK and eCapture Pro on Linux:

  1. Install the eSDK:
    a. Extract the files from the eSDK installer's zip archive (for example, eSDK_2_55_02_eCap_2_11_04_Ubuntu_22_04_6_5_0_x64.zip).
    b. Run the eSDK installer install_eSdk.sh and follow its instructions.
    c. If the installer finds a previously installed eSDK package, it will stop the installation. You should run uninstall_eSdk.sh to uninstall the eSDK package and then run install_eSdk.sh again.
  2. Install eCapture Pro:
    a. Extract the files from the eCapture Pro installer's zip archive (for example, eCapturePro_0_1_32_Ubuntu_22_04.zip).
    b. Install the libxcb-xinerama0 (a dependency for running the installer) package with the command:
    - sudo apt install libxcb-xinerama0
    c. Run the eCapture Pro installer (for example, eCaptureProInstaller_0_1_32_Ubuntu_22_04.run) and follow its instructions (see Figure 4 above).
  3. Reboot the computer/server.

After installing the software, you can start using eCapture Pro, as described below in Basic eCapture Pro usage.

Basic eCapture Pro usage

After installing the hardware and software, perform the following procedures in eCapture Pro to stream and display a camera's images:

  1. Start eCapture Pro.
  2. Purchase and install the eCapture Pro license if needed.
  3. Add the local server, NIC Ethernet port, and camera to the system graph.
  4. Stream and display the camera’s images.

Here are the steps for those procedures:

Procedure 1: Start eCapture Pro:

  1. Launch the application:
    • ‍On Windows: Double-click the eCapture Pro icon on the desktop. Alternatively, double-click the eCapturePro.cmd file in the eCapturePro folder (typically located at C:\Program Files\EVT\eCapturePro\).
    • ‍On Linux: Double-click the eCapture Pro icon in the list of installed applications. Alternatively, run the eCapturePro.sh script in the eCapturePro directory (typically located at /opt/EVT/eCapturePro/).
  2. Do one of the following:
    • If your instance of eCapture Pro doesn't have a license installed, it will open the license screen (see Figure 5). Go to procedure 2.
    • If your instance of eCapture Pro already has a license installed, it will open the default screen (see Figure 6). Go to procedure 3.
eCapture Pro license screen

Figure 5: eCapture Pro license screen

eCapture Pro default screen

Figure 6: eCapture Pro default screen

Procedure 2: Purchase and install the eCapture Pro license if needed:

Note: To manage more than two Emergent cameras with eCapture Pro, you must purchase and install an eCapture Pro license. If you have already installed a license or if you want to use eCapture Pro in trial mode with two or fewer cameras, you can skip this procedure and go to procedure 3.
  1. To purchase a license for eCapture Pro, contact Emergent Sales. They will ask you to generate and send them a system fingerprint file that identifies the computer/server on which you installed eCapture Pro.
    Note: The license will be valid only for that computer/server.
  2. To generate the system fingerprint file:
    a. On the eCapture Pro license screen (see Figure 7 below), click the fingerprint button. A dialog will open.
    b. In the dialog, select the location to save the file and click Select Folder. eCapture Pro will generate the file and display its location and name on the license screen.
  3. Send the system fingerprint file (hostinfo.dat) to Sales.
  4. When Sales sends you the license file, save it on the computer/server on which you installed eCapture Pro.
  5. Install the license file:
    a. On the eCapture Pro license screen, click the license button. A dialog will open.
    b. In the dialog, select the license file and click Open. eCapture Pro will open the default screen (see Figure 6 above).
Buttons on the eCapture Pro license screen

Figure 7: Use the buttons on the eCapture Pro license screen to generate a fingerprint file, install a license, or enter trial mode

Procedure 3: Add the local server, NIC Ethernet port, and camera to the system graph:

  1. In eCapture Pro, open the system graph: On the Graph tab, select the System subtab. eCapture Pro displays a blank system graph.
  2. Add the local server: In the left panel, click the local server icon (house) . If prompted, enter the server’s password. A server icon appears in the system graph.
  3. Add one of the NIC's Ethernet ports:
    a. In the system graph, select the server icon.
    b. Then, in the left panel, click the add button (+) beside the Ethernet port that is physically connected to the camera. An Ethernet port icon appears in the system graph.
  4. Add the camera:
    a. In the system graph, select the server icon.
    b. In the left panel, click the add button (+) beside the camera. A camera icon appears in the system graph.
  5. Automatically configure the IP addresses, subnet masks, and maximum transmission unit (MTU) of the camera and NIC:
    a. In the system graph, select the server icon.
    b. In the left panel, select the gear icon. Then, in the context menu, select Auto-reconfigure interface and camera IPs.
An example of a system graph in eCapture Pro

Figure 8: This example of a system graph in eCapture Pro shows a server connected to two Ethernet ports, two cameras, and a GPU

Procedure 4: Stream and display the camera’s images:

  1. On eCapture Pro's Live View tab, right-click the camera’s blank image display box. Then, in the context menu, select Display setting > Stream and display. The camera's captured images appear in the diplay box (see Figure 9).
  2. To improve image quality, adjust the camera’s physical position, lens, and lighting.
  3. On the Live View tab, use the features in the right panel to adjust camera parameters, such as Exposure and Gain.
An example of Emergent camera views on the Live View tab in eCapture Pro and the camera parameters on the right panel

Figure 9: An example of Emergent camera views on the Live View tab in eCapture Pro and the camera parameters on the right panel

eSDK code examples

The eSDK installation includes C++ example code in the <install_path>\EVT\eSDK\Examples directory. These examples demonstrate all the camera's functions and are a valuable resource for software developers.

On Windows, the examples are pre-configured projects that can be opened, compiled, and run using Microsoft Visual Studio Express 2019 or later. On Linux, they consist of source files and makefiles that you can build with g++.

The EVT_BenchmarkHS example is the recommended starting point for application development and for benchmarking your camera at its maximum resolution and frame rate.

Note: The following procedures use the EVT_BenchmarkHS example but you can easily modify them for the other examples.
Building code examples

You can build the code examples on Windows or Linux.

Note: For simplicity when getting started, the following procedures assume you are building and running the code examples on the computer/server that you will connect the camera to.

Prerequisites:

  • On Windows, install Microsoft Visual Studio Express 2019 or later.
  • On Linux, install g++ tools. To install them on Ubuntu 20.04 LTS or later, run the following command:
    sudo apt-get install build-essential

On Windows:

  1. Open Visual Studio.
  2. Navigate to <install_path>\EVT\eSDK\Examples\EVT_BenchmarkHS\.
  3. Open the solution file EVT_BenchmarkHS.sln.
  4. If prompted, upgrade the project to the latest version of the Windows SDK and Platform Toolset.
  5. Click Build to compile the project. The build should complete with 0 Errors.
    ‍

On Linux:

  1. Open a terminal.
  2. Navigate to /opt/EVT/eSDK/Examples/EVT_BenchmarkHS/.
  3. Compile the project by running make. The build should complete with 0 Errors.
Running code examples

After you build the code examples, you can run them on Windows or Linux.

Prerequisites:

  • Connect an Emergent camera to the computer or server.
  • Connect power to the camera.
  • To ensure the camera's IP address is in the same subnet as the NIC's IP address, perform the procedures in Basic eCapture Pro Usage , which includes steps to "automatically configure the IP addresses, subnet masks, and maximum transmission unit (MTU) of the camera and NIC".

On Windows:

  1. Open a command prompt.
  2. Navigate to <install_path>\EVT\eSDK\Examples\EVT_BenchmarkHS\x64\Debug\.
  3. Run the program by typing EVT_BenchmarkHS and pressing Enter.
    The program should show information like the following text:
-------------------------------
BenchmarkHS : Example program
-------------------------------
Open Camera:            Camera Opened

----- INT_TRIGGER Mode -----
..........

Images Captured:        1000
Dropped Frames:         0
Frame Rate Setting:     105
Calculated Frame Rate:  104.975856

Close Camera:           Camera Closed

‍

On Linux:

  1. Open a terminal.
  2. Navigate to /opt/EVT/eSDK/Examples/EVT_BenchmarkHS/out/.
  3. Run the program by typing the following command and pressing Enter:
    sudo ./EVT_BenchmarkHS
    The program should show information like the text above.
Updated on
September 25, 2024
Questions?


Get in touch with us today and our team of imaging professionals will be pleased to assist you.

Contact Us