Serial.setTimeout()

Description

Serial.setTimeout() sets the maximum milliseconds to wait for serial data. It defaults to 1000 milliseconds.

Serial.setTimeout() inherits from the Stream utility class.

Syntax

Serial.setTimeout(time)

Parameters

Serial: serial port object. See the list of available serial ports for each board on the Serial main page.
time : timeout duration in milliseconds (long).

Returns

Nothing

Notes and Warnings

Serial functions that use the timeout value set via Serial.setTimeout():

  • Serial.find()

  • Serial.findUntil()

  • Serial.parseInt()

  • Serial.parseFloat()

  • Serial.readBytes()

  • Serial.readBytesUntil()

  • Serial.readString()

  • Serial.readStringUntil()

See also