Back to Adaptive Vision Studio website

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


Checks if device sent event notification since previous iteration.

Name Type Range Description
inAddress GevAddress GigE Vision Device identifying address (IP, MAC or Serial Number)
inEventID Integer 0 - 65535 Numeric id of event to check
outEventFired Bool Gets flag indicating if event was fired since last read


This filter is intended for cooperation with GigE Vision® compliant devices. Its purpose is to monitor device for asynchronous event notifications and report its occurrence in program.

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.

Event ID (inEventID port) is a numeric id of event to listen for. Refer to device documentation for list of events and their ids. Please note, that usually Event ID is specified as hexadecimal number, while standard AVS port value editor use decimal form.

After first execution filter will start monitoring for asynchronous notification of event with specified ID. At every next execution filter will return 'true' on outEventFired port when one or more events with matching ID was received from device since previous filter execution. Port outEventFired is reset to 'false' after every filter execution, preparing filter to listen for next event.

To be able to listen for asynchronous events device must support message channel and event notification, message channel must not be disabled in application parameters, and specified event notification must be explicitly enabled in device settings.

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


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 Connection with device lost.

Complexity Level

This filter is available on Advanced Complexity Level.

Disabled in Lite Edition

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

See Also