Revision 1:d9eb07545205, committed 2018-05-30

Comitter:

phonemacro

Date:

Wed May 30 03:00:33 2018 +0000

Parent:

0:9216b8a5fd16

Commit message:

Updated for documentation.

Changed in this revision

diff -r 9216b8a5fd16 -r d9eb07545205 main.cpp
--- a/main.cpp	Wed May 30 00:12:14 2018 +0000
+++ b/main.cpp	Wed May 30 03:00:33 2018 +0000
@@ -49,16 +49,29 @@
     
 // main() runs in its own thread in the OS
 // (note the calls to Thread::wait below for delays)
+/**
+* @brief Sample main program for MAX30303
+* @version 1.0000.0
+*
+* @details Sample main program for MAX30303
+* The prints are sent to the terminal window (9600, 8n1).
+* The program initializeds the LED to blue-green.
+* If the program is successful at reading the hardware ID
+* then it prints out a successful message, and if not, then
+* it turns on the red LED.
+* To run the program, drag and drop the .bin file into the 
+* DAPLINK folder. After it finishes flashing, cycle the power or 
+* reset the Pegasus after flashing by pressing the button on
+* the Pegasus next to the battery connector or the button
+* on the MAXREFDES100HDK.
+*/
 int main()
 {
-    int32_t value = 0;
-    int ret, i;
     char hwIdOk;
     
     DigitalOut rLED(LED1, LED_OFF);
     DigitalOut gLED(LED2, LED_OFF);
     DigitalOut bLED(LED3, LED_OFF);
-
     
     bLED = LED_ON;
     gLED = LED_ON;
@@ -67,12 +80,11 @@
 
     hwIdOk = max20303_pmic.CheckPMICHWID();
     if (hwIdOk)
-        printf("Reading of the hardware ID is okay.\r\n");
+        printf("Reading of the hardware ID is successful.\r\n");
     else {
         bLED = LED_OFF;
         gLED = LED_OFF;
         rLED = LED_ON;
-    }   
-
+    }
 }