5.5.2 Fixed functions for getting time

gogi640 · gogi640 · commit 483bd39d2c70 · 2021-12-16T10:26:45.000+01:00
rtcReadTime() function renamed to rtcGetRtcData() and examples renamed accordingly. Time variables are transfered to struct called date_time and are defined as a variable rtc_time. Now before getting any of time variables it is necessary to call function rtcGetRtcData(); so rtc can save data to rtc_time.
diff --git a/examples/Inkplate10/Advanced_Inkplate_Features/Inkplate_RTC_Alarm_Example/Inkplate_RTC_Alarm_Example.ino b/examples/Inkplate10/Advanced_Inkplate_Features/Inkplate_RTC_Alarm_Example/Inkplate_RTC_Alarm_Example.ino
@@ -59,7 +59,7 @@ void setup()
 int n = 0;
 void loop()
 {
-    display.rtcReadTime();             // Get the time and date from RTC
+    display.rtcGetRtcData();             // Get the time and date from RTC
     seconds = display.rtcGetSecond();  // Store senconds in a variable
     minutes = display.rtcGetMinute();  // Store minutes in a variable
     hour = display.rtcGetHour();       // Store hours in a variable
diff --git a/examples/Inkplate10/Advanced_Inkplate_Features/Inkplate_RTC_Basic_Example/Inkplate_RTC_Basic_Example.ino b/examples/Inkplate10/Advanced_Inkplate_Features/Inkplate_RTC_Basic_Example/Inkplate_RTC_Basic_Example.ino
@@ -49,7 +49,7 @@ void setup()
 int n = 0;
 void loop()
 {
-    display.rtcReadTime();             // Get the time and date from RTC
+    display.rtcGetRtcData();             // Get the time and date from RTC
     seconds = display.rtcGetSecond();  // Store senconds in a variable
     minutes = display.rtcGetMinute();  // Store minutes in a variable
     hour = display.rtcGetHour();       // Store hours in a variable
diff --git a/examples/Inkplate10/Advanced_Inkplate_Features/Inkplate_RTC_Interrupt_Alarm_Example/Inkplate_RTC_Interrupt_Alarm_Example.ino b/examples/Inkplate10/Advanced_Inkplate_Features/Inkplate_RTC_Interrupt_Alarm_Example/Inkplate_RTC_Interrupt_Alarm_Example.ino
@@ -55,7 +55,7 @@ void loop()
 {
     display.clearDisplay();         // Clear frame buffer of display
     display.setCursor(100, 100);    // Set position of the text
-    display.rtcReadTime();          // Get the time and date from RTC
+    display.rtcGetRtcData();          // Get the time and date from RTC
 
     // Print the time on screen
     printTime(display.rtcGetHour(), display.rtcGetMinute(), display.rtcGetSecond(), display.rtcGetDay(), display.rtcGetWeekday(), display.rtcGetMonth(), display.rtcGetYear());
diff --git a/examples/Inkplate10/Advanced_Inkplate_Features/Inkplate_RTC_Timer_Example/Inkplate_RTC_Timer_Example.ino b/examples/Inkplate10/Advanced_Inkplate_Features/Inkplate_RTC_Timer_Example/Inkplate_RTC_Timer_Example.ino
@@ -69,7 +69,7 @@ void setup()
 int n = 0;
 void loop()
 {
-    display.rtcReadTime();             // Get the time and date from RTC
+    display.rtcGetRtcData();             // Get the time and date from RTC
     seconds = display.rtcGetSecond();  // Store senconds in a variable
     minutes = display.rtcGetMinute();  // Store minutes in a variable
     hour = display.rtcGetHour();       // Store hours in a variable
diff --git a/examples/Inkplate5/Advanced_Inkplate_Features/Inkplate_RTC_Alarm_Example/Inkplate_RTC_Alarm_Example.ino b/examples/Inkplate5/Advanced_Inkplate_Features/Inkplate_RTC_Alarm_Example/Inkplate_RTC_Alarm_Example.ino
@@ -59,7 +59,7 @@ void setup()
 int n = 0;
 void loop()
 {
-    display.rtcReadTime();             // Get the time and date from RTC
+    display.rtcGetRtcData();             // Get the time and date from RTC
     seconds = display.rtcGetSecond();  // Store senconds in a variable
     minutes = display.rtcGetMinute();  // Store minutes in a variable
     hour = display.rtcGetHour();       // Store hours in a variable
diff --git a/examples/Inkplate5/Advanced_Inkplate_Features/Inkplate_RTC_Basic_Example/Inkplate_RTC_Basic_Example.ino b/examples/Inkplate5/Advanced_Inkplate_Features/Inkplate_RTC_Basic_Example/Inkplate_RTC_Basic_Example.ino
@@ -49,7 +49,7 @@ void setup()
 int n = 0;
 void loop()
 {
-    display.rtcReadTime();             // Get the time and date from RTC
+    display.rtcGetRtcData();             // Get the time and date from RTC
     seconds = display.rtcGetSecond();  // Store senconds in a variable
     minutes = display.rtcGetMinute();  // Store minutes in a variable
     hour = display.rtcGetHour();       // Store hours in a variable
diff --git a/examples/Inkplate5/Advanced_Inkplate_Features/Inkplate_RTC_Interrupt_Alarm_Example/Inkplate_RTC_Interrupt_Alarm_Example.ino b/examples/Inkplate5/Advanced_Inkplate_Features/Inkplate_RTC_Interrupt_Alarm_Example/Inkplate_RTC_Interrupt_Alarm_Example.ino
@@ -55,7 +55,7 @@ void loop()
 {
     display.clearDisplay();         // Clear frame buffer of display
     display.setCursor(100, 100);    // Set position of the text
-    display.rtcReadTime();          // Get the time and date from RTC
+    display.rtcGetRtcData();          // Get the time and date from RTC
 
     // Print the time on screen
     printTime(display.rtcGetHour(), display.rtcGetMinute(), display.rtcGetSecond(), display.rtcGetDay(), display.rtcGetWeekday(), display.rtcGetMonth(), display.rtcGetYear());
diff --git a/examples/Inkplate5/Advanced_Inkplate_Features/Inkplate_RTC_Timer_Example/Inkplate_RTC_Timer_Example.ino b/examples/Inkplate5/Advanced_Inkplate_Features/Inkplate_RTC_Timer_Example/Inkplate_RTC_Timer_Example.ino
@@ -69,7 +69,7 @@ void setup()
 int n = 0;
 void loop()
 {
-    display.rtcReadTime();             // Get the time and date from RTC
+    display.rtcGetRtcData();             // Get the time and date from RTC
     seconds = display.rtcGetSecond();  // Store senconds in a variable
     minutes = display.rtcGetMinute();  // Store minutes in a variable
     hour = display.rtcGetHour();       // Store hours in a variable
diff --git a/examples/Inkplate6/Advanced_Inkplate_Features/Inkplate_RTC_Alarm_Example/Inkplate_RTC_Alarm_Example.ino b/examples/Inkplate6/Advanced_Inkplate_Features/Inkplate_RTC_Alarm_Example/Inkplate_RTC_Alarm_Example.ino
@@ -63,7 +63,7 @@ void setup()
 int n = 0;
 void loop()
 {
-    display.rtcReadTime();             // Get the time and date from RTC
+    display.rtcGetRtcData();             // Get the time and date from RTC
     seconds = display.rtcGetSecond();  // Store senconds in a variable
     minutes = display.rtcGetMinute();  // Store minutes in a variable
     hour = display.rtcGetHour();       // Store hours in a variable
diff --git a/examples/Inkplate6/Advanced_Inkplate_Features/Inkplate_RTC_Basic_Example/Inkplate_RTC_Basic_Example.ino b/examples/Inkplate6/Advanced_Inkplate_Features/Inkplate_RTC_Basic_Example/Inkplate_RTC_Basic_Example.ino
@@ -28,14 +28,14 @@
 Inkplate display(INKPLATE_1BIT); // Create an object on Inkplate library and also set library into 1-bit mode (BW)
 
 // Set clock
-uint8_t hour = 12;
-uint8_t minutes = 50;
-uint8_t seconds = 30;
+uint8_t hour = 8;
+uint8_t minutes = 25;
+uint8_t seconds = 0;
 
 // Set date and weekday (NOTE: In weekdays 0 means Sunday, 1 menas Monday, ...)
 uint8_t weekday = 4;
-uint8_t day = 11;
-uint8_t month = 11;
+uint8_t day = 16;
+uint8_t month = 12;
 uint8_t year = 21;
 
 void setup()
@@ -52,8 +52,8 @@ void setup()
 // Variable that keeps count on how much screen has been partially updated
 int n = 0;
 void loop()
-{
-    display.rtcReadTime();             // Get the time and date from RTC
+{   
+    display.rtcGetRtcData();             // Get the time and date from RTC
     seconds = display.rtcGetSecond();  // Store senconds in a variable
     minutes = display.rtcGetMinute();  // Store minutes in a variable
     hour = display.rtcGetHour();       // Store hours in a variable
diff --git a/examples/Inkplate6/Advanced_Inkplate_Features/Inkplate_RTC_Interrupt_Alarm_Example/Inkplate_RTC_Interrupt_Alarm_Example.ino b/examples/Inkplate6/Advanced_Inkplate_Features/Inkplate_RTC_Interrupt_Alarm_Example/Inkplate_RTC_Interrupt_Alarm_Example.ino
@@ -59,7 +59,7 @@ void loop()
 {
     display.clearDisplay();         // Clear frame buffer of display
     display.setCursor(100, 100);    // Set position of the text
-    display.rtcReadTime();          // Get the time and date from RTC
+    display.rtcGetRtcData();          // Get the time and date from RTC
 
     // Print the time on screen
     printTime(display.rtcGetHour(), display.rtcGetMinute(), display.rtcGetSecond(), display.rtcGetDay(), display.rtcGetWeekday(), display.rtcGetMonth(), display.rtcGetYear());
diff --git a/examples/Inkplate6/Advanced_Inkplate_Features/Inkplate_RTC_Timer_Example/Inkplate_RTC_Timer_Example.ino b/examples/Inkplate6/Advanced_Inkplate_Features/Inkplate_RTC_Timer_Example/Inkplate_RTC_Timer_Example.ino
@@ -73,7 +73,7 @@ void setup()
 int n = 0;
 void loop()
 {
-    display.rtcReadTime();             // Get the time and date from RTC
+    display.rtcGetRtcData();             // Get the time and date from RTC
     seconds = display.rtcGetSecond();  // Store senconds in a variable
     minutes = display.rtcGetMinute();  // Store minutes in a variable
     hour = display.rtcGetHour();       // Store hours in a variable
diff --git a/examples/Inkplate6PLUS/Advanced_Inkplate_Features/Inkplate_RTC_Alarm_Example/Inkplate_RTC_Alarm_Example.ino b/examples/Inkplate6PLUS/Advanced_Inkplate_Features/Inkplate_RTC_Alarm_Example/Inkplate_RTC_Alarm_Example.ino
@@ -59,7 +59,7 @@ void setup()
 int n = 0;
 void loop()
 {
-    display.rtcReadTime();             // Get the time and date from RTC
+    display.rtcGetRtcData();             // Get the time and date from RTC
     seconds = display.rtcGetSecond();  // Store senconds in a variable
     minutes = display.rtcGetMinute();  // Store minutes in a variable
     hour = display.rtcGetHour();       // Store hours in a variable
diff --git a/examples/Inkplate6PLUS/Advanced_Inkplate_Features/Inkplate_RTC_Basic_Example/Inkplate_RTC_Basic_Example.ino b/examples/Inkplate6PLUS/Advanced_Inkplate_Features/Inkplate_RTC_Basic_Example/Inkplate_RTC_Basic_Example.ino
@@ -49,7 +49,7 @@ void setup()
 int n = 0;
 void loop()
 {
-    display.rtcReadTime();             // Get the time and date from RTC
+    display.rtcGetRtcData();             // Get the time and date from RTC
     seconds = display.rtcGetSecond();  // Store senconds in a variable
     minutes = display.rtcGetMinute();  // Store minutes in a variable
     hour = display.rtcGetHour();       // Store hours in a variable
diff --git a/examples/Inkplate6PLUS/Advanced_Inkplate_Features/Inkplate_RTC_Interrupt_Alarm_Example/Inkplate_RTC_Interrupt_Alarm_Example.ino b/examples/Inkplate6PLUS/Advanced_Inkplate_Features/Inkplate_RTC_Interrupt_Alarm_Example/Inkplate_RTC_Interrupt_Alarm_Example.ino
@@ -55,7 +55,7 @@ void loop()
 {
     display.clearDisplay();         // Clear frame buffer of display
     display.setCursor(100, 100);    // Set position of the text
-    display.rtcReadTime();          // Get the time and date from RTC
+    display.rtcGetRtcData();          // Get the time and date from RTC
 
     // Print the time on screen
     printTime(display.rtcGetHour(), display.rtcGetMinute(), display.rtcGetSecond(), display.rtcGetDay(), display.rtcGetWeekday(), display.rtcGetMonth(), display.rtcGetYear());
diff --git a/examples/Inkplate6PLUS/Advanced_Inkplate_Features/Inkplate_RTC_Timer_Example/Inkplate_RTC_Timer_Example.ino b/examples/Inkplate6PLUS/Advanced_Inkplate_Features/Inkplate_RTC_Timer_Example/Inkplate_RTC_Timer_Example.ino
@@ -69,7 +69,7 @@ void setup()
 int n = 0;
 void loop()
 {
-    display.rtcReadTime();             // Get the time and date from RTC
+    display.rtcGetRtcData();             // Get the time and date from RTC
     seconds = display.rtcGetSecond();  // Store senconds in a variable
     minutes = display.rtcGetMinute();  // Store minutes in a variable
     hour = display.rtcGetHour();       // Store hours in a variable
diff --git a/library.properties b/library.properties
@@ -1,5 +1,5 @@
 name=InkplateLibrary
-version=5.5.1
+version=5.5.2
 author=e-radionica.com <inkplate@e-radionica.com>
 maintainer=David Zovko <inkplate@e-radionica.com>
 sentence=Inkplate boards driver library
diff --git a/src/include/System.cpp b/src/include/System.cpp
@@ -224,7 +224,7 @@ void System::rtcSetTime(uint8_t rtcHour, uint8_t rtcMinute, uint8_t rtcSecond)
  */
 void System::rtcSetDate(uint8_t rtcWeekday, uint8_t rtcDay, uint8_t rtcMonth, uint16_t yr)
 {
-    rtcYear = yr - 1970; // convert to RTC rtcYear format 0-99
+    rtc_time.rtcYear = yr - 1970; // convert to RTC rtcYear format 0-99
 
     Wire.beginTransmission(I2C_ADDR);
     Wire.write(RTC_RAM_by);
@@ -236,7 +236,7 @@ void System::rtcSetDate(uint8_t rtcWeekday, uint8_t rtcDay, uint8_t rtcMonth, ui
     Wire.write(rtcDecToBcd(rtcDay));
     Wire.write(rtcDecToBcd(rtcWeekday));
     Wire.write(rtcDecToBcd(rtcMonth));
-    Wire.write(rtcDecToBcd(rtcYear));
+    Wire.write(rtcDecToBcd(rtc_time.rtcYear));
     Wire.endTransmission();
 }
 
@@ -293,7 +293,7 @@ uint32_t System::rtcGetEpoch()
 /**
  * @brief                   Reads time and date from the RTC
  */
-void System::rtcReadTime()
+void System::rtcGetRtcData()
 {
     Wire.beginTransmission(I2C_ADDR);
     Wire.write(RTC_SECOND_ADDR); // datasheet 8.4.
@@ -303,13 +303,13 @@ void System::rtcReadTime()
 
     while (Wire.available())
     {
-        rtcSecond = rtcBcdToDec(Wire.read() & 0x7F); // ignore bit 7
-        rtcMinute = rtcBcdToDec(Wire.read() & 0x7F);
-        rtcHour = rtcBcdToDec(Wire.read() & 0x3F); // ignore bits 7 & 6
-        rtcDay = rtcBcdToDec(Wire.read() & 0x3F);
-        rtcWeekday = rtcBcdToDec(Wire.read() & 0x07); // ignore bits 7,6,5,4 & 3
-        rtcMonth = rtcBcdToDec(Wire.read() & 0x1F);   // ignore bits 7,6 & 5
-        rtcYear = rtcBcdToDec(Wire.read()) + 1970;
+        rtc_time.rtcSecond = rtcBcdToDec(Wire.read() & 0x7F); // ignore bit 7
+        rtc_time.rtcMinute = rtcBcdToDec(Wire.read() & 0x7F);
+        rtc_time.rtcHour = rtcBcdToDec(Wire.read() & 0x3F); // ignore bits 7 & 6
+        rtc_time.rtcDay = rtcBcdToDec(Wire.read() & 0x3F);
+        rtc_time.rtcWeekday = rtcBcdToDec(Wire.read() & 0x07); // ignore bits 7,6,5,4 & 3
+        rtc_time.rtcMonth = rtcBcdToDec(Wire.read() & 0x1F);   // ignore bits 7,6 & 5
+        rtc_time.rtcYear = rtcBcdToDec(Wire.read()) + 1970;
     }
 }
 
@@ -320,8 +320,7 @@ void System::rtcReadTime()
  */
 uint8_t System::rtcGetSecond()
 {
-    rtcReadTime();
-    return rtcSecond;
+    return rtc_time.rtcSecond;
 }
 
 /**
@@ -331,8 +330,7 @@ uint8_t System::rtcGetSecond()
  */
 uint8_t System::rtcGetMinute()
 {
-    rtcReadTime();
-    return rtcMinute;
+    return rtc_time.rtcMinute;
 }
 
 /**
@@ -342,8 +340,7 @@ uint8_t System::rtcGetMinute()
  */
 uint8_t System::rtcGetHour()
 {
-    rtcReadTime();
-    return rtcHour;
+    return rtc_time.rtcHour;
 }
 
 /**
@@ -353,8 +350,7 @@ uint8_t System::rtcGetHour()
  */
 uint8_t System::rtcGetDay()
 {
-    rtcReadTime();
-    return rtcDay;
+    return rtc_time.rtcDay;
 }
 
 /**
@@ -364,8 +360,7 @@ uint8_t System::rtcGetDay()
  */
 uint8_t System::rtcGetWeekday()
 {
-    rtcReadTime();
-    return rtcWeekday;
+    return rtc_time.rtcWeekday;
 }
 
 /**
@@ -375,8 +370,7 @@ uint8_t System::rtcGetWeekday()
  */
 uint8_t System::rtcGetMonth()
 {
-    rtcReadTime();
-    return rtcMonth;
+    return rtc_time.rtcMonth;
 }
 
 /**
@@ -386,8 +380,7 @@ uint8_t System::rtcGetMonth()
  */
 uint16_t System::rtcGetYear()
 {
-    rtcReadTime();
-    return rtcYear;
+    return rtc_time.rtcYear;
 }
 
 /**
diff --git a/src/include/System.h b/src/include/System.h
@@ -130,7 +130,7 @@ class System : public Esp,
     void rtcSetDate(uint8_t weekday, uint8_t day, uint8_t month, uint16_t yr);
     void rtcSetEpoch(uint32_t _epoch);
     uint32_t rtcGetEpoch();
-    void rtcReadTime();
+    void rtcGetRtcData();
     void rtcEnableAlarm(); // called on setAlarm()
     void rtcSetAlarm(uint8_t alarm_second, uint8_t alarm_minute, uint8_t alarm_hour, uint8_t alarm_day,
                      uint8_t alarm_weekday);
@@ -163,14 +163,6 @@ class System : public Esp,
   private:
     uint8_t rtcDecToBcd(uint8_t val);
     uint8_t rtcBcdToDec(uint8_t val);
-    /* time variables */
-    uint8_t rtcHour;
-    uint8_t rtcMinute;
-    uint8_t rtcSecond;
-    uint8_t rtcDay;
-    uint8_t rtcWeekday;
-    uint8_t rtcMonth;
-    uint16_t rtcYear;
     /* alarm */
     uint8_t rtcAlarmSecond;
     uint8_t rtcAlarmMinute;
@@ -181,6 +173,17 @@ class System : public Esp,
     uint8_t rtcControl2;
     uint8_t _panelOn = 0;
     int16_t _sdCardOk = 0;
+    /* time variables structure */
+    struct date_time
+    {
+        uint8_t rtcHour;
+        uint8_t rtcMinute;
+        uint8_t rtcSecond;
+        uint8_t rtcDay;
+        uint8_t rtcWeekday;
+        uint8_t rtcMonth;
+        uint16_t rtcYear;
+    }rtc_time;
 };
 
 #endif

Original file line number	Diff line number	Diff line change
`@@ -59,7 +59,7 @@ void setup()`
`59`	`59`	`int n = 0;`
`60`	`60`	`void loop()`
`61`	`61`	`{`
`62`		`- display.rtcReadTime(); // Get the time and date from RTC`
	`62`	`+ display.rtcGetRtcData(); // Get the time and date from RTC`
`63`	`63`	`seconds = display.rtcGetSecond(); // Store senconds in a variable`
`64`	`64`	`minutes = display.rtcGetMinute(); // Store minutes in a variable`
`65`	`65`	`hour = display.rtcGetHour(); // Store hours in a variable`
Original file line number	Diff line number	Diff line change
`@@ -49,7 +49,7 @@ void setup()`
`49`	`49`	`int n = 0;`
`50`	`50`	`void loop()`
`51`	`51`	`{`
`52`		`- display.rtcReadTime(); // Get the time and date from RTC`
	`52`	`+ display.rtcGetRtcData(); // Get the time and date from RTC`
`53`	`53`	`seconds = display.rtcGetSecond(); // Store senconds in a variable`
`54`	`54`	`minutes = display.rtcGetMinute(); // Store minutes in a variable`
`55`	`55`	`hour = display.rtcGetHour(); // Store hours in a variable`
Original file line number	Diff line number	Diff line change
`@@ -55,7 +55,7 @@ void loop()`
`55`	`55`	`{`
`56`	`56`	`display.clearDisplay(); // Clear frame buffer of display`
`57`	`57`	`display.setCursor(100, 100); // Set position of the text`
`58`		`- display.rtcReadTime(); // Get the time and date from RTC`
	`58`	`+ display.rtcGetRtcData(); // Get the time and date from RTC`
`59`	`59`
`60`	`60`	`// Print the time on screen`
`61`	`61`	`printTime(display.rtcGetHour(), display.rtcGetMinute(), display.rtcGetSecond(), display.rtcGetDay(), display.rtcGetWeekday(), display.rtcGetMonth(), display.rtcGetYear());`
Original file line number	Diff line number	Diff line change
`@@ -69,7 +69,7 @@ void setup()`
`69`	`69`	`int n = 0;`
`70`	`70`	`void loop()`
`71`	`71`	`{`
`72`		`- display.rtcReadTime(); // Get the time and date from RTC`
	`72`	`+ display.rtcGetRtcData(); // Get the time and date from RTC`
`73`	`73`	`seconds = display.rtcGetSecond(); // Store senconds in a variable`
`74`	`74`	`minutes = display.rtcGetMinute(); // Store minutes in a variable`
`75`	`75`	`hour = display.rtcGetHour(); // Store hours in a variable`
Original file line number	Diff line number	Diff line change
`@@ -63,7 +63,7 @@ void setup()`
`63`	`63`	`int n = 0;`
`64`	`64`	`void loop()`
`65`	`65`	`{`
`66`		`- display.rtcReadTime(); // Get the time and date from RTC`
	`66`	`+ display.rtcGetRtcData(); // Get the time and date from RTC`
`67`	`67`	`seconds = display.rtcGetSecond(); // Store senconds in a variable`
`68`	`68`	`minutes = display.rtcGetMinute(); // Store minutes in a variable`
`69`	`69`	`hour = display.rtcGetHour(); // Store hours in a variable`