From d0dda489321db07595cc15f93f5fa376f278ada0 Mon Sep 17 00:00:00 2001 From: guillempages Date: Fri, 3 Jun 2022 05:39:04 +0200 Subject: [PATCH] Add display_type property to DisplayBuffer (#3430) Co-authored-by: Jesse Hills <3060199+jesserockz@users.noreply.github.com> --- .../addressable_light/addressable_light_display.h | 2 ++ esphome/components/display/display_buffer.h | 11 +++++++++++ esphome/components/ili9341/ili9341_display.h | 2 ++ esphome/components/inkplate6/inkplate.h | 4 ++++ esphome/components/max7219digit/max7219digit.h | 2 ++ esphome/components/pcd8544/pcd_8544.h | 2 ++ esphome/components/ssd1306_base/ssd1306_base.h | 2 ++ esphome/components/ssd1322_base/ssd1322_base.h | 2 ++ esphome/components/ssd1325_base/ssd1325_base.h | 2 ++ esphome/components/ssd1327_base/ssd1327_base.h | 2 ++ esphome/components/ssd1331_base/ssd1331_base.h | 2 ++ esphome/components/ssd1351_base/ssd1351_base.h | 2 ++ esphome/components/st7735/st7735.h | 2 ++ esphome/components/st7789v/st7789v.h | 2 ++ esphome/components/st7920/st7920.h | 2 ++ .../components/waveshare_epaper/waveshare_epaper.h | 2 ++ 16 files changed, 43 insertions(+) diff --git a/esphome/components/addressable_light/addressable_light_display.h b/esphome/components/addressable_light/addressable_light_display.h index 163faf27b0..dfafe9d98d 100644 --- a/esphome/components/addressable_light/addressable_light_display.h +++ b/esphome/components/addressable_light/addressable_light_display.h @@ -40,6 +40,8 @@ class AddressableLightDisplay : public display::DisplayBuffer, public PollingCom void setup() override; void display(); + display::DisplayType get_display_type() override { return display::DisplayType::DISPLAY_TYPE_COLOR; } + protected: int get_width_internal() override; int get_height_internal() override; diff --git a/esphome/components/display/display_buffer.h b/esphome/components/display/display_buffer.h index 33f55aa3d1..dc6bbdf350 100644 --- a/esphome/components/display/display_buffer.h +++ b/esphome/components/display/display_buffer.h @@ -85,6 +85,12 @@ enum ImageType { IMAGE_TYPE_RGB565 = 4, }; +enum DisplayType { + DISPLAY_TYPE_BINARY = 1, + DISPLAY_TYPE_GRAYSCALE = 2, + DISPLAY_TYPE_COLOR = 3, +}; + enum DisplayRotation { DISPLAY_ROTATION_0_DEGREES = 0, DISPLAY_ROTATION_90_DEGREES = 90, @@ -361,6 +367,11 @@ class DisplayBuffer { virtual int get_width_internal() = 0; DisplayRotation get_rotation() const { return this->rotation_; } + /** Get the type of display that the buffer corresponds to. In case of dynamically configurable displays, + * returns the type the display is currently configured to. + */ + virtual DisplayType get_display_type() = 0; + protected: void vprintf_(int x, int y, Font *font, Color color, TextAlign align, const char *format, va_list arg); diff --git a/esphome/components/ili9341/ili9341_display.h b/esphome/components/ili9341/ili9341_display.h index 6014dbf9a6..e568eead40 100644 --- a/esphome/components/ili9341/ili9341_display.h +++ b/esphome/components/ili9341/ili9341_display.h @@ -48,6 +48,8 @@ class ILI9341Display : public PollingComponent, this->initialize(); } + display::DisplayType get_display_type() override { return display::DisplayType::DISPLAY_TYPE_COLOR; } + protected: void draw_absolute_pixel_internal(int x, int y, Color color) override; void setup_pins_(); diff --git a/esphome/components/inkplate6/inkplate.h b/esphome/components/inkplate6/inkplate.h index 9355154c5a..e650b57631 100644 --- a/esphome/components/inkplate6/inkplate.h +++ b/esphome/components/inkplate6/inkplate.h @@ -86,6 +86,10 @@ class Inkplate6 : public PollingComponent, public display::DisplayBuffer, public void block_partial() { this->block_partial_ = true; } + display::DisplayType get_display_type() override { + return get_greyscale() ? display::DisplayType::DISPLAY_TYPE_GRAYSCALE : display::DisplayType::DISPLAY_TYPE_BINARY; + } + protected: void draw_absolute_pixel_internal(int x, int y, Color color) override; void display1b_(); diff --git a/esphome/components/max7219digit/max7219digit.h b/esphome/components/max7219digit/max7219digit.h index 3bf934632f..3552c6b9d5 100644 --- a/esphome/components/max7219digit/max7219digit.h +++ b/esphome/components/max7219digit/max7219digit.h @@ -93,6 +93,8 @@ class MAX7219Component : public PollingComponent, uint8_t strftimedigit(const char *format, time::ESPTime time) __attribute__((format(strftime, 2, 0))); #endif + display::DisplayType get_display_type() override { return display::DisplayType::DISPLAY_TYPE_BINARY; } + protected: void send_byte_(uint8_t a_register, uint8_t data); void send_to_all_(uint8_t a_register, uint8_t data); diff --git a/esphome/components/pcd8544/pcd_8544.h b/esphome/components/pcd8544/pcd_8544.h index b57662bbd9..9a69a9fec7 100644 --- a/esphome/components/pcd8544/pcd_8544.h +++ b/esphome/components/pcd8544/pcd_8544.h @@ -52,6 +52,8 @@ class PCD8544 : public PollingComponent, this->initialize(); } + display::DisplayType get_display_type() override { return display::DisplayType::DISPLAY_TYPE_BINARY; } + protected: void draw_absolute_pixel_internal(int x, int y, Color color) override; diff --git a/esphome/components/ssd1306_base/ssd1306_base.h b/esphome/components/ssd1306_base/ssd1306_base.h index 5ab68143c7..2f5baffb69 100644 --- a/esphome/components/ssd1306_base/ssd1306_base.h +++ b/esphome/components/ssd1306_base/ssd1306_base.h @@ -48,6 +48,8 @@ class SSD1306 : public PollingComponent, public display::DisplayBuffer { float get_setup_priority() const override { return setup_priority::PROCESSOR; } void fill(Color color) override; + display::DisplayType get_display_type() override { return display::DisplayType::DISPLAY_TYPE_BINARY; } + protected: virtual void command(uint8_t value) = 0; virtual void write_display_data() = 0; diff --git a/esphome/components/ssd1322_base/ssd1322_base.h b/esphome/components/ssd1322_base/ssd1322_base.h index 6a790c0199..d672b298d6 100644 --- a/esphome/components/ssd1322_base/ssd1322_base.h +++ b/esphome/components/ssd1322_base/ssd1322_base.h @@ -30,6 +30,8 @@ class SSD1322 : public PollingComponent, public display::DisplayBuffer { float get_setup_priority() const override { return setup_priority::PROCESSOR; } void fill(Color color) override; + display::DisplayType get_display_type() override { return display::DisplayType::DISPLAY_TYPE_GRAYSCALE; } + protected: virtual void command(uint8_t value) = 0; virtual void data(uint8_t value) = 0; diff --git a/esphome/components/ssd1325_base/ssd1325_base.h b/esphome/components/ssd1325_base/ssd1325_base.h index cca9412c43..8ba6a56c8b 100644 --- a/esphome/components/ssd1325_base/ssd1325_base.h +++ b/esphome/components/ssd1325_base/ssd1325_base.h @@ -35,6 +35,8 @@ class SSD1325 : public PollingComponent, public display::DisplayBuffer { float get_setup_priority() const override { return setup_priority::PROCESSOR; } void fill(Color color) override; + display::DisplayType get_display_type() override { return display::DisplayType::DISPLAY_TYPE_BINARY; } + protected: virtual void command(uint8_t value) = 0; virtual void write_display_data() = 0; diff --git a/esphome/components/ssd1327_base/ssd1327_base.h b/esphome/components/ssd1327_base/ssd1327_base.h index 35b021c71b..5639beb828 100644 --- a/esphome/components/ssd1327_base/ssd1327_base.h +++ b/esphome/components/ssd1327_base/ssd1327_base.h @@ -30,6 +30,8 @@ class SSD1327 : public PollingComponent, public display::DisplayBuffer { float get_setup_priority() const override { return setup_priority::PROCESSOR; } void fill(Color color) override; + display::DisplayType get_display_type() override { return display::DisplayType::DISPLAY_TYPE_GRAYSCALE; } + protected: virtual void command(uint8_t value) = 0; virtual void write_display_data() = 0; diff --git a/esphome/components/ssd1331_base/ssd1331_base.h b/esphome/components/ssd1331_base/ssd1331_base.h index b889a47fbe..be5713f208 100644 --- a/esphome/components/ssd1331_base/ssd1331_base.h +++ b/esphome/components/ssd1331_base/ssd1331_base.h @@ -25,6 +25,8 @@ class SSD1331 : public PollingComponent, public display::DisplayBuffer { float get_setup_priority() const override { return setup_priority::PROCESSOR; } void fill(Color color) override; + display::DisplayType get_display_type() override { return display::DisplayType::DISPLAY_TYPE_COLOR; } + protected: virtual void command(uint8_t value) = 0; virtual void write_display_data() = 0; diff --git a/esphome/components/ssd1351_base/ssd1351_base.h b/esphome/components/ssd1351_base/ssd1351_base.h index 422e601f8b..2f1e0237cd 100644 --- a/esphome/components/ssd1351_base/ssd1351_base.h +++ b/esphome/components/ssd1351_base/ssd1351_base.h @@ -31,6 +31,8 @@ class SSD1351 : public PollingComponent, public display::DisplayBuffer { float get_setup_priority() const override { return setup_priority::PROCESSOR; } void fill(Color color) override; + display::DisplayType get_display_type() override { return display::DisplayType::DISPLAY_TYPE_COLOR; } + protected: virtual void command(uint8_t value) = 0; virtual void data(uint8_t value) = 0; diff --git a/esphome/components/st7735/st7735.h b/esphome/components/st7735/st7735.h index c049fb9e83..3baa9b083a 100644 --- a/esphome/components/st7735/st7735.h +++ b/esphome/components/st7735/st7735.h @@ -53,6 +53,8 @@ class ST7735 : public PollingComponent, void set_dc_pin(GPIOPin *value) { dc_pin_ = value; } size_t get_buffer_length(); + display::DisplayType get_display_type() override { return display::DisplayType::DISPLAY_TYPE_COLOR; } + protected: void sendcommand_(uint8_t cmd, const uint8_t *data_bytes, uint8_t num_data_bytes); void senddata_(const uint8_t *data_bytes, uint8_t num_data_bytes); diff --git a/esphome/components/st7789v/st7789v.h b/esphome/components/st7789v/st7789v.h index 2aef043ba0..e655d22e2b 100644 --- a/esphome/components/st7789v/st7789v.h +++ b/esphome/components/st7789v/st7789v.h @@ -126,6 +126,8 @@ class ST7789V : public PollingComponent, void write_display_data(); + display::DisplayType get_display_type() override { return display::DisplayType::DISPLAY_TYPE_COLOR; } + protected: GPIOPin *dc_pin_; GPIOPin *reset_pin_{nullptr}; diff --git a/esphome/components/st7920/st7920.h b/esphome/components/st7920/st7920.h index 5f32e7ff23..c00b7cf5e0 100644 --- a/esphome/components/st7920/st7920.h +++ b/esphome/components/st7920/st7920.h @@ -29,6 +29,8 @@ class ST7920 : public PollingComponent, void fill(Color color) override; void write_display_data(); + display::DisplayType get_display_type() override { return display::DisplayType::DISPLAY_TYPE_BINARY; } + protected: void draw_absolute_pixel_internal(int x, int y, Color color) override; int get_height_internal() override; diff --git a/esphome/components/waveshare_epaper/waveshare_epaper.h b/esphome/components/waveshare_epaper/waveshare_epaper.h index 7a88fecbdb..e613899149 100644 --- a/esphome/components/waveshare_epaper/waveshare_epaper.h +++ b/esphome/components/waveshare_epaper/waveshare_epaper.h @@ -36,6 +36,8 @@ class WaveshareEPaper : public PollingComponent, void on_safe_shutdown() override; + display::DisplayType get_display_type() override { return display::DisplayType::DISPLAY_TYPE_BINARY; } + protected: void draw_absolute_pixel_internal(int x, int y, Color color) override;