A serial port (UART) for communication with other serial devices. More...

#include <Serial.h>

Inherits mbed::SerialBase, mbed::Stream, NonCopyable< Serial >, mbed::SerialBase, mbed::Stream, and NonCopyable< Serial >.

Public Member Functions
	Serial (PinName tx, PinName rx, const char *name=NULL, int baud=MBED_CONF_PLATFORM_DEFAULT_SERIAL_BAUD_RATE)
	Create a Serial port, connected to the specified transmit and receive pins.
	Serial (PinName tx, PinName rx, int baud)
	Create a Serial port, connected to the specified transmit and receive pins, with the specified baud.
bool	readable ()
	Determine if there is a character available to read.
bool	writeable ()
	Determine if there is space available to write a character.
	Serial (PinName tx, PinName rx, const char *name=NULL, int baud=MBED_CONF_PLATFORM_DEFAULT_SERIAL_BAUD_RATE)
	Create a Serial port, connected to the specified transmit and receive pins.
	Serial (PinName tx, PinName rx, int baud)
	Create a Serial port, connected to the specified transmit and receive pins, with the specified baud.
bool	readable ()
	Determine if there is a character available to read.
bool	writeable ()
	Determine if there is space available to write a character.
void	baud (int baudrate)
	Set the baud rate of the serial port.
void	baud (int baudrate)
	Set the baud rate of the serial port.
void	format (int bits=8, Parity parity=SerialBase::None, int stop_bits=1)
	Set the transmission format used by the serial port.
void	format (int bits=8, Parity parity=SerialBase::None, int stop_bits=1)
	Set the transmission format used by the serial port.
void	attach (Callback< void()> func, IrqType type=RxIrq)
	Attach a function to call whenever a serial interrupt is generated.
void	attach (Callback< void()> func, IrqType type=RxIrq)
	Attach a function to call whenever a serial interrupt is generated.
