Driver Installer Manual

Note

Vimba X Driver Installer is available for Windows only. To install the CSI-2 camera driver for your ARM board, go to GitHub.

Vimba X Driver Installer is a tool to easily install the Vimba GigE Filter Driver and the Windows driver for Allied Vision USB cameras. Although the same functionality can be achieved with the Windows device manager or through the network settings, Vimba X Driver Installer provides a more convenient way to select the correct driver for your Allied Vision camera.

Main window

Upon startup, the Driver Installer examines the current hardware configuration, which may take a while. After the necessary information is collected, the main window is shown.

Driver Installer

The main window lists:

  • Installed network adapters

  • Connected USB cameras

If your camera interface is not listed or the application closes with an error message, install a suitable NIC or connect your USB camera. All adapters are listed with their name and their physical location in the PC.

  • GigE: To easily identify a network adapter, its MAC address and IP address are shown in a tool tip.

  • USB: The camera serial number is shown under Location.

The Driver Source column displays the origin of the currently installed driver comes from (for example, this SDK). The Actions panel shows the actions to be performed by the Driver Installer if the Apply button is clicked. It is initially empty.

Changing drivers

Changing individual driver settings does not take effect instantly. Instead, the changes are queued as Actions in the panel on the right side of the screen. They are executed when the Apply button is clicked. To change the driver for host adapters or cameras, select its tab (e.g., Network Adapter or USB3 Vision Cameras) whose driver you want to install or change. This can be done by three different methods:

  • Click the button in the column Driver Source of the corresponding host adapter or camera and select an entry from the popup menu, or

  • Right-click anywhere in the row of the corresponding host adapter or camera and select an entry from the popup menu, or

  • Select a host adapter or a camera by clicking in the corresponding row and choose an entry from the Install Driver menu.

Tip

Vimba X Driver Installer supports multi-selection of adapters or cameras: On your keyboard, press Ctrl + A or hold down the Shift or Ctrl key while clicking.

The list items are determined at startup. Additionally, one item is added to each list that can be used to remove the Allied Vision driver from the adapter or camera: <disable Allied Vision filter driver> for network adapters and <remove Allied Vision driver> for USB cameras.

After selecting a new driver source, one or more actions to be performed by Vimba X Driver Installer are added to the right panel. The corresponding adapters or cameras are disabled, so you can not add a second action for the same adapter or camera.

To undo your selections, click Clear.

Incompatibility message

Some Allied Vision drivers are not compatible with all installed Allied Vision SDKs. When this is detected, an Incompatibility error message is shown.

If you click Yes in the dialog, additional actions will be added to install the driver of the new SDK on the other adapters, too. If you click No, the action will be removed.

To start the installation, click Apply. During the installation, which may take a while, the operating system might bring up other windows asking for permission to install the driver. The result of each action is displayed by a small icon in front of the action.

Command line options

Vimba X Driver Installer can either be used in interactive mode or perform a single task without showing a graphical user interface (GUI). The syntax for starting the application is:

VimbaDriverInstaller.exe [command] [options]

The following commands are available:

Driver Installer commands

Command

Description

Mandatory options

help

Displays infos about the usage of Vimba X Driver Installer

none

info

Displays infos about installed Allied Vision
products and hardware.

none

add

Adds a driver of an Allied Vision product to the driver store.

/product

remove

Removes an Allied Vision driver

/product

exists

Checks whether the given Allied Vision product is
installed. Returns 0 if found, otherwise see return code table.

/product

install

Installs a driver of an Allied Vision product on
a given adapters or cameras

/product and
/deviceType

The following options are available:

Driver Installer options

Option

Description

/l filename

Log trace messages into the given file..

/product upgradeCode

Identifies a product by its upgrade code.

/product productNameAndVersion

Identifies a product by its name and version

/deviceType deviceTypeName

Identifies the hardware device by device class

/force

Force removal (even if in use), valid for remove only.
Might require a reboot.

/hidden

Disable output to console window.

/adjustMaxFilterDriverNums

Automatically adjust number of installed filter drivers
Valid only for “install” command and NICs.

Tip

Use the info command to find out the upgrade codes or exact names and versions for installed Allied Vision products.

If started without parameters, the application is displayed in interactive mode with GUI. The following table lists the return code when started in silent mode:

Driver Installer options

Return code

Description

1

Success, reboot required.

0

Success

-1

Unknown error.

-2

Unknown command.

-10

Given device not found.

-11

At least one device must be specified for this command.

-12

Exactly one device must be specified for this command.

-13

Given device cannot be modified, because it is in use.

-20

Given product not found.

-21

At least one product must be specified for this command.

-22

Exactly one product must be specified for this command.

-23

Given product cannot be removed, it is in use.

-24

Given product is not found in the driver store.

-25

Given product is not installed on the given device.

-1001

Network configuration system locked by another application.
Terminate all other applications, run the Driver Installer again.

-1002

Reached maximum number of installed network filter drivers.
Use the “adjustMaxFilterDriverNums” option or remove a
filter driver by uninstalling the corresponding application.