Skip to main content

CircuitPython `displayio` drivers for SSD1681-based ePaper displays

Project description

Introduction

Documentation Status Discord Build Status Code Style: Black

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()

# CircuitPython 6 & 7 compatible
f = open("/display-ruler.bmp", "rb")
pic = displayio.OnDiskBitmap(f)
t = displayio.TileGrid(
    pic, pixel_shader=getattr(pic, "pixel_shader", displayio.ColorConverter())
)

# # CircuitPython 7 compatible only
# 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-1.2.3.tar.gz (33.0 kB view details)

Uploaded Source

Built Distribution

File details

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

File metadata

File hashes

Hashes for adafruit_circuitpython_ssd1681-1.2.3.tar.gz
Algorithm Hash digest
SHA256 1041d1ef84c7cd85c78f3dc34e45240a6f388a8ac80868cf26958879d4d726fa
MD5 9596592ca3d820c24c9175666fa821ef
BLAKE2b-256 d735ebd3c6a5929edb258d1fa09887092666c6ee7bc9bdd85f173729415ff0d0

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for adafruit_circuitpython_ssd1681-1.2.3-py3-none-any.whl
Algorithm Hash digest
SHA256 3a1fb42144a7918f5720984f8438934171dc3395648584889cc4143ed14021c4
MD5 2993fa670be3a3cdef42d6c6ecd409da
BLAKE2b-256 49cdb0ce1052f1c49e7eab5e43d666542a87f5763e9a177412e6e1990d087215

See more details on using hashes here.

Supported by

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