Back to Aurora Vision Studio website

You are here: Start » Filter Reference » GigE Vision » GigEVision_ReadRegisterData

GigEVision_ReadRegisterData


Module: Genicam

Reads binary data from a register node of a GigEVision device.

Name Type Range Description
Input value inAddress GevAddress GigE Vision Device identifying address (IP, MAC or Serial Number)
Input value inParameterName GevParameterName Name of GenICam parameter node to access
Input value inVerifyAccess Bool True to verify GenICam parameter access state before every read
Input value inLength Integer* 0 - 536870912 Length of the data to read
Output value outBuffer ByteBuffer Data read from the register

Description

This filter is intended for cooperation with GigE Vision® compliant devices. Its purpose is to get a value of device parameter using GenICam interface. Filter can be used to access device registers, stream chunked data or event message data.

Warning: Retrieving parameters from uncached device registers may be a time consuming operation that produce blocking network packets exchange at every filter execution.

This filter does not require other GigE Vision® filters in program (especially GigEVision_GrabImage is not obligatory), but can be used in any combination with them, including sharing access to single device with other filters. Device also does not have to be a transmitter.

Device address (inAddress port) is a textual definition of either IP, MAC or serial number. Use Device Manager (click "..." button in filter properties) to select appropriate address of connected device. For information on address type meaning and selecting device address see Device manager section in user manual.

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 port) must be an ID of GenICam parameter exported by the device. Each device model can have different parameter names and its meanings. Refer to the device documentation and use the GenICam settings browser (click "..." button in filter properties) to select appropriate name of the parameter (see: Device settings editor section).

This filter allows to read a raw binary data block from the device memory. Data is read from the beginning of the register up to inLength bytes. Attempt to read more data than the register provides will result in an error. Setting the inLength input to Auto will cause the whole register range to be read. Resulting data is returned in form of a ByteBuffer data type on the outBuffer output (filters from the Binary Data category can be used interpret its content).

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

For general information about working with GigE Vision devices, please refer to the following article.

To learn more about camera acquisition thread works please go to this 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 Reading beyond the end of the register in GigEVision_ReadRegisterData.

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.