Merge pull request #94 from adafruit/UC8197

add UC8197 driver

adafruit_epd/uc8179.py

@@ -0,0 +1,213 @@
+# SPDX-FileCopyrightText: 2025 Liz Clark for Adafruit Industries
+#
+# SPDX-License-Identifier: MIT
+
+"""
+`adafruit_epd.uc8179` - Adafruit UC8179 - ePaper display driver
+====================================================================================
+CircuitPython driver for Adafruit UC8179 display breakouts
+* Author(s): Liz Clark
+"""
+
+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"
+
+# UC8179 commands
+_UC8179_PANELSETTING = const(0x00)
+_UC8179_POWERSETTING = const(0x01)
+_UC8179_POWEROFF = const(0x02)
+_UC8179_POWERON = const(0x04)
+_UC8179_DEEPSLEEP = const(0x07)
+_UC8179_WRITE_RAM1 = const(0x10)
+_UC8179_DATASTOP = const(0x11)
+_UC8179_DISPLAYREFRESH = const(0x12)
+_UC8179_WRITE_RAM2 = const(0x13)
+_UC8179_DUALSPI = const(0x15)
+_UC8179_WRITE_VCOM = const(0x50)
+_UC8179_TCON = const(0x60)
+_UC8179_TRES = const(0x61)
+_UC8179_GET_STATUS = const(0x71)
+
+BUSY_WAIT = const(500)  # milliseconds
+
+
+class Adafruit_UC8179(Adafruit_EPD):
+    """driver class for Adafruit UC8179 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:
+        # Adjust height to be divisible by 8 (direct from Arduino)
+        if (height % 8) != 0:
+            height += 8 - (height % 8)
+
+        super().__init__(width, height, spi, cs_pin, dc_pin, sramcs_pin, rst_pin, busy_pin)
+
+        # Calculate buffer sizes exactly as Arduino does: width * height / 8
+        self._buffer1_size = width * height // 8
+        self._buffer2_size = self._buffer1_size
+
+        if sramcs_pin:
+            # Using external SRAM
+            self._buffer1 = self.sram.get_view(0)
+            self._buffer2 = self.sram.get_view(self._buffer1_size)
+        else:
+            # Using internal RAM
+            self._buffer1 = bytearray(self._buffer1_size)
+            self._buffer2 = bytearray(self._buffer2_size)
+
+        # Create frame buffers
+        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,
+        )
+
+        # Set up which frame buffer is which color
+        self.set_black_buffer(0, True)
+        self.set_color_buffer(1, False)
+
+        # UC8179 uses single byte transactions
+        self._single_byte_tx = False
+
+        # Default refresh delay (from Adafruit_EPD base class in Arduino)
+        self.default_refresh_delay = 15  # seconds
+        # 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:
+            # Wait for busy pin to go HIGH
+            while not self._busy.value:
+                self.command(_UC8179_GET_STATUS)
+                time.sleep(0.1)
+        else:
+            # No busy pin, just wait
+            time.sleep(BUSY_WAIT / 1000.0)
+        # Additional delay after busy signal
+        time.sleep(0.2)
+
+    def power_up(self) -> None:
+        """Power up the display in preparation for writing RAM and updating"""
+        self.hardware_reset()
+
+        # Power setting
+        self.command(
+            _UC8179_POWERSETTING,
+            bytearray(
+                [
+                    0x07,  # VGH=20V
+                    0x07,  # VGL=-20V
+                    0x3F,  # VDH=15V
+                    0x3F,  # VDL=-15V
+                ]
+            ),
+        )
+
+        # Power on
+        self.command(_UC8179_POWERON)
+        time.sleep(0.1)  # 100ms delay
+        self.busy_wait()
+
+        # Panel setting
+        self.command(_UC8179_PANELSETTING, bytearray([0b011111]))  # BW OTP LUT
+
+        # Resolution setting
+        self.command(
+            _UC8179_TRES,
+            bytearray(
+                [self._width >> 8, self._width & 0xFF, self._height >> 8, self._height & 0xFF]
+            ),
+        )
+
+        # Dual SPI setting
+        self.command(_UC8179_DUALSPI, bytearray([0x00]))
+
+        # VCOM setting
+        self.command(_UC8179_WRITE_VCOM, bytearray([0x10, 0x07]))
+
+        # TCON setting
+        self.command(_UC8179_TCON, bytearray([0x22]))
+
+    def power_down(self) -> None:
+        """Power down the display - required when not actively displaying!"""
+        self.command(_UC8179_POWEROFF)
+        self.busy_wait()
+
+        # Only deep sleep if we have a reset pin to wake it up
+        if self._rst:
+            self.command(_UC8179_DEEPSLEEP, bytearray([0x05]))
+        time.sleep(0.1)
+
+    def update(self) -> None:
+        """Update the display from internal memory"""
+        self.command(_UC8179_DISPLAYREFRESH)
+        time.sleep(0.1)  # 100ms delay
+        self.busy_wait()
+
+        if not self._busy:
+            # If no busy pin, use default refresh delay
+            time.sleep(self.default_refresh_delay)
+
+    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(_UC8179_WRITE_RAM1, end=False)
+        if index == 1:
+            return self.command(_UC8179_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"""
+        # Not used in UC8179 chip
+        pass
+
+    def set_ram_window(self, x1: int, y1: int, x2: int, y2: int) -> None:  # noqa: PLR6301, F841
+        """Set the RAM window, not used on this chipset but required by
+        the superclass"""
+        # Not used in UC8179 chip
+        pass

