Added support to RTC alarm and synch with portenta RTC

 Added support to RTC alarm and sync with portenta RTC

Author: Rocketct

examples/RTC/RTC.ino

@@ -1,13 +1,13 @@
 /*
-  RTC Example
+  Machine Control - RTC Example
 
   This sketch shows how to use the RTC PCF8563T on the Machine
   Control Carrier and how to configure the PCF8563T's
   time registers.
 
   Circuit:
    - Portenta H7
-   - Portenta Machine Control Carrier
+   - Machine Control
 
 */
 #include <MachineControl.h>
@@ -34,12 +34,16 @@ void setup() {
   Serial.println("Initialization Done!");
 
   // APIs to set date's fields: years, months, days, hours, minutes and seconds
+  // The RTC time can be set as epoch, using one of the following two options:
+  // - Calendar time: rtc_controller.setEpoch(years,  months,  days, hours, minutes, seconds);
+  // - UTC time: rtc_controller.setEpoch(date_in_seconds);
   rtc_controller.setYears(years);
   rtc_controller.setMonths(months);
   rtc_controller.setDays(days);
   rtc_controller.setHours(hours);
   rtc_controller.setMinutes(minutes);
   rtc_controller.setSeconds(seconds);
+  rtc_controller.setEpoch();
 }
 
 void loop() {
@@ -56,5 +60,9 @@ void loop() {
   Serial.print(rtc_controller.getMinutes());
   Serial.print(":");
   Serial.println(rtc_controller.getSeconds());
-  delay(60000);
+  time_t utc_time = time(NULL);
+  Serial.print("Date as UTC time: ");
+  Serial.println(utc_time);
+  Serial.println();
+  delay(1000);
 }

examples/RTC_Alarm/RTC_Alarm.ino

@@ -0,0 +1,81 @@
+/*
+  Machine Control - RTC Alarm Example
+
+  This sketch shows how to use the RTC PCF8563T on the Machine
+  Control Carrier and how to configure and use the PCF8563T's
+  alarm.
+
+  Circuit:
+   - Portenta H7
+   - Machine Control
+
+*/
+#include <MachineControl.h>
+
+using namespace machinecontrol;
+
+int hours = 12;
+int minutes = 45;
+int seconds = 57;
+
+void callback_alarm();
+
+bool alarm_flag = false;
+
+void setup() {
+  Serial.begin(9600);
+  while (!Serial) {
+    ; // wait for serial port to connect.
+  }
+  Serial.println("Initialization");
+
+  if (!rtc_controller.begin()) {
+    Serial.println("Initialization fail!");
+  }
+
+
+  Serial.println("Initialization Done!");
+
+  // APIs to set date's fields:hours, minutes and seconds
+  rtc_controller.setHours(hours);
+  rtc_controller.setMinutes(minutes);
+  rtc_controller.setSeconds(seconds);
+  // Enables Alarm on PCF8563T
+  rtc_controller.enableAlarm();
+
+  // set the minutes at which the alarm should rise
+  rtc_controller.setMinuteAlarm(46);
+
+  // Attach an interrupt to the RTC interrupt pin
+  attachInterrupt(RTC_INT, callback_alarm, FALLING);
+
+  Serial.println();
+}
+int counter = 1;
+void loop() {
+  if (alarm_flag) {
+    Serial.println("Alarm!!");
+    detachInterrupt(RTC_INT);
+    rtc_controller.setSeconds(seconds);
+    rtc_controller.setMinuteAlarm(minutes + counter);
+    rtc_controller.clearAlarm();
+    attachInterrupt(RTC_INT, callback_alarm, FALLING);
+    alarm_flag = false;
+
+    // To disable the alarm uncomment the following line:
+    // rtc_controller.disableAlarm();
+  }
+
+  // APIs to get date's fields.
+  //Serial.println(digitalRead(rtc_controller.int_pin));
+  Serial.print(rtc_controller.getHours());
+  Serial.print(":");
+  Serial.print(rtc_controller.getMinutes());
+  Serial.print(":");
+  Serial.println(rtc_controller.getSeconds());
+  delay(1000);
+}
+
+void callback_alarm () {
+  alarm_flag = true;
+}

keywords.txt

@@ -53,6 +53,16 @@ setRetry	KEYWORD2
 getMonths	KEYWORD2
 setMonths	KEYWORD2
 
+enableAlarm	KEYWORD2
+disableAlarm	KEYWORD2
+clearAlarm	KEYWORD2
+setMinuteAlarm	KEYWORD2
+disableMinuteAlarm	KEYWORD2
+setHourAlarm	KEYWORD2
+disableHourAlarm	KEYWORD2
+setDayAlarm	KEYWORD2
+disableDayAlarm	KEYWORD2
+
 #######################################
 # Constants (LITERAL1)
 #######################################
@@ -99,4 +109,4 @@ DIN_READ_CH_PIN_06	LITERAL1
 DIN_READ_CH_PIN_07	LITERAL1
 
 PROBE_K	LITERAL1
-#define	LITERAL1
+#define	LITERAL1

src/MachineControl.h

@@ -477,7 +477,7 @@ extern ProgrammableDINClass digital_inputs;
 
 class RtcControllerClass : public PCF8563TClass {
 public:
-	mbed::DigitalIn int_pin = mbed::DigitalIn(PB_9);
+	mbed::DigitalIn int_pin = mbed::DigitalIn(PB_9,PullUp);
 private:
 
 };

src/utility/RTC/PCF8563T.cpp

@@ -20,13 +20,35 @@
 #include "PCF8563T.h"
 
 #define PCF8563T_ADDRESS        0x51
+#define PCF8563T_STATUS_2_REG   0X01
 #define PCF8563T_VL_SECONDS_REG 0X02
 #define PCF8563T_MINUTES_REG    0x03
 #define PCF8563T_HOURS_REG      0X04
 #define PCF8563T_DAYS_REG       0x05
 #define PCF8563T_MONTHS_REG     0x07
 #define PCF8563T_YEARS_REG      0x08
 
+// allarm managemet
+#define PCF8563T_MINUTE_ALARM_REG 0x09
+#define PCF8563T_MINUTE_ALARM_AE_M_MASK 0x80
+#define PCF8563T_MINUTE_ALARM_ON 0x7F
+
+#define PCF8563T_HOUR_ALARM_REG 0x0A
+#define PCF8563T_HOUR_ALARM_AE_H_MASK 0x80
+#define PCF8563T_HOUR_ALARM_ON 0x7F
+
+#define PCF8563T_DAY_ALARM_REG 0x0B
+#define PCF8563T_DAY_ALARM_AE_D_MASK 0x80
+#define PCF8563T_DAY_ALARM_ON 0x7F
+
+#define PCF8563T_TIMER_CONTROL_REG 0X0E
+#define PCF8563T_TIMER_CONTROL_ON 0x80
+#define PCF8563T_TIMER_CONTROL_OFF 0x7F
+
+#define PCF8563T_STATUS_2_AIE_MASK 0x02
+#define PCF8563T_STATUS_2_CLEAR_INT 0xF7
+#define PCF8563T_STATUS_2_INT_OFF 0x7d
+
 PCF8563TClass::PCF8563TClass()
 {
 }
@@ -114,6 +136,109 @@ uint8_t PCF8563TClass::getSeconds() {
   return (seconds & 0x0F) + ((seconds >> 4)*10);
 }
 
+
+void PCF8563TClass::setEpoch() {
+  struct tm time;
+  time.tm_sec = getSeconds();
+  time.tm_min = getMinutes();
+  time.tm_hour = getHours();
+  time.tm_mday = getDays();
+  time.tm_mon = getMonths() - 1;
+  time.tm_year = getYears() + 100;
+  time_t seconds;
+  _rtc_maketime(&time, &seconds, RTC_FULL_LEAP_YEAR_SUPPORT);
+  set_time(seconds);
+}
+
+void PCF8563TClass::setEpoch(time_t seconds) {
+  struct tm time;
+  _rtc_localtime(seconds, &time, RTC_FULL_LEAP_YEAR_SUPPORT);
+
+  setSeconds(time.tm_sec);
+  setMinutes(time.tm_min);
+  setHours( time.tm_hour);
+  setDays(time.tm_mday);
+  setMonths(time.tm_mon + 1);
+  setYears((time.tm_year - 100));
+  set_time(seconds);
+}
+
+
+void PCF8563TClass::setEpoch(uint8_t years, uint8_t months, uint8_t days, uint8_t hours, uint8_t minutes, uint8_t seconds) {
+  struct tm time;
+  time_t utcsec;
+
+  time.tm_sec = seconds;
+  time.tm_min = minutes;
+  time.tm_hour = hours;
+  time.tm_mday = days;
+  time.tm_mon = months - 1;
+  time.tm_year = years + 100;  // year since 1900
+
+  _rtc_maketime(&time, &utcsec,RTC_FULL_LEAP_YEAR_SUPPORT);
+  set_time(utcsec);
+}
+
+time_t PCF8563TClass::getEpoch() {
+  struct tm time;
+  time_t seconds;
+
+  time.tm_sec = getSeconds();
+  time.tm_min = getMinutes();
+  time.tm_hour = getHours();
+  time.tm_mday = getDays();
+  time.tm_mon = getMonths() - 1;
+  time.tm_year = getYears() + 100;  // year since 1900
+
+  _rtc_maketime(&time, &seconds, RTC_FULL_LEAP_YEAR_SUPPORT);
+  return seconds;
+}
+
+void PCF8563TClass::enableAlarm() {
+  writeByte(PCF8563T_STATUS_2_REG, (readByte(PCF8563T_STATUS_2_REG) & PCF8563T_STATUS_2_CLEAR_INT) | PCF8563T_STATUS_2_AIE_MASK);
+}
+
+void PCF8563TClass::disableAlarm() {
+   writeByte(PCF8563T_STATUS_2_REG, (readByte(PCF8563T_STATUS_2_REG) & PCF8563T_STATUS_2_INT_OFF));
+}
+
+void PCF8563TClass::clearAlarm() {
+  writeByte(PCF8563T_STATUS_2_REG, (readByte(PCF8563T_STATUS_2_REG) & PCF8563T_STATUS_2_CLEAR_INT) | PCF8563T_STATUS_2_AIE_MASK);
+}
+
+void PCF8563TClass::setMinuteAlarm(uint8_t minutes) {
+  uint8_t dec = minutes / 10;
+  uint8_t unit = minutes - (dec * 10);
+  uint8_t min_alarm = PCF8563T_MINUTE_ALARM_ON & ((dec << 4) + unit);
+  writeByte(PCF8563T_MINUTE_ALARM_REG , min_alarm);
+}
+
+void PCF8563TClass::disableMinuteAlarm() {
+  writeByte(PCF8563T_MINUTE_ALARM_REG, readByte(PCF8563T_MINUTE_ALARM_REG) | PCF8563T_MINUTE_ALARM_AE_M_MASK);
+}
+
+void PCF8563TClass::setHourAlarm(uint8_t hours) {
+  uint8_t dec = hours / 10;
+  uint8_t unit = hours - (dec * 10);
+  uint8_t hour_alarm = PCF8563T_HOUR_ALARM_AE_H_MASK & ((dec << 4) + unit);
+  writeByte(PCF8563T_HOURS_REG, hour_alarm); //check formula on datasheet val + 6 * (val / 10)
+}
+
+void PCF8563TClass::disableHourAlarm() {
+  writeByte(PCF8563T_HOUR_ALARM_REG, readByte(PCF8563T_HOUR_ALARM_REG) | PCF8563T_HOUR_ALARM_AE_H_MASK);
+}
+
+void PCF8563TClass::setDayAlarm(uint8_t days) {
+  uint8_t dec = days / 10;
+  uint8_t unit = days - (dec * 10);
+   uint8_t day_alarm = PCF8563T_DAY_ALARM_ON & ((dec << 4) + unit);
+  writeByte(PCF8563T_DAY_ALARM_REG, day_alarm);
+}
+
+void PCF8563TClass::disableDayAlarm() {
+  writeByte(PCF8563T_DAY_ALARM_REG, readByte(PCF8563T_DAY_ALARM_REG) | PCF8563T_DAY_ALARM_AE_D_MASK );
+}
+
 void PCF8563TClass::writeByte(uint8_t regAddres, uint8_t data) {
   Wire1.beginTransmission(PCF8563T_ADDRESS);
   Wire1.write(regAddres);

src/utility/RTC/PCF8563T.h

@@ -22,8 +22,10 @@
 
 #include "Arduino.h"
 #include "mbed.h"
+#include "time.h"
+#include "mbed_mktime.h"
 #include "Wire.h"
-
+#define RTC_INT PB_9
 class PCF8563TClass {
 
 public:
@@ -43,6 +45,22 @@ class PCF8563TClass {
   uint8_t getMinutes();
   uint8_t getSeconds();
 
+  void setEpoch();
+  void setEpoch(uint8_t years, uint8_t months, uint8_t days, uint8_t hours, uint8_t minutes, uint8_t seconds);
+  void setEpoch(time_t seconds);
+  time_t getEpoch();
+
+void enableAlarm();
+void disableAlarm();
+void clearAlarm();
+void setMinuteAlarm(uint8_t minutes);
+void disableMinuteAlarm();
+void setHourAlarm(uint8_t hours);
+void disableHourAlarm();
+void setDayAlarm(uint8_t days);
+void disableDayAlarm();
+
+
 private:
   void writeByte(uint8_t regAddres, uint8_t data);
   uint8_t readByte(uint8_t regAddres);