open_io_deviceT_open_io_deviceOpenIoDeviceOpenIoDeviceopen_io_device (Operator)

Name

open_io_deviceT_open_io_deviceOpenIoDeviceOpenIoDeviceopen_io_device — Open and configure an I/O device.

Signature

open_io_device( : : IOInterfaceName, IODeviceName, GenParamName, GenParamValue : IODeviceHandle)

Description

The operator open_io_deviceopen_io_deviceOpenIoDeviceOpenIoDeviceopen_io_device opens and configures the chosen I/O device interface for the specific device. The device interface is specified by the base name of the underlying library and passed to IOInterfaceNameIOInterfaceNameIOInterfaceNameIOInterfaceNameiointerface_name. The interface library will be loaded dynamically when configuring the first specific device for this device interface. The specific device itself is addressed by a name passed to IODeviceNameIODeviceNameIODeviceNameIODeviceNameiodevice_name. Available names can be queried by query_io_interfacequery_io_interfaceQueryIoInterfaceQueryIoInterfacequery_io_interface. The device can be configured by the parameters GenParamNameGenParamNameGenParamNamegenParamNamegen_param_name and GenParamValueGenParamValueGenParamValuegenParamValuegen_param_value. A reference to the device instance is returned in IODeviceHandleIODeviceHandleIODeviceHandleIODeviceHandleiodevice_handle. If the instance of the device is not needed any more, it should be released and closed via the operator close_io_deviceclose_io_deviceCloseIoDeviceCloseIoDeviceclose_io_device.

Having opened a specific device, a transmission channel can be opened by calling open_io_channelopen_io_channelOpenIoChannelOpenIoChannelopen_io_channel. Values on the I/O channel can be read and written by the operators read_io_channelread_io_channelReadIoChannelReadIoChannelread_io_channel and write_io_channelwrite_io_channelWriteIoChannelWriteIoChannelwrite_io_channel on an opened transmission channel, afterwards.

An opened device instance can be reconfigured by using the operators set_io_device_paramset_io_device_paramSetIoDeviceParamSetIoDeviceParamset_io_device_param and get_io_device_paramget_io_device_paramGetIoDeviceParamGetIoDeviceParamget_io_device_param.

Please check the directory doc/html/reference/io for documentation about your specific I/O device interface, where all supported device specific parameters are listed.

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.

This operator returns a handle. Note that the state of an instance of this handle type may be changed by specific operators even though the handle is used as an input parameter by those operators.

Parameters

IOInterfaceNameIOInterfaceNameIOInterfaceNameIOInterfaceNameiointerface_name (input_control) string → (string)

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"

IODeviceNameIODeviceNameIODeviceNameIODeviceNameiodevice_name (input_control) tuple → (string)

I/O device name.

Default: []

GenParamNameGenParamNameGenParamNamegenParamNamegen_param_name (input_control) string-array → (string)

Dynamic parameter names.

Default: []

GenParamValueGenParamValueGenParamValuegenParamValuegen_param_value (input_control) string-array → (string / integer / real)

Dynamic parameter values.

Default: []

IODeviceHandleIODeviceHandleIODeviceHandleIODeviceHandleiodevice_handle (output_control) io_device → (handle)

Handle of the opened I/O device.

Example (HDevelop)

* Select a suitable i/o device interface of name IOInterfaceName
query_io_interface (IOInterfaceName, 'io_device_names', DeviceNames)
open_io_device (IOInterfaceName, DeviceNames[0], [], [], IODeviceHandle)
query_io_device (IODeviceHandle, [], 'io_channel_names.digital_input', \
                 ChannelInputNames)
open_io_channel (IODeviceHandle, ChannelInputNames[0], [], [], \
                 IOChannelHandle)
read_io_channel (IOChannelHandle, Value, Status)

Result

If the parameters are valid, the operator open_io_deviceopen_io_deviceOpenIoDeviceOpenIoDeviceopen_io_device 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.

Possible Predecessors

query_io_interfacequery_io_interfaceQueryIoInterfaceQueryIoInterfacequery_io_interface

Possible Successors

set_io_device_paramset_io_device_paramSetIoDeviceParamSetIoDeviceParamset_io_device_param, get_io_device_paramget_io_device_paramGetIoDeviceParamGetIoDeviceParamget_io_device_param, open_io_channelopen_io_channelOpenIoChannelOpenIoChannelopen_io_channel

Module

Foundation

Operators