Always start modes with initial settings

In previous versions the board kept runtime information per mode when switching between modes. This could have odd effects, for example the "color wipe" mode could be invisible for some time when it was in the "fade out" phase when switching to the mode.
thebigpotatoe · Dec 15, 2019 · bc51b33 · bc51b33
1 parent c482d6c
commit bc51b33
Show file tree

Hide file tree

Showing 12 changed files with 139 additions and 46 deletions.
diff --git a/Super_Simple_RGB_WiFi_Lamp/LEDs.ino b/Super_Simple_RGB_WiFi_Lamp/LEDs.ino
@@ -56,6 +56,12 @@ void adjustBrightness() {
         // Clear the LEDs
         FastLED.clear();
 
+        // Initialize state of the new mode
+        auto modeIter = modes.find(Mode);
+        if (modeIter != modes.end()) {
+          modeIter->second->initialize();
+        }
+
         // Set the currentMode to Mode
         currentMode = Mode;
         modeChangeFadeAmount = 0;

diff --git a/Super_Simple_RGB_WiFi_Lamp/ModeBellCurve.ino b/Super_Simple_RGB_WiFi_Lamp/ModeBellCurve.ino
@@ -1,11 +1,18 @@
 class ModeBellCurve : public ModeBase
 {
 private:
-    int bellCurveRed   = 128;
-    int bellCurveGreen = 128;
-    int bellCurveBlue  = 128;
+    int bellCurveRed;
+    int bellCurveGreen;
+    int bellCurveBlue;
 public:
     ModeBellCurve() {}
+
+    virtual void initialize() {
+        int bellCurveRed   = 128;
+        int bellCurveGreen = 128;
+        int bellCurveBlue  = 128;
+    }
+
     virtual void render() {
         // Set the top brightness
         for (int i = 0; i < topNumLeds; i++) {

diff --git a/Super_Simple_RGB_WiFi_Lamp/ModeCircle.ino b/Super_Simple_RGB_WiFi_Lamp/ModeCircle.ino
@@ -1,9 +1,14 @@
 class ModeCircle : public ModeBase
 {
 private:
-    int circleActiveLedNumber = 0;
+    int circleActiveLedNumber;
 public:
     ModeCircle() {}
+
+    virtual void initialize() {
+        circleActiveLedNumber = 0;
+    }
+
     virtual void render() {
         // First bring our logical arrays into a list of led numbers to iterate over
         int i;

diff --git a/Super_Simple_RGB_WiFi_Lamp/ModeClock.ino b/Super_Simple_RGB_WiFi_Lamp/ModeClock.ino
@@ -1,16 +1,28 @@
 class ModeClock : public ModeBase
 {
 private:
-    int clockHourRed                 = 128;
-    int clockHourGreen               = 128;
-    int clockHourBlue                = 128;
-    int clockMinRed                  = 128;
-    int clockMinGreen                = 128;
-    int clockMinBlue                 = 128;
-    int clockOnPauseBrightness       = 255;
-    unsigned long lastClockExecution = 0;
+    int clockHourRed;
+    int clockHourGreen;
+    int clockHourBlue;
+    int clockMinRed;
+    int clockMinGreen;
+    int clockMinBlue;
+    int clockOnPauseBrightness;
+    unsigned long lastClockExecution ;
 public:
     ModeClock() {}
+
+    virtual void initialize() {
+        clockHourRed                 = 128;
+        clockHourGreen               = 128;
+        clockHourBlue                = 128;
+        clockMinRed                  = 128;
+        clockMinGreen                = 128;
+        clockMinBlue                 = 128;
+        clockOnPauseBrightness       = 255;
+        lastClockExecution = 0;
+    }
+
     virtual void render() {
         if (ntpTimeSet) {
             // Get the number of seconds between each LED

diff --git a/Super_Simple_RGB_WiFi_Lamp/ModeColorWipe.ino b/Super_Simple_RGB_WiFi_Lamp/ModeColorWipe.ino
@@ -1,15 +1,25 @@
 class ModeColorWipe : public ModeBase
 {
 private:
-    int colorWipePosition             = -1;
-    bool TurningOn                    = true;
-    int colorWipeRed                  = 255;
-    int colorWipeGreen                = 0;
-    int colorWipeBlue                 = 255;
-    int colorWipeSpeed                = 20;
+    int colorWipePosition;
+    bool TurningOn;
+    int colorWipeRed;
+    int colorWipeGreen;
+    int colorWipeBlue;
+    int colorWipeSpeed;
 
 public:
     ModeColorWipe() {}
+
+    virtual void initialize() {
+        colorWipePosition = -1;
+        TurningOn         = true;
+        colorWipeRed      = 255;
+        colorWipeGreen    = 0;
+        colorWipeBlue     = 255;
+        colorWipeSpeed    = 20;
+    }
+
     virtual void render() {
         EVERY_N_MILLISECONDS(colorWipeSpeed) {
             colorWipePosition++;

diff --git a/Super_Simple_RGB_WiFi_Lamp/ModeColour.ino b/Super_Simple_RGB_WiFi_Lamp/ModeColour.ino
@@ -1,11 +1,18 @@
 class ModeColour : public ModeBase
 {
 private:
-    int colourRed   = 128;
-    int colourGreen = 128;
-    int colourBlue  = 128;
+    int colourRed;
+    int colourGreen;
+    int colourBlue;
 public:
     ModeColour() {}
+
+    virtual void initialize() {
+        colourRed   = 128;
+        colourGreen = 128;
+        colourBlue  = 128;
+    }
+
     virtual void render() {
         fill_solid(ledString, NUM_LEDS, CRGB(colourRed, colourGreen, colourBlue));
     }

diff --git a/Super_Simple_RGB_WiFi_Lamp/ModeConfetti.ino b/Super_Simple_RGB_WiFi_Lamp/ModeConfetti.ino
@@ -1,12 +1,19 @@
 class ModeConfetti : public ModeBase
 {
 private:
-    bool confettiActive = true;
-    int confettiSpeed = 100;
-    int confettiPixel = random(NUM_LEDS);
+    bool confettiActive;
+    int confettiSpeed;
+    int confettiPixel;
 
 public:
     ModeConfetti() {}
+
+    virtual void initialize() {
+        confettiActive = true;
+        confettiSpeed = 100;
+        confettiPixel = random(NUM_LEDS);
+    }
+
     virtual void render() {
         EVERY_N_MILLISECONDS(confettiSpeed) {
           if (confettiActive) {

diff --git a/Super_Simple_RGB_WiFi_Lamp/ModeNightRider.ino b/Super_Simple_RGB_WiFi_Lamp/ModeNightRider.ino
@@ -1,12 +1,20 @@
 class ModeNightRider : public ModeBase
 {
 private:
-    int nightRiderTopLedNumber    = 0;
-    int nightRiderBottomLedNumber = 0;
-    int nightRiderTopIncrement    = 1;
-    int nightRiderBottomIncrement = 1;
+    int nightRiderTopLedNumber;
+    int nightRiderBottomLedNumber;
+    int nightRiderTopIncrement;
+    int nightRiderBottomIncrement;
 public:
     ModeNightRider() {}
+
+    virtual void initialize() {
+        nightRiderTopLedNumber    = 0;
+        nightRiderBottomLedNumber = 0;
+        nightRiderTopIncrement    = 1;
+        nightRiderBottomIncrement = 1;
+    }
+
     virtual void render() {
         int delayTime = 500 / topNumLeds;
         EVERY_N_MILLISECONDS(delayTime) {

diff --git a/Super_Simple_RGB_WiFi_Lamp/ModeRainbow.ino b/Super_Simple_RGB_WiFi_Lamp/ModeRainbow.ino
@@ -1,12 +1,20 @@
 class ModeRainbow : public ModeBase
 {
 private:
-    int rainbowStartHue   = 0;
-    int rainbowSpeed      = 10;
-    int rainbowBri        = 100;
-    float rainbowAddedHue = 0;
+    int rainbowStartHue;
+    int rainbowSpeed;
+    int rainbowBri;
+    float rainbowAddedHue;
 public:
     ModeRainbow() {}
+
+    virtual void initialize() {
+        rainbowStartHue = 0;
+        rainbowSpeed    = 10;
+        rainbowBri      = 100;
+        rainbowAddedHue = 0;
+    }
+
     virtual void render() {
         int startHue = rainbowStartHue;
         int speed = rainbowSpeed;

diff --git a/Super_Simple_RGB_WiFi_Lamp/ModeSparkle.ino b/Super_Simple_RGB_WiFi_Lamp/ModeSparkle.ino
@@ -2,14 +2,24 @@ class ModeSparkle : public ModeBase
 {
 
 private:
-    int sparkleSpeed   = 30;
-    bool sparkleActive = true;
-    int sparkleRed     = 128;
-    int sparkleGreen   = 128;
-    int sparkleBlue    = 128;
-    int sparklePixel   = random(NUM_LEDS);
+    int sparkleSpeed;
+    bool sparkleActive;
+    int sparkleRed;
+    int sparkleGreen;
+    int sparkleBlue;
+    int sparklePixel;
 public:
     ModeSparkle() {}
+
+    virtual void initialize() {
+    sparkleSpeed  = 30;
+    sparkleActive = true;
+    sparkleRed    = 128;
+    sparkleGreen  = 128;
+    sparkleBlue   = 128;
+    sparklePixel  = random(NUM_LEDS);
+    }
+
     virtual void render() {
         EVERY_N_MILLISECONDS(sparkleSpeed) {
             if (sparkleActive) {

diff --git a/Super_Simple_RGB_WiFi_Lamp/ModeVisualiser.ino b/Super_Simple_RGB_WiFi_Lamp/ModeVisualiser.ino
@@ -7,16 +7,28 @@ private:
     arduinoFFT FFT = arduinoFFT();
     double visualiserRealSamples[VISUALISER_NUM_SAMPLES];
     double visualiserImaginarySamples[VISUALISER_NUM_SAMPLES];
-    unsigned long visualiserLastSampleTime      = 0;
-    uint16_t visualiserPeriod                   = 250;
-    uint16_t visualiserMinThreshold             = 100;
-    uint16_t visualiserMaxThreshold             = 750;
-    uint8_t visualiserNumBinsToSkip             = 3;
-    uint8_t visualiserFadeUp                    = 32;
-    uint8_t visualiserFadeDown                  = 32;
-    uint8_t visualiserHueOffset                 = 170;
+    unsigned long visualiserLastSampleTime;
+    uint16_t visualiserPeriod;
+    uint16_t visualiserMinThreshold;
+    uint16_t visualiserMaxThreshold;
+    uint8_t visualiserNumBinsToSkip;
+    uint8_t visualiserFadeUp;
+    uint8_t visualiserFadeDown;
+    uint8_t visualiserHueOffset;
 public:
     ModeVisualiser() {}
+
+    virtual void initialize() {
+        visualiserLastSampleTime = 0;
+        visualiserPeriod         = 250;
+        visualiserMinThreshold   = 100;
+        visualiserMaxThreshold   = 750;
+        visualiserNumBinsToSkip  = 3;
+        visualiserFadeUp         = 32;
+        visualiserFadeDown       = 32;
+        visualiserHueOffset      = 170;
+    }
+
     virtual void render() {
         // Only use visualiser when not trying to access the NTP server
         if (((WiFi.isConnected() && ntpTimeSet) || softApStarted) && !webSocketConnecting) {

diff --git a/Super_Simple_RGB_WiFi_Lamp/Super_Simple_RGB_WiFi_Lamp.ino b/Super_Simple_RGB_WiFi_Lamp/Super_Simple_RGB_WiFi_Lamp.ino
@@ -57,6 +57,7 @@ String Password = "";
 class ModeBase
 {
 public:
+    virtual void initialize();
     virtual void render();
     virtual void applyConfig(JsonVariant& settings);
 };