Skip to main content

Introduction

Documentation Status Discord Build Status Code Style: Ruff

CircuitPython displayio driver for SSD1680-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 2.13” 250x122 Tri-Color eInk / ePaper Display with SRAM - SSD1680 Driver

Purchase the Breakout from the Adafruit shop

  • Adafruit 2.13” HD Tri-Color eInk / ePaper Display FeatherWing - 250x122 RW Panel with SSD1680

Purchase the FeatherWing 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-ssd1680

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

sudo pip3 install adafruit-circuitpython-ssd1680

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

Usage Example

import time
import board
import displayio
import fourwire
import adafruit_ssd1680

displayio.release_displays()

# This pinout works on a Metro 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.D8    # Set to None for FeatherWing
epd_busy = board.D7    # Set to None for FeatherWing

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

# For issues with display not updating top/bottom rows correctly set colstart to 8, 0, or -8
display = adafruit_ssd1680.SSD1680(
    display_bus,
    width=250,
    height=122,
    busy_pin=epd_busy,
    highlight_color=0xFF0000,
    rotation=270,
    colstart=-8,  # Comment out for older displays
)

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.

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_ssd1680-2.2.0.tar.gz (36.9 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

File details

Details for the file adafruit_circuitpython_ssd1680-2.2.0.tar.gz.

File metadata

File hashes

Hashes for adafruit_circuitpython_ssd1680-2.2.0.tar.gz
Algorithm Hash digest
SHA256 0c1a426781bd504fdff5146a181f69bbd43c460bbbb249f684f5dde530bae479
MD5 a3e3433fbb613b5ea2cd3078e7568646
BLAKE2b-256 8ef0ae05fc631d7b3b44a3742a2dac6237fae7c073fb929050f5e0d32ad05f67

See more details on using hashes here.

File details

Details for the file adafruit_circuitpython_ssd1680-2.2.0-py3-none-any.whl.

File metadata

File hashes

Hashes for adafruit_circuitpython_ssd1680-2.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 59fa76564b54f4db0e3faee4d66fa3fa2716063f3a5ea45948de819a54ca9228
MD5 174e2bc98fc17494e8c061d85c205be5
BLAKE2b-256 ff083b03082fcc90a304dfcfc697f156f881c0d91f5c6df7525a02762d17b96f

See more details on using hashes here.

Release history Release notifications | RSS feed

This release

2.2.0 This release

2 files

2.1.4

2 files

2.1.3

2 files

2.1.2

2 files

2.1.1

2 files

2.1.0

2 files

2.0.4

2 files

2.0.3

2 files

2.0.2

2 files

2.0.1

2 files

2.0.0

2 files

1.2.5

2 files

1.2.4

2 files

1.2.3

2 files

1.2.2

2 files

1.2.1

2 files

1.2.0

2 files

1.1.5

2 files

1.1.4

2 files

1.1.3

2 files

1.1.2

2 files

1.1.1

2 files

1.1.0

2 files

1.0.14

2 files

1.0.13

2 files

1.0.12

2 files

1.0.11

2 files

1.0.10

2 files

1.0.9

2 files

1.0.8

1 file

1.0.7

1 file

1.0.6

1 file

1.0.5

1 file

1.0.4

1 file

1.0.3

1 file

Supported by

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