template<typename T >
	MBED_DEPRECATED_SINCE ("mbed-os-5.1","The attach function does not support cv-qualifiers. Replaced by ""attach(callback(obj, method), type).") void attach(T *obj
	Attach a member function to call whenever a serial interrupt is generated.
template<typename T >
	MBED_DEPRECATED_SINCE ("mbed-os-5.1","The attach function does not support cv-qualifiers. Replaced by ""attach(callback(obj, method), type).") void attach(T *obj
	Attach a member function to call whenever a serial interrupt is generated.
void	clear_break ()
	Clear a break condition on the serial line NOTE: Should be run at least one frame after set_break is called.
void	clear_break ()
	Clear a break condition on the serial line NOTE: Should be run at least one frame after set_break is called.
void	send_break ()
	Generate a break condition on the serial line.
void	send_break ()
	Generate a break condition on the serial line.
void	set_flow_control (Flow type, PinName flow1=NC, PinName flow2=NC)
	Set the flow control type on the serial port.
void	set_flow_control (Flow type, PinName flow1=NC, PinName flow2=NC)
	Set the flow control type on the serial port.
int	write (const uint8_t *buffer, int length, const event_callback_t &callback, int event=SERIAL_EVENT_TX_COMPLETE)
	Begin asynchronous write using 8bit buffer.
int	write (const uint16_t *buffer, int length, const event_callback_t &callback, int event=SERIAL_EVENT_TX_COMPLETE)
	Begin asynchronous write using 16bit buffer.
int	write (const uint8_t *buffer, int length, const event_callback_t &callback, int event=SERIAL_EVENT_TX_COMPLETE)
	Begin asynchronous write using 8bit buffer.
int	write (const uint16_t *buffer, int length, const event_callback_t &callback, int event=SERIAL_EVENT_TX_COMPLETE)
	Begin asynchronous write using 16bit buffer.
void	abort_write ()
	Abort the on-going write transfer.
void	abort_write ()
	Abort the on-going write transfer.
int	read (uint8_t *buffer, int length, const event_callback_t &callback, int event=SERIAL_EVENT_RX_COMPLETE, unsigned char char_match=SERIAL_RESERVED_CHAR_MATCH)
	Begin asynchronous reading using 8bit buffer.
int	read (uint16_t *buffer, int length, const event_callback_t &callback, int event=SERIAL_EVENT_RX_COMPLETE, unsigned char char_match=SERIAL_RESERVED_CHAR_MATCH)
	Begin asynchronous reading using 16bit buffer.
int	read (uint8_t *buffer, int length, const event_callback_t &callback, int event=SERIAL_EVENT_RX_COMPLETE, unsigned char char_match=SERIAL_RESERVED_CHAR_MATCH)
	Begin asynchronous reading using 8bit buffer.
int	read (uint16_t *buffer, int length, const event_callback_t &callback, int event=SERIAL_EVENT_RX_COMPLETE, unsigned char char_match=SERIAL_RESERVED_CHAR_MATCH)
	Begin asynchronous reading using 16bit buffer.
void	abort_read ()
	Abort the on-going read transfer.
void	abort_read ()
	Abort the on-going read transfer.
int	set_dma_usage_tx (DMAUsage usage)
	Configure DMA usage suggestion for non-blocking TX transfers.
int	set_dma_usage_tx (DMAUsage usage)
	Configure DMA usage suggestion for non-blocking TX transfers.
int	set_dma_usage_rx (DMAUsage usage)
	Configure DMA usage suggestion for non-blocking RX transfers.
int	set_dma_usage_rx (DMAUsage usage)
	Configure DMA usage suggestion for non-blocking RX transfers.
	MBED_DEPRECATED_SINCE ("mbed-os-5.4","Replaced by FileHandle::seek") virtual off_t lseek(off_t offset
	Move the file position to a given offset from a given location.
Protected Member Functions
virtual void	lock ()
	Acquire exclusive access to this serial port.
virtual void	unlock ()
	Release exclusive access to this serial port.
virtual void	lock ()
	Acquire exclusive access to this serial port.
virtual void	unlock ()
	Release exclusive access to this serial port.
virtual int	close ()
	Close a file.
virtual int	close ()
	Close a file.
virtual ssize_t	write (const void *buffer, size_t length)
	Write the contents of a buffer to a file.
virtual ssize_t	read (void *buffer, size_t length)
	Read the contents of a file into a buffer.
virtual off_t	seek (off_t offset, int whence)
	Move the file position to a given offset from from a given location.
virtual off_t	seek (off_t offset, int whence)
	Move the file position to a given offset from from a given location.
virtual off_t	tell ()
	Get the file position of the file.
virtual off_t	tell ()
	Get the file position of the file.
virtual void	rewind ()
	Rewind the file position to the beginning of the file.
virtual void	rewind ()
	Rewind the file position to the beginning of the file.
virtual int	isatty ()
	Check if the file in an interactive terminal device.
virtual int	isatty ()
	Check if the file in an interactive terminal device.
virtual int	sync ()
	Flush any buffers associated with the file.
virtual int	sync ()
	Flush any buffers associated with the file.
virtual off_t	size ()
	Get the size of the file.
virtual off_t	size ()
	Get the size of the file.
	MBED_DEPRECATED ("Invalid copy construction of a NonCopyable resource.") NonCopyable(const NonCopyable &)
	NonCopyable copy constructor.
	MBED_DEPRECATED ("Invalid copy assignment of a NonCopyable resource.") NonCopyable &operator
	NonCopyable copy assignment operator.
	MBED_DEPRECATED ("Invalid copy construction of a NonCopyable resource.") NonCopyable(const NonCopyable &)
	NonCopyable copy constructor.
	MBED_DEPRECATED ("Invalid copy assignment of a NonCopyable resource.") NonCopyable &operator
	NonCopyable copy assignment operator.
	MBED_DEPRECATED ("Invalid copy construction of a NonCopyable resource.") NonCopyable(const NonCopyable &)
	NonCopyable copy constructor.
	MBED_DEPRECATED ("Invalid copy assignment of a NonCopyable resource.") NonCopyable &operator
	NonCopyable copy assignment operator.
	MBED_DEPRECATED ("Invalid copy construction of a NonCopyable resource.") NonCopyable(const NonCopyable &)
	NonCopyable copy constructor.
	MBED_DEPRECATED ("Invalid copy assignment of a NonCopyable resource.") NonCopyable &operator
	NonCopyable copy assignment operator.
	MBED_DEPRECATED ("Invalid copy construction of a NonCopyable resource.") NonCopyable(const NonCopyable &)
	NonCopyable copy constructor.
	MBED_DEPRECATED ("Invalid copy assignment of a NonCopyable resource.") NonCopyable &operator
	NonCopyable copy assignment operator.
Private Member Functions
	MBED_DEPRECATED ("Invalid copy construction of a NonCopyable resource.") NonCopyable(const NonCopyable &)
	NonCopyable copy constructor.
	MBED_DEPRECATED ("Invalid copy assignment of a NonCopyable resource.") NonCopyable &operator
	NonCopyable copy assignment operator.

Detailed Description

A serial port (UART) for communication with other serial devices.

Can be used for Full Duplex communication, or Simplex by specifying one pin as NC (Not Connected)

Note:: Synchronization level: Thread safe

Example:

 // Print "Hello World" to the PC

 #include "mbed.h"

 Serial pc(USBTX, USBRX);

 int main() {
     pc.printf("Hello World\n");
 }

Definition at line 54 of file cmsis/BUILD/mbed/drivers/Serial.h.

Constructor & Destructor Documentation

Serial	(	PinName	tx,
		PinName	rx,
		const char *	name = `NULL`,
		int	baud = `MBED_CONF_PLATFORM_DEFAULT_SERIAL_BAUD_RATE`
	)

Create a Serial port, connected to the specified transmit and receive pins.

Parameters:

tx	Transmit pin
rx	Receive pin
name	The name of the stream associated with this serial port (optional)
baud	The baud rate of the serial port (optional, defaults to MBED_CONF_PLATFORM_DEFAULT_SERIAL_BAUD_RATE or 9600)

Note:: Either tx or rx may be specified as NC (Not Connected) if unused

Definition at line 24 of file Serial.cpp.

Serial	(	PinName	tx,
		PinName	rx,
		int	baud
	)

Create a Serial port, connected to the specified transmit and receive pins, with the specified baud.

Parameters:

tx	Transmit pin
rx	Receive pin
baud	The baud rate of the serial port

Note:: Either tx or rx may be specified as NC (Not Connected) if unused

Definition at line 28 of file Serial.cpp.

Serial	(	PinName	tx,
		PinName	rx,
		const char *	name = `NULL`,
		int	baud = `MBED_CONF_PLATFORM_DEFAULT_SERIAL_BAUD_RATE`
	)

Create a Serial port, connected to the specified transmit and receive pins.

Parameters:

tx	Transmit pin
rx	Receive pin
name	The name of the stream associated with this serial port (optional)
baud	The baud rate of the serial port (optional, defaults to MBED_CONF_PLATFORM_DEFAULT_SERIAL_BAUD_RATE or 9600)

Note:: Either tx or rx may be specified as NC (Not Connected) if unused

Serial	(	PinName	tx,
		PinName	rx,
		int	baud
	)

Create a Serial port, connected to the specified transmit and receive pins, with the specified baud.

Parameters:

tx	Transmit pin
rx	Receive pin
baud	The baud rate of the serial port

Note:: Either tx or rx may be specified as NC (Not Connected) if unused

Member Function Documentation

void abort_read ( void ) [inherited]

Abort the on-going read transfer.

Definition at line 238 of file SerialBase.cpp.

void abort_read ( ) [inherited]

Abort the on-going read transfer.

void abort_write ( void ) [inherited]

Abort the on-going write transfer.

Definition at line 228 of file SerialBase.cpp.

void abort_write ( ) [inherited]

Abort the on-going write transfer.

void attach	(	Callback< void()>	func,
		IrqType	type = `RxIrq`
	)		`[inherited]`

Attach a function to call whenever a serial interrupt is generated.

Parameters:

func	A pointer to a void function, or 0 to set as none
type	Which serial interrupt to attach the member function to (Serial::RxIrq for receive, TxIrq for transmit buffer empty)

Definition at line 77 of file SerialBase.cpp.

void attach	(	Callback< void()>	func,
		IrqType	type = `RxIrq`
	)		`[inherited]`

Attach a function to call whenever a serial interrupt is generated.

Parameters:

func	A pointer to a void function, or 0 to set as none
type	Which serial interrupt to attach the member function to (Serial::RxIrq for receive, TxIrq for transmit buffer empty)

void baud ( int baudrate ) [inherited]

Set the baud rate of the serial port.

Parameters:

baudrate The baudrate of the serial port (default = 9600).

void baud ( int baudrate ) [inherited]

Set the baud rate of the serial port.

Parameters:

baudrate The baudrate of the serial port (default = 9600).

Definition at line 45 of file SerialBase.cpp.

void clear_break ( ) [inherited]

Clear a break condition on the serial line NOTE: Should be run at least one frame after set_break is called.

Definition at line 129 of file SerialBase.cpp.

void clear_break ( ) [inherited]

Clear a break condition on the serial line NOTE: Should be run at least one frame after set_break is called.

int close ( ) [protected, virtual, inherited]

Close a file.

Returns:: 0 on success, negative error code on failure

Implements FileHandle.

Definition at line 77 of file Stream.cpp.

virtual int close ( ) [protected, virtual, inherited]

Close a file.

Returns:: 0 on success, negative error code on failure

Implements FileHandle.

void format	(	int	bits = `8`,
		Parity	parity = `SerialBase::None`,
		int	stop_bits = `1`
	)		`[inherited]`

Set the transmission format used by the serial port.

Parameters:

bits	The number of bits in a word (5-8; default = 8)
parity	The parity used (SerialBase::None, SerialBase::Odd, SerialBase::Even, SerialBase::Forced1, SerialBase::Forced0; default = SerialBase::None)
stop_bits	The number of stop bits (1 or 2; default = 1)

Definition at line 53 of file SerialBase.cpp.

void format	(	int	bits = `8`,
		Parity	parity = `SerialBase::None`,
		int	stop_bits = `1`
	)		`[inherited]`

Set the transmission format used by the serial port.

Parameters:

bits	The number of bits in a word (5-8; default = 8)
parity	The parity used (SerialBase::None, SerialBase::Odd, SerialBase::Even, SerialBase::Forced1, SerialBase::Forced0; default = SerialBase::None)
stop_bits	The number of stop bits (1 or 2; default = 1)

int isatty ( ) [protected, virtual, inherited]

Check if the file in an interactive terminal device.

Returns:: True if the file is a terminal; False if the file is not a terminal; Negative error code on failure

Reimplemented from FileHandle.

Definition at line 130 of file Stream.cpp.

virtual int isatty ( ) [protected, virtual, inherited]

Check if the file in an interactive terminal device.

Returns:: True if the file is a terminal; False if the file is not a terminal; Negative error code on failure

Reimplemented from FileHandle.

void lock ( void ) [protected, virtual]

Acquire exclusive access to this serial port.

Reimplemented from SerialBase.

Definition at line 44 of file Serial.cpp.

virtual void lock ( void ) [protected, virtual]

Acquire exclusive access to this serial port.

Reimplemented from SerialBase.

MBED_DEPRECATED ( "Invalid copy assignment of a NonCopyable< FileLike > resource." ) [protected, inherited]

NonCopyable copy assignment operator.