First import

Author: agdl

README.adoc

@@ -0,0 +1,24 @@
+= RTC Library for Arduino =
+
+The RTC library enables an Arduino Zero board to take control of the internal RTC.
+
+For more information about this library please visit us at
+http://arduino.cc/en/Reference/RTC
+
+== License ==
+
+Copyright (c) Arduino LLC. All right reserved.
+
+This library is free software; you can redistribute it and/or
+modify it under the terms of the GNU Lesser General Public
+License as published by the Free Software Foundation; either
+version 2.1 of the License, or (at your option) any later version.
+
+This library is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+Lesser General Public License for more details.
+
+You should have received a copy of the GNU Lesser General Public
+License along with this library; if not, write to the Free Software
+Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA

examples/SimpleRTC/SimpleRTC.ino

@@ -0,0 +1,68 @@
+/*
+  Simple RTC for Arduino Zero
+
+ Demonstrates the use of the RTC library for the Arduino Zero
+
+ This example code is in the public domain
+
+ http://arduino.cc/en/Tutorial/SimpleRTC
+
+*/
+
+#include <RTCZero.h>
+
+/* Create an rtc object */
+RTCZero rtc;
+
+/* Change these values to set the current initial time */
+const uint8_t seconds = 0;
+const uint8_t minutes = 0;
+const uint8_t hours = 16;
+
+/* Change these values to set the current initial date */
+const uint8_t day = 15;
+const uint8_t month = 6;
+const uint8_t year = 15;
+
+void setup()
+{
+  Serial.begin(9600);
+  
+  rtc.begin(H24); // initialize RTC 24H format. The dual option is H12
+  
+  // Set the time
+  rtc.setHours(hours);
+  rtc.setMinutes(minutes);
+  rtc.setSeconds(seconds);
+  
+  // Set the date
+  rtc.setDay(day);
+  rtc.setMonth(month);
+  rtc.setYear(year);
+  
+  // you can use also
+  //rtc.setTime(hours, minutes, seconds);
+  //rtc.setDate(day, month, year);
+}
+
+void loop()
+{
+  // Print date...
+  Serial.print(rtc.getDay());
+  Serial.print("/");
+  Serial.print(rtc.getMonth());
+  Serial.print("/");
+  Serial.print(rtc.getYear());
+  Serial.print("\t");
+  
+  // ...and time
+  Serial.print(rtc.getHours());
+  Serial.print(":");
+  Serial.print(rtc.getMinutes());
+  Serial.print(":");
+  Serial.print(rtc.getSeconds());
+ 
+  Serial.println();
+  
+  delay(1000);
+}

keywords.txt

@@ -0,0 +1,34 @@
+#######################################
+# Syntax Coloring Map For RTC
+#######################################
+
+#######################################
+# Datatypes (KEYWORD1)
+#######################################
+
+RTCZero	KEYWORD1
+
+#######################################
+# Methods and Functions (KEYWORD2)
+#######################################
+
+getDay	KEYWORD2
+getMonth	KEYWORD2
+getYear	KEYWORD2
+getHours KEYWORD2
+getMinutes	KEYWORD2
+getSeconds KEYWORD2
+
+setDay	KEYWORD2
+setMonth	KEYWORD2
+setYear	KEYWORD2
+setHours KEYWORD2
+setMinutes	KEYWORD2
+setSeconds KEYWORD2
+
+#######################################
+# Constants (LITERAL1)
+#######################################
+H24 LITERAL1
+H12 LITERAL1
+

library.properties

@@ -0,0 +1,9 @@
+name=RTCZero
+version=1.0.0
+author=Arduino
+maintainer=Arduino <[email protected]>
+sentence=Allows to use the RTC functionalities. For Arduino Zero only.
+paragraph=With this library you can use the RTC peripheral of an Arduino Zero in order to program actions related to date and time.
+category=Timing
+url=http://arduino.cc/en/Reference/RTCZero
+architectures=samd

src/RTCZero.cpp

