Skip to main content

CircuitPython `displayio` drivers for SSD1681-based ePaper displays

Project description

Introduction

Documentation Status Discord Build Status Code Style: Ruff

CircuitPython displayio driver for SSD1681-based ePaper displays

Dependencies

This driver depends on:

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.

Adafruit 1.54” Tri-Color eInk / ePaper 200x200 Display with SRAM

Purchase one from the Adafruit shop

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-ssd1681

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

sudo pip3 install adafruit-circuitpython-ssd1681

To install in a virtual environment in your current project:

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

Usage Example

import time
import board
import displayio
import fourwire
import adafruit_ssd1681

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 = board.D6

display_bus = fourwire.FourWire(
    spi, command=epd_dc, chip_select=epd_cs, reset=epd_reset, baudrate=1000000
)
time.sleep(1)

display = adafruit_ssd1681.SSD1681(
    display_bus, width=200, height=200, busy_pin=epd_busy, rotation=180
)

g = displayio.Group()

pic = displayio.OnDiskBitmap("/display-ruler.bmp")
t = displayio.TileGrid(pic, pixel_shader=pic.pixel_shader)
g.append(t)

display.root_group = g

display.refresh()

print("refreshed")

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.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

adafruit_circuitpython_ssd1681-2.0.2.tar.gz (29.6 kB view details)

Uploaded Source

Built Distribution

File details

Details for the file adafruit_circuitpython_ssd1681-2.0.2.tar.gz.

File metadata

File hashes

Hashes for adafruit_circuitpython_ssd1681-2.0.2.tar.gz
Algorithm Hash digest
SHA256 6fbe860712fd665d986b636c32fbe67c1f0ece6a573d9d78389524649ca00f36
MD5 d5b5cd7d47acce3dfdfc0801de09c6da
BLAKE2b-256 57b8329e7375dd2facce3b1ba9421760b7995afaa9afd26329d920174daa89c1

See more details on using hashes here.

File details

Details for the file adafruit_circuitpython_ssd1681-2.0.2-py3-none-any.whl.

File metadata

File hashes

Hashes for adafruit_circuitpython_ssd1681-2.0.2-py3-none-any.whl
Algorithm Hash digest
SHA256 20f852521241048cb1c59372531ed2b77bec0f86766540c29f445ba5cff8cc3d
MD5 7508bb06ad6c1d8613f0b42d1095130d
BLAKE2b-256 39afa5c4984d9d57d830363757a14bfc9f40517287749911254f28a0c0720d1a

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page