Skip to main content

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.

Metadata

Release files for adafruit-circuitpython-ssd1681 2.1.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for adafruit-circuitpython-ssd1681 2.1.0
File Size Uploaded
adafruit_circuitpython_ssd1681-2.1.0.tar.gz 31.9 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for adafruit-circuitpython-ssd1681 2.1.0
File Interpreter ABI Platform
adafruit_circuitpython_ssd1681-2.1.0-py3-none-any.whl Python 3 none any Details

Total release size: 38.3 kB

Release files / adafruit_circuitpython_ssd1681-2.1.0.tar.gz

Download URL adafruit_circuitpython_ssd1681-2.1.0.tar.gz
Size 31.9 kB
Tags Source
SHA-256 checksum
How to use checksums
4249dc492e5855b07c858794d335f346d8930c26574515f8e9e0fa6e75bbb104
BLAKE2b-256 checksum
How to use checksums
13393db5755f880a39ea86762031843f0c232df2eab7aafb2b30656948deccfc
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.11.15

Release files / adafruit_circuitpython_ssd1681-2.1.0-py3-none-any.whl

Download URL adafruit_circuitpython_ssd1681-2.1.0-py3-none-any.whl
Size 6.3 kB
Tags Python 3
SHA-256 checksum
How to use checksums
c2ace9901358cb0d7b70ff7a40c7a15dbbbb59076408f59e59fddba7bbaaddd1
BLAKE2b-256 checksum
How to use checksums
c5cfe2bbe7fc2b826190ae95945c32b985cc86b4cfe7356ce4cff9e974433f07
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.11.15

Release history Release notifications | RSS feed

This release

2.1.0 This release

2 release files

2.0.5

2 release files

2.0.4

2 release files

2.0.3

2 release files

2.0.2

2 release files

2.0.1

2 release files

2.0.0

2 release files

1.2.4

2 release files

1.2.3

2 release files

1.2.2

2 release files

1.2.1

2 release files

1.2.0

2 release files

1.1.3

2 release files

1.1.2

2 release files

1.1.1

2 release files

1.1.0

2 release files

1.0.13

2 release files

1.0.12

2 release files

1.0.10

1 release file

1.0.9

1 release file

1.0.8

1 release file

1.0.7

1 release file

1.0.6

1 release file

1.0.5

1 release file

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page