gxepd2_display.h 17 KB

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