ATLEDGE-229 CurieRTC and Time Library

Initial implementation of the CurieRTC library for the built-in RTC
Includes the Time library plus 3 new examples for the Arduino101

Author: bigdinotech

libraries/CurieRTC/CurieRTC.cpp

@@ -0,0 +1,42 @@
+/*
+ * CurieRTC.c - RTC library for Arduino101
+  
+  Copyright (c) 2015 Intel Corporation.  All rights reserved
+  This library is intended to be uses with Arduino Time.h library functions
+
+  The 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 "CurieRTC.h"
+
+CurieRTC::CurieRTC()
+{
+}
+  
+// PUBLIC FUNCTIONS
+time_t CurieRTC::get()
+{
+  // Read the value of the RTC_CCVR register
+  return *(int*)RTC_CCVR;
+}
+
+void CurieRTC::set(time_t t)
+{
+  // Write t into the RTC_CLR register
+  *(int*)RTC_CLR = t;
+}
+
+CurieRTC RTC = CurieRTC(); // create an instance for the user

libraries/CurieRTC/CurieRTC.h

@@ -0,0 +1,37 @@
+/*
+ * CurieRTC.h - RTC library for Arduino101
+ * This library is intended to be uses with Arduino Time.h library functions
+ */
+
+#ifndef CurieRTC_h
+#define CurieRTC_h
+
+#define RTC_CCVR    0xb0000400 // Current Counter Value Register
+#define RTC_CMR     0xb0000404 // Counter Match Register
+#define RTC_CLR     0xb0000408 // Counter Load Register
+#define RTC_CCR     0xb000040C // Counter Control Register
+#define RTC_STAT    0xb0000410 // Interrupt Status Register
+#define RTC_RSTAT   0xb0000414 // Interrupt Raw Status Register
+#define RTC_EOI     0xb0000418 // End of Interrupt Register
+
+#include <Time.h>
+
+// library interface description
+class CurieRTC
+{
+  // user-accessible "public" interface
+  public:
+    CurieRTC();
+    static time_t get();
+    static void set(time_t t);
+};
+
+#ifdef RTC
+#undef RTC // workaround for Arduino Due, which defines "RTC"...
+#endif
+
+extern CurieRTC RTC;
+
+#endif
+ 
+

libraries/CurieRTC/examples/ReadTest/ReadTest.ino

@@ -0,0 +1,37 @@
+#include <Time.h>
+#include <CurieRTC.h>
+
+void setup() {
+  Serial.begin(115200);
+  delay(200);
+  Serial.println("CurieRTC Read Test");
+  Serial.println("-------------------");
+}
+
+void loop() {
+  tmElements_t tm;
+  time_t t = RTC.get();
+  breakTime(t, tm);
+  
+  Serial.print("Ok, Time = ");
+  print2digits(tm.Hour);
+  Serial.write(':');
+  print2digits(tm.Minute);
+  Serial.write(':');
+  print2digits(tm.Second);
+  Serial.print(", Date (D/M/Y) = ");
+  Serial.print(tm.Day);
+  Serial.write('/');
+  Serial.print(tm.Month);
+  Serial.write('/');
+  Serial.print(tmYearToCalendar(tm.Year));
+  Serial.println();
+  delay(1000);
+}
+
+void print2digits(int number) {
+  if (number >= 0 && number < 10) {
+    Serial.write('0');
+  }
+  Serial.print(number);
+}

libraries/CurieRTC/examples/SetTime/SetTime.ino

@@ -0,0 +1,71 @@
+#include <Time.h>
+#include <CurieRTC.h>
+
+const char *monthName[12] = {
+  "Jan", "Feb", "Mar", "Apr", "May", "Jun",
+  "Jul", "Aug", "Sep", "Oct", "Nov", "Dec"
+};
+
+tmElements_t tm;
+
+void setup() {
+  bool parse=false;
+  bool config=false;
+  time_t t;
+  
+  // get the date and time the compiler was run
+  if (getDate(__DATE__) && getTime(__TIME__)) {
+    t = makeTime(tm);
+    setTime(t);
+    parse = true;
+    config = true;
+  }
+
+  Serial.begin(115200);
+  delay(3000);
+  
+  if (parse && config) {
+    Serial.print("Curie configured Time=");
+    Serial.print(__TIME__);
+    Serial.print(", Date=");
+    Serial.println(__DATE__);
+  } else {
+    Serial.print("Could not parse info from the compiler, Time=\"");
+    Serial.print(__TIME__);
+    Serial.print("\", Date=\"");
+    Serial.print(__DATE__);
+    Serial.println("\"");
+  }
+}
+
+void loop() {
+}
+
+bool getTime(const char *str)
+{
+  int Hour, Min, Sec;
+
+  if (sscanf(str, "%d:%d:%d", &Hour, &Min, &Sec) != 3) return false;
+  tm.Hour = Hour;
+  tm.Minute = Min;
+  tm.Second = Sec;
+  return true;
+}
+
+bool getDate(const char *str)
+{
+  char Month[12];
+  int Day, Year;
+  uint8_t monthIndex;
+
+  if (sscanf(str, "%s %d %d", Month, &Day, &Year) != 3) return false;
+  for (monthIndex = 0; monthIndex < 12; monthIndex++) {
+    if (strcmp(Month, monthName[monthIndex]) == 0) break;
+  }
+  if (monthIndex >= 12) return false;
+  tm.Day = Day;
+  tm.Month = monthIndex + 1;
+  tm.Year = CalendarYrToTm(Year);
+  return true;
+}
+

