Runtime Installation under Linux - siliconsoftware.de · 5 Runtime Installation under Linux 1 Introduction ... The file name of the device driver package ... 12 Runtime Installation

Installation under Linux

Version 5.5.1

Installation Guide

2 Runtime Installation under Linux

Imprint

Silicon Software GmbH Steubenstraße 46 68163 Mannheim, Germany Tel.: +49 (0) 621 789507 0 Fax: +49 (0) 621 789507 10 © 2018 Silicon Software GmbH. All rights reserved. Document Version: 5.0 Document Language: en (US) Last Change: January 2018


Contents

1 Introduction ................................................................................................................................. 5

1.1 Linux Distributions ................................................................................................................. 5

1.2 System Requirements ........................................................................................................... 5

1.3 Further Prerequisites ............................................................................................................. 6

2 Installing the Software ................................................................................................................. 7

2.1 Installation Components ....................................................................................................... 7

2.2 General Installation Procedure ............................................................................................. 9

2.3 Installing the Driver ............................................................................................................... 9

2.3.1 Extracting the Driver Sources ......................................................................................... 10

2.3.2 Compiling and Installing the Driver................................................................................ 10

2.3.3 Loading the Driver .......................................................................................................... 11

2.3.4 Setting the Access Rights ............................................................................................... 11

2.3.5 Driver Entries.................................................................................................................. 12

2.3.6 Additional Helpful Commands for Setting Up the Driver .............................................. 12

2.3.7 Further Information ....................................................................................................... 13

2.4 Installing the Software Components ................................................................................... 14

2.4.1 Using the Installation Script ........................................................................................... 14

2.4.2 Adapting the Environment ............................................................................................. 17

2.4.3 Setting User Access Rights ............................................................................................. 19

2.4.4 Placing the Applet Files .................................................................................................. 19

3 The Generic Service .................................................................................................................... 20

3.1 Starting the Generic Service Manually ................................................................................ 21

3.2 Stopping the Generic Service Manually .............................................................................. 21

3.3 Running the Generic Service directly in the Shell ............................................................... 21

4 Starting microDisplay and microDiagnostics ............................................................................. 22


5 Deinstallation ............................................................................................................................. 23

5.1 Deinstalling Drivers ............................................................................................................. 23

5.2 Deinstalling Software Components ..................................................................................... 23

6 Parallel Installations ................................................................................................................... 24

7 Support ....................................................................................................................................... 24


1 Introduction

1.1 Linux Distributions

The Silicon Software runtime environment is designed for machine vision applications, with

particular focus on durable systems.

To meet the demands for durability on operating system level, the following distributions qualify:

Ubuntu 16.04 with LTS support (32bit/64bit)

Red Hat Enterprise Linux 7.1 (32bit/64bit)

Ubuntu with LTS support and Red Hat Enterprise Linux offer a longer life cycle and a longer

maintenance period than other Linux distributions. The Silicon Software Runtime has been tested

on Ubuntu 16.04 LTS and Red Hat Enterprise Linux 7.1 with particular care.

However, the Silicon Software Runtime does not use a distribution dependent implementation. It

should work on other distributions as well. Implementation on one of these other distributions

should be tested in a given case.

1.2 System Requirements

To install and use the Silicon Software Runtime, you need the following components:

Kernel Version 4.10 (min 2.6.23, max at least 4.11)

Distributions Ubuntu LTS 16.04 (min 6, max at least 15.04)

Red Hat Enterprise Linux 7.1

glibc version: >= version 2.8

zlib version: >= version 1.2.3

libtiff version: >= version 3.8.2

C-Compiler Tested with gcc


Other Systems

Ubuntu LTS 16.04 and Red Hat Enterprise Linux 7.1 are the Linux distributions and

versions supported by the Silicon Software Runtime Software version 5.5.1 or higher.

Other systems must be tested by the user in each individual case.

1.3 Further Prerequisites

Root User Access Rights: For installing the Silicon Software Runtime, you need the according

access rights on the system. Therefore, you have to be able to either use sudo or log in as root for

certain steps of the installation process.

Frame Grabber Hardware: To install the runtime components, you do not need to install a

