Update README.md

* Poll RTC by trigger, set via ISR
* Change blink state by trigger, set via ISR
* Set time compensation trigger in ISR
* Refresh clock by timer
* Re-calculate displayed time only ater rtcsync or when time adjusted by buttons
* Simplify draw algo

.gitignore

@@ -0,0 +1,6 @@
+.vscode/*
+*.swp
+*.bak
+*.old
+*.orig
+*.clang-format

.hgignore

@@ -1,6 +0,0 @@
-^\.vscode
-\.swp$
-\.bak$
-\.old$
-\.orig$
-\.clang-format

.hgtags

@@ -1,3 +0,0 @@
-ee4999ebdd2d1b54512facafdd03c8a530ea4bfa v1.0
-1167bd4b622768ed17e116a4cbac3db90031e6f8 v1.1
-109112211e454e608911949914eaa2722fbfed7d v1.2

README.md

@@ -24,3 +24,12 @@
 ### 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).
+
+This project split into 2 branches:
+
+* **default** that contains generic clock without any additional elements
+* **photoresistor** that contains additional hardware - photocell bridge - and software algorithm that compensates ambient light sensed by photocell basing on LED display charachteristics.
+
+### Stable tags for branches:
+v1.6 - default
+v1.7 - photoresistor

simpleclock.ino

@@ -6,33 +6,6 @@
  * 2 buttons for adjusting time.
  */
 
-/* This software distributed under BSD 2 Clause License
- *
- * Copyright (c) Sergei Fedosoff, All rights reserved.
- *
- * Redistribution and use in source and binary forms, with or without
- * modification, are permitted provided that the following conditions
- * are met:
- *
- * Redistributions of source code must retain the above copyright
- * notice, this listof conditions and the following disclaimer.
- * Redistributions in binary form must reproduce the above copyright
- * notice, this list of conditions and the following disclaimer in the
- * documentation and/or other materials provided with the distribution.
- *
- * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
- * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
- * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
- * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
- * HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
- * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
- * TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
- * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
- * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
- * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
- * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITYOF SUCH DAMAGE.
- */
-
 /* DS1307 lib by FrankieChu for Seeed RTC module, in my case
  * Grove___RTC_DS1307-1.0.0.zip */
 #include <DS1307.h>
@@ -43,24 +16,29 @@ SevSeg Display;
 
 /* push button stuff */
 const long initial_delay = 600;   // wait a bit before spin numbers
-const long adjust_interval = 200; // delay between consecutive number increnents
+const long adjust_interval = 200; // delay between consecutive number increments
 const long bounce_delay = 20;     // contact bounce compensation
 const int hrs_btn = A0;           // put hour adjusting button on A0 lane
 const int min_btn = A1;           // put minute adjusting button on A1 lane
-bool btn_pushed = false;          // is button pushed?
-unsigned long currentPushTimer;
+volatile bool btn_pushed = false; // is button pushed?
 unsigned long previousPushTimer = 0;
-uint8_t minutes;
-uint8_t hours;
 
 /* dot blinking stuff */
-unsigned long currentMillis;
-unsigned long previousMillis = 0;
-const long interval = 500;
-bool dot = true;
+volatile bool dot = true;
 
 /* time inaccuracy compensation flag */
-uint8_t compflag = 0;
+volatile bool compflag1 = true;
+volatile bool compflag2 = false;
+const uint8_t timeSkew = 8;          // assume that clock runs faster than should
+volatile bool timeSkewEven = false;  // comp. 1 additional second per 2 days
+
+/* time vars */
+volatile uint8_t mysecond;
+volatile uint8_t myminute;
+volatile uint8_t myhour;
+
+/* rtc sync flag */
+volatile bool rtcsync = true;
 
 void setup()
 {
@@ -77,7 +55,7 @@ void setup()
 	bool leadingZeros = false;
 
 	Display.begin(hardwareConfig, numDigits, digitPins, segmentPins,
-                      resistorsOnSegments, updateWithDelays, leadingZeros);
+	              resistorsOnSegments, updateWithDelays, leadingZeros);
 	Display.setBrightness(100);
 
 	// setup clock
@@ -96,102 +74,132 @@ void setup()
 	// setup control buttons
 	pinMode(hrs_btn, INPUT_PULLUP);
 	pinMode(min_btn, INPUT_PULLUP);
