Diff: main.cpp

Revision:

11:f1a6cced30cf

Parent:

10:f894ac48a342

Child:

12:988bacb1c2a6

diff -r f894ac48a342 -r f1a6cced30cf main.cpp
--- a/main.cpp	Fri Feb 04 14:45:43 2022 +0000
+++ b/main.cpp	Fri Feb 04 15:02:01 2022 +0000
@@ -44,8 +44,8 @@
 DigitalOut g_led(LED_GREEN);
 DigitalOut b_led(LED_BLUE);
 
-// DECLARE VOIDS BEING USED IN CODE
-
+/** Declare voids before using in the code
+*/
 void buttonStart_isr(); // Button Start interrupt service routine
 
 void buttonBack_isr(); // Button Back interrupt service routine
@@ -140,84 +140,85 @@
 grn_led2.write(1);
 grn_led3.write(0); // LED on to show the board is on
 }
-void lcd_sett()
+void lcd_sett()//LCD Set
 {
-//LCD SET
 }
-void startup() // VOID FUNCTION SETUP
+void startup() // Void function setup
 {
 S_flag = 0;
 int select = 1;
-
+/**Menu starting here, using the joystick for navigating the menu.
+*/
 while (1) {
-char d = joystick.get_direction();
+char d = joystick.get_direction(); // Allowing the joystick to navigate the menu
 
-switch(select) {
-case 1:
+switch(select) { // Main switch
+case 1: //Internal case 1 switch
 switch(d) {
 case N:
 select = 4;
 wait(0.3);
 // printf("UP");
-break;
+break; // Break from internal switch
 case S:
 select = 2;
 wait(0.3);
 // printf("Down");
-break;
+break; // Break from internal switch
 }
-break;
+break; // Break from main switch
 
-case 2:
+case 2: //Internal case 2 switch
 switch(d) {
 case N:
 select = 1;
 wait(0.3);
 // printf("UP");
-break;
+break; // Break from internal switch
 case S:
 select = 3;
 wait(0.3);
 // printf("Down");
-break;
+break; // Break from internal switch
 }
-break;
+break; // Break from main switch
 
-case 3:
+case 3: //Internal case 3 switch
 switch(d) {
 case N:
 select = 2;
 wait(0.3);
 // printf("UP");
-break;
+break; // Break from internal switch
 case S:
 select = 4;
 wait(0.3);
 // printf("Down");
-break;
+break; // Break from internal switch
 }
-break;
+break; // Break from main switch
 
-case 4:
+case 4: //Internal case 4 switch
 switch(d) {
 case N:
 select = 3;
 wait(0.3);
 // printf("UP");
-break;
+break; // Break from internal switch
 case S:
 select = 1;
 wait(0.3);
 // printf("Down");
-break;
+break; // Break from internal switch
 }
-break;
+break; // Break from main switch
 }
 wait(0.3);
-// Menu
+/** Menu selection screen printed to LCD
+*/
 if (select == 1){
 lcd.clear();
-lcd.printString(" >Collection ", 0, 0);
+lcd.printString(" >Collection ", 0, 0); // Menu Selection, printing to LCD
 lcd.printString(" View Data ", 0, 1);
 lcd.printString(" Live Data ", 0, 2);
 lcd.printString(" About ", 0, 3);
@@ -226,13 +227,13 @@
 
 
 else if (select == 2) {
-lcd.printString(" Collection ", 0, 0);// Menu Selection
+lcd.printString(" Collection ", 0, 0);// Menu Selection, Printing to LCD
 lcd.printString(" >View Data ", 0, 1);
 lcd.refresh();
 wait(0.3);}
 
 else if (select == 3) {
-lcd.printString(" Collection ", 0, 0);// Menu Selection
+lcd.printString(" Collection ", 0, 0);// Menu Selection, Printing to LCD
 lcd.printString(" View Data ", 0, 1);
 lcd.printString(" >Live Data ", 0, 2);
 lcd.refresh();
@@ -240,7 +241,7 @@
 
 else if (select == 4){
 lcd.clear();
-lcd.printString(" Collection ", 0, 0);// Menu Selection
+lcd.printString(" Collection ", 0, 0);// Menu Selection, Printing to LCD
 lcd.printString(" View Data ", 0, 1);
 lcd.printString(" Live Data ", 0, 2);
 lcd.printString(" >About ", 0, 3);
@@ -251,19 +252,18 @@
 
 
 void welcome()
-{
-// Welcome Screen 1                               
+{                           
 lcd.clear();
-lcd.printString(" Jack McGarley ", 0, 0);
+lcd.printString(" Jack McGarley ", 0, 0); // Welcome Screen 1, Printing to LCD    
 lcd.printString(" 18689007 ", 0, 1);
 lcd.printString(" Schneider ", 0, 2);
 lcd.printString(" Lincoln Uni ", 0, 3);
 lcd.printString(" February 2022 ", 0, 4);
 lcd.refresh();
 wait(3);
-// Welcome Screen 2
+
 lcd.clear();
-lcd.printString(" Temperature ", 0, 0);
+lcd.printString(" Temperature ", 0, 0);// Welcome Screen 2, Printing to LCD
 lcd.printString(" Based ", 0, 1);
 lcd.printString(" Smart Device ", 0, 2);
 lcd.printString(" Health ", 0, 3);