dev01 Brautlecht / mbed-STM32F030F4

Important changes to repositories hosted on mbed.com

Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.

To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.

It is also possible to export all your personal repositories from the account settings page.

Dependents:   STM32F031_Blink_Aug17

Fork of mbed-STM32F030F4 by Nothing Special

api/Serial.h@0:38ccae254a29, 2014-10-18 (annotated)

Committer:
mega64
Date:
Sat Oct 18 02:40:17 2014 +0000
Revision:
0:38ccae254a29
only for STM32F030F4

Who changed what in which revision?

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