You are here: Start » Filter Reference » GenICam » GenICam_ExecuteCommand
GenICam_ExecuteCommand
Conditionally executes command in GenICam device.
| Name | Type | Description | |
|---|---|---|---|
 |
inAddress | GenAddress | GenTL Provider module and device identifying address |
|
inScope | GenICamParameterScope | Specifies which parameters set in GenICam stack should be accessed |
|
inCommandName | GenParameterName | 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 general camera devices trough GenTL compliant interface. Its purpose is to execute a command in a device using GenICam interface.
This filter does not require other GenICam filters in the program (especially GenICam_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 structure of information defining 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.
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 GenICam_StartAcquisition and GenICam_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 Gen TL devices, please refer to the following article.
Complexity Level
This filter is available on Advanced Complexity Level.
Disabled in Lite Edition
See Also
- GenICam_GrabImage – Captures an image stream from a camera using a GenICam GenTL provider library.
- GenICam_StartAcquisition – Initializes and starts image acquisition in a camera.
- GenICam_SetIntegerParameter – Sets parameter of type Integer into GenICam device.
- GenICam_SetRealParameter – Sets parameter of type Real into GenICam device.
- GenICam_SetEnumParameter – Sets parameter of type Enumeration into GenICam device.
- GenICam_SetBoolParameter – Sets parameter of type Bool into GenICam device.
Application Notes - set of documents about connecting devices or establishing communication with Adaptive Vision Studio.
