Merge pull request #170 from adamgarbo/rtcAlarms

Author: Owen

libraries/RTC/examples/Example1_getTime/Example1_getTime.ino renamed to libraries/RTC/examples/Example1_Get_Time/Example1_Get_Time.ino

@@ -1,8 +1,10 @@
-/* Author: Nathan Seidle
+/*
+  Author: Nathan Seidle
   Created: Septempter 27th, 2019
   License: MIT. See SparkFun Arduino Apollo3 Project for more information
 
-  This example demonstrates how to initialize and read from the on board RTC.
+  This example demonstrates how to initialize and read from the on-board RTC.
+  
   Most SparkFun Artemis boards have the necessary external 32kHz crystal to
   enable the RTC. If you are using the Artemis module bare you will either
   need an external 32kHz xtal or use the internal LFRC. Read the datasheet
@@ -11,16 +13,19 @@
   This example is based on the Ambiq SDK EVB2 RTC example.
 */
 
-#include "RTC.h" //Include RTC library included with the Aruino_Apollo3 core
-APM3_RTC myRTC; //Create instance of RTC class
+#include "RTC.h" // Include RTC library included with the Aruino_Apollo3 core
+APM3_RTC myRTC; // Create instance of RTC class
 
 void setup()
 {
   Serial.begin(115200);
   Serial.println("SparkFun RTC Example");
 
-  myRTC.setToCompilerTime(); //Easily set RTC using the system __DATE__ and __TIME__ macros from compiler
-  //myRTC.setTime(7, 28, 51, 0, 21, 10, 15); //Manually set RTC back to the future: Oct 21st, 2015 at 7:28.51 AM
+  // Easily set RTC using the system __DATE__ and __TIME__ macros from compiler
+  myRTC.setToCompilerTime();
+
+  // Manually set RTC date and time
+  //myRTC.setTime(12, 59, 50, 0, 3, 6, 20); // 12:59:50.000, June 3rd, 2020 (hund, ss, mm, hh, dd, mm, yy)
 }
 
 void loop()

libraries/RTC/examples/Example2_RTCwithSleep/Example2_RTCwithSleep.ino

@@ -0,0 +1,104 @@
+/*
+  Author: Adam Garbo and Nathan Seidle
+  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.
+
+  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
+APM3_RTC myRTC; // Create instance of RTC class
+
+volatile bool alarmFlag = false;
+
+void setup()
+{
+  Serial.begin(115200);
+  Serial.println("SparkFun RTC Set Alarm Example");
+
+  // Easily set RTC using the system __DATE__ and __TIME__ macros from compiler
+  //myRTC.setToCompilerTime();
+
+  // Manually set RTC date and time
+  myRTC.setTime(12, 59, 50, 0, 3, 6, 20); // 12:59:50.000, June 3rd, 2020 (hund, ss, mm, hh, dd, mm, yy)
+
+  // Set the RTC's alarm
+  myRTC.setAlarm(13, 0, 0, 0, 3, 6); // 13:00:00.000, June 3rd (hund, ss, mm, hh, dd, mm). Note: No year alarm register
+  // Set the RTC alarm mode
+  /*
+    0: Alarm interrupt disabled
+    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
+
+  // Print the RTC's alarm date and time
+  Serial.print("Next alarm: "); printAlarm();
+}
+
+void loop()
+{
+  // Check if alarm flag was set
+  if (alarmFlag == true)
+  {
+    // Print date and time of RTC alarm trigger
+    Serial.print("Alarm triggered: "); printDateTime();
+
+    // Clear alarm flag
+    alarmFlag = false;
+  }
+
+  // Print RTC's date and time while waiting for alarm
+  static uint32_t nextPrint = 0;
+  if(millis() > nextPrint){
+    printDateTime();
+    nextPrint = millis() + 1000;
+  }
+}
+
+// Print the RTC's current date and time
+void printDateTime()
+{
+  myRTC.getTime();
+  char dateTimeBuffer[25];
+  sprintf(dateTimeBuffer, "20%02d-%02d-%02d %02d:%02d:%02d.%03d",
+          myRTC.year, myRTC.month, myRTC.dayOfMonth,
+          myRTC.hour, myRTC.minute, myRTC.seconds, myRTC.hundredths);
+  Serial.println(dateTimeBuffer);
+}
+
+// Print the RTC's alarm
+void printAlarm()
+{
+  myRTC.getAlarm();
+  char alarmBuffer[25];
+  sprintf(alarmBuffer, "2020-%02d-%02d %02d:%02d:%02d.%03d",
+          myRTC.alarmMonth, myRTC.alarmDayOfMonth,
+          myRTC.alarmHour, myRTC.alarmMinute,
+          myRTC.alarmSeconds, myRTC.alarmHundredths);
+  Serial.println(alarmBuffer);
+}
+
+// Interrupt handler for the RTC
+extern "C" void am_rtc_isr(void)
+{
+  // Clear the RTC alarm interrupt.
+  am_hal_rtc_int_clear(AM_HAL_RTC_INT_ALM);
+
+  // Set alarm flag
+  alarmFlag = true;
+}

libraries/RTC/examples/Example2_Set_Alarms/Example2_Set_Alarms.ino

@@ -1,32 +1,33 @@
-/* Author: Nathan Seidle and stephenf7072
+/*
+  Author: Nathan Seidle and stephenf7072
   Created: January 28th, 2020
   License: MIT. See SparkFun Arduino Apollo3 Project for more information
 
   This example test the internal HAL to make sure the days advance correctly.
 */
 
 #include "RTC.h"
