Main Content

flush

Clear serial port device buffers

collapse all in page

Syntax

flush(device)
flush(device,"input")
flush(device,"output")

Description

flush(device) flushes all data from both the input and output buffers of the specified serial port.

example

flush(device,"input") flushes only the input buffer.

flush(device,"output") flushes only the output buffer.

Examples

collapse all

Create a connection to a serial port device.

device = serialport("COM3",9600)
device = 

  Serialport with properties:

                 Port: "COM3"
             BaudRate: 9600
    NumBytesAvailable: 0

  Show all properties, functions

Write some data to the device and view the number of bytes available to be read in the input buffer.

write(device,1:5,"uint8")
device.NumBytesAvailable
ans =

     5

Flush both the input and output buffers.

flush(device);

View the number of bytes available to be read.

device.NumBytesAvailable
ans =

     0

The input buffer has no data.

Input Arguments

collapse all

Serial port connection, specified as a serialport object.

Example: flush(device) flushes data from the serial port connection device.

Version History

Introduced in R2019b

See Also

Functions