Ricardo Benitez / mbed

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.

Fork of mbed by mbed official

Diff: Serial.h

Revision:
27:7110ebee3484
Parent:
21:3944f1e2fa4f
Child:
43:e2ed12d17f06
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