kushagra brahmbhatt / IoT_Security

IoT Home Alarm System

Dependents:   IoTBurglar_and_Fire_AlarmSystem

Serial.h@0:2f388b030837, 2016-04-29 (annotated)

Committer:
kbrahmbhatt6
Date:
Fri Apr 29 06:59:59 2016 +0000
Revision:
0:2f388b030837
1

Who changed what in which revision?

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