HALCON Website / HALCON Operator Reference / System / Serial
ClassesClasses | | Operators

open_serialT_open_serialOpenSerialOpenSerial (Operator)

Name

open_serialT_open_serialOpenSerialOpenSerial — Open a serial device.

Signature

open_serial( : : PortName : SerialHandle)

Herror T_open_serial(const Htuple PortName, Htuple* SerialHandle)

void OpenSerial(const HTuple& PortName, HTuple* SerialHandle)

void HSerial::HSerial(const HString& PortName)

void HSerial::HSerial(const char* PortName)

void HSerial::HSerial(const wchar_t* PortName)   (Windows only)

void HSerial::OpenSerial(const HString& PortName)

void HSerial::OpenSerial(const char* PortName)

void HSerial::OpenSerial(const wchar_t* PortName)   (Windows only)

static void HOperatorSet.OpenSerial(HTuple portName, out HTuple serialHandle)

public HSerial(string portName)

void HSerial.OpenSerial(string portName)

Description

open_serialopen_serialOpenSerialOpenSerialOpenSerial opens a serial device. The name of the device is determined by the parameter PortNamePortNamePortNamePortNameportName and is operating system specific. On Windows machines, 'COM1'"COM1""COM1""COM1""COM1"-'COM4'"COM4""COM4""COM4""COM4" is typically used, while on Unix-like systems the serial devices usually are named '/dev/tty*'"/dev/tty*""/dev/tty*""/dev/tty*""/dev/tty*". The parameters of the serial device, e.g., its speed or number of data bits, are set to the system default values for the respective device after the device has been opened. They can be set or changed by calling set_serial_paramset_serial_paramSetSerialParamSetSerialParamSetSerialParam.

Execution Information

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

PortNamePortNamePortNamePortNameportName (input_control)  filename → HTupleHTupleHtuple (string) (string) (HString) (char*)

Name of the serial port.

Default value: 'COM1' "COM1" "COM1" "COM1" "COM1"

Suggested values: 'COM1'"COM1""COM1""COM1""COM1", 'COM2'"COM2""COM2""COM2""COM2", 'COM3'"COM3""COM3""COM3""COM3", 'COM4'"COM4""COM4""COM4""COM4", '/dev/ttya'"/dev/ttya""/dev/ttya""/dev/ttya""/dev/ttya", '/dev/ttyb'"/dev/ttyb""/dev/ttyb""/dev/ttyb""/dev/ttyb", '/dev/tty00'"/dev/tty00""/dev/tty00""/dev/tty00""/dev/tty00", '/dev/tty01'"/dev/tty01""/dev/tty01""/dev/tty01""/dev/tty01", '/dev/ttyd1'"/dev/ttyd1""/dev/ttyd1""/dev/ttyd1""/dev/ttyd1", '/dev/ttyd2'"/dev/ttyd2""/dev/ttyd2""/dev/ttyd2""/dev/ttyd2", '/dev/cua0'"/dev/cua0""/dev/cua0""/dev/cua0""/dev/cua0", '/dev/cua1'"/dev/cua1""/dev/cua1""/dev/cua1""/dev/cua1"

SerialHandleSerialHandleSerialHandleSerialHandleserialHandle (output_control)  serial → HSerial, HTupleHTupleHtuple (handle) (IntPtr) (HHandle) (handle)

Serial interface handle.

Result

If the parameters are correct and the device could be opened, the operator open_serialopen_serialOpenSerialOpenSerialOpenSerial returns the value 2 (H_MSG_TRUE). Otherwise an exception is raised.

Possible Successors

set_serial_paramset_serial_paramSetSerialParamSetSerialParamSetSerialParam, read_serialread_serialReadSerialReadSerialReadSerial, write_serialwrite_serialWriteSerialWriteSerialWriteSerial, close_serialclose_serialCloseSerialCloseSerialCloseSerial

See also

set_serial_paramset_serial_paramSetSerialParamSetSerialParamSetSerialParam, get_serial_paramget_serial_paramGetSerialParamGetSerialParamGetSerialParam, open_fileopen_fileOpenFileOpenFileOpenFile

Module

Foundation

ClassesClasses | | Operators
HALCON Operator Reference 19.11.0.0 Copyright © 1996-2019 MVTec Software GmbH