Added photoresistor and amb. light compensation

+ Added ambient light compensation logic
+ Added photocell on scheme
+ Added photoresitor to README.md

--HG--
branch : phtoresistor

.hgignore

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

.hgtags

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

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,160 +1,235 @@
-/*  
+/*
- *           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
+ * It uses display module with common anode and DS1307 RTC module to enhance
- *           RTC module to enhance time keeping ability of
+ * time keeping ability of Atmega 328p based Arduino Nano microcontroller and
- *           Atmega 328p based Arduino nano microcontroller and
+ * 2 buttons for adjusting time.
- *           2 buttons for adjusting time.
+ */
- */
+
-
+/* This software distributed under BSD 2 Clause License
-/* This software distributed under BSD 2 Clause License
+ *
-
+ * Copyright (c) Sergei Fedosoff, All rights reserved.
-Copyright (c) Sergei Fedosoff, All rights reserved.
+ *
-
+ * Redistribution and use in source and binary forms, with or without
-Redistribution and use in source and binary forms, with or without modification,
+ * modification, are permitted provided that the following conditions
-are permitted provided that the following conditions are met:
+ * are met:
-
+ *
-Redistributions of source code must retain the above copyright notice, this list
+ * Redistributions of source code must retain the above copyright
-of conditions and the following disclaimer. Redistributions in binary form must
+ * notice, this listof conditions and the following disclaimer.
-reproduce the above copyright notice, this list of conditions and the following
+ * Redistributions in binary form must reproduce the above copyright
-disclaimer in the documentation and/or other materials provided with the
+ * notice, this list of conditions and the following disclaimer in the
-distribution. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
+ * documentation and/or other materials provided with the distribution.
-CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+ *
-LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
-PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR
+ * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
-CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY,
+ * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
-OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+ * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
-SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+ * HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
-INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+ * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
-CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
+ * TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
-IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY
+ * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
-OF SUCH DAMAGE.
+ * 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.
-#include <SevSeg.h>
+ */
-#include <Wire.h>
+
-#include <TimeLib.h>
+/* DS1307 lib by FrankieChu for Seeed RTC module, in my case
-// DS1307 lib by FrankieChu for Seeed RTC module
+ * Grove___RTC_DS1307-1.0.0.zip */
-#include <DS1307.h>
+#include <DS1307.h>
-
+#include <SevSeg.h>
-DS1307 clock;
+
-SevSeg Display;
+DS1307 clock;
-
+SevSeg Display;
-unsigned long currentMillis;
+
-unsigned long previousMillis = 0;
+/* push button stuff */
-const long interval = 500;
+const long initial_delay = 600;   // wait a bit before spin numbers
-const int hrs_btn = A0;
+const long adjust_interval = 200; // delay between consecutive number increnents
-const int min_btn = A1;
+const long bounce_delay = 20;     // contact bounce compensation
-bool dot = true;
+const int hrs_btn = A0;           // put hour adjusting button on A0 lane
-uint8_t minutes;
+const int min_btn = A1;           // put minute adjusting button on A1 lane
-uint8_t hours;
+bool btn_pushed = false;          // is button pushed?
-
+unsigned long currentPushTimer;
-void setup()
+unsigned long previousPushTimer = 0;
-{
+uint8_t minutes;
-	// setup display
+uint8_t hours;
-	byte hardwareConfig = COMMON_ANODE;
+
-	byte numDigits = 4;
+/* dot blinking stuff */
-	byte digitPins[] = {9, 10, 11, 12};
+unsigned long currentMillis;
-	byte segmentPins[] = {2, 3, 4, 5, 6, 7, 8, 13};
+unsigned long previousMillis = 0;
-	bool resistorsOnSegments = true;   // 8 resistors, 330 Ohms each
+const long interval = 500;
-	bool updateWithDelays = false;     // Default. Recommended
+bool dot = true;
-	/* without it there is visual bug at 0 o'clock, and in current version of
+
-	 * SevSeg' setChars() does not dots at all */
+/* time inaccuracy compensation flag */
-	bool leadingZeros = false;          
+uint8_t compflag = 0;
-
+const uint8_t timeSkew = 6; // assume that clock runs faster than should
-	Display.begin(hardwareConfig, numDigits, digitPins, segmentPins,
+
-                      resistorsOnSegments, updateWithDelays, leadingZeros);
+/* ambient light compensation aka night mode */
-	Display.setBrightness(90);
+const int photoPin = A2;
-
+
-	// 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 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;   // Default. Recommended
-	// setup control buttons
+
-	pinMode(hrs_btn, INPUT_PULLUP);
+	/* without it there is visual bug at 0 o'clock, and in current version
-	pinMode(min_btn, INPUT_PULLUP);
+	 * of SevSeg' setChars() does not dots at all */
-}
+	bool leadingZeros = false;
-
+
-
+	Display.begin(hardwareConfig, numDigits, digitPins, segmentPins,
-void loop()
+                      resistorsOnSegments, updateWithDelays, leadingZeros);
-{
+	Display.setBrightness(100);
-	unsigned long currentMillis = millis();
+
-	char str[4];
+	// setup clock
-	float d;
+	clock.begin();
-	
+
-	if (currentMillis - previousMillis >= interval)
+	// if rtc returns incorrect time, reset it to some default value
-	{
+	clock.getTime();
-		previousMillis = currentMillis;
+
-
+	if ((clock.hour > 23) || (clock.minute > 59)) {
-		if (dot == false)
+		clock.fillByYMD(2019, 2, 23); // 23 Feb 2019
-		{
+		clock.fillByHMS(15, 52, 30);  // 15:52:30"
-			dot = true;
+		clock.fillDayOfWeek(SAT);     // Saturday
-
+		clock.setTime();              // put date to rtc
-			if (digitalRead(hrs_btn) == LOW)
+	}
-			{
+
-				clock.getTime();
+	// setup control buttons
-				hours = clock.hour + 1;
+	pinMode(hrs_btn, INPUT_PULLUP);
-				(hours > 23)? hours = 0: hours;
+	pinMode(min_btn, INPUT_PULLUP);
-				clock.fillByHMS(hours, clock.minute, 0);
+
-				clock.setTime();
+	// setup brigtness sensor
-			}
+	pinMode(photoPin, INPUT);
-
+}
-			if (digitalRead(min_btn) == LOW)
+
-			{
+void loop()
-				clock.getTime();
+{
-				minutes = clock.minute + 1;
+	currentMillis = millis();
-				(minutes > 59)? minutes = 0: minutes;
+	currentPushTimer = currentMillis;
-				clock.fillByHMS(clock.hour, minutes, 0);
+	char str[4];
-				clock.setTime();
+	float d;
-			}
+	unsigned int ambLight = analogRead(photoPin);
-		}
+
-		else
+	clock.getTime();
-		{
+
-			dot = false;
+	// push button magic
-		}
+	if ((!btn_pushed) and
-	}
+            ((digitalRead(hrs_btn) == LOW) or (digitalRead(min_btn) == LOW))) {
-
+		if (currentPushTimer - previousPushTimer >= initial_delay) {
-	clock.getTime();
+			previousPushTimer = currentPushTimer;
-
+			btn_pushed = true;
-	// make blinking dot
+		}
-	if (clock.hour > 0)
+	}
-	{
+
-		if (dot == true) 
+	if (btn_pushed and
-		{
+            (digitalRead(hrs_btn) != LOW) and (digitalRead(min_btn) != LOW)) {
-			Display.setNumber((clock.hour * 100 + clock.minute), 2);
+		// compensate possible contact bounce with delay
-		}
+		if (currentPushTimer - previousPushTimer >= bounce_delay) {
-		else
+			btn_pushed = false;
-		{
+		}
-			Display.setNumber((clock.hour * 100 + clock.minute));
+	}
-		}
+
-	}
+	if (btn_pushed) {
-	else
+		if (currentPushTimer - previousPushTimer >= adjust_interval) {
-	{
+			previousPushTimer = currentPushTimer;
-		/* 0 o'clock is an exception, we dont want to see "00.00", we want see
+
-		 * "0.00" or "0 00", so we have to use this "hack" */
+			if (digitalRead(hrs_btn) == LOW) {
-		if (dot == true)
+				hours = clock.hour + 1;
-		{
+				(hours > 23) ? hours = 0 : hours;
-			d = float(clock.minute) / 100;
+				clock.fillByHMS(hours, clock.minute, 0);
-			Display.setNumber(d, 2);
+				clock.setTime();
-		}
+			}
-		else
+
-		{
+			if (digitalRead(min_btn) == LOW) {
-			sprintf(str, "%2d%02d", clock.hour, clock.minute);
+				minutes = clock.minute + 1;
-			Display.setChars(str);
+				(minutes > 59) ? minutes = 0 : minutes;
-		}
+				clock.fillByHMS(clock.hour, minutes, 0);
-	}
+				clock.setTime();
-
+			}
-	Display.refreshDisplay();
+		}
-}
+	}
-
+
-/* vim: set filetype=cpp: */
+	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, (clock.second - timeSkew));
+		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);
+		}
+	}
+
+	/* ambient light compensation
+	 * ambLight can be in range of 0..1023, if it 800, it has point to use fullbright
+	 */
+	if (ambLight >= 940) {
+		Display.setBrightness(100);
+	} else if ((ambLight < 900) and (ambLight >= 840)) {
+		Display.setBrightness(95);
+	} else if ((ambLight < 800) and (ambLight >= 735)) {
+		Display.setBrightness(70);
+	} else if ((ambLight < 700) and (ambLight >= 635)) {
+		Display.setBrightness(25);
+	} else if ((ambLight < 600) and (ambLight >= 530)) {
+		Display.setBrightness(15);
+	} else if ((ambLight < 500) and (ambLight >= 430)) {
+		Display.setBrightness(12);
+	} else if ((ambLight < 400) and (ambLight >= 325)) {
+		Display.setBrightness(10);
+	} else if ((ambLight < 300) and (ambLight >= 220)) {
+		Display.setBrightness(8);
+	} else if ((ambLight < 200) and (ambLight >= 110)) {
+		Display.setBrightness(7);
+	} else if (ambLight < 100) {
+		Display.setBrightness(6);
+	}
+
+	Display.refreshDisplay();
+}
+
+/* vim: set filetype=cpp: */