Einstein Filho / Mbed 2 deprecated MANGUEBAJA2019_BOX

Mangue Baja Box

Dependencies:   mbed

mbed/RawSerial.h@0:0dee8840a1c0, 2019-07-29 (annotated)

Committer:
einsteingustavo
Date:
Mon Jul 29 20:38:00 2019 +0000
Revision:
0:0dee8840a1c0
Mangue Baja Box

Who changed what in which revision?

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