Naming conventions for member enums

Remove redundant RTC_ prefix. Fix #7 Require Core version higher than 1.3.0 Signed-off-by: Frederic.Pillon <frederic.pillon@st.com>

Author: fpistm

examples/Epoch/Epoch.ino

@@ -44,9 +44,9 @@ STM32RTC& rtc = STM32RTC::getInstance();
 void setup() {
  Serial.begin(9600);
 
- // Select RTC clock source: RTC_LSI_CLOCK, RTC_LSE_CLOCK or RTC_HSE_CLOCK.
+ // Select RTC clock source: LSI_CLOCK, LSE_CLOCK or HSE_CLOCK.
  // By default the LSI is selected as source.
- //rtc.setClockSource(STM32RTC::RTC_LSE_CLOCK);
+ //rtc.setClockSource(STM32RTC::LSE_CLOCK);
 
  rtc.begin(); // initialize RTC 24H format
 

examples/RTCClockSelection/RTCClockSelection.ino

@@ -58,9 +58,9 @@ void setup()
 {
  Serial.begin(9600);
 
- // Select RTC clock source: RTC_LSI_CLOCK, RTC_LSE_CLOCK or RTC_HSE_CLOCK.
+ // Select RTC clock source: LSI_CLOCK, LSE_CLOCK or HSE_CLOCK.
  // By default the LSI is selected as source.
- rtc.setClockSource(STM32RTC::RTC_LSE_CLOCK);
+ rtc.setClockSource(STM32RTC::LSE_CLOCK);
 
  rtc.begin(); // initialize RTC 24H format
 

examples/SimpleRTC/SimpleRTC.ino

@@ -57,9 +57,9 @@ void setup()
 {
  Serial.begin(9600);
 
- // Select RTC clock source: RTC_LSI_CLOCK, RTC_LSE_CLOCK or RTC_HSE_CLOCK.
+ // Select RTC clock source: LSI_CLOCK, LSE_CLOCK or HSE_CLOCK.
  // By default the LSI is selected as source.
- //rtc.setClockSource(STM32RTC::RTC_LSE_CLOCK);
+ //rtc.setClockSource(STM32RTC::LSE_CLOCK);
 
  rtc.begin(); // initialize RTC 24H format
 

examples/advancedRTCAlarm/advancedRTCAlarm.ino

@@ -40,9 +40,9 @@ void setup()
 {
  Serial.begin(9600);
 
- // Select RTC clock source: RTC_LSI_CLOCK, RTC_LSE_CLOCK or RTC_HSE_CLOCK.
+ // Select RTC clock source: LSI_CLOCK, LSE_CLOCK or HSE_CLOCK.
  // By default the LSI is selected as source.
- //rtc.setClockSource(STM32RTC::RTC_LSE_CLOCK);
+ //rtc.setClockSource(STM32RTC::LSE_CLOCK);
 
  rtc.begin(); // initialize RTC 24H format
 

examples/simpleRTCAlarm/simpleRTCAlarm.ino

@@ -55,9 +55,9 @@ void setup()
 {
  Serial.begin(9600);
 
- // Select RTC clock source: RTC_LSI_CLOCK, RTC_LSE_CLOCK or RTC_HSE_CLOCK.
+ // Select RTC clock source: LSI_CLOCK, LSE_CLOCK or HSE_CLOCK.
  // By default the LSI is selected as source.
- //rtc.setClockSource(STM32RTC::RTC_LSE_CLOCK);
+ //rtc.setClockSource(STM32RTC::LSE_CLOCK);
 
  rtc.begin(); // initialize RTC 24H format
 

keywords.txt

@@ -85,10 +85,10 @@ MATCH_HHMMSS	LITERAL1
 MATCH_DHHMMSS	LITERAL1
 MATCH_MMDDHHMMSS	LITERAL1
 MATCH_YYMMDDHHMMSS	LITERAL1
-RTC_HOUR_12LITERAL1
-RTC_HOUR_24LITERAL1
-RTC_AMLITERAL1
-RTC_PMLITERAL1
-RTC_LSE_CLOCKLITERAL1
-RTC_LSI_CLOCKLITERAL1
-RTC_HSE_CLOCKLITERAL1
+HOUR_12LITERAL1
+HOUR_24LITERAL1
+AMLITERAL1
+PMLITERAL1
+LSE_CLOCKLITERAL1
+LSI_CLOCKLITERAL1
+HSE_CLOCKLITERAL1

src/STM32RTC.cpp

@@ -49,7 +49,7 @@ bool STM32RTC::_configured = false;
 /**
  * @brief initializes the RTC
  * @param resetTime: if true reconfigures the RTC
- * @param format: hour format: RTC_HOUR_12 or RTC_HOUR_24(default)
+ * @param format: hour format: HOUR_12 or HOUR_24(default)
  * @retval None
  */
 void STM32RTC::begin(bool resetTime, RTC_Hour_Format format)
@@ -63,15 +63,15 @@ void STM32RTC::begin(bool resetTime, RTC_Hour_Format format)
 
 /**
  * @brief initializes the RTC
- * @param format: hour format: RTC_HOUR_12 or RTC_HOUR_24(default)
+ * @param format: hour format: HOUR_12 or HOUR_24(default)
  * @retval None
  */
 void STM32RTC::begin(RTC_Hour_Format format)
 {
  if(_configured == false) {
- RTC_init((format == RTC_HOUR_12)? HOUR_FORMAT_12: HOUR_FORMAT_24,
- (_clockSource == RTC_LSE_CLOCK)? LSE_CLOCK:
- (_clockSource == RTC_HSE_CLOCK)? HSE_CLOCK : LSI_CLOCK);
+ RTC_init((format == HOUR_12)? HOUR_FORMAT_12: HOUR_FORMAT_24,
+ (_clockSource == LSE_CLOCK)? ::LSE_CLOCK:
+ (_clockSource == HSE_CLOCK)? ::HSE_CLOCK : ::LSI_CLOCK);
  // Must be set before call of sync methods
  _configured = true;
  syncTime();
@@ -106,7 +106,7 @@ void STM32RTC::end(void)
 
 /**
  * @brief get the RTC clock source.
- * @retval clock source: RTC_LSI_CLOCK, RTC_LSE_CLOCK or RTC_HSE_CLOCK
+ * @retval clock source: LSI_CLOCK, LSE_CLOCK or HSE_CLOCK
  */
 STM32RTC::RTC_Source_Clock STM32RTC::getClockSource(void)
 {
@@ -116,15 +116,15 @@ STM32RTC::RTC_Source_Clock STM32RTC::getClockSource(void)
 /**
  * @brief set the RTC clock source. By default LSI clock is selected. This
  * method must be called before begin().
- * @param source: clock source: RTC_LSI_CLOCK, RTC_LSE_CLOCK or RTC_HSE_CLOCK
+ * @param source: clock source: LSI_CLOCK, LSE_CLOCK or HSE_CLOCK
  * @retval None
  */
 void STM32RTC::setClockSource(RTC_Source_Clock source)
 {
  if(IS_CLOCK_SOURCE(source)) {
  _clockSource = source;
- RTC_SetClockSource((_clockSource == RTC_LSE_CLOCK)? LSE_CLOCK:
- (_clockSource == RTC_HSE_CLOCK)? HSE_CLOCK : LSI_CLOCK);
+ RTC_SetClockSource((_clockSource == LSE_CLOCK)? ::LSE_CLOCK:
+ (_clockSource == HSE_CLOCK)? ::HSE_CLOCK : ::LSI_CLOCK);
  }
 }
 
@@ -174,7 +174,7 @@ void STM32RTC::enableAlarm(Alarm_Match match)
  case MATCH_MMSS:
  case MATCH_SS:
  RTC_StartAlarm(_alarmDay, _alarmHours, _alarmMinutes, _alarmSeconds,
- _alarmSubSeconds, (_alarmPeriod == RTC_AM)? AM: PM,
+ _alarmSubSeconds, (_alarmPeriod == AM)? HOUR_AM: HOUR_PM,
  static_cast<uint8_t>(_alarmMatch));
  _alarmEnabled = true;
  break;
@@ -458,7 +458,7 @@ void STM32RTC::setSubSeconds(uint32_t subSeconds)
  if(subSeconds < 1000) {
  _subSeconds = subSeconds;
  }
- RTC_SetTime(_hours, _minutes, _seconds, _subSeconds, (_hoursPeriod == RTC_AM)? AM : PM);
+ RTC_SetTime(_hours, _minutes, _seconds, _subSeconds, (_hoursPeriod == AM)? HOUR_AM : HOUR_PM);
  }
 }
 
@@ -474,7 +474,7 @@ void STM32RTC::setSeconds(uint8_t seconds)
  if(seconds < 60) {
  _seconds = seconds;
  }
- RTC_SetTime(_hours, _minutes, _seconds, _subSeconds, (_hoursPeriod == RTC_AM)? AM : PM);
+ RTC_SetTime(_hours, _minutes, _seconds, _subSeconds, (_hoursPeriod == AM)? HOUR_AM : HOUR_PM);
  }
 }
 
@@ -490,7 +490,7 @@ void STM32RTC::setMinutes(uint8_t minutes)
  if(minutes < 60) {
  _minutes = minutes;
  }
- RTC_SetTime(_hours, _minutes, _seconds, _subSeconds, (_hoursPeriod == RTC_AM)? AM : PM);
+ RTC_SetTime(_hours, _minutes, _seconds, _subSeconds, (_hoursPeriod == AM)? HOUR_AM : HOUR_PM);
  }
 }
 
@@ -506,7 +506,7 @@ void STM32RTC::setHours(uint8_t hours)
  if(hours < 24) {
  _hours = hours;
  }
- RTC_SetTime(_hours, _minutes, _seconds, _subSeconds, (_hoursPeriod == RTC_AM)? AM : PM);
+ RTC_SetTime(_hours, _minutes, _seconds, _subSeconds, (_hoursPeriod == AM)? HOUR_AM : HOUR_PM);
  }
 }
 
