Operator Reference

HALCON Operator Reference / System / I/O Devices
ClassesClasses | | Operators

control_io_interfaceT_control_io_interfaceControlIoInterfaceControlIoInterfacecontrol_io_interface (Operator)

control_io_interfaceT_control_io_interfaceControlIoInterfaceControlIoInterfacecontrol_io_interface — Perform an action on the I/O interface.

Signature

control_io_interface( : : IOInterfaceName, Action, Argument : Result)

Herror T_control_io_interface(const Htuple IOInterfaceName, const Htuple Action, const Htuple Argument, Htuple* Result)

void ControlIoInterface(const HTuple& IOInterfaceName, const HTuple& Action, const HTuple& Argument, HTuple* Result)

static HTuple HIODevice::ControlIoInterface(const HString& IOInterfaceName, const HString& Action, const HTuple& Argument)

static HTuple HIODevice::ControlIoInterface(const HString& IOInterfaceName, const HString& Action, const HString& Argument)

static HTuple HIODevice::ControlIoInterface(const char* IOInterfaceName, const char* Action, const char* Argument)

static HTuple HIODevice::ControlIoInterface(const wchar_t* IOInterfaceName, const wchar_t* Action, const wchar_t* Argument)   ( Windows only)

static void HOperatorSet.ControlIoInterface(HTuple IOInterfaceName, HTuple action, HTuple argument, out HTuple result)

static HTuple HIODevice.ControlIoInterface(string IOInterfaceName, string action, HTuple argument)

static HTuple HIODevice.ControlIoInterface(string IOInterfaceName, string action, string argument)

def control_io_interface(iointerface_name: str, action: str, argument: MaybeSequence[Union[int, float, str]]) -> Sequence[Union[int, float, str]]

Description

control_io_interfacecontrol_io_interfaceControlIoInterfaceControlIoInterfacecontrol_io_interface performs an action on the I/O interface. The supported parameters are interface-specific and listed in the corresponding documentation of the used I/O interface that can be found in the directory doc/html/reference/io.

The special value 'keep_open'"keep_open""keep_open""keep_open""keep_open" for ActionActionActionactionaction is used to control when the interface should be unloaded. If ArgumentArgumentArgumentargumentargument is set to 'true'"true""true""true""true", the interface will remain loaded until the HALCON process is terminated. If it is set to 'false'"false""false""false""false", the interface will be unloaded as soon as all its device instances are closed. This is the default behavior.

Attention

On Windows Systems, error dialog boxes from the operating system can occur when dependency modules of the interface are not found, e.g., the according SDK was not installed. The occurrence of the error boxes can be controlled by setting Windows' Error Mode. Please refer to the description of SetErrorMode within the Windows MSDN documentation.

Execution Information

  • Multithreading type: reentrant (runs in parallel with non-exclusive operators).
  • Multithreading scope: global (may be called from any thread).
  • Processed without parallelization.

Parameters

IOInterfaceNameIOInterfaceNameIOInterfaceNameIOInterfaceNameiointerface_name (input_control)  string → HTuplestrHTupleHtuple (string) (string) (HString) (char*)

HALCON I/O interface name.

Default: []

Suggested values: 'ADLINK-DAQPilot'"ADLINK-DAQPilot""ADLINK-DAQPilot""ADLINK-DAQPilot""ADLINK-DAQPilot", 'ADLINK-EOS'"ADLINK-EOS""ADLINK-EOS""ADLINK-EOS""ADLINK-EOS", 'Advantech'"Advantech""Advantech""Advantech""Advantech", 'Contec'"Contec""Contec""Contec""Contec", 'Hilscher-cifX'"Hilscher-cifX""Hilscher-cifX""Hilscher-cifX""Hilscher-cifX", 'Interface'"Interface""Interface""Interface""Interface", 'Linux-GPIO'"Linux-GPIO""Linux-GPIO""Linux-GPIO""Linux-GPIO", 'NIDAQmx'"NIDAQmx""NIDAQmx""NIDAQmx""NIDAQmx", 'OPC_Classic'"OPC_Classic""OPC_Classic""OPC_Classic""OPC_Classic", 'OPC_UA'"OPC_UA""OPC_UA""OPC_UA""OPC_UA"

ActionActionActionactionaction (input_control)  string → HTuplestrHTupleHtuple (string) (string) (HString) (char*)

Name of the action to perform.

ArgumentArgumentArgumentargumentargument (input_control)  string(-array) → HTupleMaybeSequence[Union[int, float, str]]HTupleHtuple (string / integer / real) (string / int / long / double) (HString / Hlong / double) (char* / Hlong / double)

List of arguments for the action.

Default: []

ResultResultResultresultresult (output_control)  string-array → HTupleSequence[Union[int, float, str]]HTupleHtuple (string / integer / real) (string / int / long / double) (HString / Hlong / double) (char* / Hlong / double)

List of results returned by the action.

Result

If the parameters are valid, the operator control_io_interfacecontrol_io_interfaceControlIoInterfaceControlIoInterfacecontrol_io_interface returns the value 2 ( H_MSG_TRUE) . If necessary an exception is raised. In this case an extended error information may be set and can be queried with the operator get_extended_error_infoget_extended_error_infoGetExtendedErrorInfoGetExtendedErrorInfoget_extended_error_info.

See also

query_io_interfacequery_io_interfaceQueryIoInterfaceQueryIoInterfacequery_io_interface

Module

Foundation

ClassesClasses | | Operators