*************************************************************
*
*   STEMMER IMAGING COMMON VISION BLOX (CameraSuite)
*
*************************************************************
*
*   Setup for UBUNTU based Linux distributions
*
*************************************************************

Tested with:
* Ubuntu 16.04 (32Bit)
* Ubuntu 16.04 (64Bit)
* Unity / Xfce desktop environment

*************************************************************

Installation:
=============

* Start the install_cvb.sh script to install all packages.

* A restart is required after the installation to have the necessary environment
  variables applied.

Licensing:
==========

* If available add your CVB CameraSuite License Key for your camera via the
  "CVB Licensing Console".
  Start it via the start menu or by excuting
  "sudo LicenseManager"
  in the console/terminal. Then click on "Enter/Edit CameraSuite Codes" and add
  your Camera Suite License Key via the new Entry button (top right).


Documentation:
==============

* The documentation is available as chm-files in /opt/cvb/doc/

* To view these files you need to install a chm viewer.
  (such as kchmviewer)


Quick start:
============

* Start the "CVB GeniCam Browser" through your Start menu or by executing
  "GenICamBrowser"
  in the console/terminal and verify if you get an image from your camera. If
  no camera is found or the acquisition does not work use the troubleshooting
  guide below.

* Create your (first) GenICam.ini file
  Use the "Add selected Device to the configuration" to add cameras to your
  configuration.
  Click on the save button to save the configuration to the GenICam.ini file.

* The GenICam.ini file is located in /etc/opt/cvb/drivers/ and holds all
  configured properties set by GenICamBrowser. Alternatively you can edit the
  file manually to change additional settings. More information about these
  settings can be found in the GenICam User Guide:
  "/opt/cvb/doc/GenICam_CVB_UserGuide.chm"

* Build and run the GrabConsoleExample to test the acquisition of your camera.
  This simple example can found here:
  "/opt/cvb/tutorial/ImageManager/GrabConsoleExample"
  The example provides a make file as well as a CMake file.

* If you are looking for a more advanced example you should take a look into the
  ComplexMultiOsConsoleExample
  "/opt/cvb/tutorial/ImageManager/ComplexMultiOSConsoleExample"


Troubleshooting:
================

For device handling problems like IP configuration please refer to the
GenICam_CVB_UserGuide:
"/opt/cvb/doc/GenICam_CVB_UserGuide.chm"
or online at
http://help.commonvisionblox.com/GenICam-User-Guide/
for the current version of the document.

Known Problems:
---------------

* "Ignore Subnet Discovery" of the GenICamBrowser for GigE Vision cameras is
  not working.

* On Linux the default size of concurrent USB transfers is limited to 16MB.
  Check the value with the command:
  "cat /sys/module/usbcore/parameters/usbfs_memory_mb"
  The combined payload transfer size (usually image size) of all connected
  cameras must be below that limit.
  If larger transfers are required, the value can be adjusted through grub boot
  parameters in
  "/etc/default/grub"
  Set
  GRUB_CMDLINE_LINUX_DEFAULT="quiet splash usbcore.usbfs_memory_mb=1000"
  After that update grub
  "sudo update-grub"
  The updated setting is applied after the next boot.

Setup settings modifying your system:
-------------------------------------

* Change to /proc/sys/net/core/rmem_max to improve GigE Vision receive
  performance. If this is an issue it can be reversed by editing
  "/etc/sysctl.d/10-cvb.conf"

* Change to the udev rules to make USB 3 Vision cameras accessible to default
  users (enabling file access by adding the devices to the "video" group). If
  this is an issue you can find the rule at
  "/etc/udev/rules.d/59-cvb_u3v.rules"
  As there is no standard other software can override these settings.