microEnable frame grabber in the system. Nevertheless, available hardware makes it a lot easier

to verify if an installation has been successful (for information on how to install the frame grabber

hardware, see the according section in the document Getting Started/Hardware).

http://www.siliconsoftware.de/download/live_docu/RT5/en/ind_intro.html


2 Installing the Software

2.1 Installation Components

The installation of the Silicon Software Runtime consists of three components:

Driver package

Software components and documentation package

Installation script

Driver package: The driver comes as source code and has to be compiled and installed before

usage (see section 2.3 below). The file name of the device driver package is:

menable_linuxdrv_src_4.2.4.tar.bz2

(The figures “4.1.0” indicate the version of the driver and may differ with another delivery.)

Software components and documentation package: The package contains all software

components and the documentation (in HTML and PDF). The components come as ready-to-use

binary files. You can use the installation script to extract and copy the files to their final

destination within the file system (see section 0 below).

The file name of the software and documentation package is:

siso-rt5-5.5.x-linux-amd64.tar.bz2 (for 64 bit systems)

siso-rt5-5.5.x-linux-ia32.tar.bz2 (for 32 bit systems)

(The figures “rt5-5.5.x” indicate the version of the software and may differ with another delivery.)

The following main software components are contained (amongst others):

Runtime libraries (SDK) as library (*.so)

Applets (*.so)

Header files and linker libraries (*.h and *.a) of the Software Development Kit (SDK)

Tools in form of executable files (command line and GUI tools for support, diagnosis

and parameterization)

Firmware files for the individual frame grabber types and models (*.hap)

Documentation


Installation script: To ease the installation of the software components, a shell script is delivered

which copies the software component files to their final destination (installation folder) and makes

entries in the system environment (see below for details). The file name of the installation script

is:

siso-rt5-5.5.x-linux-amd64-installer.sh (for 64 bit systems)

siso-rt5-5.5.x-linux-ia32-installer.sh (for 32 bit systems)

(The figures “rt5-5.5.x” indicate the version of the software and may differ with another delivery. )


2.2 General Installation Procedure

To install the Silicon Software Runtime, you have to carry out three steps:

Install the device driver for frame grabber microEnable III, microEnable IV and/or

microEnable 5

Install the software components and documentation

Adapt the system environment

2.3 Installing the Driver

To install the driver, you have to carry out four steps:

Extract the driver source code files (the drivers come as source code in a *.tar

archive)

Compile and link the driver sources

Load the driver

Set the access rights

Detailed Driver Installation Information

In addition to the following instructions, you may also refer to the „INSTALL“ file

(which you find in the *.tar archive together with the driver sources). It contains a

detailed description of the whole driver installing procedure, and tips for

troubleshooting.

Although the driver installation procedure has been tested most carefully, minor

difficulties can occur due to the manifold of systems. The troubleshooting tips in the

„INSTALL“ file provide you with starting points for those cases.


2.3.1 Extracting the Driver Sources

To extract the driver source files:

1. Open a terminal window.

2. Go to the directory where you want to extract the sources to.

No Blanks in Path to Directory

Make sure the path to the directory you want to use for compilation of the source

files contains no blanks. (The kernel build scripts accept no blanks in a path.)

Otherwise, compilation of the source files will fail.

3. Start extracting the driver sources by entering the command

tar xjvf menable_linuxdrv_src_4.2.4.tar.bz2

2.3.2 Compiling and Installing the Driver

To compile and install the driver:

1. Open a terminal window.

2. Go to the directory where you have the driver sources extracted to (see above).

No Blanks in Path to Directory

Make sure the path to the directory you want to use for compilation of the source

files contains no blanks. (The kernel build scripts accept no blanks in a path.)

Otherwise, compilation of the source files will fail.

3. Start the build procedure by entering commands

make && sudo make install

4. Enter your password when you are asked.

Now, all necessary files are built and installed.


2.3.3 Loading the Driver

To load the driver:

1. Enter command

sudo modprobe menable

If you have a frame grabber plugged into your system, you can check if the driver is loaded and

fully functional:

2. Enter command

dmesg | grep menable

2.3.4 Setting the Access Rights

After the driver has been loaded, the microEnable frame grabbers can only be accessed by users

