Bumped version to 3.3.0. - New pattern TWINKLE. New function copyRegion(). Copied and used random8() from FastLED.

Author: ArminJo

README.md

@@ -52,6 +52,7 @@ Available as [Arduino library "NeoPatterns"](https://www.arduinolibraries.info/l
 - SCANNER_EXTENDED
 - STRIPES
 - FLASH
+- TWINKLE
 - PROCESS_SELECTIVE
 - HEARTBEAT
 - BOUNCING_BALL
@@ -90,6 +91,7 @@ the included **NeoPixel library is an extensions of the Adafruit NeoPixel librar
 - convertLinearToGamma5Color(aLinearBrightnessValue) - Returns the gamma corrected color.
 - dimColorWithGamma5(aLinearBrightnessValue, aBrightness) - like before but with additional brightness.
 - Wheel() - Returns colors from a color wheel starting ar red.
+- copyRegion() - Copy a mutiple pixels to another part of the strip. Optional do a reverse copy.
 - printConnectionInfo().<br/>
 as well as functions for getting pixel info:
 - getRedPart(color32_t color).
@@ -221,6 +223,12 @@ It also shows, how to dynamically **determine the length of the attached strip**
 <br/>
 
 # Revision History
+### Version 3.3.0
+- New pattern `TWINKLE`.
+- New functions `setCompensatedInterval()` and `copyRegion()`.
+- Member variable `Interval` is now signed.
+- Copied and used `random8()` from [FastLED](https://github.com/FastLED/FastLED/blob/master/src/lib8tion/random8.h).
+
 ### Version 3.2.0
 - Added functions `getActualNeopixelLenghtSimple()`, `clearAndShow()`, `setMatrixPixelColorAndShow()` and `testMapping()`.
 - Improved `SNOW` pattern.

examples/AllPatternsOnMultiDevices/AllPatternsOnMultiDevices.ino

@@ -5,7 +5,7 @@
  *
  *  You need to install "Adafruit NeoPixel" library under "Tools -> Manage Libraries..." or "Ctrl+Shift+I" -> use "neoPixel" as filter string
  *
- *  Copyright (C) 2018-2022  Armin Joachimsmeyer
+ *  Copyright (C) 2018-2025  Armin Joachimsmeyer
  *  [email protected]
  *
  *  This file is part of NeoPatterns https://github.com/ArminJo/NeoPatterns.

examples/MatrixPatternsTest/AVRUtils.cpp

@@ -37,26 +37,28 @@
  * Returns actual start of available / free heap
  * Usage for print:
  Serial.print(F("AvailableHeapStart=0x"));
- Serial.println((uint16_t) getAvailableHeapStart(), HEX);
+ Serial.println((uint16_t) getStartOfAvailableHeap(), HEX);
  */
-uint8_t* getAvailableHeapStart(void) {
+
+uint8_t* getStartOfAvailableHeap(void) {
     if (__brkval == 0) {
         // __brkval is 0 if no malloc() has happened before
 //        __brkval = __malloc_heap_start;
         __brkval = &__heap_start;
     }
     return (uint8_t*) __brkval;
 }
-void printAvailableHeapStart(Print *aSerial) {
+
+void printStartOfAvailableHeap(Print *aSerial) {
     aSerial->print(F("Heap start="));
-    aSerial->println((uint16_t) getAvailableHeapStart());
+    aSerial->println((uint16_t) getStartOfAvailableHeap());
 }
 
 /*
  * Initialize RAM between current stack and actual heap start (__brkval) with pattern 0x5A
  */
 void initStackFreeMeasurement() {
-    uint8_t *tHeapPtr = getAvailableHeapStart(); // This sets __brkval
+    uint8_t *tHeapPtr = getStartOfAvailableHeap(); // This sets __brkval
 
 // Fill / paint stack
     do {
@@ -79,7 +81,7 @@ int16_t getStackMaxUsedAndUnusedSizes(uint16_t *aStackUnusedSizePointer) {
      * Search for first touched value from end of current heap.
      */
     uint16_t tStackUnused = 0;
-    uint8_t *tHeapPtr = getAvailableHeapStart(); // __brkval
+    uint8_t *tHeapPtr = getStartOfAvailableHeap(); // __brkval
     while (*tHeapPtr == HEAP_STACK_UNTOUCHED_VALUE && tHeapPtr <= (uint8_t*) SP) {
         tHeapPtr++;
         tStackUnused++;
@@ -107,14 +109,14 @@ void printStackMaxUsedAndUnusedSizes(Print *aSerial) {
     aSerial->print(F(", unused="));
     aSerial->print(tStackUnusedBytes);
     aSerial->print(F(" of current total "));
-    aSerial->println((RAMEND + 1) - (uint16_t) getAvailableHeapStart());
+    aSerial->println((RAMEND + 1) - (uint16_t) getStartOfAvailableHeap());
 }
 
 /*
  * Search upwards the first two HEAP_STACK_UNTOUCHED_VALUE values after current begin of heap
  */
 uint16_t getHeapMaxUsedSize() {
-    uint8_t *tHeapPtr = getAvailableHeapStart();
+    uint8_t *tHeapPtr = getStartOfAvailableHeap();
     while (*tHeapPtr != HEAP_STACK_UNTOUCHED_VALUE && *(tHeapPtr + 1) != HEAP_STACK_UNTOUCHED_VALUE && tHeapPtr <= (uint8_t*) SP) {
         tHeapPtr++;
     }
@@ -150,7 +152,7 @@ bool printStackMaxUsedAndUnusedSizesIfChanged(Print *aSerial) {
  * Value computed depends on current stackpointer!
  */
 uint16_t getCurrentAvailableStackSize(void) {
-    uint16_t tAvailableHeapStart = (uint16_t) getAvailableHeapStart(); // __brkval
+    uint16_t tAvailableHeapStart = (uint16_t) getStartOfAvailableHeap(); // __brkval
     if (tAvailableHeapStart >= SP) {
         return 0;
     }
@@ -183,7 +185,7 @@ uint16_t getTheoreticalMaximumAvailableHeapSize(void) {
     if (RAMEND <= __malloc_margin) {
         return 0;
     }
-    return RAMEND - __malloc_margin; // (128)
+    return (RAMEND - RAMSTART) -__malloc_margin; // (128)
 }
 
 /*
@@ -194,7 +196,6 @@ void printCurrentAvailableHeapSize(Print *aSerial) {
     aSerial->println(getCurrentAvailableHeapSize());
 }
 
-
 /*
  * Simple and short implementation, does not work before initStackFreeMeasurement() or first malloc()
  * The STACK required for this function is 4 bytes, so available numbers are 4 less than for caller.
@@ -205,7 +206,7 @@ void printCurrentAvailableHeapSizeSimple(Print *aSerial) {
 }
 
 // This define is in AVRUtils.h
-// #define PRINT_AVAILABLE_HEAP    Serial.print(F("available="));Serial.println(SP - (uint16_t) __brkval + 1 - ((uint16_t) __malloc_margin + HEURISTIC_ADDITIONAL_MALLOC_MARGIN))
+//#define PRINT_AVAILABLE_HEAP   Serial.print(F("available="));Serial.println(SP - (uint16_t) __brkval + 1 - HEURISTIC_ADDITIONAL_MALLOC_MARGIN - ((uint16_t) __malloc_margin))
 
 void printBaseRAMData(Print *aSerial) {
     // __malloc_heap_end seems to be 0
@@ -245,7 +246,7 @@ void printBaseRAMData(Print *aSerial) {
 
 /*
  * RAM starts with Data, i.e. variables initialized with values != 0,
- * followed by BSS, i.e. uninitalized  variables (which are initialized with 0)
+ * followed by BSS, i.e. uninitialized variables (which are initialized with 0)
  * and variables not initialized by using attribute "__attribute__((section(".noinit")))".
  * It ends with the heap and the stack.
  *
@@ -264,14 +265,14 @@ void printRAMInfo(Print *aSerial) {
     aSerial->print((uint16_t) &__heap_start - RAMSTART);
 
     aSerial->print(F(". Heap: used="));
-    aSerial->print((uint16_t) getAvailableHeapStart() - (uint16_t) &__heap_start);
+    aSerial->print((uint16_t) getStartOfAvailableHeap() - (uint16_t) &__heap_start);
     aSerial->print(F(", max written=")); // if Stack uses total heap, we see the stack size here :-(
     aSerial->print(getHeapMaxUsedSize());
     aSerial->print(F(", max available="));
-    aSerial->print(RAMEND - (uint16_t) __malloc_margin);
+    aSerial->print(RAMEND - (uint16_t) getStartOfAvailableHeap() + 1 - (uint16_t) __malloc_margin);
 
     aSerial->print(F(". Stack: available="));
-    aSerial->print(SP - (uint16_t) getAvailableHeapStart() + 1);
+    aSerial->print(SP - (uint16_t) getStartOfAvailableHeap() + 1);
     aSerial->print(F(", used="));
     aSerial->print(RAMEND - SP);
     uint16_t tStackUnusedBytes;
@@ -280,7 +281,7 @@ void printRAMInfo(Print *aSerial) {
     aSerial->print(F(", unused="));
     aSerial->print(tStackUnusedBytes);
     aSerial->print(F(" of current total "));
-    aSerial->print((RAMEND + 1) - (uint16_t) getAvailableHeapStart()); // getAvailableHeapStart()
+    aSerial->print((RAMEND + 1) - (uint16_t) getStartOfAvailableHeap()); // getStartOfAvailableHeap()
 
     aSerial->println();
 }
@@ -302,7 +303,7 @@ bool isAddressInRAM(void *aAddressToCheck) {
 }
 
 bool isAddressBelowAvailableHeapStart(void *aAddressToCheck) {
-    return (aAddressToCheck < getAvailableHeapStart());
+    return (aAddressToCheck < getStartOfAvailableHeap());
 }
 
 /*
@@ -315,8 +316,10 @@ void testCallocSizesAndPrint(Print *aSerial) {
     while (true) {
         aSerial->print(F("SP=0x"));
         aSerial->print(SP, HEX);
+        aSerial->print(F(" available="));
+        aSerial->print(SP - (uint16_t) __brkval + 1 - ((uint16_t) __malloc_margin)- HEURISTIC_ADDITIONAL_MALLOC_MARGIN);
         aSerial->print(F(" max available="));
-        aSerial->print(SP - (uint16_t) __brkval + 1 - ((uint16_t) __malloc_margin));
+        aSerial->print(RAMEND - (uint16_t) __brkval + 1 - ((uint16_t) __malloc_margin));
         uint8_t *tMallocPtr = (uint8_t*) calloc(tMallocSize, 1);
 
         aSerial->print(F(" -> calloc("));

examples/MatrixPatternsTest/AVRUtils.h

@@ -44,7 +44,11 @@ extern void *__flp; //
 extern char __heap_start; // = __bss_end, the linker address of heap start
 #define DEFAULT_MALLOC_MARGIN   128
 
-//#define HEURISTIC_ADDITIONAL_MALLOC_MARGIN 14 // No malloc() possible if size is lower than (__malloc_margin + HEURISTIC_ADDITIONAL_MALLOC_MARGIN)
+/*
+ * The stack amount used for call of malloc(), i.e. Stack is lowered by this value before applying __malloc_margin.
+ * No malloc() possible if size at caller (stack) position is lower than (__malloc_margin + HEURISTIC_ADDITIONAL_MALLOC_MARGIN).
+ */
+#define HEURISTIC_ADDITIONAL_MALLOC_MARGIN 14
 
 /*
  * storage for millis value to enable compensation for interrupt disable at signal acquisition etc.
@@ -71,15 +75,18 @@ void sleepWithWatchdog(uint8_t aWatchdogPrescaler, bool aAdjustMillis = false);
 
 #include <Print.h>
 
-uint8_t* getAvailableHeapStart();
-void printAvailableHeapStart(Print *aSerial);
+uint8_t* getAvailableHeapStart() __attribute__ ((deprecated ("Renamed to getStartOfAvailableHeap()")));
+void printAvailableHeapStart(Print *aSerial) __attribute__ ((deprecated ("Renamed to printStartOfAvailableHeap()")));
+uint8_t* getStartOfAvailableHeap(void);
+void printStartOfAvailableHeap(Print *aSerial);
 uint16_t getCurrentAvailableStackSize(void);
 void printCurrentAvailableStackSize(Print *aSerial);
 uint16_t getCurrentAvailableHeapSize(void);
 uint16_t getTheoreticalMaximumAvailableHeapSize(void);
 void printCurrentAvailableHeapSize(Print *aSerial);
 void printCurrentAvailableHeapSizeSimple(Print *aSerial);
-#define PRINT_AVAILABLE_HEAP    Serial.print(F("available="));Serial.println(SP - (uint16_t) __brkval + 1 - ((uint16_t) __malloc_margin))
+// print available heap at current program (SP value matters) position
+#define PRINT_AVAILABLE_HEAP   Serial.print(F("available="));Serial.println(SP - (uint16_t) __brkval + 1 - HEURISTIC_ADDITIONAL_MALLOC_MARGIN - ((uint16_t) __malloc_margin))
 
 #define HEAP_STACK_UNTOUCHED_VALUE 0x5A
 void initStackFreeMeasurement();

examples/MatrixPatternsTest/MatrixPatternsTest.ino

@@ -37,7 +37,6 @@
 #endif
 //#include "HexDump.hpp"
 
-
 #define INFO
 
 #define DO_NOT_SUPPORT_RGBW // saves up to 428 bytes additional program memory for the AllPatternsOnMultiDevices() example.
@@ -46,6 +45,7 @@
 
 #define ENABLE_MATRIX_PATTERN_FIRE
 #define ENABLE_MATRIX_PATTERN_SNOW
+#define ENABLE_PATTERN_TWINKLE
 #define ENABLE_PATTERNS_FOR_SNAKE_AUTORUN
 #include <MatrixSnake.hpp>
 
@@ -97,8 +97,9 @@ bool delayAndCheckMode(uint16_t aMilliseconds);
 #define MODE_SNOW       0
 #define MODE_SNAKE      1
 #define MODE_FIRE       2
-#define MODE_ALL_COLORS 3
-#define MODE_MAX        3
+#define MODE_TWINKLE    3
+#define MODE_ALL_COLORS 4
+#define MODE_MAX        4
 #define MODE_NO_MODE  255 // in case of error
 uint8_t sCurrentMode;
 volatile bool sButtonJustPressed = false;
@@ -272,13 +273,20 @@ void loop() {
         if (sCurrentMode == MODE_SNOW) {
             NeoPixelMatrix.update(tBrightness);
             if (!sDemoModeEnabled) {
-                NeoPixelMatrix.TotalStepCounter = 3; // to enable fast ending, if demo mode is enabled again
+                // set to constant value to allow endless running
+                NeoPixelMatrix.TotalStepCounter = 3; // 3 to enable fast ending, if demo mode is enabled again
+            }
+
+        } else if (sCurrentMode == MODE_TWINKLE) {
+            NeoPixelMatrix.update(tBrightness);
+            if (!sDemoModeEnabled) {
+                NeoPixelMatrix.TotalStepCounter = 3; // 3 to enable fast ending, if demo mode is enabled again
             }
 
         } else if (sCurrentMode == MODE_SNAKE) {
             NeoPixelMatrix.update(tBrightness);
             if (!sDemoModeEnabled) {
-                NeoPixelMatrix.Repetitions = 1; // to enable fast ending, if demo mode is enabled again
+                NeoPixelMatrix.Repetitions = 1; // 1 to enable fast ending, if demo mode is enabled again
             }
 
         } else if (sCurrentMode == MODE_ALL_COLORS) {
@@ -359,13 +367,14 @@ bool startPattern(uint8_t aNewMode) {
     if (aNewMode == MODE_SNOW) {
         return NeoPixelMatrix.Snow(1000, 20);
 
+    } else if (aNewMode == MODE_TWINKLE) {
+        NeoPixelMatrix.Twinkle(COLOR32_SPECIAL, NeoPixelMatrix.getNumberOfPixels() / 4, 50, 60);
+        return true;
+
     } else if (aNewMode == MODE_SNAKE) {
         return initSnakeAutorun(&NeoPixelMatrix, 200, COLOR32_BLUE, 2);
 
     } else if (aNewMode == MODE_FIRE) {
-#if defined(USE_16_X_16_MATRIX)
-        set__malloc_margin(120); // 2 bytes stack are unused then :-)
-#endif
         return NeoPixelMatrix.Fire(800, 30);
     }
     return true;
@@ -406,7 +415,6 @@ void switchMode() {
  * Handler for automatically playing all patterns
  */
 void DemoModeHandler(NeoPatterns *aLedsPtr) {
-    (void) aLedsPtr;
 
     Serial.println();
     Serial.print(F("Old mode="));
@@ -421,8 +429,12 @@ void DemoModeHandler(NeoPatterns *aLedsPtr) {
      * Start new pattern
      */
     if (!startPattern(sCurrentMode)) {
-        Serial.println(F("Not enough heap available"));
-        sCurrentMode = MODE_NO_MODE;
+        Serial.print(F("Not enough heap available for new mode "));
+        printlnMode(sCurrentMode);
+#if defined(__AVR__)
+        printRAMInfo(&Serial);
+#endif
+        DemoModeHandler(aLedsPtr); // Try next pattern
     } else {
         Serial.print(F("New mode="));
         printlnMode(sCurrentMode);
@@ -438,6 +450,8 @@ void printlnMode(uint8_t aMode) {
         Serial.println(F("Snow"));
     } else if (aMode == MODE_SNAKE) {
         Serial.println(F("Snake"));
+    } else if (aMode == MODE_TWINKLE) {
+        Serial.println(F("Twinkle"));
     } else if (aMode == MODE_FIRE) {
         Serial.println(F("Fire"));
     } else if (aMode == MODE_ALL_COLORS) {

library.json

@@ -1,6 +1,6 @@
 {
   "name": "NeoPatterns",
-  "version": "3.2.0",
+  "version": "3.3.0",
   "description": "Patterns for NeoPixel strips and matrixes including the patterns of the NeoPattern example by Adafruit.",
   "keywords": "NeoPixel, adafruit",
   "homepage": "https://github.com/ArminJo/NeoPatterns",

library.properties

@@ -1,9 +1,9 @@
 name=NeoPatterns
-version=3.2.0
+version=3.3.0
 author=Armin Joachimsmeyer
 maintainer=Armin Joachimsmeyer <[email protected]>
 sentence=Patterns for NeoPixel strips and matrixes including the patterns of the NeoPattern example by Adafruit.
-paragraph=Patterns from Adafruit are: SCANNER, STRIPES, DELAY, PROCESS_SELECTIVE, FADE_SELECTIVE. The original SCANNER pattern is extended and includes the CYLON as well as the ROCKET or FALLING_STAR pattern. The more versatile STRIPES pattern replaces the old THEATER_CHASE one. NeoPixel-Matrix pattern are: MOVING_PICTURE, MOVE, TICKER, FIRE, SNOW, SNAKE.
+paragraph=Patterns not from Adafruit are: SCANNER, STRIPES, FLASH, TWINKLE, DELAY, PROCESS_SELECTIVE, FADE_SELECTIVE. The original SCANNER pattern is extended and includes the CYLON as well as the ROCKET or FALLING_STAR pattern. The more versatile STRIPES pattern replaces the old THEATER_CHASE one. NeoPixel-Matrix pattern are: MOVING_PICTURE, MOVE, TICKER, FIRE, SNOW, SNAKE.
 category=Display
 url=https://github.com/ArminJo/NeoPatterns
 architectures=avr,megaavr,esp8266,esp32,stm32,STM32F1

src/ADCUtils.hpp

@@ -32,6 +32,9 @@
 #define STR_HELPER(x) #x
 #define STR(x) STR_HELPER(x)
 #endif
+#if !defined(BITS_PER_BYTE)
+#define BITS_PER_BYTE 8
+#endif
 
 /*
  * By replacing this value with the voltage you measured a the AREF pin after a conversion

src/Colors.h

@@ -76,6 +76,7 @@ typedef uint32_t color32_t;
 #define COLOR32_BLACK          COLOR32(0,0,0)
 
 #define COLOR32_WHITE          COLOR32(255,255,255)
+#define COLOR32_SPECIAL        (COLOR32(255,255,255) - 1) // To signal special color treatment e.g. use random color
 #define COLOR32_WHITE_HALF     COLOR32(128,128,128) // to reduce power consumption
 #define COLOR32_WHITE_QUARTER  COLOR32(64,64,64)    // to reduce power consumption
 #define COLOR32_WHITE_EIGHTH   COLOR32(32,32,32)    // to reduce power consumption