Hiroshi Yamaguchi / XBee 1.0

XBee API mode library 1.0

Files at this revision

API Documentation at this revision

Revision 4:4a11f50ffb64, committed 2012-04-12

Comitter:
yamaguch
Date:
Thu Apr 12 10:27:28 2012 +0000
Parent:
3:48f7780963e2
Commit message:
updated API documents

Changed in this revision

XBee.h Show annotated file Show diff for this revision Revisions of this file 
diff -r 48f7780963e2 -r 4a11f50ffb64 XBee.h
--- a/XBee.h	Thu Apr 12 10:20:17 2012 +0000
+++ b/XBee.h	Thu Apr 12 10:27:28 2012 +0000
@@ -176,7 +176,14 @@
     XBee(Serial& ser, int apiMode = 2, bool debug = false);
 
 
-
+    /**
+     * creates an XBee interface object.
+     *
+     * @param tx TX pin connected to XBee
+     * @param rx RX pin connected to XBee
+     * @param apiMode API mode either 1 or 2 (use escape; default)
+     * @param debug display debugging (I/O state) information through LEDs
+     */
     XBee(PinName tx, PinName rx, int apiMode = 2, bool debug = false);
 
     /**
@@ -189,6 +196,15 @@
      */
     XBee(Serial& ser, Serial& mon, int apiMode = 2, bool debug = false);
 
+    /**
+     * creates an XBee interface object.
+     *
+     * @param tx TX pin connected to XBee
+     * @param rx RX pin connected to XBee
+     * @param mon alternate Serial object for monitoring (use serial ports other than USBTX/USBRX)
+     * @param apiMode API mode either 1 or 2 (use escape; default)
+     * @param debug display debugging (I/O state) information through LEDs
+     */
     XBee(PinName tx, PinName rx, Serial& mon, int apiMode = 2, bool debug = false);
     
     /**