@@ -0,0 +1,213 @@
+/*
+  RTC library for Arduino Zero.
+  Copyright (c) 2015 Arduino LLC. All right reserved.
+
+  This library is free software; you can redistribute it and/or
+  modify it under the terms of the GNU Lesser General Public
+  License as published by the Free Software Foundation; either
+  version 2.1 of the License, or (at your option) any later version.
+
+  This library is distributed in the hope that it will be useful,
+  but WITHOUT ANY WARRANTY; without even the implied warranty of
+  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+  Lesser General Public License for more details.
+
+  You should have received a copy of the GNU Lesser General Public
+  License along with this library; if not, write to the Free Software
+  Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
+*/
+ 
+#include "RTCZero.h"
+
+static bool __time24 = false;
+
+void RTCZero::begin(bool timeRep) 
+{
+  uint16_t tmp_reg = 0;
+  
+  if (timeRep)
+    __time24 = true; // 24h representation chosen
+  
+  PM->APBAMASK.reg |= PM_APBAMASK_RTC; // turn on digital interface clock
+  config32kOSC();
+
+  // Setup clock GCLK2 with OSC32K divided by 32
+  GCLK->GENDIV.reg = GCLK_GENDIV_ID(2)|GCLK_GENDIV_DIV(4);
+  while (GCLK->STATUS.reg & GCLK_STATUS_SYNCBUSY)
+    ;
+  GCLK->GENCTRL.reg = (GCLK_GENCTRL_GENEN | GCLK_GENCTRL_SRC_XOSC32K | GCLK_GENCTRL_ID(2) | GCLK_GENCTRL_DIVSEL );
+  while (GCLK->STATUS.reg & GCLK_STATUS_SYNCBUSY)
+    ;
+  GCLK->CLKCTRL.reg = (uint32_t)((GCLK_CLKCTRL_CLKEN | GCLK_CLKCTRL_GEN_GCLK2 | (RTC_GCLK_ID << GCLK_CLKCTRL_ID_Pos)));
+  while (GCLK->STATUS.bit.SYNCBUSY)
+    ;
+
+  RTCdisable();
+
+  RTCreset();
+
+  tmp_reg |= RTC_MODE2_CTRL_MODE_CLOCK; // set clock operating mode
+  tmp_reg |= RTC_MODE2_CTRL_PRESCALER_DIV1024; // set prescaler to 1024 for MODE2
+  tmp_reg &= ~RTC_MODE2_CTRL_MATCHCLR; // disable clear on match
+  
+  if (timeRep)
+    tmp_reg |= RTC_MODE2_CTRL_CLKREP; // 24h time representation
+  else
+    tmp_reg &= ~RTC_MODE2_CTRL_CLKREP; // 12h time representation
+
+  RTC->MODE2.READREQ.reg &= ~RTC_READREQ_RCONT; // disable continuously mode
+
+  RTC->MODE2.CTRL.reg = tmp_reg;
+  while (RTCisSyncing())
+    ;
+
+  RTCenable();
+  RTCresetRemove();
+}
+
+/*
+ * Get Functions
+ */
+
+uint8_t RTCZero::getSeconds()
+{
+  return RTC->MODE2.CLOCK.bit.SECOND;
+}
+
+uint8_t RTCZero::getMinutes()
+{
+  return RTC->MODE2.CLOCK.bit.MINUTE;
+}
+
+uint8_t RTCZero::getHours()
+{
+  return RTC->MODE2.CLOCK.bit.HOUR;
+}
+
+uint8_t RTCZero::getDay()
+{
+  return RTC->MODE2.CLOCK.bit.DAY;
+}
+
+uint8_t RTCZero::getMonth()
+{
+  return RTC->MODE2.CLOCK.bit.MONTH;
+}
+
+uint8_t RTCZero::getYear()
+{
+  return RTC->MODE2.CLOCK.bit.YEAR;
+}
+
+/*
+ * Set Functions
+ */
+
+void RTCZero::setSeconds(uint8_t seconds)
+{
+  RTC->MODE2.CLOCK.bit.SECOND = seconds;
+  while (RTCisSyncing())
+    ;
+}
+
+void RTCZero::setMinutes(uint8_t minutes)
+{
+  RTC->MODE2.CLOCK.bit.MINUTE = minutes;
+  while (RTCisSyncing())
+    ;
+}
+
+void RTCZero::setHours(uint8_t hours)
+{
+  if (__time24) {
+    RTC->MODE2.CLOCK.bit.HOUR = hours;
+  } else {
+    RTC->MODE2.CLOCK.bit.HOUR = hours - 12;
+  }
+  while (RTCisSyncing())
+    ;
+}
+
+void RTCZero::setTime(uint8_t hours, uint8_t minutes, uint8_t seconds)
+{
+  setSeconds(seconds);
+  setMinutes(minutes);
+  setHours(hours);
+}
+
+void RTCZero::setDay(uint8_t day)
+{
+  RTC->MODE2.CLOCK.bit.DAY = day;
+  while (RTCisSyncing())
+    ;
+}
+
+void RTCZero::setMonth(uint8_t month)
+{
+  RTC->MODE2.CLOCK.bit.MONTH = month;
+  while (RTCisSyncing())
+    ;
+}
+
+void RTCZero::setYear(uint8_t year)
+{
+  RTC->MODE2.CLOCK.bit.YEAR = year;
+  while (RTCisSyncing())
+    ;
+}
+
+void RTCZero::setDate(uint8_t day, uint8_t month, uint8_t year)
+{
+  setDay(day);
+  setMonth(month);
+  setYear(year);
+}
+
+/*
+ * Private Utility Functions
+ */
+
+/* Configure the 32768Hz Oscillator */
+void RTCZero::config32kOSC() 
+{
+  SYSCTRL->XOSC32K.reg = SYSCTRL_XOSC32K_ONDEMAND |
+                         SYSCTRL_XOSC32K_EN32K |
+                         SYSCTRL_XOSC32K_XTALEN |
+                         SYSCTRL_XOSC32K_STARTUP(6) |
+                         SYSCTRL_XOSC32K_ENABLE;
+}
+
+/* Wait for sync in write operations */
+bool RTCZero::RTCisSyncing()
+{
+  return (RTC->MODE2.STATUS.bit.SYNCBUSY);
+}
+
+void RTCZero::RTCdisable()
+{
+  RTC->MODE2.CTRL.reg &= ~RTC_MODE2_CTRL_ENABLE; // disable RTC
+  while (RTCisSyncing())
+    ;
+}
+
+void RTCZero::RTCenable()
+{
+  RTC->MODE2.CTRL.reg |= RTC_MODE2_CTRL_ENABLE; // enable RTC
+  while (RTCisSyncing())
+    ;
+}
+
+void RTCZero::RTCreset()
+{
+  RTC->MODE2.CTRL.reg |= RTC_MODE2_CTRL_SWRST; // software reset
+  while (RTCisSyncing())
+    ;
+}
+
+void RTCZero::RTCresetRemove()
+{
+  RTC->MODE2.CTRL.reg &= ~RTC_MODE2_CTRL_SWRST; // software reset remove
+  while (RTCisSyncing())
+    ;
+}
+