serial_set_inter_byte_timeout()

Definition

serial_set_inter_byte_timeout(ser, timeout=None)

Features

This function sets the timeout between the bytes (inter-byte) when reading and writing to the port.

Parameters

Parameter Name	Data Type	Default Value	Description
ser	serial.Serial	-	Serial instance
timeout	float	None	Timeout between bytes during reading or writing Continued processing of data that was processed before the timeout None: inter-byte timeout not specified

Parameter Name

Data Type

Default Value

Description

ser

serial.Serial

Serial instance

timeout

float

None

Timeout between bytes during reading or writing

Continued processing of data that was processed before the timeout
None: inter-byte timeout not specified

Return

Value	Description
0	Success

Exception

Exception	Description
DR_Error (DR_ERROR_TYPE)	Parameter data type error occurred

Example

Python

ser = serial_open(port="COM", baudrate=115200, bytesize=DR_EIGHTBITS, 
        parity=DR_PARITY_NONE, stopbits=DR_STOPBITS_ONE)
 
res = serial_set_inter_byte_timeout(ser, 0.1)
 
serial_close(ser)

Keyword

serial / inter / byte / inter_byte / timeout / byte_timeout / inter_byte_timeout