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@120:3051dd49fa3a, 2013-12-31 (annotated)
- Committer:
- jengbrecht
- Date:
- Tue Dec 31 22:58:53 2013 +0000
- Revision:
- 120:3051dd49fa3a
- Parent:
- 86:186bbf974c7c
- Child:
- 141:571e0ef6c8dc
Updated Wifi documentation
Who changed what in which revision?
User | Revision | Line number | New contents of line |
---|---|---|---|
jengbrecht | 0:563b70517320 | 1 | #ifndef MTSSERIAL_H |
jengbrecht | 0:563b70517320 | 2 | #define MTSSERIAL_H |
jengbrecht | 0:563b70517320 | 3 | |
jengbrecht | 0:563b70517320 | 4 | #include "mbed.h" |
jengbrecht | 0:563b70517320 | 5 | #include "MTSBufferedIO.h" |
jengbrecht | 0:563b70517320 | 6 | |
jengbrecht | 83:9813f9b8ee68 | 7 | namespace mts |
jengbrecht | 83:9813f9b8ee68 | 8 | { |
jengbrecht | 83:9813f9b8ee68 | 9 | |
jengbrecht | 36:bb6b293c7495 | 10 | /** This class derives from MTSBufferedIO and provides a buffered wrapper to the |
jengbrecht | 45:40745c2036cf | 11 | * standard mbed Serial class. Since it depends only on the mbed Serial class for |
jengbrecht | 45:40745c2036cf | 12 | * accessing serial data, this class is inherently portable accross different mbed |
jengbrecht | 45:40745c2036cf | 13 | * platforms. |
jengbrecht | 36:bb6b293c7495 | 14 | */ |
jengbrecht | 0:563b70517320 | 15 | class MTSSerial : public MTSBufferedIO |
jengbrecht | 0:563b70517320 | 16 | { |
jengbrecht | 0:563b70517320 | 17 | public: |
jengbrecht | 45:40745c2036cf | 18 | /** Creates a new MTSSerial object that can be used to talk to an mbed serial port |
jengbrecht | 36:bb6b293c7495 | 19 | * through internal SW buffers. |
jengbrecht | 36:bb6b293c7495 | 20 | * |
jengbrecht | 45:40745c2036cf | 21 | * @param TXD the transmit data pin on the desired mbed Serial interface. |
jengbrecht | 45:40745c2036cf | 22 | * @param RXD the receive data pin on the desired mbed Serial interface. |
jengbrecht | 36:bb6b293c7495 | 23 | * @param txBufferSize the size in bytes of the internal SW transmit buffer. The |
jengbrecht | 36:bb6b293c7495 | 24 | * default is 64 bytes. |
jengbrecht | 36:bb6b293c7495 | 25 | * @param rxBufferSize the size in bytes of the internal SW receive buffer. The |
jengbrecht | 36:bb6b293c7495 | 26 | * default is 64 bytes. |
jengbrecht | 36:bb6b293c7495 | 27 | */ |
jengbrecht | 120:3051dd49fa3a | 28 | MTSSerial(PinName TXD, PinName RXD, int txBufferSize = 256, int rxBufferSize = 256); |
jengbrecht | 36:bb6b293c7495 | 29 | |
jengbrecht | 36:bb6b293c7495 | 30 | /** Destructs an MTSSerial object and frees all related resources, including |
jengbrecht | 36:bb6b293c7495 | 31 | * internal buffers. |
jengbrecht | 36:bb6b293c7495 | 32 | */ |
jengbrecht | 0:563b70517320 | 33 | ~MTSSerial(); |
jengbrecht | 45:40745c2036cf | 34 | |
jengbrecht | 36:bb6b293c7495 | 35 | /** This method is used to the set the baud rate of the serial port. |
jengbrecht | 45:40745c2036cf | 36 | * |
jengbrecht | 45:40745c2036cf | 37 | * @param baudrate the baudrate in bps as an int. The default is 9600 bps. |
jengbrecht | 36:bb6b293c7495 | 38 | */ |
jengbrecht | 0:563b70517320 | 39 | void baud(int baudrate); |
jengbrecht | 0:563b70517320 | 40 | |
jengbrecht | 45:40745c2036cf | 41 | /** This method sets the transmission format used by the serial port. |
jengbrecht | 45:40745c2036cf | 42 | * |
jengbrecht | 45:40745c2036cf | 43 | * @param bits the number of bits in a word (5-8; default = 8) |
jengbrecht | 45:40745c2036cf | 44 | * @param parity the parity used (SerialBase::None, SerialBase::Odd, SerialBase::Even, |
jengbrecht | 45:40745c2036cf | 45 | * SerialBase::Forced1, SerialBase::Forced0; default = SerialBase::None) |
jengbrecht | 45:40745c2036cf | 46 | * @param stop the number of stop bits (1 or 2; default = 1) |
jengbrecht | 36:bb6b293c7495 | 47 | */ |
mfiore | 51:d22d3d87391f | 48 | void format(int bits=8, SerialBase::Parity parity=mbed::SerialBase::None, int stop_bits=1); |
jengbrecht | 0:563b70517320 | 49 | |
jengbrecht | 83:9813f9b8ee68 | 50 | protected: |
sgodinez | 86:186bbf974c7c | 51 | Serial serial; // Internal mbed Serial object |
jengbrecht | 83:9813f9b8ee68 | 52 | |
jengbrecht | 0:563b70517320 | 53 | private: |
jengbrecht | 45:40745c2036cf | 54 | virtual void handleWrite(); // Method for handling data to be written |
jengbrecht | 45:40745c2036cf | 55 | virtual void handleRead(); // Method for handling data to be read |
jengbrecht | 0:563b70517320 | 56 | }; |
jengbrecht | 0:563b70517320 | 57 | |
mfiore | 39:6e94520a3217 | 58 | } |
mfiore | 39:6e94520a3217 | 59 | |
jengbrecht | 0:563b70517320 | 60 | #endif /* MTSSERIAL_H */ |