examples/epd_bitmap.py

@@ -16,6 +16,7 @@ from adafruit_epd.ssd1680 import Adafruit_SSD1680
 from adafruit_epd.ssd1681 import Adafruit_SSD1681
 from adafruit_epd.ssd1683 import Adafruit_SSD1683
 from adafruit_epd.uc8151d import Adafruit_UC8151D
+from adafruit_epd.uc8179 import Adafruit_UC8179
 
 # create the spi device and pins we will need
 spi = busio.SPI(board.SCK, MOSI=board.MOSI, MISO=board.MISO)
@@ -35,6 +36,8 @@ print("Creating display")
 # display = Adafruit_EK79686(176, 264,        # 2.7" Tri-color display
 # display = Adafruit_IL0373(152, 152,         # 1.54" Tri-color display
 # display = Adafruit_UC8151D(128, 296,        # 2.9" mono flexible display
+# display = Adafruit_UC8179(648, 480,         # 5.83" mono 648x480 display
+# display = Adafruit_UC8179(800, 480,         # 7.5" mono 800x480 display
 # display = Adafruit_IL0373(128, 296,         # 2.9" Tri-color display IL0373
 # display = Adafruit_SSD1680(128, 296,        # 2.9" Tri-color display SSD1680
 # display = Adafruit_SSD1683(400, 300,        # 4.2" 300x400 Tri-Color display
@@ -50,7 +53,9 @@ display = Adafruit_IL0373(
     busy_pin=busy,
 )
 
-# IF YOU HAVE A 2.13" FLEXIBLE DISPLAY uncomment these lines!
+# IF YOU HAVE A 2.13" FLEXIBLE DISPLAY OR!
+# UC8179 5.83" or 7.5" displays
+# uncomment these lines!
 # display.set_black_buffer(1, False)
 # display.set_color_buffer(1, False)
 

examples/epd_blinka.py

@@ -19,6 +19,7 @@ from adafruit_epd.ssd1680 import Adafruit_SSD1680
 from adafruit_epd.ssd1681 import Adafruit_SSD1681
 from adafruit_epd.ssd1683 import Adafruit_SSD1683
 from adafruit_epd.uc8151d import Adafruit_UC8151D
+from adafruit_epd.uc8179 import Adafruit_UC8179
 
 # create the spi device and pins we will need
 spi = busio.SPI(board.SCK, MOSI=board.MOSI, MISO=board.MISO)
@@ -41,6 +42,8 @@ print("Creating display")
 # display = Adafruit_EK79686(176, 264,        # 2.7" Tri-color display
 # display = Adafruit_IL0373(152, 152,         # 1.54" Tri-color display
 # display = Adafruit_UC8151D(128, 296,        # 2.9" mono flexible display
