eBUS Player UG For Windows and Linux PDF
eBUS Player UG For Windows and Linux PDF
eBUS Player UG For Windows and Linux PDF
Trademarks
PureGEV, eBUS, iPORT, vDisplay, AutoGEV, AutoGen, and all product logos are trademarks of Pleora Technologies. Third party
copyrights and trademarks are the property of their respective owners.
Notice of Rights
All information provided in this manual is believed to be accurate and reliable. No responsibility is assumed by Pleora for its use.
Pleora reserves the right to make changes to this information without notice. Redistribution of this manual in whole or in part, by
any means, is prohibited without obtaining prior permission from Pleora.
Document Number
EX001-017-0009 Version 9.0, 7/30/19
Table of Contents
About this Guide . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1
What this Guide Provides. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2
Related Guides . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2
Choosing a Driver. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .7
Comparing Drivers. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
Using the eBUS Driver Installation Tool . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
Configuring the Network Adapter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
i
Monitoring Performance . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47
Using the Event Monitor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49
Using the Device Serial Ports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50
Configuring the Serial Ports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50
Setting the Baud Rate for Serial Ports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51
Establishing Communication Between a Camera and Third-Party Camera
Configuration Software . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57
Technical Support . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63
Related Guides
The eBUS Player User Guide is complemented by the following Pleora Technologies documents, which
are available on the Pleora Technologies Support Center (supportcenter.pleora.com):
Software developers who are looking to create image acquisition software can also consult the following
guides for information about creating custom image acquisition software:
• eBUS SDK API Quick Start Guides, available for C++, .NET, Linux, and macOS, which are available
on the Pleora Support Center at supportcenter.pleora.com.
• eBUS SDK API Help Files, which are included with the eBUS SDK. These help files are installed on
your computer when you install the eBUS SDK. You can access this documentation from the
Windows Start menu under eBUS.
eBUS Player allows you to save GenICam XML information retrieved from a device; you can also load
the saved GenICam XML file information to a device.
Not just a controller, eBUS Player also receives and allows you to view streaming data. While viewing the
image data, you can use eBUS Player to balance the colors, and save video, images, and device
configuration settings.
You can use the tools in eBUS Player to determine the optimal settings for your Vision system.
As you become more familiar with GigE Vision, USB3 Vision, and GenICam, you can continue to
control your GigE Vision and USB3 Vision devices using eBUS Player, or you can build your own
software application using the eBUS SDK.
Please note that runtime packages are also available for the eBUS SDK, for easy integration into
applications developed with the eBUS SDK.
The runtime packages install only the items that are required to run an application created with the eBUS
SDK (including GigE Vision and USB3 Vision drivers). They exclude the items that are used to create
applications with the eBUS SDK (such as header files, libraries, sample code, and API Help files).
You can access the installation files from the Pleora Support Center at supportcenter.pleora.com.
You can launch eBUS Player from the Windows Start menu, under eBUS.
System Requirements
Ensure the computer on which you install the eBUS Player Toolkit or eBUS SDK meets the following
recommended requirements:
• At least one Gigabit Ethernet NIC (if you are using GigE Vision devices) or at least one USB 3.0
port (if you are using USB3 Vision devices).
One of the following operating systems:
For more detailed information about how to use eBUS Player to control your GigE Vision or USB3 Vision
devices, please see “Controlling GigE Vision and USB3 Vision Devices” on page 15.
eBUS Player can communicate with GigE Vision devices using either a direct Ethernet connection or
through a GigE switch. For USB3 Vision devices, eBUS Player uses a direct USB 3.0 connection.
Choosing a Driver
This chapter describes the drivers that are available, and provides guidance on selecting the driver that is
best suited for your system.
Choosing a Driver 7
Comparing Drivers
The eBUS Player Toolkit and eBUS SDK provide you with drivers you can install to:
You can use the eBUS Driver Installation Tool to install or change drivers. The Driver Installation Tool
can be launched from the Windows Start menu, under eBUS.
GigE Vision Driver Provides the best performance and excellent compatibility with most network
adapters. For use with GigE Vision devices.
USB3 Vision Driver Provides control and streaming capabilities. For use with USB3 Vision devices.
Note: Some USB 3.0 host controllers allow you to enable or disable power
management. We recommend that you disable power management.
You can choose to install Pleora drivers as part of the eBUS SDK installation wizard, or you can use the
eBUS Driver Installation Tool to install or uninstall a driver.
To see the versions of the installed drivers, click Help > About.
Choosing a Driver 9
Configuring the Network Adapter
For GigE Vision devices, you can configure your network adapter to reduce CPU utilization, and enhance
receive and transmit performance.
In the eBUS Driver Installation Tool, click Advanced to configure your network adapter. In the Network
Adapter Configuration dialog box that appears, you can perform the following tasks for the selected
network adapter:
The Network Adapter Configuration dialog box provides detailed descriptions of these settings and
explains the impact of these settings on latency and memory consumption.
As you adjust the settings the changes are applied to the selected network adapter.
Some third-party GigE Vision devices do not support the optional features introduced in version 1.1 (and
later) of the GigE Vision standard, which ensure compatibility with firewalls. This restriction requires you
to disable the computer firewall to properly use devices that do not support the optional features.
This chapter provides you with instructions for disabling the firewall in the Windows 8 and Windows 7
operating systems. This chapter only applies to systems that include GigE Vision devices; it does not
apply to systems that use USB3 Vision devices.
For more detailed information about how firewalls function, including how firewalls can affect GigE Vision
devices, see the Pleora Technologies knowledge base article, Correcting Firewall Issues with 3rd Party GigE
Vision Devices, available on the Pleora Support Center at supportcenter.pleora.com.
The eBUS SDK operates correctly with Windows firewalls when used with Pleora GigE Vision devices.
You should not have to lower the firewall or take any specific action.
When the eBUS SDK is used with a Pleora device, it knows where to send the packets to keep the firewall
open. For streaming, the device uses port 20202 + channel number. The streaming channel 0 (first,
default) uses port 20202. For the messaging channel, the device uses port 4.
Third-Party Devices
Version 1.1 of the GigE Vision standard added optional features, allowing devices to report which device-
side UDP port is used for streaming each available streaming channel, and for the messaging channel.
This mechanism allows the eBUS SDK to know exactly where to send the packet that is used to keep the
firewall open.
It is important to understand that this GigE Vision 1.1 feature is optional. Not all third-party devices
support it, even if they report using GigE Vision 1.1 (or later).
If your third-party devices support the firewall compatibility features, your system should work without
having to disable the firewall.
If your third-party devices do not support the firewall compatibility features, the firewall needs to be de-
activated for your system to stream, or use the messaging channel.
eBUS SDK 5.1 (and later) supports GigE Vision 2.0 (and earlier).
We recommend that you do not deactivate the firewall on a public network, such as a wireless access point
at a coffee house or hotel. If you are on a corporate or home network, but Windows behaves as if you are
on a public network, you might need to set the correct type of network used by your NIC.
Note: If your device is connected to a network, network policy settings might prevent you from
completing these steps. For more info, contact your administrator.
For GigE Vision devices, it is important for eBUS Player to be installed on a computer that is configured
for the same subnet as the GigE Vision device to which you want to connect.
To connect to a device
1. On the Windows Start menu, click eBUS > eBUS Player.
2. Under Connection, click Select/Connect.
3. Click the GigE Vision or USB3 Vision device in the Available Devices list, and then click OK.
4. If you are using the manufacturer driver, a message may appear, indicating that you are not using
an eBUS driver. Keep in mind the following information about drivers:
• GigE Vision devices. For optimal streaming performance, we recommend you use the GigE
Vision driver.
• USB3 Vision devices. The manufacturer driver allows eBUS Player to detect USB3 Vision
devices, but you cannot control the devices or stream images. To perform these activities, you
must install the USB3 Vision driver.
For more information, see “Choosing a Driver” on page 7.
Warnings and errors related to the USB3 Vision device and host controller may appear in the right-hand
panel of the Device Selection dialog box. For example, a warning may appear if you have connected your
USB3 Vision device to a USB 2.0 port.
8. Now that you have connected to the device, here are some common tasks that you can perform:
• Configure a persistent IP address for the device, which will persist across power cycles, as
outlined in “Configuring a Persistent IP Address for a GigE Vision Device” on page 18.
• Acquire images to see the image stream or the Pleora test pattern, as outlined in “Acquiring
Images” on page 20.
The device can use the persistent IP address each time it is powered up as long as the IP address is valid
and there are no IP address conflicts.
5. In the TransportLayerControl section of the Device Control dialog box, enter a subnet mask in the
GevPersistentSubnetMask box.
6. Enter a default gateway in the GevPersistentDefaultGateway box.
The device uses the persistent IP address first, but if this option if set to False, it uses the IP address
provided by DHCP next, and if this fails, uses LLA to find an available IP address. LLA cannot be disabled
and is True by default.
Acquiring Images
Because most devices start up in a state that is ready to send images, you can start acquiring images as
soon as you apply power and connect the transmitter to the network (for GigE Vision devices) or USB
3.0 port on your computer (for USB3 Vision devices with the USB3 Vision driver installed).
Pleora GigE Vision and USB3 Vision devices can transmit a test pattern, which is a test image generated
by the device and can be used when a camera head is not available (most devices transmit a test pattern
by default). If you have a camera head, you can turn the test pattern off to see the image stream.
If you are using eBUS Player to connect to a vDisplay HDI-Pro External Frame Grabber, this section does not
apply. A vDisplay HDI-Pro External Frame Grabber acts as a controller and/or receiver, which means that it
does not transmit video over the network. Instead, skip this section and go to “Configuring eBUS Player as
a Controller or Data Receiver” on page 35.
To acquire images
1. Start eBUS Player and click Select/Connect.
2. Click the device in the Available Devices list.
3. Click OK in the bottom right corner.
4. For multi-source GigE Vision devices, click the source to which a camera is connected under
Source. If you do not have a camera connected, you can use the test pattern. For more information,
see “To turn the test pattern on or off ” on page 20.
5. In the Mode list, click Continuous, which configures the device to send a stream of continuous
images (instead of a single image).
For other acquisition modes, see “Configuring How Images are Acquired” on page 32.
6. Click Play.
The images appear in the Display section.
Some of the core GenICam commands are executed when you click buttons and make selections in the
Player window. For example, when you click Play or Stop and you are working with a GigE Vision device, the
AcquisitionStart and AcquisitionStop commands are executed. When you select a source for a multi-
source GigE Vision device, the GevStreamChannelSelector feature is accessed.
Some Pleora devices, perform reconstruction for selected tap geometries, allowing the image to be
reconstructed before it is transmitted. For more information, see the user guide that accompanies your
Pleora device.
A variety of tap geometries can be reconstructed using eBUS Player. For descriptions of the tap geometries,
see the GenICam Standard Features Naming Convention (SFNC), available from the European Machine
Vision Association at www.emva.org.
The histogram shows the number of pixels with the pixel value and the range of colors.
Number of pixels
with this value
To remap the dynamic range of images displayed in eBUS Player or exported as H.264
video
1. On the Tools menu, click Image Filtering.
2. Under Histogram, select the Enabled check box.
To use this feature, your GigE Vision or USB3 Vision device must be configured for chunk data. For more
information, see the documentation accompanying your device. For detailed information about the
extended chunk mode feature, see the iPORT Advanced Features User Guide, available on the Pleora
Support Center at supportcenter.pleora.com.
If you changed any of the options in the Image Filtering dialog box (Tools > Image Filtering), please note
the following:
• TIFF or raw binary format. The image filtering configuration is not used for the image files that you
save. Images are saved without any modification, which is beneficial if you are performing image
processing.
• BMP or MP4 video format. The image filtering configuration is used for video that you save, which
can provide greater clarity.
5. If you selected H.264 video in MP4 container in step 4, specify the data rate of the video file in the
Target encoding bitrate box.
7. Click OK.
The Display section changes to red, the word RECORDING appears, and statistics about the
recording appear, including the image count, the size of the file, the frame rate, and the data rate.
The file name of the saved image or video files contains the image index and the image timestamp.
The timestamp reflects the number of milliseconds that have elapsed since the computer was
started. The raw binary data format also includes the width, height, pixel format, and tap geometry
(if applicable) of the image. This information is used by the eBUS Raw Image Viewer application
to display raw binary data images properly. For more information about the eBUS Raw Image
Viewer, see the Using the eBUS Raw Image Viewer Application to View Raw Binary Images knowledge
base article at supportcenter.pleora.com.
If you are displaying chunk data, only the image is saved (because the chunk data is overlaid on top of the
image, it is not part of the image or video).
If you are saving images in MP4 format and have selected the Save one image out of every [ ] captured
images, stopping recording before the entire image has been stored in the file will result in an incomplete
MP4 file that cannot be played.
You can use the eBUS Raw Image Viewer to open raw binary files saved using eBUS Player (or applications
created with the eBUS SDK). For more information, see the eBUS Raw Image Viewer knowledge base article
on the Pleora Support Center (supportcenter.pleora.com).
5. You do not need to change the Throttling options, as only a single image will be saved.
6. Click OK.
Note: When you close and re-open eBUS Player, the default image format and save folder are used.
The acquisition modes supported by a device are enumerated by the GenApi AcquisitionMode feature.
Modes Standard on Most GigE Vision and USB3 Vision Compliant Devices
Continuous, SingleFrame, and MultiFrame modes are usually standard for devices. Acquisition starts
when the Play button is pressed (the AcquisitionStart command is executed).
Continuous Mode
This mode allows you to acquire images continuously and is the default mode for most devices.
SingleFrame Mode
This mode allows you to acquire a single image.
You can set the AcquisitionControl > AcquisitionFrameCount feature in the Device Control dialog box,
as shown in the following image.
These modes are helpful when you are working with a camera that transmits images at a rate that exceeds
the connection between the Pleora device and the computer, resulting in dropped images. By using the
recording and readout modes, you can capture and stream images from the camera without losing any
images (as long as there is space in the onboard memory).
Acquisition starts when the Play button is pressed (the AcquisitionStart command is executed) when one
of the recording modes is selected.
For more information about how many images can be stored in the Pleroa device’s onboard memory and
to understand when images will be removed, see the user guide that accompanies the Pleora external frame
grabber or embedded video interface. User guides are available on the Pleora Support Center at
supportcenter.pleora.com.
In most cases, errors will not appear if you are connecting to a device for the first time. If an error appears,
click Image stream control and review the information in the Counters section. If anything other than
zero appears in the features within this section and you are using a GigE Vision device, consult the Stream
Control Technical Note, available at the Pleora Support Center, to determine which feature is causing the
error and for guidance on how to correct the error.
Table 2: Roles
Role Description
Controller and Data Receiver Select this role if you are using eBUS Player to connect to and control a GigE Vision
or USB3 Vision transmitter AND if you want eBUS Player to receive streaming video
from the transmitter.
This setting is ideal when you want to control an iPORT device and see streaming
video with eBUS Player. This is the default setting.
Controller Select this role if you are using eBUS Player to connect to and control a GigE Vision
or USB3 Vision device. eBUS Player does not receive streaming video from the
device if this option is selected.
This setting is often used to connect eBUS Player to a receiver, such as the Pleora
vDisplay HDI-Pro External Frame Grabber (for use with GigE Vision devices).
Data Receiver Select this role if you are using eBUS Player to connect to and receive streaming
video from a GigE Vision or USB3 Vision device. You cannot control the device if this
option is selected.
The vDisplay HDI-Pro External Frame Grabber receives video from the GigE Vision network and makes it
available for display on an attached monitor.
For multi-channel GigE Vision devices, eBUS Player queries the GenICam interface of the device (in most
cases) to determine which channel should be used with the source. In cases where eBUS Player cannot
determine the channel to use, the default channel that you specify is used. This can occur when you are
using a data receiver that does not have access to device control. If you are multicasting and want to set
up a pure data receiver, you need to specify the channel on which to listen by typing the Default channel.
4. Click OK.
If eBUS Player is already connected to a device, you must close the Setup dialog box and disconnect from
the device before you can select an eBUS Player role.
Unicast, specific local port Select this option to configure the camera to stream video directly to a user-defined
port on the eBUS Player computer.
Unicast, other destination Select this option to configure the camera to stream video directly to a computer or a
vDisplay External Frame Grabber (a destination other than the eBUS Player computer).
Multicast Select this option to configure the camera to join a multicast group (specified by the
IP address and port), and to begin streaming to that group.
The vDisplay External Frame Grabber or any other receiver (such as a computer), must
be configured to receive streaming video at the same multicast address.
If eBUS Player is configured as a multicast receiver, it allows you to view video from the
camera streaming video to the same multicast address.
Before you connect to a GigE Vision or USB3 Vision device, you can set the default communication
parameters that will be used for the connection. If the connection is already established, you can adjust
the communication settings as required.
The Default GigE Vision Communication Parameters or Default USB3 Vision Communication
Parameters dialog box appears.
3. Customize the communication settings as required and then close the dialog box.
When you connect to the GigE Vision or USB3 Vision device, the communication settings that
you specified will be used. For information about connecting to a device, see “To connect to a
device” on page 16.
5. The Communication Control dialog box appears. Customize the communication settings as
required by adjusting the features in the dialog box.
The Communication control button is only available when eBUS Player is connected to a device. To
configure the communication settings before a connection is established with a GigE Vision or USB3 Vision
device, see “To set the default communication parameters for the initial device connection” on page 38.
By changing the values of controls in the eBUS Player control dialog boxes, you can change how the GigE
Vision or USB3 Vision device (and connection between the device and the host computer) performs.
System configuration is comprised of the following three categories, and provides a set of controls for each
category in a separate dialog box:
• Communication Control dialog box. Controls connection and communication settings between
the host computer and the GigE Vision or USB3 Vision device. For information about the
communication settings, see “Accessing the Communication Settings” on page 37.
• Device Control dialog box. Controls all device settings, including transport layer settings, image
processing settings, image mode and formatting settings, display timing settings, channel settings,
autonomous control settings, and messaging settings.
• Image Stream Control dialog box. Controls image stream settings and provides performance
statistics.
We recommend that you do not use the AcquisitionStart and AcquisitionStop features in the Device
Control dialog to start and stop streaming. Instead, you should use the Play and Stop buttons in the Player
window.
While the available communication control and stream control features do not change based on device,
the available device control features are retrieved from the device’s XML file. The device control features
will vary depending on the device you are working with.
To help you locate features in the Communication Control, Device Control, and Image Stream Control
dialog boxes, you can use the search box. By default the search box is hidden. To make it available, open
any of these dialog boxes (ensuring the dialog box has focus) and press CTRL + F.
MAC address field (GigE Vision devices Device Control dialog box > TransportLayerControl /
only) GevMACAddress
GUID field (USB3 Vision devices only) Communication Control dialog box > Connection / DeviceGUID (not
shown below)
Vendor field Device Control dialog box > DeviceControl / DeviceVendorName (not
shown below)
Model field Device Control dialog box > DeviceControl / DeviceModelName (not
shown below)
If you use the AcquisitionStart and AcquisitionStop features in the Device Control dialog box to start and
stop streaming from a GigE Vision device, please note that the TLParamsLocked feature is not activated,
allowing you to change features that are normally locked during image streaming, such as width and height.
This may cause unexpected results. Whenever possible, we recommend that you use the Play and Stop
buttons to start and stop streaming.
For transmitters that do not timestamp packets, an asterisk (*) appears next to the frame rate (FPS) and
data rate (Mbps) in the Display section, which indicates that host-side timestamps values were used to
calculate the frame and data rates. You can set the SDK to use the receiving computer’s time to do the
calculation by clicking Image Stream Control and setting the Statistics > General
>TimestampSourcePreferred feature to Software.
The Device Control dialog box appears. Customize the settings as required by adjusting the features
in the dialog box.
Expand All,
Collapse All buttons Visibility list
Browser Options
button Refresh button
Minus button Search box (press CTRL + F to
make this box appear)
Plus button
Collapse All button Collapses the categories (when the Tree view is selected in the Browser Options dialog
box).
Search box Performs a keyword search. Press CTRL + F to make the search box appear in the dialog
box. Search results are highlighted in the dialog box. To move through the results, use the
arrow buttons beside the search box.
Visibility list Filters the list of features to suit your level of video network responsibility and
understanding. There are more controls available for the Guru level than the Beginner
level; some controls are not available in the Beginner level.
Browser Options Opens the Browser Options dialog box, which allows you to:
button
• Choose whether the features are displayed as an alphabetical list or a feature tree.
• Show the features using either the feature name or the display name.
• Specify whether the device features are refreshed automatically, based on polling
time (as defined in the GenApi XML file that was used to build the node map), or
manually refreshed (using the Refresh button).
Minus button Collapses a category (when the Tree view is selected in the Browser Options dialog box).
Plus button Expands a category (when the Tree view is selected in the Browser Options dialog box).
Monitoring Performance
As your device receives images from your camera and sends them to your computer, it keeps track of
image errors (such as missing lines), network errors (such as lost packets), and other performance-related
statistics.
You can view a complete list of error counts in the Image Stream Control dialog box. Performance metrics
are grouped under Statistics.
You can view a summarized list of error counts at the bottom of the Display section. The Display section
shows the total number of images displayed (BlockCount), the instantaneous frame rate
(AcquisitionRateAverage), and the data rate (BandwidthAverage).
You can clear the log content, and you can save the content to your hard drive.
eBUS Player allows you to control the serial ports of a GigE Vision or USB3 Vision device that is
integrated with a Pleora device. You can also transfer files to the device using the serial port, such as a
Non-Uniformity Correction (NUC) file, a Look-Up Table (LUT), or camera firmware.
The available serial ports vary, depending on the device you are using.
Other settings, such as parity and the number of stop bits, should also be configured by entering the
appropriate values for the settings in the PortCommunication section.
3. In the Port Selection list, click a serial or bulk port, depending on your device.
3. In the Speed list, select the baud rate that matches your GigE Vision or USB3 Vision device.
Additional settings, such as parity and the number of stop bits can also be configured. For more
information, see “Configuring the Serial Ports” on page 50.
4. Click the browse button that appears beside Send file and click the file that you want to upload to
the device.
5. Click Open.
6. For validation that the file was uploaded, select the Loopback validation check box.
For loopback validation to work, you must enable loopback mode for the serial port.
Note: If the device does not send loopback data back to the computer as quickly as it is transmitted,
congestion may occur in the serial FIFO, which can affect loopback performance.
The content of the files being transferred appears under Transcript. When the transfer is complete,
a brief message appears at the end of the transmitted content in the Transcript section.
For information about establishing a communication bridge, see one of the following knowledge base
articles on the Pleora Support Center (supportcenter.pleora.com).
• Knowledge Base Article: Establishing a Serial Bridge through Camera Link DLL Communication. This
article is for users who have a third-party camera configuration application that requires that them
use a Camera Link DLL to send serial commands to the camera.
• Knowledge Base Article: Establishing a Serial Bridge through a Serial Port (COM Port) Link. This
article is for users who have a third-party camera configuration application and want to use a serial
port on their computer to send serial commands to the camera, or would like to use a joystick
connected to a serial port on their computer to control the camera.
• Knowledge Base Article: Establishing a Camera Bridge with a CLProtocol DLL and GenICam
CLProtocol. This article is for users who have a CLProtocol DLL (provided by the camera
manufacturer) that allows them to configure and monitor settings within the camera using
GenICam.
• Knowledge Base Article: Establishing a Camera Bridge through GenCP. This article is for users with a
camera that supports the GenCP device control protocol.
• Save current session settings to a configuration file. Save the eBUS Player preferences and device
settings to a configuration file, which you can use to start a new session or load during future
sessions.
• eBUS Player preferences only. Save the eBUS Player preferences, such as the frame rate used to
display video in eBUS Player, as your default eBUS Player settings. This method also saves the
Communication control settings, which are used to communicate with your device, such as a
specific default heartbeat interval and answer timeout value.
• Device settings. Save the settings to the device’s flash memory as a User Set, allowing the device
settings to persist over power cycles.
A supplementary document is available on the Pleora Support Center that lists the settings that are saved
with each of the options listed in this chapter. For more information, see Saving eBUS Player and Device
Settings.
• “Saving Your eBUS Player and Device Settings to a Configuration File” on page 60
• “Saving Your eBUS Player Preferences” on page 61
• “Saving Your Device Configuration Settings to the Device’s Flash Memory” on page 61
When you save your settings to a configuration file, all of the eBUS Player preferences, Communication
Control settings, Image Stream Control settings, and device settings (for the particular device) are saved.
To load eBUS Player and device configuration settings from a configuration file
1. On the File menu, click Open.
2. Select the configuration file that you want to open.
If eBUS Player is not connected to a GigE Vision or USB3 Vision device, eBUS Player opens the file
and attempts to connect to the device from which the configuration file was created. Please note,
eBUS Player attempts to establish a connection based on the MAC address or USB 3.0 GUID of
the device. For GigE Vision devices, using the MAC address (instead of the IP address) allows eBUS
Player to connect to the device even if its IP address has changed.
If eBUS Player is connected to a GigE Vision or USB3 Vision device, a message appears to warn you
that the settings will be applied to the device. Click Yes to apply the settings that are stored in the
configuration file, or No to cancel the operation (and then disconnect from the device and connect
to a different device).
If you want to revert back to the original eBUS Player default preferences, you can do so at any time.
The Device control settings and the Image stream control settings are not saved when you click Save
Preferences. The Device control settings can be saved as part of the device “user sets”. For more
information, see “Saving Your Device Configuration Settings to the Device’s Flash Memory” on page 61. If
the Image stream control settings do not meet your needs, you must configure them every time you
connect to a device.
You can revert back to the original eBUS Player default preferences by clicking Restore Default
Preferences on the Tools menu.
Most iPORT devices support two User Sets: UserSet1, which consists of the user-configured settings, and
Default, which consists of the pre-configured settings, to which you can always revert. Settings identified
as Default in the Device Control dialog box cannot be changed.
UserSetLoadLastUserSet Shows the last User Set executed by the device from a UserSetLoad
command, or as a result of a reset of the device.
UserSetLoadStatus Indicates the success or failure of the last User Set applied. The User
Set can be applied through a power cycle or through user selection.
Technical Support
On the Pleora Support Center, you can:
Technical Support 63