Clean up fade

Author: stnkl

src/Config.cpp

@@ -31,7 +31,7 @@ bool ConfigClass::initialize()
   return parseJson(json);
 }
 
-bool ConfigClass::parseJson(char *input)
+bool ConfigClass::parseJson(const char *input)
 {
   DynamicJsonDocument doc(2048);
   DeserializationError error = deserializeJson(doc, input);

src/Config.h

@@ -19,19 +19,19 @@ class ConfigClass
   // Alarm functionality enabled
   bool alarmEnabled = false;
   /// Alarm duration in minutes
-  uint16_t alarmDuration = 0;
+  uint16_t alarmDuration = 1;
   /// Alarm time hour
   uint8_t alarmHour = 0;
   /// Alarm time minute
   uint8_t alarmMinute = 0;
   /// Animation during alarm duration (while the brightness increases)
-  String alarmAnimation = "";
+  String alarmAnimation = "Color";
   /// Animation triggered after the alarm duration has ended
-  String postAlarmAnimation = "";
+  String postAlarmAnimation = "Color";
   /// Sunset functionality enabled
   bool sunsetEnabled = false;
   /// Sunset duration in minutes
-  uint16_t sunsetDuration = 0;
+  uint16_t sunsetDuration = 1;
   /// Sunset time hour
   int8_t sunsetHour = 0;
   /// Sunset time minute
@@ -40,11 +40,11 @@ class ConfigClass
   /// automatically obtained local sunset time
   int16_t sunsetOffset = 0;
   /// Sunset animation
-  String sunsetAnimation = "";
+  String sunsetAnimation = "Color";
   /// Startup animation that gets triggered when powering up the device
   String startupAnimation = "";
   /// Lastly used color for Color animation
-  String color = "";
+  String color = "ffffff";
   /// Slider values
   LinkedList<int16_t> sliderValues;
 
@@ -61,7 +61,7 @@ class ConfigClass
   /// config state.
   /// @param input JSON char array
   /// @return True if successfull
-  bool parseJson(char *input);
+  bool parseJson(const char *input);
 
   /// Get config state contained in a DynamicJsonDocument
   /// @return DynamicJsonDocument containing config

src/Fade.cpp

@@ -13,12 +13,11 @@
 namespace Fade
 {
 
-FadeMode currentFade = FadeMode::NONE;
+FadeMode mode = FadeMode::NONE;
 uint16_t fadeBrightness = 0;
-uint16_t sunsetMaximumBrightness = 0;
+uint16_t targetBrightness = 0;
 Ticker fadeTicker;
-Ticker hasBeenStartedResetTicker;
-bool hasBeenStarted = false;
+Ticker debounce;
 
 void initialize()
 {
@@ -28,59 +27,31 @@ void initialize()
 
 void handle()
 {
-  // Return if fade is running
-  if (currentFade != FadeMode::NONE || hasBeenStarted)
+  if (mode != FadeMode::NONE || debounce.active())
     return;
 
-  // Get current time
-  time_t n = time(nullptr);
-  if (!n)
+  int8_t hour, minute;
+  if (!getTime(&hour, &minute))
     return;
-  struct tm *now = gmtime(&n);
-  int8_t hour = (now->tm_hour + Config.timeZone + Config.summerTime) % 24;
 
-  // Check for alarm
-  if (Config.alarmEnabled && hour == Config.alarmHour && now->tm_min == Config.alarmMinute)
+  if (Config.alarmEnabled && hour == Config.alarmHour && minute == Config.alarmMinute)
   {
     Fade::begin(Fade::FadeMode::ALARM);
   }
-  // Check for sunset
-  else if (Config.sunsetEnabled && hour == Config.sunsetHour && now->tm_min == Config.sunsetMinute)
+  else if (Config.sunsetEnabled && hour == Config.sunsetHour && minute == Config.sunsetMinute && FastLEDHub.isDim())
   {
-    // Only start sunset if all leds are off
-    if (FastLEDHub.brightness10 == 0)
-    {
-      Fade::begin(Fade::FadeMode::SUNSET);
-    }
-    else // brightness10 > 0
-    {
-      bool ledsIlluminated = false;
-      for (uint16_t i = 0; i < FastLEDHub.numLeds; i++)
-      {
-        if (FastLEDHub.hardwareLeds[i] != CRGB(0, 0, 0))
-        {
-          ledsIlluminated = true;
-          break;
-        }
-      }
-
-      if (!ledsIlluminated)
-        Fade::begin(Fade::FadeMode::SUNSET);
-    }
+    Fade::begin(Fade::FadeMode::SUNSET);
   }
 }
 
 void begin(FadeMode fadeMode)
 {
-  // Set fade starting point
-  fadeBrightness = 1;
+  mode = fadeMode;
+  targetBrightness = FastLEDHub.brightness10;
+  fadeBrightness = 0;
   FastLEDHub.show(fadeBrightness);
 
-  currentFade = fadeMode;
-
-  // Prevent starting fade multiple times
-  hasBeenStarted = true;
-  hasBeenStartedResetTicker.attach(90, [&]() { hasBeenStarted = false; }); // TODO: Should only be called once?
+  debounce.once(61, [&](){ debounce.detach(); });
 
   if (fadeMode == Fade::FadeMode::ALARM)
   {
@@ -91,42 +62,38 @@ void begin(FadeMode fadeMode)
   else if (fadeMode == Fade::FadeMode::SUNSET)
   {
     FastLEDHub.begin(FastLEDHub.getAnimation(Config.sunsetAnimation));
-    sunsetMaximumBrightness = FastLEDHub.brightness10;
-    fadeTicker.attach_ms(Config.sunsetDuration * 60 * 1000 / sunsetMaximumBrightness, tick);
+    fadeTicker.attach_ms(Config.sunsetDuration * 60 * 1000 / targetBrightness, tick);
     PRINTLN("[FastLEDHub] Start fade 'Sunset'");
   }
 }
 
 void stop()
 {
   fadeTicker.detach();
-  currentFade = FadeMode::NONE;
+  mode = FadeMode::NONE;
 }
 
 void tick()
 {
   if (FastLEDHub.status == PAUSED)
     return;
 
-  if (currentFade == Fade::FadeMode::ALARM && fadeBrightness == 1023)
+  if (mode == Fade::FadeMode::ALARM && fadeBrightness == 1023)
   {
     if (Config.postAlarmAnimation != Config.alarmAnimation)
       FastLEDHub.begin(FastLEDHub.getAnimation(Config.postAlarmAnimation));
-    fadeTicker.detach();
+
+    stop();
     PRINTLN("[FastLEDHub] End fade 'Alarm'");
   }
-  else if (currentFade == Fade::FadeMode::SUNSET && fadeBrightness == sunsetMaximumBrightness)
+  else if (mode == Fade::FadeMode::SUNSET && fadeBrightness == targetBrightness)
   {
-    fadeTicker.detach();
+    stop();
     PRINTLN("[FastLEDHub] End fade 'Sunset'");
   }
   else
   {
-    if (fadeBrightness < 1023)
-      fadeBrightness++;
-    else
-      fadeTicker.detach();
-
+    fadeBrightness++;
     PRINTLN("[FastLEDHub] Fade brightness: " + String(fadeBrightness));
   }
 
@@ -166,4 +133,18 @@ void getSunsetTime()
   }
 }
 
+bool getTime(int8_t *hour, int8_t *minute)
+{
+  time_t n = time(nullptr);
+
+  if (!n)
+    return false;
+
+  tm *now = gmtime(&n);
+  *hour = (now->tm_hour + Config.timeZone + Config.summerTime) % 24;
+  *minute = now->tm_min;
+
+  return true;
+}
+
 } // namespace Fade

src/Fade.h

@@ -17,13 +17,14 @@ enum class FadeMode
   SUNSET
 };
 
-extern FadeMode currentFade;
+extern FadeMode mode;
 
 void handle();
 void begin(FadeMode fadeMode);
 void stop();
 void tick();
 void initialize();
 void getSunsetTime();
+bool getTime(int8_t *hour, int8_t *minute);
 
 } // namespace Fade

