[RTC] Enhance example

* Apply Arduino Astyle formatting
* Display subseconds
* Use printf for better formatting
* Manage alarm subsecond

Signed-off-by: Frederic Pillon <frederic.pillon@st.com>

Author: fpistm

examples/NonReg/RTC/RTC_Tests/RTC_Config.ino

@@ -34,4 +34,5 @@ void rtc_setTime(const char* date, const char* time) {
   // you can use also
   //rtc.setTime(hours, minutes, seconds);
   //rtc.setDate(weekDay, day, month, year);
-}
+   delay(100);
+}

examples/NonReg/RTC/RTC_Tests/RTC_Tests.ino

@@ -18,26 +18,26 @@
 STM32RTC& rtc = STM32RTC::getInstance();
 
 /* Change these values to set the current initial time
- *
- * format: date: "Dec 31 2017" and time: "23:59:56"
- * by default use built date and time
- */
+
+   format: date: "Dec 31 2017" and time: "23:59:56"
+   by default use built date and time
+*/
 static const char* mydate = __DATE__;
 static const char* mytime = __TIME__;
 //static const char* mydate = "Dec 31 2017";
 //static const char* mytime = "23:59:56";
 
 /* Change these values to set user (a)synchronous prescalers
- * value to test.
- *
- * Default 99/9999 are for RTCCLK = 1MHz
- * Example for DISCO_F746NG with a HSE of 25MHz
- * HSE divider will be 25 and RTCCLK will be 1MHz. (HSE/HSEdiv)
- *
- * To have a calendar clock of 1 Hz:
- * clk = RTCCLK / ((predA +1) * (predS +1))
- * clk = 1000000 / ((99 +1) * (9999+1)) = 1 Hz
- */
+   value to test.
+
+   Default 99/9999 are for RTCCLK = 1MHz
+   Example for DISCO_F746NG with a HSE of 25MHz
+   HSE divider will be 25 and RTCCLK will be 1MHz. (HSE/HSEdiv)
+
+   To have a calendar clock of 1 Hz:
+   clk = RTCCLK / ((predA +1) * (predS +1))
+   clk = 1000000 / ((99 +1) * (9999+1)) = 1 Hz
+*/
 static int8_t userPredA = 99;
 static int16_t userPredS = 9999;
 
@@ -55,16 +55,16 @@ static STM32RTC::Hour_Format hourFormat = STM32RTC::HOUR_24;
 static STM32RTC::AM_PM period = STM32RTC::AM;
 
 #ifndef STM32F1xx
-static STM32RTC::Alarm_Match SS_MATCH = STM32RTC::MATCH_SS;
-static STM32RTC::Alarm_Match MMSS_MATCH = STM32RTC::MATCH_MMSS;
-static STM32RTC::Alarm_Match HHMMSS_MATCH = STM32RTC::MATCH_HHMMSS;
+  static STM32RTC::Alarm_Match SS_MATCH = STM32RTC::MATCH_SS;
+  static STM32RTC::Alarm_Match MMSS_MATCH = STM32RTC::MATCH_MMSS;
+  static STM32RTC::Alarm_Match HHMMSS_MATCH = STM32RTC::MATCH_HHMMSS;
 #endif
 static STM32RTC::Alarm_Match DHHMMSS_MATCH = STM32RTC::MATCH_DHHMMSS;
 
 void setup()
 {
   Serial.begin(115200);
-  while(!Serial) {}
+  while (!Serial) {}
 }
 
 void loop()
@@ -88,7 +88,7 @@ void loop()
       Serial.println("Invalid input");
       continue;
     }
-    switch(c) {
+    switch (c) {
       case '1':
       default:
         Serial.println("Test will use LSI_CLOCK");
@@ -105,20 +105,19 @@ void loop()
     }
     break;
   }
-
   Serial.println("Testing asynchronous and synchronous prescaler setting");
   int8_t a;
   int16_t s;
   rtc.getPrediv(&a, &s);
   Serial.print("Async/Sync for default LSI clock: ");
-  Serial.print(a); Serial.print('/'); Serial.println(s);
+  Serial.printf("%i/%i\n", a, s);
   rtc_config(clkSource, rtc.HOUR_24, mydate, mytime);
   Serial.print("Async/Sync for selected clock: ");
   rtc.getPrediv(&a, &s);
-  Serial.print(a); Serial.print('/'); Serial.println(s);
+  Serial.printf("%i/%i\n", a, s);
   rtc.end();
 
