Merge pull request #2 from fpistm/pr177-review

STM32RTC fix and enhancements

Author: fpistm

README.md

@@ -18,22 +18,26 @@ The following functions are not supported:
 The following functions have been added to support specific STM32 RTC features:
 
 _RTC hours mode (12 or 24)_
-* **`void begin(RTCHourFormats_t format)`**
+* **`void begin(RTC_Hour_Format format)`**
 
 _RTC clock source_
-* **`void setClockSource(sourceClock_t source)`** : this function must be called before `begin()`
+* **`void setClockSource(RTC_Source_Clock source)`** : this function must be called before `begin()`.
+
+_RTC Asynchronous and Synchronous prescaler_
+* **`void getPrediv(int8_t *predivA, int16_t *predivS)`** : get user (a)synchronous prescaler values if set else computed ones for the current clock source.
+* **`void setPrediv(int8_t predivA, int16_t predivS)`** : set user (a)synchronous prescaler values.  This function must be called before `begin()`. Use -1 to reset value and use computed ones.
 
 _SubSeconds management_
 * **`uint32_t getSubSeconds(void)`**
 * **`void setSubSeconds(uint32_t subSeconds)`**
 
 _Hour format (AM or PM)_
-* **`uint8_t getHours(Hour12_AM_PM_t *format)`**
-* **`void setHours(uint8_t hours, Hour12_AM_PM_t format)`**
-* **`void setTime(uint8_t hours, uint8_t minutes, uint8_t seconds, uint32_t subSeconds, Hour12_AM_PM_t format)`**
-* **`void setAlarmHours(uint8_t hours, Hour12_AM_PM_t format)`**
-* **`uint8_t getAlarmHours(Hour12_AM_PM_t *format)`**
-* **`void setAlarmTime(uint8_t hours, uint8_t minutes, uint8_t seconds, Hour12_AM_PM_t format)`**
+* **`uint8_t getHours(RTC_AM_PM *period)`**
+* **`void setHours(uint8_t hours, RTC_AM_PM period)`**
+* **`void setTime(uint8_t hours, uint8_t minutes, uint8_t seconds, uint32_t subSeconds, RTC_AM_PM period)`**
+* **`void setAlarmHours(uint8_t hours, RTC_AM_PM period)`**
+* **`uint8_t getAlarmHours(RTC_AM_PM *period)`**
+* **`void setAlarmTime(uint8_t hours, uint8_t minutes, uint8_t seconds, RTC_AM_PM period)`**
 
 _Week day configuration_
 * **`uint8_t getWeekDay(void)`**

examples/RTCClockSelection/RTCClockSelection.ino

@@ -60,7 +60,7 @@ void setup()
 
   // Select RTC clock source: RTC_LSI_CLOCK, RTC_LSE_CLOCK or RTC_HSE_CLOCK.
   // By default the LSI is selected as source.
-  rtc.setClockSource(RTC_LSE_CLOCK);
+  rtc.setClockSource(STM32RTC::RTC_LSE_CLOCK);
 
   rtc.begin(); // initialize RTC 24H format
 

keywords.txt

@@ -62,14 +62,28 @@ attachInterrupt		KEYWORD2
 detachInterrupt		KEYWORD2
 
 setClockSource		KEYWORD2
+isConfigured	KEYWORD2
+
+getPrediv	KEYWORD2
+setPrediv	KEYWORD2
+
+IS_CLOCK_SOURCE		KEYWORD2
+IS_HOUR_FORMAT	KEYWORD2
 
 #######################################
 # Constants (LITERAL1)
 #######################################
-HOUR_12	LITERAL1
-HOUR_24	LITERAL1
-HOUR_AM	LITERAL1
-HOUR_PM	LITERAL1
+MATCH_OFF	LITERAL1
+MATCH_SS	LITERAL1
+MATCH_MMSS	LITERAL1
+MATCH_HHMMSS	LITERAL1
+MATCH_DHHMMSS	LITERAL1
+MATCH_MMDDHHMMSS	LITERAL1
+MATCH_YYMMDDHHMMSS	LITERAL1
+RTC_HOUR_12		LITERAL1
+RTC_HOUR_24		LITERAL1
+RTC_AM	LITERAL1
+RTC_PM	LITERAL1
 RTC_LSE_CLOCK	LITERAL1
 RTC_LSI_CLOCK	LITERAL1
 RTC_HSE_CLOCK	LITERAL1

library.properties

@@ -1,8 +1,8 @@
 name=STM32duino RTC
 version=1.0.0
-author=Wi6Labs
+author=STMicroelectronics, Wi6Labs
 maintainer=stm32duino
-sentence=Allows to use the RTC functionalities. For STM32 boards.
+sentence=Allows to use the RTC functionalities of STM32 based boards.
 paragraph=With this library you can use the RTC peripheral in order to program actions related to date and time.
 category=Timing
 url=https://github.com/stm32duino/STM32RTC.git