@@ -524,7 +524,7 @@ void STM32RTC::setHours(uint8_t hours, RTC_AM_PM period)
  _hours = hours;
  }
  _hoursPeriod = period;
- RTC_SetTime(_hours, _minutes, _seconds, _subSeconds, (_hoursPeriod == RTC_AM)? AM : PM);
+ RTC_SetTime(_hours, _minutes, _seconds, _subSeconds, (_hoursPeriod == AM)? HOUR_AM : HOUR_PM);
  }
 }
 
@@ -548,7 +548,7 @@ void STM32RTC::setTime(uint8_t hours, uint8_t minutes, uint8_t seconds)
  if(hours < 24) {
  _hours = hours;
  }
- RTC_SetTime(_hours, _minutes, _seconds, _subSeconds, (_hoursPeriod == RTC_AM)? AM : PM);
+ RTC_SetTime(_hours, _minutes, _seconds, _subSeconds, (_hoursPeriod == AM)? HOUR_AM : HOUR_PM);
  }
 }
 
@@ -577,7 +577,7 @@ void STM32RTC::setTime(uint8_t hours, uint8_t minutes, uint8_t seconds, uint32_t
  _hours = hours;
  }
  _hoursPeriod = period;
- RTC_SetTime(_hours, _minutes, _seconds, _subSeconds, (_hoursPeriod == RTC_AM)? AM : PM);
+ RTC_SetTime(_hours, _minutes, _seconds, _subSeconds, (_hoursPeriod == AM)? HOUR_AM : HOUR_PM);
  }
 }
 
