VimbaX Camera

From: Allied Vision Technologies

Class: herosdevices.hardware.allied_vision.vimba_camera.VimbaCompatibleCamera

Driver Quality Index: beta

Requires the following packages

vmbpy

A class to interface with Allied Vision VimbaX cameras.

The class provides functionality to control and capture images from Allied Vision VimbaX cameras. It manages camera configuration, acquisition, and data streaming.

Important

The vendor underlying library must be obtained from the official website. Download the Allied Vision VimbaX SDK, unpack it and install it following the supplied README file.

Note:

For use with BOSS in docker, you can adapt the VimbaX install script cti/Install_GenTL_Path.sh

To find the cam_id of your camera, you can either use the VimbaXViewer (or start the driver with a wrong id, it will print the available ids). The ids look something like DEV_000A4717239E.

Arguments

Bold arguments are mandatory. For more information on the listed arguments refer to the class documentation: herosdevices.hardware.allied_vision.vimba_camera.VimbaCompatibleCamera If parameters appear in this list but not in the class definition, please recursively check the linked base classes for the definition of the parameter.

Argument	Type	Default Value	Description
cam_id	<class ‘str’>		Serial number of the cam. See note above to learn how to obtain the correct serial.
config_dict	<class ‘dict’>		Dict of configuration values like shown in the json example above. The keys starting with a capital letter in the example are features of the camera. For available features, see the manual of your camera model. Valid special keys are: - pixel_format: Sets the pixel format of the camera, for example “Mono8”
default_config	str | None	None	Default key in config_dict to use.
reset_to_continuous	<class ‘bool’>	False	If True, the camera will be set to continuous acquisition mode on teardown.
lib_path	str | None	None	Path to vendor transport library.

Example JSON for BOSS

The following JSON strings can be used to start a HERO device representation of VimbaCompatibleCamera using BOSS.

{
    "_id": "test_cam",
    "classname": "herosdevices.hardware.allied_vision.VimbaCompatibleCamera",
    "arguments": {
        "cam_id": "DEV_000A1217739E",
        "config_dict": {
            "default": {
                "ExposureTime": 3000,
                "TriggerSelector": "ExposureStart",
                "AcquisitionMode": "MultiFrame",
                "TriggerMode": "On",
                "TriggerSource": "Software",
                "AcquisitionFrameCount": 5,
                "pixel_format": "Mono8"
            },
            "continuous": {
                "AcquisitionMode": "Continuous",
                "AcquisitionFrameRateEnable": "On",
                "AcquisitionFrameRate": 20,
                "ExposureTime": 200
            }
        }
    }
}

^{from examples/allied_vision/vimba_cam.json}

{
    "_id": "my_VimbaCompatibleCamera",
    "classname": "herosdevices.hardware.allied_vision.vimba_camera.VimbaCompatibleCamera",
    "arguments": {
        "cam_id": "<class 'str'>",
        "config_dict": {
            "default": {
                "ExposureTime": 1000,
                "TriggerSelector": "ExposureStart",
                "TriggerMode": "On",
                "TriggerSource": "Software",
                "AcquisitionMode": "MultiFrame",
                "AcquisitionFrameCount": 5
            }
        },
        "default_config": "default",
        "reset_to_continuous": false,
        "lib_path": "/opt/vimba/cti/"
    }
}

^{generated from signature}

Inheritance