immediate stopping of effects

+ smaller API

only core business in lib

Author: bertmelis

.travis.yml

@@ -1,6 +1,6 @@
 # esp32WS2811
 
-Arduino Library for ESP32 to drive WS2811/WS2811 RGB leds using the RMT peripheral.
+Arduino Library for ESP32 to drive WS2811/WS2812 RGB leds using the RMT peripheral. The lib is lean and only drives the leds.
 
 ## Hardware
 
@@ -59,60 +59,33 @@ void setup() {
 Change LED colours:
 
 ```C++
+Colour colour = yourLedString.getPixel(size_t index);  // gives you the Colour of the led on index.
 yourLedString.setPixel(size_t index, uint32_t red, uint32_t green, uint32_t blue);
-yourLedString.show();  // this updates the LEDs
+yourLedString.show();  // this actually makes the LEDs light up
 ```
 
 A number of helpers methods are available:
 
 ```C++
-void clearAll();  // turns off all LEDs
-void setAll(uint32_t red, uint32_t green, uint32_t blue);  // gives all LEDs the specified colour
-void set Bightness (uint8_t brightness, bool reset = false)  // set maximum brightness (in %), reset updates immediately
+yourLedString.clearAll();  // turns off all LEDs
+yourLedString.setAll(Colour colour);  // // gives all LEDs the specified colour
+yourLedString.setAll(uint32_t red, uint32_t green, uint32_t blue);  // gives all LEDs the specified colour
 ```
 
 Keep in mind that all these methods require to call `show()` afterwards.
 
 ## Effects
 
-Starting and stopping an effect is done by.
+Starting and stopping an effect is done by:
 
 ```C++
 void startEffect(WS2811Effect* effect);
 void stopEffect();
 ```
 
-You don't have to stop a runnign effect before starting a new one.
-
-Available effects are in the "Effects" directory. Creating your own is done by creating an effect class:
-
-```C++
-// this effect will light a random LED, delay and turn off
-class MyNewEffect : public WS2811Effect {
- public:
-  explicit FadeColours(int delay) :
-    _delay(delay) {}
-  void run(WS2811* strip, size_t numLeds) {
-    strip->clearAll();  // clear all, we don't know the current state...
-    strip->show();
-    strip->setPixel(random(0, numLeds), 0, 255, 0);
-    strip->show();
-    delay(_delay);
-  }
-
- private:
-  int _delay;
-};
-```
-
-using this effect in your code as follows:
-
-```C++
-MyNewEffect myNewEffect(500);  // make sure it doesn't go out of scope
-ws2811.startEffect(&myNewEffect);
-```
+You don't have to stop a running effect before starting a new one. The effect stops immediately and does not wait for it's routine to complete.
 
 # Credits
 
 The RMT driver for WS2811/WS2812 comes from @nkolban [https://github.com/nkolban/esp32-snippets](https://github.com/nkolban/esp32-snippets).
-Effects are heavily inspired and copied from [https://www.tweaking4all.com/hardware/arduino/adruino-led-strip-effects/](https://www.tweaking4all.com/hardware/arduino/adruino-led-strip-effects/)
+Effects are heavily inspired and/or copied from [https://www.tweaking4all.com/hardware/arduino/adruino-led-strip-effects/](https://www.tweaking4all.com/hardware/arduino/adruino-led-strip-effects/)

README.md

@@ -5,8 +5,6 @@
 
 #include <esp32WS2811.h>
 
-BlinkLed signal({0, 127, 0}, 1, 500);
-
 WS2811 ws2811(18, 50);
 std::vector<WS2811Effect*> effects;
 Ticker timer;
@@ -22,20 +20,17 @@ void setup() {
   Serial.println("Booting");
 
   // add effects
-  effects.push_back(new TwinkleRandom(10, 1000));
-  effects.push_back(new RandomColours(1000));
-  effects.push_back(new RandomColours(100));
-  effects.push_back(new FadeColours(100, 1000));
-  effects.push_back(new LarsonScanner({255, 0, 0}, 4, 10, 5));
-  effects.push_back(new SnowSparkle({20, 17, 10}, 3, 100, 500));
+  effects.push_back(new Circus(1000));
+  effects.push_back(new SnowSparkle({82, 56, 13}, 3, 100, 500));
 
   // output enable level shifter
   pinMode(23, OUTPUT);
   digitalWrite(23, HIGH);
 
+  // start led strip
   ws2811.begin();
-  ws2811.startEffect(&signal);
 
+  // effect starts in 15 seconds...
   timer.attach(15, nextEffect);
 }
 

examples/allEffects/allEffects.ino

@@ -4,27 +4,27 @@
 
 WS2811	KEYWORD1
 
-TwinkleRandom	KEYWORD1
 RandomColours	KEYWORD1
-FadeColours	KEYWORD1
-LarsonScanner	KEYWORD1
-BlinkLed	KEYWORD1
 
 #######################################
 # Methods and Functions (KEYWORD2)
 #######################################
 
 begin	KEYWORD2
+numLeds	KEYWORD2
 show	KEYWORD2
 setPixel	KEYWORD2
+getPixel	KEYWORD2
 clearAll	KEYWORD2
 setAll	KEYWORD2
-setBrightness	KEYWORD2
 startEffect	KEYWORD2
 stopEffect	KEYWORD2
 
 #######################################
 # Constants (LITERAL1)
 #######################################
 
-#CONSTANT	LITERAL2
+
+#######################################
+# Constants (LITERAL2)
+#######################################

keywords.txt

@@ -1,5 +1,5 @@
 {
-  "name": "esp32WS2811oWiFi",
+  "name": "esp32WS2811",
   "version": "0.1.0",
   "keywords": "Arduino, esp32, WS2811, WS2812, RMT",
   "description": "Arduino library for ESP32 to drive WS2811 LEDs using the RMT peripheral",

library.json

@@ -22,17 +22,21 @@ SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 
 */
 
-#include "RandomColours.h"
+#include "Circus.h"
 
-RandomColours::RandomColours(uint32_t delay) :
-  _delay(delay) {}
+Circus::Circus(uint32_t interval) :
+  _interval(interval) {}
 
-void RandomColours::run(WS2811* ws2811, size_t numLeds) {
-  Colour colour;
+void Circus::_setup() {
+  _ledstrip->clearAll();
+  _ledstrip->show();
+}
+
+void Circus::_loop() {
+  size_t numLeds = _ledstrip->numLeds();
   for (size_t i = 0; i < numLeds; ++i) {
-    colour = colours[random(0, 13)];
-    ws2811->setPixel(i, colour.red, colour.green, colour.blue);
+    _ledstrip->setPixel(i, colours[random(0, 12)]);
   }
-  ws2811->show();
-  delay(_delay);
+  _ledstrip->show();
+  delay(_interval);
 }

src/Effects/BlinkLed.h

@@ -22,18 +22,21 @@ SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 
 */
 
-#include "BlinkLed.h"
-
-BlinkLed::BlinkLed(Colour colour, size_t pixel, uint32_t delay) :
-  _colour(colour),
-  _pixel(pixel),
-  _delay(delay) {}
-
-void BlinkLed::run(WS2811* ws2811, size_t numLeds) {
-  ws2811->setAll(0, 0, 0);
-  ws2811->show();
-  delay(_delay);
-  ws2811->setPixel(0, _colour.red, _colour.green, _colour.blue);
-  ws2811->show();
-  delay(_delay);
-}
+#pragma once
+
+#include <stddef.h>
+#include <Arduino.h>  // millis, random...
+#include "Effect.h"
+#include "Colour.h"
+
+class Circus : public WS2811Effect {
+ public:
+  explicit Circus(uint32_t interval);
+
+ private:
+  void _setup();
+  void _loop();
+
+ private:
+  uint32_t _interval;
+};

src/Effects/RandomColours.cpp renamed to src/Effects/Circus.cpp

@@ -34,12 +34,6 @@ Colour::Colour(uint8_t r, uint8_t g, uint8_t b) :
   green(g),
   blue(b) {}
 
-Colour::Colour(const Colour& c) {
-  red = c.red;
-  green = c.green;
-  blue = c.blue;
-}
-
 Colour colours[] {
   {0xFF, 0x00, 0x00},  /// red
   {0x80, 0x00, 0x00},  /// maroon

src/Effects/BlinkLed.cpp renamed to src/Effects/Circus.h

@@ -53,12 +53,6 @@ class Colour {
    */
   Colour(uint8_t r, uint8_t g, uint8_t b);
 
-  /**
-   * @brief Copy constructor.
-   * 
-   * @param c Colour to be copied
-   */
-  Colour(const Colour& c);
   uint8_t red;    ///< red value, 0-255
   uint8_t green;  ///< green value, 0-255
   uint8_t blue;   ///< blue value, 0-255

src/Effects/Colour.cpp

@@ -0,0 +1,27 @@
+#include "Effect.h"
+
+WS2811Effect::WS2811Effect() :
+  _task(nullptr),
+  _ledstrip(nullptr) {}
+
+WS2811Effect::~WS2811Effect() {
+  stop();
+}
+
+void WS2811Effect::start(WS2811* ledstrip) {
+  _ledstrip = ledstrip;
+  xTaskCreate((TaskFunction_t)&_effectTask, "effectTask", 2048, this, 1, &_task);
+}
+
+void WS2811Effect::stop() {
+  if (!_task) return;
+  vTaskDelete(_task);
+}
+
+void WS2811Effect::_effectTask(WS2811Effect* e) {
+  e->_setup();
+  while(1) {
+    e->_loop();
+  }
+  vTaskDelete(nullptr);
+}