ILI9xxx TFT LCD Series¶
Usage¶
This component is the successor of the ILI9341 component allowing to control more display drivers and use 16bit colors when enough free ram.
The ILI9xxx
display platform allows you to use
ILI9341 (datasheet,
Aliexpress) and other
displays from the same chip family with ESPHome. As this is a somewhat higher resolution display and may require pins
beyond the typical SPI connections, it is better suited for use with the ESP32.
Note: To use 16bit instead of 8bit colors use a esp32 with enough PSRAM the display.

ILI9341 display¶
# Example minimal configuration entry
display:
- platform: ili9xxx
model: ili9341
dc_pin: 27
reset_pin: 33
lambda: |-
it.fill(COLOR_BLACK);
it.print(0, 0, id(my_font), id(my_red), TextAlign::TOP_LEFT, "Hello World!");
Configuration variables:¶
model (Required): The model of the display. Options are:
M5STACK
,TFT 2.4
,TFT 2.4R
ILI9341
,ILI9342
,ILI9481
,ILI9486
,ILI9488
,ST7796
dc_pin (Required, Pin Schema): The DC pin.
reset_pin (Optional, Pin Schema): The RESET pin.
rotation (Optional): Set the rotation of the display. Everything drawn in the
lambda:
will be rotated per this option. One of0°
(default),90°
,180°
, or270°
.lambda (Optional, lambda): The lambda to use for rendering the content on the display. See Display Rendering Engine for more information.
update_interval (Optional, Time): The interval to re-draw the screen. Defaults to
5s
.auto_clear_enabled (Optional, boolean): Whether to automatically clear the display in each loop (‘’true’’, default), or to keep the existing display content (must overwrite explicitly, e.g., only on data change).
pages (Optional, list): Show pages instead of a single lambda. See Display Pages.
id (Optional, ID): Manually specify the ID used for code generation.
color_palette (Optional): The type of color pallet that will be used in the ESP’s internal 8-bits-per-pixel buffer. This can be used to improve color depth quality of the image. For example if you know that the display will only be showing grayscale images, the clarity of the display can be improved by targeting the available colors to monochrome only. Options are:
NONE
(default)GRAYSCALE
IMAGE_ADAPTIVE
color_palette_images (Optional): A list of image files that will be used to generate the color pallet for the display. This should only be used in conjunction with
-color_palette: IMAGE_ADAPTIVE
above. The images will be analysed at compile time and a custom color pallet will be created based on the most commonly occuring colors. A typical setting would be a sample image that represented the fully populated display. This can significantly improve the quality of displayed images. Note that these images are not stored on the ESP device, just the 256byte color pallet created from them.dimensions (Optional): Dimensions of the screen with WIDTHxHEIGHT. Usually not needed since
model:
has good defaults.
Configuration examples¶
To utilize the color capabilities of this display module, you’ll likely want to add a color:
section to your
YAML configuration; please see color for more detail on this configuration section.
To use colors in your lambda:
color:
- id: my_red
red: 100%
green: 3%
blue: 5%
...
display:
...
lambda: |-
it.rectangle(0, 0, it.get_width(), it.get_height(), id(my_red));
To bring in color images:
image:
- file: "image.jpg"
id: my_image
resize: 200x200
type: RGB24
...
display:
...
lambda: |-
it.image(0, 0, id(my_image));
To configure a dimmable backlight:
# Define a PWM output on the ESP32
output:
- platform: ledc
pin: 32
id: gpio_32_backlight_pwm
# Define a monochromatic, dimmable light for the backlight
light:
- platform: monochromatic
output: gpio_32_backlight_pwm
name: "Display Backlight"
id: back_light
restore_mode: ALWAYS_ON
To configure an image adaptive color pallet to show greater than 8 bit color depth with a RAM limited screen buffer:
image:
- file: "sample_100x100.png"
id: myimage
resize: 100x100
type: RGB24
display:
- platform: ili9xxx
model: ili9341
dc_pin: 4
reset_pin: 22
rotation: 90
id: tft_ha
color_palette: IMAGE_ADAPTIVE
color_palette_images:
- "sample_100x100.png"
- "display_design.png"
lambda: |-
it.image(0, 0, id(myimage));