Diff: FileManager.h

Revision:

11:e21d4c5bfd1b

Parent:

10:a8003d357cf2

Child:

14:4ba6147f067b

--- a/FileManager.h	Wed May 18 10:46:16 2016 +0000
+++ b/FileManager.h	Wed May 18 12:16:12 2016 +0000
@@ -1,60 +1,62 @@
 /* ###############  Constant Defination  ################## */
 
-#define DEVICE_NAME             "sd"
+#define DEVICE_NAME             "sd"                        /** Device directory */                       
 
 // DEVICE_NAME must be put in between "/" for file name 
-#define SETUP_FILE_NAME         "/sd/RMS_Tester.xml"
-#define GPS_LOG_FILE_NAME       "/sd/YYYY-MM-DD.gps.csv "
-#define RTL_LOG_FILE_NAME       "/sd/YYYY-MM-DD.rtl.csv"
-#define VARIABLE_FILE_NAME      "/sd/20160216185627_upload.xml"
+#define SETUP_FILE_NAME         "/sd/RMS_Tester.xml"        /** Setup File Name */
+#define GPS_LOG_FILE_NAME       "/sd/YYYY-MM-DD.gps.csv "   /** GPS Log File Name */
+#define RTL_LOG_FILE_NAME       "/sd/YYYY-MM-DD.rtl.csv"    /** RMS Log File Name */
+#define VARIABLE_FILE_NAME      "/sd/20160216185627_upload.xml" /** Mini RMS Log File Name */
 #define MINIRMS_LOG_FILE_NAME   "/sd/miniRMS.log"
 
-#define GPS_TAG                 "<Gps>"                 
-#define DATA_TAG                "<Data>"
-#define UPDATE_INTERVAL_TAG     "<Update_Interval>"
-#define VAR_NAME_TAG            "<varName>"
-#define VAR_ADDR_TAG            "<varAddress>"
-#define VAR_TYPE_TAG            "<varType>"
-#define VAR_LSB1_TAG            "<LSB1>"
-#define VAR_LSB2_TAG            "<LSB2>"
-#define VAR_BITMASK_TAG         "<BitMask>"
-#define VAR_UNIT_TAG            "<Unit>"
-#define XMLTEXT_SIZE            20
+/** XML Tag */
+#define GPS_TAG                 "<Gps>"                     /** GPS Tag */
+#define DATA_TAG                "<Data>"                    /** Data Tag */
+#define UPDATE_INTERVAL_TAG     "<Update_Interval>"         /** Update Internal Tag */
+#define VAR_NAME_TAG            "<varName>"                 /** Variable Name Tag */
+#define VAR_ADDR_TAG            "<varAddress>"              /** Variable Address Tag */
+#define VAR_TYPE_TAG            "<varType>"                 /** Variable Type Tag */
+#define VAR_LSB1_TAG            "<LSB1>"                    /** Variable LSB1 Tag */
+#define VAR_LSB2_TAG            "<LSB2>"                    /** Variable LSB2 Tag */
+#define VAR_BITMASK_TAG         "<BitMask>"                 /** Variable Bit Mask Tag */
+#define VAR_UNIT_TAG            "<Unit>"                    /** Variable Unit Tag */
 
-#define VAR_NAME_MAX_SIZE       20
-#define VAR_ADDR_MAX_SIZE       10
-#define VAR_TYPE_MAX_SIZE       3
-#define VAR_LSB1_MAX_SIZE       3
-#define VAR_LSB2_MAX_SIZE       10
-#define VAR_BITMASK_MAX_SIZE    5
-#define VAR_UNIT_MAX_SIZE       20
+/** XML Text Size */
+#define XMLTEXT_SIZE            20                          /** XML Text Maximum size */
+#define VAR_NAME_MAX_SIZE       20                          /** Variable Name Maximum Size  */
+#define VAR_ADDR_MAX_SIZE       10                          /** Variable Address Maximum Size  */
+#define VAR_TYPE_MAX_SIZE       3                           /** Variable Type Maximum Size  */
+#define VAR_LSB1_MAX_SIZE       3                           /** Variable LSB1 Maximum Size  */
+#define VAR_LSB2_MAX_SIZE       10                          /** Variable LSB2 Maximum Size  */
+#define VAR_BITMASK_MAX_SIZE    5                           /** Variable Bit Mask  Maximum Size  */
+#define VAR_UNIT_MAX_SIZE       20                          /** Variable Unit Maximum Size  */
 
-#define MAX_VAR                 50
+#define MAX_VAR                 50                          /** Maximum variable to be supported  */
 
-#define RMS_HEADER_TIME         "Time"
-#define RMS_MSECOND             "MSecond"
+#define RMS_HEADER_TIME         "Time"                      /** RMS Header Time tag  */
+#define RMS_HEADER_MSECOND      "MSecond"                   /** RMS MSecond Time tag  */
 
 
 /* ###############  Enum  ################## */
 typedef enum  {
-    STATE_FINDING,    /** Finding */
-    STATE_FOUND_DATA,  /** Found Data tag */
-    STATE_FOUND_DATA_INTERVAL,  /**< Found update internal of tag*/
-    STATE_FOUND_GPS,  /** Found GPS tag */
-    STATE_FOUND_GPS_INTERVAL,  /** Found update internal of GPS*/
+    STATE_FINDING,                      /** Finding */
+    STATE_FOUND_DATA,                   /** Found Data tag */
+    STATE_FOUND_DATA_INTERVAL,          /**< Found update internal of tag*/
+    STATE_FOUND_GPS,                    /** Found GPS tag */
+    STATE_FOUND_GPS_INTERVAL,           /** Found update internal of GPS*/
 } ReadingFileState;
 
 
 /* ###############  Structure   ################## */
 
 typedef struct {
-    char varName[VAR_NAME_MAX_SIZE];
-    char varAddress[VAR_ADDR_MAX_SIZE+1];
-    char varType[VAR_TYPE_MAX_SIZE];
-    char varLSB1[VAR_LSB1_MAX_SIZE];
-    char varLSB2[VAR_LSB2_MAX_SIZE];
-    char varBitMask[VAR_BITMASK_MAX_SIZE];
-    char varUnit[VAR_UNIT_MAX_SIZE];
+    char varName[VAR_NAME_MAX_SIZE];                /** char array Variable Name */
+    char varAddress[VAR_ADDR_MAX_SIZE+1];           /** char array Variable Address */
+    char varType[VAR_TYPE_MAX_SIZE];                /** char array Variable Type */
+    char varLSB1[VAR_LSB1_MAX_SIZE];                /** char array Variable LSB1 */
+    char varLSB2[VAR_LSB2_MAX_SIZE];                /** char array Variable LSB2 */
+    char varBitMask[VAR_BITMASK_MAX_SIZE];          /** char array Variable Bit Mask */
+    char varUnit[VAR_UNIT_MAX_SIZE];                /** char array Variable Unit */
 } Variable_Data_TypeDef;