-APM3_RTC myRTC; //Create instance of RTC class
+APM3_RTC myRTC; // Create instance of RTC class
 
-int previousDay = 1;
+int previousDay;
 
 void setup()
 {
   Serial.begin(115200);
   delay(10);
-  Serial.println("Artemis RTC testing");
+  Serial.println("Artemis RTC Testing");
 
-  //myRTC.setTime(hh, mm, ss, hund, dd, mm, yy);
-  myRTC.setTime(23, 59, 59, 99, 1, 1, 19); //Manually set RTC to 1s before midnight
+  // Manually set RTC date and time to the start of 2020 so that myRTC contains valid times
+  myRTC.setTime(23, 59, 59, 0, 1, 1, 20); // Set to 1 second before midnight Jan 1
 }
 
 void loop()
 {
-  printArtemisTime();
+  myRTC.setTime(23, 59, 59, 99, myRTC.dayOfMonth, myRTC.month, myRTC.year); // Manually set RTC 1/100th of a second from the next day
+  previousDay = myRTC.weekday;
+  delay(11); //Allow us to roll from midnight the night before to the new day
 
-  myRTC.getTime();
-  myRTC.setTime(23, 59, 59, 99, myRTC.dayOfMonth, myRTC.month, myRTC.year); //Manually set RTC
-  delay(11);                                                                //Allow us to roll from midnight the night before to the new day
+  printArtemisTime();
 }
 
 void printArtemisTime()
@@ -76,7 +77,5 @@ void printArtemisTime()
       ;
   }
 
-  previousDay = myRTC.weekday;
-
   Serial.println();
 }

libraries/RTC/examples/Example3_TestRTC/Example3_TestRTC.ino renamed to libraries/RTC/examples/Example3_Test_RTC/Example3_Test_RTC.ino

@@ -0,0 +1,41 @@
+/* 
+  Author: Adam Garbo and Nathan Seidle
+  Created: June 3rd, 2020
+  License: MIT. See SparkFun Arduino Apollo3 Project for more information
+
+  This example demonstrates how to set the RTC using UNIX Epoch time.
+*/
+
+#include "RTC.h" // Include RTC library included with the Aruino_Apollo3 core
+APM3_RTC myRTC; // Create instance of RTC class
+
+void setup()
+{
+  Serial.begin(115200);
+  Serial.println("SparkFun RTC Set UNIX Epoch Time Example");
+
+  // Set the RTC time using UNIX Epoch time
+  myRTC.setEpoch(1591185600); // E.g. 12:00:00, June 3rd, 2020 
+}
+
+void loop()
+{
+  // Print UNIX Epoch timestamp
+  Serial.print("Epoch time: "); Serial.println(myRTC.getEpoch());
+  
+  // Print RTC's date and time
+  Serial.print("Timestamp: "); printDateTime();
+
+  delay(1000);
+}
+
+// Print the RTC's current date and time
+void printDateTime()
+{
+  myRTC.getTime();
+  char dateTime[20];
+  sprintf(dateTime, "20%02d-%02d-%02d %02d:%02d:%02d",
+          myRTC.year, myRTC.month, myRTC.dayOfMonth,
+          myRTC.hour, myRTC.minute, myRTC.seconds);
+  Serial.println(dateTime);
+}