Ds3231 square wave fix (#93)

* FixSqw Fix Squarewave flag for activating during battery backup mode * UpdateVersion
Makuna · May 29, 2019 · fb67bca · fb67bca
1 parent f287c1e
commit fb67bca
Show file tree

Hide file tree

Showing 4 changed files with 28 additions and 33 deletions.
diff --git a/keywords.txt b/keywords.txt
@@ -75,7 +75,6 @@ DS3231SquareWaveClock_1kHz	LITERAL1
 DS3231SquareWaveClock_4kHz	LITERAL1
 DS3231SquareWaveClock_8kHz	LITERAL1
 DS3231SquareWavePin_ModeNone	LITERAL1
-DS3231SquareWavePin_ModeBatteryBackup	LITERAL1
 DS3231SquareWavePin_ModeClock	LITERAL1
 DS3231SquareWavePin_ModeAlarmOne	LITERAL1
 DS3231SquareWavePin_ModeAlarmTwo	LITERAL1

diff --git a/library.json b/library.json
@@ -6,7 +6,7 @@
         "type": "git",
         "url": "https://github.com/Makuna/Rtc.git"
     },
-    "version": "2.3.2",
+    "version": "2.3.3",
     "frameworks": "arduino",
     "platforms": "*"
 }

diff --git a/library.properties b/library.properties
@@ -1,5 +1,5 @@
 name=Rtc by Makuna
-version=2.3.2
+version=2.3.3
 author=Michael C. Miller (makuna@live.com)
 maintainer=Michael C. Miller (makuna@live.com)
 sentence=A library that makes interfacing DS1302, DS1307, DS3231, and DS3234 Real Time Clock modules easy.

diff --git a/src/RtcDS3231.h b/src/RtcDS3231.h
@@ -206,11 +206,11 @@ enum DS3231SquareWaveClock
 enum DS3231SquareWavePinMode
 {
     DS3231SquareWavePin_ModeNone,
-    DS3231SquareWavePin_ModeBatteryBackup,
-    DS3231SquareWavePin_ModeClock,
     DS3231SquareWavePin_ModeAlarmOne,
     DS3231SquareWavePin_ModeAlarmTwo,
-    DS3231SquareWavePin_ModeAlarmBoth
+    // note:  the same as DS3231SquareWavePin_ModeAlarmOne | DS3231SquareWavePin_ModeAlarmTwo
+    DS3231SquareWavePin_ModeAlarmBoth, 
+    DS3231SquareWavePin_ModeClock
 };
 
 enum DS3231AlarmFlag
@@ -378,41 +378,37 @@ template<class T_WIRE_METHOD> class RtcDS3231
         setReg(DS3231_REG_STATUS, sreg);
     }
 
-    void SetSquareWavePin(DS3231SquareWavePinMode pinMode)
+    void SetSquareWavePin(DS3231SquareWavePinMode pinMode, bool enableWhileInBatteryBackup = true)
     {
         uint8_t creg = getReg(DS3231_REG_CONTROL);
 
         // clear all relevant bits to a known "off" state
         creg &= ~(DS3231_AIEMASK | _BV(DS3231_BBSQW));
-        creg |= _BV(DS3231_INTCN);  // set INTCN to disables SQW
+        creg |= _BV(DS3231_INTCN);  // set INTCN to disables clock SQW
 
-        switch (pinMode)
+        if (pinMode != DS3231SquareWavePin_ModeNone)
         {
-        case DS3231SquareWavePin_ModeNone:
-            break;
-
-        case DS3231SquareWavePin_ModeBatteryBackup:
-            creg |= _BV(DS3231_BBSQW); // set battery backup flag
-            creg &= ~_BV(DS3231_INTCN); // clear INTCN to enable SQW 
-            break;
-
-        case DS3231SquareWavePin_ModeClock:
-            creg &= ~_BV(DS3231_INTCN); // clear INTCN to enable SQW 
-            break;
-
-        case DS3231SquareWavePin_ModeAlarmOne:
-            creg |= _BV(DS3231_A1IE);
-            break;
-
-        case DS3231SquareWavePin_ModeAlarmTwo:
-            creg |= _BV(DS3231_A2IE);
-            break;
-
-        case DS3231SquareWavePin_ModeAlarmBoth:
-            creg |= _BV(DS3231_A1IE) | _BV(DS3231_A2IE);
-            break;
+            if (pinMode == DS3231SquareWavePin_ModeClock)
+            {
+                creg &= ~_BV(DS3231_INTCN); // clear INTCN to enable clock SQW 
+            }
+            else
+            {
+                if (pinMode & DS3231SquareWavePin_ModeAlarmOne)
+                {
+                    creg |= _BV(DS3231_A1IE);
+                }
+                if (pinMode & DS3231SquareWavePin_ModeAlarmTwo)
+                {
+                    creg |= _BV(DS3231_A2IE);
+                }
+            }
+
+            if (enableWhileInBatteryBackup)
+            {
+                creg |= _BV(DS3231_BBSQW); // set enable int/sqw while in battery backup flag
+            }
         }
-
         setReg(DS3231_REG_CONTROL, creg);
     }