Diff: xbee.h

Revision:

2:cb627ea9b817

Parent:

1:c3d9bdcb0b03

Child:

3:682615a0717e

diff -r c3d9bdcb0b03 -r cb627ea9b817 xbee.h
--- a/xbee.h	Wed Aug 29 10:39:42 2012 +0000
+++ b/xbee.h	Wed Aug 29 13:27:02 2012 +0000
@@ -1,48 +1,55 @@
 #include "mbed.h"
 
 /** Xbee interface class for configuring, sending and recieving data using an Xbee */
-class xbee {
+class xbee
+{
 private:
     PinName _tx;
     PinName _rx;
 public:
-    /** Configure serial data pin
-      * @param tx The serial tx pin the xbee is conected to
-      * @param rx The serial rx pin the xbee is conected to
+    /** Configure serial data pin.
+      * @param tx The serial tx pin the xbee is conected to.
+      * @param rx The serial rx pin the xbee is conected to.
       */
     xbee(PinName tx, PinName rx);
     ~xbee();
-    /** Puts the Xbee into config mode
-      * @return Returns 1 on success
+    /** Puts the Xbee into config mode.
+      * @return Returns 1 on success.
       */
     int ConfigMode();
-    /** Gets the serial number of the Xbee
-      * @return Returns 1 on success
+    /** Gets the serial number/mac address of the Xbee and places it into serial_no.
+      * @param serial_no array to store the serial of Xbee (must be 8 long).
+      * @return Returns 1 on success.
+      */
+    int GetSerial(int*);
+    /** Sets the encryption key to the one stored in security_key.
+      * @param key Pointer to the network key to set.
+      * @return Returns 1 on success.
       */
-    int GetSerial();
-    /** Sets the encryption key for the Xbee
-      * @return Returns 1 on success
+    int SetKey(char*);
+    /** Sets the id of the PAN network for the Xbee to use
+      * @param pan_id The id of the PAN for the Xbee to use.
+      * @return Returns 1 on success.
       */
-    int SetKey();
-    /** Writes the settings to the Non volatile memory on the Xbee 
-      * @return Returns 1 on success
+    int SetPanId(int);
+    /** Writes the settings to the Non volatile memory on the Xbee
+      * @param key Pointer to the network key to set.
+      * @return Returns 1 on success.
       */
     int WriteSettings();
     /** Exits config mode
-      * @return Returns 1 on success
+      * @return Returns 1 on success.
       */
     int ExitConfigMode();
-    /** Sends data in the sendData buffer
-      * @return Returns 1 on success
-      */
-    int SendData();
-    /** Recieves data and puts it into the recieveData buffer. Will over write anything already in the buffer
-      * @param numchar Number of characters to read
+    /** Sends data in the send_Data buffer.
+      * @param data_buf Pointer to the buffer of data to send.
+      * @returns 1 on success.
       */
-    void RecieveData(int numchar);
-    
-    int serial_no[8];
-    int security_key[16]; 
-    char sendData[202];
-    char readData[202];
+    int SendData(char*);
+    /** Recieves data sent to the xbee.
+      * @param data_buf Pointer to the buffer to put recieved data into.
+      * @param numchar Number of characters to read. If 0, will use the size of data_buf.
+      */
+    void RecieveData(char*, int);
+
 };
\ No newline at end of file