Back to Aurora Vision Studio website

You are here: Start » Filter Reference » GenICam » GenICam_WriteRegisterData

GenICam_WriteRegisterData


Module: Genicam

Writes binary data into a register node of a GenICam device.

Name Type Description
Input value inAddress GenAddress GenTL Provider module and device identifying address
Input value inScope GenICamParameterScope Specifies which parameters set in GenICam stack should be accessed
Input value inParameterName GenParameterName Name of GenICam parameter node to access
Input value inVerifyAccess Bool True to verify GenICam parameter access state before every write
Input value inBuffer ByteBuffer Data to be written to the register

Description

This filter is intended for cooperation with general camera device trough GenTL compliant interface. Its purpose is to set a value into internal device parameter using GenICam interface.

This filter does not require other GenICam filters in program (especially GenICam_GrabImage is not obligatory), but can be used in any combination with them, including sharing access to single device with other filters.

Device address (inAddress port) is a structure defining a unique device and its GenTL provider module in the system. It is recommended to use the GenTL Device Manager (click the "..." button in Filter Properties) to select the appropriate device, connected to the local system, whose identification information will be used.

Device address consists of the following fields:

  • VendorName - Vendor name of the GenTL provider module, which will be used to communicate with the device.
  • TLType - Identification code of interface transport technology type (for example "GEV", "IIDC", "UVC", "USB3", "PCI", "Custom"). The exact code depends on the GenTL provider module.
  • DeviceID - Unique ID of the device in the selected interface technology of the used provider module. The format of this field must be always an exact ID string and depends on the used GenTL provider module.

This filter will interpret the value of inAddress port only during the first iteration of its parent Task, when the connection to the device is established. During the next iterations the filter will use previously established connection and subsequent changes in the device address will be ignored.

Parameter name (inParameterName) must be an ID of GenICam parameter exported by device. Each device model can have different parameter names and its meanings. Refer to device documentation and use GenICam settings browser (click "..." button in filter properties) to select appropriate name of parameter (see: Device settings editor section in user manual).

This filter allows to write a raw binary data block into the device or module memory. Source data is provided in form of a ByteBuffer data type on the inBuffer input (filters from the Binary Data category can be used to generate its content). Data is written from the beginning of the register up to the size of the provided buffer. Attempt to write more data than the size of the register range will result in an error. Data will be sent to the device/module on every filter execution.

The name of the parameter must point to a GenICam parameter providing "IRegister" interface or error will be raised upon filter execution.

For general information about working with Gen TL devices, please refer to the following article.

Hints

  • Interactively select a camera available in your network by defining the inAddress input.
  • Choose inParameterName from those supported by your camera.

Errors

This filter can throw an exception to report error. Read how to deal with errors in Error Handling.

List of possible exceptions:

Error type Description
IoError Writing beyond the end of the register in GenICam_WriteRegisterData.

Complexity Level

This filter is available on Expert Complexity Level.

Disabled in Lite Edition

This filter is disabled in Lite Edition. It is available only in full, Aurora Vision Studio Professional version.

See Also

  • Application Notes - set of documents about connecting devices or establishing communication with Aurora Vision Studio.