Add strip off refresh option in LED settings. (wled#2259)

* Add strip off refresh option in LED settings.
New strip initialization logic.
Minor code clen-up.

* Dev code removal.

* Missing ethernet include

* Renamed mainseg to selseg

* Fix for preset cycling bounds.

* "Preset 0" bugfix.

* Auto segments only if segments were not modified

Co-authored-by: cschwinne <[email protected]>

Author: blazoncek

wled00/FX.h

@@ -619,7 +619,7 @@ class WS2812FX {
     }
 
     void
-      finalizeInit(uint16_t countPixels),
+      finalizeInit(),
       service(void),
       blur(uint8_t),
       fill(uint32_t),
@@ -636,7 +636,8 @@ class WS2812FX {
       trigger(void),
       setSegment(uint8_t n, uint16_t start, uint16_t stop, uint8_t grouping = 0, uint8_t spacing = 0),
       resetSegments(),
-      populateDefaultSegments(),
+      makeAutoSegments(),
+      fixInvalidSegments(),
       setPixelColor(uint16_t n, uint32_t c),
       setPixelColor(uint16_t n, uint8_t r, uint8_t g, uint8_t b, uint8_t w = 0),
       show(void),
@@ -650,6 +651,7 @@ class WS2812FX {
       gammaCorrectCol = true,
       applyToAllSelected = true,
       setEffectConfig(uint8_t m, uint8_t s, uint8_t i, uint8_t p),
+      checkSegmentAlignment(void),
       // return true if the strip is being sent pixel updates
       isUpdating(void);
 

wled00/FX_fcn.cpp

@@ -65,25 +65,22 @@
 #endif
 
 //do not call this method from system context (network callback)
-void WS2812FX::finalizeInit(uint16_t countPixels)
+void WS2812FX::finalizeInit(void)
 {
   RESET_RUNTIME;
-  _length = countPixels;
+  isRgbw = isOffRefreshRequred = false;
 
-  //if busses failed to load, add default (FS issue...)
+  //if busses failed to load, add default (fresh install, FS issue, ...)
   if (busses.getNumBusses() == 0) {
     const uint8_t defDataPins[] = {DATA_PINS};
     const uint16_t defCounts[] = {PIXEL_COUNTS};
     const uint8_t defNumBusses = ((sizeof defDataPins) / (sizeof defDataPins[0]));
     const uint8_t defNumCounts = ((sizeof defCounts)   / (sizeof defCounts[0]));
     uint16_t prevLen = 0;
-    for (uint8_t i = 0; i < defNumBusses; i++) {
+    for (uint8_t i = 0; i < defNumBusses && i < WLED_MAX_BUSSES; i++) {
       uint8_t defPin[] = {defDataPins[i]};
       uint16_t start = prevLen;
-      uint16_t count = _length;
-      if (defNumBusses > 1 && defNumCounts) {
-        count = defCounts[(i < defNumCounts) ? i : defNumCounts -1];
-      }
+      uint16_t count = defCounts[(i < defNumCounts) ? i : defNumCounts -1];
       prevLen += count;
       BusConfig defCfg = BusConfig(DEFAULT_LED_TYPE, defPin, start, count, COL_ORDER_GRB);
       busses.add(defCfg);
@@ -92,60 +89,30 @@ void WS2812FX::finalizeInit(uint16_t countPixels)
 
   deserializeMap();
 
-  uint16_t segStarts[MAX_NUM_SEGMENTS] = {0};
-  uint16_t segStops [MAX_NUM_SEGMENTS] = {0};
-
-  setBrightness(_brightness);
-
-  //TODO make sure segments are only refreshed when bus config actually changed (new settings page)
-  uint8_t s = 0;
-  for (uint8_t i = 0; i < busses.getNumBusses(); i++) {
-    Bus* b = busses.getBus(i);
-
-    if (autoSegments) { //make one segment per bus
-      segStarts[s] = b->getStart();
-      segStops[s] = segStarts[s] + b->getLength();
-
-      //check for overlap with previous segments
-      for (uint8_t j = 0; j < s; j++) {
-        if (segStops[j] > segStarts[s] && segStarts[j] < segStops[s]) {
-          //segments overlap, merge
-          segStarts[j] = min(segStarts[s],segStarts[j]);
-          segStops [j] = max(segStops [s],segStops [j]); segStops[s] = 0;
-          s--;
-        }
-      }
-      s++;
-    }
-
+  _length = 0;
+  for (uint8_t i=0; i<busses.getNumBusses(); i++) {
+    Bus *bus = busses.getBus(i);
+    if (bus == nullptr) continue;
+    if (bus->getStart() + bus->getLength() > MAX_LEDS) break;
+    //RGBW mode is enabled if at least one of the strips is RGBW
+    isRgbw |= bus->isRgbw();
+    //refresh is required to remain off if at least one of the strips requires the refresh.
+    isOffRefreshRequred |= bus->isOffRefreshRequired();
+    uint16_t busEnd = bus->getStart() + bus->getLength();
+    if (busEnd > _length) _length = busEnd;
     #ifdef ESP8266
-    if ((!IS_DIGITAL(b->getType()) || IS_2PIN(b->getType()))) continue;
+    if ((!IS_DIGITAL(bus->getType()) || IS_2PIN(bus->getType()))) continue;
     uint8_t pins[5];
-    b->getPins(pins);
-    BusDigital* bd = static_cast<BusDigital*>(b);
+    if (!bus->getPins(pins)) continue;
+    BusDigital* bd = static_cast<BusDigital*>(bus);
     if (pins[0] == 3) bd->reinit();
     #endif
   }
+  ledCount = _length;
 
-  if (autoSegments) {
-    for (uint8_t i = 0; i < MAX_NUM_SEGMENTS; i++) {
-      setSegment(i, segStarts[i], segStops[i]);
-    }
-  } else {
-    //expand the main seg to the entire length, but only if there are no other segments
-    uint8_t mainSeg = getMainSegmentId();
-    
-    if (getActiveSegmentsNum() < 2) {
-      setSegment(mainSeg, 0, _length);
-    } else {
-      //there are multiple segments, leave them, but prune length to total
-      for (uint8_t i = 0; i < MAX_NUM_SEGMENTS; i++)
-      {
-        if (_segments[i].start >= _length) setSegment(i, 0, 0);
-        if (_segments[i].stop  >  _length) setSegment(i, _segments[i].start, _length);
-      }
-    }
-  }
+  //segments are created in makeAutoSegments();
+
+  setBrightness(_brightness);
 }
 
 void WS2812FX::service() {
@@ -654,23 +621,67 @@ void WS2812FX::resetSegments() {
   _segment_runtimes[0].reset();
 }
 
-void WS2812FX::populateDefaultSegments() {
-  uint16_t length = 0;
-  for (uint8_t i=0; i<busses.getNumBusses(); i++) {
-    Bus *bus = busses.getBus(i);
-    if (bus == nullptr) continue;
-    _segments[i].start = bus->getStart();
-    length += bus->getLength();
-    _segments[i].stop = _segments[i].start + bus->getLength();
-    _segments[i].mode = DEFAULT_MODE;
-    _segments[i].colors[0] = DEFAULT_COLOR;
-    _segments[i].speed = DEFAULT_SPEED;
-    _segments[i].intensity = DEFAULT_INTENSITY;
-    _segments[i].grouping = 1;
-    _segments[i].setOption(SEG_OPTION_SELECTED, 1);
-    _segments[i].setOption(SEG_OPTION_ON, 1);
-    _segments[i].opacity = 255;
+void WS2812FX::makeAutoSegments() {
+  uint16_t segStarts[MAX_NUM_SEGMENTS] = {0};
+  uint16_t segStops [MAX_NUM_SEGMENTS] = {0};
+
+  if (autoSegments) { //make one segment per bus
+    uint8_t s = 0;
+    for (uint8_t i = 0; i < busses.getNumBusses(); i++) {
+      Bus* b = busses.getBus(i);
+
+      segStarts[s] = b->getStart();
+      segStops[s] = segStarts[s] + b->getLength();
+
+      //check for overlap with previous segments
+      for (uint8_t j = 0; j < s; j++) {
+        if (segStops[j] > segStarts[s] && segStarts[j] < segStops[s]) {
+          //segments overlap, merge
+          segStarts[j] = min(segStarts[s],segStarts[j]);
+          segStops [j] = max(segStops [s],segStops [j]); segStops[s] = 0;
+          s--;
+        }
+      }
+      s++;
+    }
+    for (uint8_t i = 0; i < MAX_NUM_SEGMENTS; i++) {
+      setSegment(i, segStarts[i], segStops[i]);
+    }
+  } else {
+    //expand the main seg to the entire length, but only if there are no other segments
+    uint8_t mainSeg = getMainSegmentId();
+    
+    if (getActiveSegmentsNum() < 2) {
+      setSegment(mainSeg, 0, _length);
+    }
+  }
+
+  fixInvalidSegments();
+}
+
+void WS2812FX::fixInvalidSegments() {
+  //make sure no segment is longer than total (sanity check)
+  for (uint8_t i = 0; i < MAX_NUM_SEGMENTS; i++)
+  {
+    if (_segments[i].start >= _length) setSegment(i, 0, 0); 
+    if (_segments[i].stop  >  _length) setSegment(i, _segments[i].start, _length);
+  }
+}
+
+//true if all segments align with a bus, or if a segment covers the total length
+bool WS2812FX::checkSegmentAlignment() {
+  for (uint8_t i = 0; i < MAX_NUM_SEGMENTS; i++)
+  {
+    if (_segments[i].start >= _segments[i].stop) continue; //inactive segment
+    bool aligned = false;
+    for (uint8_t b = 0; b<busses.getNumBusses(); b++) {
+      Bus *bus = busses.getBus(b);
+      if (_segments[i].start == bus->getStart() && _segments[i].stop == bus->getStart() + bus->getLength()) aligned = true;
+    }
+    if (_segments[i].start == 0 && _segments[i].stop == _length) aligned = true;
+    if (!aligned) return false;
   }
+  return true;
 }
 
 //After this function is called, setPixelColor() will use that segment (offsets, grouping, ... will apply)

wled00/bus_manager.h

@@ -24,6 +24,10 @@
   #define DEBUG_PRINTF(x...)
 #endif
 
+#define GET_BIT(var,bit)    (((var)>>(bit))&0x01)
+#define SET_BIT(var,bit)    ((var)|=(uint16_t)(0x0001<<(bit)))
+#define UNSET_BIT(var,bit)  ((var)&=(~(uint16_t)(0x0001<<(bit))))
+
 //temporary struct for passing bus configuration to bus
 struct BusConfig {
   uint8_t type = TYPE_WS2812_RGB;
@@ -32,10 +36,12 @@ struct BusConfig {
   uint8_t colorOrder = COL_ORDER_GRB;
   bool reversed = false;
   uint8_t skipAmount;
+  bool refreshReq;
   uint8_t pins[5] = {LEDPIN, 255, 255, 255, 255};
-  BusConfig(uint8_t busType, uint8_t* ppins, uint16_t pstart, uint16_t len = 1, uint8_t pcolorOrder = COL_ORDER_GRB, bool rev = false, uint8_t skip=0) {
-    type = busType; count = len; start = pstart;
-    colorOrder = pcolorOrder; reversed = rev; skipAmount = skip;
+  BusConfig(uint8_t busType, uint8_t* ppins, uint16_t pstart, uint16_t len = 1, uint8_t pcolorOrder = COL_ORDER_GRB, bool rev = false, uint8_t skip = 0) {
+    refreshReq = (bool) GET_BIT(busType,7);
+    type = busType & 0x7F;  // bit 7 may be/is hacked to include refresh info (1=refresh in off state, 0=no refresh)
+    count = len; start = pstart; colorOrder = pcolorOrder; reversed = rev; skipAmount = skip;
     uint8_t nPins = 1;
     if (type >= TYPE_NET_DDP_RGB && type < 96) nPins = 4; //virtual network bus. 4 "pins" store IP address
     else if (type > 47) nPins = 2;
@@ -120,13 +126,18 @@ class Bus {
     return false;
   }
 
+  inline bool isOffRefreshRequired() {
+    return _needsRefresh;
+  }
+
   bool reversed = false;
 
   protected:
   uint8_t _type = TYPE_NONE;
   uint8_t _bri = 255;
   uint16_t _start = 0;
   bool _valid = false;
+  bool _needsRefresh = false;
 };
 
 
@@ -143,6 +154,7 @@ class BusDigital : public Bus {
       _pins[1] = bc.pins[1];
     }
     reversed = bc.reversed;
+    _needsRefresh = bc.refreshReq || bc.type == TYPE_TM1814;
     _skip = bc.skipAmount;    //sacrificial pixels
     _len = bc.count + _skip;
     _iType = PolyBus::getI(bc.type, _pins, nr);
@@ -204,7 +216,7 @@ class BusDigital : public Bus {
   }
 
   inline bool isRgbw() {
-    return (_type == TYPE_SK6812_RGBW || _type == TYPE_TM1814);
+    return Bus::isRgbw(_type);
   }
 
   inline uint8_t skippedLeds() {
@@ -216,7 +228,7 @@ class BusDigital : public Bus {
   }
 
   void cleanup() {
-    DEBUG_PRINTLN("Digital Cleanup");
+    DEBUG_PRINTLN(F("Digital Cleanup."));
     PolyBus::cleanup(_busPtr, _iType);
     _iType = I_NONE;
     _valid = false;
@@ -326,7 +338,7 @@ class BusPwm : public Bus {
   }
 
   bool isRgbw() {
-    return (_type > TYPE_ONOFF && _type <= TYPE_ANALOG_5CH && _type != TYPE_ANALOG_3CH);
+    return Bus::isRgbw(_type);
   }
 
   inline void cleanup() {
@@ -481,7 +493,7 @@ class BusManager {
   static uint32_t memUsage(BusConfig &bc) {
     uint8_t type = bc.type;
     uint16_t len = bc.count;
-    if (type < 32) {
+    if (type > 15 && type < 32) {
       #ifdef ESP8266
         if (bc.pins[0] == 3) { //8266 DMA uses 5x the mem
           if (type > 29) return len*20; //RGBW
@@ -496,7 +508,7 @@ class BusManager {
     }
     if (type > 31 && type < 48)   return 5;
     if (type == 44 || type == 45) return len*4; //RGBW
-    return len*3;
+    return len*3; //RGB
   }
 
   int add(BusConfig &bc) {
@@ -513,7 +525,7 @@ class BusManager {
 
   //do not call this method from system context (network callback)
   void removeAll() {
-    //Serial.println("Removing all.");
+    DEBUG_PRINTLN(F("Removing all."));
     //prevents crashes due to deleting busses while in use. 
     while (!canAllShow()) yield();
     for (uint8_t i = 0; i < numBusses; i++) delete busses[i];
@@ -573,16 +585,6 @@ class BusManager {
     return len;
   }
 
-  // a workaround
-  static inline bool isRgbw(uint8_t type) {
-    return Bus::isRgbw(type);
-  }
-
-  //Return true if the strip requires a refresh to stay off.
-  static bool isOffRefreshRequred(uint8_t type) {
-    return type == TYPE_TM1814;
-  }
-
   private:
   uint8_t numBusses = 0;
   Bus* busses[WLED_MAX_BUSSES];