Custom RC

Addition of the EFFECT_CUSTOM_RC return code option to identify when
specific parts of a scrolling text message has been reached.

Author: AaronLiddiment

LEDText.cpp

@@ -1,5 +1,5 @@
 /*
-LEDText V4 class by Aaron Liddiment (c) 2015
+LEDText V5 class by Aaron Liddiment (c) 2015
 
 Uses my LEDMatrix class and especially the 
 
@@ -133,7 +133,7 @@ void cLEDText::SetTextColrOptions(uint16_t Options, uint8_t ColA1, uint8_t ColA2
 
 void cLEDText::SetFrameRate(uint8_t Rate)
 {
-	m_FrameRate = Rate;
+  m_FrameRate = Rate;
 }
 
 
@@ -167,16 +167,17 @@ void cLEDText::DecodeOptions(uint16_t *tp, uint16_t *opt, uint8_t *backDim, uint
       *tp += 1;
       break;
     case UC_FRAME_RATE:
-      if ((m_XBitPos == 0) && (m_YBitPos == 0))
-        m_FrameRate = (uint8_t)m_pText[*tp + 1];
+      m_FrameRate = (uint8_t)m_pText[*tp + 1];
       *tp += 1;
       break;
     case UC_DELAY_FRAMES:
-      if ( ((m_XBitPos == 0) && (m_YBitPos == 0)) && (m_LastDelayTP < *tp) )
+      if (m_LastDelayTP < *tp)
       {
         m_LastDelayTP = *tp;
         m_DelayCounter = (m_pText[*tp + 1] << 8) + m_pText[*tp + 2];
       }
+      else if ( (m_LastDelayTP == *tp) && (m_DelayCounter == 0) )
+        m_LastDelayTP++;
       *tp += 2;
       break;
     case UC_CUSTOM_RC:
@@ -186,7 +187,7 @@ void cLEDText::DecodeOptions(uint16_t *tp, uint16_t *opt, uint8_t *backDim, uint
         *RC = m_pText[*tp + 1];
       }
       *tp += 1;
-    	break;
+      break;
     case UC_CHAR_UP:
     case UC_CHAR_DOWN:
     case UC_CHAR_LEFT:
@@ -329,13 +330,19 @@ int cLEDText::UpdateText()
         uint16_t oldopt = opt;
         DecodeOptions(&tp, &opt, &bDim, c1, c2, &cDim, &RC);
         tp++;
-        if ((m_Options & INSTANT_OPTIONS_MODE) == INSTANT_OPTIONS_MODE)
+        if ( (tp == (m_LastDelayTP + 3)) && (m_DelayCounter > 0) )
+        { // Fix to stop processing codes until delay expired
+          tp = m_pSize;
+          x = m_XMax + 1;
+        }
+        else if ((m_Options & INSTANT_OPTIONS_MODE) == INSTANT_OPTIONS_MODE)
           opt = (opt & (~SCROLL_MASK)) | (oldopt & SCROLL_MASK);
         else if ((oldopt & SCROLL_MASK) != (opt & SCROLL_MASK))
         {
           if (m_EOLtp == 0)
             m_EOLtp = tp;
           tp = m_pSize;
+          x = m_XMax + 1;
           opt = oldopt;
         }
       }

LEDText.h

@@ -72,14 +72,14 @@
 /* Binary constant generator macro By Tom Torfs - donated to the public domain */
 /* All macro's evaluate to compile-time constants */
 #ifndef HEX__
-	#define HEX__(n) 0x##n##LU
+  #define HEX__(n) 0x##n##LU
 #endif
 #ifndef B8__
-	#define B8__(x) ((x&0x0000000FLU)?1:0) +((x&0x000000F0LU)?2:0) +((x&0x00000F00LU)?4:0) +((x&0x0000F000LU)?8:0) \
-									+((x&0x000F0000LU)?16:0) +((x&0x00F00000LU)?32:0) +((x&0x0F000000LU)?64:0) +((x&0xF0000000LU)?128:0)
-	#define B8(d1)				((uint8_t)B8__(HEX__(d1)))
-	#define B16(d1,d2)		((uint8_t)B8__(HEX__(d1))),((uint8_t)B8__(HEX__(d2)))
-	#define B24(d1,d2,d3)	((uint8_t)B8__(HEX__(d1))),((uint8_t)B8__(HEX__(d2))),((uint8_t)B8__(HEX__(d3))))
+  #define B8__(x) ((x&0x0000000FLU)?1:0) +((x&0x000000F0LU)?2:0) +((x&0x00000F00LU)?4:0) +((x&0x0000F000LU)?8:0) \
+                  +((x&0x000F0000LU)?16:0) +((x&0x00F00000LU)?32:0) +((x&0x0F000000LU)?64:0) +((x&0xF0000000LU)?128:0)
+  #define B8(d1)        ((uint8_t)B8__(HEX__(d1)))
+  #define B16(d1,d2)    ((uint8_t)B8__(HEX__(d1))),((uint8_t)B8__(HEX__(d2)))
+  #define B24(d1,d2,d3) ((uint8_t)B8__(HEX__(d1))),((uint8_t)B8__(HEX__(d2))),((uint8_t)B8__(HEX__(d3))))
 #endif
 
 

