Mark Turner / MarksMbed

This is a repository for all my programs or modified programs.

RawSerial.h@0:72480818e4a9, 2016-09-11 (annotated)

Committer:
mturner5
Date:
Sun Sep 11 23:48:09 2016 +0000
Revision:
0:72480818e4a9
Made delays for the LEDS and button presses

Who changed what in which revision?

UserRevisionLine numberNew contents of line
mturner5 0:72480818e4a9 1 /* mbed Microcontroller Library
mturner5 0:72480818e4a9 2 * Copyright (c) 2006-2013 ARM Limited
mturner5 0:72480818e4a9 3 *
mturner5 0:72480818e4a9 4 * Licensed under the Apache License, Version 2.0 (the "License");
mturner5 0:72480818e4a9 5 * you may not use this file except in compliance with the License.
mturner5 0:72480818e4a9 6 * You may obtain a copy of the License at
mturner5 0:72480818e4a9 7 *
mturner5 0:72480818e4a9 8 * http://www.apache.org/licenses/LICENSE-2.0
mturner5 0:72480818e4a9 9 *
mturner5 0:72480818e4a9 10 * Unless required by applicable law or agreed to in writing, software
mturner5 0:72480818e4a9 11 * distributed under the License is distributed on an "AS IS" BASIS,
mturner5 0:72480818e4a9 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
mturner5 0:72480818e4a9 13 * See the License for the specific language governing permissions and
mturner5 0:72480818e4a9 14 * limitations under the License.
mturner5 0:72480818e4a9 15 */
mturner5 0:72480818e4a9 16 #ifndef MBED_RAW_SERIAL_H
mturner5 0:72480818e4a9 17 #define MBED_RAW_SERIAL_H
mturner5 0:72480818e4a9 18
mturner5 0:72480818e4a9 19 #include "platform.h"
mturner5 0:72480818e4a9 20
mturner5 0:72480818e4a9 21 #if DEVICE_SERIAL
mturner5 0:72480818e4a9 22
mturner5 0:72480818e4a9 23 #include "SerialBase.h"
mturner5 0:72480818e4a9 24 #include "serial_api.h"
mturner5 0:72480818e4a9 25
mturner5 0:72480818e4a9 26 namespace mbed {
mturner5 0:72480818e4a9 27
mturner5 0:72480818e4a9 28 /** A serial port (UART) for communication with other serial devices
mturner5 0:72480818e4a9 29 * This is a variation of the Serial class that doesn't use streams,
mturner5 0:72480818e4a9 30 * thus making it safe to use in interrupt handlers with the RTOS.
mturner5 0:72480818e4a9 31 *
mturner5 0:72480818e4a9 32 * Can be used for Full Duplex communication, or Simplex by specifying
mturner5 0:72480818e4a9 33 * one pin as NC (Not Connected)
mturner5 0:72480818e4a9 34 *
mturner5 0:72480818e4a9 35 * Example:
mturner5 0:72480818e4a9 36 * @code
mturner5 0:72480818e4a9 37 * // Send a char to the PC
mturner5 0:72480818e4a9 38 *
mturner5 0:72480818e4a9 39 * #include "mbed.h"
mturner5 0:72480818e4a9 40 *
mturner5 0:72480818e4a9 41 * RawSerial pc(USBTX, USBRX);
mturner5 0:72480818e4a9 42 *
mturner5 0:72480818e4a9 43 * int main() {
mturner5 0:72480818e4a9 44 * pc.putc('A');
mturner5 0:72480818e4a9 45 * }
mturner5 0:72480818e4a9 46 * @endcode
mturner5 0:72480818e4a9 47 */
mturner5 0:72480818e4a9 48 class RawSerial: public SerialBase {
mturner5 0:72480818e4a9 49
mturner5 0:72480818e4a9 50 public:
mturner5 0:72480818e4a9 51 /** Create a RawSerial port, connected to the specified transmit and receive pins
mturner5 0:72480818e4a9 52 *
mturner5 0:72480818e4a9 53 * @param tx Transmit pin
mturner5 0:72480818e4a9 54 * @param rx Receive pin
mturner5 0:72480818e4a9 55 *
mturner5 0:72480818e4a9 56 * @note
mturner5 0:72480818e4a9 57 * Either tx or rx may be specified as NC if unused
mturner5 0:72480818e4a9 58 */
mturner5 0:72480818e4a9 59 RawSerial(PinName tx, PinName rx);
mturner5 0:72480818e4a9 60
mturner5 0:72480818e4a9 61 /** Write a char to the serial port
mturner5 0:72480818e4a9 62 *
mturner5 0:72480818e4a9 63 * @param c The char to write
mturner5 0:72480818e4a9 64 *
mturner5 0:72480818e4a9 65 * @returns The written char or -1 if an error occured
mturner5 0:72480818e4a9 66 */
mturner5 0:72480818e4a9 67 int putc(int c);
mturner5 0:72480818e4a9 68
mturner5 0:72480818e4a9 69 /** Read a char from the serial port
mturner5 0:72480818e4a9 70 *
mturner5 0:72480818e4a9 71 * @returns The char read from the serial port
mturner5 0:72480818e4a9 72 */
mturner5 0:72480818e4a9 73 int getc();
mturner5 0:72480818e4a9 74
mturner5 0:72480818e4a9 75 /** Write a string to the serial port
mturner5 0:72480818e4a9 76 *
mturner5 0:72480818e4a9 77 * @param str The string to write
mturner5 0:72480818e4a9 78 *
mturner5 0:72480818e4a9 79 * @returns 0 if the write succeeds, EOF for error
mturner5 0:72480818e4a9 80 */
mturner5 0:72480818e4a9 81 int puts(const char *str);
mturner5 0:72480818e4a9 82
mturner5 0:72480818e4a9 83 int printf(const char *format, ...);
mturner5 0:72480818e4a9 84 };
mturner5 0:72480818e4a9 85
mturner5 0:72480818e4a9 86 } // namespace mbed
mturner5 0:72480818e4a9 87
mturner5 0:72480818e4a9 88 #endif
mturner5 0:72480818e4a9 89
mturner5 0:72480818e4a9 90 #endif