Revision 15:3bb82129f3a8, committed 2016-04-27

Comitter:

ottaviano3

Date:

Wed Apr 27 05:46:34 2016 +0000

Parent:

14:55631bb4aa44

Commit message:

Update comment formatting

Changed in this revision

diff -r 55631bb4aa44 -r 3bb82129f3a8 xbee900hp.h
--- a/xbee900hp.h	Wed Apr 27 05:43:10 2016 +0000
+++ b/xbee900hp.h	Wed Apr 27 05:46:34 2016 +0000
@@ -35,9 +35,9 @@
     /**
     * Send packet over spi to xBee for TX
     *
-    * data     -> char array of the message to be sent wirelessly.
-    * length   -> then length of the char array excluding any null termination.
-    * enMesh   -> true enables DigiMesh.
+    * @param data      -> char array of the message to be sent wirelessly.
+    * @param length    -> then length of the char array excluding any null termination.
+    * @param enMesh    -> true enables DigiMesh.
     *
     * Returns 0 upon successful completion, else returns 1.
     */
@@ -52,15 +52,18 @@
 
     /**
     * Set the transmission power level.
+    * @param value integer value of power level. Acceptable values are 0-4.
+    *
+    * @returns 
+    *   0 upon success
+    *   1 upon failure
+    */
+    /* Note
     * 0 = +7 dBm, (5 mW)
     * 1 = +15 dBm, (32 mW)
     * 2 = +18 dBm, (63 mW)
     * 3 = +21 dBm, (125 mW)
     * 4 = +24 dBm, (250 mW)
-    *
-    * @returns 
-    *   0 upon success
-    *   1 upon failure
     */
     int setPower(int value);
 
@@ -74,6 +77,8 @@
     /**
     * Wait for and read incoming data packet
     *
+    * @param data   -> A char array of sufficent size to contain any message you expect to recieve.
+    *
     * Returns the 64-bit (0-0xFFFFFFFF) Serial/MAC address of the sending XBee if successful, or 0 if it failed.
     */
     unsigned long long readPacket(char* data);