Update PCF85xx RTC examples

examples/PCF85063_AlarmByUnits/PCF85063_AlarmByUnits.ino

@@ -0,0 +1,214 @@
+/**
+ *
+ * @license MIT License
+ *
+ * Copyright (c) 2022 lewis he
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ *
+ * @file      PCF85063_AlarmByUnits.ino
+ * @author    Lewis He (lewishe@outlook.com)
+ * @date      2023-12-11
+ *
+ */
+#include <Wire.h>
+#include <SPI.h>
+#include <Arduino.h>
+#include <time.h>
+#include "SensorPCF85063.hpp"
+
+#ifndef SENSOR_SDA
+#define SENSOR_SDA  4
+#endif
+
+#ifndef SENSOR_SCL
+#define SENSOR_SCL  5
+#endif
+
+#ifndef SENSOR_IRQ
+#define SENSOR_IRQ  14
+#endif
+
+
+SensorPCF85063 rtc;
+
+
+uint32_t lastMillis = 0;
+uint8_t nextHour = 22;
+uint8_t nextMonth = 1;
+uint8_t nextDay = 1;
+uint8_t nextMinute = 59;
+uint8_t nextSecond = 20;
+
+
+void setup()
+{
+    Serial.begin(115200);
+    while (!Serial);
+
+    if (!rtc.begin(Wire, PCF85063_SLAVE_ADDRESS, SENSOR_SDA, SENSOR_SCL)) {
+        Serial.println("Failed to find PCF8563 - check your wiring!");
+        while (1) {
+            delay(1000);
+        }
+    }
+
+    pinMode(SENSOR_IRQ, INPUT_PULLUP);
+
+    rtc.setDateTime(2022, nextMonth, nextDay, nextHour, nextMinute, nextSecond);
+
+    nextSecond = 55;
+
+    // First test alarm seconds
+    rtc.setAlarmBySecond(30);
+
+    rtc.enableAlarm();
+
+}
+
+void printDateTime()
+{
+    if (millis() - lastMillis > 1000) {
+        /**
+        /// Format output time*
+        Option:
+            DATETIME_FORMAT_HM
+            DATETIME_FORMAT_HMS
+            DATETIME_FORMAT_YYYY_MM_DD
+            DATETIME_FORMAT_MM_DD_YYYY
+            DATETIME_FORMAT_DD_MM_YYYY
+            DATETIME_FORMAT_YYYY_MM_DD_H_M_S
+        default:   DATETIME_FORMAT_YYYY_MM_DD_H_M_S_WEEK
+        */
+        Serial.println(rtc.strftime());
+
+        lastMillis = millis();
+    }
+}
+
+// Test seconds timing
+void  testAlarmSeconds()
+{
+    while (1) {
+        if (digitalRead(SENSOR_IRQ) == LOW) {
+            Serial.println("testAlarmSeconds Interrupt .... ");
+            if (rtc.isAlarmActive()) {
+                Serial.println("Alarm active");
+                rtc.resetAlarm();
+                rtc.setDateTime(2022, nextMonth, nextDay, nextHour, nextMinute, nextSecond);
+                rtc.setAlarmByMinutes(0);
+                return;
+            }
+        }
+        printDateTime();
+    }
+}
+
+
+// Test minute timing
+void  testAlarmMinute()
+{
+    while (1) {
+        if (digitalRead(SENSOR_IRQ) == LOW) {
+            Serial.println("testAlarmMinute Interrupt .... ");
+            if (rtc.isAlarmActive()) {
+                Serial.println("Alarm active");
+                rtc.resetAlarm();
+                rtc.setDateTime(2022, nextMonth, nextDay, nextHour, nextMinute, nextSecond);
+                nextHour++;
+                if (nextHour >= 24) {
+                    nextHour = 23;
+                    nextDay = 25;
+                    rtc.setAlarmByHours(0);
+                    Serial.println("setAlarmByHours");
+                    return;
+                }
+            }
+        }
+        printDateTime();
+    }
+}
+
+// Test hour timing
+void  testAlarmHour()
+{
+    while (1) {
+        if (digitalRead(SENSOR_IRQ) == LOW) {
+            Serial.println("testAlarmHour Interrupt .... ");
+            if (rtc.isAlarmActive()) {
+                Serial.println("Alarm active");
+                rtc.resetAlarm();
+                rtc.setDateTime(2022, nextMonth, nextDay, nextHour, nextMinute, nextSecond);
+                nextDay++;
+                if (nextDay >= 30) {
+                    nextMonth = 1;
+                    nextHour = 23;
+                    nextMinute = 59;
+                    nextSecond = 55;
+                    nextDay = rtc.getDaysInMonth(nextMonth, 2022);
+                    rtc.setDateTime(2022, nextMonth, nextDay, nextHour, nextMinute, nextSecond);
+                    rtc.setAlarmByDays(1);
+                    Serial.println("setAlarmByDays");
+                    return;
+                }
+            }
+        }
+        printDateTime();
+    }
+}
+
+// Test day timing
+void  testAlarmDay()
+{
+    while (1) {
+        if (digitalRead(SENSOR_IRQ) == LOW) {
+            Serial.println("testAlarmDay Interrupt .... ");
+            if (rtc.isAlarmActive()) {
+                Serial.println("Alarm active");
+                rtc.resetAlarm();
+                nextDay = rtc.getDaysInMonth(nextMonth, 2022);
+                rtc.setDateTime(2022, nextMonth, nextDay, nextHour, nextMinute, nextSecond);
+                nextMonth++;
+                if (nextMonth >= 12) {
+                    return;
+                }
+            }
+        }
+        printDateTime();
+    }
+}
+
+
+
+
+void loop()
+{
+    testAlarmSeconds();
+    testAlarmMinute();
+    testAlarmHour();
+    testAlarmDay();
+
+    Serial.println("Test done ...");
+    while (1) {
+        delay(100);
+    }
+}
+
+
+

