The SynView API is an application programming library which provides a unified and user friendly API for easy application building. It is based on current GenICam and GenTL standards.

Introduction

The SynView API is an application programming library which provides a unified and user friendly API for easy application building. It is based on current GenICam and GenTL standards.
The GenICam and GenTL are the current standards in the vision industry for digital imaging devices, assuring compatibility between HW and SW of different vendors. While the GenICam API is strongly object oriented the GenTL API is a plain C API with a completely different way to set and get items.

The SynView API is designed to free you from unnecessary workload and lets you concentrate on your problem or the solution of it. It hides the standard implementation details and provides a simple to use, unified application programming interface. Besides this, it also provides additional useful functionality, like displaying images, pre-processing, saving to files etc. It is designed as a tool to do simple tasks as well as complex applications. One of the aims of SynView is to avoid inventing a new terminology. Wherever possible it uses terminology from the above mentioned standards. In the following we will assume that you are not familiar with the GenICam and GenTL standards, so let's start with some elementary explanations.

SynView acts like a GenTL consumer which means the hardware is accessed through a GenTL library (so called provider). This library will be provided by a camera vendor in case their camera is not compatible on a lower level. The SynView set of libraries is delivered also with an own GenTL provider library designed for NET GmbH hardware.

SynView can be considered not only an API for cameras from NET GmbH, but also can be used for devices from other vendors as well as long as an appropriate GenTL library for this hardware is available. In case of compatibility of cameras on a lower level there might be no need for a GenTL library from the camera vendor. For example, Gigabit Ethernet cameras are usually compatible on a GigE Vision protocol level and can work directly with the NET GmbH GenTL provider library.

The GenICam standard specifies how the camera (or in general a device) exposes its features and how they can be controlled. The way how device features are displayed in the feature tree in the SynView Explorer is derived from the GenICam standard.
Note that in this manual we often use for simplicity the term camera instead of device, because in most cases you will use it with a real physical camera. The GenICam standard is not limited to cameras. An imaging device can be for example a scanner or any other device which provides images.

Reference Documents

	File	Modified

SynView Explorer

	SynView by NET is a development environment based on GenICam/GenTL standards. It contains a high-performance and user-friendly API to make it easier to create applications. Application engineers can concentrate fully on developing your solution. More information can be found under the following link .
	The SynView package contains the SynView Explorer tool, which allows to enumerate, connect and configure camera, acquire images or generate sample source code for SynView API. It is a useful tool for testing both the SynView and camera functionality.

Download link for Host SynView can be found here .

During production the latest version of the SynView with iAMGigEServer is installed to camera under the path /opt/synview/bin/.

To learn more how to use SynView Explorer we refer to the SynView Explorer manual.

Testing the camera

Capture an image or test new camera settings with SynView Explorer. There are two ways:

Using iAMGigEServer with iam and receiving the image data with SynView Explorer on a host system. iam acts like a normal GigE Vision camera.
Native: Using the OpenSSH connection with -server forwarding. From the command line it is possible to start sv.explorer with the command below.

ssh -Y root@192.168.1.10 "(export XILINX_XRT=/usr/ ; /opt/synview/bin/sv.explorer)"

Using OpenSSH from a Windows Host we recomend to use and configure the tools discribed in section Windows Host System to support all features (x-server forwarding et al.).

Since iAMGigEServer is executed via autostart, stop iAMGigEServer before using SynView Explorer natively on the camera (Option 2). See section iAMGigEServer

The latest version of SynView Explorer is required for iam. For this, update the host system. See Download latest SynView Package .

	Connect the camera to test. Select it in the list of found cameras and press the “Connect camera” button.
	Configure the camera features. Pay attention especially to features in Image Format Control and Acquisition Control categories.
	When prepared, click the “Start acquisition” button. The camera should start acquiring. If not, verify again, if the camera was not set to triggered mode, while no trigger was attached.
	While the acquisition is active, the runtime parameters can be adjusted, such as exposure time or gain. Basic acquisition parameters, such as pixel format or trigger mode get locked when the acquisition starts.
	When finished, click the “Stop acquisition” button and exit.

