Juan Salazar / mbed

test

Dependents:   robotic_fish_7

RawSerial.h@0:44931ff4a3ed, 2020-01-14 (annotated)

Committer:
juansal12
Date:
Tue Jan 14 19:14:29 2020 +0000
Revision:
0:44931ff4a3ed
Sofi 7 code;

Who changed what in which revision?

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