Juan Salazar / sofi7

test

Dependents:   robotic_fish_6

Serial.h@0:c792b17d9f78, 2021-12-03 (annotated)

Committer:
juansal12
Date:
Fri Dec 03 23:00:34 2021 +0000
Revision:
0:c792b17d9f78
uploaded sofi code ;

Who changed what in which revision?

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