Operator Reference

set_serial_paramT_set_serial_paramSetSerialParamSetSerialParamset_serial_param (Operator)

set_serial_paramT_set_serial_paramSetSerialParamSetSerialParamset_serial_param — Set the parameters of a serial device.

Signature

set_serial_param( : : SerialHandle, BaudRate, DataBits, FlowControl, Parity, StopBits, TotalTimeOut, InterCharTimeOut : )

Description

set_serial_paramset_serial_paramSetSerialParamSetSerialParamset_serial_param can be used to set the parameters of a serial device. The parameter BaudRateBaudRateBaudRatebaudRatebaud_rate 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 DataBitsDataBitsDataBitsdataBitsdata_bits. The parameter FlowControlFlowControlFlowControlflowControlflow_control 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 StopBitsStopBitsStopBitsstopBitsstop_bits. Finally, two timeout for reading from the serial device can be set. The parameter TotalTimeOutTotalTimeOutTotalTimeOuttotalTimeOuttotal_time_out determines the maximum time, which may pass in read_serialread_serialReadSerialReadSerialread_serial until the first character arrives, independent of the actual number of characters requested. The parameter InterCharTimeOutInterCharTimeOutInterCharTimeOutinterCharTimeOutinter_char_time_out determines the time which may pass between the reading of individual characters, if multiple characters are requested with read_serialread_serialReadSerialReadSerialread_serial. If one of the timeouts is set to -1, the system waits an arbitrary amount of time for the arrival of characters. If both timeouts are set to 0 the system doesn't wait and returns the available or none characters. Thus, on Windows systems, a total timeout of TotalTimeOutTotalTimeOutTotalTimeOuttotalTimeOuttotal_time_out + n InterCharTimeOutInterCharTimeOutInterCharTimeOutinterCharTimeOutinter_char_time_out 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:

SerialHandleSerialHandleSerialHandleserialHandleserial_handle

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

Parameters

SerialHandleSerialHandleSerialHandleserialHandleserial_handle (input_control, state is modified) serial → (handle)

Serial interface handle.

BaudRateBaudRateBaudRatebaudRatebaud_rate (input_control) integer → (integer / string)

Speed of the serial interface.