gxepd2_display.h 19 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430
  1. #pragma once
  2. #include "esphome/core/component.h"
  3. #include "esphome/core/helpers.h"
  4. #include "esphome/components/display/display_buffer.h"
  5. #include "esphome/components/spi/spi.h"
  6. #include "cycle_engine.h"
  7. #include "panel_154_z90c.h"
  8. #include "panel_213_b72.h"
  9. #include "panel_213_z98c.h"
  10. #include "panel_213c_gdey0213f51.h"
  11. #include "panel_213c_gdey0213f52.h"
  12. #include "panel_270.h"
  13. #include "panel_290_t5d.h"
  14. #include "panel_290c_gdey029f51.h"
  15. #include "panel_420.h"
  16. #include "panel_426_gdeq0426t82.h"
  17. #include "panel_579c_gdey0579f51.h"
  18. #include "panel_579c_gdey0579f51_master_only.h"
  19. #include "panel_583.h"
  20. #include "panel_583_gdeq0583t31.h"
  21. #include "panel_730c_gdep073e01.h"
  22. #include "panel_750_gdey075t7.h"
  23. namespace esphome::gxepd2 {
  24. static const char *const TAG = "gxepd2";
  25. // ESPHome display component for a GxEPD2 panel. Panels arrive as
  26. // EpdPanelDescriptors selected at runtime via set_descriptor() and driven by
  27. // CycleEngine, not by templating this class over GxEPD2's own driver classes.
  28. class GxEPD2Display : public display::DisplayBuffer {
  29. public:
  30. void set_cs_pin(GPIOPin *pin) { this->cs_ = pin; }
  31. void set_dc_pin(GPIOPin *pin) { this->dc_ = pin; }
  32. void set_reset_pin(GPIOPin *pin) { this->rst_ = pin; }
  33. void set_busy_pin(GPIOPin *pin) { this->busy_ = pin; }
  34. void set_spi_parent(spi::SPIComponent *parent) { this->spi_.set_spi_parent(parent); }
  35. void set_descriptor(const EpdPanelDescriptor *desc) { this->desc_ = desc; }
  36. void set_invert_mono(bool invert) { this->invert_mono_ = invert; }
  37. // The short panel label (e.g. "GDEQ0583T31") test_pattern() can print,
  38. // derived from model: in display.py.
  39. void set_model_name(const char *name) { this->model_name_ = name; }
  40. // Whether this panel's descriptor is confirmed on real hardware (vs captured
  41. // but not yet bench-verified) - surfaced in dump_config(). From display.py.
  42. void set_verified(bool v) { this->verified_ = v; }
  43. // Bench visual-check pattern, bit-depth aware. Everything scales to what
  44. // THIS panel can actually show (see test_colors_): the color-bar count,
  45. // the ladder color cycle and the corner markers all follow the panel's
  46. // real color set instead of a hardcoded 4, so the drawn pattern doubles as
  47. // a statement of what the driver expects of the panel. Adds a dithered grey
  48. // ramp so a 1bpp panel shows a graded sweep, not just two flat blocks.
  49. //
  50. // Pass a font to label the panel with its model (and the panel can spare the
  51. // room); pass nothing to skip the label - handy when you just want a quick
  52. // pattern without defining a font. From the display lambda:
  53. // id(<display_id>).test_pattern(); // no label
  54. // id(<display_id>).test_pattern(id(<font_id>)); // labelled
  55. void test_pattern(display::BaseFont *font = nullptr) {
  56. const int w = this->get_width();
  57. const int h = this->get_height();
  58. Color colors[8];
  59. const int n = this->test_colors_(colors, 8);
  60. this->fill(Color(0xFF, 0xFF, 0xFF));
  61. const int smin = w < h ? w : h;
  62. const int border = smin / 100 > 1 ? smin / 100 : 1;
  63. const int x0 = border;
  64. int y0 = border;
  65. const int iw = w - 2 * border;
  66. int ih = h - 2 * border;
  67. // Name band, above every test zone. Drawn only when a font was passed and
  68. // the panel is tall enough to give it a fifth of the interior without
  69. // crowding the zones below.
  70. if (font != nullptr && this->model_name_ != nullptr && this->model_name_[0] != '\0') {
  71. int tw, xoff, baseline, th;
  72. font->measure(this->model_name_, &tw, &xoff, &baseline, &th);
  73. const int band = th + 4;
  74. if (band <= ih / 5) {
  75. this->print(w / 2, y0 + band / 2, font, Color(0x00, 0x00, 0x00), display::TextAlign::CENTER, this->model_name_);
  76. y0 += band;
  77. ih -= band;
  78. }
  79. }
  80. // Vertical budget for the four zones below any name band.
  81. const int bars_h = ih * 34 / 100;
  82. int dither_h = ih * 12 / 100;
  83. if (dither_h < 8) dither_h = 8;
  84. const int row_h = ih * 18 / 100 > 2 ? ih * 18 / 100 : 2;
  85. const int dy = y0 + bars_h;
  86. const int ry = dy + dither_h;
  87. const int col_y = ry + row_h;
  88. const int col_h = (y0 + ih) - col_y;
  89. // Color bars: one solid block per available color, in palette/wire-code
  90. // order (black, white, then the accents). A wrong or missing block
  91. // points straight at the color - or the wire code - it stands for.
  92. const int bar_w = iw / n;
  93. for (int i = 0; i < n; i++) {
  94. const int bx = x0 + i * bar_w;
  95. const int bw = (i == n - 1) ? (x0 + iw - bx) : bar_w;
  96. this->filled_rectangle(bx, y0, bw, bars_h, colors[i]);
  97. }
  98. // Dithered grey ramp: brightness 255 (left) -> 0 (right) via an ordered
  99. // 4x4 Bayer threshold. On a 1bpp panel this is the only zone that shows
  100. // a graded sweep; on deeper panels it's a quick mono/uniformity check.
  101. static const uint8_t BAYER4[4][4] = {
  102. {0, 8, 2, 10}, {12, 4, 14, 6}, {3, 11, 1, 9}, {15, 7, 13, 5}};
  103. for (int yy = 0; yy < dither_h; yy++) {
  104. for (int xx = 0; xx < iw; xx++) {
  105. const int bright = (iw <= 1) ? 255 : 255 - xx * 255 / (iw - 1);
  106. const int thr = (BAYER4[yy & 3][xx & 3] * 2 + 1) * 255 / 32;
  107. if (bright <= thr)
  108. this->draw_pixel_at(x0 + xx, dy + yy, Color(0x00, 0x00, 0x00));
  109. }
  110. }
  111. // Row ladder: 1px rows cycling the full color set - a dropped, doubled
  112. // or reordered row breaks the N-row cadence.
  113. for (int yy = 0; yy < row_h; yy++)
  114. this->horizontal_line(x0, ry + yy, iw, colors[yy % n]);
  115. // Column ladder: the same rotated 90 degrees, catching nibble/column
  116. // order bugs the row ladder can't (packed formats put several pixels per
  117. // byte, so a column-order fault can leave every row looking fine).
  118. for (int xx = 0; xx < iw; xx++)
  119. this->vertical_line(x0 + xx, col_y, col_h, colors[xx % n]);
  120. // Corner markers for orientation, using the panel's ink colors (every
  121. // color but white). BL is always black; TL/TR take the next inks when
  122. // the panel has them; BR is left blank as the distinct "no marker"
  123. // state. A 90/180 rotation or mirror can't survive this even though the
  124. // bars and ladders are otherwise symmetric.
  125. Color ink[8];
  126. int ni = 0;
  127. for (int i = 0; i < n; i++) {
  128. if (colors[i].red == 0xFF && colors[i].green == 0xFF && colors[i].blue == 0xFF)
  129. continue; // skip white - a white marker is invisible
  130. ink[ni++] = colors[i];
  131. }
  132. const int mk = smin / 12 > 3 ? smin / 12 : 3;
  133. if (ni > 0) this->filled_rectangle(x0, y0 + ih - mk, mk, mk, ink[0]); // BL
  134. if (ni > 1) this->filled_rectangle(x0, y0, mk, mk, ink[1]); // TL
  135. if (ni > 2) this->filled_rectangle(x0 + iw - mk, y0, mk, mk, ink[2]); // TR
  136. // Corner-to-corner diagonals over everything: the cheapest coordinate-
  137. // transform check - a clean line means no row/column reordering.
  138. this->line(0, 0, w - 1, h - 1, Color(0x00, 0x00, 0x00));
  139. this->line(w - 1, 0, 0, h - 1, Color(0x00, 0x00, 0x00));
  140. // Border frame last, so it stays an unbroken rectangle on all four edges
  141. // even where a zone fills to the edge - catches a clipped/offset origin.
  142. this->rectangle(0, 0, w, h, Color(0x00, 0x00, 0x00));
  143. }
  144. void setup() override {
  145. const auto *desc = this->desc_;
  146. // window_per_plane panels (GDEY0579F51's master+slave) size each
  147. // plane's own buffer from plane_width (each region's own local
  148. // width), not the descriptor's overall width (the full logical canvas
  149. // ESPHome draws into) - both regions are the same size here, so one
  150. // plane_bytes_ value covers both buffers.
  151. uint32_t w = desc->window_per_plane ? desc->plane_width : desc->width;
  152. // width*height*bpp/8: /8 at 1bpp, /4 at 2bpp (4-color), /2 at 4bpp (7-color).
  153. this->plane_bytes_ = (uint32_t) w * desc->height * desc->bits_per_pixel / 8;
  154. RAMAllocator<uint8_t> allocator;
  155. this->plane0_ = allocator.allocate(this->plane_bytes_);
  156. bool need_plane1 = desc->plane_count > 1;
  157. this->plane1_ = need_plane1 ? allocator.allocate(this->plane_bytes_) : nullptr;
  158. if (this->plane0_ == nullptr || (need_plane1 && this->plane1_ == nullptr)) {
  159. ESP_LOGE(TAG, "Failed to allocate %u-byte plane buffer(s)", (unsigned) this->plane_bytes_);
  160. this->mark_failed();
  161. return;
  162. }
  163. if (desc->bits_per_pixel > 1) {
  164. // Packed modes: clear every pixel to the panel's white/blank code,
  165. // replicated across the byte - e.g. 4-color white=0x01 -> 0x55, 7-color
  166. // white=0x01 -> 0x11, matching GxEPD2's own writeScreenBuffer() fill
  167. // (color4()*0x55 / color7()|<<4). Both regions of a window_per_plane
  168. // panel (master/slave) get the same blank fill.
  169. uint8_t fill = replicate_code_(desc->blank_code, desc->bits_per_pixel);
  170. memset(this->plane0_, fill, this->plane_bytes_);
  171. if (this->plane1_ != nullptr)
  172. memset(this->plane1_, fill, this->plane_bytes_);
  173. } else {
  174. // 1bpp plane model: plane0 white = all bits set (0xFF); plane1 (the
  175. // accent/red plane, when present) = 0 = not-red.
  176. memset(this->plane0_, 0xFF, this->plane_bytes_);
  177. if (this->plane1_ != nullptr)
  178. memset(this->plane1_, 0x00, this->plane_bytes_);
  179. }
  180. this->spi_.spi_setup();
  181. this->engine_.begin(desc, this->cs_, this->dc_, this->rst_, this->busy_, &this->spi_);
  182. }
  183. // Arms the state machine and returns immediately - the real several-
  184. // seconds-long write/refresh/busy-wait cycle happens across many
  185. // subsequent loop() ticks, not before this call returns.
  186. void update() override {
  187. if (!this->engine_.idle()) {
  188. ESP_LOGW(TAG, "Skipping update: previous display refresh is still running");
  189. return;
  190. }
  191. this->do_update_();
  192. this->engine_.request_full_update(this->plane0_, this->plane1_);
  193. }
  194. void loop() override { this->engine_.step(); }
  195. // Turns off the panel's driving-voltage generation (reduces fading over
  196. // time between refreshes). Call from a lambda, e.g.
  197. // id(<display_id>).power_off(); - not called automatically by update(),
  198. // since this engine does a full hardware reset every cycle regardless of
  199. // prior power state, so correctness never depends on it. A no-op (with a
  200. // warning) while a refresh is still in progress.
  201. void power_off() {
  202. if (!this->engine_.idle()) {
  203. ESP_LOGW(TAG, "Skipping power_off: display refresh still in progress");
  204. return;
  205. }
  206. this->engine_.request_power_off();
  207. }
  208. // power_off() + deep sleep, wakeable only by a hardware reset pulse - which
  209. // the next update() always issues (request_full_update()'s RESET_LOW), so
  210. // no paired "wake" call is needed; just call update() as usual. A no-op
  211. // (with a warning) while a refresh is still in progress.
  212. void hibernate() {
  213. if (!this->engine_.idle()) {
  214. ESP_LOGW(TAG, "Skipping hibernate: display refresh still in progress");
  215. return;
  216. }
  217. this->engine_.request_hibernate();
  218. }
  219. #ifdef USE_GXEPD2_DIAGNOSTICS
  220. // Dev-time diagnostics - compiled out entirely unless this display's YAML
  221. // sets `diagnostics: true` (display.py then adds -DUSE_GXEPD2_DIAGNOSTICS),
  222. // so a production build pays nothing for them. A stash for throwaway bench
  223. // tests, not a stable API - add more here as needed, don't feel obliged to
  224. // keep any of it around once a test has done its job.
  225. //
  226. // Draws the current lambda/pages content and pushes it WITHOUT the reset
  227. // pulse update() normally does first - see
  228. // CycleEngine::diag_request_update_no_reset(). Call from a lambda, e.g. to
  229. // check whether power_off()/hibernate() actually took: call one of those,
  230. // then this with a pattern distinct from what's already on screen - no
  231. // change (or odd BUSY behavior) means the panel really is off-line; follow
  232. // with a normal update() to confirm the next real reset wakes it and to
  233. // leave the panel in a known state either way.
  234. void diag_update_no_reset() {
  235. if (!this->engine_.idle()) {
  236. ESP_LOGW(TAG, "Skipping diag_update_no_reset: display refresh still in progress");
  237. return;
  238. }
  239. this->do_update_();
  240. this->engine_.diag_request_update_no_reset(this->plane0_, this->plane1_);
  241. }
  242. #endif
  243. void dump_config() override {
  244. ESP_LOGCONFIG(TAG, "GxEPD2 Display:");
  245. ESP_LOGCONFIG(TAG, " Dimensions: %ux%u", (unsigned) this->desc_->width, (unsigned) this->desc_->height);
  246. ESP_LOGCONFIG(TAG, " Bits/pixel: %u (%s)", (unsigned) this->desc_->bits_per_pixel,
  247. this->desc_->bits_per_pixel == 1 ? "mono/plane" : "packed palette");
  248. ESP_LOGCONFIG(TAG, " Planes/regions: %u", (unsigned) this->desc_->plane_count);
  249. ESP_LOGCONFIG(TAG, " Busy active level: %s", this->desc_->busy_active_level ? "HIGH" : "LOW");
  250. if (this->desc_->bits_per_pixel == 1)
  251. ESP_LOGCONFIG(TAG, " invert_mono: %s", YESNO(this->invert_mono_));
  252. ESP_LOGCONFIG(TAG, " Hardware-verified: %s", YESNO(this->verified_));
  253. if (!this->verified_)
  254. ESP_LOGW(TAG, "Panel %s is not yet hardware-verified - the captured descriptor may be wrong; "
  255. "if it renders correctly, please report it so it can be marked verified",
  256. this->model_name_ != nullptr ? this->model_name_ : "(unknown)");
  257. LOG_UPDATE_INTERVAL(this);
  258. }
  259. display::DisplayType get_display_type() override { return display::DisplayType::DISPLAY_TYPE_COLOR; }
  260. protected:
  261. // Replicates a packed wire code across a whole byte (one code per pixel
  262. // slot), e.g. 2bpp code 0x01 -> 0x55, 4bpp code 0x01 -> 0x11.
  263. static uint8_t replicate_code_(uint8_t code, uint8_t bpp) {
  264. uint8_t mask = static_cast<uint8_t>((1u << bpp) - 1);
  265. uint8_t out = 0;
  266. for (uint8_t i = 0; i < 8 / bpp; i++)
  267. out = static_cast<uint8_t>((out << bpp) | (code & mask));
  268. return out;
  269. }
  270. // Maps a drawn RGB color to its panel wire code via the descriptor's
  271. // palette: exact matches win (so named colors are deterministic, like
  272. // GxEPD2's color4()/color7() switch), otherwise nearest in RGB space.
  273. static uint8_t classify_(Color c, const EpdPaletteEntry *pal, uint8_t len) {
  274. if (pal == nullptr || len == 0)
  275. return 0;
  276. uint8_t best = 0;
  277. long best_d = -1;
  278. for (uint8_t i = 0; i < len; i++) {
  279. long dr = static_cast<long>(c.red) - pal[i].r;
  280. long dg = static_cast<long>(c.green) - pal[i].g;
  281. long db = static_cast<long>(c.blue) - pal[i].b;
  282. long d = dr * dr + dg * dg + db * db;
  283. if (d == 0)
  284. return pal[i].code;
  285. if (best_d < 0 || d < best_d) {
  286. best_d = d;
  287. best = i;
  288. }
  289. }
  290. return pal[best].code;
  291. }
  292. // Packed code-per-pixel model (bits_per_pixel > 1): N bits/pixel, MSB
  293. // first, matching GxEPD2's own out_data packing in writeImage (4-color
  294. // 4px/byte, 7-color 2px/byte). Routes to the correct region for a
  295. // window_per_plane (master/slave) panel the same way the mono path does.
  296. void draw_packed_(int x, int y, Color color) {
  297. const uint8_t bpp = this->desc_->bits_per_pixel;
  298. uint8_t code = classify_(color, this->desc_->palette, this->desc_->palette_len);
  299. uint16_t stride = this->desc_->width;
  300. uint8_t *buf = this->plane0_;
  301. int local_x = x;
  302. if (this->desc_->window_per_plane && this->desc_->plane_count > 1) {
  303. stride = this->desc_->plane_width;
  304. if (x >= stride) {
  305. buf = this->plane1_;
  306. local_x = x - stride;
  307. }
  308. }
  309. uint32_t px = static_cast<uint32_t>(y) * stride + local_x;
  310. const uint8_t ppb = 8 / bpp;
  311. uint32_t idx = px / ppb;
  312. uint8_t shift = static_cast<uint8_t>((ppb - 1 - (px % ppb)) * bpp);
  313. uint8_t mask = static_cast<uint8_t>((1u << bpp) - 1);
  314. buf[idx] = static_cast<uint8_t>((buf[idx] & ~(mask << shift)) | ((code & mask) << shift));
  315. }
  316. void draw_absolute_pixel_internal(int x, int y, Color color) override {
  317. if (x < 0 || y < 0 || x >= this->desc_->width || y >= this->desc_->height)
  318. return;
  319. if (this->desc_->bits_per_pixel > 1) {
  320. this->draw_packed_(x, y, color);
  321. return;
  322. }
  323. bool red = color.red > color.green && color.red > color.blue && color.red > 0x7f;
  324. bool bright = color.red > 0x7f || color.green > 0x7f || color.blue > 0x7f;
  325. uint32_t idx = (static_cast<uint32_t>(y) * this->desc_->width + x) / 8;
  326. uint8_t mask = 0x80 >> (x % 8);
  327. // Red/accent pixels go to the color plane (when the panel has one),
  328. // everything else is black/white on the black plane. get_display_type()
  329. // reports
  330. // DISPLAY_TYPE_COLOR, so callers draw literal RGB colors, not the
  331. // on/off is_on() convention, even on a plane_count==1 (BW-only) panel -
  332. // there just is no color plane for a "red" classification to land on.
  333. //
  334. // Buffer convention here is 1=red/0=not-red (matching the reference
  335. // epaper_spi driver's EPaperWeAct3C internal convention), transformed
  336. // to the wire value by plane_invert[1] - see PANEL_213_Z98C's comment
  337. // for why that inversion flag and this buffer convention are coupled,
  338. // not independent facts.
  339. if (red && this->plane1_ != nullptr) {
  340. this->plane1_[idx] |= mask;
  341. } else {
  342. if (this->plane1_ != nullptr)
  343. this->plane1_[idx] &= ~mask;
  344. // plane0 bit set = white/blank. invert_mono_ flips the mono sense so a
  345. // bright color (e.g. ESPHome's default COLOR_ON) becomes ink, not blank
  346. // - see display.py's CONF_INVERT_MONO. Red classification is unaffected.
  347. if (bright ^ this->invert_mono_) {
  348. this->plane0_[idx] |= mask;
  349. } else {
  350. this->plane0_[idx] &= ~mask;
  351. }
  352. }
  353. }
  354. int get_width_internal() override { return this->desc_->width; }
  355. int get_height_internal() override { return this->desc_->height; }
  356. // The colors this panel can actually show, each as a representative RGB, in
  357. // a stable order (black, white, then accents). Packed panels (>1bpp): one
  358. // entry per distinct palette wire code, first RGB seen for each. 1bpp:
  359. // black + white, plus red when a second plane exists for the accent (only
  360. // red-classified pixels reach it - see draw_absolute_pixel_internal). This
  361. // is what makes test_pattern() bit-depth aware. Returns the count.
  362. int test_colors_(Color *out, int max) {
  363. int n = 0;
  364. if (this->desc_->bits_per_pixel > 1 && this->desc_->palette != nullptr) {
  365. uint8_t seen[16];
  366. int seen_n = 0;
  367. for (int i = 0; i < this->desc_->palette_len && n < max; i++) {
  368. const uint8_t code = this->desc_->palette[i].code;
  369. bool dup = false;
  370. for (int j = 0; j < seen_n; j++)
  371. if (seen[j] == code) { dup = true; break; }
  372. if (dup) continue;
  373. if (seen_n < (int) sizeof(seen)) seen[seen_n++] = code;
  374. const auto &e = this->desc_->palette[i];
  375. out[n++] = Color(e.r, e.g, e.b);
  376. }
  377. } else {
  378. if (n < max) out[n++] = Color(0x00, 0x00, 0x00); // black
  379. if (n < max) out[n++] = Color(0xFF, 0xFF, 0xFF); // white
  380. if (this->desc_->plane_count >= 2 && n < max) out[n++] = Color(0xFF, 0x00, 0x00); // accent
  381. }
  382. return n;
  383. }
  384. const EpdPanelDescriptor *desc_{nullptr};
  385. const char *model_name_{nullptr};
  386. bool verified_{false};
  387. GPIOPin *cs_{nullptr};
  388. GPIOPin *dc_{nullptr};
  389. GPIOPin *rst_{nullptr};
  390. GPIOPin *busy_{nullptr};
  391. EpdSPIDevice spi_;
  392. CycleEngine engine_;
  393. uint8_t *plane0_{nullptr};
  394. uint8_t *plane1_{nullptr};
  395. uint32_t plane_bytes_{0};
  396. bool invert_mono_{false};
  397. };
  398. } // namespace esphome::gxepd2