GxEPD2_102.h 5.6 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283
  1. // Display Library for SPI e-paper panels from Dalian Good Display and boards from Waveshare.
  2. // Requires HW SPI and Adafruit_GFX. Caution: these e-papers require 3.3V supply AND data lines!
  3. //
  4. // based on Demo Example from Good Display: http://www.e-paper-display.com/download_list/downloadcategoryid=34&isMode=false.html
  5. // Panel: GDEW0102T4 : https://www.good-display.com/product/207.html
  6. // Controller: UC8175 : https://v4.cecdn.yun300.cn/100001_1909185148/UC8175-1.pdf
  7. //
  8. // Author: Jean-Marc Zingg
  9. //
  10. // Version: see library.properties
  11. //
  12. // Library: https://github.com/ZinggJM/GxEPD2
  13. #ifndef _GxEPD2_102_H_
  14. #define _GxEPD2_102_H_
  15. #include "../GxEPD2_EPD.h"
  16. class GxEPD2_102 : public GxEPD2_EPD
  17. {
  18. public:
  19. // attributes
  20. static const uint16_t WIDTH = 80;
  21. static const uint16_t HEIGHT = 128;
  22. static const GxEPD2::Panel panel = GxEPD2::GDEW0102T4;
  23. static const bool hasColor = false;
  24. static const bool hasPartialUpdate = true;
  25. static const bool usePartialUpdateWindow = false; // set false for better image
  26. static const bool hasFastPartialUpdate = true;
  27. static const bool useOTPforFullRefresh = true;
  28. static const uint16_t power_on_time = 250; // ms, e.g. 210453us
  29. static const uint16_t power_off_time = 250; // ms, e.g. 202366us
  30. static const uint16_t full_refresh_time = 3600; // ms, e.g. 3507492us
  31. static const uint16_t partial_refresh_time = 1200; // ms, e.g. 1102149us
  32. // constructor
  33. GxEPD2_102(int16_t cs, int16_t dc, int16_t rst, int16_t busy);
  34. // methods (virtual)
  35. // Support for Bitmaps (Sprites) to Controller Buffer and to Screen
  36. void clearScreen(uint8_t value = 0xFF); // init controller memory and screen (default white)
  37. void writeScreenBuffer(uint8_t value = 0xFF); // init controller memory (default white)
  38. // write to controller memory, without screen refresh; x and w should be multiple of 8
  39. void writeImage(const uint8_t bitmap[], int16_t x, int16_t y, int16_t w, int16_t h, bool invert = false, bool mirror_y = false, bool pgm = false);
  40. void writeImageForFullRefresh(const uint8_t bitmap[], int16_t x, int16_t y, int16_t w, int16_t h, bool invert = false, bool mirror_y = false, bool pgm = false);
  41. void writeImagePart(const uint8_t bitmap[], int16_t x_part, int16_t y_part, int16_t w_bitmap, int16_t h_bitmap,
  42. int16_t x, int16_t y, int16_t w, int16_t h, bool invert = false, bool mirror_y = false, bool pgm = false);
  43. void writeImage(const uint8_t* black, const uint8_t* color, int16_t x, int16_t y, int16_t w, int16_t h, bool invert = false, bool mirror_y = false, bool pgm = false);
  44. void writeImagePart(const uint8_t* black, const uint8_t* color, int16_t x_part, int16_t y_part, int16_t w_bitmap, int16_t h_bitmap,
  45. int16_t x, int16_t y, int16_t w, int16_t h, bool invert = false, bool mirror_y = false, bool pgm = false);
  46. // write sprite of native data to controller memory, without screen refresh; x and w should be multiple of 8
  47. void writeNative(const uint8_t* data1, const uint8_t* data2, int16_t x, int16_t y, int16_t w, int16_t h, bool invert = false, bool mirror_y = false, bool pgm = false);
  48. // write to controller memory, with screen refresh; x and w should be multiple of 8
  49. void drawImage(const uint8_t bitmap[], int16_t x, int16_t y, int16_t w, int16_t h, bool invert = false, bool mirror_y = false, bool pgm = false);
  50. void drawImagePart(const uint8_t bitmap[], int16_t x_part, int16_t y_part, int16_t w_bitmap, int16_t h_bitmap,
  51. int16_t x, int16_t y, int16_t w, int16_t h, bool invert = false, bool mirror_y = false, bool pgm = false);
  52. void drawImage(const uint8_t* black, const uint8_t* color, int16_t x, int16_t y, int16_t w, int16_t h, bool invert = false, bool mirror_y = false, bool pgm = false);
  53. void drawImagePart(const uint8_t* black, const uint8_t* color, int16_t x_part, int16_t y_part, int16_t w_bitmap, int16_t h_bitmap,
  54. int16_t x, int16_t y, int16_t w, int16_t h, bool invert = false, bool mirror_y = false, bool pgm = false);
  55. // write sprite of native data to controller memory, with screen refresh; x and w should be multiple of 8
  56. void drawNative(const uint8_t* data1, const uint8_t* data2, int16_t x, int16_t y, int16_t w, int16_t h, bool invert = false, bool mirror_y = false, bool pgm = false);
  57. void refresh(bool partial_update_mode = false); // screen refresh from controller memory to full screen
  58. void refresh(int16_t x, int16_t y, int16_t w, int16_t h); // screen refresh from controller memory, partial screen
  59. void powerOff(); // turns off generation of panel driving voltages, avoids screen fading over time
  60. void hibernate(); // turns powerOff() and sets controller to deep sleep for minimum power use, ONLY if wakeable by RST (rst >= 0)
  61. private:
  62. void _writeImage(uint8_t command, const uint8_t bitmap[], int16_t x, int16_t y, int16_t w, int16_t h, bool invert = false, bool mirror_y = false, bool pgm = false);
  63. void _writeImagePart(uint8_t command, const uint8_t bitmap[], int16_t x_part, int16_t y_part, int16_t w_bitmap, int16_t h_bitmap,
  64. int16_t x, int16_t y, int16_t w, int16_t h, bool invert = false, bool mirror_y = false, bool pgm = false);
  65. void _setPartialRamArea(uint16_t x, uint16_t y, uint16_t w, uint16_t h);
  66. void _PowerOn();
  67. void _PowerOff();
  68. void _InitDisplay();
  69. void _Init_Full();
  70. void _Init_Part();
  71. void _Update_Full();
  72. void _Update_Part();
  73. private:
  74. static const unsigned char lut_w_full[];
  75. static const unsigned char lut_b_full[];
  76. static const unsigned char lut_w_partial[];
  77. static const unsigned char lut_b_partial[];
  78. };
  79. #endif