Merge pull request #31 from adafruit/pb-modes

Add “ink mode” to ThinkInk classes (needed for ImageReader)

Author: ladyada

src/Adafruit_ThinkInk.h

@@ -1,3 +1,8 @@
+#ifndef _ADAFRUIT_THINKINK_H_
+#define _ADAFRUIT_THINKINK_H_
+
+#include "Adafruit_EPD.h"
+
 typedef enum {
   THINKINK_MONO,
   THINKINK_TRICOLOR,
@@ -22,3 +27,5 @@ typedef enum {
 #include "panels/ThinkInk_213_Mono_B73.h"
 #include "panels/ThinkInk_213_Mono_BN.h"
 #include "panels/ThinkInk_420_Mono_BN.h"
+
+#endif // _ADAFRUIT_THINKINK_H_

src/panels/ThinkInk_154_Grayscale4_T8.h

@@ -1,39 +1,42 @@
 #ifndef _THINKINK_154_GRAYSCALE4_T8_H
 #define _THINKINK_154_GRAYSCALE4_T8_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.
+
 // clang-format off
 
 static const uint8_t ti_154t8_gray4_init_code[] {
   IL0373_POWER_SETTING, 5, 0x03, 0x00, 0x2b, 0x2b, 0x13,
-    IL0373_BOOSTER_SOFT_START, 3, 0x17, 0x17, 0x17,
-    IL0373_POWER_ON, 0,
-    0xFF, 200,
-    IL0373_PANEL_SETTING, 1, 0x3F,
-    IL0373_PLL, 1, 0x3C,    
-    IL0373_VCM_DC_SETTING, 1, 0x12,
-    IL0373_CDI, 1, 0x97,
-    0xFE // EOM
+  IL0373_BOOSTER_SOFT_START, 3, 0x17, 0x17, 0x17,
+  IL0373_POWER_ON, 0,
+  0xFF, 200,
+  IL0373_PANEL_SETTING, 1, 0x3F,
+  IL0373_PLL, 1, 0x3C,    
+  IL0373_VCM_DC_SETTING, 1, 0x12,
+  IL0373_CDI, 1, 0x97,
+  0xFE // EOM
 };
 
 static const uint8_t ti_154t8_monopart_init_code[] {
   IL0373_POWER_SETTING, 5, 0x03, 0x00, 0x2b, 0x2b, 0x03,
-    IL0373_BOOSTER_SOFT_START, 3, 0x17, 0x17, 0x17,
-    IL0373_POWER_ON, 0,
-    0xFF, 200,
-    IL0373_PANEL_SETTING, 2, 0xbF, 0x0d,
-    IL0373_PLL, 1, 0x3C,    
-    IL0373_VCM_DC_SETTING, 1, 0x12,
-    IL0373_CDI, 1, 0x47,
-    0xFE // EOM
+  IL0373_BOOSTER_SOFT_START, 3, 0x17, 0x17, 0x17,
+  IL0373_POWER_ON, 0,
+  0xFF, 200,
+  IL0373_PANEL_SETTING, 2, 0xbF, 0x0d,
+  IL0373_PLL, 1, 0x3C,    
+  IL0373_VCM_DC_SETTING, 1, 0x12,
+  IL0373_CDI, 1, 0x47,
+  0xFE // EOM
 };
 
 static const uint8_t ti_154t8_monofull_init_code[] {
-    IL0373_BOOSTER_SOFT_START, 3, 0x17, 0x17, 0x17,
-    IL0373_POWER_ON, 0,
-    0xFF, 200,
-    IL0373_PANEL_SETTING, 2, 0x1f, 0x0d,
-    IL0373_CDI, 1, 0x97,
-    0xFE // EOM
+  IL0373_BOOSTER_SOFT_START, 3, 0x17, 0x17, 0x17,
+  IL0373_POWER_ON, 0,
+  0xFF, 200,
+  IL0373_PANEL_SETTING, 2, 0x1f, 0x0d,
+  IL0373_CDI, 1, 0x97,
+  0xFE // EOM
 };
 
 static const uint8_t ti_154t8_monopart_lut_code[] = {
@@ -144,7 +147,6 @@ static const uint8_t ti_154t8_gray4_lut_code[] = {
 // clang-format on
 
 class ThinkInk_154_Grayscale4_T8 : public Adafruit_IL0373 {
-private:
 public:
   ThinkInk_154_Grayscale4_T8(int8_t SID, int8_t SCLK, int8_t DC, int8_t RST,
                              int8_t CS, int8_t SRCS, int8_t MISO,
@@ -160,6 +162,8 @@ class ThinkInk_154_Grayscale4_T8 : public Adafruit_IL0373 {
     setColorBuffer(0, true); // layer 0 uninverted
     setBlackBuffer(1, true); // layer 1 uninverted
 
+    inkmode = mode; // Preserve ink mode for ImageReader or others
+
     if (mode == THINKINK_GRAYSCALE4) {
       _epd_init_code = ti_154t8_gray4_init_code;
       _epd_lut_code = ti_154t8_gray4_lut_code;
@@ -170,8 +174,7 @@ class ThinkInk_154_Grayscale4_T8 : public Adafruit_IL0373 {
       layer_colors[EPD_GRAY] = 0b10;
       layer_colors[EPD_LIGHT] = 0b01;
       layer_colors[EPD_DARK] = 0b10;
-    }
-    if (mode == THINKINK_MONO) {
+    } else if (mode == THINKINK_MONO) {
       _epd_init_code = ti_154t8_monofull_init_code;
       _epd_partial_init_code = ti_154t8_monopart_init_code;
       _epd_partial_lut_code = ti_154t8_monopart_lut_code;
@@ -187,7 +190,12 @@ class ThinkInk_154_Grayscale4_T8 : public Adafruit_IL0373 {
     default_refresh_delay = 1000;
     setRotation(3);
     powerDown();
-  };
+  }
+
+  thinkinkmode_t getMode(void) { return inkmode; }
+
+private:
+  thinkinkmode_t inkmode; // Ink mode passed to begin()
 };
 
 #endif // _THINKINK_154_GRAYSCALE4_T8_H

src/panels/ThinkInk_154_Mono_D27.h

@@ -1,10 +1,10 @@
 #ifndef _THINKINK_154_MONO_D27_H
 #define _THINKINK_154_MONO_D27_H
 
-#include "Adafruit_EPD.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_154_Mono_D27 : public Adafruit_SSD1608 {
-private:
 public:
   ThinkInk_154_Mono_D27(int8_t SID, int8_t SCLK, int8_t DC, int8_t RST,
                         int8_t CS, int8_t SRCS, int8_t MISO, int8_t BUSY = -1)
@@ -19,6 +19,8 @@ class ThinkInk_154_Mono_D27 : public Adafruit_SSD1608 {
     setColorBuffer(0, true); // layer 0 uninverted
     setBlackBuffer(0, true); // only one buffer
 
+    inkmode = mode; // Preserve ink mode for ImageReader or others
+
     layer_colors[EPD_WHITE] = 0b00;
     layer_colors[EPD_BLACK] = 0b01;
     layer_colors[EPD_RED] = 0b01;
@@ -29,7 +31,12 @@ class ThinkInk_154_Mono_D27 : public Adafruit_SSD1608 {
     default_refresh_delay = 1000;
     setRotation(3);
     powerDown();
-  };
+  }
+
+  thinkinkmode_t getMode(void) { return inkmode; }
+
+private:
+  thinkinkmode_t inkmode; // Ink mode passed to begin()
 };
 
 #endif // _THINKINK_154_MONO_D27_H

src/panels/ThinkInk_154_Mono_D67.h

@@ -1,10 +1,10 @@
 #ifndef _THINKINK_154_MONO_D67_H
 #define _THINKINK_154_MONO_D67_H
 
-#include "Adafruit_EPD.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_154_Mono_D67 : public Adafruit_SSD1681 {
-private:
 public:
   ThinkInk_154_Mono_D67(int8_t SID, int8_t SCLK, int8_t DC, int8_t RST,
                         int8_t CS, int8_t SRCS, int8_t MISO, int8_t BUSY = -1)
@@ -19,6 +19,8 @@ class ThinkInk_154_Mono_D67 : public Adafruit_SSD1681 {
     setColorBuffer(0, true); // layer 0 uninverted
     setBlackBuffer(0, true); // only one buffer
 
+    inkmode = mode; // Preserve ink mode for ImageReader or others
+
     layer_colors[EPD_WHITE] = 0b00;
     layer_colors[EPD_BLACK] = 0b01;
     layer_colors[EPD_RED] = 0b01;
@@ -29,7 +31,12 @@ class ThinkInk_154_Mono_D67 : public Adafruit_SSD1681 {
     default_refresh_delay = 1000;
     setRotation(3);
     powerDown();
-  };
+  }
+
+  thinkinkmode_t getMode(void) { return inkmode; }
+
+private:
+  thinkinkmode_t inkmode; // Ink mode passed to begin()
 };
 
 #endif // _THINKINK_154_MONO_D67_H

src/panels/ThinkInk_154_Tricolor_RW.h

@@ -1,10 +1,10 @@
 #ifndef _THINKINK_154_TRICOLOR_RW_H
 #define _THINKINK_154_TRICOLOR_RW_H
 
-#include "Adafruit_EPD.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_154_Tricolor_RW : public Adafruit_SSD1680 {
-private:
 public:
   ThinkInk_154_Tricolor_RW(int8_t SID, int8_t SCLK, int8_t DC, int8_t RST,
                            int8_t CS, int8_t SRCS, int8_t MISO,
@@ -20,6 +20,8 @@ class ThinkInk_154_Tricolor_RW : public Adafruit_SSD1680 {
     setBlackBuffer(0, true);
     setColorBuffer(1, false);
 
+    inkmode = mode; // Preserve ink mode for ImageReader or others
+
     layer_colors[EPD_WHITE] = 0b00;
     layer_colors[EPD_BLACK] = 0b01;
     layer_colors[EPD_RED] = 0b10;
@@ -30,7 +32,12 @@ class ThinkInk_154_Tricolor_RW : public Adafruit_SSD1680 {
     default_refresh_delay = 13000;
     setRotation(3);
     powerDown();
-  };
+  }
+
+  thinkinkmode_t getMode(void) { return inkmode; }
+
+private:
+  thinkinkmode_t inkmode; // Ink mode passed to begin()
 };
 
 #endif // _THINKINK_154_TRI

src/panels/ThinkInk_154_Tricolor_Z17.h

@@ -1,10 +1,10 @@
 #ifndef _THINKINK_154_TRICOLOR_Z17_H
 #define _THINKINK_154_TRICOLOR_Z17_H
 
-#include "Adafruit_EPD.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_154_Tricolor_Z17 : public Adafruit_IL0373 {
-private:
 public:
   ThinkInk_154_Tricolor_Z17(int8_t SID, int8_t SCLK, int8_t DC, int8_t RST,
                             int8_t CS, int8_t SRCS, int8_t MISO,
@@ -20,6 +20,8 @@ class ThinkInk_154_Tricolor_Z17 : public Adafruit_IL0373 {
     setColorBuffer(0, true); // layer 0 uninverted
     setBlackBuffer(1, true); // layer 1 uninverted
 
+    inkmode = mode; // Preserve ink mode for ImageReader or others
+
     layer_colors[EPD_WHITE] = 0b00;
     layer_colors[EPD_BLACK] = 0b10;
     layer_colors[EPD_RED] = 0b01;
@@ -31,7 +33,12 @@ class ThinkInk_154_Tricolor_Z17 : public Adafruit_IL0373 {
 
     setRotation(3);
     powerDown();
-  };
+  }
+
+  thinkinkmode_t getMode(void) { return inkmode; }
+
+private:
+  thinkinkmode_t inkmode; // Ink mode passed to begin()
 };
 
 #endif // _THINKINK_154_TRICOLOR_Z17_H

src/panels/ThinkInk_213_Grayscale4_T5.h

@@ -1,41 +1,42 @@
 #ifndef _THINKINK_213_GRAYSCALE4_T5_H
 #define _THINKINK_213_GRAYSCALE4_T5_H
 
-#include "Adafruit_EPD.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.
 
 // clang-format off
 
 static const uint8_t ti_213t5_gray4_init_code[] {
   IL0373_POWER_SETTING, 5, 0x03, 0x00, 0x2b, 0x2b, 0x13,
-    IL0373_BOOSTER_SOFT_START, 3, 0x17, 0x17, 0x17,
-    IL0373_POWER_ON, 0,
-    0xFF, 200,
-    IL0373_PANEL_SETTING, 1, 0x3F,
-    IL0373_PLL, 1, 0x3C,    
-    IL0373_VCM_DC_SETTING, 1, 0x12,
-    IL0373_CDI, 1, 0x97,
-    0xFE // EOM
+  IL0373_BOOSTER_SOFT_START, 3, 0x17, 0x17, 0x17,
+  IL0373_POWER_ON, 0,
+  0xFF, 200,
+  IL0373_PANEL_SETTING, 1, 0x3F,
+  IL0373_PLL, 1, 0x3C,    
+  IL0373_VCM_DC_SETTING, 1, 0x12,
+  IL0373_CDI, 1, 0x97,
+  0xFE // EOM
 };
 
 static const uint8_t ti_213t5_monopart_init_code[] {
   IL0373_POWER_SETTING, 5, 0x03, 0x00, 0x2b, 0x2b, 0x03,
-    IL0373_BOOSTER_SOFT_START, 3, 0x17, 0x17, 0x17,
-    IL0373_POWER_ON, 0,
-    0xFF, 200,
-    IL0373_PANEL_SETTING, 2, 0xbF, 0x0d,
-    IL0373_PLL, 1, 0x3C,    
-    IL0373_VCM_DC_SETTING, 1, 0x12,
-    IL0373_CDI, 1, 0x47,
-    0xFE // EOM
+  IL0373_BOOSTER_SOFT_START, 3, 0x17, 0x17, 0x17,
+  IL0373_POWER_ON, 0,
+  0xFF, 200,
+  IL0373_PANEL_SETTING, 2, 0xbF, 0x0d,
+  IL0373_PLL, 1, 0x3C,    
+  IL0373_VCM_DC_SETTING, 1, 0x12,
+  IL0373_CDI, 1, 0x47,
+  0xFE // EOM
 };
 
 static const uint8_t ti_213t5_monofull_init_code[] {
-    IL0373_BOOSTER_SOFT_START, 3, 0x17, 0x17, 0x17,
-    IL0373_POWER_ON, 0,
-    0xFF, 200,
-    IL0373_PANEL_SETTING, 2, 0x1f, 0x0d,
-    IL0373_CDI, 1, 0x97,
-    0xFE // EOM
+  IL0373_BOOSTER_SOFT_START, 3, 0x17, 0x17, 0x17,
+  IL0373_POWER_ON, 0,
+  0xFF, 200,
+  IL0373_PANEL_SETTING, 2, 0x1f, 0x0d,
+  IL0373_CDI, 1, 0x97,
+  0xFE // EOM
 };
 
 static const uint8_t ti_213t5_monopart_lut_code[] = {
@@ -146,7 +147,6 @@ static const uint8_t ti_213t5_gray4_lut_code[] = {
 // clang-format on
 
 class ThinkInk_213_Grayscale4_T5 : public Adafruit_IL0373 {
-private:
 public:
   ThinkInk_213_Grayscale4_T5(int8_t SID, int8_t SCLK, int8_t DC, int8_t RST,
                              int8_t CS, int8_t SRCS, int8_t MISO,
@@ -162,6 +162,8 @@ class ThinkInk_213_Grayscale4_T5 : public Adafruit_IL0373 {
     setColorBuffer(0, true); // layer 0 uninverted
     setBlackBuffer(1, true); // layer 1 uninverted
 
+    inkmode = mode; // Preserve ink mode for ImageReader or others
+
     if (mode == THINKINK_GRAYSCALE4) {
       _epd_init_code = ti_213t5_gray4_init_code;
       _epd_lut_code = ti_213t5_gray4_lut_code;
@@ -172,8 +174,7 @@ class ThinkInk_213_Grayscale4_T5 : public Adafruit_IL0373 {
       layer_colors[EPD_GRAY] = 0b10;
       layer_colors[EPD_LIGHT] = 0b01;
       layer_colors[EPD_DARK] = 0b10;
-    }
-    if (mode == THINKINK_MONO) {
+    } else if (mode == THINKINK_MONO) {
       _epd_init_code = ti_213t5_monofull_init_code;
       _epd_partial_init_code = ti_213t5_monopart_init_code;
       _epd_partial_lut_code = ti_213t5_monopart_lut_code;
@@ -189,7 +190,12 @@ class ThinkInk_213_Grayscale4_T5 : public Adafruit_IL0373 {
     default_refresh_delay = 1000;
 
     powerDown();
-  };
+  }
+
+  thinkinkmode_t getMode(void) { return inkmode; }
+
+private:
+  thinkinkmode_t inkmode; // Ink mode passed to begin()
 };
 
 #endif // _THINKINK_213_GRAYSCALE4_T5_H