-  if(clkSource == rtc.HSE_CLOCK) {
+  if (clkSource == rtc.HSE_CLOCK) {
     Serial.print("User Async/Sync set to ");
     Serial.print(userPredA);
     Serial.print("/");
@@ -127,15 +126,15 @@ void loop()
     rtc.setPrediv(userPredA, userPredS);
     rtc_config(clkSource, rtc.HOUR_24, mydate, mytime);
     rtc.getPrediv(&a, &s);
-    Serial.print(a); Serial.print('/'); Serial.println(s);
+    Serial.printf("%i/%i\n", a, s);
     printDateTime(10, 1000, false);
   }
 
   Serial.print("User Async/Sync reset use the computed one: ");
   rtc.setPrediv(-1, -1);
   rtc_config(clkSource, rtc.HOUR_24, mydate, mytime);
   rtc.getPrediv(&a, &s);
-  Serial.print(a); Serial.print('/'); Serial.println(s);
+  Serial.printf("%i/%i\n", a, s);
 
   // Check date change
   Serial.println("Testing date and time");
@@ -158,22 +157,25 @@ void loop()
 
   Serial.println("Using Epoch API, set to Jan 1, 2016");
   rtc.setEpoch(1451606400); // Jan 1, 2016
-  for (uint32_t i=0; i<8; i++) {
-    Serial.print("Unix time = ");
-    Serial.println(rtc.getEpoch());
-    Serial.print("Seconds since Jan 1 2000 = ");
-    Serial.println(rtc.getY2kEpoch());
+  for (uint32_t i = 0; i < 8; i++) {
+    Serial.printf("Unix time = %u\n", rtc.getEpoch());
+    Serial.printf("Seconds since Jan 1 2000 = %u\n", rtc.getY2kEpoch());
     printDateTime(1, 1000, false);
   }
 
   Serial.println("\nTesting alarm");
   rtc_config(clkSource, rtc.HOUR_24, mydate, mytime);
-  byte alarmSeconds = ((seconds+5)<60) ? seconds+5 : 5;
-  byte alarmMinutes = ((seconds+5)<60) ? minutes : ((minutes+1)<60) ? minutes+1 : 0;
-  byte alarmHours = ((seconds+5)<60) ? hours : ((minutes+1)<60) ? hours : ((hours+1)<24) ? hours+1 : 0;
-  byte alarmDay = (hours==alarmHours)? day: ((day+1)<=31) ? day+1 : 1;
+  byte alarmSeconds = ((seconds + 5) < 60) ? seconds + 5 : 5;
+  byte alarmMinutes = ((seconds + 5) < 60) ? minutes : ((minutes + 1) < 60) ? minutes + 1 : 0;
+  byte alarmHours = ((seconds + 5) < 60) ? hours : ((minutes + 1) < 60) ? hours : ((hours + 1) < 24) ? hours + 1 : 0;
+  byte alarmDay = (hours == alarmHours) ? day : ((day + 1) <= 31) ? day + 1 : 1;
+
+#if defined(STM32_RTC_VERSION) && (STM32_RTC_VERSION  >= 0x01010000)
+  rtc.setAlarmSubSeconds(123);
+#endif
 
 #ifndef STM32F1xx
+  Serial.println("\nEvery minute");
   rtc.attachInterrupt(alarmMatch, (void*)&SS_MATCH);
   rtc.setAlarmSeconds(alarmSeconds);
   rtc.enableAlarm(rtc.MATCH_SS);
@@ -203,7 +205,11 @@ void loop()
   Serial.println("\nEvery month");
   rtc_setTime(mydate, mytime);
   rtc.attachInterrupt(alarmMatch, (void*)&DHHMMSS_MATCH);
+#if defined(STM32_RTC_VERSION) && (STM32_RTC_VERSION  >= 0x01010000)
+  rtc.setAlarmTime(alarmHours, alarmMinutes, alarmSeconds, 123);
+#else
   rtc.setAlarmTime(alarmHours, alarmMinutes, alarmSeconds);
+#endif
   rtc.setAlarmDay(alarmDay);
   rtc.enableAlarm(rtc.MATCH_DHHMMSS);
   printDateTime(20, 1000, true);
@@ -219,33 +225,33 @@ void alarmMatch(void *data)
 {
   STM32RTC::Alarm_Match m = *(STM32RTC::Alarm_Match*)data;
 
-  Serial.print("Alarm Match ");
-  switch(m) {
-      case STM32RTC::MATCH_OFF:
-        Serial.println("MATCH_OFF could not happen");
-        break;
-      case STM32RTC::MATCH_YYMMDDHHMMSS://kept for compatibility
-      case STM32RTC::MATCH_MMDDHHMMSS:  //kept for compatibility
-      case STM32RTC::MATCH_DHHMMSS:
-        Serial.println("MATCH_DHHMMSS");
-        rtc.setMonth(((rtc.getMonth()+1)<13)? rtc.getMonth()+1: 1);
-        rtc.setEpoch(rtc.getEpoch()- 10);
-        break;
-      case STM32RTC::MATCH_HHMMSS:
-        Serial.println("MATCH_HHMMSS");
-        rtc.setEpoch(rtc.getEpoch()+86395);
-        break;
-      case STM32RTC::MATCH_MMSS:
-        Serial.println("MATCH_MMSS");
-        rtc.setEpoch(rtc.getEpoch()+3595);
-        break;
-      case STM32RTC::MATCH_SS:
-        Serial.println("MATCH_SS");
-        rtc.setEpoch(rtc.getEpoch()+55);
-        break;
-      default:
-        Serial.println("Unknown STM32RTC::Alarm_Match type");
+  Serial.print("Alarm Match at ");
+  printDateTime(1, 0, false);
+  switch (m) {
+    case STM32RTC::MATCH_OFF:
+      Serial.println("MATCH_OFF could not happen");
+      break;
+    case STM32RTC::MATCH_YYMMDDHHMMSS://kept for compatibility
+    case STM32RTC::MATCH_MMDDHHMMSS:  //kept for compatibility
+    case STM32RTC::MATCH_DHHMMSS:
+      Serial.println("MATCH_DHHMMSS");
+      rtc.setMonth(((rtc.getMonth() + 1) < 13) ? rtc.getMonth() + 1 : 1);
+      rtc.setEpoch(rtc.getEpoch() - 10);
+      break;
+    case STM32RTC::MATCH_HHMMSS:
+      Serial.println("MATCH_HHMMSS");
+      rtc.setEpoch(rtc.getEpoch() + 86395);
+      break;
+    case STM32RTC::MATCH_MMSS:
+      Serial.println("MATCH_MMSS");
+      rtc.setEpoch(rtc.getEpoch() + 3595);
+      break;
+    case STM32RTC::MATCH_SS:
+      Serial.println("MATCH_SS");
+      rtc.setEpoch(rtc.getEpoch() + 55);
+      break;
+    default:
+      Serial.println("Unknown STM32RTC::Alarm_Match type");
       break;
   }
-}
-
+}

examples/NonReg/RTC/RTC_Tests/RTC_utils.ino

@@ -6,13 +6,6 @@ static uint8_t conv2d(const char* p) {
   return 10 * v + *++p - '0';
 }
 
-void print2digits(int number) {
-  if (number < 10) {
-    Serial.print("0"); // print a 0 before if the number is < than 10
-  }
-  Serial.print(number);
-}
-
 // sample input: date = "Dec 26 2009", time = "12:34:56"
 void initDateTime (const char* date, const char* time) {
   year = conv2d(date + 9);
@@ -41,41 +34,31 @@ void initDateTime (const char* date, const char* time) {
 // d: delay between each print
 // a: display alarm
 void printDateTime(uint32_t t, uint32_t d, bool a) {
-  for (uint32_t i=0; i<t; i++) {
+  uint32_t subSeconds;
+
+  for (uint32_t i = 0; i < t; i++) {
+    rtc.getTime(&hours, &minutes, &seconds, &subSeconds, &period);
+
     // Print date...
-    print2digits(rtc.getMonth());
-    Serial.print("/");
-    print2digits(rtc.getDay());
-    Serial.print("/");
-    print2digits(rtc.getYear());
-    Serial.print("\t");
+    Serial.printf("%02d/%02d/%02d\t", rtc.getMonth(), rtc.getDay(), rtc.getYear());
 
     // ...and time
-    print2digits(rtc.getHours(&period));
-    Serial.print(":");
-    print2digits(rtc.getMinutes());
-    Serial.print(":");
-    print2digits(rtc.getSeconds());
+    Serial.printf("%02d:%02d:%02d.%03d", hours, minutes, seconds, subSeconds);
+
     if (hourFormat == rtc.HOUR_12) {
-      Serial.print(period == rtc.AM ? " AM":" PM");
+      Serial.print(period == rtc.AM ? " AM" : " PM");
     }
-    if(a) {
+    if (a) {
       // Print day...
-      Serial.print("\t");
-      print2digits(rtc.getAlarmDay());
-      Serial.print("\t");
-
+      Serial.printf("\t%02d\t", rtc.getAlarmDay());
       // ...and time
-      print2digits(rtc.getAlarmHours(&period));
-      Serial.print(":");
-      print2digits(rtc.getAlarmMinutes());
-      Serial.print(":");
-      print2digits(rtc.getAlarmSeconds());
+      Serial.printf("%02d:%02d:%02d.%03d", rtc.getAlarmHours(&period), rtc.getAlarmMinutes(),
+                    rtc.getAlarmSeconds(), rtc.getAlarmSubSeconds());
       if (hourFormat == rtc.HOUR_12) {
-        Serial.print(period == rtc.AM ? " AM":" PM");
+        Serial.print(period == rtc.AM ? " AM" : " PM");
       }
     }
     Serial.println();
     delay(d);
   }
-}
+}