that have administrative access rights.

Enabling user accounts

We recommend you assign all users you want to be able to access the driver (and

thereby the frame grabber) to the group “video”.

To assign users to the group “video”:

1. Enter the command

sudo usermod -aG video <username>

(Replace <username> with the user name of the user.)

After the user’s next login to the system, the changes in group membership are active. The user is

now able to fully use the microEnable boards from his/her own account.


2.3.5 Driver Entries

Entries by the driver are written into the file /etc/udev/rules.d/10-siso.rules.

2.3.6 Additional Helpful Commands for Setting Up the Driver

Command Result Application Area

insmod Show loaded modules and accessing programs

Diagnosis

modinfo

modinfo <modulename>

Show information on loaded modules Diagnosis

modprobe

Loading:

modprobe –a <modulename>

Unloading:

Modprobe –r <modulename>

Load/unload modules including implicit dependencies

Loading and unloading manually

depmod Enter information on module dependencies into file

/lib/module/<Kernelversion>/modules.dep

so that module can be loaded automatically during system start

Important step during Installation

- Load module automatically during system start:

Entry in file

/etc/modules

Important step during Installation

Table 1: Commands for Driver Set-Up


2.3.7 Further Information

Further information and guidance in case of difficulties you can find in document “INSTALL“ which

is located in the archive of the driver source files.

Driver Re-Installation after Kernel Update

Please keep in mind that after a kernel update, you have to re-build and install the

driver again.


2.4 Installing the Software Components

There are two options for installing the software components of the Silicon Software Runtime.

You can either

use the installation script that has come together with the other packages (as

described below), or

extract the files and copy them into the target directory of the installation.

2.4.1 Using the Installation Script

Read here how to install the Silicon Software Runtime under Linux using the installation script via

shell.

Using the call parameters of the installation script

If you use the shell script as described below, you will have to enter some installation-

relevant data during installation. Alternatively, you can use the according call

parameters of the installation script.

Use the command

[prompt] sudo ./[NameOfRuntimeInstallerFile] -h

to get an overview listing all available installation parameters, together with their

preset default values. The order in which you enter the parameters is of no relevance.


To install the Silicon Software Runtime using the shell script in the default location:

1. Boot the system.

2. Go to the directory that contains the Silicon Software Runtime installer.

Depending on the system you are using (32 or 64 bit), you will have been provided with

one of these two installer files:

siso-rt5-5.5.x-linux-amd64-installer.sh , or

siso-rt5-5.5.x-linux-ia32-installer.sh

3. Enter either

[prompt] sudo ./siso-rt5-5.5.x-linux-amd64-installer.sh

or

[prompt] sudo ./siso-rt5-5.5.x-linux-ia32-installer.sh

Access Rights

Make sure you have full administrative access to the folder where you want to

install the runtime in (e.g., as a root user). You must be able to execute files

within this installation folder.

Make sure the file can be executed. If not, use the chmod command. You can

change access permissions so that they correspond to the required setting by

using the chmod command:

sudo chmod +x [NameOfRuntimeInstallerFile]

This will install into the default location /opt/SiliconSoftware

Alternatively, if you want to install the Silicon Software Runtime in a different location:

4. Use the -d command to specify the directory where you want to install the Silicon Software

runtime in (without a slash at the end of the path):

[prompt] ./[NameOfRuntimeInstallerFile] -d [PathToTargetDirectory]

Now, the target directory you specified is displayed.


5. Confirm the target directory you have chosen by writing yes (you have to write the whole

word, to write just an y will not be enough).

Tip

Alternatively to the last steps, you can also specify an installation directory and

directly affirm your choice.

To do so, add an -y after the installation command:

[prompt] ./[NameOfRuntimeInstallerFile] -d [PathToTargetDirectory] –y

6. Depending on where you install the Silicon Software Runtime, you might need to elevate

the access rights by calling the installer with sudo.

Now, the installation process is started:

The installer file will be unzipped into the directory you specified.

The extracted files will be modified in so far as absolute paths are being set.

After successful installation, the absolute paths are displayed in the shell.

If you want to read the full installation log:

7. Go to the installation directory (using the cd command) and enter

[prompt] cat install.log.txt

