Emir Sokic / mbedPAI Featured

mbed.h verzija za koristenje na predmetu PAI

Serial.h@0:05aad811ea07, 2015-03-10 (annotated)

Committer:
esokic
Date:
Tue Mar 10 09:51:52 2015 +0000
Revision:
0:05aad811ea07
mbed.h verzija od marta 2014, za koristenje na predmetu PAI

Who changed what in which revision?

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