ESPHome 2026.3.0
Loading...
Searching...
No Matches
st7701s.cpp
Go to the documentation of this file.
1#ifdef USE_ESP32_VARIANT_ESP32S3
2#include "st7701s.h"
3#include "esphome/core/gpio.h"
4#include "esphome/core/log.h"
5
6namespace esphome {
7namespace st7701s {
8
10 this->spi_setup();
12
13 esp_lcd_rgb_panel_config_t config{};
14 config.flags.fb_in_psram = 1;
15 config.bounce_buffer_size_px = this->width_ * 10;
16 config.num_fbs = 1;
17 config.timings.h_res = this->width_;
18 config.timings.v_res = this->height_;
19 config.timings.hsync_pulse_width = this->hsync_pulse_width_;
20 config.timings.hsync_back_porch = this->hsync_back_porch_;
21 config.timings.hsync_front_porch = this->hsync_front_porch_;
22 config.timings.vsync_pulse_width = this->vsync_pulse_width_;
23 config.timings.vsync_back_porch = this->vsync_back_porch_;
24 config.timings.vsync_front_porch = this->vsync_front_porch_;
25 config.timings.flags.pclk_active_neg = this->pclk_inverted_;
26 config.timings.pclk_hz = this->pclk_frequency_;
27 config.clk_src = LCD_CLK_SRC_PLL160M;
28 size_t data_pin_count = sizeof(this->data_pins_) / sizeof(this->data_pins_[0]);
29 for (size_t i = 0; i != data_pin_count; i++) {
30 config.data_gpio_nums[i] = this->data_pins_[i]->get_pin();
31 }
32 config.data_width = data_pin_count;
33 config.disp_gpio_num = -1;
34 config.hsync_gpio_num = this->hsync_pin_->get_pin();
35 config.vsync_gpio_num = this->vsync_pin_->get_pin();
36 config.de_gpio_num = this->de_pin_->get_pin();
37 config.pclk_gpio_num = this->pclk_pin_->get_pin();
38 esp_err_t err = esp_lcd_new_rgb_panel(&config, &this->handle_);
39 if (err != ESP_OK) {
40 esph_log_e(TAG, "lcd_new_rgb_panel failed: %s", esp_err_to_name(err));
41 this->mark_failed();
42 return;
43 }
44 ESP_ERROR_CHECK(esp_lcd_panel_reset(this->handle_));
45 ESP_ERROR_CHECK(esp_lcd_panel_init(this->handle_));
46}
47
49 if (this->handle_ != nullptr)
50 esp_lcd_rgb_panel_restart(this->handle_);
51}
52
53void ST7701S::draw_pixels_at(int x_start, int y_start, int w, int h, const uint8_t *ptr, display::ColorOrder order,
54 display::ColorBitness bitness, bool big_endian, int x_offset, int y_offset, int x_pad) {
55 if (w <= 0 || h <= 0)
56 return;
57 // if color mapping is required, pass the buck.
58 // note that endianness is not considered here - it is assumed to match!
59 if (bitness != display::COLOR_BITNESS_565) {
60 return display::Display::draw_pixels_at(x_start, y_start, w, h, ptr, order, bitness, big_endian, x_offset, y_offset,
61 x_pad);
62 }
63 x_start += this->offset_x_;
64 y_start += this->offset_y_;
65 esp_err_t err;
66 // x_ and y_offset are offsets into the source buffer, unrelated to our own offsets into the display.
67 if (x_offset == 0 && x_pad == 0 && y_offset == 0) {
68 // we could deal here with a non-zero y_offset, but if x_offset is zero, y_offset probably will be so don't bother
69 err = esp_lcd_panel_draw_bitmap(this->handle_, x_start, y_start, x_start + w, y_start + h, ptr);
70 } else {
71 // draw line by line
72 auto stride = x_offset + w + x_pad;
73 for (int y = 0; y != h; y++) {
74 err = esp_lcd_panel_draw_bitmap(this->handle_, x_start, y + y_start, x_start + w, y + y_start + 1,
75 ptr + ((y + y_offset) * stride + x_offset) * 2);
76 if (err != ESP_OK)
77 break;
78 }
79 }
80 if (err != ESP_OK)
81 esph_log_e(TAG, "lcd_lcd_panel_draw_bitmap failed: %s", esp_err_to_name(err));
82}
83
84void ST7701S::draw_pixel_at(int x, int y, Color color) {
85 if (!this->get_clipping().inside(x, y))
86 return; // NOLINT
87
88 switch (this->rotation_) {
90 break;
92 std::swap(x, y);
93 x = this->width_ - x - 1;
94 break;
96 x = this->width_ - x - 1;
97 y = this->height_ - y - 1;
98 break;
100 std::swap(x, y);
101 y = this->height_ - y - 1;
102 break;
103 }
105
106 this->draw_pixels_at(x, y, 1, 1, (const uint8_t *) &pixel, display::COLOR_ORDER_RGB, display::COLOR_BITNESS_565, true,
107 0, 0, 0);
108 App.feed_wdt();
109}
110
111void ST7701S::write_command_(uint8_t value) {
112 this->enable();
113 if (this->dc_pin_ == nullptr) {
114 this->write(value, 9);
115 } else {
116 this->dc_pin_->digital_write(false);
117 this->write_byte(value);
118 this->dc_pin_->digital_write(true);
119 }
120 this->disable();
121}
122
123void ST7701S::write_data_(uint8_t value) {
124 this->enable();
125 if (this->dc_pin_ == nullptr) {
126 this->write(value | 0x100, 9);
127 } else {
128 this->dc_pin_->digital_write(true);
129 this->write_byte(value);
130 }
131 this->disable();
132}
133
138void ST7701S::write_sequence_(uint8_t cmd, size_t len, const uint8_t *bytes) {
139 this->write_command_(cmd);
140 while (len-- != 0)
141 this->write_data_(*bytes++);
142}
143
145 for (size_t i = 0; i != this->init_sequence_.size();) {
146 uint8_t cmd = this->init_sequence_[i++];
147 size_t len = this->init_sequence_[i++];
148 if (len == ST7701S_DELAY_FLAG) {
149 ESP_LOGV(TAG, "Delay %dms", cmd);
150 delay(cmd);
151 } else {
152 this->write_sequence_(cmd, len, &this->init_sequence_[i]);
153 i += len;
154 ESP_LOGV(TAG, "Command %X, %d bytes", cmd, len);
155 if (cmd == SW_RESET_CMD)
156 delay(6);
157 }
158 }
159 // st7701 does not appear to support axis swapping
161 this->write_command_(SDIR_CMD); // this is in the BK0 command set
162 this->write_data_(this->mirror_x_ ? 0x04 : 0x00);
163 uint8_t val = this->color_mode_ == display::COLOR_ORDER_BGR ? 0x08 : 0x00;
164 if (this->mirror_y_)
165 val |= 0x10;
167 this->write_data_(val);
168 ESP_LOGD(TAG, "write MADCTL %X", val);
170 // can't avoid this inline delay due to the need to complete setup before anything else tries to draw.
171 delay(120); // NOLINT
174 this->spi_teardown(); // SPI not needed after this
175 delay(10);
176}
177
179 ESP_LOGCONFIG("", "ST7701S RGB LCD");
180 ESP_LOGCONFIG(TAG,
181 " Height: %u\n"
182 " Width: %u",
183 this->height_, this->width_);
184 LOG_PIN(" CS Pin: ", this->cs_);
185 LOG_PIN(" DC Pin: ", this->dc_pin_);
186 LOG_PIN(" DE Pin: ", this->de_pin_);
187 LOG_PIN(" Reset Pin: ", this->reset_pin_);
188 size_t data_pin_count = sizeof(this->data_pins_) / sizeof(this->data_pins_[0]);
189 char pin_summary[GPIO_SUMMARY_MAX_LEN];
190 for (size_t i = 0; i != data_pin_count; i++) {
191 this->data_pins_[i]->dump_summary(pin_summary, sizeof(pin_summary));
192 ESP_LOGCONFIG(TAG, " Data pin %d: %s", i, pin_summary);
193 }
194 ESP_LOGCONFIG(TAG, " SPI Data rate: %dMHz", (unsigned) (this->data_rate_ / 1000000));
195}
196
197} // namespace st7701s
198} // namespace esphome
199#endif // USE_ESP32_VARIANT_ESP32S3
uint8_t h
Definition bl0906.h:2
void feed_wdt(uint32_t time=0)
void mark_failed()
Mark this component as failed.
virtual void digital_write(bool value)=0
virtual size_t dump_summary(char *buffer, size_t len) const
Write a summary of this pin to the provided buffer.
Definition gpio.h:129
virtual uint8_t get_pin() const =0
static uint16_t color_to_565(Color color, ColorOrder color_order=ColorOrder::COLOR_ORDER_RGB)
Rect get_clipping() const
Get the current the clipping rectangle.
Definition display.cpp:766
DisplayRotation rotation_
Definition display.h:790
virtual void draw_pixels_at(int x_start, int y_start, int w, int h, const uint8_t *ptr, ColorOrder order, ColorBitness bitness, bool big_endian, int x_offset, int y_offset, int x_pad)
Given an array of pixels encoded in the nominated format, draw these into the display's buffer.
Definition display.cpp:54
uint32_t data_rate_
Definition spi.h:410
void setup() override
Definition st7701s.cpp:9
InternalGPIOPin * data_pins_[16]
Definition st7701s.h:93
void draw_pixels_at(int x_start, int y_start, int w, int h, const uint8_t *ptr, display::ColorOrder order, display::ColorBitness bitness, bool big_endian, int x_offset, int y_offset, int x_pad) override
Definition st7701s.cpp:53
void write_sequence_(uint8_t cmd, size_t len, const uint8_t *bytes)
this relies upon the init sequence being well-formed, which is guaranteed by the Python init code.
Definition st7701s.cpp:138
uint16_t vsync_front_porch_
Definition st7701s.h:99
esp_lcd_panel_handle_t handle_
Definition st7701s.h:113
InternalGPIOPin * vsync_pin_
Definition st7701s.h:90
void draw_pixel_at(int x, int y, Color color) override
Definition st7701s.cpp:84
InternalGPIOPin * de_pin_
Definition st7701s.h:87
uint16_t vsync_pulse_width_
Definition st7701s.h:97
void write_data_(uint8_t value)
Definition st7701s.cpp:123
display::ColorOrder color_mode_
Definition st7701s.h:105
uint16_t hsync_pulse_width_
Definition st7701s.h:94
std::vector< uint8_t > init_sequence_
Definition st7701s.h:100
void dump_config() override
Definition st7701s.cpp:178
void write_command_(uint8_t value)
Definition st7701s.cpp:111
InternalGPIOPin * hsync_pin_
Definition st7701s.h:89
InternalGPIOPin * pclk_pin_
Definition st7701s.h:88
uint16_t hsync_front_porch_
Definition st7701s.h:96
void loop() override
Definition st7701s.cpp:48
mopeka_std_values val[3]
@ DISPLAY_ROTATION_0_DEGREES
Definition display.h:135
@ DISPLAY_ROTATION_270_DEGREES
Definition display.h:138
@ DISPLAY_ROTATION_180_DEGREES
Definition display.h:137
@ DISPLAY_ROTATION_90_DEGREES
Definition display.h:136
const uint8_t SLEEP_OUT
Definition st7701s.h:20
const uint8_t SDIR_CMD
Definition st7701s.h:21
const uint8_t ST7701S_DELAY_FLAG
Definition st7701s.h:28
const uint8_t INVERT_ON
Definition st7701s.h:24
const uint8_t MADCTL_CMD
Definition st7701s.h:22
const uint8_t SW_RESET_CMD
Definition st7701s.h:19
const uint8_t CMD2_BK0[5]
Definition st7701s.h:27
const uint8_t DISPLAY_ON
Definition st7701s.h:25
const uint8_t CMD2_BKSEL
Definition st7701s.h:26
const uint8_t INVERT_OFF
Definition st7701s.h:23
Providing packet encoding functions for exchanging data with a remote host.
Definition a01nyub.cpp:7
constexpr T convert_big_endian(T val)
Convert a value between host byte order and big endian (most significant byte first) order.
Definition helpers.h:784
std::string size_t len
Definition helpers.h:892
constexpr size_t GPIO_SUMMARY_MAX_LEN
Maximum buffer size for dump_summary output.
Definition gpio.h:13
void HOT delay(uint32_t ms)
Definition core.cpp:28
Application App
Global storage of Application pointer - only one Application can exist.
uint16_t x
Definition tt21100.cpp:5
uint16_t y
Definition tt21100.cpp:6