examples/PCF85063_SimpleTime/PCF85063_SimpleTime.ino

@@ -32,9 +32,17 @@
 #include <Arduino.h>
 #include "SensorPCF85063.hpp"
 
-#define SENSOR_SDA                     9
-#define SENSOR_SCL                     8
-#define SENSOR_IRQ                     7
+#ifndef SENSOR_SDA
+#define SENSOR_SDA  17
+#endif
+
+#ifndef SENSOR_SCL
+#define SENSOR_SCL  18
+#endif
+
+#ifndef SENSOR_IRQ
+#define SENSOR_IRQ  7
+#endif
 
 SensorPCF85063 rtc;
 uint32_t lastMillis;
@@ -60,13 +68,8 @@ void setup()
     uint8_t minute = 24;
     uint8_t second = 30;
 
-    // rtc.setDateTime(year, month, day, hour, minute, second);
+    rtc.setDateTime(year, month, day, hour, minute, second);
 
-    // Set 12-hour mode
-    rtc.set12Hour();
-
-    // Set 24-hour mode
-    // rtc.set24Hour();
 }
 
 
@@ -78,9 +81,6 @@ void loop()
         Serial.printf(" Year :"); Serial.print(datetime.year);
         Serial.printf(" Month:"); Serial.print(datetime.month);
         Serial.printf(" Day :"); Serial.print(datetime.day);
-        if (rtc.is12HourMode()) {
-            Serial.print(" "); Serial.print(datetime.AMPM); Serial.print("M ");
-        }
         Serial.printf(" Hour:"); Serial.print(datetime.hour);
         Serial.printf(" Minute:"); Serial.print(datetime.minute);
         Serial.printf(" Sec :"); Serial.println(datetime.second);

platformio.ini

@@ -18,6 +18,7 @@
 ; src_dir = examples/PCF8563_TimeLib
 ; src_dir = examples/PCF8563_TimeSynchronization
 ; src_dir = examples/PCF85063_SimpleTime
+; src_dir = examples/PCF85063_AlarmByUnits
 ; src_dir = examples/QMC6310_CalibrateExample
 ; src_dir = examples/QMC6310_CompassExample
 ; src_dir = examples/QMC6310_GetDataExample
@@ -39,7 +40,7 @@
 ; src_dir = examples/CM32181_LightSensor
 ; src_dir = examples/CM32181_LightSensorInterrupt
 ; src_dir = examples/LTR553ALS_Sensor
-src_dir = examples/BHI260AP_6DoF
+; src_dir = examples/BHI260AP_6DoF
 ; src_dir = examples/BHI260AP_Orientation
 ; src_dir = examples/BHI260AP_StepCounter
 ; src_dir = examples/BHI260AP_DebugInfo

src/REG/PCF85063Constants.h

@@ -59,3 +59,5 @@
 #define PCF85063_CTRL1_HOUR_FORMAT_12H_MASK     (1<<1u)
 
 
+#define PCF85063_NO_ALARM        (0xFF)
+#define PCF85063_ALARM_ENABLE    (0x80)