# SPDX-FileCopyrightText: 2018 Dean Miller for Adafruit Industries # # SPDX-License-Identifier: MIT """ `adafruit_epd.il91874` - Adafruit IL91874 - ePaper display driver ==================================================================================== CircuitPython driver for Adafruit IL91874 display breakouts * Author(s): Dean Miller, Ladyada """ import time import adafruit_framebuf from micropython import const from adafruit_epd.epd import Adafruit_EPD try: "Needed for type annotations" import typing from busio import SPI from digitalio import DigitalInOut from typing_extensions import Literal except ImportError: pass __version__ = "0.0.0+auto.0" __repo__ = "https://github.com/adafruit/Adafruit_CircuitPython_EPD.git" _IL91874_PANEL_SETTING = const(0x00) _IL91874_POWER_SETTING = const(0x01) _IL91874_POWER_OFF = const(0x02) _IL91874_POWER_OFF_SEQUENCE = const(0x03) _IL91874_POWER_ON = const(0x04) _IL91874_POWER_ON_MEASURE = const(0x05) _IL91874_BOOSTER_SOFT_START = const(0x06) _IL91874_DEEP_SLEEP = const(0x07) _IL91874_DTM1 = const(0x10) _IL91874_DATA_STOP = const(0x11) _IL91874_DISPLAY_REFRESH = const(0x12) _IL91874_DTM2 = const(0x13) _IL91874_PDTM1 = const(0x14) _IL91874_PDTM2 = const(0x15) _IL91874_PDRF = const(0x16) _IL91874_LUT1 = const(0x20) _IL91874_LUTWW = const(0x21) _IL91874_LUTBW = const(0x22) _IL91874_LUTWB = const(0x23) _IL91874_LUTBB = const(0x24) _IL91874_PLL = const(0x30) _IL91874_CDI = const(0x50) _IL91874_RESOLUTION = const(0x61) _IL91874_VCM_DC_SETTING = const(0x82) _LUT_VCOMDC = b"\x00\x00\x00\x1a\x1a\x00\x00\x01\x00\n\n\x00\x00\x08\x00\x0e\x01\x0e\x01\x10\x00\n\n\x00\x00\x08\x00\x04\x10\x00\x00\x05\x00\x03\x0e\x00\x00\n\x00#\x00\x00\x00\x01" # noqa: E501 _LUT_WW = b"\x90\x1a\x1a\x00\x00\x01@\n\n\x00\x00\x08\x84\x0e\x01\x0e\x01\x10\x80\n\n\x00\x00\x08\x00\x04\x10\x00\x00\x05\x00\x03\x0e\x00\x00\n\x00#\x00\x00\x00\x01" # noqa: E501 _LUT_BW = b"\xa0\x1a\x1a\x00\x00\x01\x00\n\n\x00\x00\x08\x84\x0e\x01\x0e\x01\x10\x90\n\n\x00\x00\x08\xb0\x04\x10\x00\x00\x05\xb0\x03\x0e\x00\x00\n\xc0#\x00\x00\x00\x01" # noqa: E501 _LUT_BB = b"\x90\x1a\x1a\x00\x00\x01@\n\n\x00\x00\x08\x84\x0e\x01\x0e\x01\x10\x80\n\n\x00\x00\x08\x00\x04\x10\x00\x00\x05\x00\x03\x0e\x00\x00\n\x00#\x00\x00\x00\x01" # noqa: E501 _LUT_WB = b"\x90\x1a\x1a\x00\x00\x01 \n\n\x00\x00\x08\x84\x0e\x01\x0e\x01\x10\x10\n\n\x00\x00\x08\x00\x04\x10\x00\x00\x05\x00\x03\x0e\x00\x00\n\x00#\x00\x00\x00\x01" # noqa: E501 class Adafruit_IL91874(Adafruit_EPD): """driver class for Adafruit IL91874 ePaper display breakouts""" def __init__( self, width: int, height: int, spi: SPI, *, cs_pin: DigitalInOut, dc_pin: DigitalInOut, sramcs_pin: DigitalInOut, rst_pin: DigitalInOut, busy_pin: DigitalInOut, ) -> None: super().__init__(width, height, spi, cs_pin, dc_pin, sramcs_pin, rst_pin, busy_pin) self._buffer1_size = int(width * height / 8) self._buffer2_size = int(width * height / 8) if sramcs_pin: self._buffer1 = self.sram.get_view(0) self._buffer2 = self.sram.get_view(self._buffer1_size) else: self._buffer1 = bytearray((width * height) // 8) self._buffer2 = bytearray((width * height) // 8) # since we have *two* framebuffers - one for red and one for black # we dont subclass but manage manually self._framebuf1 = adafruit_framebuf.FrameBuffer( self._buffer1, width, height, buf_format=adafruit_framebuf.MHMSB ) self._framebuf2 = adafruit_framebuf.FrameBuffer( self._buffer2, width, height, buf_format=adafruit_framebuf.MHMSB ) self.set_black_buffer(0, True) self.set_color_buffer(1, False) self._single_byte_tx = True def begin(self, reset: bool = True) -> None: """Begin communication with the display and set basic settings""" if reset: self.hardware_reset() self.power_down() def busy_wait(self) -> None: """Wait for display to be done with current task, either by polling the busy pin, or pausing""" if self._busy: while not self._busy.value: time.sleep(0.01) else: time.sleep(0.5) def power_up(self) -> None: """Power up the display in preparation for writing RAM and updating""" self.hardware_reset() time.sleep(0.2) self.command(_IL91874_POWER_ON) self.busy_wait() self.command(_IL91874_PANEL_SETTING, bytearray([0xAF])) self.command(_IL91874_PLL, bytearray([0x3A])) self.command(_IL91874_POWER_SETTING, bytearray([0x03, 0x00, 0x2B, 0x2B, 0x09])) self.command(_IL91874_BOOSTER_SOFT_START, bytearray([0x07, 0x07, 0x17])) self.command(0xF8, bytearray([0x60, 0xA5])) # mystery command in example code self.command(0xF8, bytearray([0x89, 0xA5])) # mystery command in example code self.command(0xF8, bytearray([0x90, 0x00])) # mystery command in example code self.command(0xF8, bytearray([0x93, 0xA2])) # mystery command in example code self.command(0xF8, bytearray([0x73, 0x41])) # mystery command in example code self.command(_IL91874_VCM_DC_SETTING, bytearray([0x12])) self.command(_IL91874_CDI, bytearray([0x87])) # Look Up Tables self.command(_IL91874_LUT1, _LUT_VCOMDC) self.command(_IL91874_LUTWW, _LUT_WW) self.command(_IL91874_LUTBW, _LUT_BW) self.command(_IL91874_LUTWB, _LUT_WB) self.command(_IL91874_LUTBB, _LUT_BB) _b0 = (self._width >> 8) & 0xFF _b1 = self._width & 0xFF _b2 = (self._height >> 8) & 0xFF _b3 = self._height & 0xFF self.command(_IL91874_RESOLUTION, bytearray([_b0, _b1, _b2, _b3])) self.command(_IL91874_PDRF, bytearray([0x00])) def power_down(self) -> None: """Power down the display - required when not actively displaying!""" self.command(_IL91874_POWER_OFF, bytearray([0x17])) self.busy_wait() if self._rst: # Only deep sleep if we can get out of it self.command(_IL91874_DEEP_SLEEP, bytearray([0xA5])) def update(self) -> None: """Update the display from internal memory""" self.command(_IL91874_DISPLAY_REFRESH) self.busy_wait() if not self._busy: time.sleep(16) # wait 16 seconds def write_ram(self, index: Literal[0, 1]) -> int: """Send the one byte command for starting the RAM write process. Returns the byte read at the same time over SPI. index is the RAM buffer, can be 0 or 1 for tri-color displays.""" if index == 0: return self.command(_IL91874_DTM1, end=False) if index == 1: return self.command(_IL91874_DTM2, end=False) raise RuntimeError("RAM index must be 0 or 1") def set_ram_address(self, x: int, y: int) -> None: # noqa: PLR6301, F841 """Set the RAM address location, not used on this chipset but required by the superclass""" return # on this chip it does nothing