gxepd2_display.h 6.2 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148
  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_213_z98c.h"
  8. #include "panel_290c_gdey029f51.h"
  9. #include "panel_426_gdeq0426t82.h"
  10. #include "panel_579c_gdey0579f51_master_only.h"
  11. #include "panel_583_gdeq0583t31.h"
  12. namespace esphome::gxepd2 {
  13. static const char *const TAG = "gxepd2";
  14. // Native chunked-engine replacement for the old GxEPD2-template/FreeRTOS-task
  15. // component - see the plan this was built from (and project memory entry
  16. // gxepd2_task_watchdog_status) for why. Panels arrive as hand-written
  17. // (later, extracted) descriptors selected at runtime via set_descriptor(),
  18. // not by templating this class over GxEPD2's own driver classes.
  19. class GxEPD2Display : public display::DisplayBuffer {
  20. public:
  21. void set_cs_pin(GPIOPin *pin) { this->cs_ = pin; }
  22. void set_dc_pin(GPIOPin *pin) { this->dc_ = pin; }
  23. void set_reset_pin(GPIOPin *pin) { this->rst_ = pin; }
  24. void set_busy_pin(GPIOPin *pin) { this->busy_ = pin; }
  25. void set_spi_parent(spi::SPIComponent *parent) { this->spi_.set_spi_parent(parent); }
  26. void set_descriptor(const EpdPanelDescriptor *desc) { this->desc_ = desc; }
  27. void setup() override {
  28. const auto *desc = this->desc_;
  29. this->plane_bytes_ = desc->packed_2bpp_plane ? (static_cast<uint32_t>(desc->width) * desc->height) / 4
  30. : (static_cast<uint32_t>(desc->width) * desc->height) / 8;
  31. RAMAllocator<uint8_t> allocator;
  32. this->plane0_ = allocator.allocate(this->plane_bytes_);
  33. bool need_plane1 = !desc->packed_2bpp_plane && desc->plane_count > 1;
  34. this->plane1_ = need_plane1 ? allocator.allocate(this->plane_bytes_) : nullptr;
  35. if (this->plane0_ == nullptr || (need_plane1 && this->plane1_ == nullptr)) {
  36. ESP_LOGE(TAG, "Failed to allocate %u-byte plane buffer(s)", (unsigned) this->plane_bytes_);
  37. this->mark_failed();
  38. return;
  39. }
  40. // Packed 2bpp: code 0x01 (white) repeated 4x/byte = 0x55, matching
  41. // GxEPD2's own writeScreenBuffer()'s white fill value exactly - not
  42. // 0xFF (that's the 1bpp planes' white) or 0x00 (that's black here).
  43. memset(this->plane0_, desc->packed_2bpp_plane ? 0x55 : 0xFF, this->plane_bytes_);
  44. if (this->plane1_ != nullptr)
  45. memset(this->plane1_, 0x00, this->plane_bytes_); // 0 = not-red
  46. this->spi_.spi_setup();
  47. this->engine_.begin(desc, this->cs_, this->dc_, this->rst_, this->busy_, &this->spi_);
  48. }
  49. // Arms the state machine and returns immediately - the real several-
  50. // seconds-long write/refresh/busy-wait cycle happens across many
  51. // subsequent loop() ticks, not before this call returns.
  52. void update() override {
  53. if (!this->engine_.idle()) {
  54. ESP_LOGW(TAG, "Skipping update: previous display refresh is still running");
  55. return;
  56. }
  57. this->do_update_();
  58. this->engine_.request_full_update(this->plane0_, this->plane1_);
  59. }
  60. void loop() override { this->engine_.step(); }
  61. void dump_config() override {
  62. ESP_LOGCONFIG(TAG, "GxEPD2 Display");
  63. LOG_UPDATE_INTERVAL(this);
  64. }
  65. display::DisplayType get_display_type() override { return display::DisplayType::DISPLAY_TYPE_COLOR; }
  66. protected:
  67. void draw_absolute_pixel_internal(int x, int y, Color color) override {
  68. if (x < 0 || y < 0 || x >= this->desc_->width || y >= this->desc_->height)
  69. return;
  70. bool red = color.red > color.green && color.red > color.blue && color.red > 0x7f;
  71. bool bright = color.red > 0x7f || color.green > 0x7f || color.blue > 0x7f;
  72. if (this->desc_->packed_2bpp_plane) {
  73. // JD79667/HX8717-family panels: 2 bits/pixel, 4 pixels/byte, MSB
  74. // first (matches GxEPD2's own out_data <<= 2 packing order in e.g.
  75. // GxEPD2_290c_GDEY029F51::writeImage). Codes match GxEPD2_4C.h's own
  76. // color4() table exactly: black=0x00, white=0x01, yellow=0x02,
  77. // red=0x03 - confirmed against that table after first getting
  78. // black/white backwards by misreading writeImage's own
  79. // black_data-bit ternary (2026-09-19).
  80. bool yellow = color.red > 0x7f && color.green > 0x7f && color.blue <= 0x7f;
  81. uint8_t code;
  82. if (red)
  83. code = 0x03;
  84. else if (yellow)
  85. code = 0x02;
  86. else if (bright)
  87. code = 0x01;
  88. else
  89. code = 0x00;
  90. uint32_t px = static_cast<uint32_t>(y) * this->desc_->width + x;
  91. uint32_t idx = px / 4;
  92. uint8_t shift = static_cast<uint8_t>((3 - (px % 4)) * 2);
  93. this->plane0_[idx] = static_cast<uint8_t>((this->plane0_[idx] & ~(0x03 << shift)) | (code << shift));
  94. return;
  95. }
  96. uint32_t idx = (static_cast<uint32_t>(y) * this->desc_->width + x) / 8;
  97. uint8_t mask = 0x80 >> (x % 8);
  98. // Same classification the old task-based component used: red/accent
  99. // pixels go to the color plane (when the panel has one), everything
  100. // else is black/white on the black plane. get_display_type() reports
  101. // DISPLAY_TYPE_COLOR, so callers draw literal RGB colors, not the
  102. // on/off is_on() convention, even on a plane_count==1 (BW-only) panel -
  103. // there just is no color plane for a "red" classification to land on.
  104. //
  105. // Buffer convention here is 1=red/0=not-red (matching the reference
  106. // epaper_spi driver's EPaperWeAct3C internal convention), transformed
  107. // to the wire value by plane_invert[1] - see PANEL_213_Z98C's comment
  108. // for why that inversion flag and this buffer convention are coupled,
  109. // not independent facts.
  110. if (red && this->plane1_ != nullptr) {
  111. this->plane1_[idx] |= mask;
  112. } else {
  113. if (this->plane1_ != nullptr)
  114. this->plane1_[idx] &= ~mask;
  115. if (bright) {
  116. this->plane0_[idx] |= mask;
  117. } else {
  118. this->plane0_[idx] &= ~mask;
  119. }
  120. }
  121. }
  122. int get_width_internal() override { return this->desc_->width; }
  123. int get_height_internal() override { return this->desc_->height; }
  124. const EpdPanelDescriptor *desc_{nullptr};
  125. GPIOPin *cs_{nullptr};
  126. GPIOPin *dc_{nullptr};
  127. GPIOPin *rst_{nullptr};
  128. GPIOPin *busy_{nullptr};
  129. EpdSPIDevice spi_;
  130. CycleEngine engine_;
  131. uint8_t *plane0_{nullptr};
  132. uint8_t *plane1_{nullptr};
  133. uint32_t plane_bytes_{0};
  134. };
  135. } // namespace esphome::gxepd2