@@ -925,7 +925,7 @@ void STM32RTC::setEpoch(uint32_t ts)
  _seconds = tmp->tm_sec;
 
  RTC_SetDate(_year, _month, _day, _wday);
- RTC_SetTime(_hours, _minutes, _seconds, _subSeconds, (_hoursPeriod == RTC_AM)? AM : PM);
+ RTC_SetTime(_hours, _minutes, _seconds, _subSeconds, (_hoursPeriod == AM)? HOUR_AM : HOUR_PM);
  }
 }
 
@@ -993,9 +993,9 @@ void STM32RTC::configForLowPower(RTC_Source_Clock source)
 void STM32RTC::syncTime(void)
 {
  if(_configured) {
- hourAM_PM_t p = AM;
+ hourAM_PM_t p = HOUR_AM;
  RTC_GetTime(&_hours, &_minutes, &_seconds, &_subSeconds, &p);
- _hoursPeriod = (p == AM)? RTC_AM : RTC_PM;
+ _hoursPeriod = (p == HOUR_AM)? AM : PM;
  }
 }
 
@@ -1017,11 +1017,11 @@ void STM32RTC::syncDate(void)
 void STM32RTC::syncAlarmTime(void)
 {
  if(_configured) {
- hourAM_PM_t p = AM;
+ hourAM_PM_t p = HOUR_AM;
  uint8_t match;
  RTC_GetAlarm(&_alarmDay, &_alarmHours, &_alarmMinutes, &_alarmSeconds,
  &_alarmSubSeconds, &p, &match);
- _alarmPeriod = (p == AM)? RTC_AM : RTC_PM;
+ _alarmPeriod = (p == HOUR_AM)? AM : PM;
  switch (static_cast<Alarm_Match>(match)) {
  case MATCH_OFF:
  case MATCH_YYMMDDHHMMSS://kept for compatibility

src/STM32RTC.h

@@ -48,23 +48,23 @@
 
 typedef void(*voidFuncPtr)(void *);
 
-#define IS_CLOCK_SOURCE(SRC) (((SRC) == STM32RTC::RTC_LSI_CLOCK) || ((SRC) == STM32RTC::RTC_LSE_CLOCK) ||\
- ((SRC) == STM32RTC::RTC_HSE_CLOCK))
-#define IS_HOUR_FORMAT(FMT) (((FMT) == STM32RTC::RTC_HOUR_12) || ((FMT) == STM32RTC::RTC_HOUR_24))
+#define IS_CLOCK_SOURCE(SRC) (((SRC) == STM32RTC::LSI_CLOCK) || ((SRC) == STM32RTC::LSE_CLOCK) ||\
+ ((SRC) == STM32RTC::HSE_CLOCK))
+#define IS_HOUR_FORMAT(FMT) (((FMT) == STM32RTC::HOUR_12) || ((FMT) == STM32RTC::HOUR_24))
 
 class STM32RTC {
 public:
 
  enum RTC_Hour_Format : uint8_t
  {
- RTC_HOUR_12 = HOUR_FORMAT_12,
- RTC_HOUR_24 = HOUR_FORMAT_24
+ HOUR_12 = HOUR_FORMAT_12,
+ HOUR_24 = HOUR_FORMAT_24
  };
 
  enum RTC_AM_PM : uint8_t
  {
- RTC_AM = AM,
- RTC_PM = PM
+ AM = HOUR_AM,
+ PM = HOUR_PM
  };
 
  enum Alarm_Match: uint8_t
@@ -81,9 +81,9 @@ class STM32RTC {
 
  enum RTC_Source_Clock: uint8_t
  {
- RTC_LSI_CLOCK = LSI_CLOCK,
- RTC_LSE_CLOCK = LSE_CLOCK,
- RTC_HSE_CLOCK = HSE_CLOCK
+ LSI_CLOCK = ::LSI_CLOCK,
+ LSE_CLOCK = ::LSE_CLOCK,
+ HSE_CLOCK = ::HSE_CLOCK
  };
 
  static STM32RTC& getInstance() {
@@ -95,8 +95,8 @@ class STM32RTC {
  STM32RTC(STM32RTC const&) = delete;
  void operator=(STM32RTC const&) = delete;
 
- void begin(bool resetTime, RTC_Hour_Format format = RTC_HOUR_24);
- void begin(RTC_Hour_Format format = RTC_HOUR_24);
+ void begin(bool resetTime, RTC_Hour_Format format = HOUR_24);
+ void begin(RTC_Hour_Format format = HOUR_24);
 
  void end(void);
 
@@ -188,7 +188,7 @@ class STM32RTC {
  friend class STM32LowPower;
 
 private:
- STM32RTC(void): _clockSource(RTC_LSI_CLOCK) {}
+ STM32RTC(void): _clockSource(LSI_CLOCK) {}
 
  static bool _configured;