mbed-drivers
Public Member Functions | Protected Member Functions | List of all members
mbed::Serial Class Reference

#include <Serial.h>

Inheritance diagram for mbed::Serial:
mbed::SerialBase mbed::Stream mbed::FileLike mbed::FileHandle mbed::FileBase

Public Member Functions

 Serial (PinName tx, PinName rx, const char *name=NULL)
 
- Public Member Functions inherited from mbed::SerialBase
void baud (int baudrate)
 
void format (int bits=8, Parity parity=SerialBase::None, int stop_bits=1)
 
int readable ()
 
int writeable ()
 
void attach (void(*fptr)(void), IrqType type=RxIrq)
 
template<typename T >
void attach (T *tptr, void(T::*mptr)(void), IrqType type=RxIrq)
 
void send_break ()
 
void set_flow_control (Flow type, PinName flow1=NC, PinName flow2=NC)
 
int write (void *buffer, int length, const event_callback_t &callback, int event=SERIAL_EVENT_TX_COMPLETE)
 
int write (const Buffer &buf, const event_callback_t &callback, int event=SERIAL_EVENT_TX_COMPLETE)
 
void abort_write ()
 
int read (void *buffer, int length, const event_callback_t &callback, int event=SERIAL_EVENT_RX_COMPLETE, unsigned char char_match=SERIAL_RESERVED_CHAR_MATCH)
 
int read (const Buffer &buffer, const event_callback_t &callback, int event=SERIAL_EVENT_RX_COMPLETE, unsigned char char_match=SERIAL_RESERVED_CHAR_MATCH)
 
void abort_read ()
 
int set_dma_usage_tx (DMAUsage usage)
 
int set_dma_usage_rx (DMAUsage usage)
 
- Public Member Functions inherited from mbed::Stream
 Stream (const char *name=NULL)
 
int putc (int c)
 
int puts (const char *s)
 
int getc ()
 
char * gets (char *s, int size)
 
int printf (const char *format,...)
 
int scanf (const char *format,...)
 
int vprintf (const char *format, std::va_list args)
 
int vscanf (const char *format, std::va_list args)
 
 operator std::FILE * ()
 
- Public Member Functions inherited from mbed::FileLike
 FileLike (const char *name)
 
- Public Member Functions inherited from mbed::FileBase
 FileBase (const char *name, PathType t)
 
const char * getName (void)
 
PathType getPathType (void)
 

Protected Member Functions

virtual int _getc ()
 
virtual int _putc (int c)
 
- Protected Member Functions inherited from mbed::SerialBase
void start_read (const Buffer &buffer, char buffer_width, const event_callback_t &callback, int event, unsigned char char_match)
 
void start_write (const Buffer &buffer, char buffer_width, const event_callback_t &callback, int event)
 
void interrupt_handler_asynch (void)
 
 SerialBase (PinName tx, PinName rx)
 
int _base_getc ()
 
int _base_putc (int c)
 
- Protected Member Functions inherited from mbed::Stream
virtual int close ()
 
virtual ssize_t write (const void *buffer, size_t length)
 
virtual ssize_t read (void *buffer, size_t length)
 
virtual off_t lseek (off_t offset, int whence)
 
virtual int isatty ()
 
virtual int fsync ()
 
virtual off_t flen ()
 

Additional Inherited Members

- Public Types inherited from mbed::SerialBase
enum  Parity {
  None = 0, Odd, Even, Forced1,
  Forced0
}
 
enum  IrqType { RxIrq = 0, TxIrq }
 
enum  Flow { Disabled = 0, RTS, CTS, RTSCTS }
 
typedef mbed::util::FunctionPointer2< void, Buffer, int > event_callback_t
 
- Static Public Member Functions inherited from mbed::SerialBase
static void _irq_handler (uint32_t id, SerialIrq irq_type)
 
- Static Public Member Functions inherited from mbed::FileBase
static FileBaselookup (const char *name, unsigned int len)
 
static FileBaseget (int n)
 
- Protected Types inherited from mbed::SerialBase
typedef OneWayTransaction< event_callback_ttransaction_data_t
 
typedef Transaction< SerialBase, transaction_data_ttransaction_t
 
- Protected Attributes inherited from mbed::SerialBase
CThunk< SerialBase_thunk_irq
 
transaction_data_t _current_tx_transaction
 
transaction_data_t _current_rx_transaction
 
DMAUsage _tx_usage
 
DMAUsage _rx_usage
 
serial_t _serial
 
mbed::util::FunctionPointer _irq [2]
 
int _baud
 
- Protected Attributes inherited from mbed::Stream
std::FILE * _file
 
- Protected Attributes inherited from mbed::FileBase
FileBase_next
 
const char * _name
 
PathType _path_type
 
- Static Protected Attributes inherited from mbed::FileBase
static FileBase_head = NULL
 

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");
}

Constructor & Destructor Documentation

mbed::Serial::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

The documentation for this class was generated from the following files: