feat: add getAlarmEpoch method

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

Author: fpistm

keywords.txt

@@ -38,6 +38,7 @@ setTime	KEYWORD2
 
 getEpoch	KEYWORD2
 getY2kEpoch	KEYWORD2
+getAlarmEpoch	KEYWORD2
 setEpoch	KEYWORD2
 setY2kEpoch	KEYWORD2
 setAlarmEpoch	KEYWORD2

src/STM32RTC.cpp

@@ -1077,6 +1077,60 @@ time_t STM32RTC::getY2kEpoch(void)
   return (getEpoch() - EPOCH_TIME_OFF);
 }
 
+/**
+  * @brief  get alarm epoch time
+  * @param  name: ALARM_A or ALARM_B if exists
+  * @retval epoch time in seconds
+  */
+time_t STM32RTC::getAlarmEpoch(Alarm name)
+{
+  return getAlarmEpoch(nullptr, name);
+}
+
+/**
+  * @brief  get alarm epoch time
+  * @param  subSeconds: optional pointer to where to store subseconds of the epoch in ms
+  * @param  name: optional (default: ALARM_A)
+  *         ALARM_A or ALARM_B if exists
+  * @retval epoch time in seconds
+  */
+time_t STM32RTC::getAlarmEpoch(uint32_t *subSeconds, Alarm name)
+{
+  struct tm tm;
+
+  tm.tm_isdst = -1;
+  /*
+   * mktime ignores the values supplied by the caller in the
+   * tm_wday and tm_yday fields
+   */
+  tm.tm_yday = 0;
+  tm.tm_wday = 0;
+  tm.tm_year = _year + EPOCH_TIME_YEAR_OFF;
+  tm.tm_mon = _month - 1;
+  syncAlarmTime(name);
+#ifdef RTC_ALARM_B
+  if (name == ALARM_B) {
+    tm.tm_mday = _alarmBDay;
+    tm.tm_hour = _alarmBHours;
+    tm.tm_min = _alarmBMinutes;
+    tm.tm_sec = _alarmBSeconds;
+    if (subSeconds != nullptr) {
+      *subSeconds = _alarmBSubSeconds;
+    }
+  } else
+#endif
+  {
+    tm.tm_mday = _alarmDay;
+    tm.tm_hour = _alarmHours;
+    tm.tm_min = _alarmMinutes;
+    tm.tm_sec = _alarmSeconds;
+    if (subSeconds != nullptr) {
+      *subSeconds = _alarmSubSeconds;
+    }
+  }
+  return mktime(&tm);
+}
+
 /**
   * @brief  set RTC alarm from epoch time
   * @param  epoch time in seconds

src/STM32RTC.h

@@ -206,6 +206,8 @@ class STM32RTC {
     time_t getY2kEpoch(void);
     void setEpoch(time_t ts, uint32_t subSeconds = 0);
     void setY2kEpoch(time_t ts);
+    time_t getAlarmEpoch(Alarm name);
+    time_t getAlarmEpoch(uint32_t *subSeconds = nullptr, Alarm name = ALARM_A);
     void setAlarmEpoch(time_t ts, Alarm_Match match, Alarm name);
     void setAlarmEpoch(time_t ts, Alarm_Match match = MATCH_DHHMMSS, uint32_t subSeconds = 0, Alarm name = ALARM_A);