Tested

adafruit_jd79661.py

@@ -6,7 +6,7 @@
 `adafruit_jd79661`
 ================================================================================
 
-CircuitPython library for the JD79661 e-paper driver IC
+CircuitPython `displayio` driver for JD79661-based ePaper displays
 
 
 * Author(s): Scott Shawcroft
@@ -16,22 +16,124 @@ Implementation Notes
 
 **Hardware:**
 
-.. todo:: Add links to any specific hardware product page(s), or category page(s).
+* JD79661-based 4-color ePaper displays (128x250 resolution) - Black, White, Red, Yellow
-  Use unordered list & hyperlink rST inline format: "* `Link Text <url>`_"
 
 **Software and Dependencies:**
 
 * Adafruit CircuitPython firmware for the supported boards:
-  https://circuitpython.org/downloads
+  https://github.com/adafruit/circuitpython/releases
 
-.. todo:: Uncomment or remove the Bus Device and/or the Register library dependencies
-  based on the library's use of either.
-
-# * Adafruit's Bus Device library: https://github.com/adafruit/Adafruit_CircuitPython_BusDevice
-# * Adafruit's Register library: https://github.com/adafruit/Adafruit_CircuitPython_Register
 """
 
-# imports
+from epaperdisplay import EPaperDisplay
+
+try:
+    import typing
+
+    from fourwire import FourWire
+except ImportError:
+    pass
+
 
 __version__ = "0.0.0+auto.0"
 __repo__ = "https://github.com/adafruit/Adafruit_CircuitPython_JD79661.git"
+
+# JD79661 Command definitions
+_JD79661_PANEL_SETTING = 0x00
+_JD79661_POWER_SETTING = 0x01
+_JD79661_POWER_OFF = 0x02
+_JD79661_POWER_ON = 0x04
+_JD79661_BOOSTER_SOFTSTART = 0x06
+_JD79661_DEEP_SLEEP = 0x07
+_JD79661_DATA_START_XMIT = 0x10
+_JD79661_DISPLAY_REFRESH = 0x12
+_JD79661_CDI = 0x50
+_JD79661_PLL_CONTROL = 0x60
+_JD79661_RESOLUTION = 0x61
+
+_START_SEQUENCE = (
+    b"\x4d\x01\x78"  # Set register 0x4D to 0x78
+    b"\x00\x02\x8f\x29"  # Panel setting (128x250 resolution)
+    b"\x01\x02\x07\x00"  # Power setting
+    b"\x03\x03\x10\x54\x44"  # Power offset
+    b"\x06\x07\x05\x00\x3F\x0A\x25\x12\x1A"  # Booster soft start
+    b"\x50\x01\x37"  # CDI
+    b"\x60\x02\x02\x02"  # TCON
+    b"\x61\x04\x00\x80\x00\xfa"  # Resolution (0, 128, 0, 250)
+    b"\xe7\x01\x1c"  # Additional config register
+    b"\xe3\x01\x22"  # Additional config register
+    b"\xb4\x01\xd0"  # Additional config register
+    b"\xb5\x01\x03"  # Additional config register
+    b"\xe9\x01\x01"  # Additional config register
+    b"\x30\x01\x08"  # PLL Control
+    b"\x04\x00"  # Power on and wait
+)
+
+_STOP_SEQUENCE = (
+    b"\x02\x80\x00"  # Power off and wait
+    b"\x07\x01\xa5"  # Deep sleep
+)
+
+_REFRESH_SEQUENCE = (
+    b"\x12\x01\x00"  # Display refresh
+)
+
+# pylint: disable=too-few-public-methods
+class JD79661(EPaperDisplay):
+    r"""JD79661 driver
+
+    :param bus: The data bus the display is on
+    :param \**kwargs:
+        See below
+
+    :Keyword Arguments:
+        * *width* (``int``) --
+          Display width
+        * *height* (``int``) --
+          Display height
+        * *rotation* (``int``) --
+          Display rotation
+    """
+
+    def __init__(self, bus: FourWire, **kwargs) -> None:
+        stop_sequence = bytearray(_STOP_SEQUENCE)
+        try:
+            bus.reset()
+        except RuntimeError:
+            # No reset pin defined, so no deep sleeping
+            stop_sequence = b""
+
+        start_sequence = bytearray(_START_SEQUENCE )
+
+        width = kwargs.get("width", 128)
+        height = kwargs.get("height", 250)
+        if "rotation" in kwargs and kwargs["rotation"] % 180 != 90:
+            width, height = height, width
+
+        # Update resolution in start sequence (bytes at position for resolution command)
+        # Find the resolution command in the sequence and update it
+        res_pos = start_sequence.find(b'\x61\x04')
+        if res_pos != -1:
+            if height % 4 != 0:
+                height += 4 - height % 4
+            start_sequence[res_pos + 2] = (height >> 8) & 0xFF
+            start_sequence[res_pos + 3] = height & 0xFF
+            start_sequence[res_pos + 4] = (width >> 8) & 0xFF
+            start_sequence[res_pos + 5] = width & 0xFF
+
+        print(start_sequence.hex(" "))
+
+        super().__init__(
+            bus,
+            start_sequence,
+            stop_sequence,
+            **kwargs,
+            ram_width=128,
+            ram_height=250,
+            busy_state=False,
+            write_black_ram_command=_JD79661_DATA_START_XMIT,
+            write_color_ram_command=None,  # JD79661 uses single RAM with 2-bit pixels
+            refresh_display_command=_REFRESH_SEQUENCE,
+            always_toggle_chip_select=True,
+            address_little_endian=False
+        )

examples/jd79661_simpletest.py

@@ -1,4 +1,62 @@
-# SPDX-FileCopyrightText: 2017 Scott Shawcroft, written for Adafruit Industries
+# SPDX-FileCopyrightText: 2025 Scott Shawcroft, written for Adafruit Industries
-# SPDX-FileCopyrightText: Copyright (c) 2025 Scott Shawcroft for Adafruit Industries
+# SPDX-FileCopyrightText: Copyright (c) 2021 Melissa LeBlanc-Williams for Adafruit Industries
 #
 # SPDX-License-Identifier: Unlicense
+
+"""Simple test script for 2.9" 296x128 display. This example runs it in mono mode."""
+
+import time
+
+import board
+import busio
+import displayio
+from fourwire import FourWire
+
+import adafruit_jd79661
+
+displayio.release_displays()
+
+# This pinout works on a MagTag with the newer screen and may need to be altered for other boards.
+spi = busio.SPI(board.EPD_SCK, board.EPD_MOSI)  # Uses SCK and MOSI
+epd_cs = board.EPD_CS
+epd_dc = board.EPD_DC
+epd_reset = board.EPD_RESET
+epd_busy = board.EPD_BUSY
+
+display_bus = FourWire(spi, command=epd_dc, chip_select=epd_cs, reset=epd_reset, baudrate=1000000)
+time.sleep(1)
+
+display = adafruit_jd79661.JD79661(
+    display_bus,
+    width=250,
+    height=122,
+    busy_pin=epd_busy,
+    rotation=270,
+    colstart=0,
+    highlight_color=0x00FF00,
+    highlight_color2=0xFF0000,
+)
+
+g = displayio.Group()
+
+pic = displayio.OnDiskBitmap("/display-ruler-640x360.bmp")
+t = displayio.TileGrid(pic, pixel_shader=pic.pixel_shader)
+g.append(t)
+
+display.root_group = g
+
+display.refresh()
+
+print("refreshed")
+
+time.sleep(display.time_to_refresh + 5)
+# Always refresh a little longer. It's not a problem to refresh
+# a few seconds more, but it's terrible to refresh too early
+# (the display will throw an exception when if the refresh
+# is too soon)
+print("waited correct time")
+
+
+# Keep the display the same
+while True:
+    time.sleep(10)