+	
+/* Timer stuff
+ * 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
+ * We'll use timer1, since we have no mechanical parts and don't need servo lib
+ */
+	// initialize timer1
+	noInterrupts();           // disable all interrupts
+	TCCR1A = 0;
+	TCCR1B = 0;
+
+	TCNT1 = 34286;            // preload timer 65536-16MHz/256/2Hz
+	TCCR1B |= (1 << CS12);    // 256 prescaler 
+	TIMSK1 |= (1 << TOIE1);   // enable timer overflow interrupt
+	interrupts();             // enable all interrupts
+}
+
+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;
+
+/* time compensation magic */
+	if ((myhour == 21) and (myminute == 21) and (mysecond == 21)
+	    and (compflag2)) {
+		compflag1 = true;
+		(timeSkewEven) ? timeSkewEven = false : timeSkewEven;
+	}
+
+	if ((myhour == 21) and (myminute == 21) and (mysecond == 23)) {
+		compflag1 = false;
+		compflag2 = true;
+	}
 }
 
 void loop()
 {
-	currentMillis = millis();
-	currentPushTimer = currentMillis;
-	char str[4];
-	float d;
+	unsigned long currentMillis = millis();
 
-	clock.getTime();
+/*
+ * Let's implement time compenstion for individual rtc module time
+ * charachteristics. In in my case quartz resonator as inaccurate as
+ * about +8.5 seconds per 24 hours
+ */
+	if (compflag1 && compflag2) {
+		if (timeSkewEven) {
+			clock.fillByHMS(myhour, myminute, (mysecond - timeSkew - 1));
+		} else {
+			clock.fillByHMS(myhour, myminute, (mysecond - timeSkew));
+		}
+
+		clock.setTime();
+		compflag2 = false;
+	}
+
+	if (rtcsync) {
+		clock.getTime();
+		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 (currentPushTimer - previousPushTimer >= initial_delay) {
-			previousPushTimer = currentPushTimer;
+	    ((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)) {
+	    (digitalRead(hrs_btn) != LOW) and (digitalRead(min_btn) != LOW)) {
 		// compensate possible contact bounce with delay
-		if (currentPushTimer - previousPushTimer >= bounce_delay) {
+		if (currentMillis - previousPushTimer >= bounce_delay) {
 			btn_pushed = false;
 		}
 	}
 
 	if (btn_pushed) {
-		if (currentPushTimer - previousPushTimer >= adjust_interval) {
-			previousPushTimer = currentPushTimer;
+		if (currentMillis - previousPushTimer >= adjust_interval) {
+			previousPushTimer = currentMillis;
 
 			if (digitalRead(hrs_btn) == LOW) {
-				hours = clock.hour + 1;
-				(hours > 23) ? hours = 0 : hours;
-				clock.fillByHMS(hours, clock.minute, 0);
+				myhour++;
+				(myhour > 23) ? myhour = 0 : myhour;
+				clock.fillByHMS(myhour, myminute, 0);
 				clock.setTime();
 			}
 
 			if (digitalRead(min_btn) == LOW) {
-				minutes = clock.minute + 1;
-				(minutes > 59) ? minutes = 0 : minutes;
-				clock.fillByHMS(clock.hour, minutes, 0);
+				myminute++;
+				(myminute > 59) ? myminute = 0 : myminute;
+				clock.fillByHMS(myhour, myminute, 0);
 				clock.setTime();
 			}
 		}
-	}
 
-	if (currentMillis - previousMillis >= interval) {
-		previousMillis = currentMillis;
-
-		if (dot)
-			dot = false;
-		else
-			dot = true;
-	}
-
-	/*
-	 * Let's implement time compenstion for individual rtc module time
-	 * charachteristics. In in my case quartz resonator as inaccurate as
-	 * +/- about 5-8 seconds per 24 hours, maybe its require more EMI
-	 * shielding?
-	 */
-
-	if ((clock.hour == 21) and (clock.minute == 21) and
-            (clock.second == 21) and (compflag == 0)) {
-		clock.fillByHMS(clock.hour, clock.minute, 14);
-		clock.setTime();
-		compflag = 1;
-	}
-
-	if ((clock.hour == 21) and (clock.minute == 21) and
-            (clock.second == 23) and (compflag == 1)) {
-		compflag = 0;
-	}
-
-	// make blinking dot
-	if (clock.hour > 0) {
-		if (dot) {
-			Display.setNumber((clock.hour * 100 + clock.minute), 2);
-		} else {
-			Display.setNumber((clock.hour * 100 + clock.minute));
-		}
-	} else {
-		/* 0 o'clock is an exception, we don't want to see "00.00", we
-		   want see "0.00" or "0 00", so we have to use this "hack" */
-		if (dot) {
-			d = float(clock.minute) / 100;
-			Display.setNumber(d, 2);
-		} else {
-			sprintf(str, "%2d%02d", clock.hour, clock.minute);
-			Display.setChars(str);
-		}
+		updateTimeStr(myhour, myminute);
 	}
 
 	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: */