mbed library sources

Fork of mbed-src by mbed official

Embed: (wiki syntax)

« Back to documentation index

Serial Class Reference

Serial Class Reference

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

#include <Serial.h>

Inherits mbed::SerialBase, and 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=SerialBase::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.
void attach (void(*fptr)(void), IrqType type=RxIrq)
 Attach a function to call whenever a serial interrupt is generated.
template<typename T >
void attach (T *tptr, void(T::*mptr)(void), IrqType type=RxIrq)
 Attach a member function to call whenever a serial interrupt is generated.
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.
int write (uint8_t *buffer, int length, const event_callback_t &callback, int event=SERIAL_EVENT_TX_COMPLETE)
 Begin asynchronous write using 8bit buffer.
int write (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.
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.
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.

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 47 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

Definition at line 23 of file Serial.cpp.


Member Function Documentation

void abort_read ( void   ) [inherited]

Abort the on-going read transfer.

Definition at line 144 of file SerialBase.cpp.

void abort_write ( void   ) [inherited]

Abort the on-going write transfer.

Definition at line 139 of file SerialBase.cpp.

void attach ( T *  tptr,
void(T::*)(void)  mptr,
IrqType  type = RxIrq 
) [inherited]

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)

Definition at line 104 of file SerialBase.h.

void attach ( void(*)(void)  fptr,
IrqType  type = RxIrq 
) [inherited]

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)

Definition at line 51 of file SerialBase.cpp.

void baud ( int  baudrate ) [inherited]

Set the baud rate of the serial port.

Parameters:
baudrateThe baudrate of the serial port (default = 9600).

Definition at line 33 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:
bitsThe number of bits in a word (5-8; default = 8)
parityThe parity used (SerialBase::None, SerialBase::Odd, SerialBase::Even, SerialBase::Forced1, SerialBase::Forced0; default = SerialBase::None)
stopThe number of stop bits (1 or 2; default = 1)

Definition at line 38 of file SerialBase.cpp.

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 
) [inherited]

Begin asynchronous reading using 16bit buffer.

The completition invokes registred RX event callback.

Parameters:
bufferThe buffer where received data will be stored
lengthThe buffer length
callbackThe event callback function
eventThe logical OR of RX events
char_matchThe matching character

Definition at line 177 of file SerialBase.cpp.

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 
) [inherited]

Begin asynchronous reading using 8bit buffer.

The completition invokes registred RX event callback.

Parameters:
bufferThe buffer where received data will be stored
lengthThe buffer length
callbackThe event callback function
eventThe logical OR of RX events
char_matchThe matching character

Definition at line 167 of file SerialBase.cpp.

int readable (  ) [inherited]

Determine if there is a character available to read.

Returns:
1 if there is a character available to read, 0 otherwise

Definition at line 42 of file SerialBase.cpp.

void send_break (  ) [inherited]

Generate a break condition on the serial line.

Definition at line 74 of file SerialBase.cpp.

int set_dma_usage_rx ( DMAUsage  usage ) [inherited]

Configure DMA usage suggestion for non-blocking RX transfers.

Parameters:
usageThe usage DMA hint for peripheral
Returns:
Zero if the usage was set, -1 if a transaction is on-going

Definition at line 158 of file SerialBase.cpp.

int set_dma_usage_tx ( DMAUsage  usage ) [inherited]

Configure DMA usage suggestion for non-blocking TX transfers.

Parameters:
usageThe usage DMA hint for peripheral
Returns:
Zero if the usage was set, -1 if a transaction is on-going

Definition at line 149 of file SerialBase.cpp.

void set_flow_control ( Flow  type,
PinName  flow1 = NC,
PinName  flow2 = NC 
) [inherited]

Set the flow control type on the serial port.

Parameters:
typethe flow control type (Disabled, RTS, CTS, RTSCTS)
flow1the first flow control pin (RTS for RTS or RTSCTS, CTS for CTS)
flow2the second flow control pin (CTS for RTSCTS)

Definition at line 89 of file SerialBase.cpp.

int write ( uint16_t *  buffer,
int  length,
const event_callback_t callback,
int  event = SERIAL_EVENT_TX_COMPLETE 
) [inherited]

Begin asynchronous write using 16bit buffer.

The completition invokes registered TX event callback

Parameters:
bufferThe buffer where received data will be stored
lengthThe buffer length
callbackThe event callback function
eventThe logical OR of TX events

Definition at line 122 of file SerialBase.cpp.

int write ( uint8_t *  buffer,
int  length,
const event_callback_t callback,
int  event = SERIAL_EVENT_TX_COMPLETE 
) [inherited]

Begin asynchronous write using 8bit buffer.

The completition invokes registered TX event callback

Parameters:
bufferThe buffer where received data will be stored
lengthThe buffer length
callbackThe event callback function
eventThe logical OR of TX events

Definition at line 113 of file SerialBase.cpp.

int writeable (  ) [inherited]

Determine if there is space available to write a character.

Returns:
1 if there is space to write a character, 0 otherwise

Definition at line 47 of file SerialBase.cpp.