Diff: LLAPSerial.h

Revision:

4:34499a4a4ec7

Parent:

3:08f5e8989688

Child:

5:ec6fbf70d110

--- a/LLAPSerial.h	Wed Apr 16 08:06:18 2014 +0000
+++ b/LLAPSerial.h	Wed Apr 16 10:55:24 2014 +0000
@@ -37,11 +37,31 @@
 class LLAPSerial
 {
  private:
+    /** Private internal received message buffer used when receivign characters
+    */
     char cMessage[13];      // Raw receive buffer
+    
+    /** Internal pointer to next character to write in buffer
+    */
     char* inPtr;
+    
+    /** Boolean flag to determine if code needs to check the incoming ID and match to device ID, if true and no match,
+        message is ignored
+    */
     bool checkDevID = false;
+    
+    /** Process a received message, determine if its for us, starts with 'a' and optionally matches device ID.
+        Automatically responds to HELLO and CHDEVID requests (TODO - Add more auto responses)
+    */
     void processMessage();
+    
+    /** Serial interrupt handler, deals with a single character, builds up internal receive message buffer and calls processmessage when
+        enough characters have been received.
+    */
     void SerialEvent();
+    
+    /** Serial object to communicate with the SRF/XRF
+    */
     Serial srf;
     
  public:
@@ -88,7 +108,7 @@
     */
     char deviceId[2];
 
-    /** Received message buffer
+    /** Public Received message buffer
     */
     char sMessage[15];      // Received message buffer