Start » Filter Reference » GigE Vision » GigEVision_ExecuteCommand
Module: | GenICam |
---|
Conditionally executes command in GigEVision device.
Name | Type | Description | |
---|---|---|---|
inAddress | GevAddress | GigE Vision Device identifying address (IP, MAC or Serial Number) | |
inCommandName | GevParameterName | Name of GenICam command node to access | |
inActivationMode | GenActivationMode | Specifies how filter checks inActivation input | |
inActivation | Bool | Activates execution of command | |
inVerifyAccess | Bool | True to verify GenICam command parameter access state before every command execution |
Description
This filter is intended for cooperation with GigE Vision® compliant devices. Its purpose is to execute a command in a device using GenICam interface.
This filter does not require other GigE Vision® filters in the program (especially GigEVision_GrabImage is not obligatory), but can be used in any combination with them, including shared access to a single device with other filters. The 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.
A command name (inCommandName port) must be an ID of a GenICam command exported by the device. Each device model can have different command names and their meanings. Refer to the device documentation and use GenICam settings browser (click "..." button in filter properties) to select the appropriate name of a command (see: Device settings editor section in user manual).
The name of the command must point to a GenICam node providing "ICommand" interface or error will be raised upon filter execution.
Do not execute commands "AcquisitionStart" and "AcquisitionStop" directly in the device with this filter, use GigEVision_StartAcquisition and GigEVision_StopAcquisition filters instead.
Command execution is controlled by inActivation input. The command in the device is executed at the filter execution point, but only when the value at inActivation input meets its condition. inActivationMode input can be used to specify how the inActivation input is checked. Refer to GenActivationMode enum description for more details.
For general information about working with GigE Vision devices, please refer to the following article.
Complexity Level
This filter is available on Advanced Complexity Level.
Disabled in Lite Edition
See Also
- GigEVision_GrabImage – Captures an image stream from a GigE Vision compliant camera.
- GigEVision_StartAcquisition – Initializes and starts image acquisition in a device.
- GigEVision_SetIntegerParameter – Sets parameter of type Integer into GigEVision device.
- GigEVision_SetRealParameter – Sets parameter of type Real into GigEVision device.
- GigEVision_SetEnumParameter – Sets parameter of type Enumeration into GigEVision device.
Application Notes - set of documents about connecting devices or establishing communication with Aurora Vision Studio.