This page goes over how to use the 2.9" Monochrome eInk displays with CircuitPython.
CircuitPython eInk displayio Library Installation
To use displayio, you will need to install the appropriate library for your display.
First make sure you are running the latest version of Adafruit CircuitPython for your board. You will need the latest version of CircuitPython.
Next you'll need to install the necessary libraries to use the hardware--carefully follow the steps to find and install these libraries from Adafruit's CircuitPython library bundle. The introduction guide has a great page on how to install the library bundle for both Express and non-Express boards.
You will need to copy the appropriate displayio driver from the bundle lib folder to a lib folder on your CIRCUITPY drive. The displayio driver contains the initialization codes specific to your display that are needed to for it to work. Since there is more than one driver, you will need to copy the correct file over. Here is a list of each of the displays and the correct driver for that display.
To use the eInk displays with displayio, you will need to use the latest version of CircuitPython and a board that can fit displayio. See the Support Matrix to determine if displayio is available on a given board: https://circuitpython.readthedocs.io/en/latest/shared-bindings/support_matrix.html
Adafruit_CircuitPython_UC8151D
The flexible monochrome displays use the Adafruit_CircuitPython_UC8151D library. To easily get all the required files and libraries, you can click the Download Project Bundle link at the top of the example code below. Just unzip, open the folder that corresponds to the version of CircuitPython you have installed, and copy the contents to the CIRCUITPY drive.
Image File
To show you how to use the eInk with displayio, you'll draw a bitmap onto it. First start by downloading display-ruler.bmp
Copy display-ruler.bmp into the root directory of your CIRCUITPY drive.
Monochrome Display Usage
In the examples folder for your UC8151C displayio driver, there should be a test for your display which is listed here:
# SPDX-FileCopyrightText: 2017 Scott Shawcroft, written 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 monochrome display.
Supported products:
* Adafruit Flexible 2.9" Monochrome
* https://www.adafruit.com/product/4262
"""
# pylint: disable=no-member
import time
import board
import displayio
from fourwire import FourWire
import adafruit_uc8151d
displayio.release_displays()
# This pinout works on a Feather M4 and may need to be altered for other boards.
spi = board.SPI() # Uses SCK and MOSI
epd_cs = board.D9
epd_dc = board.D10
epd_reset = board.D5
epd_busy = None
display_bus = FourWire(spi, command=epd_dc, chip_select=epd_cs, reset=epd_reset, baudrate=1000000)
time.sleep(1)
display = adafruit_uc8151d.UC8151D(
display_bus, width=296, height=128, rotation=90, busy_pin=epd_busy
)
g = displayio.Group()
pic = displayio.OnDiskBitmap("/display-ruler.bmp")
t = displayio.TileGrid(pic, pixel_shader=pic.pixel_shader)
g.append(t)
# Place the display group on the screen
display.root_group = g
# Refresh the display to have it actually show the image
# NOTE: Do not refresh eInk displays sooner than 180 seconds
display.refresh()
print("refreshed")
time.sleep(180)
Configure and Upload
You will want to change the epd_reset and epd_busy to the correct values. If you are using the eInk Breakout Friend and wired it up as shown on the Wiring page, you will want to change it to these values:
epd_reset = board.D8 epd_busy = board.D7
If you are using the eInk FeatherWing Friend, you will want to change both of these values to None:
epd_reset = None epd_busy = None
Save it to your CIRCUITPY drive as code.py and it should automatically run. Your display will look something like this:
Page last edited June 30, 2025
Text editor powered by tinymce.