It is a common source of error to operate a monochrome sensor in the color space. In case of a monochrome sensor change the Pixel Format to Mono 8 .

Live View Performance

From the line just above the live image, the frames count per second is visible on iam. Displaying the images remotely over an OpenSSH connection will impair the performace very much and will add some delay as well. In the example below, the sensor runs with 147 frames per second and 1.8 frames per second are displayed remotely.

See what your camera model can achieve by looking up the maximum frame rate at Camera Model Overview table.

An OpenSSH session using live imaging has a poor performance but can help to change camera parameters or test new features.

Please be aware of the low frame refresh rates with this type of connection. A better refresh rate will be achieved with the "GigE Vision Server of SynView" in the future.

Basic Camera Features

This section shows the most essential camera features relevant for the basic tests.

The SynView Explorer displays by default the basic camera features intended to handle the most common tasks. To display also the more advanced features, switch to the “expert” feature level. Note that the third available level, “guru”, is intended just for debugging and should not be used for standard operation.

Feature Category	Feature Name
Image format The basic properties of the acquired image can be configured through features in the Image Format category.	Pixel format The “Pixel Format” feature is an enumeration allowing to specify the type of image data delivered to the application buffer. The available pixel formats differ among camera models. In general, they can be - Monochrome, with various number of bits per pixel, e.g. Mono 8 or Mono 12. - Bayer encoded, with sensor-dependent Bayer formats, e.g. Bayer GR 8 or Bayer BG 8. In this case the application needs to decode the Bayer encoded image buffer to get a proper color image — SynView API provides functions for this. - RGB color format, providing true RGB output, in this case the Bayer decoding is performed directly by the camera. Image size The camera will acquire full size image by default. The acquired image size can be reduced using the “Width and Height” features, which set the acquired image size in pixels. The field of view will be automatically centered within the full sensor image.
Acquisition parameters The luminance of the acquired image can be controlled either explicitly through exposure time and gain functions, or automatically through corresponding auto-functions.	Exposure time The “Exposure Time” feature in “Acquisition Control” category configures the length of the exposure in microseconds. Analog gain Analog gain to be applied on the sensor during acquired image digitization can be configured through corresponding features in “Analog Control” category. Verify that the “Gain Selector” feature is set to analog (some cameras models support also digital gain). Now, the gain feature controls the desired analog gain value in decibel. Auto-functions Selected camera models support automatic gain and/or automatic exposure functions, when the camera keeps adjusting given parameter automatically, to maintain constant image luminance. The features will be displayed in the feature tree only if the camera supports them. To switch on the auto function, navigate to corresponding control feature, “Automatic Exposure in Acquisition Control” category or “Automatic Gain in Analog Control” category and switch them from “Off” to “Continuous”.
Triggered acquisition The camera starts by default in “free running” mode — acquiring continuous stream of image frames. On the other hand in the triggered mode, the acquisition of individual frames can be explicitly controlled by hardware or software triggers. The trigger related features are located in the “Acquisition Control” category.	Triggered mode To switch the camera to “Triggered mode”, open the “Trigger Selector” sub-tree and set “Trigger Mode” to “On”. After starting the acquisition again, the camera will acquire images only when explicit trigger signal arrives. Trigger source The Trigger source enumeration allows to select where should the camera “listen for triggers”. You can select either Software or one of the camera's I/O lines. The assignment of the I/O lines to the connector pins is described in Section, Connector and cable description . Software triggering The Software triggers can be issued during active acquisition in triggered mode, regardless whether the trigger source is set to Software or a physical I/O line. To apply the software trigger, select the “Generate Software Trigger” feature and click the button in the tool bar. Strobe The strobe can be configured using features in the “Digital I/O Control” category, after switching the feature visibility level to “expert”. Select the desired output line, where the strobe pulses should be applied through Line Selector (the I/O line mapping to interface connector pins is described in Section, Connector and cable description ). Switch the strobe on for the selected line by setting Line Source to “Exposure Active”. The camera will issue a strobe pulse aligned with the exposure for every acquired frame. The strobe output is available only in triggered mode. In case the camera has an integrated Strobe Ring, its Strobe can be controlled through the “Strobe Control” category. Select which Clusters to use with Strobe Enable. Strobe Duration sets the length of the Strobe Pulse.
Device Control Information about the camera. It is frequently necessary to query the basic information about the camera. The information is available through features in the Device Control category.	Device identity The most important features identifying the camera are Vendor Name and Model Name. The camera's serial number is stored as string in feature Device ID (available only in “expert” feature level). Finally, the “nick-name” used to identify the device is accessible (read/write) in DeviceUser ID. Firmware version The version of the firmware loaded on the camera is accessible as string in feature Device Firmware Version.

