Diff: Glider.h

Revision:

17:aa62b351af43

Parent:

16:7e1a1cd9f9fb

Child:

20:d8044cd4819f

--- a/Glider.h	Mon May 15 13:51:30 2017 +0000
+++ b/Glider.h	Tue May 16 15:31:39 2017 +0000
@@ -8,17 +8,18 @@
 #include "BMP180.h"
 #include "beep.h"
 
-#define SAVE_DATA_FORMAT "%d %d %d"
-#define PACKET_FORMAT "3387, GLIDER, %d, %u, %.2f, %.2f, %.2f, %.2f, %.2f, %.2f, %d\r\n"
-#define CMD_BUZZER 'b'
-#define CMD_RESET 'z'
-#define CMD_NEXT_STATE 'n'
-#define CMD_PREV_STATE 'p'
+#define SAVE_DATA_FORMAT "%d %d %d"  //string format for the data saved to flash mem
+#define PACKET_FORMAT "3387, GLIDER, %d, %u, %.2f, %.2f, %.2f, %.2f, %.2f, %.2f, %d\r\n"  //string format for telemetry packet
 
-#define FREQ 1.0
+#define CMD_BUZZER 'b'  //sound buzzer for 3 seconds  
+#define CMD_RESET 'z'  //zero out packet count, mission time, and state
+#define CMD_NEXT_STATE 'n'  //increment state
+#define CMD_PREV_STATE 'p'  //decrement state
 
-#define CRUZE 0
-#define LAND 1
+#define FREQ 1.0  //frequency of sending a telem packet (1 a second)
+
+#define CRUZE 0  //released from container
+#define LAND 1  //on the ground
 
 #define PITO_V_DIVIDER 0.6666
 #define SOLAR_V_DIVIDER 0.5
@@ -30,28 +31,30 @@
 
 #define ALT_THRESH 100.0 //meters
 
-#define EMERGENCY_TIMEOUT 60.0
+#define EMERGENCY_TIMEOUT 30.0  //seconds before buzzer will sound forever no matter what
 
 class Glider {
 public:
     Serial* dev;
-    Serial* xbee;
-    double heading;
-    float pressure;
-    float temp;
-    float alt;
-    float speed;
-    float solarVoltage;
-    bool cmdFlag;
-    bool transmitFlag;
-    time_t startTime;  //saved data
-    time_t missionTime;  
+    Serial* xbee;  //xbee radio
+    double heading;  //degrees from north
+    float pressure;  //hpa
+    float temp;  //C
+    float alt;  //m
+    float speed;  //m per s
+    float solarVoltage;  //volts
+    bool cmdFlag;  //goes true when a command is recieved
+    bool transmitFlag;  //goes true once a second
+    time_t startTime;  //saved data  
+    time_t missionTime;  //current time - initial time
     uint8_t packetCount;  //saved data
     uint8_t state;  //saved data
-    HMC5883L* hmc;
-    BMP180* bmp;
+    HMC5883L* hmc;  //magnetometer object
+    BMP180* bmp;  //pressor sensor object
+    
+    //constructor for glider object
     Glider(Serial* device, PinName sda, PinName scl, PinName tx, PinName rx);
-    InterruptIn xbeeRxInt;
+    InterruptIn xbeeRxInt;  //ISR for RX external interrupt
     AnalogIn pitot;
     AnalogIn solVoltIn;
     Beep buzzer;