Paperd.Ink Library 0.0.5
Library for interacting with Paperd.Ink devices.
Loading...
Searching...
No Matches
GxEPD2_154_M09.h
Go to the documentation of this file.
1// Display Library for SPI e-paper panels from Dalian Good Display and boards from Waveshare.
2// Requires HW SPI and Adafruit_GFX. Caution: the e-paper panels require 3.3V supply AND data lines!
3//
4// based on Demo Example from Good Display, available here: http://www.e-paper-display.com/download_detail/downloadsId=806.html
5// Panel: GDEW0154M09 : http://www.e-paper-display.com/products_detail/productId=513.html
6// Controller : JD79653A : http://www.e-paper-display.com/download_detail/downloadsId%3d943.html
7//
8// Author: Jean-Marc Zingg
9//
10// Version: see library.properties
11//
12// Library: https://github.com/ZinggJM/GxEPD2
13
14#ifndef _GxEPD2_154_M09_H_
15#define _GxEPD2_154_M09_H_
16
17#include "../GxEPD2_EPD.h"
18
20{
21 public:
22 // attributes
23 static const uint16_t WIDTH = 200;
24 static const uint16_t HEIGHT = 200;
26 static const bool hasColor = false;
27 static const bool hasPartialUpdate = true;
28 static const bool hasFastPartialUpdate = true;
29 static const uint16_t power_on_time = 250; // ms, e.g. 206410us
30 static const uint16_t power_off_time = 100; // ms, e.g. 62091us
31 static const uint16_t full_refresh_time = 1000; // ms, e.g. 924485us
32 static const uint16_t partial_refresh_time = 400; // ms, e.g. 324440us
33 // constructor
34 GxEPD2_154_M09(int16_t cs, int16_t dc, int16_t rst, int16_t busy);
35 // methods (virtual)
36 // Support for Bitmaps (Sprites) to Controller Buffer and to Screen
37 void clearScreen(uint8_t value = 0xFF); // init controller memory and screen (default white)
38 void writeScreenBuffer(uint8_t value = 0xFF); // init controller memory (default white)
39 void writeScreenBufferAgain(uint8_t value = 0xFF); // init previous buffer controller memory (default white)
40 // write to controller memory, without screen refresh; x and w should be multiple of 8
41 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);
42 void writeImagePart(const uint8_t bitmap[], int16_t x_part, int16_t y_part, int16_t w_bitmap, int16_t h_bitmap,
43 int16_t x, int16_t y, int16_t w, int16_t h, bool invert = false, bool mirror_y = false, bool pgm = false);
44 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);
45 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,
46 int16_t x, int16_t y, int16_t w, int16_t h, bool invert = false, bool mirror_y = false, bool pgm = false);
47 // write sprite of native data to controller memory, without screen refresh; x and w should be multiple of 8
48 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);
49 // write to controller memory, with screen refresh; x and w should be multiple of 8
50 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);
51 void drawImagePart(const uint8_t bitmap[], int16_t x_part, int16_t y_part, int16_t w_bitmap, int16_t h_bitmap,
52 int16_t x, int16_t y, int16_t w, int16_t h, bool invert = false, bool mirror_y = false, bool pgm = false);
53 //for differential update: set current and previous buffers equal (for fast partial update to work correctly)
54 void writeImageAgain(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);
55 void writeImagePartAgain(const uint8_t bitmap[], int16_t x_part, int16_t y_part, int16_t w_bitmap, int16_t h_bitmap,
56 int16_t x, int16_t y, int16_t w, int16_t h, bool invert = false, bool mirror_y = false, bool pgm = false);
57 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);
58 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,
59 int16_t x, int16_t y, int16_t w, int16_t h, bool invert = false, bool mirror_y = false, bool pgm = false);
60 // write sprite of native data to controller memory, with screen refresh; x and w should be multiple of 8
61 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);
62 void refresh(bool partial_update_mode = false); // screen refresh from controller memory to full screen
63 void refresh(int16_t x, int16_t y, int16_t w, int16_t h); // screen refresh from controller memory, partial screen
64 void powerOff(); // turns off generation of panel driving voltages, avoids screen fading over time
65 void hibernate(); // turns powerOff() and sets controller to deep sleep for minimum power use, ONLY if wakeable by RST (rst >= 0)
66 private:
67 void _writeScreenBuffer(uint8_t command, uint8_t value);
68 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);
69 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,
70 int16_t x, int16_t y, int16_t w, int16_t h, bool invert = false, bool mirror_y = false, bool pgm = false);
71 void _setPartialRamArea(uint16_t x, uint16_t y, uint16_t w, uint16_t h);
72 void _PowerOn();
73 void _PowerOff();
74 void _InitDisplay();
75 void _Init_Full();
76 void _Init_Part();
77 void _Update_Full();
78 void _Update_Part();
79 private:
80 static const unsigned char lut_20_vcomDC[];
81 static const unsigned char lut_21_ww[];
82 static const unsigned char lut_22_bw[];
83 static const unsigned char lut_23_wb[];
84 static const unsigned char lut_24_bb[];
85 static const unsigned char lut_20_vcomDC_partial[];
86 static const unsigned char lut_21_ww_partial[];
87 static const unsigned char lut_22_bw_partial[];
88 static const unsigned char lut_23_wb_partial[];
89 static const unsigned char lut_24_bb_partial[];
90};
91
92#endif
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)
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)
static const uint16_t power_off_time
void writeImageAgain(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)
void writeImagePartAgain(const uint8_t bitmap[], int16_t x_part, int16_t y_part, int16_t w_bitmap, int16_t h_bitmap, int16_t x, int16_t y, int16_t w, int16_t h, bool invert=false, bool mirror_y=false, bool pgm=false)
void clearScreen(uint8_t value=0xFF)
static const uint16_t partial_refresh_time
static const uint16_t full_refresh_time
void drawImagePart(const uint8_t bitmap[], int16_t x_part, int16_t y_part, int16_t w_bitmap, int16_t h_bitmap, int16_t x, int16_t y, int16_t w, int16_t h, bool invert=false, bool mirror_y=false, bool pgm=false)
void writeScreenBuffer(uint8_t value=0xFF)
static const GxEPD2::Panel panel
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)
static const bool hasColor
void writeScreenBufferAgain(uint8_t value=0xFF)
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)
static const bool hasFastPartialUpdate
static const uint16_t WIDTH
static const uint16_t power_on_time
static const bool hasPartialUpdate
GxEPD2_154_M09(int16_t cs, int16_t dc, int16_t rst, int16_t busy)
void writeImagePart(const uint8_t bitmap[], int16_t x_part, int16_t y_part, int16_t w_bitmap, int16_t h_bitmap, int16_t x, int16_t y, int16_t w, int16_t h, bool invert=false, bool mirror_y=false, bool pgm=false)
void refresh(bool partial_update_mode=false)
static const uint16_t HEIGHT
Panel
Definition GxEPD2.h:37
@ GDEW0154M09
Definition GxEPD2.h:43