add 3.7" Tri-color

examples/ThinkInk_gray4/ThinkInk_gray4.ino

@@ -43,8 +43,8 @@ ThinkInk_213_Grayscale4_MFGN display(EPD_DC, EPD_RESET, EPD_CS, SRAM_CS, EPD_BUS
 //                                      EPD_SPI);
 
 // 2.9" Grayscale Featherwing or Breakout:
-//ThinkInk_290_Grayscale4_T5 display(EPD_DC, EPD_RESET, EPD_CS, SRAM_CS, EPD_BUSY,
-//                                   EPD_SPI);
+// ThinkInk_290_Grayscale4_T5 display(EPD_DC, EPD_RESET, EPD_CS, SRAM_CS, EPD_BUSY,
+//                                    EPD_SPI);
 
 // 4.2" 4-Grayscale display with SSD1683 chipset
 // ThinkInk_420_Grayscale4_MFGN display(EPD_DC, EPD_RESET, EPD_CS, SRAM_CS, EPD_BUSY, EPD_SPI);

src/Adafruit_EPD.h

@@ -214,6 +214,7 @@ class Adafruit_EPD : public Adafruit_GFX {
 #include "drivers/Adafruit_SSD1683.h"
 #include "drivers/Adafruit_UC8151D.h"
 #include "drivers/Adafruit_UC8179.h"
+#include "drivers/Adafruit_UC8253.h"
 #include "drivers/Adafruit_UC8276.h"
 
 #endif /* _ADAFRUIT_EPD_H_ */

src/Adafruit_ThinkInk.h

@@ -33,6 +33,7 @@
 #include "panels/ThinkInk_290_Tricolor_Z10.h"
 #include "panels/ThinkInk_290_Tricolor_Z13.h"
 #include "panels/ThinkInk_290_Tricolor_Z94.h"
+#include "panels/ThinkInk_370_Tricolor_BABMFGNR.h"
 #include "panels/ThinkInk_420_Grayscale4_T2.h"
 #include "panels/ThinkInk_420_Mono_BN.h"
 #include "panels/ThinkInk_420_Mono_M06.h"

src/drivers/Adafruit_UC8253.cpp

@@ -0,0 +1,223 @@
+#include "Adafruit_UC8253.h"
+
+#include "Adafruit_EPD.h"
+
+#define EPD_RAM_BW 0x10
+#define EPD_RAM_RED 0x13
+
+#define BUSY_WAIT 500
+
+// clang-format off
+
+const uint8_t uc8253_default_init_code[] {
+    UC8253_POWERON, 0, // soft reset
+    0xFF, 50,          // busy wait
+    UC8253_PANELSETTING, 2, 0b11001111, 0x8D,
+    0xFE};
+
+// clang-format on
+
+/**************************************************************************/
+/*!
+    @brief constructor if using external SRAM chip and software SPI
+    @param width the width of the display in pixels
+    @param height the height of the display in pixels
+    @param SID the SID pin to use
+    @param SCLK the SCLK pin to use
+    @param DC the data/command pin to use
+    @param RST the reset pin to use
+    @param CS the chip select pin to use
+    @param SRCS the SRAM chip select pin to use
+    @param MISO the MISO pin to use
+    @param BUSY the busy pin to use
+*/
+/**************************************************************************/
+Adafruit_UC8253::Adafruit_UC8253(int width, int height, int16_t SID,
+                                 int16_t SCLK, int16_t DC, int16_t RST,
+                                 int16_t CS, int16_t SRCS, int16_t MISO,
+                                 int16_t BUSY)
+    : Adafruit_EPD(width, height, SID, SCLK, DC, RST, CS, SRCS, MISO, BUSY) {
+  if ((height % 8) != 0) {
+    height += 8 - (height % 8);
+  }
+
+  buffer1_size = width * height / 8;
+  buffer2_size = buffer1_size;
+
+  if (SRCS >= 0) {
+    use_sram = true;
+    buffer1_addr = 0;
+    buffer2_addr = buffer1_size;
+    buffer1 = buffer2 = NULL;
+  } else {
+    buffer1 = (uint8_t*)malloc(buffer1_size);
+    buffer2 = (uint8_t*)malloc(buffer2_size);
+  }
+
+  singleByteTxns = true;
+}
+
+// constructor for hardware SPI - we indicate DataCommand, ChipSelect, Reset
+
+/**************************************************************************/
+/*!
+    @brief constructor if using on-chip RAM and hardware SPI
+    @param width the width of the display in pixels
+    @param height the height of the display in pixels
+    @param DC the data/command pin to use
+    @param RST the reset pin to use
+    @param CS the chip select pin to use
+    @param SRCS the SRAM chip select pin to use
+    @param BUSY the busy pin to use
+*/
+/**************************************************************************/
+Adafruit_UC8253::Adafruit_UC8253(int width, int height, int16_t DC, int16_t RST,
+                                 int16_t CS, int16_t SRCS, int16_t BUSY,
+                                 SPIClass* spi)
+    : Adafruit_EPD(width, height, DC, RST, CS, SRCS, BUSY, spi) {
+  if ((height % 8) != 0) {
+    height += 8 - (height % 8);
+  }
+
+  buffer1_size = width * height / 8;
+  buffer2_size = buffer1_size;
+
+  if (SRCS >= 0) {
+    use_sram = true;
+    buffer1_addr = 0;
+    buffer2_addr = buffer1_size;
+    buffer1 = buffer2 = NULL;
+  } else {
+    buffer1 = (uint8_t*)malloc(buffer1_size);
+    buffer2 = (uint8_t*)malloc(buffer2_size);
+  }
+
+  singleByteTxns = true;
+}
+
+/**************************************************************************/
+/*!
+    @brief wait for busy signal to end
+*/
+/**************************************************************************/
+void Adafruit_UC8253::busy_wait(void) {
+  if (_busy_pin >= 0) {
+    while (!digitalRead(_busy_pin)) { // wait for busy HIGH
+      EPD_command(UC8253_GET_STATUS);
+      delay(50);
+    }
+  } else {
+    delay(BUSY_WAIT);
+  }
+}
+
+/**************************************************************************/
+/*!
+    @brief begin communication with and set up the display.
+    @param reset if true the reset pin will be toggled.
+*/
+/**************************************************************************/
+void Adafruit_UC8253::begin(bool reset) {
+  Adafruit_EPD::begin(reset);
+  setBlackBuffer(0, true);  // black defaults to inverted
+  setColorBuffer(1, false); // red defaults to inverted
+  powerUp();
+  powerDown();
+}
+
+/**************************************************************************/
+/*!
+    @brief signal the display to update
+*/
+/**************************************************************************/
+void Adafruit_UC8253::update() {
+  EPD_command(UC8253_DISPLAYREFRESH);
+  delay(100);
+  busy_wait();
+
+  if (_busy_pin <= -1) {
+    delay(default_refresh_delay);
+  }
+}
+
+/**************************************************************************/
+/*!
+    @brief start up the display
+*/
+/**************************************************************************/
+void Adafruit_UC8253::powerUp() {
+  hardwareReset();
+  const uint8_t* init_code = uc8253_default_init_code;
+
+  if (_epd_init_code != NULL) {
+    init_code = _epd_init_code;
+  }
+  EPD_commandList(init_code);
+  busy_wait();
+}
+
+/**************************************************************************/
+/*!
+    @brief wind down the display
+*/
+/**************************************************************************/
+void Adafruit_UC8253::powerDown() {
+  uint8_t buf[1];
+  EPD_command(UC8253_POWEROFF);
+  busy_wait();
+
+  delay(1000); // required delay
+  // Only deep sleep if we can get out of it
+  if (_reset_pin >= 0) {
+    buf[0] = 0xA5;
+    EPD_command(UC8253_DEEPSLEEP, buf, 1);
+  }
+}
+
+/**************************************************************************/
+/*!
+    @brief Send the specific command to start writing to EPD display RAM
+    @param index The index for which buffer to write (0 or 1 or tri-color
+   displays) Ignored for monochrome displays.
+    @returns The byte that is read from SPI at the same time as sending the
+   command
+*/
+/**************************************************************************/
+uint8_t Adafruit_UC8253::writeRAMCommand(uint8_t index) {
+  if (index == 0) {
+    return EPD_command(UC8253_WRITE_RAM1, false);
+  }
+  if (index == 1) {
+    return EPD_command(UC8253_WRITE_RAM2, false);
+  }
+  return 0;
+}
+
+/**************************************************************************/
+/*!
+    @brief Some displays require setting the RAM address pointer
+    @param x X address counter value
+    @param y Y address counter value
+*/
+/**************************************************************************/
+void Adafruit_UC8253::setRAMAddress(uint16_t x, uint16_t y) {
+  // not used in this chip!
+  (void)x;
+  (void)y;
+}
+
+/**************************************************************************/
+/*!
+    @brief Some displays require setting the RAM address pointer
+    @param x X address counter value
+    @param y Y address counter value
+*/
+/**************************************************************************/
+void Adafruit_UC8253::setRAMWindow(uint16_t x1, uint16_t y1, uint16_t x2,
+                                   uint16_t y2) {
+  // not used in this chip!
+  (void)x1;
+  (void)y1;
+  (void)x2;
+  (void)y2;
+}

src/drivers/Adafruit_UC8253.h

@@ -0,0 +1,42 @@
+#ifndef LIB_ADAFRUIT_UC8253
+#define LIB_ADAFRUIT_UC8253
+
+#include <Arduino.h>
+
+#include "Adafruit_EPD.h"
+
+#define UC8253_PANELSETTING 0x00
+#define UC8253_POWEROFF 0x02
+#define UC8253_POWERON 0x04
+#define UC8253_DEEPSLEEP 0x07
+#define UC8253_DISPLAYREFRESH 0x12
+#define UC8253_WRITE_RAM1 0x10
+#define UC8253_WRITE_RAM2 0x13
+#define UC8253_GET_STATUS 0x71
+
+/**************************************************************************/
+/*!
+    @brief  Class for interfacing with UC8253 EPD drivers
+*/
+/**************************************************************************/
+class Adafruit_UC8253 : public Adafruit_EPD {
+ public:
+  Adafruit_UC8253(int width, int height, int16_t SID, int16_t SCLK, int16_t DC,
+                  int16_t RST, int16_t CS, int16_t SRCS, int16_t MISO,
+                  int16_t BUSY = -1);
+  Adafruit_UC8253(int width, int height, int16_t DC, int16_t RST, int16_t CS,
+                  int16_t SRCS, int16_t BUSY = -1, SPIClass* spi = &SPI);
+
+  void begin(bool reset = true);
+  void powerUp();
+  void update(void);
+  void powerDown();
+
+ protected:
+  uint8_t writeRAMCommand(uint8_t index);
+  void setRAMAddress(uint16_t x, uint16_t y);
+  void setRAMWindow(uint16_t x1, uint16_t y1, uint16_t x2, uint16_t y2);
+  void busy_wait();
+};
+
+#endif

src/panels/ThinkInk_290_Tricolor_Z13.h

@@ -32,7 +32,7 @@ class ThinkInk_290_Tricolor_Z13 : public Adafruit_UC8151D {
     layer_colors[EPD_LIGHT] = 0b00;
     layer_colors[EPD_DARK] = 0b01;
 
-    default_refresh_delay = 1000;
+    default_refresh_delay = 13000;
     setRotation(0);
     powerDown();
   }

src/panels/ThinkInk_370_Tricolor_BABMFGNR.h

@@ -0,0 +1,41 @@
+#ifndef _THINKINK_370_TRI_BABMFGNR_H
+#define _THINKINK_370_TRI_BABMFGNR_H
+
+// This file is #included by Adafruit_ThinkInk.h and does not need to
+// #include anything else to pick up the EPD header or ink mode enum.
+
+
+class ThinkInk_370_Tricolor_BABMFGNR : public Adafruit_UC8253 {
+ public:
+  ThinkInk_370_Tricolor_BABMFGNR(int16_t SID, int16_t SCLK, int16_t DC, 
+                                 int16_t RST, int16_t CS, int16_t SRCS, 
+                                 int16_t MISO, int16_t BUSY = -1)
+    : Adafruit_UC8253(416, 240, SID, SCLK, DC, RST, CS, SRCS, MISO, BUSY){};
+
+  ThinkInk_370_Tricolor_BABMFGNR(int16_t DC, int16_t RST, int16_t CS, 
+                                 int16_t SRCS, int16_t BUSY = -1, 
+                                 SPIClass* spi = &SPI)
+      : Adafruit_UC8253(416, 240, DC, RST, CS, SRCS, BUSY, spi){};
+
+  void begin(thinkinkmode_t mode = THINKINK_TRICOLOR) {
+    Adafruit_UC8253::begin(true);
+
+    setColorBuffer(0, true);
+    setBlackBuffer(1, false);
+
+    inkmode = mode; // Preserve ink mode for ImageReader or others
+
+    layer_colors[EPD_WHITE] = 0b00;
+    layer_colors[EPD_BLACK] = 0b10;
+    layer_colors[EPD_RED] = 0b01;
+    layer_colors[EPD_GRAY] = 0b01;
+    layer_colors[EPD_LIGHT] = 0b00;
+    layer_colors[EPD_DARK] = 0b01;
+
+    default_refresh_delay = 13000;
+    setRotation(0);
+    // DO NOT power down again!
+  }
+};
+
+#endif // _THINKINK_370_TRI_BABMFGNR_H