src/FastLEDHub.cpp

@@ -33,7 +33,6 @@ void FastLEDHubClass::initialize(String projectName, uint16_t numberOfLeds)
   numLeds = numberOfLeds;
   leds = new CRGB[numLeds];
   hardwareLeds = new CRGB[numLeds];
-  brightness10 = 1023;
   Config.initialize();
   if (WiFi.status() == WL_CONNECTED)
   {
@@ -144,6 +143,22 @@ void FastLEDHubClass::clear(bool writeData)
     show();
 }
 
+bool FastLEDHubClass::isDim()
+{
+  if (brightness10 == 0)
+    return true;
+
+  for (uint16_t i = 0; i < numLeds; i++)
+  {
+    if (hardwareLeds[i] != CRGB(0, 0, 0))
+    {
+      return false;
+    }
+  }
+
+  return true;
+}
+
 void FastLEDHubClass::delay(uint16_t ms)
 {
   unsigned long start = micros();
@@ -210,7 +225,7 @@ Slider* FastLEDHubClass::getSlider(uint8_t i)
 
 void FastLEDHubClass::handleInput()
 {
-  if (potentiometerPin >= 0 && Fade::currentFade == Fade::FadeMode::NONE)
+  if (potentiometerPin >= 0 && Fade::mode == Fade::FadeMode::NONE)
   {
     // Adjust the range slightly so low and high adc values
     // span the whole 10bit brightness range

src/FastLEDHub.h

@@ -93,6 +93,10 @@ class FastLEDHubClass : public CFastLED
   /// @param scale Brightness scale to set LEDs to (0 - 255)
   void showColor(const struct CRGB &color, uint8_t scale);
 
+  /// Check if all leds are turned off (i.e. either brightness is zero or
+  /// all leds are black)
+  bool isDim();
+
   /// Clear all pixels. This function should be used in combination with
   /// FastLEDHub rather than FastLED.clear().
   /// @param writeData Wether to write out the data

src/WebSocket.cpp

@@ -43,7 +43,7 @@ void handle(uint8_t id, WStype_t type, uint8_t *payload, size_t length)
   break;
   case WStype_TEXT:
     PRINTF_VERBOSE("[%u] Got text: %s\n", id, payload);
-    handleText(byteArray2string(payload), id);
+    handleText(byteArray2String(payload), id);
     break;
   case WStype_BIN:
     PRINTF_VERBOSE("[%u] Got binary: %s\n", id, payload);
@@ -56,10 +56,7 @@ void handle(uint8_t id, WStype_t type, uint8_t *payload, size_t length)
 
 void handleText(String text, uint8_t id)
 {
-  char textArray[text.length()];
-  text.toCharArray(textArray, text.length());
-
-  if (Config.parseJson(textArray))
+  if (Config.parseJson(text.c_str()))
     Config.save();
 }
 
@@ -122,7 +119,7 @@ void handleBinary(uint8_t *binary, uint8_t id)
   }
 }
 
-String byteArray2string(uint8_t *bytes)
+String byteArray2String(uint8_t *bytes)
 {
   String s = "";
   for (uint16_t i = 0; bytes[i] != '\0'; i++)

src/WebSocket.h

@@ -35,6 +35,6 @@ void broadcastStatus();
 /// Convert a byte array to String
 /// @param bytes Byte array
 /// @return Converted String
-String byteArray2string(uint8_t *bytes);
+String byteArray2String(uint8_t *bytes);
 
 } // namespace Websocket