IDS Software Suite 4.92.0 for Linux

Contents

System requirements   

For operating the uEye cameras, the following system requirements must be met:

  USB 3.1/USB 3.0 camera USB 2.0 camera GigE camera
Interface USB 3.0 port (Super Speed) USB 2.0 port (High Speed 480 Mbps, "Full Powered" 500 mA) Gigabit Ethernet port (1000 Mbps)
CPU Intel i5 or better Intel i3 or better Intel i3 or better
Memory min. 2 GB min. 2 GB min. 2 GB
Disk space min. 500 MB min. 500 MB min. 500 MB
Operating system Linux > Kernel 3.4 (32/64-bit)
For UI-3013XC: Linux >= Kernel 3.13 (32/64-bit)
Linux > Kernel 2.6 (32/64-bit) Linux > Kernel 2.6 (32/64-bit)

Depending on the sensor model, the camera performance may be limited with the minimum system requirements.

Compatibility list

The Linux operation system is one of the most widely ported, running on a huge amount of architectures and provided over many distributions. Although we are trying to be compatible among the whole range of kernel versions and distributions, there is no guarantee that the IDS Software Suite is working on a specific untested combination.

Below is a list of successfully tested distributions for the current IDS Software Suite:

Configuration notes   

Notes on older camera models   

Former versions of the IDS Software Suite can be downloaded in the software archive under https://en.ids-imaging.com/ueye-software-archive.html.

UI-3013XC

The UI-3013XC camera model is supported by driver version 4.92 for the last time.

UI-112xSE, UI-512xSE, and XS

The models UI-112xSE, UI-512xSE, and XS are supported by driver version 4.91 for the last time.

UI-1008XS

The UI-1008XS camera model is supported by driver version 4.81 for the last time.

GigE uEye RE

The GigE uEye RE camera family is supported by driver version 4.80 for the last time. The GigE uEye RE PoE camera family is not affected by this.

USB 2 uEye RE

The USBE uEye RE camera family is supported by driver version 4.80 for the last time.

USB 2 uEye ME

The USB uEye ME camera family is supported by driver version 4.40 for the last time.

GigE uEye HE

The GigE uEye HE camera family is supported by driver version 3.82 for the last time.

USB uEye SE

The models UI-121xSE, UI-141xSE, UI-144xSE, UI-145xSE, and UI-154xSE-C have been discontinued and will not be tested from driver version 3.80 on. IDS Imaging Development Systems GmbH therefore cannot guarantee that these models will provide full functionality with new driver versions and operate without problems.

uEye memory board USB uEye SE/USB uEye RE

The optional memory board of the USB uEye SE and USB uEye RE camera series has been discontinued. The functions required to operate the memory board are supported up to and including driver version 3.25.

Older USB 2 uEye CMOS cameras

All USB CMOS cameras with USB board revision < 2.1 are not supported by driver versions > 3.10. How can you check whether your camera is affected?

Check the serial number of your camera. If it is less than 400 26 27000, your camera will not be compatible with driver versions > 3.10.

If your camera is not compatible with driver versions > 3.10, you can of course continue to use your present driver (up to version 2.40).

Installation   

You must be root to install.

Installing the (self-extracting) archive

  1. Copy the setup file into a directory on the hard disk (you need write access to decompress).
  2. Go to the directory you copied the files into and run the setup program script by typing (replace the wildcard with the actual version identifier of the installer file)
    $> sudo sh ./ueyesdk-setup*.run
  3. If any problems occurred, the known issues section below or the generated report file (/tmp/ids_ueye_YYYYMMDDhhmmss_PID.log) may include a hint to solve them (see installer output). If not, contact your local distributors support and submit the report file.

Note: If older configuration files are present from a previous installation, they are backed up before the new configuration files are created.

Installed file structure

The created files will be installed in following directories (if you have not uninstalled the USB or GigE package):

/var/run/ueyed
/usr/lib/libueye_api.so.[version] 32-bit uEye shared library After ldconfig has finished, a symbolic link libueye_api.so should exist to provide linkage against libueye_api.so. Note that only the version for the current target architecture will be installed, e.g. the 32-bit library will only be installed on a 32-bit system and the 64-bit library will only be installed on a 64-bit system.
/usr/lib/libueye_api64.so.[version] 64-bit uEye shared library
/usr/include/ueye.h Development header file For compatibility with older versions, a symbolic link /usr/include/uEye.h will be created. It is strongly recommended to use the lower case file name in new projects.
/usr/bin/ueyeethd GigE uEye daemon binaries Configuration files are located under /etc/ids/...
/usr/bin/ueyeusbd USB uEye daemon binaries Configuration files are located under /etc/ids/...
/usr/share/ids/ueye/licenses Third party licenses and copyrights  
/usr/lib/firmware/ids/ueye USB3 firmware binaries  
Runtime directory  
/etc/init.d/ueyeethdrc GigE uEye daemon runlevel control script Is only installed if systemd is not available on your system
/etc/init.d/ueyeusbdrc USB uEye daemon runlevel control script Is only installed if systemd is not available on your system
/lib/systemd/system/ueyeethdrc.service GigE uEye daemon service file  
/lib/systemd/system/ueyeusbdrc.service USB uEye daemon service file  
/usr/src/ids/ueyedemo IDS demo sources  
/usr/share/ids/ueye/readme.txt IDS SDK readme  
/usr/share/ids/ueye/manual IDS SDK user manual  

 

