serialbreak

Send break to device connected to serial port

Syntax

serialbreak(device,time)

Description

serialbreak(device,time) sends a break of the specified duration time, in milliseconds, to the specified serial port device, by setting the transmit pin (TXD) to high for the duration. The duration of the break might be inaccurate under some operating systems. For some devices, you can use the break signal as a way to clear the hardware buffer. The function suspends MATLAB^® execution until it is complete.

Input Arguments

device — Serial port connection

serialport object

Serial port connection, specified as a serialport object.

Example: serialbreak(device,10) sends a 10 millisecond break to the serial port connection device.

time — Duration of break

numeric

Duration of break in milliseconds, specified as a positive integer value.

Example: serialbreak(device,10) sends a 10 millisecond break to the serial port connection device.

Version History

Introduced before R2006a

R2023b: serialport object interface supports serialbreak

Use the serialbreak function with a serialport object to send a serial break to your instrument.

R2021a: serial object interface will be removed

Use of this function with a serial object will be removed. To access a serial port device, use a serialport object with its functions and properties instead.

The recommended functionality has additional capabilities and improved performance. See Transition Your Code to serialport Interface for more information about using the recommended functionality.