Blame view

mbed/Serial.h 1.76 KB
f7c9a8e1   jdenecha   Feat : Firt dump
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
  /* mbed Microcontroller Library

   * Copyright (c) 2006-2013 ARM Limited

   *

   * Licensed under the Apache License, Version 2.0 (the "License");

   * you may not use this file except in compliance with the License.

   * You may obtain a copy of the License at

   *

   *     http://www.apache.org/licenses/LICENSE-2.0

   *

   * Unless required by applicable law or agreed to in writing, software

   * distributed under the License is distributed on an "AS IS" BASIS,

   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.

   * See the License for the specific language governing permissions and

   * limitations under the License.

   */

  #ifndef MBED_SERIAL_H

  #define MBED_SERIAL_H

  

  #include "platform.h"

  

  #if DEVICE_SERIAL

  

  #include "Stream.h"

  #include "SerialBase.h"

  #include "serial_api.h"

  

  namespace mbed {

  

  /** 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:

   * @code

   * // Print "Hello World" to the PC

   *

   * #include "mbed.h"

   *

   * Serial pc(USBTX, USBRX);

   *

   * int main() {

   *     pc.printf("Hello World\n");

   * }

   * @endcode

   */

  class Serial : public SerialBase, public Stream {

  

  public:

  #if DEVICE_SERIAL_ASYNCH

      using SerialBase::read;

      using SerialBase::write;

  #endif

  

      /** Create a Serial port, connected to the specified transmit and receive pins

       *

       *  @param tx Transmit pin

       *  @param rx Receive pin

       *

       *  @note

       *    Either tx or rx may be specified as NC if unused

       */

      Serial(PinName tx, PinName rx, const char *name=NULL);

  

  protected:

      virtual int _getc();

      virtual int _putc(int c);

  };

  

  } // namespace mbed

  

  #endif

  

  #endif