peek.adoc

title
Serial.peek()

peek()

Description

Returns the next byte (character) of incoming serial data without removing it from the internal serial buffer. That is, successive calls to peek() will return the same character, as will the next call to read().

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

Syntax

Serial.peek()

Parameters

Serial: serial port object. See the list of available serial ports for each board on the Serial main page.

Returns

The first byte of incoming serial data available (or -1 if no data is available). Data type: int.

See also

• LANGUAGE begin()
  

• LANGUAGE end()
  

• LANGUAGE available()
  

• LANGUAGE read()
  

• LANGUAGE peek()
  

• LANGUAGE flush()
  

• LANGUAGE print()
  

• LANGUAGE println()
  

• LANGUAGE write()
  

• LANGUAGE SerialEvent()
  

• LANGUAGE Stream.peek()