kushagra brahmbhatt / IoT_Security

IoT Home Alarm System

Dependents:   IoTBurglar_and_Fire_AlarmSystem

RawSerial.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_RAW_SERIAL_H
kbrahmbhatt6 0:2f388b030837 17 #define MBED_RAW_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 "SerialBase.h"
kbrahmbhatt6 0:2f388b030837 24 #include "serial_api.h"
kbrahmbhatt6 0:2f388b030837 25
kbrahmbhatt6 0:2f388b030837 26 namespace mbed {
kbrahmbhatt6 0:2f388b030837 27
kbrahmbhatt6 0:2f388b030837 28 /** A serial port (UART) for communication with other serial devices
kbrahmbhatt6 0:2f388b030837 29 * This is a variation of the Serial class that doesn't use streams,
kbrahmbhatt6 0:2f388b030837 30 * thus making it safe to use in interrupt handlers with the RTOS.
kbrahmbhatt6 0:2f388b030837 31 *
kbrahmbhatt6 0:2f388b030837 32 * Can be used for Full Duplex communication, or Simplex by specifying
kbrahmbhatt6 0:2f388b030837 33 * one pin as NC (Not Connected)
kbrahmbhatt6 0:2f388b030837 34 *
kbrahmbhatt6 0:2f388b030837 35 * Example:
kbrahmbhatt6 0:2f388b030837 36 * @code
kbrahmbhatt6 0:2f388b030837 37 * // Send a char to the PC
kbrahmbhatt6 0:2f388b030837 38 *
kbrahmbhatt6 0:2f388b030837 39 * #include "mbed.h"
kbrahmbhatt6 0:2f388b030837 40 *
kbrahmbhatt6 0:2f388b030837 41 * RawSerial pc(USBTX, USBRX);
kbrahmbhatt6 0:2f388b030837 42 *
kbrahmbhatt6 0:2f388b030837 43 * int main() {
kbrahmbhatt6 0:2f388b030837 44 * pc.putc('A');
kbrahmbhatt6 0:2f388b030837 45 * }
kbrahmbhatt6 0:2f388b030837 46 * @endcode
kbrahmbhatt6 0:2f388b030837 47 */
kbrahmbhatt6 0:2f388b030837 48 class RawSerial: public SerialBase {
kbrahmbhatt6 0:2f388b030837 49
kbrahmbhatt6 0:2f388b030837 50 public:
kbrahmbhatt6 0:2f388b030837 51 /** Create a RawSerial port, connected to the specified transmit and receive pins
kbrahmbhatt6 0:2f388b030837 52 *
kbrahmbhatt6 0:2f388b030837 53 * @param tx Transmit pin
kbrahmbhatt6 0:2f388b030837 54 * @param rx Receive pin
kbrahmbhatt6 0:2f388b030837 55 *
kbrahmbhatt6 0:2f388b030837 56 * @note
kbrahmbhatt6 0:2f388b030837 57 * Either tx or rx may be specified as NC if unused
kbrahmbhatt6 0:2f388b030837 58 */
kbrahmbhatt6 0:2f388b030837 59 RawSerial(PinName tx, PinName rx);
kbrahmbhatt6 0:2f388b030837 60
kbrahmbhatt6 0:2f388b030837 61 /** Write a char to the serial port
kbrahmbhatt6 0:2f388b030837 62 *
kbrahmbhatt6 0:2f388b030837 63 * @param c The char to write
kbrahmbhatt6 0:2f388b030837 64 *
kbrahmbhatt6 0:2f388b030837 65 * @returns The written char or -1 if an error occured
kbrahmbhatt6 0:2f388b030837 66 */
kbrahmbhatt6 0:2f388b030837 67 int putc(int c);
kbrahmbhatt6 0:2f388b030837 68
kbrahmbhatt6 0:2f388b030837 69 /** Read a char from the serial port
kbrahmbhatt6 0:2f388b030837 70 *
kbrahmbhatt6 0:2f388b030837 71 * @returns The char read from the serial port
kbrahmbhatt6 0:2f388b030837 72 */
kbrahmbhatt6 0:2f388b030837 73 int getc();
kbrahmbhatt6 0:2f388b030837 74
kbrahmbhatt6 0:2f388b030837 75 /** Write a string to the serial port
kbrahmbhatt6 0:2f388b030837 76 *
kbrahmbhatt6 0:2f388b030837 77 * @param str The string to write
kbrahmbhatt6 0:2f388b030837 78 *
kbrahmbhatt6 0:2f388b030837 79 * @returns 0 if the write succeeds, EOF for error
kbrahmbhatt6 0:2f388b030837 80 */
kbrahmbhatt6 0:2f388b030837 81 int puts(const char *str);
kbrahmbhatt6 0:2f388b030837 82
kbrahmbhatt6 0:2f388b030837 83 int printf(const char *format, ...);
kbrahmbhatt6 0:2f388b030837 84 };
kbrahmbhatt6 0:2f388b030837 85
kbrahmbhatt6 0:2f388b030837 86 } // namespace mbed
kbrahmbhatt6 0:2f388b030837 87
kbrahmbhatt6 0:2f388b030837 88 #endif
kbrahmbhatt6 0:2f388b030837 89
kbrahmbhatt6 0:2f388b030837 90 #endif