A library for talking to Multi-Tech's Cellular SocketModem Devices.

Dependents:   M2X_dev axeda_wrapper_dev MTS_M2x_Example1 MTS_Cellular_Connect_Example ... more

io/MTSSerial.h

Committer:
mfiore
Date:
2013-12-19
Revision:
40:14342c4de476
Parent:
36:bb6b293c7495
Parent:
39:6e94520a3217
Child:
46:b30547bf07d5

File content as of revision 40:14342c4de476:

#ifndef MTSSERIAL_H
#define MTSSERIAL_H

#include "mbed.h"
#include "MTSBufferedIO.h"

namespace mts {
    
/** This class derives from MTSBufferedIO and provides a buffered wrapper to the
* standard Mbed Serial class. Since it depends only on the Mbed Serial class for
* accessing serial data, this class is inherently portable accross Mbed platforms.
*/
class MTSSerial : public MTSBufferedIO
{
public:
    /** Creates a new MTSSerial object that can be used to talk to an Mbed serial port
    * through internal SW buffers.
    *
    * @param TXD the transmit data pin on the desired Mbed serial interface.
    * @param RXD the receive data pin on the desired Mbed serial interface.
    * @param txBufferSize the size in bytes of the internal SW transmit buffer. The
    * default is 64 bytes.
    * @param rxBufferSize the size in bytes of the internal SW receive buffer. The
    * default is 64 bytes.
    * @param name an optional name for the serial port. The default is blank.
    */
    MTSSerial(PinName TXD, PinName RXD, int txBufferSize = 64, int rxBufferSize = 64, char* name = "");

    /** Destructs an MTSSerial object and frees all related resources, including
    * internal buffers.
    */
    ~MTSSerial();
    
    /** This method is used to the set the baud rate of the serial port.
    * 
    * @param baudrate the baudrate in bps as an int. The internal interface
    * default is 9600 bps.
    */
    void baud(int baudrate);
    
//    void format(int bits=8, Parity parity=SerialBase::None, int stop_bits=1);

    /** Overridden method used internally to handle reading from the serial interface.
    * Do not call directly, use data access methods available in MTSBufferedIO.
    */
    virtual void handleRead();

    /** Overridden method used internally to handle writing to the serial interface.
    * Do not call directly, use data access methods available in MTSBufferedIO.
    */
    virtual void handleWrite();

private:
    Serial* serial; // Internal mbed Serial object
    int writeSize; // Amount of data to write based on buffer size
    char* if_name; // Name of the interface
};

}

#endif /* MTSSERIAL_H */