Fork of the official mbed C/C++ SDK provides the software platform and libraries to build your applications. The fork has the documentation converted to Doxygen format
Dependents: NervousPuppySprintOne NervousPuppySprint2602 Robot WarehouseBot1 ... more
Fork of mbed by
Diff: Serial.h
- Revision:
- 27:7110ebee3484
- Parent:
- 21:3944f1e2fa4f
- Child:
- 43:aff670d0d510
diff -r 63bcd7ba4912 -r 7110ebee3484 Serial.h --- a/Serial.h Fri Feb 11 10:33:02 2011 +0000 +++ b/Serial.h Tue Nov 29 14:59:27 2011 +0000 @@ -1,11 +1,14 @@ /* mbed Microcontroller Library - Serial - * Copyright (c) 2007-2009 ARM Limited. All rights reserved. - * sford + * Copyright (c) 2007-2011 ARM Limited. All rights reserved. */ #ifndef MBED_SERIAL_H #define MBED_SERIAL_H +#include "device.h" + +#if DEVICE_SERIAL + #include "platform.h" #include "PinNames.h" #include "PeripheralNames.h" @@ -17,6 +20,9 @@ /* Class: Serial * A serial port (UART) for communication with other serial devices * + * Can be used for Full Duplex communication, or Simplex by specifying + * one pin as NC (Not Connected) + * * Example: * > // Print "Hello World" to the PC * > @@ -87,6 +93,10 @@ /* Function: getc * Read a character * + * Reads a character from the serial port. This will block until + * a character is available. To see if a character is available, + * see <readable> + * * Variables: * returns - The character read from the serial port */ @@ -176,3 +186,4 @@ #endif +#endif