Stream.setTimeout()

Description

setTimeout() sets the maximum milliseconds to wait for stream data, it defaults to 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)

Parameter Values

  • stream: an instance of a class that inherits from Stream.
  • time: timeout duration in milliseconds. Allowed data types: long.

Return Values

  • Nothing

※ NOTES AND WARNINGS:

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

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

See Also

ARDUINO BUY RECOMMENDATION

Arduino UNO R3
Arduino Starter Kit
Please note: These are Amazon affiliate links. If you buy the components through these links, We will get a commission at no extra cost to you. We appreciate it.

※ OUR MESSAGES