set_serial_paramT_set_serial_paramSetSerialParamSetSerialParam (Operator)

Name

set_serial_paramT_set_serial_paramSetSerialParamSetSerialParam — Set the parameters of a serial device.

Signature

Description

set_serial_paramset_serial_paramSetSerialParamSetSerialParamSetSerialParam can be used to set the parameters of a serial device. The parameter BaudRateBaudRateBaudRateBaudRatebaudRate determines the input and output speed of the device. It should be noted that not all devices support all possible speeds. The number of sent and received data bits is set with DataBitsDataBitsDataBitsDataBitsdataBits. The parameter FlowControlFlowControlFlowControlFlowControlflowControl determines if and what kind of data flow control should be used. Software control ('xon_xoff'"xon_xoff""xon_xoff""xon_xoff""xon_xoff") and hardware control ('cts_rts'"cts_rts""cts_rts""cts_rts""cts_rts" and 'dtr_dsr'"dtr_dsr""dtr_dsr""dtr_dsr""dtr_dsr") can be used. Multiple values can be set separated by a space within one string (e.g. 'cts_rts dtr_dsr'"cts_rts dtr_dsr""cts_rts dtr_dsr""cts_rts dtr_dsr""cts_rts dtr_dsr"). If and what kind of parity check of the transmitted data should be performed can be determined by ParityParityParityParityparity. The number of stop bits sent is set with StopBitsStopBitsStopBitsStopBitsstopBits. Finally, two timeout for reading from the serial device can be set. The parameter TotalTimeOutTotalTimeOutTotalTimeOutTotalTimeOuttotalTimeOut determines the maximum time, which may pass in read_serialread_serialReadSerialReadSerialReadSerial until the first character arrives, independent of the actual number of characters requested. The parameter InterCharTimeOutInterCharTimeOutInterCharTimeOutInterCharTimeOutinterCharTimeOut determines the time which may pass between the reading of individual characters, if multiple characters are requested with read_serialread_serialReadSerialReadSerialReadSerial. If one of the timeouts is set to -1, a read waits an arbitrary amount of time for the arrival of characters. If both timeouts are set to 0 the a read doesn't wait and returns the available or none characters. Thus, on Windows systems, a total timeout of TotalTimeOutTotalTimeOutTotalTimeOutTotalTimeOuttotalTimeOut + n InterCharTimeOutInterCharTimeOutInterCharTimeOutInterCharTimeOutinterCharTimeOut results if n characters are to be read. On Unix-like systems, only one of the two timeouts can be set. Thus, if both timeouts are passed larger than -1, only the total timeout is used. The unit of both timeouts is milliseconds. It should be noted, however, that the timeout is specified in increments of one tenths of a second on Unix-like systems, i.e., the minimum timeout that has any effect is 100. For each parameter, the current values can be left in effect by passing 'unchanged'"unchanged""unchanged""unchanged""unchanged".

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:

• SerialHandleSerialHandleSerialHandleSerialHandleserialHandle

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

Parameters

Result

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

Possible Predecessors

open_serialopen_serialOpenSerialOpenSerialOpenSerial, get_serial_paramget_serial_paramGetSerialParamGetSerialParamGetSerialParam

Possible Successors

read_serialread_serialReadSerialReadSerialReadSerial, write_serialwrite_serialWriteSerialWriteSerialWriteSerial

See also

get_serial_paramget_serial_paramGetSerialParamGetSerialParamGetSerialParam

Module

Foundation