iAMGigEVisionServer

Introduction

iam can be recognized by common system architectures as a standard GigE Vision device.

With the iAMGigEServer running on the camera, iam acts like a GigE Vision and GenICam compliant camera with freely definable features. Live images as well as processed images can be delivered as a GigE Vision stream to the host. The iAMGigEServer is GigE Vision standard compatible and thus works with any standard compliant software interface from other suppliers.

The iAMGigEServer is a small software application, which is preinstalled to the camera autostart script. It provides a comfortable way to set up the vision application on a host system. Obtaining a high-performance live stream from the camera, analyzing image quality or testing new camera settings can be done quickly.

While iAMGigEServer is running, it will block the camera access for other applications e.g. like SynView Explorer running directly on the camera.

iAMGigEServer is pre-installed and out of the box by default.

After setting up the system it is necessary to disable the iAMGigEServer autostart for accessing the camera hardware from the iam camera application.

This can be done with SynView IP Config Tool.

Requirements

To use the iAMGigEServer it is mandatory to configure the network controller for high data throughput. See Configure your Network Controller for more details.
Installation of the latest version of SynView to host system. See Download latest SynView Package for download link.
During production the latest version of the SynView Explorer and iAMGigEServer is installed to camera. Only in special cases it is necessary to update the camera. See section SynView Update Tool for detailed information.
The behaviour of the iAMGigEServer can be controlled by the SynView IP Config Tool. SynView IP Config Tool can be found on your host PC under "C:\Program Files\SynView\bin\sv.ipconf.x64.exe"

Start iAMGigEServer

iAMGigEServer is pre-installed and starts with an autostart script. Therefore it is usually not necessary to start iAMGigEServer manually.

If the sv.ipconf.x64 tool does not find a connected camera, iAMGigEServer is stopped or disabled.
To get access to iam via SynView IP Config Tool,
an openSSH connection to the camera has to be established and iAMGigEServer has to be started manually.

ssh root@192.168.1.10
root@iam_mipi:~# /opt/synview/bin/sv.iAMGigEServer

From Comand Line (eg. SSH)
- sv.iAMGigEServer

Stop iAMGigEServer

From Comand Line (eg. SSH)
- create file: "/opt/synview/bin/sv.iAMGigEServer.stop":
  touch /opt/synview/bin/sv.iAMGigEServer.stop
With SynView IP Config Tool (sv.ipconf.x64.exe) tool
- Open SynView IP Config Tool .
- Now you should see the iam camera under "device model".
- Press button "Connect and configure".
- Press button "Stop GigEServer".
- iam immediately disappears from sv.ipconf-tool.

With SynView Explorer on the host PC
- Open sv.explorer.x64.exe.
- Now you should see iam under “found cameras“.
- Open the iam.
- Press “Show guru level“.
- Open “Smart Application Features“.
- Press “Smart Application Exit Event“ command.
- iam disappears from SynView Explorer.

Disabling the start of iAMGigEServer after booting

Open SynView IP Config Tool .
Now you should see the camera under "device model".
Press button "Connect and configure".
Set "Boot switch" checkbox to checked.
Set Boot switch mode to "None".
Press button "Apply and disconnect".

