open_serialT_open_serialOpenSerialOpenSerialopen_serial (Operator)
Name
open_serialT_open_serialOpenSerialOpenSerialopen_serial — Open a serial device.
Signature
Description
open_serialopen_serialOpenSerialOpenSerialOpenSerialopen_serial opens a serial device. The name of the device
is determined by the parameter PortNamePortNamePortNamePortNameportNameport_name and is operating
system specific. On Windows machines,
'COM1'"COM1""COM1""COM1""COM1""COM1"-'COM4'"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*""/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_paramSetSerialParamSetSerialParamSetSerialParamset_serial_param.
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
PortNamePortNamePortNamePortNameportNameport_name (input_control) filename → HTuplestrHTupleHtuple (string) (string) (HString) (char*)
Name of the serial port.
Default value:
'COM1'
"COM1"
"COM1"
"COM1"
"COM1"
"COM1"
Suggested values: 'COM1'"COM1""COM1""COM1""COM1""COM1", 'COM2'"COM2""COM2""COM2""COM2""COM2", 'COM3'"COM3""COM3""COM3""COM3""COM3", 'COM4'"COM4""COM4""COM4""COM4""COM4", '/dev/ttya'"/dev/ttya""/dev/ttya""/dev/ttya""/dev/ttya""/dev/ttya", '/dev/ttyb'"/dev/ttyb""/dev/ttyb""/dev/ttyb""/dev/ttyb""/dev/ttyb", '/dev/tty00'"/dev/tty00""/dev/tty00""/dev/tty00""/dev/tty00""/dev/tty00", '/dev/tty01'"/dev/tty01""/dev/tty01""/dev/tty01""/dev/tty01""/dev/tty01", '/dev/ttyd1'"/dev/ttyd1""/dev/ttyd1""/dev/ttyd1""/dev/ttyd1""/dev/ttyd1", '/dev/ttyd2'"/dev/ttyd2""/dev/ttyd2""/dev/ttyd2""/dev/ttyd2""/dev/ttyd2", '/dev/cua0'"/dev/cua0""/dev/cua0""/dev/cua0""/dev/cua0""/dev/cua0", '/dev/cua1'"/dev/cua1""/dev/cua1""/dev/cua1""/dev/cua1""/dev/cua1"
SerialHandleSerialHandleSerialHandleSerialHandleserialHandleserial_handle (output_control) serial → HSerial, HTupleHHandleHTupleHtuple (handle) (IntPtr) (HHandle) (handle)
Serial interface handle.
Result
If the parameters are correct and the device could be opened, the
operator open_serialopen_serialOpenSerialOpenSerialOpenSerialopen_serial returns the value 2 (H_MSG_TRUE). Otherwise an
exception is raised.
Possible Successors
set_serial_paramset_serial_paramSetSerialParamSetSerialParamSetSerialParamset_serial_param,
read_serialread_serialReadSerialReadSerialReadSerialread_serial,
write_serialwrite_serialWriteSerialWriteSerialWriteSerialwrite_serial,
close_serialclose_serialCloseSerialCloseSerialCloseSerialclose_serial
See also
set_serial_paramset_serial_paramSetSerialParamSetSerialParamSetSerialParamset_serial_param,
get_serial_paramget_serial_paramGetSerialParamGetSerialParamGetSerialParamget_serial_param,
open_fileopen_fileOpenFileOpenFileOpenFileopen_file
Module
Foundation