Now, the content of the installation log file install.log.txt is displayed in the shell.


2.4.2 Adapting the Environment

After installing the runtime, the environment variables have to be set. You can either do this

automatically, or manually.

Setting Important Environment Variables Manually

After (re)installation of the Silicon Software Runtime, at least one environment variable needs to

be updated:

SISODIR5

The variable SISODIR5 must point to the installation directory where the runtime is installed.

1. Set SISODIR5 by using the following command:

export SISODIR5=/opt/SiliconSoftware/Runtime5.5.x

(in this example, /opt/SiliconSoftware/Runtime5.5.x is the directory where the runtime is

installed; specify the path to the installation directory according to your file system.)

2. Set the GenICam environment for the runtime:

export GENICAM_ROOT_V2_2=${SISODIR5}/genicam

export GENICAM_CACHE_V2_2=${SISODIR5}/genicam/cache

export

GENICAM_LOG_CONFIG_V2_2=${SISODIR5}/genicam/log/config/SisoLogging.prop

erties

3. To locate the corresponding modules PATH and LD_LIBRARY_PATH, use the following

commands:

export PATH=${SISODIR5}/bin:${PATH}

export

LD_LIBRARY_PATH=${GENICAM_ROOT_V2_2}/bin/<PLATFORM>:${SISODIR5}/lib

:${LD_LIBRARY_PATH}

<PLATFORM> is either “Linux32_i86” or “Linux64_x64”.


Note

When using Ubuntu 16.04 LTS or Red Hat Enterprise Linux 7.1, you can make these

entries for the current terminal in file

/etc/profile

Or

~/.profile

Adapting the Environment Automatically

After installing the runtime, the environment variables have to be set. This can be done

automatically. In this case, you simply have to start the process.

1. To start the automatic setting of the necessary environment variables, enter

[prompt] source <INSTALLDIR>/setup-siso-env.sh

Upon pressing ENTER, all environment variables required for using the runtime are set to

the appropriate values automatically.

2. You can read which environment variables have been set, and which values are being used.

To read the according file, enter

[prompt] cat <INSTALLDIR>/setup-siso-env.sh

Now, the content of the file is displayed in the shell.


2.4.3 Setting User Access Rights

We recommend to grant full access rights to all users to the directories

<INSTALLDIR>/bin/log

<INSTALLDIR>/genicam/cache

1. To allow anyone in the group video write access, call

sudo chown -R root:video <INSTALLDIR>/bin/log

sudo chmod -R g+w <INSTALLDIR>/bin/log

sudo chown -R root:video <INSTALLDIR>/genicam/cache

sudo chmod -R g+w <INSTALLDIR>/genicam/cache

Only when write access is enabled, the Silicon Software Runtime can place log files in these

directories. Without sufficient access rights, some tools and features may not work properly (e.g.,

microDiagnostics).

2.4.4 Placing the Applet Files

To use VisualApplets (*.hap) files created by Visual Applets:

1. Copy the (*.hap) files into this folder:

<INSTALLDIR>/Hardware Applets/<Platform>

<PLATFORM> refers here to the frame grabber hardware platform, e.g, mE4AD4-CL,

mE4VD4-CL, mE4VQ4-GPoE …

VisualApplets (*.hap) files enhance the image processing functionality of the frame grabber.


3 The Generic Service

The Program gs

The program gs implements the „Generic Service“ and is in the following referred to

as „Generic Service“.

The name conflicts with a commonly installed utility for linux, GhostScript. This might

cause confusion as to whether typing gs will start Generic Service, or GhostScript.

It is advisable to start the Generic service always using the full path.

When using a GigE Vision frame Grabber, you have to start the Generic Service before working

with frame grabber and runtime.

Important

The Generic Service must be always running.

We recommend to start the Generic Service at system start. Refer to the

documentation of your current distribution to get detailed information on how to do

that.

You could, for example, write an according Shell Script for starting the service, and

place it in directory

/etc/init.d/

And add a link to your runlevel directory, e.g.:

/etc/rc2.d/


3.1 Starting the Generic Service Manually

To start the service manually (via a terminal window):

1. To check if the service is running, enter:

