adafruit-circuitpython-spd1656 0.8.6

Introduction

Driver for SPD1656 driven ACeP (7-color) e-paper displays.

Please note that we do not have Blinka support for this yet. So it won’t work with a Raspberry Pi.

Dependencies

This driver depends on:

• Adafruit CircuitPython

Please ensure all dependencies are available on the CircuitPython filesystem. This is easily achieved by downloading the Adafruit library and driver bundle or individual libraries can be installed using circup.

This supports the common 4” and 5.65” ACeP displays.

• [Waveshare 4”](https://www.waveshare.com/4.01inch-e-paper-hat-f.htm)

• [Waveshare 5.65”](https://www.waveshare.com/5.65inch-e-paper-module-f.htm)

• [Pimoroni 5.7”](https://shop.pimoroni.com/products/inky-impression-5-7) (Likely the same as 5.65”.)

• [Pimoroni 4”](https://shop.pimoroni.com/products/inky-impression-4)

Installing from PyPI

On supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally from PyPI. To install for current user:

pip3 install adafruit-circuitpython-spd1656

To install system-wide (this may be required in some cases):

sudo pip3 install adafruit-circuitpython-spd1656

To install in a virtual environment in your current project:

mkdir project-name && cd project-name
python3 -m venv .venv
source .env/bin/activate
pip3 install adafruit-circuitpython-spd1656

Installing to a Connected CircuitPython Device with Circup

Make sure that you have circup installed in your Python environment. Install it with the following command if necessary:

pip3 install circup

With circup installed and your CircuitPython device connected use the following command to install:

circup install adafruit_spd1656

Or the following command to update an existing version:

circup update

Usage Example

# SPDX-FileCopyrightText: Copyright (c) 2023 Scott Shawcroft for Adafruit Industries
# SPDX-FileCopyrightText: Copyright (c) 2021 Melissa LeBlanc-Williams for Adafruit Industries
#
# SPDX-License-Identifier: Unlicense

"""Simple test script for 5.6" 600x448 7-color ACeP display.
  """
# pylint: disable=no-member

import time
import board
import displayio
import adafruit_spd1656

displayio.release_displays()

# This pinout works on a Feather RP2040 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.D11
epd_busy = board.D12

display_bus = displayio.FourWire(
    spi, command=epd_dc, chip_select=epd_cs, reset=epd_reset, baudrate=1000000
)

display = adafruit_spd1656.SPD1656(
    display_bus, width=600, height=448, busy_pin=epd_busy
)

g = displayio.Group()

fn = "/display-ruler-720p.bmp"

with open(fn, "rb") as f:
    pic = displayio.OnDiskBitmap(f)
    t = displayio.TileGrid(pic, pixel_shader=pic.pixel_shader)
    g.append(t)

    display.show(g)

    display.refresh()

    time.sleep(120)

Documentation

API documentation for this library can be found on Read the Docs.

For information on building library documentation, please check out this guide.

Contributing

Contributions are welcome! Please read our Code of Conduct before contributing to help this project stay welcoming.