get_serial_paramGetSerialParamGetSerialParamget_serial_paramT_get_serial_param

HALCON ScriptCpp++.NETPythonC

Short description

get_serial_paramGetSerialParamGetSerialParamget_serial_paramT_get_serial_param — Get the parameters of a serial device.

Signature

get_serial_param( serial SerialHandle, out integer BaudRate, out integer DataBits, out string FlowControl, out string Parity, out integer StopBits, out integer TotalTimeOut, out integer InterCharTimeOut )void GetSerialParam( const HTuple& SerialHandle, HTuple* BaudRate, HTuple* DataBits, HTuple* FlowControl, HTuple* Parity, HTuple* StopBits, HTuple* TotalTimeOut, HTuple* InterCharTimeOut )static void HOperatorSet.GetSerialParam( HTuple serialHandle, out HTuple baudRate, out HTuple dataBits, out HTuple flowControl, out HTuple parity, out HTuple stopBits, out HTuple totalTimeOut, out HTuple interCharTimeOut )def get_serial_param( serial_handle: HHandle ) -> Tuple[int, int, str, str, int, int, int]

Herror T_get_serial_param( const Htuple SerialHandle, Htuple* BaudRate, Htuple* DataBits, Htuple* FlowControl, Htuple* Parity, Htuple* StopBits, Htuple* TotalTimeOut, Htuple* InterCharTimeOut )

Hlong HSerial::GetSerialParam( Hlong* DataBits, HString* FlowControl, HString* Parity, Hlong* StopBits, Hlong* TotalTimeOut, Hlong* InterCharTimeOut ) const

int HSerial.GetSerialParam( out int dataBits, out string flowControl, out string parity, out int stopBits, out int totalTimeOut, out int interCharTimeOut )

Description

get_serial_paramGetSerialParam returns the current parameter settings of the serial device passed in SerialHandleserialHandleserial_handle. For a description of the parameters of a serial device, see set_serial_paramSetSerialParam.

Execution information

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 modifies the state of the following input parameter:

• SerialHandleserialHandleserial_handle

During execution of this operator, access to the value of this parameter must be synchronized if it is used across multiple threads.

Parameters

SerialHandleserialHandleserial_handle (input_control, state is modified) serial → (handle)HTuple (HHandle)HSerial, HTuple (IntPtr)HHandleHtuple (handle)

Serial interface handle.

BaudRatebaudRatebaud_rate (output_control) integer → (integer)HTuple (Hlong)HTuple (int / long)intHtuple (Hlong)

Speed of the serial interface.

DataBitsdataBitsdata_bits (output_control) integer → (integer)HTuple (Hlong)HTuple (int / long)intHtuple (Hlong)

Number of data bits of the serial interface.

FlowControlflowControlflow_control (output_control) string → (string)HTuple (HString)HTuple (string)strHtuple (char*)

Type of flow control of the serial interface.

Parityparityparity (output_control) string → (string)HTuple (HString)HTuple (string)strHtuple (char*)

Parity of the serial interface.

StopBitsstopBitsstop_bits (output_control) integer → (integer)HTuple (Hlong)HTuple (int / long)intHtuple (Hlong)

Number of stop bits of the serial interface.

TotalTimeOuttotalTimeOuttotal_time_out (output_control) integer → (integer)HTuple (Hlong)HTuple (int / long)intHtuple (Hlong)

Total timeout of the serial interface in ms.

InterCharTimeOutinterCharTimeOutinter_char_time_out (output_control) integer → (integer)HTuple (Hlong)HTuple (int / long)intHtuple (Hlong)

Inter-character timeout of the serial interface in ms.

Result

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

Combinations with other operators

Combinations

Possible predecessors

open_serialOpenSerial

Possible successors

read_serialReadSerial, write_serialWriteSerial

See also

set_serial_paramSetSerialParam

Module

Foundation