Update RTC alarm comparisons

Author: adamgarbo

libraries/RTC/examples/Example2_Set_Alarms/Example2_Set_Alarms.ino

@@ -3,10 +3,15 @@
   Created: June 3rd, 2020
   License: MIT. See SparkFun Arduino Apollo3 Project for more information
 
-  This example demonstrates how to read and set the RTC alarms. The code is
-  configured so that the RTC alarm will trigger every minute. The RTC interrupt
-  service routine will set an alarm flag each time the alarm triggers and the 
-  RTC date and time will printed to the Serial Monitor.
+  This example demonstrates how to read and set the RTC alarms.
+
+  It is necessary to first set the RTC alarm date and time and then specify
+  the alarm mode, which determines which date and time values will be used
+  for comparison when generating an alarm interrupt.
+
+  The code is configured so that the RTC alarm will trigger every minute.
+  The RTC interrupt service routine will set an alarm flag each time the
+  alarm triggers and the RTC date and time will printed to the Serial Monitor.
 */
 
 #include "RTC.h" // Include RTC library included with the Aruino_Apollo3 core
@@ -31,13 +36,13 @@ void setup()
   // Set the RTC alarm mode
   /*
     0: Alarm interrupt disabled
-    1: Alarm match every year
-    2: Alarm match every month
-    3: Alarm match every week
-    4: Alarm match every day
-    5: Alarm match every hour
-    6: Alarm match every minute
-    7: Alarm match every second
+    1: Alarm match every year   (hundredths, seconds, minutes, hour, day, month)
+    2: Alarm match every month  (hundredths, seconds, minutes, hours, day)
+    3: Alarm match every week   (hundredths, seconds, minutes, hours, weekday)
+    4: Alarm match every day    (hundredths, seconds, minute, hours)
+    5: Alarm match every hour   (hundredths, seconds, minutes)
+    6: Alarm match every minute (hundredths, seconds)
+    7: Alarm match every second (hundredths)
   */
   myRTC.setAlarmMode(6); // Set the RTC alarm to match on minutes rollover
   myRTC.attachInterrupt(); // Attach RTC alarm interrupt

libraries/RTC/examples/Example5_Rolling_Alarms/Example5_Rolling_Alarms.ino

@@ -36,13 +36,13 @@ void setup()
   // Set the RTC alarm mode
   /*
     0: Alarm interrupt disabled
-    1: Alarm match every year
-    2: Alarm match every month
-    3: Alarm match every week
-    4: Alarm match every day
-    5: Alarm match every hour
-    6: Alarm match every minute
-    7: Alarm match every second
+    1: Alarm match every year   (hundredths, seconds, minutes, hour, day, month)
+    2: Alarm match every month  (hundredths, seconds, minutes, hours, day)
+    3: Alarm match every week   (hundredths, seconds, minutes, hours, weekday)
+    4: Alarm match every day    (hundredths, seconds, minute, hours)
+    5: Alarm match every hour   (hundredths, seconds, minutes)
+    6: Alarm match every minute (hundredths, seconds)
+    7: Alarm match every second (hundredths)
   */
   myRTC.setAlarmMode(6); // Set the RTC alarm to match on minutes rollover
   myRTC.attachInterrupt(); // Attach RTC alarm interrupt

libraries/RTC/examples/Example6_LowPower_Alarm/Example6_LowPower_Alarm.ino

@@ -32,13 +32,13 @@ void setup()
   // Set the RTC alarm mode
   /*
     0: Alarm interrupt disabled
-    1: Alarm match every year
-    2: Alarm match every month
-    3: Alarm match every week
-    4: Alarm match every day
-    5: Alarm match every hour
-    6: Alarm match every minute
-    7: Alarm match every second
+    1: Alarm match every year   (hundredths, seconds, minutes, hour, day, month)
+    2: Alarm match every month  (hundredths, seconds, minutes, hours, day)
+    3: Alarm match every week   (hundredths, seconds, minutes, hours, weekday)
+    4: Alarm match every day    (hundredths, seconds, minute, hours)
+    5: Alarm match every hour   (hundredths, seconds, minutes)
+    6: Alarm match every minute (hundredths, seconds)
+    7: Alarm match every second (hundredths)
   */
   myRTC.setAlarmMode(6); // Set the RTC alarm to match on minutes rollover
   myRTC.attachInterrupt(); // Attach RTC alarm interrupt