# SPDX-FileCopyrightText: 2018 Dean Miller for Adafruit Industries # # SPDX-License-Identifier: MIT """ `adafruit_epd.ssd1675b` - Adafruit SSD1675 - ePaper display driver ==================================================================================== CircuitPython driver for Adafruit SSD1675 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" _SSD1675B_DRIVER_CONTROL = const(0x01) _SSD1675B_GATE_VOLTAGE = const(0x03) _SSD1675B_SOURCE_VOLTAGE = const(0x04) _SSD1675B_INIT_SETTING = const(0x08) _SSD1675B_INIT_WRITE_REG = const(0x09) _SSD1675B_INIT_READ_REG = const(0x0A) _SSD1675B_BOOSTER_SOFT_START = const(0x0C) _SSD1675B_GATESCAN_START = const(0x0F) _SSD1675B_DEEP_SLEEP = const(0x10) _SSD1675B_DATA_MODE = const(0x11) _SSD1675B_SW_RESET = const(0x12) _SSD1675B_HV_READY = const(0x14) _SSD1675B_VCI_READY = const(0x15) _SSD1675B_TEMP_CONTROL = const(0x18) _SSD1675B_TEMP_WRITE = const(0x1A) _SSD1675B_TEMP_READ = const(0x1B) _SSD1675B_EXTTEMP_WRITE = const(0x1C) _SSD1675B_MASTER_ACTIVATE = const(0x20) _SSD1675B_DISP_CTRL1 = const(0x21) _SSD1675B_DISP_CTRL2 = const(0x22) _SSD1675B_WRITE_RAM1 = const(0x24) _SSD1675B_WRITE_RAM2 = const(0x26) _SSD1675B_READ_RAM = const(0x27) _SSD1675B_VCOM_SENSE = const(0x28) _SSD1675B_VCOM_DURATION = const(0x29) _SSD1675B_WRITE_VCOM_OTP = const(0x2A) _SSD1675B_WRITE_VCOM_CTRL = const(0x2B) _SSD1675B_WRITE_VCOM_REG = const(0x2C) _SSD1675B_READ_OTP = const(0x2D) _SSD1675B_READ_USERID = const(0x2E) _SSD1675B_READ_STATUS = const(0x2F) _SSD1675B_WRITE_WS_OTP = const(0x30) _SSD1675B_LOAD_WS_OTP = const(0x31) _SSD1675B_WRITE_LUT = const(0x32) _SSD1675B_CRC_CALC = const(0x34) _SSD1675B_CRC_READ = const(0x35) _SSD1675B_PROG_OTP = const(0x36) _SSD1675B_WRITE_DISPLAY_OPT = const(0x37) _SSD1675B_WRITE_USERID = const(0x38) _SSD1675B_OTP_PROGMODE = const(0x39) _SSD1675B_WRITE_DUMMY = const(0x3A) _SSD1675B_WRITE_GATELINE = const(0x3B) _SSD1675B_WRITE_BORDER = const(0x3C) _SSD1675B_SET_RAMXPOS = const(0x44) _SSD1675B_SET_RAMYPOS = const(0x45) _SSD1675B_AUTOWRITE_RED = const(0x46) _SSD1675B_AUTOWRITE_BW = const(0x47) _SSD1675B_SET_RAMXCOUNT = const(0x4E) _SSD1675B_SET_RAMYCOUNT = const(0x4F) _SSD1675B_SET_ANALOGBLOCK = const(0x74) _SSD1675B_SET_DIGITALBLOCK = const(0x7E) _SSD1675B_NOP = const(0xFF) _LUT_DATA = b"\xa0\x90P\x00\x00\x00\x00\x00\x00\x00P\x90\xa0\x00\x00\x00\x00\x00\x00\x00\xa0\x90P\x00\x00\x00\x00\x00\x00\x00P\x90\xa0\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x0f\x0f\x00\x00\x00\x0f\x0f\x00\x00\x03\x0f\x0f\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x15A\xa82P,\x0b" # noqa: E501 class Adafruit_SSD1675B(Adafruit_EPD): """driver class for Adafruit SSD1675B 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) stride = width if stride % 8 != 0: stride += 8 - stride % 8 self._buffer1_size = int(stride * height / 8) self._buffer2_size = self._buffer1_size if sramcs_pin: self._buffer1 = self.sram.get_view(0) self._buffer2 = self.sram.get_view(self._buffer1_size) else: self._buffer1 = bytearray(self._buffer1_size) self._buffer2 = bytearray(self._buffer2_size) # 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, stride=stride, buf_format=adafruit_framebuf.MHMSB, ) self._framebuf2 = adafruit_framebuf.FrameBuffer( self._buffer2, width, height, stride=stride, buf_format=adafruit_framebuf.MHMSB, ) self.set_black_buffer(0, True) self.set_color_buffer(0, True) # pylint: enable=too-many-arguments 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 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.1) self.busy_wait() self.command(_SSD1675B_SW_RESET) self.busy_wait() # set analog block control self.command(_SSD1675B_SET_ANALOGBLOCK, bytearray([0x54])) # set digital block control self.command(_SSD1675B_SET_DIGITALBLOCK, bytearray([0x3B])) self.command( _SSD1675B_DRIVER_CONTROL, bytearray([self._height - 1, (self._height - 1) >> 8, 0x00]), ) # Data entry sequence self.command(_SSD1675B_DATA_MODE, bytearray([0x03])) # Set ram X start/end postion self.command(_SSD1675B_SET_RAMXPOS, bytearray([0x00, self._width // 8])) # Set ram Y start/end postion self.command( _SSD1675B_SET_RAMYPOS, bytearray([0x0, 0x0, self._height - 1, (self._height - 1) >> 8]), ) # Border color self.command(_SSD1675B_WRITE_BORDER, bytearray([0x03])) # Vcom Voltage self.command(_SSD1675B_WRITE_VCOM_REG, bytearray([0x50])) # Set gate voltage self.command(_SSD1675B_GATE_VOLTAGE, _LUT_DATA[100:101]) # Set source voltage self.command(_SSD1675B_SOURCE_VOLTAGE, _LUT_DATA[101:104]) # Set dummy line period self.command(_SSD1675B_WRITE_DUMMY, _LUT_DATA[105:106]) # Set gate line width self.command(_SSD1675B_WRITE_GATELINE, _LUT_DATA[106:107]) # LUT self.command(_SSD1675B_WRITE_LUT, _LUT_DATA[0:100]) # Set temperature control # self.command(_SSD1675B_TEMP_CONTROL, bytearray([0x80])) # Set RAM X address counter self.command(_SSD1675B_SET_RAMXCOUNT, bytearray([0])) # Set RAM Y address counter self.command( _SSD1675B_SET_RAMYCOUNT, bytearray([self._height - 1, (self._height - 1) >> 8]), ) self.busy_wait() def power_down(self) -> None: """Power down the display - required when not actively displaying!""" self.command(_SSD1675B_DEEP_SLEEP, bytearray([0x01])) time.sleep(0.1) def update(self) -> None: """Update the display from internal memory""" self.command(_SSD1675B_DISP_CTRL2, bytearray([0xC7])) self.command(_SSD1675B_MASTER_ACTIVATE) self.busy_wait() if not self._busy: time.sleep(3) # wait 3 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(_SSD1675B_WRITE_RAM1, end=False) if index == 1: return self.command(_SSD1675B_WRITE_RAM2, 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""" self.command(_SSD1675B_SET_RAMXCOUNT, bytearray([x])) self.command(_SSD1675B_SET_RAMYCOUNT, bytearray([y, y >> 8]))