Juan Salazar / mbed

test

Dependents:   robotic_fish_7

Serial.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_SERIAL_H
juansal12 0:44931ff4a3ed 17 #define MBED_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 "Stream.h"
juansal12 0:44931ff4a3ed 24 #include "SerialBase.h"
juansal12 0:44931ff4a3ed 25 #include "serial_api.h"
juansal12 0:44931ff4a3ed 26
juansal12 0:44931ff4a3ed 27 namespace mbed {
juansal12 0:44931ff4a3ed 28
juansal12 0:44931ff4a3ed 29 /** A serial port (UART) for communication with other serial devices
juansal12 0:44931ff4a3ed 30 *
juansal12 0:44931ff4a3ed 31 * Can be used for Full Duplex communication, or Simplex by specifying
juansal12 0:44931ff4a3ed 32 * one pin as NC (Not Connected)
juansal12 0:44931ff4a3ed 33 *
juansal12 0:44931ff4a3ed 34 * Example:
juansal12 0:44931ff4a3ed 35 * @code
juansal12 0:44931ff4a3ed 36 * // Print "Hello World" to the PC
juansal12 0:44931ff4a3ed 37 *
juansal12 0:44931ff4a3ed 38 * #include "mbed.h"
juansal12 0:44931ff4a3ed 39 *
juansal12 0:44931ff4a3ed 40 * Serial pc(USBTX, USBRX);
juansal12 0:44931ff4a3ed 41 *
juansal12 0:44931ff4a3ed 42 * int main() {
juansal12 0:44931ff4a3ed 43 * pc.printf("Hello World\n");
juansal12 0:44931ff4a3ed 44 * }
juansal12 0:44931ff4a3ed 45 * @endcode
juansal12 0:44931ff4a3ed 46 */
juansal12 0:44931ff4a3ed 47 class Serial : public SerialBase, public Stream {
juansal12 0:44931ff4a3ed 48
juansal12 0:44931ff4a3ed 49 public:
juansal12 0:44931ff4a3ed 50 #if DEVICE_SERIAL_ASYNCH
juansal12 0:44931ff4a3ed 51 using SerialBase::read;
juansal12 0:44931ff4a3ed 52 using SerialBase::write;
juansal12 0:44931ff4a3ed 53 #endif
juansal12 0:44931ff4a3ed 54
juansal12 0:44931ff4a3ed 55 /** Create a Serial port, connected to the specified transmit and receive pins
juansal12 0:44931ff4a3ed 56 *
juansal12 0:44931ff4a3ed 57 * @param tx Transmit pin
juansal12 0:44931ff4a3ed 58 * @param rx Receive pin
juansal12 0:44931ff4a3ed 59 *
juansal12 0:44931ff4a3ed 60 * @note
juansal12 0:44931ff4a3ed 61 * Either tx or rx may be specified as NC if unused
juansal12 0:44931ff4a3ed 62 */
juansal12 0:44931ff4a3ed 63 Serial(PinName tx, PinName rx, const char *name=NULL);
juansal12 0:44931ff4a3ed 64
juansal12 0:44931ff4a3ed 65 protected:
juansal12 0:44931ff4a3ed 66 virtual int _getc();
juansal12 0:44931ff4a3ed 67 virtual int _putc(int c);
juansal12 0:44931ff4a3ed 68 };
juansal12 0:44931ff4a3ed 69
juansal12 0:44931ff4a3ed 70 } // namespace mbed
juansal12 0:44931ff4a3ed 71
juansal12 0:44931ff4a3ed 72 #endif
juansal12 0:44931ff4a3ed 73
juansal12 0:44931ff4a3ed 74 #endif