Re-enabling the start of iAMGigEServer after booting

You need an openSSH connection to the camera to start iAMGigEServer.

ssh root@192.168.1.10
root@iam_mipi:~# /opt/synview/bin/sv.iAMGigEServer

Following this commands, the camera shows up again in the SynView IP Config Tool .

Open SynView IP Config Tool .
Now you should see the camera under "device model".
Press button "Connect and configure".
Set "Boot switch" checkbox to checked.
Set Boot switch mode to "Autostart GigEServer".
Press button "Apply and disconnect".

Factory IP and System Settings

Out-of-the box the iam system comes with the factory settings below.

IP Address	192.168.1.10
root user name	root
root user passwort	root

The iAMGigEServer is run by autostart to allow remote IP configuration with SynView IP Config Tool even if you Network Controller Configuration is not set properly.

During production the latest version of the SynView and iAMGigEServer is installed to camera. Only in special cases it is necessary to update the camera. See section iam update tool for detailed information.

Requirements

It is mandatory to have iAMGigEServer running on iam system to use the SynView IP Config Tool.
Installation of the latest version of SynView to host system. See Download latest SynView Package for download link.
During production the latest version of the SynView Explorer and iAMGigEServer is installed to camera. Only in special cases it is necessary to update the camera. See section SynView Update Tool for detailed information.

After installation of latest Synview Prerelease the SynView IP Config Tool sv.ipconf.x64 can be found on your host-pc under the location:

C:\Program Files\SynView\bin\sv.ipconf.x64.exe

Change IP Address

The IP Address of iam camera is an important settings affecting the major interface and will therefore define the accessibility of the system.

This important feature can be set by the SynView IP Config Tool even if you Network Controller Configuration is not set properly.

iam operates with static ip settings du to the GenICam - Standard conformity

The IP address can be changed temporary and persistent. For changing the persistent IP address it is mandatory to have proper access to the system, eg. by change the IP address temporary first.

Temporary Change of IP Settings

Open sv.ipconf.x64.exe.
Now you should see the iam camera under "device model" even if the camera is not in the correct subnet.
Enter below “Current IP settings” or “Restart IP configuration” for obtaining the persistent settings.
Press button "Force IP address".

Persistent Change of IP Settings

Open sv.ipconf.x64.exe.
Now you should see the iam camera under "device model".
Press button "Connect and configure".
Enter below checkbox “Persistent IP address”
Press button "Use current IP address".
Press button "Apply and disconnect".

Attachments

Update complete firmware of iam

SynView iAM Update Tool

So far SynView iam Update Tool is not part of the official released SynView (e.g. from the NET Website) - therefore it is mandatory to use prerelease Version below on your system.

Preparation

The tool is a standalone portable version and must be extracted by using the self extracting ExtractiAMUpdater.exe below. After accepting the license agreement the software extract just next to the file in a subdirector ./iam_updater.

There must be a SynView version (DeviceControl → DeviceSoftwareVersion) greater than 1.03.12.1009 installed on your camera to use the update tool. You can update the version first via ssh command as discribed here. Than using the SynView iam Update Tool below.

Upload Package:

Use latest Release Package for your version of iam camera from below or sign up for prerelease program by contacting our Sales Team.

If you are not sure which package to choose, you can use the command below after starting your camera and establishing an openSSH: cat /etc/petalinux/version

Or using iAMGigEServer (DeviceControl → DeviceVersion).

Usage

Start sv.ipconf.x64.exe from the subdirector ./iam_updater.
Select Upload Package File by click on the “…” Symbol.
The tool is loading the package and checks compability.
Double ckeck the compability by verifying the displayed values.
Click on “Run Update”
Wait until all processes reach 100%
Message Box will pop up for closing the programm.

Download:

Upload Package File

ExtractiAMUpdater.exe

Sign up for prerelease program by contacting our Sales Team.

🔍 References

🔗 related content

👥 contact NET

Error rendering macro 'excerpt-include' : No link could be created for 'MasterContent: Contact NET'.