gxepd2_display.h 4.6 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117
  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_426_gdeq0426t82.h"
  9. #include "panel_583_gdeq0583t31.h"
  10. namespace esphome::gxepd2 {
  11. static const char *const TAG = "gxepd2";
  12. // Native chunked-engine replacement for the old GxEPD2-template/FreeRTOS-task
  13. // component - see the plan this was built from (and project memory entry
  14. // gxepd2_task_watchdog_status) for why. Panels arrive as hand-written
  15. // (later, extracted) descriptors selected at runtime via set_descriptor(),
  16. // not by templating this class over GxEPD2's own driver classes.
  17. class GxEPD2Display : public display::DisplayBuffer {
  18. public:
  19. void set_cs_pin(GPIOPin *pin) { this->cs_ = pin; }
  20. void set_dc_pin(GPIOPin *pin) { this->dc_ = pin; }
  21. void set_reset_pin(GPIOPin *pin) { this->rst_ = pin; }
  22. void set_busy_pin(GPIOPin *pin) { this->busy_ = pin; }
  23. void set_spi_parent(spi::SPIComponent *parent) { this->spi_.set_spi_parent(parent); }
  24. void set_descriptor(const EpdPanelDescriptor *desc) { this->desc_ = desc; }
  25. void setup() override {
  26. const auto *desc = this->desc_;
  27. this->plane_bytes_ = (static_cast<uint32_t>(desc->width) * desc->height) / 8;
  28. RAMAllocator<uint8_t> allocator;
  29. this->plane0_ = allocator.allocate(this->plane_bytes_);
  30. this->plane1_ = desc->plane_count > 1 ? allocator.allocate(this->plane_bytes_) : nullptr;
  31. if (this->plane0_ == nullptr || (desc->plane_count > 1 && this->plane1_ == nullptr)) {
  32. ESP_LOGE(TAG, "Failed to allocate %u-byte plane buffer(s)", (unsigned) this->plane_bytes_);
  33. this->mark_failed();
  34. return;
  35. }
  36. memset(this->plane0_, 0xFF, this->plane_bytes_); // 1 = white
  37. if (this->plane1_ != nullptr)
  38. memset(this->plane1_, 0x00, this->plane_bytes_); // 0 = not-red
  39. this->spi_.spi_setup();
  40. this->engine_.begin(desc, this->cs_, this->dc_, this->rst_, this->busy_, &this->spi_);
  41. }
  42. // Arms the state machine and returns immediately - the real several-
  43. // seconds-long write/refresh/busy-wait cycle happens across many
  44. // subsequent loop() ticks, not before this call returns.
  45. void update() override {
  46. if (!this->engine_.idle()) {
  47. ESP_LOGW(TAG, "Skipping update: previous display refresh is still running");
  48. return;
  49. }
  50. this->do_update_();
  51. this->engine_.request_full_update(this->plane0_, this->plane1_);
  52. }
  53. void loop() override { this->engine_.step(); }
  54. void dump_config() override {
  55. ESP_LOGCONFIG(TAG, "GxEPD2 Display");
  56. LOG_UPDATE_INTERVAL(this);
  57. }
  58. display::DisplayType get_display_type() override { return display::DisplayType::DISPLAY_TYPE_COLOR; }
  59. protected:
  60. void draw_absolute_pixel_internal(int x, int y, Color color) override {
  61. if (x < 0 || y < 0 || x >= this->desc_->width || y >= this->desc_->height)
  62. return;
  63. uint32_t idx = (static_cast<uint32_t>(y) * this->desc_->width + x) / 8;
  64. uint8_t mask = 0x80 >> (x % 8);
  65. // Same classification the old task-based component used: red/accent
  66. // pixels go to the color plane (when the panel has one), everything
  67. // else is black/white on the black plane. get_display_type() reports
  68. // DISPLAY_TYPE_COLOR, so callers draw literal RGB colors, not the
  69. // on/off is_on() convention, even on a plane_count==1 (BW-only) panel -
  70. // there just is no color plane for a "red" classification to land on.
  71. //
  72. // Buffer convention here is 1=red/0=not-red (matching the reference
  73. // epaper_spi driver's EPaperWeAct3C internal convention), transformed
  74. // to the wire value by plane_invert[1] - see PANEL_213_Z98C's comment
  75. // for why that inversion flag and this buffer convention are coupled,
  76. // not independent facts.
  77. bool red = color.red > color.green && color.red > color.blue && color.red > 0x7f;
  78. bool bright = color.red > 0x7f || color.green > 0x7f || color.blue > 0x7f;
  79. if (red && this->plane1_ != nullptr) {
  80. this->plane1_[idx] |= mask;
  81. } else {
  82. if (this->plane1_ != nullptr)
  83. this->plane1_[idx] &= ~mask;
  84. if (bright) {
  85. this->plane0_[idx] |= mask;
  86. } else {
  87. this->plane0_[idx] &= ~mask;
  88. }
  89. }
  90. }
  91. int get_width_internal() override { return this->desc_->width; }
  92. int get_height_internal() override { return this->desc_->height; }
  93. const EpdPanelDescriptor *desc_{nullptr};
  94. GPIOPin *cs_{nullptr};
  95. GPIOPin *dc_{nullptr};
  96. GPIOPin *rst_{nullptr};
  97. GPIOPin *busy_{nullptr};
  98. EpdSPIDevice spi_;
  99. CycleEngine engine_;
  100. uint8_t *plane0_{nullptr};
  101. uint8_t *plane1_{nullptr};
  102. uint32_t plane_bytes_{0};
  103. };
  104. } // namespace esphome::gxepd2