+# display = Adafruit_UC8179(648, 480,         # 5.83" mono 648x480 display
+# display = Adafruit_UC8179(800, 480,         # 7.5" mono 800x480 display
 # display = Adafruit_IL0373(128, 296,         # 2.9" Tri-color display
 # display = Adafruit_IL0398(400, 300,         # 4.2" Tri-color display
 # display = Adafruit_IL0373(104, 212,         # 2.13" Tri-color display
@@ -55,7 +58,9 @@ display = Adafruit_SSD1675B(
     busy_pin=busy,
 )
 
-# IF YOU HAVE A 2.13" FLEXIBLE DISPLAY uncomment these lines!
+# IF YOU HAVE A 2.13" FLEXIBLE DISPLAY OR!
+# UC8179 5.83" or 7.5" displays
+# uncomment these lines!
 # display.set_black_buffer(1, False)
 # display.set_color_buffer(1, False)
 

examples/epd_pillow_demo.py

@@ -22,6 +22,7 @@ from adafruit_epd.ssd1680 import Adafruit_SSD1680, Adafruit_SSD1680Z
 from adafruit_epd.ssd1681 import Adafruit_SSD1681
 from adafruit_epd.ssd1683 import Adafruit_SSD1683
 from adafruit_epd.uc8151d import Adafruit_UC8151D
+from adafruit_epd.uc8179 import Adafruit_UC8179
 
 # First define some color constants
 WHITE = (0xFF, 0xFF, 0xFF)
@@ -50,13 +51,15 @@ busy = digitalio.DigitalInOut(board.D17)
 # display = Adafruit_SSD1680(122, 250,        # 2.13" HD Tri-color or mono display
 # display = Adafruit_SSD1680Z(122, 250,       # Newer 2.13" mono display
 # display = Adafruit_SSD1681(200, 200,        # 1.54" HD Tri-color display
-# display = Adafruit_SSD1683(400, 300,        # 4.2" 300x400 Tri-Color display
 # display = Adafruit_IL91874(176, 264,        # 2.7" Tri-color display
 # display = Adafruit_EK79686(176, 264,        # 2.7" Tri-color display
 # display = Adafruit_IL0373(152, 152,         # 1.54" Tri-color display
 # display = Adafruit_UC8151D(128, 296,        # 2.9" mono flexible display
+# display = Adafruit_UC8179(648, 480,         # 5.83" mono 648x480 display
+# display = Adafruit_UC8179(800, 480,         # 7.5" mono 800x480 display
 # display = Adafruit_IL0373(128, 296,         # 2.9" Tri-color display IL0373
 # display = Adafruit_SSD1680(128, 296,        # 2.9" Tri-color display SSD1680
