Massimiliano Flori / mbed_fw_rev1_1

Important changes to repositories hosted on mbed.com

Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.

To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.

It is also possible to export all your personal repositories from the account settings page.

Dependencies:   mbed

Embed: (wiki syntax)

« Back to documentation index

Serial Class Reference
Public Member Functions

Serial Class Reference

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

#include <Serial.h>

Inherits mbed::Stream.

Public Member Functions

 Serial (PinName tx, PinName rx, const char *name=NULL)
 Create a Serial port, connected to the specified transmit and receive pins.
void baud (int baudrate)
 Set the baud rate of the serial port.
void format (int bits=8, Parity parity=Serial::None, int stop_bits=1)
 Set the transmission format used by the Serial port.
int readable ()
 Determine if there is a character available to read.
int writeable ()
 Determine if there is space available to write a character.
pFunctionPointer_t attach (void(*fptr)(void), IrqType type=RxIrq)
 Attach a function to call whenever a serial interrupt is generated.
pFunctionPointer_t add_handler (void(*fptr)(void), IrqType type=RxIrq)
 Add a function to be called when a serial interrupt is generated at the end of the call chain.
pFunctionPointer_t add_handler_front (void(*fptr)(void), IrqType type=RxIrq)
 Add a function to be called when a serial interrupt is generated at the beginning of the call chain.
template<typename T >
pFunctionPointer_t attach (T *tptr, void(T::*mptr)(void), IrqType type=RxIrq)
 Attach a member function to call whenever a serial interrupt is generated.
template<typename T >
pFunctionPointer_t add_handler (T *tptr, void(T::*mptr)(void), IrqType type=RxIrq)
 Add a function to be called when a serial interrupt is generated at the end of the call chain.
template<typename T >
pFunctionPointer_t add_handler_front (T *tptr, void(T::*mptr)(void), IrqType type=RxIrq)
 Add a function to be called when a serial interrupt is generated at the beginning of the call chain.
bool remove_handler (pFunctionPointer_t pf, IrqType type=RxIrq)
 Remove a function from the list of functions to be called when a serial interrupt is generated.
void send_break ()
 Generate a break condition on the serial line.

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)

Example: 

 // Print "Hello World" to the PC

 #include "mbed.h"

 Serial pc(USBTX, USBRX);

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

Definition at line 48 of file Serial.h.

Constructor & Destructor Documentation

Serial ( PinName  tx,
PinName  rx,
const char *  name = NULL 
)

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

Parameters:
txTransmit pin
rxReceive pin
Note:
Either tx or rx may be specified as NC if unused

Member Function Documentation

pFunctionPointer_t add_handler ( T *  tptr,
void(T::*)(void)  mptr,
IrqType  type = RxIrq 
)

Add a function to be called when a serial interrupt is generated at the end of the call chain.

Parameters:
tptrpointer to the object to call the member function on
mptrpointer to the member function to be called
typeWhich serial interrupt to attach the member function to (Seriall::RxIrq for receive, TxIrq for transmit buffer empty)
Returns:
The function object created for 'fptr'

Definition at line 169 of file Serial.h.

pFunctionPointer_t add_handler ( void(*)(void)  fptr,
IrqType  type = RxIrq 
)

Add a function to be called when a serial interrupt is generated at the end of the call chain.

Parameters:
fptrthe function to add
typeWhich serial interrupt to attach the member function to (Seriall::RxIrq for receive, TxIrq for transmit buffer empty)
Returns:
The function object created for 'fptr'

Definition at line 122 of file Serial.h.

pFunctionPointer_t add_handler_front ( T *  tptr,
void(T::*)(void)  mptr,
IrqType  type = RxIrq 
)

Add a function to be called when a serial interrupt is generated at the beginning of the call chain.

Parameters:
tptrpointer to the object to call the member function on
mptrpointer to the member function to be called
typeWhich serial interrupt to attach the member function to (Seriall::RxIrq for receive, TxIrq for transmit buffer empty)
Returns:
The function object created for 'fptr'

Definition at line 183 of file Serial.h.

pFunctionPointer_t add_handler_front ( void(*)(void)  fptr,
IrqType  type = RxIrq 
)

Add a function to be called when a serial interrupt is generated at the beginning of the call chain.

Parameters:
fptrthe function to add
typeWhich serial interrupt to attach the member function to (Seriall::RxIrq for receive, TxIrq for transmit buffer empty)
Returns:
The function object created for 'fptr'

Definition at line 134 of file Serial.h.

pFunctionPointer_t attach ( T *  tptr,
void(T::*)(void)  mptr,
IrqType  type = RxIrq 
)

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

Parameters:
tptrpointer to the object to call the member function on
mptrpointer to the member function to be called
typeWhich serial interrupt to attach the member function to (Seriall::RxIrq for receive, TxIrq for transmit buffer empty)
Thefunction object created for 'tptr' and 'mptr'

Definition at line 148 of file Serial.h.

pFunctionPointer_t attach ( void(*)(void)  fptr,
IrqType  type = RxIrq 
)

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

Parameters:
fptrA pointer to a void function, or 0 to set as none
typeWhich serial interrupt to attach the member function to (Seriall::RxIrq for receive, TxIrq for transmit buffer empty)
Returns:
The function object created for 'fptr'
void baud ( int  baudrate )

Set the baud rate of the serial port.

Parameters:
baudrateThe baudrate of the serial port (default = 9600).
void format ( int  bits = 8,
Parity  parity = Serial::None,
int  stop_bits = 1 
)

Set the transmission format used by the Serial port.

Parameters:
bitsThe number of bits in a word (5-8; default = 8)
parityThe parity used (Serial::None, Serial::Odd, Serial::Even, Serial::Forced1, Serial::Forced0; default = Serial::None)
stopThe number of stop bits (1 or 2; default = 1)
int readable (  )

Determine if there is a character available to read.

Returns:
1 if there is a character available to read, 0 otherwise
bool remove_handler ( pFunctionPointer_t  pf,
IrqType  type = RxIrq 
)

Remove a function from the list of functions to be called when a serial interrupt is generated.

Parameters:
pfthe function object to remove
typeWhich serial interrupt to attach the member function to (Seriall::RxIrq for receive, TxIrq for transmit buffer empty)
Returns:
true if the function was found and removed, false otherwise
void send_break (  )

Generate a break condition on the serial line.

int writeable (  )

Determine if there is space available to write a character.

Returns:
1 if there is space to write a character, 0 otherwise
Generated on Thu Jul 14 2022 04:58:45 by  doxygen 1.7.2