Duy tran / easy-connect-customized

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.

Embed: (wiki syntax)

« Back to documentation index

BufferedSerial Class Reference
Public Member Functions

BufferedSerial Class Reference

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

#include <BufferedSerial.h>

Public Member Functions

 BufferedSerial (PinName tx, PinName rx, uint32_t buf_size=256, uint32_t tx_multiple=4, const char *name=NULL)
 Create a BufferedSerial port, connected to the specified transmit and receive pins.
virtual ~BufferedSerial (void)
 Destroy a BufferedSerial port.
virtual int readable (void)
 Check on how many bytes are in the rx buffer.
virtual int writeable (void)
 Check to see if the tx buffer has room.
virtual int getc (void)
 Get a single byte from the BufferedSerial Port.
virtual int putc (int c)
 Write a single byte to the BufferedSerial Port.
virtual int puts (const char *s)
 Write a string to the BufferedSerial Port.
virtual int printf (const char *format,...)
 Write a formatted string to the BufferedSerial Port.
virtual ssize_t write (const void *s, std::size_t length)
 Write data to the Buffered Serial Port.
virtual void attach (Callback< void()> func, IrqType type=RxIrq)
 Attach a function to call whenever a serial interrupt is generated.
template<typename T >
void attach (T *obj, void(T::*method)(), IrqType type=RxIrq)
 Attach a member function to call whenever a serial interrupt is generated.
template<typename T >
void attach (T *obj, void(*method)(T *), IrqType type=RxIrq)
 Attach a member function to call whenever a serial interrupt is generated.

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: 

  #include "mbed.h"
  #include "BufferedSerial.h"

  BufferedSerial pc(USBTX, USBRX);

  int main()
  { 
      while(1)
      {
          Timer s;
        
          s.start();
          pc.printf("Hello World - buffered\n");
          int buffered_time = s.read_us();
          wait(0.1f); // give time for the buffer to empty
        
          s.reset();
          printf("Hello World - blocking\n");
          int polled_time = s.read_us();
          s.stop();
          wait(0.1f); // give time for the buffer to empty
        
          pc.printf("printf buffered took %d us\n", buffered_time);
          pc.printf("printf blocking took %d us\n", polled_time);
          wait(0.5f);
      }
  }

Software buffers and interrupt driven tx and rx for Serial

Definition at line 71 of file BufferedSerial.h.

Constructor & Destructor Documentation

BufferedSerial ( PinName  tx,
PinName  rx,
uint32_t  buf_size = 256,
uint32_t  tx_multiple = 4,
const char *  name = NULL 
)

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

Parameters:
txTransmit pin
rxReceive pin
buf_sizeprintf() buffer size
tx_multipleamount of max printf() present in the internal ring buffer at one time
nameoptional name
Note:
Either tx or rx may be specified as NC if unused

Definition at line 28 of file BufferedSerial.cpp.

~BufferedSerial ( void   ) [virtual]

Destroy a BufferedSerial port.

Definition at line 37 of file BufferedSerial.cpp.

Member Function Documentation

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

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

Parameters:
funcA pointer to a void function, or 0 to set as none
typeWhich serial interrupt to attach the member function to (Serial::RxIrq for receive, TxIrq for transmit buffer empty)

Definition at line 162 of file BufferedSerial.cpp.

void attach ( T *  obj,
void(T::*)()  method,
IrqType  type = RxIrq 
)

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

Parameters:
objpointer to the object to call the member function on
methodpointer to the member function to call
typeWhich serial interrupt to attach the member function to (Serial::RxIrq for receive, TxIrq for transmit buffer empty)

Definition at line 153 of file BufferedSerial.h.

void attach ( T *  obj,
void(*)(T *)  method,
IrqType  type = RxIrq 
)

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

Parameters:
objpointer to the object to call the member function on
methodpointer to the member function to call
typeWhich serial interrupt to attach the member function to (Serial::RxIrq for receive, TxIrq for transmit buffer empty)

Definition at line 163 of file BufferedSerial.h.

int getc ( void   ) [virtual]

Get a single byte from the BufferedSerial Port.

Should check readable() before calling this.

Returns:
A byte that came in on the Serial Port

Definition at line 55 of file BufferedSerial.cpp.

int printf ( const char *  format,
  ... 
) [virtual]

Write a formatted string to the BufferedSerial Port.

Parameters:
formatThe string + format specifiers to write to the Serial Port
Returns:
The number of bytes written to the Serial Port Buffer

Definition at line 90 of file BufferedSerial.cpp.

int putc ( int  c ) [virtual]

Write a single byte to the BufferedSerial Port.

Parameters:
cThe byte to write to the Serial Port
Returns:
The byte that was written to the Serial Port Buffer

Definition at line 60 of file BufferedSerial.cpp.

int puts ( const char *  s ) [virtual]

Write a string to the BufferedSerial Port.

Must be NULL terminated

Parameters:
sThe string to write to the Serial Port
Returns:
The number of bytes written to the Serial Port Buffer

Definition at line 68 of file BufferedSerial.cpp.

int readable ( void   ) [virtual]

Check on how many bytes are in the rx buffer.

Returns:
1 if something exists, 0 otherwise

Definition at line 45 of file BufferedSerial.cpp.

virtual ssize_t write ( const void *  s,
std::size_t  length 
) [virtual]

Write data to the Buffered Serial Port.

Parameters:
sA pointer to data to send
lengthThe amount of data being pointed to
Returns:
The number of bytes written to the Serial Port Buffer
int writeable ( void   ) [virtual]

Check to see if the tx buffer has room.

Returns:
1 always has room and can overwrite previous content if too small / slow

Definition at line 50 of file BufferedSerial.cpp.

Generated on Tue Jul 12 2022 19:14:51 by  doxygen 1.7.2