comments for main.c and some RPG functions

Author: AYingst

BUILD_DIR/main.c

@@ -16,7 +16,8 @@
 
 ESOS_USER_TASK(demoLEDsAndSwitches) {
     ESOS_TASK_BEGIN();
-	    esos_uiF14_flashLED3( 500 ); 
+	    esos_uiF14_flashLED3( 500 );           //heartbeat always blinking
+		// RPG controls LED2
 		if (esos_uiF14_isRpgTurning ()){
 			esos_uiF14_turnLED2Off ();
 		}
@@ -29,7 +30,8 @@ ESOS_USER_TASK(demoLEDsAndSwitches) {
 		if (esos_uiF14_isRpgTurningFast()){
 			esos_uiF14_flashLED2( 100 );
 		}
-		if (esos_uiF14_isSW3Released()){
+		//switch on RPG (SW3) controls whether SW1 or SW2 controls LED1
+		if (esos_uiF14_isSW3Released()){      
 			if (esos_uiF14_isSW1Pressed()){
 				esos_uiF14_turnLED1On ();
 			} else if (esos_uiF14_isSW1Released (){
@@ -99,7 +101,6 @@ ESOS_USER_TASK(drawDisplay) {
 			} else {outString("Sw3 is NOT Double Pressed\n\n");}
 
 			if (esos_uiF14_isRPGTurning()) {
-				
 				outString("RPG is Turning ");
 				if (esos_uiF14_isRPGTurningCW()) { 
 					outString("CW ");
@@ -117,13 +118,13 @@ ESOS_USER_TASK(drawDisplay) {
 				outString("RPG is Not Turning");
 			}
 			ESOS_TASK_WAIT_TICKS(50);
-			outString("\n\n\n\n\n\n\n\n");
+			outString("\n\n\n\n\n\n\n\n"); //these newlines clear the screen and allow overwrite
 		}
 	ESOS_TASK_END();
 }
 void user_init(){
 
+	esos_RegisterTask(demoLEDsAndSwitches);
 	esos_RegisterTask(drawDisplay);
-	
 
 }

esos/include/esos_f14ui.h

@@ -20,7 +20,7 @@ typedef struct {
     BOOL b_SW2DoublePressed;    
     BOOL b_SW3Pressed;
     BOOL b_SW3DoublePressed;
-	uint16_t u16_doublePressUpperMs;
+	uint16_t u16_doublePressUpperMs;  //upper time limit to be double pressed
 
     BOOL b_RPGALast;  // compared to current RPGA, used to detect rotation
 	BOOL b_RPGFast;
@@ -30,17 +30,17 @@ typedef struct {
 	uint16_t u16_RPGLastChangeMs;  //time of last RPGA change
 	uint16_t u16_RPGPeriodMs;      // time SINCE last RPGA change
 	uint16_t u16_RPGNotMovingToSlowPeriodMs;  //border between not moving and slow
-	uint16_t u16_RPGSlowToMediumPeriodMs;
-	uint16_t u16_RPGMediumToFastPeriodMs;
-	BOOL b_RPGCW;
-    BOOL b_RPGCCW;
-	int16_t i16_RPGCounter;      // notice signed int for couting CCW from start
-    int16_t i16_lastRPGCounter;
-	BOOL b_RPGCWRev;
+	uint16_t u16_RPGSlowToMediumPeriodMs;     //border between slow and medium
+	uint16_t u16_RPGMediumToFastPeriodMs;	  //border between medium and fast
+	BOOL b_RPGCW;				//clockwise rotation
+    BOOL b_RPGCCW;				//counter clockwise
+	int16_t i16_RPGCounter;      //notice signed int for counting CCW from start
+    int16_t i16_lastRPGCounter;  
+	BOOL b_RPGCWRev;		//T/F has RPG gone 1 full CW revolution?
 	BOOL b_RPGCCWRev;
 
     BOOL b_LED1On;
-    uint16_t u16_LED1FlashPeriod; 
+    uint16_t u16_LED1FlashPeriod; //period of one full one then off toggle
 
     BOOL b_LED2On;
     uint16_t u16_LED2FlashPeriod;   

esos/src/esos_f14ui.c

@@ -80,8 +80,6 @@ inline BOOL esos_uiF14_isSW3DoublePressed (void) {
 
 // PUBLIC LED FUNCTIONS
 
-//Ryan: I think some of these functions are intended to actually
-//trigger LED changes, so I'm updating the LED register
 
 inline BOOL esos_uiF14_isLED1On (void) {
     return (_st_esos_uiF14Data.b_LED1On);