[prompt] <INSTALLDIR>/bin/gs status

You will get a return saying "Service is running."

2. If you need to start the service, enter

[prompt] <INSTALLDIR>/bin/gs start

3.2 Stopping the Generic Service Manually

To stop the service manually (via a terminal window):

1. Enter:

[prompt] <INSTALLDIR>/bin/gs stop

2. To check if the service has really been stopped, enter:

[prompt] <INSTALLDIR>/bin/gs status

You will get a return saying "Service is not running."

3.3 Running the Generic Service directly in the Shell

You can also run the service directly in the shell.

To run the service directly in the shell:

1. Enter

[prompt] <INSTALLDIR>/bin/gs run

To stop the service when running in the shell:

Use the key combination

CTRL + C


4 Starting microDisplay and microDiagnostics

To set up and control your image acquisition system, you can use the programs microDisplay and

microDiagnostic which come as part of the installation package.

Important

Before running microDisplay, microDiagnostics, any other tool, or even an SDK

project, please make sure that for the specific runtime version you are using

the frame grabber is loaded with the required firmware, and

the required device driver is installed.

To open microDisplay:

1. Enter

[prompt] microDisplay

For further information, please refer to the microDisplay Documentation.

To open microDiagnostics:

2. Enter

[prompt] microDiagnostics

For further information, please refer to the microDiagnostics Documentation.

http://www.siliconsoftware.de/download/live_docu/RT5/en/documents/microDisplay.html

http://www.siliconsoftware.de/download/live_docu/RT5/en/Tools/mDiagnostics/mDiagnostics.htm


5 Deinstallation

5.1 Deinstalling Drivers

To uninstall the driver manually:

1. Enter the following commands in a terminal:

sudo rmmod menable.ko

sudo rm /etc/udev/rules.d/10-siso.rules

sudo rm /sbin/men_path_id /sbin/men_uiq

sudo rm `find /etc/modules -name menable.ko`

Note

Please note that ` above must be a backtick, usually entered as an accent grave.

Alternatively, you can:

Enter the find command seperately,

Specify the path of menable.ko, and then

Call sudo rm using the specified path.

5.2 Deinstalling Software Components

To deinstall software components of the Silicon Software Runtime:

1. Delete all files in the corresponding install directory.

2. Undo all manual changes you made to the system.


6 Parallel Installations

If you want to use multiple installations of the Silicon Software Runtime on one system, we

recommend the following procedure:

1. Install the newest driver on the system.

2. Switch between the installations by setting the environment variable SISODIR5 to the

according installation path.

This way, applications out of a specific installation can be started via scripts (that have been

adapted accordantly).

7 Support

For technical support please contact our support team:

mailto:[email protected]

Phone: +49 621 789 50 70

mailto:[email protected]


Contact Details

GmbH

Steubenstrasse 46

D - 68163 Mannheim, Germany

Phone: +49(0)621.789 507 0

Fax: +49(0)621.789 507 10

Email: [email protected]

Web: https://silicon.software

Inc.

(USA)

1 Tara Boulevard, Suite 200

Nashua, NH 03062, USA

Phone: +1 603 324 7172

Fax: +1 603 324 7101



America Inc.

3055 St-Martin Blvd., Suite 500

Laval, Qc., H7T0J3, Canada

Phone: +1 888.808 3670 Ext 101

Fax: +1 888.808 3670



Disclaimer

While every precaution has been taken in the preparation of this manual, Silicon Software GmbH

assumes no responsibility for errors or omissions. Silicon Software GmbH reserves the right to

change the specification of the product described within this manual and the manual itself at any

time without notice and without obligation of Silicon Software GmbH to notify any person of such

revisions or changes.

Trademarks

All trademarks and registered trademarks are the property of their respective owners.

Copyright Note

© Copyright 2018 Silicon Software GmbH. All rights reserved. This document may not in whole or

in part, be reproduced, transmitted, transcribed, stored in any electronic medium or machine

readable form, or translated into any language or computer language without the prior written

consent of Silicon Software GmbH.

Documents

Runtime Installation under Linux - siliconsoftware.de · 5 Runtime Installation under Linux 1 Introduction ... The file name of the device driver package ... 12 Runtime Installation