Init battery for ds3231 explicitly, code style fixes

* move Time Compensation feature under define
* translte last few eol to unix style
* make correction: in my case with bad chrystal rtc runs faster about
  9.5 seconds per day

README.md

@@ -4,13 +4,25 @@
 
 ### Component base is very simple:
 
-* Arduino NANO v3 chinese replica
+* Arduino NANO v3 chinese replica (on Atmega-168 chip)
-* 7 segment 4 digit LED indicator with common anode, FYQ-5641BG-21
+* 7 segment 4 digit LED indicator with common anode, FYQ-5641BD-21 (red LEDs)
 * 8 resistors that limiting current on LED segments, 330 Ohms, 0.25 watts
-* RTC Module GEEGROW with DS1307 chip
+* RTC Module GEEGROW with DS1307 chip (very basic, only RTC chip, quartz resonator, button battery, no additional memory chip)
 * 5x7 cm single side prototyping board
 * usb phone charger as power supply
 * 2 push buttons
 * 1 on/off switch
+* 1 photoresistor
+* 1 resistor to make secund shoulder of photosensitive "bridge", 10 kOhms, 0.25 watts
 * Gainta G521G enclosure (92x66.5x28мм)
 * 5m power cord
+
+### Optionally you may need:
+
+* Capasitor with well capacity if your charger has small capasitor on output
+* Fuse, to protect your device
+* DC/DC transformer if you have power supply that gives more than 5 volts or less than 4.5 volts (this will give additional surge protection if your power supply dies, this can happen after 3-5 years of uninterrupted work)
+
+### Additional Notes:
+
+My RTC module is not very accurate due to bad quartz chrystal calibration, looks like it is not exactly 32768 Hz and clock runs faster than it should be, giving about 5-8 seconds runaway per day. So i have to implement time correction in software (temperature changes during day/month/year is not very big - about 10 degrees Celsius, so we can use software compensation without thermal compensation).

simpleclock.ino