+# display = Adafruit_SSD1683(400, 300,        # 4.2" 300x400 Tri-Color display
 # display = Adafruit_IL0398(400, 300,         # 4.2" Tri-color display
 display = Adafruit_IL0373(
     104,
@@ -69,7 +72,9 @@ display = Adafruit_IL0373(
     busy_pin=busy,
 )
 
-# IF YOU HAVE A 2.13" FLEXIBLE DISPLAY uncomment these lines!
+# IF YOU HAVE A 2.13" FLEXIBLE DISPLAY OR!
+# UC8179 5.83" or 7.5" displays
+# uncomment these lines!
 # display.set_black_buffer(1, False)
 # display.set_color_buffer(1, False)
 

examples/epd_pillow_image.py

@@ -24,6 +24,7 @@ from adafruit_epd.ssd1680 import Adafruit_SSD1680, Adafruit_SSD1680Z
 from adafruit_epd.ssd1681 import Adafruit_SSD1681
 from adafruit_epd.ssd1683 import Adafruit_SSD1683
 from adafruit_epd.uc8151d import Adafruit_UC8151D
+from adafruit_epd.uc8179 import Adafruit_UC8179
 
 # create the spi device and pins we will need
 spi = busio.SPI(board.SCK, MOSI=board.MOSI, MISO=board.MISO)
@@ -40,13 +41,15 @@ busy = digitalio.DigitalInOut(board.D17)
 # display = Adafruit_SSD1680(122, 250,        # 2.13" HD Tri-color or mono display
 # display = Adafruit_SSD1680Z(122, 250,       # Newer 2.13" mono display
 # display = Adafruit_SSD1681(200, 200,        # 1.54" HD Tri-color display
-# display = Adafruit_SSD1683(400, 300,        # 4.2" 300x400 Tri-Color display
 # display = Adafruit_IL91874(176, 264,        # 2.7" Tri-color display
 # display = Adafruit_EK79686(176, 264,        # 2.7" Tri-color display
 # display = Adafruit_IL0373(152, 152,         # 1.54" Tri-color display
 # display = Adafruit_UC8151D(128, 296,        # 2.9" mono flexible display
+# display = Adafruit_UC8179(648, 480,         # 5.83" mono 648x480 display
+# display = Adafruit_UC8179(800, 480,         # 7.5" mono 800x480 display
 # display = Adafruit_IL0373(128, 296,         # 2.9" Tri-color display IL0373
 # display = Adafruit_SSD1680(128, 296,        # 2.9" Tri-color display SSD1680
+# display = Adafruit_SSD1683(400, 300,        # 4.2" 300x400 Tri-Color display
 # display = Adafruit_IL0398(400, 300,         # 4.2" Tri-color display
 display = Adafruit_IL0373(
     104,
@@ -59,7 +62,9 @@ display = Adafruit_IL0373(
     busy_pin=busy,
 )
 
-# IF YOU HAVE A 2.13" FLEXIBLE DISPLAY uncomment these lines!
+# IF YOU HAVE A 2.13" FLEXIBLE DISPLAY OR!
+# UC8179 5.83" or 7.5" displays
+# uncomment these lines!
 # display.set_black_buffer(1, False)
 # display.set_color_buffer(1, False)
 

examples/epd_simpletest.py

@@ -17,6 +17,7 @@ from adafruit_epd.ssd1680 import Adafruit_SSD1680, Adafruit_SSD1680Z
 from adafruit_epd.ssd1681 import Adafruit_SSD1681
 from adafruit_epd.ssd1683 import Adafruit_SSD1683
 from adafruit_epd.uc8151d import Adafruit_UC8151D
+from adafruit_epd.uc8179 import Adafruit_UC8179
 
 # create the spi device and pins we will need
 spi = busio.SPI(board.SCK, MOSI=board.MOSI, MISO=board.MISO)
@@ -34,13 +35,15 @@ print("Creating display")
 # display = Adafruit_SSD1680(122, 250,        # 2.13" HD Tri-color display
 # display = Adafruit_SSD1681(200, 200,        # 1.54" HD Tri-color display
 # display = Adafruit_SSD1681(200, 200,        # 1.54" HD Tri-color display
-# display = Adafruit_SSD1683(400, 300,        # 4.2" 300x400 Tri-Color display
 # display = Adafruit_IL91874(176, 264,        # 2.7" Tri-color display
 # display = Adafruit_EK79686(176, 264,        # 2.7" Tri-color display
 # display = Adafruit_IL0373(152, 152,         # 1.54" Tri-color display
 # display = Adafruit_UC8151D(128, 296,        # 2.9" mono flexible display
+# display = Adafruit_UC8179(648, 480,         # 5.83" mono 648x480 display
+# display = Adafruit_UC8179(800, 480,         # 7.5" mono 800x480 display
 # display = Adafruit_IL0373(128, 296,         # 2.9" Tri-color display IL0373
 # display = Adafruit_SSD1680(128, 296,        # 2.9" Tri-color display SSD1680
+# display = Adafruit_SSD1683(400, 300,        # 4.2" 300x400 Tri-Color display
 # display = Adafruit_IL0398(400, 300,         # 4.2" Tri-color display
 display = Adafruit_IL0373(
     104,
@@ -53,7 +56,9 @@ display = Adafruit_IL0373(
     busy_pin=busy,
 )
 
-# IF YOU HAVE A 2.13" FLEXIBLE DISPLAY uncomment these lines!
+# IF YOU HAVE A 2.13" FLEXIBLE DISPLAY OR!
+# UC8179 5.83" or 7.5" displays
+# uncomment these lines!
 # display.set_black_buffer(1, False)
 # display.set_color_buffer(1, False)