Merge branch 'dev'

Author: tfeldmann

CHANGELOG.md

@@ -1,5 +1,12 @@
 # Changelog
 
+## v2.2.0 (2021-12-17)
+
+- Fixes a bug where no default speed is set
+- Fixes a bug in the SerialBlink example where `Serial.begin()` is not called
+- `BaseFader` now supports custom value ranges (default = 255)
+- Small code speedup in `BaseFader`
+
 ## v2.1.0 (2021-12-16)
 
 - Removed default speeds from methods

examples/SerialBlink/SerialBlink.ino

@@ -10,7 +10,6 @@ class SerialBlinker : public BaseBlinker
 public:
     void write(int state) override
     {
-        Serial.print("LED: ");
         Serial.println(state);
     }
 };
@@ -19,6 +18,7 @@ SerialBlinker myBlinker;
 
 void setup()
 {
+    Serial.begin(9600);
     myBlinker.pattern(2, 4);
 }
 

library.json

@@ -1,6 +1,6 @@
 {
     "name": "Blinkenlight",
-    "version": "2.1.0",
+    "version": "2.2.0",
     "description": "This library gives you non-blocking blinking patterns and smooth fade effects for your LEDs, buzzers or any other status indicators",
     "keywords": "led, signal, fading, blink",
     "repository": {

library.properties

@@ -1,5 +1,5 @@
 name=Blinkenlight
-version=2.1.0
+version=2.2.0
 author=Thomas Feldmann <mail@tfeldmann.de>
 maintainer=Thomas Feldmann <mail@tfeldmann.de>
 sentence=Supercharge your status LEDs / beepers

src/BaseBlinker.cpp

@@ -5,6 +5,7 @@ BaseBlinker::BaseBlinker()
 {
     permanent(LOW);
     write(LOW);
+    setSpeed(SPEED_FAST);
 }
 
 void BaseBlinker::setSpeed(uint16_t on_ms)

src/BaseFader.h

@@ -28,36 +28,36 @@ static const uint8_t LED_LOG_CURVE[256] = {
 class BaseFader : public BaseBlinker
 {
 public:
-    BaseFader(bool logarithmic = false, int fadeSpeed = 30)
+    BaseFader(bool logarithmic = false, int fadeSpeed = 30, int range = 255)
         : BaseBlinker(),
           output_(0),
-          fadeSpeed_(abs(fadeSpeed)),
+          lastUpdate_(millis()),
           logarithmic_(logarithmic),
-          lastUpdate_(millis())
+          fadeSpeed_(abs(fadeSpeed)),
+          range_(range)
     {
     }
 
     int update()
     {
         int state = BaseBlinker::update();
-        uint32_t time = millis();
-        if (time - lastUpdate_ > 10)
+        uint32_t ms = millis();
+
+        if (ms - lastUpdate_ > 10)
         {
-            lastUpdate_ = time;
-            int diff = state * 255 - output_;
-            output_ += constrain(diff, -fadeSpeed_, fadeSpeed_);
+            lastUpdate_ = ms;
+            int diff = state * range_ - output_;
 
-            // only write changes
+            // we only call `write` on changes
             if (diff)
             {
+                output_ += constrain(diff, -fadeSpeed_, fadeSpeed_);
                 int result = logarithmic_ ? LED_LOG_CURVE[output_] : output_;
                 write(result);
                 return result;
             }
         }
-        if (logarithmic_)
-            return LED_LOG_CURVE[output_];
-        return output_;
+        return logarithmic_ ? LED_LOG_CURVE[output_] : output_;
     }
 
     virtual void write(int state)
@@ -75,7 +75,9 @@ class BaseFader : public BaseBlinker
 
 private:
     int output_;
-    uint8_t fadeSpeed_;
-    bool logarithmic_;
     uint32_t lastUpdate_;
+
+    bool logarithmic_;
+    int fadeSpeed_;
+    int range_;
 };