@@ -1,137 +1,337 @@
-/*  
+/* 7 Segment 4 Digits clock with digit point separator.
- *           7 Segment 4 Digits clock with digit point separator
+ *
- *  
+ * It uses display module with common anode and DS1307/DS3231 RTC module to
- *           It uses display module with common anode and DS1307
+ * enhance time keeping ability of Atmega 328p based Arduino Nano 
- *           RTC module to enhance time keeping ability of
+ * microcontroller and 2 buttons for adjusting time. */
- *           Atmega 328p based Arduino nano microcontroller and
+
- *           2 buttons for adjusting time.
+/* uRTCLib
- */
+ * https://github.com/Naguissa/uRTCLib
-
+ * it has support for both DS1307 and DS3231, that I have.
-/* This software distributed under BSD 2 Clause License
+ * It is more fat than ds1307-dedicated or ds3231-dedicated lib, but I do not
-
+ * want to re-invent wheel if I have one. */
-Copyright (c) Sergei Fedosoff, All rights reserved.
+#include <uRTCLib.h>
-
+
-Redistribution and use in source and binary forms, with or without modification,
+/* SevSeg
-are permitted provided that the following conditions are met:
+ * https://github.com/DeanIsMe/SevSeg
-
+ * it has simple api and ideally works in my case.  */
-Redistributions of source code must retain the above copyright notice, this list
+#include <SevSeg.h>
-of conditions and the following disclaimer. Redistributions in binary form must
+
-reproduce the above copyright notice, this list of conditions and the following
+/* Disable time compensation.
-disclaimer in the documentation and/or other materials provided with the
+ * At last we borrow more accurate chrystal and solder it to rtc breakboard.
-distribution. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
+ */
-CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+//#define TIMECOMP
-LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
+// 0.5 second/day compensation flag.
-PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR
+//#define OFIVECOMP
-CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY,
+
-OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+#define cbi(sfr, bit) (_SFR_BYTE(sfr) &= ~_BV(bit))
-SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+#define sbi(sfr, bit) (_SFR_BYTE(sfr) |= _BV(bit))
-INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+
-CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
+uRTCLib clock;
-IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY
+SevSeg Display;
-OF SUCH DAMAGE.
+
-*/
+// Push button stuff.
-
+const long initial_delay = 600;   // wait a bit before spin numbers
-#include <SevSeg.h>
+const long adjust_interval = 200; // delay between consecutive number increments
-#include <Wire.h>
+const long bounce_delay = 20;     // contact bounce compensation
-#include <TimeLib.h>
+const int hrs_btn = A0;           // put hour adjusting button on A0 lane
-// DS1307 lib by FrankieChu for Seeed RTC module
+const int min_btn = A1;           // put minute adjusting button on A1 lane
-#include <DS1307.h>
+volatile bool btn_pushed = false; // is button pushed?
-
+unsigned long previousPushTimer = 0;
-DS1307 clock;
+
-SevSeg Display;
+// Dot blinking stuff.
-
+volatile bool dot = true;
-unsigned long currentMillis;
+
-unsigned long previousMillis = 0;
+#ifdef TIMECOMP
-const long interval = 500;
+// Time inaccuracy compensation flag.
-const int hrs_btn = A0;
+volatile bool compflag1 = true;
-const int min_btn = A1;
+volatile bool compflag2 = false;
-bool dot = true;
+const uint8_t timeSkew = 9;          // Assume that clock runs faster than should.
-uint8_t minutes;
+#ifdef OFIVECOMP
-uint8_t hours;
+volatile bool timeSkewEven = false;  // Comp. 1 additional second per 2 days.
-
+#endif
-void setup()
+#endif
-{
+
-	// setup display
+// Ambient light compensation aka night mode.
-	byte hardwareConfig = COMMON_ANODE;
+const int photoPin = A2;
-	byte numDigits = 4;
+volatile bool measureAmbLight = true;
-	byte digitPins[] = {9, 10, 11, 12};
+unsigned int ambLight = 0;           // Actual value.
-	byte segmentPins[] = {2, 3, 4, 5, 6, 7, 8, 13};
+unsigned long previousLightTimer = 0;
-	bool resistorsOnSegments = true;   // 8 resistors, 330 Ohms each
+const long refresh_interval = 40;    // Refresh rate 25Hz.
-	bool updateWithDelays = false;     // Default. Recommended
+
-	/* without it there is visual bug at 0 o'clock, and in current version of
+// Time vars.
-	 * SevSeg' setChars() does not dots at all */
+volatile uint8_t mysecond;
-	bool leadingZeros = true;          
+volatile uint8_t myminute;
-
+volatile uint8_t myhour;
-	Display.begin(hardwareConfig, numDigits, digitPins, segmentPins,
+
-                      resistorsOnSegments, updateWithDelays, leadingZeros);
+// RTC sync flag.
-	Display.setBrightness(90);
+volatile bool rtcsync = true;
-
+
-	// setup clock
+void setup()
-	clock.begin();
+{
-
+	// Setup display.
-	// if rtc returns incorrect time, reset it to some default value
+	byte hardwareConfig = COMMON_ANODE;
-	clock.getTime();
+	byte numDigits = 4;
-
+	byte digitPins[] = {9, 10, 11, 12};
-	if (( clock.hour > 23 ) || (clock.minute > 59))
+	byte segmentPins[] = {2, 3, 4, 5, 6, 7, 8, 13};
-	{
+	bool resistorsOnSegments = true; // 8 resistors, 330 Ohms each
-		clock.fillByYMD(2019,2,23);  // 23 Feb 2013
+	/* updateWithDelays defaults to false and it is recommended value,
-		clock.fillByHMS(15,52,30);   // 15:52 30"
+	 * but I was unable to make my display to change brightness notably with
-		clock.fillDayOfWeek(SAT);    // Saturday
+	 * recommended value, so i have to use updateWithDelays=true,
-		clock.setTime();             // put date to rtc
+	 * in this case brightness gets changed. */
-	}
+	bool updateWithDelays = true;
-
+
-	// setup control buttons
+	/* Without it there is visual bug at 0 o'clock, and in current version
-	pinMode(hrs_btn, INPUT_PULLUP);
+	 * of SevSeg' setChars() does not dots at all. */
-	pinMode(min_btn, INPUT_PULLUP);
+	bool leadingZeros = false;
-}
+
-
+	Display.begin(hardwareConfig, numDigits, digitPins, segmentPins,
-
+	              resistorsOnSegments, updateWithDelays, leadingZeros);
-void loop()
+	Display.setBrightness(100);
-{
+
-	unsigned long currentMillis = millis();
+	// Init i2c bus and setup clock address.
-
+	Wire.begin();
-	if (currentMillis - previousMillis >= interval)
+	clock.set_rtc_address(0x68);
-	{
+
-		previousMillis = currentMillis;
+	// If rtc returns incorrect time, reset it to some default values.
-
+	clock.refresh();
-		if (dot == false)
+
-		{
+	if (clock.lostPower()) {
-			dot = true;
+		clock.set(30, 52, 15, 6, 23, 2, 19); // Saturday, 23 Feb 2019 15:52:30
-
+		clock.lostPowerClear();
-			if (digitalRead(hrs_btn) == LOW)
+	}
-			{
+
-				clock.getTime();
+	if ((clock.hour() > 23) || (clock.minute() > 59)) {
-				hours = clock.hour + 1;
+		clock.set(30, 52, 15, 6, 23, 2, 19); // Saturday, 23 Feb 2019 15:52:30
-				(hours > 23)? hours = 0: hours;
+	}
-				clock.fillByHMS(hours, clock.minute, 0);
+
-				clock.setTime();
+	/* In case of ds1307 this will be noop, but ds3231/ds3232 sometimes does
-			}
+	 * not enable battery by default. */
-
+	clock.enableBattery();
-			if (digitalRead(min_btn) == LOW)
+
-			{
+	// Setup control buttons.
-				clock.getTime();
+	pinMode(hrs_btn, INPUT_PULLUP);
-				minutes = clock.minute + 1;
+	pinMode(min_btn, INPUT_PULLUP);
-				(minutes > 59)? minutes = 0: minutes;
+
-				clock.fillByHMS(clock.hour, minutes, 0);
+	/* Timer stuff.
-				clock.setTime();
+	 * timer0 being used in millis() micros() delay() etc, it has 8 bit resolution.
-			}
+	 * timer2 being used in analogWrite() tone() notone(), it has 8 bit resolution.
-		}
+	 * timer1 being used in servo lib has 16 bit resolution.
-		else
+	 * We'll use timer1, since we have no mechanical parts and don't need servo lib */
-		{
+
-			dot = false;
+	// Initialize timer1.
-		}
+	noInterrupts();           // Disable all interrupts.
-	}
+	TCCR1A = 0;
-
+	TCCR1B = 0;
-	clock.getTime();
+
-
+	TCNT1 = 34286;            // Preload timer 65536-16MHz/256/2Hz
-	// make blinking dot
+	TCCR1B |= (1 << CS12);    // 256 prescaler 
-	if (dot == true) {
+	TIMSK1 |= (1 << TOIE1);   // Enable timer overflow interrupt.
-		Display.setNumber((clock.hour * 100 + clock.minute), 2);
+	interrupts();             // Enable all interrupts.
-	} else {
+
-		Display.setNumber((clock.hour * 100 + clock.minute));
+	/* Increase sampling rate of analogRead()
-	}
+	 * by setting an ADC prescale from 128 to 16, so it takes less time to read
-
+	 * sensor. */
-	Display.refreshDisplay();
+	sbi(ADCSRA, ADPS2);
-}
+	cbi(ADCSRA, ADPS1);
-
+	cbi(ADCSRA, ADPS0);
-/* vim: set filetype=cpp: */
+
+	// Setup ambient brigtness sensor.
+	pinMode(photoPin, INPUT);
+	ambLight = analogRead(photoPin);
+}
+
+ISR(TIMER1_OVF_vect)
+{
+	// Feed clock twice per second.
+	TCNT1 = 34286;            // Preload timer.
+	// Do not read rtc if time beng adjusted by buttons.
+	(btn_pushed) ? rtcsync : rtcsync = true;
+
+	// Also switch dot.
+	if (dot)
+		dot = false;
+	else
+		dot = true;
+
+#ifdef TIMECOMP
+	// Time compensation magic.
+	if ((myhour == 21) and (myminute == 21) and (mysecond == 21)
+	    and (compflag2)) {
+		compflag1 = true;
+#ifdef OFIVECOMP
+		(timeSkewEven) ? timeSkewEven = false : timeSkewEven;
+#endif
+	}
+
+	if ((myhour == 21) and (myminute == 21) and (mysecond == 23)) {
+		compflag1 = false;
+		compflag2 = true;
+	}
+#endif
+}
+
+void loop()
+{
+	unsigned long currentMillis = millis();
+
+#ifdef TIMECOMP
+	/* Let's implement time compensation for individual rtc module time
+	 * characteristics. In in my case quartz resonator as inaccurate as
+	 * about +9.5 seconds per 24 hours. */
+	if (compflag1 && compflag2) {
+#ifdef OFIVECOMP
+		if (timeSkewEven) {
+			clock.set(
+				(mysecond - timeSkew - 1),
+				clock.minute(),
+				clock.hour(),
+				clock.dayOfWeek(),
+				clock.day(),
+				clock.month(),
+				clock.year()
+			);
+		} else {
+#endif
+			clock.set(
+				(mysecond - timeSkew),
+				clock.minute(),
+				clock.hour(),
+				clock.dayOfWeek(),
+				clock.day(),
+				clock.month(),
+				clock.year()
+			);
+#ifdef OFIVECOMP
+		}
+#endif
+
+		compflag2 = false;
+	}
+#endif
+
+	if (rtcsync) {
+		clock.refresh();
+		mysecond = clock.second();
+		myminute = clock.minute();
+		myhour = clock.hour();
+		updateTimeStr(myhour, myminute);
+		rtcsync = false;
+	}
+
+	// Push button magic.
+	if ((!btn_pushed) and
+	    ((digitalRead(hrs_btn) == LOW) or (digitalRead(min_btn) == LOW))) {
+		if (currentMillis - previousPushTimer >= initial_delay) {
+			previousPushTimer = currentMillis;
+			btn_pushed = true;
+		}
+	}
+
+	if (btn_pushed and
+	    (digitalRead(hrs_btn) != LOW) and (digitalRead(min_btn) != LOW)) {
+		// compensate possible contact bounce with delay
+		if (currentMillis - previousPushTimer >= bounce_delay) {
+			btn_pushed = false;
+		}
+	}
+
+	if (btn_pushed) {
+		if (currentMillis - previousPushTimer >= adjust_interval) {
+			previousPushTimer = currentMillis;
+
+			if (digitalRead(hrs_btn) == LOW) {
+				myhour++;
+				(myhour > 23) ? myhour = 0 : myhour;
+				clock.set(
+					0,
+					myminute,
+					myhour,
+					clock.dayOfWeek(),
+					clock.day(),
+					clock.month(),
+					clock.year()
+				);
+			}
+
+			if (digitalRead(min_btn) == LOW) {
+				myminute++;
+				(myminute > 59) ? myminute = 0 : myminute;
+				clock.set(
+					0,
+					myminute,
+					myhour,
+					clock.dayOfWeek(),
+					clock.day(),
+					clock.month(),
+					clock.year()
+				);
+			}
+		}
+
+		updateTimeStr(myhour, myminute);
+	}
+
+	if ((currentMillis - previousLightTimer >= refresh_interval) or
+	    (previousLightTimer > currentMillis)) { // millis() reset every ~49 days
+		previousLightTimer = currentMillis;
+		ambLight = analogRead(photoPin);
+
+		/* Ambient light compensation.
+		 * ambLight can be in range of 0..1023, if it 910+, it has point to use
+		 * fullbright.
+		 * Use table comparsion (not function of ambLight) because of non-linear
+		 * characteristics of led indicator, that cannot be described via simple
+		 * formula. */
+		if (ambLight >= 910) {
+			Display.setBrightness(100);
+		} else if ((ambLight < 900) and (ambLight >= 860)) {
+			Display.setBrightness(75);
+		} else if ((ambLight < 850) and (ambLight >= 810)) { 
+			Display.setBrightness(45);
+		} else if ((ambLight < 800) and (ambLight >= 760)) {
+			Display.setBrightness(25);
+		} else if ((ambLight < 750) and (ambLight >= 710)) {
+			Display.setBrightness(18);
+		} else if ((ambLight < 700) and (ambLight >= 660)) {
+			Display.setBrightness(12);
+		} else if ((ambLight < 650) and (ambLight >= 610)) {
+			Display.setBrightness(10);
+		} else if ((ambLight < 600) and (ambLight >= 560)) {
+			Display.setBrightness(7);
+		} else if ((ambLight < 550) and (ambLight >= 410)) {
+			Display.setBrightness(4);
+		} else if ((ambLight < 400) and (ambLight >= 360)) {
+			Display.setBrightness(0);
+		} else if ((ambLight < 350) and (ambLight >= 310)) {
+			Display.setBrightness(-3);
+		} else if ((ambLight < 300) and (ambLight >= 260)) {
+			Display.setBrightness(-6);
+		} else if ((ambLight < 250) and (ambLight >= 210)) {
+			Display.setBrightness(-10);
+		} else if ((ambLight < 200) and (ambLight >= 160)) {
+			Display.setBrightness(-14);
+		} else if ((ambLight < 150) and (ambLight >= 110)) {
+			Display.setBrightness(-18);
+		} else if (ambLight < 100) {
+			Display.setBrightness(-22);
+		}
+	}
+
+	Display.refreshDisplay();
+}
+
+void updateTimeStr(uint8_t h, uint8_t m)
+{
+	if (dot) {
+		char str[5];
+		sprintf(str, "%2d.%02d", h, m);
+		Display.setChars(str);
+	} else {
+		char str[4];
+		sprintf(str, "%2d%02d", h, m);
+		Display.setChars(str);
+	}
+}
+
+
+/* vim: set filetype=cpp: */