Merge branch 'main' into hour_animation_frame_light

techniccontroller · techniccontroller · commit 4faf200053b1 · 2026-02-08T20:51:29.000+01:00
diff --git a/README.md b/README.md
@@ -92,6 +92,8 @@ We've got some interesting branches in this repo inspired by user feedback. Thes
 ![compile esp8266 workflow](https://github.com/techniccontroller/wordclock_esp8266/actions/workflows/compile_esp8266.yml/badge.svg?branch=rgbw_leds)
 - [**static_background_pattern**](https://github.com/techniccontroller/wordclock_esp8266/tree/static_background_pattern): This branch allows to light up specific letters always during clock mode. E.G., to display some special words in another color.  
 ![compile esp8266 workflow](https://github.com/techniccontroller/wordclock_esp8266/actions/workflows/compile_esp8266.yml/badge.svg?branch=static_background_pattern)
+- [**frame_light**](https://github.com/techniccontroller/wordclock_esp8266/tree/frame_light): This branch allows to add an additional LEDs around the clock, as background/frame light it has the same color as the clock. Thanks to Sandro for the idea. 
+![compile esp8266 workflow](https://github.com/techniccontroller/wordclock_esp8266/actions/workflows/compile_esp8266.yml/badge.svg?branch=frame_light)
 
 ## Install needed Libraries
 
diff --git a/data/index.html b/data/index.html
@@ -280,6 +280,10 @@ <h1 id="headline">WORDCLOCK 2.0</h1>
 				<label for="colorshiftspeed">Color shift speed:</label>
 				<input type="range" id="colorshiftspeed" name="volume" min="0" max="50">
 			</div>
+			<div class="number-container">
+				<label for="nm_brightness">Nightmode brightness:</label>
+				<input type="range" id="nm_brightness" name="volume" min="0" max="100">
+			</div>
 			<div class="number-container">
 				<label for="nm_start" style="align-self: flex-start">Nightmode start time: </label> 
 				<input type="time" id="nm_start" name="nm_start" min="00:00" max="23:59">
@@ -586,6 +590,7 @@ <h1 id="headline">WORDCLOCK 2.0</h1>
 					document.getElementById("nm_start").value = myVar.nightModeStart.replace("-", ":");
 					document.getElementById("nm_end").value = myVar.nightModeEnd.replace("-", ":");
 					document.getElementById("brightness").value = parseInt(myVar.brightness);
+					document.getElementById("nm_brightness").value = parseInt(myVar.nightModeBrightness);
 					document.getElementById("brightnessFrame").value = parseInt(myVar.brightnessFrame);
 					document.getElementById("colorshiftspeed").value = parseInt(myVar.colorshiftspeed);
 
@@ -663,6 +668,7 @@ <h1 id="headline">WORDCLOCK 2.0</h1>
 				var nmStart = document.getElementById("nm_start");
 				var nmEnd = document.getElementById("nm_end");
 				var sld_brightness = document.getElementById("brightness");
+				var sld_nm_brightness = document.getElementById("nm_brightness");
 				var sld_brightnessFrame = document.getElementById("brightnessFrame");
 				var sld_colorshiftspeed = document.getElementById("colorshiftspeed");
 				var ckb_resetWifi = document.querySelector('input[id="ResetWifi"]');
@@ -675,6 +681,8 @@ <h1 id="headline">WORDCLOCK 2.0</h1>
 				cmdstr += "-";
 				cmdstr += sld_colorshiftspeed.value;
 				cmdstr += "-";
+				cmdstr += sld_nm_brightness.value;
+				cmdstr += "-";
 				cmdstr += sld_brightnessFrame.value;
 				console.log(cmdstr);
 				sendCommand(cmdstr);
diff --git a/ntp_client_plus.cpp b/ntp_client_plus.cpp
@@ -314,6 +314,26 @@ unsigned int NTPClientPlus::getDayOfWeek()
     return this->_dayOfWeek;
 }
 
+/**
+ * @brief Getter for day of the month
+ * 
+ * @return unsigned int 
+ */
+unsigned int NTPClientPlus::getDayOfMonth()
+{
+    return this->_dateDay;
+}
+
+/**
+ * @brief Getter for the month number
+ * 
+ * @return unsigned int 
+ */
+unsigned int NTPClientPlus::getMonthNumber()
+{
+    return this->_dateMonth;
+}
+
 /**
  * @brief Function to calc current year
  * 
diff --git a/ntp_client_plus.h b/ntp_client_plus.h
@@ -33,6 +33,8 @@ class NTPClientPlus{
         String getFormattedDate();
         void calcDate();
         unsigned int getDayOfWeek();
+        unsigned int getDayOfMonth();
+        unsigned int getMonthNumber();
         unsigned int getYear();
         bool isLeapYear(unsigned int year);
         int getMonth(int dayOfYear);
diff --git a/wordclock_esp8266.ino b/wordclock_esp8266.ino
@@ -48,23 +48,41 @@
 //                                        CONSTANTS
 // ----------------------------------------------------------------------------------
 
-#define EEPROM_SIZE 32      // size of EEPROM to save persistent variables
-#define ADR_NM_START_H 0
-#define ADR_NM_END_H 1
-#define ADR_NM_START_M 2
-#define ADR_NM_END_M 3
-#define ADR_BRIGHTNESS 4
-#define ADR_MC_RED 5
-#define ADR_MC_GREEN 6
-#define ADR_MC_BLUE 7
-#define ADR_BRIGHTNESS_FRAME 10
-#define ADR_FRAMELIGHTACTIVE 11
-#define ADR_STATE 26
-#define ADR_NM_ACTIVATED 27
-#define ADR_COLSHIFTSPEED 28
-#define ADR_COLSHIFTACTIVE 29
-#define ADR_HOURANIMATION 30
-
+#define EEPROM_VERSION_CODE   3  // Change this value when defaults settings change
+
+// EEPROM address map (all uint8_t, 1 byte each)
+#define EEPROM_SIZE          14  // size of EEPROM to save persistent variables
+#define ADR_EEPROM_VERSION    0  // uint8_t
+#define ADR_NM_START_H        1  // uint8_t
+#define ADR_NM_END_H          2  // uint8_t
+#define ADR_NM_START_M        3  // uint8_t
+#define ADR_NM_END_M          4  // uint8_t
+#define ADR_BRIGHTNESS        5  // uint8_t
+#define ADR_MC_RED            6  // uint8_t
+#define ADR_MC_GREEN          7  // uint8_t
+#define ADR_MC_BLUE           8  // uint8_t
+#define ADR_STATE             9  // uint8_t
+#define ADR_NM_ACTIVATED     10  // uint8_t
+#define ADR_COLSHIFTSPEED    11  // uint8_t
+#define ADR_COLSHIFTACTIVE   12  // uint8_t
+#define ADR_NM_BRIGHTNESS    13  // uint8_t
+#define ADR_HOURANIMATION    14  // uint8_t
+#define ADR_BRIGHTNESS_FRAME 15  // uint8_t
+#define ADR_FRAMELIGHTACTIVE 16  // uint8_t
+
+// DEFAULT SETTINGS (if one changes this, also increment the EEPROM_VERSION_CODE, to ensure that the EEPROM is updated with the new defaults)
+#define DEFAULT_NM_START_HOUR 22 // default start hour of nightmode (0-23)
+#define DEFAULT_NM_START_MIN 5   // default start minute of nightmode (0-59)
+#define DEFAULT_NM_END_HOUR 7    // default end hour of nightmode (0-23)
+#define DEFAULT_NM_END_MIN 0     // default end minute of nightmode (0-59)
+#define DEFAULT_BRIGHTNESS 40    // default brightness of LEDs (10-255)
+#define DEFAULT_MC_RED 200       // default main color red value
+#define DEFAULT_MC_GREEN 200     // default main color green value
+#define DEFAULT_MC_BLUE 0        // default main color blue value
+#define DEFAULT_NM_ACTIVATED 1   // if function nightmode is activated (0 = deactivated, 1 = activated)
+#define DEFAULT_NM_BRIGHTNESS 0 // default brightness during night mode (0-255)
+#define DEFAULT_COLSHIFT_SPEED 1 // needs to be between larger than 0 (1 = slowest, 255 = fastest)
+#define DEFAULT_COLSHIFT_ACTIVE 0 // if dynamic color shift is active (0 = deactivated, 1 = activated)
 
 #define NEOPIXELPIN 5       // pin to which the NeoPixels are attached
 #define NEOPIXELPIN_FRAME 4 // pin to which the NeoPixels for the frame light are attached
@@ -166,7 +184,7 @@ const uint32_t colors24bit[NUM_COLORS] = {
   LEDMatrix::Color24bit(0, 128, 0), 
   LEDMatrix::Color24bit(0, 0, 255) };
 
-uint8_t brightness = 40;            // current brightness of leds
+uint8_t brightness = DEFAULT_BRIGHTNESS;            // current brightness of leds
 uint8_t brightnessFrame = 40;       // brightness of leds for frame light
 bool animationDir = false;
 
@@ -191,27 +209,28 @@ Tetris mytetris = Tetris(&ledmatrix, &logger);
 Snake mysnake = Snake(&ledmatrix, &logger);
 Pong mypong = Pong(&ledmatrix, &logger);
 
-float filterFactor = DEFAULT_SMOOTHING_FACTOR;// stores smoothing factor for led transition
-uint8_t currentState = st_clock;              // stores current state
-bool stateAutoChange = false;                 // stores state of automatic state change
-bool nightMode = false;                       // stores state of nightmode
-bool nightModeActivated = true;               // stores if the function nightmode is activated (its not the state of nightmode)
-bool ledOff = false;                          // stores state of led off
-uint32_t maincolor_clock = colors24bit[2];    // color of the clock and digital clock
-uint32_t maincolor_snake = colors24bit[1];    // color of the random snake animation
-bool apmode = false;                          // stores if WiFi AP mode is active
-bool dynColorShiftActive = false;              // stores if dynamic color shift is active
-uint8_t dynColorShiftPhase = 0;               // stores the phase of the dynamic color shift
-uint8_t dynColorShiftSpeed = 1;               // stores the speed of the dynamic color shift -> used to calc update period
+float filterFactor = DEFAULT_SMOOTHING_FACTOR;        // stores smoothing factor for led transition
+uint8_t currentState = st_clock;                      // stores current state
+bool stateAutoChange = false;                         // stores state of automatic state change
+bool nightMode = false;                               // stores state of nightmode
+bool nightModeActivated = DEFAULT_NM_ACTIVATED;       // stores if the function nightmode is activated (its not the state of nightmode)
+bool ledOff = false;                                  // stores state of led off
+uint32_t maincolor_clock = colors24bit[2];            // color of the clock and digital clock
+uint32_t maincolor_snake = colors24bit[1];            // color of the random snake animation
+bool apmode = false;                                  // stores if WiFi AP mode is active
+bool dynColorShiftActive = DEFAULT_COLSHIFT_ACTIVE;   // stores if dynamic color shift is active
+uint8_t dynColorShiftPhase = 0;                       // stores the phase of the dynamic color shift
+uint8_t dynColorShiftSpeed = DEFAULT_COLSHIFT_SPEED;  // stores the speed of the dynamic color shift -> used to calc update period
 bool hourAnimation = false;                   // stores if the hour animation is active
 uint32_t hourAnimationDuration = 18000;           // stores the duration of the hour animation in seconds
 bool frameLightActive = false;                // stores if frame light is active
 
 // nightmode settings
-uint8_t nightModeStartHour = 22;
-uint8_t nightModeStartMin = 0;
-uint8_t nightModeEndHour = 7;
-uint8_t nightModeEndMin = 0;
+uint8_t nightModeStartHour = DEFAULT_NM_START_HOUR;
+uint8_t nightModeStartMin = DEFAULT_NM_START_MIN;
+uint8_t nightModeEndHour = DEFAULT_NM_END_HOUR;
+uint8_t nightModeEndMin = DEFAULT_NM_END_MIN;
+uint8_t nightModeBrightness = DEFAULT_NM_BRIGHTNESS;
 
 // Watchdog counter to trigger restart if NTP update was not possible 30 times in a row (5min)
 int watchdogCounter = 30;
@@ -233,6 +252,25 @@ void setup() {
   //Init EEPROM
   EEPROM.begin(EEPROM_SIZE);
 
+  // Check EEPROM version code
+  uint8_t storedVersion = EEPROM.read(ADR_EEPROM_VERSION);
+  if (storedVersion != EEPROM_VERSION_CODE) {
+    // Set new defaults
+    EEPROM.write(ADR_EEPROM_VERSION, EEPROM_VERSION_CODE);
+    EEPROM.write(ADR_NM_START_H, DEFAULT_NM_START_HOUR);
+    EEPROM.write(ADR_NM_START_M, DEFAULT_NM_START_MIN);
+    EEPROM.write(ADR_NM_END_H, DEFAULT_NM_END_HOUR);
+    EEPROM.write(ADR_NM_END_M, DEFAULT_NM_END_MIN);
+    EEPROM.write(ADR_BRIGHTNESS, DEFAULT_BRIGHTNESS);
+    setMainColor(DEFAULT_MC_RED, DEFAULT_MC_GREEN, DEFAULT_MC_BLUE);
+    EEPROM.write(ADR_STATE, st_clock);
+    EEPROM.write(ADR_NM_ACTIVATED, DEFAULT_NM_ACTIVATED);
+    EEPROM.write(ADR_COLSHIFTSPEED, DEFAULT_COLSHIFT_SPEED);
+    EEPROM.write(ADR_COLSHIFTACTIVE, DEFAULT_COLSHIFT_ACTIVE);
+    EEPROM.write(ADR_NM_BRIGHTNESS, DEFAULT_NM_BRIGHTNESS);
+    EEPROM.commit();
+  }
+
   // configure button pin as input
   pinMode(BUTTONPIN, INPUT_PULLUP);
 
@@ -375,6 +413,7 @@ void setup() {
   loadNightmodeSettingsFromEEPROM();
   loadBrightnessSettingsFromEEPROM();
   loadColorShiftStateFromEEPROM();
+  loadNightmodeBrightnessFromEEPROM();
   loadHourAnimationSettingsFromEEPROM();
   
   if(ESP.getResetReason().equals("Power On") || ESP.getResetReason().equals("External System")){
@@ -461,15 +500,23 @@ void loop() {
   }
 
   // handle state behaviours (trigger loopCycles of different states depending on current state)
-  if(!nightMode && !ledOff && (millis() - lastStep > behaviorUpdatePeriod) && (millis() - lastLEDdirect > TIMEOUT_LEDDIRECT)){
+  if(!ledOff && (millis() - lastStep > behaviorUpdatePeriod) && (millis() - lastLEDdirect > TIMEOUT_LEDDIRECT)){
     updateStateBehavior(currentState);    
     lastStep = millis();
   }
 
-  // Turn off LEDs if ledOff is true or nightmode is active
-  if((ledOff || nightMode) && !waitForTimeAfterReboot){
+  // Turn off LEDs if ledOff is true
+  if(ledOff && !waitForTimeAfterReboot){
     ledmatrix.gridFlush();
   }
+  
+  // Apply night mode brightness
+  if(nightMode && !ledOff && !waitForTimeAfterReboot){
+    ledmatrix.setBrightness(nightModeBrightness);
+  }
+  else if(!nightMode && !ledOff && !waitForTimeAfterReboot){
+    ledmatrix.setBrightness(brightness);
+  }
 
   // periodically write colors to matrix
   if(millis() - lastAnimationStep > PERIOD_MATRIXUPDATE && !waitForTimeAfterReboot && (millis() - lastLEDdirect > TIMEOUT_LEDDIRECT)){
@@ -483,7 +530,7 @@ void loop() {
   handleButton();
 
   // handle state changes
-  if(stateAutoChange && (millis() - lastStateChange > PERIOD_STATECHANGE) && !nightMode && !ledOff){
+  if(stateAutoChange && (millis() - lastStateChange > PERIOD_STATECHANGE) && !ledOff){
     // increment state variable and trigger state change
     stateChange((currentState + 1) % NUM_STATES, false);
     
@@ -940,6 +987,16 @@ void loadColorShiftStateFromEEPROM()
   logger.logString("ColorShiftActive: " + String(dynColorShiftActive));
 }
 
+/**
+ * @brief Load the night mode brightness from EEPROM
+ *
+ */
+void loadNightmodeBrightnessFromEEPROM()
+{
+  nightModeBrightness = EEPROM.read(ADR_NM_BRIGHTNESS);
+  logger.logString("Night mode brightness: " + String(nightModeBrightness));
+}
+
 /**
  * @brief load the hour animation setting from EEPROM
  * 
@@ -1023,7 +1080,8 @@ void handleCommand() {
     nightModeEndMin = split(timestr, '-', 3).toInt();
     brightness = split(timestr, '-', 4).toInt();
     dynColorShiftSpeed = split(timestr, '-', 5).toInt();
-    brightnessFrame = split(timestr, '-', 6).toInt();
+    nightModeBrightness = split(timestr, '-', 6).toInt();
+    brightnessFrame = split(timestr, '-', 7).toInt();
     if(nightModeStartHour < 0 || nightModeStartHour > 23) nightModeStartHour = 22;
     if(nightModeStartMin < 0 || nightModeStartMin > 59) nightModeStartMin = 0;
     if(nightModeEndHour < 0 || nightModeEndHour > 23) nightModeEndHour = 7;
@@ -1038,12 +1096,14 @@ void handleCommand() {
     EEPROM.write(ADR_BRIGHTNESS, brightness);
     EEPROM.write(ADR_BRIGHTNESS_FRAME, brightnessFrame);
     EEPROM.write(ADR_COLSHIFTSPEED, dynColorShiftSpeed);
+    EEPROM.write(ADR_NM_BRIGHTNESS, nightModeBrightness);
     EEPROM.commit();
     logger.logString("Nightmode starts at: " + String(nightModeStartHour) + ":" + String(nightModeStartMin));
     logger.logString("Nightmode ends at: " + String(nightModeEndHour) + ":" + String(nightModeEndMin));
     logger.logString("Brightness: " + String(brightness));
     logger.logString("Brightness Frame: " + String(brightnessFrame));
     logger.logString("ColorShiftSpeed: " + String(dynColorShiftSpeed));
+    logger.logString("Night mode brightness: " + String(nightModeBrightness));
     ledmatrix.setBrightness(brightness);
     backgroundLEDStrip.setBrightness(brightnessFrame);
     lastNightmodeCheck = millis()  - PERIOD_NIGHTMODECHECK;
@@ -1214,6 +1274,8 @@ void handleDataRequest() {
       message += ",";
       message += "\"brightness\":\"" + String(brightness) + "\"";
       message += ",";
+      message += "\"nightModeBrightness\":\"" + String(nightModeBrightness) + "\"";
+      message += ",";
       message += "\"brightnessFrame\":\"" + String(brightnessFrame) + "\"";
       message += ",";
       message += "\"colorshift\":\"" + String(dynColorShiftActive) + "\"";
diff --git a/wordclockfunctions.ino b/wordclockfunctions.ino
@@ -114,7 +114,7 @@ String timeToString(uint8_t hours,uint8_t minutes){
   }
   else if(minutes >= 20 && minutes < 25)
   {
-    message += "ZEHN VOR HALB "; 
+    message += "ZWANZIG NACH ";
   }
   else if(minutes >= 25 && minutes < 30)
   {
@@ -130,7 +130,7 @@ String timeToString(uint8_t hours,uint8_t minutes){
   }
   else if(minutes >= 40 && minutes < 45)
   {
-    message += "ZEHN NACH HALB ";
+    message += "ZWANZIG VOR ";
   }
   else if(minutes >= 45 && minutes < 50)
   {
@@ -150,7 +150,7 @@ String timeToString(uint8_t hours,uint8_t minutes){
   {
       hours -= 12;
   }
-  if(minutes >= 20)
+  if(minutes >= 25)
   {
       hours++;
   }

Original file line number	Diff line number	Diff line change
`@@ -114,7 +114,7 @@ String timeToString(uint8_t hours,uint8_t minutes){`
`114`	`114`	`}`
`115`	`115`	`else if(minutes >= 20 && minutes < 25)`
`116`	`116`	`{`
`117`		`- message += "ZEHN VOR HALB ";`
	`117`	`+ message += "ZWANZIG NACH ";`
`118`	`118`	`}`
`119`	`119`	`else if(minutes >= 25 && minutes < 30)`
`120`	`120`	`{`
`@@ -130,7 +130,7 @@ String timeToString(uint8_t hours,uint8_t minutes){`
`130`	`130`	`}`
`131`	`131`	`else if(minutes >= 40 && minutes < 45)`
`132`	`132`	`{`
`133`		`- message += "ZEHN NACH HALB ";`
	`133`	`+ message += "ZWANZIG VOR ";`
`134`	`134`	`}`
`135`	`135`	`else if(minutes >= 45 && minutes < 50)`
`136`	`136`	`{`
`@@ -150,7 +150,7 @@ String timeToString(uint8_t hours,uint8_t minutes){`
`150`	`150`	`{`
`151`	`151`	`hours -= 12;`
`152`	`152`	`}`
`153`		`- if(minutes >= 20)`
	`153`	`+ if(minutes >= 25)`
`154`	`154`	`{`
`155`	`155`	`hours++;`
`156`	`156`	`}`