examples/TextExample5/TextExample5.ino

@@ -0,0 +1,107 @@
+// This example shows the use of EFFECT_CUSTOM_RC
+// This allows you to monitor the return code of the UpdateText() call
+// for more than just 0 or -1. It allows you to set a return code of 1-255
+// when certain parts of the message reach the displayable area.
+
+#include <FastLED.h>
+
+#include <LEDMatrix.h>
+#include <LEDText.h>
+#include <FontRobotron.h>
+
+// Change the next 6 defines to match your matrix type and size
+
+#define LED_PIN        2
+#define COLOR_ORDER    GRB
+#define CHIPSET        WS2812B
+
+#define MATRIX_WIDTH   16
+#define MATRIX_HEIGHT  16
+#define MATRIX_TYPE    HORIZONTAL_MATRIX
+
+cLEDMatrix<MATRIX_WIDTH, MATRIX_HEIGHT, MATRIX_TYPE> leds;
+
+cLEDText DemoMsg;
+
+const unsigned char TxtDemo[] = { EFFECT_SCROLL_LEFT
+                                  EFFECT_FRAME_RATE "\x00"
+                                  EFFECT_BACKGND_ERASE
+                                  EFFECT_COLR_EMPTY
+                                  EFFECT_CUSTOM_RC "\x01"
+                                  "   HORIZONTAL   "
+                                  EFFECT_CUSTOM_RC "\x02"
+                                  "VERTICAL   "
+                                  EFFECT_CUSTOM_RC "\x03"
+                                  "DIAGONAL   " };
+
+void setup()
+{
+  FastLED.addLeds<CHIPSET, LED_PIN, COLOR_ORDER>(leds[0], leds.Size());
+  FastLED.setBrightness(255);
+  FastLED.clear(true);
+  delay(500);
+  FastLED.showColor(CRGB::Red);
+  delay(1000);
+  FastLED.showColor(CRGB::Lime);
+  delay(1000);
+  FastLED.showColor(CRGB::Blue);
+  delay(1000);
+  FastLED.showColor(CRGB::White);
+  delay(1000);
+  FastLED.show();
+
+  DemoMsg.SetFont(RobotronFontData);
+  DemoMsg.Init(&leds, leds.Width(), DemoMsg.FontHeight() + 1, 0, 0);
+  DemoMsg.SetText((unsigned char *)TxtDemo, sizeof(TxtDemo) - 1);
+}
+
+
+void loop()
+{
+  static uint8_t hue;
+  static int Mode = 1;
+  int16_t x, y;
+  uint8_t h;
+  int rc;
+
+  h = hue;
+  switch (Mode)
+  {
+    case 1:
+      // ** Fill LED's with horizontal stripes
+      for (y=0; y<leds.Height(); ++y)
+      {
+        leds.DrawLine(0, y, leds.Width() - 1, y, CHSV(h, 255, 255));
+        h+=16;
+      }
+      break;
+    case 2:
+      // ** Fill LED's with vertical stripes
+      for (x=0; x<leds.Width(); ++x)
+      {
+        leds.DrawLine(x, 0, x, leds.Height() - 1, CHSV(h, 255, 255));
+        h+=16;
+      }
+      break;
+    case 3:
+      // ** Fill LED's with diagonal stripes
+      for (x=0; x<(leds.Width()+leds.Height()); ++x)
+      {
+        leds.DrawLine(x - leds.Height(), leds.Height() - 1, x, 0, CHSV(h, 255, 255));
+        h+=16;
+      }
+      break;
+  }
+  hue += 4;
+
+  rc = DemoMsg.UpdateText();
+  if (rc == -1)
+  {
+    DemoMsg.SetText((unsigned char *)TxtDemo, sizeof(TxtDemo) - 1);
+    rc = DemoMsg.UpdateText();
+  }
+  if (rc > 0)
+    Mode = rc;
+  FastLED.show();
+  delay(20);
+}