Add get methods for clock source, date and time

RTC_Source_Clock getClockSource(void);
void getTime(uint8_t *hours, uint8_t *minutes, uint8_t *seconds, uint32_t *subSeconds, RTC_AM_PM *period = NULL);
void getDate(uint8_t *weekDay, uint8_t *day, uint8_t *month, uint8_t *year);

Signed-off-by: Frederic.Pillon <[email protected]>

Author: fpistm

README.md

@@ -21,6 +21,7 @@ _RTC hours mode (12 or 24)_
 * **`void begin(RTC_Hour_Format format)`**
 
 _RTC clock source_
+* **`RTC_Source_Clock setClockSource(void)`** : get current clock source.
 * **`void setClockSource(RTC_Source_Clock source)`** : this function must be called before `begin()`.
 
 _RTC Asynchronous and Synchronous prescaler_
@@ -44,6 +45,10 @@ _Week day configuration_
 * **`void setWeekDay(uint8_t weekDay)`**
 * **`void setDate(uint8_t weekDay, uint8_t day, uint8_t month, uint8_t year)`**
 
+_Time and date configuration (added for convenience)_
+* **`void getTime(uint8_t *hours, uint8_t *minutes, uint8_t *seconds, uint32_t *subSeconds, RTC_AM_PM *period = NULL)`**
+* **`void getDate(uint8_t *weekDay, uint8_t *day, uint8_t *month, uint8_t *year)`**
+
 Refer to the Arduino RTC documentation for the other functions  
 http://arduino.cc/en/Reference/RTC
 

keywords.txt

@@ -20,6 +20,8 @@ getHours		KEYWORD2
 getMinutes		KEYWORD2
 getSeconds 		KEYWORD2
 getSubSeconds		KEYWORD2
+getTime		KEYWORD2
+getDate		KEYWORD2
 
 setWeekDay		KEYWORD2
 setDay			KEYWORD2
@@ -61,6 +63,7 @@ disableAlarm 		KEYWORD2
 attachInterrupt		KEYWORD2
 detachInterrupt		KEYWORD2
 
+getClockSource		KEYWORD2
 setClockSource		KEYWORD2
 isConfigured	KEYWORD2
 

src/STM32RTC.cpp

@@ -107,6 +107,15 @@ void STM32RTC::end(void)
   }
 }
 
+/**
+  * @brief get the RTC clock source.
+  * @retval clock source: RTC_LSI_CLOCK, RTC_LSE_CLOCK or RTC_HSE_CLOCK
+  */
+STM32RTC::RTC_Source_Clock STM32RTC::getClockSource(void)
+{
+  return _clockSource;
+}
+
 /**
   * @brief set the RTC clock source. By default LSI clock is selected. This
   * method must be called before begin().
@@ -250,7 +259,7 @@ uint8_t STM32RTC::getMinutes(void)
 /**
   * @brief  get RTC hours.
   * @param  format: optional (default: NULL)
-  *         pointer to the current hour format set in the RTC: AM or PM
+  *         pointer to the current hour period set in the RTC: AM or PM
   * @retval return the current hours from the RTC.
   */
 uint8_t STM32RTC::getHours(RTC_AM_PM *period)
@@ -262,6 +271,36 @@ uint8_t STM32RTC::getHours(RTC_AM_PM *period)
   return _hours;
 }
 
+/**
+  * @brief  get RTC time.
+  * @param  hours: pointer to the current hours
+  * @param  minutes: pointer to the current minutes
+  * @param  seconds: pointer to the current seconds
+  * @param  subSeconds: pointer to the current subSeconds
+  * @param  period: optional (default: NULL)
+  *         pointer to the current hour period set in the RTC: AM or PM
+  * @retval none
+  */
+void STM32RTC::getTime(uint8_t *hours, uint8_t *minutes, uint8_t *seconds, uint32_t *subSeconds, RTC_AM_PM *period)
+{
+  syncTime();
+  if(hours != NULL) {
+    *hours = _hours;
+  }
+  if(minutes != NULL) {
+    *minutes = _minutes;
+  }
+  if(seconds != NULL) {
+    *seconds = _seconds;
+  }
+  if(subSeconds != NULL) {
+    *subSeconds = _subSeconds;
+  }
+  if(period != NULL) {
+    *period = _hoursPeriod;
+  }
+}
+
 /**
   * @brief  get RTC week day.
   * @retval return the current week day from the RTC.
@@ -302,6 +341,31 @@ uint8_t STM32RTC::getYear(void)
   return _year;
 }
 
+/**
+  * @brief  get RTC time.
+  * @param  weekDay: pointer to the current weekDay
+  * @param  day: pointer to the current day
+  * @param  month: pointer to the current month
+  * @param  year: pointer to the current year
+  * @retval none
+  */
+void STM32RTC::getDate(uint8_t *weekDay, uint8_t *day, uint8_t *month, uint8_t *year)
+{
+  syncDate();
+  if(weekDay != NULL) {
+    *weekDay = _wday;
+  }
+  if(day != NULL) {
+    *day = _day;
+  }
+  if(month != NULL) {
+    *month = _month;
+  }
+  if(year != NULL) {
+    *year = _year;
+  }
+}
+
 /**
   * @brief  get RTC alarm subsecond.
   * @retval return the current alarm subsecond.

src/STM32RTC.h

@@ -93,6 +93,7 @@ class STM32RTC {
 
   void end(void);
 
+  RTC_Source_Clock getClockSource(void);
   void setClockSource(RTC_Source_Clock source);
 
   void enableAlarm(Alarm_Match match);
@@ -110,11 +111,13 @@ class STM32RTC {
   uint8_t getSeconds(void);
   uint8_t getMinutes(void);
   uint8_t getHours(RTC_AM_PM *period = NULL);
+  void getTime(uint8_t *hours, uint8_t *minutes, uint8_t *seconds, uint32_t *subSeconds, RTC_AM_PM *period = NULL);
 
   uint8_t getWeekDay(void);
   uint8_t getDay(void);
   uint8_t getMonth(void);
   uint8_t getYear(void);
+  void getDate(uint8_t *weekDay, uint8_t *day, uint8_t *month, uint8_t *year);
 
   uint32_t getAlarmSubSeconds(void);
   uint8_t getAlarmSeconds(void);