Merge pull request #13 from brimshot/timing-fixes

performance

Author: brimshot

README.md

@@ -63,14 +63,7 @@ void setup() {
 
   // ~ Configure quickPatterns
 
-  // Due to a potential latching issue when writing data, we use a hard delay for timing with the ESP8266
-  #ifdef ESP8266
-  quickPatterns.setTickMillis(0);
-  #endif
-
-  #ifndef ESP8266
   quickPatterns.setTickMillis(TICKLENGTH);
-  #endif
 
   //cylon of 8 pixels that cycles through the rainbow
   quickPatterns.addPattern(new qpBouncingBars(8))
@@ -86,12 +79,9 @@ void setup() {
 
 void loop()
 {
-  quickPatterns.draw();
-  FastLED.show();
-
-  #ifdef ESP8266
-  FastLED.delay(TICKLENGTH);
-  #endif
+  // Refresh lights only when new frame data available, prevents issues with data timing on fast processors
+  if(quickPatterns.draw())
+    FastLED.show();
 }
 ```
 
@@ -130,12 +120,14 @@ void setup() {
 }
 ```
 
-Finally, in your *loop()* function, call the *draw()* method of the quickPatterns controller and then FastLED.show()
+Finally, in your *loop()* function, call the *draw()* method of the quickPatterns controller and then FastLED.show() when new frame data is available (*draw()* returns true).
+
 ```
 void loop()
 {
-  quickPatterns.draw();
-  FastLED.show();
+  // Refresh lights only when new frame data available, prevents issues with data timing on fast processors
+  if(quickPatterns.draw())
+    FastLED.show();
 }
 ```
 
@@ -765,4 +757,4 @@ Section of lights of length *size* that move back and forth randomly along the l
 ---
 Copyright (c) 2020 Chris Brim
 
-Tested platforms: ESP8266, ESP32, Teensy 3.2, Arduino Mega
+Tested platforms: ESP8266, ESP32, Teensy 3.2, Teensy 4.0, Arduino Mega

examples/bulb_lights/bulb_lights.ino

@@ -32,11 +32,11 @@ SOFTWARE.
 #include <quickPatterns.h>
 
 #define CHIPSET     WS2811
-#define PIN_A       8
+#define DATA_PIN    8
 #define NUM_LEDS    100
 #define BRIGHTNESS  32
 #define COLOR_ORDER RGB         //GRB for WS2812, RGB for WS2811
-#define TICKLENGTH  20
+#define TICKLENGTH  25
 
 CRGB leds[NUM_LEDS];
 
@@ -50,7 +50,7 @@ void setup() {
 
   // ~ Configure FastLED
 
-  FastLED.addLeds<CHIPSET, PIN_A, COLOR_ORDER>(leds, NUM_LEDS)
+  FastLED.addLeds<CHIPSET, DATA_PIN, COLOR_ORDER>(leds, NUM_LEDS)
     .setCorrection(TypicalLEDStrip)
     .setDither(BRIGHTNESS < 255);
 
@@ -63,11 +63,6 @@ void setup() {
 
   quickPatterns.setTickMillis(TICKLENGTH);
 
-  // Due to a potential latching issue when writing data, we use a hard delay for timing with the ESP8266
-  #ifdef ESP8266
-  quickPatterns.setTickMillis(0);
-  #endif
-
   // ~
 
   quickPatterns.addPattern(new qpPaletteDissolve(5))
@@ -117,21 +112,15 @@ void setup() {
   quickPatterns.sameScene().addPattern(new qpWanderingLine(30))
     .singleColor(CRGB::White);
   quickPatterns.sameLayer().setLayerBrush(MASK);    
-  
-
-
 
 }
 
 void loop()
 {
 
-  quickPatterns.draw();
-  FastLED.show();
-
-  #ifdef ESP8266
-  FastLED.delay(25);
-  #endif
+  // Refresh lights only when new frame data available, prevents issues with data timing on fast processors
+  if(quickPatterns.draw())
+    FastLED.show();
 
   EVERY_N_SECONDS(30) {
     quickPatterns.nextScene();

examples/flat_strip/flat_strip.ino

@@ -25,6 +25,10 @@ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 SOFTWARE.
 *****************************************************/
 
+#ifdef CORE_TEENSY
+#define FASTLED_ALLOW_INTERRUPTS 0
+#endif
+
 #include <quickPatterns.h>
 
 #define CHIPSET     WS2812
@@ -48,7 +52,7 @@ void setup() {
 
   // ~ Configure FastLED
 
-  FastLED.addLeds<CHIPSET, 8, COLOR_ORDER>(leds, NUM_LEDS)
+  FastLED.addLeds<CHIPSET, DATA_PIN, COLOR_ORDER>(leds, NUM_LEDS)
     .setCorrection(TypicalLEDStrip)
     .setDither(BRIGHTNESS < 255);
 
@@ -60,15 +64,7 @@ void setup() {
 
   // ~ Configure quickPatterns
 
-  // Due to a potential latching issue when writing data, we use a hard delay for timing with the ESP8266
-  #ifdef ESP8266
-  quickPatterns.setTickMillis(0);
-  #endif
-
-  #ifndef ESP8266
   quickPatterns.setTickMillis(TICKLENGTH);
-  #endif
-
 
   // ~ Scene 0 - demonstrates running simultaneous patterns at differing speeds, the same bouncing bars pattern with 3 different configurations will weave in and out of sync
 
@@ -127,7 +123,7 @@ void setup() {
   CRGB *pulseColors = new CRGB[3];
   pulseColors[0] = CRGB::Blue;
   pulseColors[1] = CRGB::Yellow;
-  pulseColors[2] = CRGB::Pink;
+  pulseColors[2] = CRGB::DeepPink;
 
   // small line of pixels that bounces back and forth
   quickPatterns.sameScene().addPattern(new qpComet(8))
@@ -174,22 +170,18 @@ void setup() {
   quickPatterns.sameLayer().setLayerBrush(MASK).continuallyFadeLayerBy(10);
 
   // small pink runner on top
-  quickPatterns.sameScene().addPattern(new qpComet(5))
-    .singleColor(CRGB::HotPink);
+  quickPatterns.sameScene().addPattern(new qpComet(5, true))
+    .singleColor(CRGB::DeepPink);
 
 }
 
 
 void loop()
 {
 
-  quickPatterns.draw();
-  FastLED.show();
-
-  //On ESP8266 boards due to FastLED latching / write issue, we set our 'tick' length to 0 (see above) and manage the global update speed via hard delay
-  #ifdef ESP8266
-  FastLED.delay(TICKLENGTH);
-  #endif
+  // Refresh lights only when new frame data available, prevents issues with data timing on fast processors
+  if(quickPatterns.draw())
+      FastLED.show();
 
   EVERY_N_SECONDS(30) {
     quickPatterns.nextScene();

quickPatterns.cpp

@@ -12,7 +12,7 @@ quickPatterns::quickPatterns(CRGB *leds, int numLeds) {
 
 // Render
 
-void quickPatterns::draw() {
+bool quickPatterns::draw() {
 
   uint32_t currentMillis = millis();
 
@@ -24,18 +24,11 @@ void quickPatterns::draw() {
 
     this->currentScene->draw(this->lightStrand->getLeds(), this->lightStrand->getNumLeds());
 
-    //double render will be slooow and also overwrite any fades.....
-    /*
-    if(transitioning) {
-      this->nextScene->draw(this->sceneBuffer, this->numLeds());
-      if((*transitionFunction)()) {
-        transitioning = false;
-        this->currentScene = this->nextScene;
-      }
-    }
-    */
+    return true;
   }
 
+  return false;
+
 }
 
 

quickPatterns.h

@@ -51,7 +51,7 @@ class quickPatterns {
 
     // ~ Rendering
 
-    void draw();
+    bool draw();
 
     void setTickMillis(int tickLengthMillis) { this->tickLengthInMillis = tickLengthMillis; }