libraries/CurieRTC/readme.txt

@@ -0,0 +1,7 @@
+Readme file for CurieRTC Library
+
+The CurieRTC library is provided to demonstrate the Arduino101 Time library.
+
+See the TimeCurieRTC example sketches provided with the Arduino101 Time library download for usage
+
+

libraries/Time/DateStrings.cpp

@@ -0,0 +1,97 @@
+/* DateStrings.cpp
+ * Definitions for date strings for use with the Time library
+ *
+ * Updated for Arduino 1.5.7 18 July 2014
+ *
+ * No memory is consumed in the sketch if your code does not call any of the string methods
+ * You can change the text of the strings, make sure the short strings are each exactly 3 characters 
+ * the long strings can be any length up to the constant dt_MAX_STRING_LEN defined in Time.h
+ * 
+ */
+
+#if defined(__AVR__)
+#include <avr/pgmspace.h>
+#else
+// for compatiblity with Arduino Due and Teensy 3.0 and maybe others?
+#define PROGMEM
+#define PGM_P  const char *
+#define pgm_read_byte(addr) (*(const unsigned char *)(addr))
+#define pgm_read_word(addr) (*(const unsigned char **)(addr))
+#define strcpy_P(dest, src) strcpy((dest), (src))
+#endif
+#include <string.h> // for strcpy_P or strcpy
+#include "Time.h"
+ 
+// the short strings for each day or month must be exactly dt_SHORT_STR_LEN
+#define dt_SHORT_STR_LEN  3 // the length of short strings
+
+static char buffer[dt_MAX_STRING_LEN+1];  // must be big enough for longest string and the terminating null
+
+const char monthStr0[] PROGMEM = "";
+const char monthStr1[] PROGMEM = "January";
+const char monthStr2[] PROGMEM = "February";
+const char monthStr3[] PROGMEM = "March";
+const char monthStr4[] PROGMEM = "April";
+const char monthStr5[] PROGMEM = "May";
+const char monthStr6[] PROGMEM = "June";
+const char monthStr7[] PROGMEM = "July";
+const char monthStr8[] PROGMEM = "August";
+const char monthStr9[] PROGMEM = "September";
+const char monthStr10[] PROGMEM = "October";
+const char monthStr11[] PROGMEM = "November";
+const char monthStr12[] PROGMEM = "December";
+
+const PROGMEM char * const PROGMEM monthNames_P[] =
+{
+    monthStr0,monthStr1,monthStr2,monthStr3,monthStr4,monthStr5,monthStr6,
+    monthStr7,monthStr8,monthStr9,monthStr10,monthStr11,monthStr12
+};
+
+const char monthShortNames_P[] PROGMEM = "ErrJanFebMarAprMayJunJulAugSepOctNovDec";
+
+const char dayStr0[] PROGMEM = "Err";
+const char dayStr1[] PROGMEM = "Sunday";
+const char dayStr2[] PROGMEM = "Monday";
+const char dayStr3[] PROGMEM = "Tuesday";
+const char dayStr4[] PROGMEM = "Wednesday";
+const char dayStr5[] PROGMEM = "Thursday";
+const char dayStr6[] PROGMEM = "Friday";
+const char dayStr7[] PROGMEM = "Saturday";
+
+const PROGMEM char * const PROGMEM dayNames_P[] =
+{
+   dayStr0,dayStr1,dayStr2,dayStr3,dayStr4,dayStr5,dayStr6,dayStr7
+};
+
+const char dayShortNames_P[] PROGMEM = "ErrSunMonTueWedThuFriSat";
+
+/* functions to return date strings */
+
+char* monthStr(uint8_t month)
+{
+    strcpy_P(buffer, (PGM_P)pgm_read_word(&(monthNames_P[month])));
+    return buffer;
+}
+
+char* monthShortStr(uint8_t month)
+{
+   for (int i=0; i < dt_SHORT_STR_LEN; i++)      
+      buffer[i] = pgm_read_byte(&(monthShortNames_P[i+ (month*dt_SHORT_STR_LEN)]));  
+   buffer[dt_SHORT_STR_LEN] = 0;
+   return buffer;
+}
+
+char* dayStr(uint8_t day) 
+{
+   strcpy_P(buffer, (PGM_P)pgm_read_word(&(dayNames_P[day])));
+   return buffer;
+}
+
+char* dayShortStr(uint8_t day) 
+{
+   uint8_t index = day*dt_SHORT_STR_LEN;
+   for (int i=0; i < dt_SHORT_STR_LEN; i++)      
+      buffer[i] = pgm_read_byte(&(dayShortNames_P[index + i]));  
+   buffer[dt_SHORT_STR_LEN] = 0; 
+   return buffer;
+}