Description

setTimeout() sets the maximum milliseconds to wait for stream data. The default timeout value is 1000 milliseconds.

This function is part of the Stream class, and can be called by any class that inherits from it (Wire, Serial, etc). See the Stream class main page for more information.

Syntax

stream.setTimeout(time)

Parameters

  • time: timeout duration in milliseconds. Allowed data types: unsigned long.

Returns

Nothing.

Notes and Warnings

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

  • find()
  • findUntil()
  • parseInt()
  • parseFloat()
  • readBytes()
  • readBytesUntil()
  • readString()
  • readStringUntil()