Additionally, the installer provides the following tools - unless not indicated otherwise, the tools will be installed to /usr/bin:

ueyesetid Camera ID configuration tool
ueyesetip Camera IP address configuration tool
idscameramanager IDS Camera Manager
ueyedemo Demo application
ueyereport Report generator tool
ueyesetup IDS SDK setup tool
For installing/uninstalling the self-extracting tar archive

User/group

The installer will create a system group 'ueye' and a system user 'ueyed' to run the daemon with. Currently there are no access control restrictions, but be aware that this might change in the future.

First start   

Note: It is recommended to use systemd for controlling the daemons. Do not mix calls of systemd and init.d!

  1. After installation, you may start the uEye daemons separately with systemd by typing:
    $> sudo systemctl start ueyeethdrc
    $> sudo systemctl start ueyeusbdrc
    If your system does not support systemd yet, you can use the following commands:
    $> sudo /etc/init.d/ueyeethdrc start
    $> sudo /etc/init.d/ueyeusbdrc start
    Before you stop the uEye daemons, make sure that there are no connections to it:
    $> sudo systemctl stop ueyeethdrc
    $> sudo systemctl stop ueyeusbdrc
    Or without systemd:
    $> sudo /etc/init.d/ueyeethdrc stop
    $> sudo /etc/init.d/ueyeusbdrc stop
    Alternatively, if you have a working graphical environment, the daemons may be controlled via the IDS Camera Manager (started as root)
  2. Set camera ID
    To set the camera ID, you may use the IDS Camera Manager or the ueyesetid tool.
  3. Set camera IP
    To set the camera persistent IP address, you may use the IDS Camera Manager or the ueyesetip tool.

USB 3.1/USB 3/USB 2 uEye camera

After you installed the software, connect the camera to the PC, using the corresponding USB cable. The camera will be recognized automatically. When you connect a camera with a PC or a new USB port for the first time, it is detected as a new device and the firmware is uploaded to the camera. When the camera has been correctly installed, the LED on the back of the camera lights up green and the camera is displayed in the list of the IDS Camera Manager.

USB 3/USB 3.1 uEye cameras under USB 2.0

USB 3/USB 3.1 uEye cameras are limited usable under USB 2.0. Depending on the camera model, not all camera functions are available in USB 2.0 mode. USB 3/USB 3.1 uEye cameras are optimized for USB 3.0 ports and are not tested by IDS Imaging Development Systems GmbH under USB 2.0.

Please note that due to the high performance of modern sensors, some USB 3/USB 3.1 uEye models are not supported in USB 2.0 mode anymore, as the USB 2.0 interface does not provide enough power.

GigE uEye camera

After you installed the software, connect the camera with the network. Check the power supply to the camera. Use either an external power supply or - depending on the model - via PoE (Power over Ethernet).

Attention: The camera should not be supplied through both voltage sources at once as this can irreparably damage the camera.

Before you can use the camera on the network, you need to assign a valid IP address to the camera in the IDS Camera Manager.

Note regarding GigE uEye cameras

By default, the installer configures the default ethernet network interfaces. If you use another network interface to connect your cameras, insert the interface name at the interface configuration parameter in "[Parameters]-Interfaces" of /etc/ids/ueye/ueyeethd.conf. You must be root to edit the configuration file.

The GigE uEye daemon network interfaces may be configured with the IDS Camera Manager if a graphical environment is available.

Note: ueyeethd must be stopped before manually editing the configuration file!

Known issues   

This section lists known issues that might occur in this release.

List of contained files / dependencies   

See list on https://en.ids-imaging.com/open-source.html

Uninstallation   

Uninstalling the (self extracting) archive

You should always use the setup script that came with the previous installation to ensure proper system cleanup. Do not attempt to remove the IDS Software Suite manually.

Note: The configuration files are not uninstalled and remain on the system.

© 2019, IDS Imaging Development Systems GmbH

IDS Imaging Development Systems and uEye are registered trademarks of IDS Imaging Development Systems GmbH.

 

IDS Imaging Development Systems GmbH
Dimbacher Str. 6-8
74182 Obersulm, Germany
https://en.ids-imaging.com