Neil Johnson / microbit-ARMBand

Official Sheffield ARMBand micro:bit program

microbit/microbit-dal/mbed-dev-bin/Serial.h@0:b9164b348919, 2016-10-17 (annotated)

Committer:
MrBedfordVan
Date:
Mon Oct 17 12:41:20 2016 +0000
Revision:
0:b9164b348919
Official Sheffield ARMBand Micro:bit program

Who changed what in which revision?

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