Jhon Plantikow / Dataloger

Dataloger

Serial.h@0:666850d06c9f, 2015-08-20 (annotated)

Committer:
jhon309
Date:
Thu Aug 20 00:37:14 2015 +0000
Revision:
0:666850d06c9f
ok

Who changed what in which revision?

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