VisionBox Interface Library  1.7.9.0 (2023-09-08)
VisionBox Interface Library Documentation

Introduction

The VisionBox Interface Library for C++ gives the user access to interfaces and special features of the following IMAGO devices:

  • VisionBox AGE-X, all generations
  • VisionBox LE MANS
  • VisionBox DAYTONA
  • VisionBox AI
  • VisionBoards (PCIe cards)
    • Machine Vision Controller
    • Camera Link grabber
    • Smart NIC with PoE/ToE
  • VisionCam XM
  • VisionSensor PV
  • Machine Vision Manager (external USB device)
Hardware.jpg

Real-Time Communication Controller

The Real-Time Communication Controller (RTCC) is the central device controlling the different interfaces. The major part of the controller is implemented by a FPGA. It provides user-programmable logic and internal units operating independent from the operating system. Many time-critical applications can be realized without using a real-time operating system.

Note that the VisionSensor PV doesn't provide the RTCC and therefore has a limited range of functions.

The Library

  • The library is platform and architecture independent.
  • All classes and functions for this library reside in the namespace VIB.
  • The library provides a single header file to the user: VIB_Interface.h
  • The different hardware devices and functional units are represented by device class objects like VIB::DigitalOutput, VIB::Multiplexer, ..., see page Devices for a list of available device class types.
  • All library functions are thread-safe. Each device object can only be opened by one process at the same time.

Please have a look at the First Steps and Devices page for code examples and an introduction on how to use the API.

Hardware support

The following table lists the supported devices / classes for the different hardware platforms. Please note that the actual presence of devices depends on the actual hardware configuration and installed options:

Supported devices by different hardware platforms
Hardware Platform Hardware entity
(see eHardwareType)
Generic System Type
eSystemType
Supported device classes
(hover for description)
This class contains functions associated with the hardware component (serial number, system temperature, watchdog, firmware updates). This class controlls the LED Strobe Controller. This class controls the digital camera trigger output. This class controls the status LEDs. This class controls a group of digital input signals. This class controls a group of digital output signals. This class controls the RS-422 interface. This class controls the FPGA Trigger Unit. This class controls the Multiplexer unit which connects signal sources and sinks with each other. This class controls the I/O Scheduler which allows to store and emit output signals in hard real-time. This class represents the PowerOverEthernet (PoE) module, which allows gathering information about the current state of attached PoE devices. This class represents the TriggerOverEthernet (ToE) module which allows the generation of GigE Action Commands. This class represents the Camera Link grabber module. This class represents the RS-232 interface which allows sending and receiving data over a RS-232 port. This class controls the status display of the Machine Vision Controller.
VisionBox AGE-X1 Mainboard with RTCC SYST_BASEBOARD yes yes yes yes yes yes no no no no
VisionBox AGE-X2 Mainboard with RTCC SYST_BASEBOARD yes yes yes yes no yes yes no no no
Smart NIC SYST_NETWORK yes no no no no no no yes no no
Camera Link SYST_CL yes no no no yes no no no yes no
VisionBox AGE-X3 I/O board with RTCC SYST_BASEBOARD yes yes yes yes no yes yes no no no
VisionBox AGE-X4[1] Mainboard without RTCC SYST_BASEBOARD yes no no no no no no no no no
VisionBox AGE-X5 Mainboard with RTCC SYST_BASEBOARD yes yes yes yes no yes yes no no no
Smart NIC SYST_NETWORK yes no no no no no no yes no no
Camera Link SYST_CL yes no no no yes no no no yes no
VisionBox LE MANS [1] Mainboard with RTCC SYST_BASEBOARD yes yes yes yes yes yes yes no no no
VisionBox DAYTONA Mainboard with RTCC SYST_BASEBOARD yes no yes yes yes yes yes no yes no no
VisionBox AI Mainboard with RTCC SYST_BASEBOARD yes yes yes yes yes yes yes no yes no
VisionBoards (PCIe cards) Machine Vision Controller (RTCC) SYST_INTERNAL_PCI yes yes no yes yes yes yes no no yes
Smart NIC SYST_NETWORK yes no no no no no no yes no no
Camera Link card SYST_CL yes no no no yes no no no yes no
VisionCam XM Camera with RTCC SYST_BASEBOARD yes yes no yes yes yes yes yes no yes no no
VisionSensor PV Camera without RTCC SYST_BASEBOARD yes no no yes no no no no no no
Machine Vision Manager 1 USB device with RTCC SYST_EXTERNAL_USB yes yes yes yes yes yes yes no yes no no
Machine Vision Manager 2 USB device with RTCC SYST_EXTERNAL_USB yes yes no yes no yes yes no no no

  1. The VisionBox AGE-X4 and the VisionBox LE MANS additionally use VisionBoards.
    The VisionBox AGE-X4 normally contains a PCIe Machine Vision Controller card, because the RTCC is not present on the mainboard.