eBUS SDK For Linux Quick Start Guide PDF
eBUS SDK For Linux Quick Start Guide PDF
eBUS SDK For Linux Quick Start Guide PDF
Trademarks
CoreGEV, 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-0013, Version 11.0 7/10/19
Table of Contents
About this Guide . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1
About the eBUS SDK for Linux. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2
What this Guide Provides . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2
Documented Product Version . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2
Related Documents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3
Troubleshooting. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21
Technical Support . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23
i
Chapter 1
System Requirements
Ensure the workstation or embedded computer meets the following recommended requirements:
• At least one Gigabit Ethernet NIC (if you are using GigE Vision devices) or at least one USB 3 port
(if you are using USB3 Vision devices).
For supported USB 3 host controller chipsets, consult the eBUS SDK Release Notes, available on the
Pleora Support Center.
• One of the following operating systems:
• For the x86 Linux platform:
• Red Hat Enterprise Linux (RHEL), 64-bit
• CentOS 7, 64-bit
• Ubuntu 18.04 LTS (64-bit), 16.04 (32-bit or 64-bit), and 14.04 (32-bit or 64-bit)
Note: Ensure you have the Linux kernel header files, which are required to install the eBUS
Universal Pro for Ethernet Filter driver. The Linux kernel headers are typically installed on
your system when you install RHEL/CentOS or Ubuntu. If they are not present, as indicated
by an error message when installing the driver, see “Error message: Cannot find the files to
build kernel module in this PC” on page 22.
Tip: If there is a failure to compile and install the eBUS Universal Pro driver due to permissions or missing
dependencies, you can manually compile and install the driver. For more information, see “To manually
install the eBUS Universal Pro for Ethernet Filter Driver” on page 14.
Note: If the eBUS SDK installation is not successful, your system may be missing the required Linux kernel
headers. For more information, see “Error message: Cannot find the files to build kernel module in this PC”
on page 22.
Tip: To see installed packages, you can execute one of the following commands:
• On Ubuntu:
sudo dpkg -l | grep ebus
• On RHEL/CentOS:
sudo rpm -qa | grep ebus
If you use the eBUS SDK without a license, the following limitations apply:
• Received images (received from third-party GigE Vision or USB3 Vision transmitter devices) have
an embossed watermark.
• The raw data payload type cannot be received.
• Connections to a software-based GigE Vision device (developed with the eBUS Tx portion of the
Pleora eBUS SDK) will disconnect after 15 minutes.
• Certain device information strings cannot be customized by a software developer when creating a
software-based GigE Vision device, such as the device’s model name.
Understanding Licensing
Receiver and transmitter licenses are associated to the MAC address of a network interface card (NIC).
Depending on the type of license you are purchasing, you will need to provide the following information:
• For a receiver or developer seat license, provide the MAC address of a NIC in the workstation.
• For a transmitter license, provide the MAC address of a network interface in the embedded
computer that will run your software-based GigE Vision device.
Pleora includes the MAC address in the license file that you purchase, which allows the eBUS SDK to
accept the license. The MAC address is used to identify the workstation or embedded computer.
If the licenses folder is not created automatically, create the folder by executing the following command:
sudo mkdir /opt/pleora/ebus_sdk/<distribution_targeted>/licenses
Tip: If you are not sure if your device is a Pleora transmitter, observe the USB GUID that appears on the
device’s label or in your software application. If it begins with the Pleora vendor ID (28b7), it uses Pleora’s
transmitter technology.
To set up access for USB3 Vision devices that are not enabled with Pleora’s technology
1. Execute the following command:
sudo /opt/pleora/ebus_sdk/<distribution_targeted>/bin/set_udev_rules.sh script.
2. When prompted, enter the vendor ID assigned to the device’s manufacturer. This number often
appears on the device’s label.
3. Stop and restart the eBUS daemon by executing the following commands:
sudo service eBUSd restart
Note: The eBUS SDK daemon is used by the eBUS SDK for connection to USB3 Vision devices
and is also used to license the eBUS SDK’s transmit and receive capabilities.
• “Using the eBUS Universal Pro for Ethernet Filter Driver” on page 14
• “Enabling Jumbo Ethernet Frames” on page 15
• “Additional Optimization Steps” on page 15
When installing the eBUS SDK, if the eBUS Universal Pro for Ethernet Filter Driver fails to compile and
install the eBUS Universal Pro driver due to permissions or missing dependencies, you can manually
compile and install the driver.
If you would like to uninstall the filter driver, you can do so. Keep in mind that you can still work with
GigE Vision devices after you uninstall the eBUS Universal Pro for Ethernet Filter driver. However, the
operation of these devices is not optimized.
To manually install the eBUS Universal Pro for Ethernet Filter Driver
1. Navigate to the following directory:
/opt/pleora/ebus_sdk/<distribution_targeted>/module
2. Execute the following command:
sudo ./build.sh --kernel=/usr/src/<linux_headers>
Where <linux_headers> is the corresponding headers for the Linux4Tegra version that is installed.
For example, linux-headers-4.4.38-tegra.
3. After you compile the driver, install it by executing the following command:
sudo ./install_driver.sh --install
To start, stop, or check the status of the eBUS Universal Pro for Ethernet Filter Driver
• Execute the following command:
sudo /opt/pleora/ebus_sdk/<distribution_targeted>/module/ebdriverlauncher.sh <command>
(where <command> can be start, stop, or status)
You can also check the status of the driver by executing the following command:
lsmod | grep ebUniversalProForEthernet
Tips:
To see the name of the NIC in your system, execute the following command:
sudo lshw -c network -businfo
To see the current maximum transmission unit (MTU) value, execute the following command:
ifconfig | grep MTU
You must disable the firewall before using GigE Vision devices. Some optimization may be desirable
before using GigE Vision or USB3 Vision devices with the eBUS SDK in a production environment, as
was discussed in “Optimizing Operation with GigE Vision Devices” on page 13.
A list of samples, with a description of each, can be found in the index.html file in the share/samples
directory.
Compilation will fail for GUI-based samples if the Qt development package is not installed. For Qt version
information, see “System Requirements” on page 5.
For information about building the sample applications and creating your own applications, see the eBUS
SDK C++ API Quick Start Guide.
If you encounter issues with running the samples due to the environment variables not being set, you can
restart your computer or set the environment variables manually, as outlined in “The sample applications
compiled successfully, but they will not run.” on page 22.
Troubleshooting
Cannot detect or connect to GigE Vision devices.
In the Device Selection dialog box, select the Show unreachable Network Devices check box.
If the device does not use Pleora’s transmitter technology and the device’s vendor ID has not been added
to the eBUS SDK, you will be unable to detect or connect to it. To see if your device uses Pleora
transmitter technology, observe the USB GUID that appears on the device’s label or in your software
application. If it begins with the Pleora vendor ID (28b7), it uses Pleora transmitter technology. For
information about accessing the camera, see “Providing Access to Third-Party USB3 Vision Transmitter
Devices” on page 11.
Troubleshooting 21
The sample applications compiled successfully, but they will not run.
As superuser, execute the /opt/pleora/ebus_sdk/<distribution_targeted>/bin/install_libraries.sh
script to ensure that the required libraries have been added to the system. Also, ensure that you source the
bin/set_puregev_env script to set the environment variables (source set_puregev_env).
Tip: You can also launch the sample applications using the RunFromEnv.sh script. For example:
Error message: Cannot find the files to build kernel module in this PC
This error, which can occur when you are installing the eBUS SDK or eBUS Universal Pro for Ethernet
Filter Driver, indicates that the kernel headers are not present on your system. The kernel headers are
required to compile one of the Linux modules and they must match the system kernel version.
To install the Linux kernel headers, execute one of the following commands:
• On Ubuntu:
sudo apt-get install linux-headers-$(uname -r)
• On RHEL/CentOS:
sudo yum install kernel-devel
The eBUS SDK applications freeze or stop responding on the Jetson module
Ensure that you have chosen the nvpmodel mode, increased the CPU clock the maximum value, and
configured jumbo packets for 9000 bytes. For more information, see “Choosing Optimal Setting for the
Jetson Modules” on page 7.
Technical Support
On the Pleora Support Center, you can:
Technical Support 23