1/8 Scan Panel Example

6 files changed, 338 insertions, 1 deletions

diff --git a/examples/One_Eighth_1_8_ScanPanel/OneEighthScanMatrixPanel.h b/examples/One_Eighth_1_8_ScanPanel/OneEighthScanMatrixPanel.h
new file mode 100644
index 0000000..5fc8bd7
--- /dev/null
+++ b/examples/One_Eighth_1_8_ScanPanel/OneEighthScanMatrixPanel.h
@@ -0,0 +1,211 @@
+#ifndef _ESP32_ONE_EIGTH_MATRIX_PANEL_I2S_DMA
+#define _ESP32_ONE_EIGTH_MATRIX_PANEL_I2S_DMA
+
+#include "ESP32-HUB75-MatrixPanel-I2S-DMA.h"
+
+struct VirtualCoords {
+  int16_t x;
+  int16_t y;
+};
+
+ 
+#ifdef USE_GFX_ROOT
+class OneEighthMatrixPanel : public GFX
+#elif !defined NO_GFX
+class OneEighthMatrixPanel : public Adafruit_GFX
+#else
+class OneEighthMatrixPanel
+#endif	
+{
+
+  public:
+    int16_t virtualResX;
+    int16_t virtualResY;
+
+    int16_t vmodule_rows;
+    int16_t vmodule_cols;
+
+    int16_t panelResX;
+    int16_t panelResY;
+
+    MatrixPanel_I2S_DMA *display;
+
+    OneEighthMatrixPanel(MatrixPanel_I2S_DMA &disp, int _vmodule_rows, int _vmodule_cols, int _panelResX, int _panelResY, bool serpentine_chain = true, bool top_down_chain = false)
+#ifdef USE_GFX_ROOT
+      : GFX(_vmodule_cols*_panelResX, _vmodule_rows*_panelResY)
+#elif !defined NO_GFX
+      : Adafruit_GFX(_vmodule_cols*_panelResX, _vmodule_rows*_panelResY)
+#endif            
+    {
+      this->display = &disp;
+
+      panelResX = _panelResX;
+      panelResY = _panelResY;
+
+      vmodule_rows = _vmodule_rows;
+      vmodule_cols = _vmodule_cols;
+
+      virtualResX = vmodule_cols*_panelResX;      
+      virtualResY = vmodule_rows*_panelResY;	  
+	  
+	  /* Virtual Display width() and height() will return a real-world value. For example:
+	   * Virtual Display width: 128
+	   * Virtual Display height: 64
+	   *
+	   * So, not values that at 0 to X-1
+	   */
+      _s_chain_party = serpentine_chain; // serpentine, or 'S' chain?
+      _chain_top_down= top_down_chain;
+	  
+	  coords.x = coords.y = -1; // By default use an invalid co-ordinates that will be rejected by updateMatrixDMABuffer
+
+    }
+
+    VirtualCoords getCoords(int16_t x, int16_t y);
+
+    // equivalent methods of the matrix library so it can be just swapped out.
+    virtual void drawPixel(int16_t x, int16_t y, uint16_t color);
+    virtual void fillScreen(uint16_t color); // overwrite adafruit implementation
+    void clearScreen() {
+      display->clearScreen();
+    }
+    void drawPixelRGB888(int16_t x, int16_t y, uint8_t r, uint8_t g, uint8_t b);
+    void drawIcon (int *ico, int16_t x, int16_t y, int16_t icon_cols, int16_t icon_rows);
+
+    uint16_t color444(uint8_t r, uint8_t g, uint8_t b) {
+      return display->color444(r, g, b);
+    }
+    uint16_t color565(uint8_t r, uint8_t g, uint8_t b) {
+      return display->color565(r, g, b);
+    }
+    uint16_t color333(uint8_t r, uint8_t g, uint8_t b) {
+      return display->color333(r, g, b);
+    }
+	
+	void flipDMABuffer() { display->flipDMABuffer(); }
+	
+    // Rotate display
+    inline void setRotate(bool rotate);	
+
+  private:
+    VirtualCoords coords;
+    bool _s_chain_party  = true; // Are we chained? Ain't no party like a... 
+    bool _chain_top_down = false; // is the ESP at the top or bottom of the matrix of devices?
+	bool _rotate 		 = false;
+
+}; // end Class header
+
+/**
+ * Calculate virtual->real co-ordinate mapping to underlying single chain of panels connected to ESP32.
+ * Then do further calculations for 1/8 scan panel.
+ * Updates the private class member variable 'coords', so no need to use the return value. 
+ * Not thread safe, but not a concern for ESP32 sketch anyway... I think.
+ */
+inline VirtualCoords OneEighthMatrixPanel::getCoords(int16_t x, int16_t y) {
+
+  coords.x = coords.y = -1; // By defalt use an invalid co-ordinates that will be rejected by updateMatrixDMABuffer
+
+  // Check if virtual work co-ordinates are outside the virtual display resolution space. This does NOT check
+  // against the physical real-world DMA matrix resolution / setup configured, that is used to actually output
+  // the electrical pulse to the panel.
+  
+  if (x < 0 || x >= width() || y < 0 || y >= height() ) { // Co-ordinates go from 0 to X-1 remember! width() and height() are out of range!
+    //Serial.printf("OneEighthMatrixPanel::getCoords(): Invalid virtual display coordinate. x,y: %d, %d\r\n", x, y);
+    return coords;
+  }
+  
+	 // We want to rotate?
+	 if (_rotate){
+		uint16_t temp_x=x;
+		x=y;
+		y=virtualResY-1-temp_x;
+   }  
+
+    uint8_t row = (y / panelResY) + 1; //a non indexed 0 row number
+    uint8_t col = (x / panelResX) + 1; //a non indexed 0 row number    
+    if(   ( _s_chain_party && !_chain_top_down && (row % 2 == 0) )  // serpentine vertically stacked chain starting from bottom row (i.e. ESP closest to ground), upwards
+          ||
+          ( _s_chain_party && _chain_top_down  && (row % 2 != 0) )  // serpentine vertically stacked chain starting from the sky downwards
+    )
+    {
+      // First portion gets you to the correct offset for the row you need
+      // Second portion inverts the x on the row
+	    coords.x = ((y / panelResY) * (virtualResX)) + (virtualResX - x) - 1;
+	  
+      // inverts the y the row
+      coords.y = panelResY - 1 - (y % panelResY);  
+    } 
+    else 
+    {
+	  // Normal chain pixel co-ordinate
+      coords.x = x + ((y / panelResY) * (virtualResX)) ;
+      coords.y = y % panelResY;
+    }
+	
+	/* *******
+	 * START: 1/8 Scan Panel Pixel Re-Mapping
+	 *
+	 * We have calculated the x, y co-ordinates as if we have a chain of standard panels this library is designed 
+	 * for, this being 1/8 or 1/16 scan panels. We have to do some further hacking to convert co-ords to the 
+	 * double length and 1/2 physical dma output length that is required for these panels to work electronically.
+	 */
+
+   // 1/8 Scan Panel - Is the final x-coord on the 1st or 3rd, 1/4ths (8 pixel 'blocks') of the panel (i.e. Row 0-7 or 17-24) ?
+   // Double the length of the x-coord if required
+   if ( (coords.y /8) % 2 == 0) { // returns true/1 for the 1st and 3rd 8-pixel 1/4th of a 32px high panel
+        coords.x += (panelResX*col);
+   }
+   coords.y /= 2; // half the row-coord, to match the PHYSICAL DMA configuration.
+
+  /* 
+   * END: 1/8 Scan Panel Pixel Re-Mapping
+   * *******
+   */
+
+  // Reverse co-ordinates if panel chain from ESP starts from the TOP RIGHT
+  // TODO: Remove use of underyling _cfg configuration values! 
+  if (_chain_top_down)
+  {
+    const HUB75_I2S_CFG _cfg = this->display->getCfg();
+    coords.x = (_cfg.mx_width * _cfg.chain_length - 1) - coords.x;
+    coords.y = (_cfg.mx_height-1) - coords.y;
+  
+  }   
+	
+	return coords;  
+
+}
+
+inline void OneEighthMatrixPanel::drawPixel(int16_t x, int16_t y, uint16_t color)
+{
+  //VirtualCoords coords = getCoords(x, y);	
+  getCoords(x, y);
+  this->display->drawPixel(coords.x, coords.y, color);
+}
+
+inline void OneEighthMatrixPanel::fillScreen(uint16_t color)  // adafruit virtual void override
+{
+  // No need to map this.
+  this->display->fillScreen(color);
+}
+
+inline void OneEighthMatrixPanel::drawPixelRGB888(int16_t x, int16_t y, uint8_t r, uint8_t g, uint8_t b)
+{
+  //VirtualCoords coords = getCoords(x, y);	
+  getCoords(x, y);
+  this->display->drawPixelRGB888( coords.x, coords.y, r, g, b);
+}
+
+inline void OneEighthMatrixPanel::setRotate(bool rotate) {
+	_rotate=rotate;	
+	
+	// We don't support rotation by degrees.
+	if (rotate) { setRotation(1); } else { setRotation(0); }
+}
+
+// need to recreate this one, as it wouldnt work to just map where it starts.
+inline void OneEighthMatrixPanel::drawIcon (int *ico, int16_t x, int16_t y, int16_t icon_cols, int16_t icon_rows) {
+	
+}
+
+#endif
\ No newline at end of file
diff --git a/examples/One_Eighth_1_8_ScanPanel/One_Eighth_1_8_ScanPanel.ino b/examples/One_Eighth_1_8_ScanPanel/One_Eighth_1_8_ScanPanel.ino
new file mode 100644
index 0000000..9115388
--- /dev/null
+++ b/examples/One_Eighth_1_8_ScanPanel/One_Eighth_1_8_ScanPanel.ino
@@ -0,0 +1,117 @@
+/*************************************************************************
+ * Description: 
+ * 
+ * The underlying implementation of the ESP32-HUB75-MatrixPanel-I2S-DMA only
+ * supports output to 1/16 or 1/32 scan panels - which means outputting 
+ * two lines at the same time, 16 or 32 rows apart. This cannot be changed
+ * at the DMA layer as it would require a messy and complex rebuild of the 
+ * library's DMA internals.
+ *
+ * However, it is possible to connect 1/8 scan panels to this same library and
+ * 'trick' the output to work correctly on these panels by way of adjusting the
+ * pixel co-ordinates that are 'sent' to the ESP32-HUB75-MatrixPanel-I2S-DMA
+ * library (in this example, it is the 'dmaOutput' class).
+ * 
+ * Supports chaining of multiple 1/8 panels...
+ *
+ **************************************************************************/
+   
+  // Panel configuration
+  #define PANEL_RES_X 64 // Number of pixels wide of each INDIVIDUAL panel module. 
+  #define PANEL_RES_Y 32 // Number of pixels tall of each INDIVIDUAL panel module.
+  
+  #define NUM_ROWS 1 // Number of rows of chained INDIVIDUAL PANELS
+  #define NUM_COLS 1 // Number of INDIVIDUAL PANELS per ROW
+  #define PANEL_CHAIN NUM_ROWS*NUM_COLS    // total number of panels chained one to another
+  
+  // Change this to your needs, for details on VirtualPanel pls read the PDF!
+  #define SERPENT true
+  #define TOPDOWN false
+  
+  // GPIO Configuration
+  #define R1_PIN  2
+  #define G1_PIN  15
+  #define B1_PIN  4
+  #define R2_PIN  16
+  #define G2_PIN  27
+  #define B2_PIN  17
+  
+  #define A_PIN   5
+  #define B_PIN   18
+  #define C_PIN   19
+  #define D_PIN   -1 // Connected to GND on panel (21 if exist)
+  #define E_PIN   -1 // Connected to GND on panel
+  
+  #define LAT_PIN 26
+  #define OE_PIN  25
+  #define CLK_PIN 22 
+  
+  #include "OneEighthScanMatrixPanel.h" // Virtual Display to re-map co-ordinates such that they draw correctly on a32x16 1/4 Scan panel 
+  
+  // placeholder for the matrix object
+  MatrixPanel_I2S_DMA *dma_display   = nullptr;
+  
+  // placeholder for the virtual display object
+  OneEighthMatrixPanel  *virtualDisp = nullptr;
+  
+  /******************************************************************************
+   * Setup!
+   ******************************************************************************/
+  void setup() {
+    
+    delay(2000);
+    Serial.begin(115200);
+    Serial.println(""); Serial.println(""); Serial.println("");
+    Serial.println("*****************************************************");
+    Serial.println("*         1/8 Scan Panel Demonstration              *");
+    Serial.println("*****************************************************");
+  
+  
+    /******************************************************************************
+     * Create physical DMA panel class AND virtual (chained) display class.   
+     ******************************************************************************/
+  
+  	/*
+  	The configuration for MatrixPanel_I2S_DMA object is held in HUB75_I2S_CFG structure,
+  	All options has it's predefined default values. So we can create a new structure and redefine only the options we need
+  
+  	Please refer to the '2_PatternPlasma.ino' example for detailed example of how to use the MatrixPanel_I2S_DMA configuration
+  	*/
+  
+  	HUB75_I2S_CFG mxconfig(
+  				PANEL_RES_X*2,   	// DO NOT CHANGE THIS
+  				PANEL_RES_Y/2,   	// DO NOT CHANGE THIS
+  				PANEL_CHAIN    		// DO NOT CHANGE THIS
+  	);
+  
+  	//mxconfig.driver = HUB75_I2S_CFG::FM6126A;     // in case that we use panels based on FM6126A chip, we can set it here before creating MatrixPanel_I2S_DMA object
+  
+  	// OK, now we can create our matrix object
+  	dma_display = new MatrixPanel_I2S_DMA(mxconfig);
+  
+  	// let's adjust default brightness to about 75%
+  	dma_display->setBrightness8(192);    // range is 0-255, 0 - 0%, 255 - 100%
+  
+  	// Allocate memory and start DMA display
+  	if( not dma_display->begin() )
+  	  Serial.println("****** !KABOOM! I2S memory allocation failed ***********");
+  
+  	// create VirtualDisplay object based on our newly created dma_display object
+  	virtualDisp = new OneEighthMatrixPanel((*dma_display), NUM_ROWS, NUM_COLS, PANEL_RES_X, PANEL_RES_Y, SERPENT, TOPDOWN);
+  
+  	virtualDisp->setTextColor(virtualDisp->color565(0, 0, 255));
+  	virtualDisp->setCursor(0, virtualDisp->height()/2); 
+  
+  	// Red text inside red rect (2 pix in from edge)
+  	virtualDisp->print("  1234");
+  	virtualDisp->drawRect(1,1, virtualDisp->width()-2, virtualDisp->height()-2, virtualDisp->color565(255,0,0));
+  
+  	// White line from top left to bottom right
+  	virtualDisp->drawLine(0,0, virtualDisp->width()-1, virtualDisp->height()-1, virtualDisp->color565(255,255,255));
+  }
+  
+  
+  void loop() {
+    
+  
+  } // end loop
\ No newline at end of file
diff --git a/examples/One_Eighth_1_8_ScanPanel/README.md b/examples/One_Eighth_1_8_ScanPanel/README.md
new file mode 100644
index 0000000..5920f65
--- /dev/null
+++ b/examples/One_Eighth_1_8_ScanPanel/README.md
@@ -0,0 +1,9 @@
+# Using this library with 32x16 1/4 Scan Panels
+
+## Problem
+ESP32-HUB75-MatrixPanel-I2S-DMA library will not display output correctly with 1/8 scan panels such [as this](https://github.com/mrfaptastic/ESP32-HUB75-MatrixPanel-I2S-DMA/issues/154) by default.
+
+## Solution
+It is possible to connect 1/8 scan panels to this library and 'trick' the output to work correctly on these panels by way of adjusting the pixel co-ordinates that are 'sent' to the ESP32-HUB75-MatrixPanel-I2S-DMA library (in this example, it is the 'dmaOutput' class).
+
+Creation of a 'OneEighthScanMatrixPanel.h' class which sends an adjusted drawPixel() x,y co-ordinates to the underlying ESP32-HUB75-MatrixPanel-I2S-DMA library's drawPixel routine, to trick the output to look pixel perfect. 
diff --git a/examples/P6_32x16_1_4_ScanPanel/QuarterScanMatrixPanel.h b/examples/One_Quarter_1_4_ScanPanel/OneQuarterScanMatrixPanel.h
index 2a0f0e7..2a0f0e7 100644
--- a/examples/P6_32x16_1_4_ScanPanel/QuarterScanMatrixPanel.h
+++ b/examples/One_Quarter_1_4_ScanPanel/OneQuarterScanMatrixPanel.h
diff --git a/examples/P6_32x16_1_4_ScanPanel/P6_32x16_1_4_ScanPanel.ino b/examples/One_Quarter_1_4_ScanPanel/One_Quarter_1_4_ScanPanel.ino
index 7e28f5f..a3aa5a4 100644
--- a/examples/P6_32x16_1_4_ScanPanel/P6_32x16_1_4_ScanPanel.ino
+++ b/examples/One_Quarter_1_4_ScanPanel/One_Quarter_1_4_ScanPanel.ino
@@ -44,7 +44,7 @@
 #define LAT_PIN  4
 #define E_PIN  -1 // required for 1/32 scan panels
 
-#include "QuarterScanMatrixPanel.h" // Virtual Display to re-map co-ordinates such that they draw correctly on a32x16 1/4 Scan panel 
+#include "OneQuarterScanMatrixPanel.h" // Virtual Display to re-map co-ordinates such that they draw correctly on a32x16 1/4 Scan panel 
 #include <Wire.h>
 
 /* 
diff --git a/examples/P6_32x16_1_4_ScanPanel/README.md b/examples/One_Quarter_1_4_ScanPanel/README.md
index 6af1fa6..6af1fa6 100644
--- a/examples/P6_32x16_1_4_ScanPanel/README.md
+++ b/examples/One_Quarter_1_4_ScanPanel/README.md