ScStw/ESP32-HUB75-MatrixPanel-DMA
2
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Update documentation on higher scan rate panels

Browse source 
Also breaks the VirtualMatrixPanel backward compatibility for 1/4 scan panels.
This commit is contained in:
mrfaptastic 2023-02-01 21:04:19 +00:00
parent a0f9ab6830
commit 15763b12b1
6 changed files with 105 additions and 86 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

119
README.md
View file

@ -1,4 +1,4 @@
# HUB75 RGB LED matrix library utilizing ESP32 DMA Engine # HUB75 RGB LED matrix panel library utilizing ESP32 DMA
__[BUILD OPTIONS](/doc/BuildOptions.md) | [EXAMPLES](/examples/README.md)__ | [![PlatformIO CI](https://github.com/mrfaptastic/ESP32-HUB75-MatrixPanel-DMA/actions/workflows/pio_build.yml/badge.svg)](https://github.com/mrfaptastic/ESP32-HUB75-MatrixPanel-DMA/actions/workflows/pio_build.yml) __[BUILD OPTIONS](/doc/BuildOptions.md) | [EXAMPLES](/examples/README.md)__ | [![PlatformIO CI](https://github.com/mrfaptastic/ESP32-HUB75-MatrixPanel-DMA/actions/workflows/pio_build.yml/badge.svg)](https://github.com/mrfaptastic/ESP32-HUB75-MatrixPanel-DMA/actions/workflows/pio_build.yml)
@ -28,43 +28,57 @@ __[BUILD OPTIONS](/doc/BuildOptions.md) | [EXAMPLES](/examples/README.md)__ | [!
- [Thank you!](#thank-you) - [Thank you!](#thank-you)
## Introduction ## Introduction
This ESP32 Arduino/IDF library for HUB75 / HUB75E connector type 64x32 RGB LED 1/16 Scan OR 64x64 RGB LED 1/32 Scan LED Matrix Panel, utilities the DMA functionality provided by the ESP32's 'LCD Mode'. * This is an ESP32 Arduino/IDF library for HUB75 / HUB75E RGB LED panels.
* This library 'out of the box' (mostly) supports HUB75 panels where TWO rows/lines are updated in parallel... referred to as 'two scan' panels within this library's documentation.
* 'Four scan' panels are also supported - but please refer to the Four Scan Panel example.
* The library uses the DMA functionality provided by the ESP32's 'LCD Mode' for faster output.
### Features ### Features
- **Low CPU overhead** - once initialized pixel data is pumped to the matrix inputs via DMA engine directly from memory - **Low CPU overhead** - Pixel data is sent directly with the use of hardware-backed DMA, no CPU involvement
- **Fast** - updating pixel data involves only bit-wise logic over DMA buffer memory, no pins manipulation or blocking IO - **Fast** - Updating pixel data involves only bit-wise logic over DMA buffer memory, no pins manipulation or blocking IO
- **Full screen BCM** - library utilizes [binary-code modulation](http://www.batsocks.co.uk/readme/art_bcm_5.htm) to render pixel color depth / brightness over the entire matrix - **Full screen BCM** - Library utilizes [binary-code modulation](http://www.batsocks.co.uk/readme/art_bcm_5.htm) to render pixel color depth / brightness over the entire matrix to give reasonable colour depth
- **Variable color depth** - up to TrueColor 24 bits output is possible depending on matrix size/refresh rate required - **Variable color depth** - Up to TrueColor 24 bits output is possible depending on matrix size/refresh rate required
- **CIE 1931** luminance [correction](https://ledshield.wordpress.com/2012/11/13/led-brightness-to-your-eye-gamma-correction-no/) (aka natural LED dimming) - **CIE 1931** luminance [correction](https://ledshield.wordpress.com/2012/11/13/led-brightness-to-your-eye-gamma-correction-no/) (aka natural LED dimming) implemented
- **Adafruit GFX API** - library could be build with AdafruitGFX, simplified GFX or without GFX API at all - **Adafruit GFX API** - Library can be built with AdafruitGFX, simplified GFX or without a GFX API at all
If you wanna ask "*...OK, OK, than what's the price for those features?*" I'll tell you - "[memory](/doc/memcalc.md), you pay it all by precious MCU's internal memory (SRAM) for the DMA buffer". ## ESP32 variants supported
* Original ESP32 - That being the ESP-WROOM-32 module with ESP32‑D0WDQ6 chip from ~2017.
Please use the ['Memory Calculator'](/doc/memcalc.md) to see what is actually achievable with a typical ESP32.
![Memory Calculator](doc/memcalc.jpg)
Note: Things are better for more recent ESP32 variants, refer [below](#memory-constraints) on how to use external SPIRAM/PSRAM for the DMA buffer which drives the HUB75 panels.
## ESP32 Supported
This library supports the:
* Original ESP32 - That being the ESP-WROOM-32 module with ESP32‑D0WDQ6 chip from 2017. This MCU has 520kB of SRAM which is much more than all the recent 'reboots' of the ESP32 such as the S2, S3 etc.
* ESP32-S2; and * ESP32-S2; and
* ESP32-S3 * ESP32-S3
RISC-V ESP32's (like the C3) are not, and will never be supported as they do not have parallel DMA output required for this library. RISC-V ESP32's (like the C3) are not supported as they do not have the hardware 'LCD mode' required for this library.
## Panels Supported ## Memory is required!
* 64x32 (width x height) pixel 1/16 Scan LED Matrix 'Indoor' Panel, such as this [typical RGB panel available for purchase](https://www.aliexpress.com/item/256-128mm-64-32-pixels-1-16-Scan-Indoor-3in1-SMD2121-RGB-full-color-P4-led/32810362851.html). "*What's the price for those features?*" - It's [memory](/doc/memcalc.md), you pay it all by precious MCU's internal memory (SRAM) for the DMA buffer".
* 64x64 pixel 1/32 Scan LED Matrix 'Indoor' Panel.
* 32x16 pixel 1/4 Scan LED Matrix 'Indoor' Panel using an ingenious workaround as demonstrated in the 32x16_1_4_ScanPanel example. A typical 64x32px panel at 24bpp colour uses about 20kB of internal memory.
* 126x64 [SM5266P](https://github.com/mrfaptastic/ESP32-HUB75-MatrixPanel-I2S-DMA/issues/164) 1/32 Scan Panel
Please use the ['Memory Calculator'](/doc/memcalc.md) to see what is *typically* achievable with the typical ESP32. ![Memory Calculator](doc/memcalc.jpg)
For the ESP32-S3 only, you can use SPIRAM/PSRAM to drive the HUB75 DMA buffer when using **Octal SPI-RAM** (i.e. ESP32 S3 N8R8 variant). However, due to bandwidth limitations, the maximum output frequency is limited to approx. 13Mhz, which will limit the real-world number of panels that can be chained without flicker.
To enable PSRAM support on the ESP32-S3, refer to [the build options](/doc/BuildOptions.md) to enable.
For all other ESP32 variants (like the most popular ‘original’ ESP32), [only *internal* SRAM can be used](https://github.com/mrfaptastic/ESP32-HUB75-MatrixPanel-I2S-DMA/issues/55), so you will be limited to the ~200KB or so of 'free' SRAM (because of the memory used for your sketch amongst other things) regardless of how many megabytes of SPIRAM/PSRAM you may have connected.
## Suported panels
### Parallel scan lines
* 'Two scan' panels where **two** rows/lines are updated in parallel.
* 64x32 (width x height) 'Indoor' panels, such as this [typical RGB panel available for purchase](https://www.aliexpress.com/item/256-128mm-64-32-pixels-1-16-Scan-Indoor-3in1-SMD2121-RGB-full-color-P4-led/32810362851.html). Often also referred to as 1/16 'scan panel' as every 16th row is updated in parallel (hence why I refer to it as 'two scan')
* 64x64 pixel 1/32 Scan LED Matrix 'Indoor' Panel
* 'Four scan' panels where **four** rows/lines are updated in parallel.
* 32x16 pixel 1/4 Scan LED Matrix 'Indoor' Panel using an ingenious workaround as demonstrated in the Four_Scan_Panel example.
* 126x64 [SM5266P](https://github.com/mrfaptastic/ESP32-HUB75-MatrixPanel-I2S-DMA/issues/164)
Ones interested in internals of such matrices could find [this article](https://www.sparkfun.com/news/2650) useful. Ones interested in internals of such matrices could find [this article](https://www.sparkfun.com/news/2650) useful.
Due to the high-speed optimized nature of this library, only specific panels are supported. Please do not raise issues with respect to panels not supported on the list below. Due to the high-speed optimized nature of this library, only specific panels are supported. Please do not raise issues with respect to panels not supported on the list below.
## Panel driver chips known to be working well ![Panel Scan Types](doc/ScanRateGraphic.jpg)
### Driver chips known to be working well
* ICND2012 * ICND2012
* [RUC7258](http://www.ruichips.com/en/products.html?cateid=17496) * [RUC7258](http://www.ruichips.com/en/products.html?cateid=17496)
@ -72,28 +86,19 @@ Due to the high-speed optimized nature of this library, only specific panels are
* SM5266P * SM5266P
## Panels Not Supported ## Panels Not Supported
* 1/8 Scan LED Matrix Panels are not supported.
* RUL5358 / SHIFTREG_ABC_BIN_DE based panels are not supported. * RUL5358 / SHIFTREG_ABC_BIN_DE based panels are not supported.
* ICN2053 / FM6353 based panels - Refer to [this library](https://github.com/LAutour/ESP32-HUB75-MatrixPanel-DMA-ICN2053), which is a fork of this library ( [discussion link](https://github.com/mrfaptastic/ESP32-HUB75-MatrixPanel-DMA/discussions/324)). * ICN2053 / FM6353 based panels - Refer to [this library](https://github.com/LAutour/ESP32-HUB75-MatrixPanel-DMA-ICN2053), which is a fork of this library ( [discussion link](https://github.com/mrfaptastic/ESP32-HUB75-MatrixPanel-DMA/discussions/324)).
* Any other panel not listed above. * Any other panel not listed above.
Please use an [alternative library](https://github.com/2dom/PxMatrix) if you bought one of these. Please use an [alternative library](https://github.com/2dom/PxMatrix) if you bought one of these.
## Cool uses of this library
There are a number of great looking LED graphical display projects which leverage this library, these include:
* [128x64 Morph Clock](https://github.com/bogd/esp32-morphing-clock)
* [FFT Audio Visualisation](https://github.com/mrfaptastic/ESP32-HUB75-MatrixPanel-I2S-DMA/discussions/149)
* [Clock, GIF Animator and Audio Visualiser](https://github.com/mrfaptastic/ESP32-HUB75-MatrixPanel-I2S-DMA/discussions/153)
* [Aurora Audio Visualiser](https://github.com/mrfaptastic/ESP32-HUB75-MatrixPanel-I2S-DMA/discussions/188)
* [Big Visualisation](https://github.com/mrfaptastic/ESP32-HUB75-MatrixPanel-I2S-DMA/discussions/155)
* [Clockwise](https://jnthas.github.io/clockwise/)
# Getting Started # Getting Started
## 1. Library Installation ## 1. Library Installation
* Dependency: You will need to install Adafruit_GFX from the "Library > Manage Libraries" menu. * Dependancy: You will need to install Adafruit_GFX from the "Library > Manage Libraries" menu.
* Download and unzip this repository into your Arduino/libraries folder (or better still, use the Arduino 'add library from .zip' option. * Install this library from the Arduino Library manager.
* Library also tested to work fine with PlatformIO, install into your PlatformIO projects' lib/ folder as appropriate. Or just add it into [platformio.ini](/doc/BuildOptions.md) [lib_depth](https://docs.platformio.org/en/latest/projectconf/section_env_library.html#lib-deps) section.
Library also tested to work fine with PlatformIO, install into your PlatformIO projects' lib/ folder as appropriate. Or just add it into [platformio.ini](/doc/BuildOptions.md) [lib_depth](https://docs.platformio.org/en/latest/projectconf/section_env_library.html#lib-deps) section.
## 2. Wiring the ESP32/ESP32-S2/ESP32-S3 to an LED Matrix Panel ## 2. Wiring the ESP32/ESP32-S2/ESP32-S3 to an LED Matrix Panel
@ -113,7 +118,7 @@ If you want to change the GPIO mapping at runtime, simply provide the wanted pin
#define B_PIN 19 #define B_PIN 19
#define C_PIN 5 #define C_PIN 5
#define D_PIN 17 #define D_PIN 17
#define E_PIN -1 // required for 1/32 scan panels, like 64x64. Any available pin would do, i.e. IO32 #define E_PIN -1 // required for 1/32 scan panels, like 64x64px. Any available pin would do, i.e. IO32
#define LAT_PIN 4 #define LAT_PIN 4
#define OE_PIN 15 #define OE_PIN 15
#define CLK_PIN 16 #define CLK_PIN 16
@ -136,25 +141,18 @@ Various people have created PCBs for which one can simply connect an ESP32 to a
Please contact or order these products from the respective authors. Please contact or order these products from the respective authors.
### Can I use with a larger panel (i.e. 64x64px square panel)?
If you want to use with a 64x64 pixel panel (typically a HUB75*E* panel) you MUST configure a valid *E_PIN* to your ESP32 and connect it to the E pin of the HUB75 panel! Hence the 'E' in 'HUB75E'
## 3. Run a Test Sketch ## 3. Run a Test Sketch
Below is a bare minimum sketch to draw a single white dot in the top left. You must call begin() before you call ANY pixel-drawing (fonts, lines, colours etc.) function of the MatrixPanel_I2S_DMA class. Below is a bare minimum sketch to draw a single white dot in the top left. You must call begin() before you call ANY pixel-drawing (fonts, lines, colours etc.) function of the MatrixPanel_I2S_DMA class.
Once this is working, refer to the [PIO Test Patterns](/examples/PIO_TestPatterns) example. This sketch draws simple colors/lines/gradients over the entire matrix and it could help to troubleshoot various issues with ghosting, flickering, etc... Once this is working, refer to the [PIO Test Patterns](/examples/PIO_TestPatterns) example. This sketch draws simple colors/lines/gradients over the entire matrix and it could help to troubleshoot various issues with ghosting, flickering, etc...
>Note: Requires the use of [PlatformIO](https://platformio.org/), which you should probably use if you aren't already.
# More Information
## Build-time options
Although Arduino IDE does not [seem](https://github.com/arduino/Arduino/issues/421) to offer any way of specifying compile-time options for external libs there are other IDE's (like [PlatformIO](https://platformio.org/)/[Eclipse](https://www.eclipse.org/ide/)) that could use that. Check [Build Options](doc/BuildOptions.md) document for reference.
## Memory constraints Note: Requires the use of [PlatformIO](https://platformio.org/), which you should probably use if you aren't already.
If you are going to use large/combined panels make sure to check for [memory constraints](/doc/i2s_memcalc.md).
NOTE: You can use SPIRAM/PSRAM to drive the HUB75 DMA buffer only on the ESP32-S3 and with Octal SPI-RAM (i.e. ESP32 S3 N8R8 variant). However, due to bandwidth limitations, the maximum output frequency is limited to approx. 16Mhz, which will limit the real world number of panels that can be chained without flicker being obvious. This is enabled at compile time, refer to [the build options](/doc/BuildOptions.md) to enable.
For all other ESP32 variants (like the most popular ‘original’ ESP32), [only *internal* SRAM can be used](https://github.com/mrfaptastic/ESP32-HUB75-MatrixPanel-I2S-DMA/issues/55), so you will be limited to the ~200KB or so of 'free' SRAM regardless of how many megabytes of SPIRAM/PSRAM you may have connected.
## Can I use with a larger panel (i.e. 64x64px square panel)?
If you want to use with a 64x64 pixel panel (typically a HUB75*E* panel) you MUST configure a valid *E_PIN* to your ESP32 and connect it to the E pin of the HUB75 panel! Hence the 'E' in 'HUB75E'
# Further information
## Can I chain panels? ## Can I chain panels?
Yes! Yes!
@ -168,7 +166,7 @@ Resolutions beyond 128x64 are more likely to result in crashes due to [memory](/
![ezgif com-video-to-gif](https://user-images.githubusercontent.com/12006953/89837358-b64c0480-db60-11ea-870d-4b6482068a3b.gif) ![ezgif com-video-to-gif](https://user-images.githubusercontent.com/12006953/89837358-b64c0480-db60-11ea-870d-4b6482068a3b.gif)
## Panel Brightness ## Adjusting Panel Brightness
By default you should not need to change / set the brightness value (which is 128 or 50%) as it should be sufficient for most purposes. Brightness can be changed by calling `setPanelBrightness(xx)` or `setBrightness8(xx)`. By default you should not need to change / set the brightness value (which is 128 or 50%) as it should be sufficient for most purposes. Brightness can be changed by calling `setPanelBrightness(xx)` or `setBrightness8(xx)`.
@ -185,7 +183,8 @@ Serial.begin(115200);
``` ```
![Brightness Samples](https://user-images.githubusercontent.com/55933003/211192894-f90311f5-b6fe-4665-bf26-2f363bb36047.png) ![Brightness Samples](https://user-images.githubusercontent.com/55933003/211192894-f90311f5-b6fe-4665-bf26-2f363bb36047.png)
## Build-time options
Although Arduino IDE does not [seem](https://github.com/arduino/Arduino/issues/421) to offer any way of specifying compile-time options for external libs there are other IDE's (like [PlatformIO](https://platformio.org/)/[Eclipse](https://www.eclipse.org/ide/)) that could use that. Check [Build Options](doc/BuildOptions.md) document for reference.
## Latch blanking ## Latch blanking
If you are facing issues with image ghosting when pixels has clones with horizontal offset, than you try to change Latch blanking value. Latch blanking controls for how many clock pulses matrix output is disabled via EO signal before/after toggling LAT signal. It hides row bits transitioning and different panels may require longer times for proper operation. Default value is 1 clock before/after LAT row transition. This could be controlled with `MatrixPanel_I2S_DMA::setLatBlanking(uint8_t v)`. v could be between 1 to 4, default is 1, larger values won't give any benefit other than reducing brightness. If you are facing issues with image ghosting when pixels has clones with horizontal offset, than you try to change Latch blanking value. Latch blanking controls for how many clock pulses matrix output is disabled via EO signal before/after toggling LAT signal. It hides row bits transitioning and different panels may require longer times for proper operation. Default value is 1 clock before/after LAT row transition. This could be controlled with `MatrixPanel_I2S_DMA::setLatBlanking(uint8_t v)`. v could be between 1 to 4, default is 1, larger values won't give any benefit other than reducing brightness.
@ -209,6 +208,16 @@ This project was inspired by:
* 'SmartMatrix': https://github.com/pixelmatix/SmartMatrix/tree/teensylc * 'SmartMatrix': https://github.com/pixelmatix/SmartMatrix/tree/teensylc
* Sprite_TM's demo implementation here: https://www.esp32.com/viewtopic.php?f=17&t=3188 * Sprite_TM's demo implementation here: https://www.esp32.com/viewtopic.php?f=17&t=3188
## Cool uses of this library
There are a number of great looking LED graphical display projects which leverage this library, these include:
* [128x64 Morph Clock](https://github.com/bogd/esp32-morphing-clock)
* [FFT Audio Visualisation](https://github.com/mrfaptastic/ESP32-HUB75-MatrixPanel-I2S-DMA/discussions/149)
* [Clock, GIF Animator and Audio Visualiser](https://github.com/mrfaptastic/ESP32-HUB75-MatrixPanel-I2S-DMA/discussions/153)
* [Aurora Audio Visualiser](https://github.com/mrfaptastic/ESP32-HUB75-MatrixPanel-I2S-DMA/discussions/188)
* [Big Visualisation](https://github.com/mrfaptastic/ESP32-HUB75-MatrixPanel-I2S-DMA/discussions/155)
* [Clockwise](https://jnthas.github.io/clockwise/)
# Thank you! # Thank you!
* [Brian Lough](https://www.tindie.com/stores/brianlough/) ([youtube link](https://www.youtube.com/c/brianlough)) for providing code contributions, hardware and suggestions * [Brian Lough](https://www.tindie.com/stores/brianlough/) ([youtube link](https://www.youtube.com/c/brianlough)) for providing code contributions, hardware and suggestions
* [Vortigont](https://github.com/vortigont) for his game changing code contributions and performance optimisations * [Vortigont](https://github.com/vortigont) for his game changing code contributions and performance optimisations

BIN
doc/ScanRateGraphic.jpg Normal file
View file

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 111 KiB

BIN
doc/ScanRateGraphic.odp Normal file
View file

Binary file not shown.

40
examples/One_Eight_1_8_ScanPanel/One_Eight_1_8_ScanPanel.ino → examples/Four_Scan_Panel/Four_Scan_Panel.ino
View file

@ -2,12 +2,14 @@
* Description: * Description:
* *
* The underlying implementation of the ESP32-HUB75-MatrixPanel-I2S-DMA only * The underlying implementation of the ESP32-HUB75-MatrixPanel-I2S-DMA only
* supports output to 1/16 or 1/32 scan panels - which means outputting * supports output to HALF scan panels - which means outputting
* two lines at the same time, 16 or 32 rows apart. This cannot be changed * two lines at the same time, 16 or 32 rows apart if a 32px or 64px high panel
* at the DMA layer as it would require a messy and complex rebuild of the * respectively.
* library's DMA internals. * This cannot be changed at the DMA layer as it would require a messy and complex
* rebuild of the library's internals.
* *
* However, it is possible to connect 1/8 scan panels to this same library and * However, it is possible to connect QUARTER (i.e. FOUR lines updated in parallel)
* scan panels to this same library and
* 'trick' the output to work correctly on these panels by way of adjusting the * '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 * pixel co-ordinates that are 'sent' to the ESP32-HUB75-MatrixPanel-I2S-DMA
* library. * library.
@ -39,7 +41,7 @@
MatrixPanel_I2S_DMA *dma_display = nullptr; MatrixPanel_I2S_DMA *dma_display = nullptr;
// placeholder for the virtual display object // placeholder for the virtual display object
VirtualMatrixPanel *OneEightMatrixDisplay = nullptr; VirtualMatrixPanel *FourScanPanel = nullptr;
/****************************************************************************** /******************************************************************************
* Setup! * Setup!
@ -88,11 +90,11 @@
dma_display->clearScreen(); dma_display->clearScreen();
delay(500); delay(500);
// create OneEightMatrixDisplaylay object based on our newly created dma_display object // create FourScanPanellay object based on our newly created dma_display object
OneEightMatrixDisplay = new VirtualMatrixPanel((*dma_display), NUM_ROWS, NUM_COLS, PANEL_RES_X, PANEL_RES_Y, SERPENT, TOPDOWN); FourScanPanel = new VirtualMatrixPanel((*dma_display), NUM_ROWS, NUM_COLS, PANEL_RES_X, PANEL_RES_Y, SERPENT, TOPDOWN);
// THE IMPORTANT BIT BELOW! // THE IMPORTANT BIT BELOW!
OneEightMatrixDisplay->setPhysicalPanelScanRate(ONE_EIGHT_32); FourScanPanel->setPhysicalPanelScanRate(FOUR_SCAN_32PX_HIGH);
} }
@ -111,7 +113,7 @@
// Try again using the pixel / dma memory remapper // Try again using the pixel / dma memory remapper
for (int i=PANEL_RES_X+5; i< (PANEL_RES_X*2)-1; i++) for (int i=PANEL_RES_X+5; i< (PANEL_RES_X*2)-1; i++)
{ {
OneEightMatrixDisplay->drawLine(i, 0, i, 7, dma_display->color565(0, 0, 255)); // blue FourScanPanel->drawLine(i, 0, i, 7, dma_display->color565(0, 0, 255)); // blue
delay(10); delay(10);
} }
*/ */
@ -120,10 +122,10 @@
int offset = PANEL_RES_X*((NUM_ROWS*NUM_COLS)-1); int offset = PANEL_RES_X*((NUM_ROWS*NUM_COLS)-1);
for (int i=0; i< PANEL_RES_X; i++) for (int i=0; i< PANEL_RES_X; i++)
{ {
OneEightMatrixDisplay->drawLine(i+offset, 0, i+offset, 7, dma_display->color565(0, 0, 255)); // blue FourScanPanel->drawLine(i+offset, 0, i+offset, 7, dma_display->color565(0, 0, 255)); // blue
OneEightMatrixDisplay->drawLine(i+offset, 8, i+offset, 15, dma_display->color565(0, 128,0)); // g FourScanPanel->drawLine(i+offset, 8, i+offset, 15, dma_display->color565(0, 128,0)); // g
OneEightMatrixDisplay->drawLine(i+offset, 16, i+offset, 23, dma_display->color565(128, 0,0)); // red FourScanPanel->drawLine(i+offset, 16, i+offset, 23, dma_display->color565(128, 0,0)); // red
OneEightMatrixDisplay->drawLine(i+offset, 24, i+offset, 31, dma_display->color565(0, 128, 128)); // blue FourScanPanel->drawLine(i+offset, 24, i+offset, 31, dma_display->color565(0, 128, 128)); // blue
delay(10); delay(10);
} }
@ -134,15 +136,15 @@
// This only really works for a single horizontal chain // This only really works for a single horizontal chain
for (int i = 0; i < NUM_ROWS*NUM_COLS; i++) for (int i = 0; i < NUM_ROWS*NUM_COLS; i++)
{ {
OneEightMatrixDisplay->setTextColor(OneEightMatrixDisplay->color565(255, 255, 255)); FourScanPanel->setTextColor(FourScanPanel->color565(255, 255, 255));
OneEightMatrixDisplay->setCursor(i*PANEL_RES_X+7, OneEightMatrixDisplay->height()/3); FourScanPanel->setCursor(i*PANEL_RES_X+7, FourScanPanel->height()/3);
// Red text inside red rect (2 pix in from edge) // Red text inside red rect (2 pix in from edge)
OneEightMatrixDisplay->print("Panel " + String(i+1)); FourScanPanel->print("Panel " + String(i+1));
OneEightMatrixDisplay->drawRect(1,1, OneEightMatrixDisplay->width()-2, OneEightMatrixDisplay->height()-2, OneEightMatrixDisplay->color565(255,0,0)); FourScanPanel->drawRect(1,1, FourScanPanel->width()-2, FourScanPanel->height()-2, FourScanPanel->color565(255,0,0));
// White line from top left to bottom right // White line from top left to bottom right
OneEightMatrixDisplay->drawLine(0,0, OneEightMatrixDisplay->width()-1, OneEightMatrixDisplay->height()-1, OneEightMatrixDisplay->color565(255,255,255)); FourScanPanel->drawLine(0,0, FourScanPanel->width()-1, FourScanPanel->height()-1, FourScanPanel->color565(255,255,255));
} }
delay(2000); delay(2000);

0
examples/One_Eight_1_8_ScanPanel/README.md → examples/Four_Scan_Panel/README.md
View file

30
src/ESP32-VirtualMatrixPanel-I2S-DMA.h
View file

@ -9,8 +9,16 @@
grid. grid.
However, the function of this class has expanded now to also manage However, the function of this class has expanded now to also manage
the output for 1/16 scan panels, as the core DMA library is designed the output for
ONLY FOR 1/16 scan matrix panels.
1) HALF scan panels = Two rows updated in parallel.
* 64px high panel = (incorrectly) referred to as 1/32 scan
* 32px high panel = (incorrectly) referred to as 1/16 scan
* 16px high panel = (incorrectly) referred to as 1/8 scan
2) FOUR scan panels = Four rows updated in parallel
* 32px high panel = (incorrectly) referred to as 1/8 scan
* 16px high panel = (incorrectly) referred to as 1/4 scan
YouTube: https://www.youtube.com/brianlough YouTube: https://www.youtube.com/brianlough
Tindie: https://www.tindie.com/stores/brianlough/ Tindie: https://www.tindie.com/stores/brianlough/
@ -36,9 +44,9 @@ struct VirtualCoords
enum PANEL_SCAN_RATE enum PANEL_SCAN_RATE
{ {
NORMAL_ONE_SIXTEEN, NORMAL_TWO_SCAN, NORMAL_ONE_SIXTEEN, // treated as the same
ONE_EIGHT_32, FOUR_SCAN_32PX_HIGH,
ONE_EIGHT_16 FOUR_SCAN_16PX_HIGH
}; };
#ifdef USE_GFX_ROOT #ifdef USE_GFX_ROOT
@ -129,7 +137,7 @@ protected:
bool _chain_top_down = false; // is the ESP at the top or bottom of the matrix of devices? bool _chain_top_down = false; // is the ESP at the top or bottom of the matrix of devices?
bool _rotate = false; bool _rotate = false;
PANEL_SCAN_RATE _panelScanRate = NORMAL_ONE_SIXTEEN; PANEL_SCAN_RATE _panelScanRate = NORMAL_TWO_SCAN;
}; // end Class header }; // end Class header
@ -198,18 +206,18 @@ inline VirtualCoords VirtualMatrixPanel::getCoords(int16_t &x, int16_t &y)
coords.y = (panelResY - 1) - coords.y; coords.y = (panelResY - 1) - coords.y;
} }
/* START: Pixel remapping AGAIN to convert 1/16 SCAN output that the /* START: Pixel remapping AGAIN to convert 1/2 SCAN output that the
* the underlying hardware library is designed for (because * the underlying hardware library is designed for (because
* there's only 2 x RGB pins... and convert this to 1/8 or something * there's only 2 x RGB pins... and convert this to 1/4 or something
*/ */
if (_panelScanRate == ONE_EIGHT_32) if (_panelScanRate == FOUR_SCAN_32PX_HIGH)
{ {
/* Convert Real World 'VirtualMatrixPanel' co-ordinates (i.e. Real World pixel you're looking at /* Convert Real World 'VirtualMatrixPanel' co-ordinates (i.e. Real World pixel you're looking at
on the panel or chain of panels, per the chaining configuration) to a 1/8 panels on the panel or chain of panels, per the chaining configuration) to a 1/8 panels
double 'stretched' and 'squished' coordinates which is what needs to be sent from the double 'stretched' and 'squished' coordinates which is what needs to be sent from the
DMA buffer. DMA buffer.
Note: Look at the One_Eight_1_8_ScanPanel code and you'll see that the DMA buffer is setup Note: Look at the FourScanPanel example code and you'll see that the DMA buffer is setup
as if the panel is 2 * W and 0.5 * H ! as if the panel is 2 * W and 0.5 * H !
*/ */
@ -238,7 +246,7 @@ inline VirtualCoords VirtualMatrixPanel::getCoords(int16_t &x, int16_t &y)
Serial.print("to ("); Serial.print(coords.x, DEC); Serial.print(","); Serial.print(coords.y, DEC); Serial.println(") "); Serial.print("to ("); Serial.print(coords.x, DEC); Serial.print(","); Serial.print(coords.y, DEC); Serial.println(") ");
*/ */
} }
else if (_panelScanRate == ONE_EIGHT_16) else if (_panelScanRate == FOUR_SCAN_16PX_HIGH)
{ {
if ((y & 8) == 0) if ((y & 8) == 0)
{ {