import logging from esphome import core, pins import esphome.codegen as cg from esphome.components import display, spi from esphome.components.display import validate_rotation import esphome.config_validation as cv from esphome.const import ( CONF_AUTO_CLEAR_ENABLED, CONF_COLOR_ORDER, CONF_COLOR_PALETTE, CONF_DC_PIN, CONF_DIMENSIONS, CONF_HEIGHT, CONF_ID, CONF_INIT_SEQUENCE, CONF_INVERT_COLORS, CONF_LAMBDA, CONF_MIRROR_X, CONF_MIRROR_Y, CONF_MODEL, CONF_OFFSET_HEIGHT, CONF_OFFSET_WIDTH, CONF_PAGES, CONF_RAW_DATA_ID, CONF_RESET_PIN, CONF_ROTATION, CONF_SWAP_XY, CONF_TRANSFORM, CONF_WIDTH, ) from esphome.core import CORE, HexInt from esphome.final_validate import full_config DEPENDENCIES = ["spi"] CODEOWNERS = ["@nielsnl68", "@clydebarrow"] LOGGER = logging.getLogger(__name__) ili9xxx_ns = cg.esphome_ns.namespace("ili9xxx") ILI9XXXDisplay = ili9xxx_ns.class_( "ILI9XXXDisplay", cg.PollingComponent, spi.SPIDevice, display.Display, display.DisplayBuffer, ) PixelMode = ili9xxx_ns.enum("PixelMode") PIXEL_MODES = { "16bit": PixelMode.PIXEL_MODE_16, "18bit": PixelMode.PIXEL_MODE_18, } ILI9XXXColorMode = ili9xxx_ns.enum("ILI9XXXColorMode") ColorOrder = display.display_ns.enum("ColorMode") MODELS = { "GC9A01A": ili9xxx_ns.class_("ILI9XXXGC9A01A", ILI9XXXDisplay), "GC9D01N": ili9xxx_ns.class_("ILI9XXXGC9D01N", ILI9XXXDisplay), "M5STACK": ili9xxx_ns.class_("ILI9XXXM5Stack", ILI9XXXDisplay), "M5CORE": ili9xxx_ns.class_("ILI9XXXM5CORE", ILI9XXXDisplay), "TFT_2.4": ili9xxx_ns.class_("ILI9XXXILI9341", ILI9XXXDisplay), "TFT_2.4R": ili9xxx_ns.class_("ILI9XXXILI9342", ILI9XXXDisplay), "ILI9341": ili9xxx_ns.class_("ILI9XXXILI9341", ILI9XXXDisplay), "ILI9342": ili9xxx_ns.class_("ILI9XXXILI9342", ILI9XXXDisplay), "ILI9481": ili9xxx_ns.class_("ILI9XXXILI9481", ILI9XXXDisplay), "ILI9481-18": ili9xxx_ns.class_("ILI9XXXILI948118", ILI9XXXDisplay), "ILI9486": ili9xxx_ns.class_("ILI9XXXILI9486", ILI9XXXDisplay), "ILI9488": ili9xxx_ns.class_("ILI9XXXILI9488", ILI9XXXDisplay), "ILI9488_A": ili9xxx_ns.class_("ILI9XXXILI9488A", ILI9XXXDisplay), "ST7735": ili9xxx_ns.class_("ILI9XXXST7735", ILI9XXXDisplay), "ST7796": ili9xxx_ns.class_("ILI9XXXST7796", ILI9XXXDisplay), "ST7789V": ili9xxx_ns.class_("ILI9XXXST7789V", ILI9XXXDisplay), "S3BOX": ili9xxx_ns.class_("ILI9XXXS3Box", ILI9XXXDisplay), "S3BOX_LITE": ili9xxx_ns.class_("ILI9XXXS3BoxLite", ILI9XXXDisplay), "WAVESHARE_RES_3_5": ili9xxx_ns.class_("WAVESHARERES35", ILI9XXXDisplay), "CUSTOM": ILI9XXXDisplay, } COLOR_ORDERS = { "RGB": ColorOrder.COLOR_ORDER_RGB, "BGR": ColorOrder.COLOR_ORDER_BGR, } COLOR_PALETTE = cv.one_of("NONE", "GRAYSCALE", "IMAGE_ADAPTIVE", "8BIT", upper=True) CONF_LED_PIN = "led_pin" CONF_COLOR_PALETTE_IMAGES = "color_palette_images" CONF_INVERT_DISPLAY = "invert_display" CONF_PIXEL_MODE = "pixel_mode" def cmd(c, *args): """ Create a command sequence :param c: The command (8 bit) :param args: zero or more arguments (8 bit values) :return: a list with the command, the argument count and the arguments """ return [c, len(args)] + list(args) def map_sequence(value): """ An initialisation sequence is a literal array of data bytes. The format is a repeated sequence of [CMD, ] """ if len(value) == 0: raise cv.Invalid("Empty sequence") return cmd(*value) def _validate(config): if ( config.get(CONF_COLOR_PALETTE) == "IMAGE_ADAPTIVE" and CONF_COLOR_PALETTE_IMAGES not in config ): raise cv.Invalid( "IMAGE_ADAPTIVE palette requires at least one 'color_palette_images' entry" ) if ( config.get(CONF_COLOR_PALETTE_IMAGES) and config.get(CONF_COLOR_PALETTE) != "IMAGE_ADAPTIVE" ): raise cv.Invalid( "Providing color palette images requires palette mode to be 'IMAGE_ADAPTIVE'" ) model = config[CONF_MODEL] if CORE.is_esp8266 and model not in [ "M5STACK", "TFT_2.4", "TFT_2.4R", "ILI9341", "ILI9342", "ST7789V", "ST7735", ]: raise cv.Invalid("Selected model can't run on ESP8266.") if model == "CUSTOM": if CONF_INIT_SEQUENCE not in config or CONF_DIMENSIONS not in config: raise cv.Invalid("CUSTOM model requires init_sequence and dimensions") return config CONFIG_SCHEMA = cv.All( display.FULL_DISPLAY_SCHEMA.extend( { cv.GenerateID(): cv.declare_id(ILI9XXXDisplay), cv.Required(CONF_MODEL): cv.enum(MODELS, upper=True, space="_"), cv.Optional(CONF_PIXEL_MODE): cv.enum(PIXEL_MODES), cv.Optional(CONF_DIMENSIONS): cv.Any( cv.dimensions, cv.Schema( { cv.Required(CONF_WIDTH): cv.int_, cv.Required(CONF_HEIGHT): cv.int_, cv.Optional(CONF_OFFSET_HEIGHT, default=0): cv.int_, cv.Optional(CONF_OFFSET_WIDTH, default=0): cv.int_, } ), ), cv.Required(CONF_DC_PIN): pins.gpio_output_pin_schema, cv.Optional(CONF_RESET_PIN): pins.gpio_output_pin_schema, cv.Optional(CONF_LED_PIN): cv.invalid( "This property is removed. To use the backlight use proper light component." ), cv.Optional(CONF_COLOR_PALETTE, default="NONE"): COLOR_PALETTE, cv.GenerateID(CONF_RAW_DATA_ID): cv.declare_id(cg.uint8), cv.Optional(CONF_COLOR_PALETTE_IMAGES, default=[]): cv.ensure_list( cv.file_ ), cv.Optional(CONF_INVERT_DISPLAY): cv.invalid( "'invert_display' has been replaced by 'invert_colors'" ), cv.Required(CONF_INVERT_COLORS): cv.boolean, cv.Optional(CONF_COLOR_ORDER): cv.one_of(*COLOR_ORDERS.keys(), upper=True), cv.Exclusive(CONF_ROTATION, CONF_ROTATION): validate_rotation, cv.Exclusive(CONF_TRANSFORM, CONF_ROTATION): cv.Schema( { cv.Optional(CONF_SWAP_XY, default=False): cv.boolean, cv.Optional(CONF_MIRROR_X, default=False): cv.boolean, cv.Optional(CONF_MIRROR_Y, default=False): cv.boolean, } ), cv.Optional(CONF_INIT_SEQUENCE): cv.ensure_list(map_sequence), } ) .extend(cv.polling_component_schema("1s")) .extend(spi.spi_device_schema(False, "40MHz")), cv.has_at_most_one_key(CONF_PAGES, CONF_LAMBDA), _validate, ) def final_validate(config): global_config = full_config.get() # Ideally would calculate buffer size here, but that info is not available on the Python side needs_buffer = ( CONF_LAMBDA in config or CONF_PAGES in config or config[CONF_AUTO_CLEAR_ENABLED] ) if ( CORE.is_esp32 and config[CONF_COLOR_PALETTE] == "NONE" and "psram" not in global_config and needs_buffer ): LOGGER.info("Consider enabling PSRAM if available for the display buffer") return spi.final_validate_device_schema( "ili9xxx", require_miso=False, require_mosi=True ) FINAL_VALIDATE_SCHEMA = final_validate async def to_code(config): rhs = MODELS[config[CONF_MODEL]].new() var = cg.Pvariable(config[CONF_ID], rhs) await display.register_display(var, config) await spi.register_spi_device(var, config) dc = await cg.gpio_pin_expression(config[CONF_DC_PIN]) cg.add(var.set_dc_pin(dc)) if init_sequences := config.get(CONF_INIT_SEQUENCE): sequence = [] for seq in init_sequences: sequence.extend(seq) cg.add(var.add_init_sequence(sequence)) if pixel_mode := config.get(CONF_PIXEL_MODE): cg.add(var.set_pixel_mode(pixel_mode)) if CONF_COLOR_ORDER in config: cg.add(var.set_color_order(COLOR_ORDERS[config[CONF_COLOR_ORDER]])) if CONF_TRANSFORM in config: transform = config[CONF_TRANSFORM] cg.add(var.set_swap_xy(transform[CONF_SWAP_XY])) cg.add(var.set_mirror_x(transform[CONF_MIRROR_X])) cg.add(var.set_mirror_y(transform[CONF_MIRROR_Y])) if CONF_LAMBDA in config: lambda_ = await cg.process_lambda( config[CONF_LAMBDA], [(display.DisplayRef, "it")], return_type=cg.void ) cg.add(var.set_writer(lambda_)) if CONF_RESET_PIN in config: reset = await cg.gpio_pin_expression(config[CONF_RESET_PIN]) cg.add(var.set_reset_pin(reset)) if CONF_DIMENSIONS in config: dimensions = config[CONF_DIMENSIONS] if isinstance(dimensions, dict): cg.add(var.set_dimensions(dimensions[CONF_WIDTH], dimensions[CONF_HEIGHT])) cg.add( var.set_offsets( dimensions[CONF_OFFSET_WIDTH], dimensions[CONF_OFFSET_HEIGHT] ) ) else: (width, height) = dimensions cg.add(var.set_dimensions(width, height)) rhs = None if config[CONF_COLOR_PALETTE] == "GRAYSCALE": cg.add(var.set_buffer_color_mode(ILI9XXXColorMode.BITS_8_INDEXED)) rhs = [] for x in range(256): rhs.extend([HexInt(x), HexInt(x), HexInt(x)]) elif config[CONF_COLOR_PALETTE] == "IMAGE_ADAPTIVE": cg.add(var.set_buffer_color_mode(ILI9XXXColorMode.BITS_8_INDEXED)) from PIL import Image def load_image(filename): path = CORE.relative_config_path(filename) try: return Image.open(path) except Exception as e: raise core.EsphomeError(f"Could not load image file {path}: {e}") # make a wide horizontal combined image. images = [load_image(x) for x in config[CONF_COLOR_PALETTE_IMAGES]] total_width = sum(i.width for i in images) max_height = max(i.height for i in images) ref_image = Image.new("RGB", (total_width, max_height)) x = 0 for i in images: ref_image.paste(i, (x, 0)) x = x + i.width # reduce the colors on combined image to 256. converted = ref_image.convert("P", palette=Image.Palette.ADAPTIVE, colors=256) # if you want to verify how the images look use # ref_image.save("ref_in.png") # converted.save("ref_out.png") palette = converted.getpalette() assert len(palette) == 256 * 3 rhs = palette elif config[CONF_COLOR_PALETTE] == "8BIT": cg.add(var.set_buffer_color_mode(ILI9XXXColorMode.BITS_8)) else: cg.add(var.set_buffer_color_mode(ILI9XXXColorMode.BITS_16)) if rhs is not None: prog_arr = cg.progmem_array(config[CONF_RAW_DATA_ID], rhs) cg.add(var.set_palette(prog_arr)) cg.add(var.invert_colors(config[CONF_INVERT_COLORS]))