tmk_core/tool/mbed/mbed-sdk/libraries/mbed/api/Serial.h

   1 /* mbed Microcontroller Library
   2  * Copyright (c) 2006-2013 ARM Limited
   3  *
   4  * Licensed under the Apache License, Version 2.0 (the "License");
   5  * you may not use this file except in compliance with the License.
   6  * You may obtain a copy of the License at
   7  *
   8  *     http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an "AS IS" BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  */
  16 #ifndef MBED_SERIAL_H
  17 #define MBED_SERIAL_H
  18
  19 #include "platform.h"
  20
  21 #if DEVICE_SERIAL
  22
  23 #include "Stream.h"
  24 #include "SerialBase.h"
  25 #include "serial_api.h"
  26
  27 namespace mbed {
  28
  29 /** A serial port (UART) for communication with other serial devices
  30  *
  31  * Can be used for Full Duplex communication, or Simplex by specifying
  32  * one pin as NC (Not Connected)
  33  *
  34  * Example:
  35  * @code
  36  * // Print "Hello World" to the PC
  37  *
  38  * #include "mbed.h"
  39  *
  40  * Serial pc(USBTX, USBRX);
  41  *
  42  * int main() {
  43  *     pc.printf("Hello World\n");
  44  * }
  45  * @endcode
  46  */
  47 class Serial : public SerialBase, public Stream {
  48
  49 public:
  50     /** Create a Serial port, connected to the specified transmit and receive pins
  51      *
  52      *  @param tx Transmit pin
  53      *  @param rx Receive pin
  54      *
  55      *  @note
  56      *    Either tx or rx may be specified as NC if unused
  57      */
  58     Serial(PinName tx, PinName rx, const char *name=NULL);
  59
  60 protected:
  61     virtual int _getc();
  62     virtual int _putc(int c);
  63 };
  64
  65 } // namespace mbed
  66
  67 #endif
  68
  69 #endif