Clean up

Author: stnkl

src/Config.h

@@ -50,17 +50,17 @@ class ConfigClass
 
   /// Initialize config object by mounting file system and
   /// reading the config file.
-  /// @return True if successfull
+  /// @return True if successful
   bool initialize();
 
   /// Save config to file system
-  /// @return True if successfull
+  /// @return True if successful
   bool save();
 
   /// Parse a JSON char array and apply its values to the
   /// config state.
   /// @param input JSON char array
-  /// @return True if successfull
+  /// @return True if successful
   bool parseJson(const char *input);
 
   /// Get config state contained in a DynamicJsonDocument

src/Fade.cpp

@@ -1,5 +1,4 @@
 #include "Fade.h"
-
 #include "FastLEDHub.h"
 #include "SerialOut.h"
 
@@ -14,7 +13,6 @@ namespace Fade
 {
 
 FadeMode mode = FadeMode::NONE;
-uint16_t fadeBrightness = 0;
 uint16_t targetBrightness = 0;
 Ticker fadeTicker;
 Ticker debounce;
@@ -31,35 +29,35 @@ void handle()
     return;
 
   int8_t hour, minute;
-  if (!getTime(&hour, &minute))
+  if (!getCurrentTime(&hour, &minute))
     return;
 
   if (Config.alarmEnabled && hour == Config.alarmHour && minute == Config.alarmMinute)
   {
-    Fade::begin(Fade::FadeMode::ALARM);
+    Fade::begin(FadeMode::ALARM);
   }
   else if (Config.sunsetEnabled && hour == Config.sunsetHour && minute == Config.sunsetMinute && FastLEDHub.isDim())
   {
-    Fade::begin(Fade::FadeMode::SUNSET);
+    Fade::begin(FadeMode::SUNSET);
   }
 }
 
 void begin(FadeMode fadeMode)
 {
   mode = fadeMode;
   targetBrightness = FastLEDHub.brightness10;
-  fadeBrightness = 0;
-  FastLEDHub.show(fadeBrightness);
+  FastLEDHub.brightness10 = 0;
+  FastLEDHub.show();
 
   debounce.once(61, [&](){ debounce.detach(); });
 
-  if (fadeMode == Fade::FadeMode::ALARM)
+  if (fadeMode == FadeMode::ALARM)
   {
     FastLEDHub.begin(FastLEDHub.getAnimation(Config.alarmAnimation));
     fadeTicker.attach_ms(Config.alarmDuration * 60 * 1000 / 1024, tick);
     PRINTLN("[FastLEDHub] Start fade 'Alarm'");
   }
-  else if (fadeMode == Fade::FadeMode::SUNSET)
+  else if (fadeMode == FadeMode::SUNSET)
   {
     FastLEDHub.begin(FastLEDHub.getAnimation(Config.sunsetAnimation));
     fadeTicker.attach_ms(Config.sunsetDuration * 60 * 1000 / targetBrightness, tick);
@@ -78,26 +76,26 @@ void tick()
   if (FastLEDHub.status == PAUSED)
     return;
 
-  if (mode == Fade::FadeMode::ALARM && fadeBrightness == 1023)
+  if (mode == FadeMode::ALARM && FastLEDHub.brightness10 == 1023)
   {
     if (Config.postAlarmAnimation != Config.alarmAnimation)
       FastLEDHub.begin(FastLEDHub.getAnimation(Config.postAlarmAnimation));
 
     stop();
     PRINTLN("[FastLEDHub] End fade 'Alarm'");
   }
-  else if (mode == Fade::FadeMode::SUNSET && fadeBrightness == targetBrightness)
+  else if (mode == FadeMode::SUNSET && FastLEDHub.brightness10 == targetBrightness)
   {
     stop();
     PRINTLN("[FastLEDHub] End fade 'Sunset'");
   }
   else
   {
-    fadeBrightness++;
-    PRINTLN("[FastLEDHub] Fade brightness: " + String(fadeBrightness));
+    FastLEDHub.brightness10++;
+    PRINTLN("[FastLEDHub] Fade brightness: " + String(FastLEDHub.brightness10));
   }
 
-  FastLEDHub.brightness10 = fadeBrightness;
+  FastLEDHub.brightness10 = FastLEDHub.brightness10;
 }
 
 void getSunsetTime()
@@ -133,7 +131,7 @@ void getSunsetTime()
   }
 }
 
-bool getTime(int8_t *hour, int8_t *minute)
+bool getCurrentTime(int8_t *hour, int8_t *minute)
 {
   time_t n = time(nullptr);
 

src/Fade.h

@@ -12,19 +12,19 @@ namespace Fade
 
 enum class FadeMode
 {
-  NONE = 0,
+  NONE,
   ALARM,
   SUNSET
 };
 
 extern FadeMode mode;
 
+void tick();
 void handle();
 void begin(FadeMode fadeMode);
 void stop();
-void tick();
 void initialize();
 void getSunsetTime();
-bool getTime(int8_t *hour, int8_t *minute);
+bool getCurrentTime(int8_t *hour, int8_t *minute);
 
 } // namespace Fade

src/FastLEDHub.cpp

@@ -1,9 +1,8 @@
-#include "FastLEDHub.h"
-
 #include "Animation.h"
 #include "ColorUtils.h"
 #include "Config.h"
 #include "Fade.h"
+#include "FastLEDHub.h"
 #include "SerialOut.h"
 #include "Webserver.h"
 #include "WebSocket.h"