Skip to main content

CircuitPython `displayio` drivers for SSD1608-based ePaper displays

Project description

Introduction

Documentation Status Discord Build Status Code Style: Black

CircuitPython displayio driver for SSD1608-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.

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

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

sudo pip3 install adafruit-circuitpython-ssd1608

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

Usage Example

"""Simple test script for 1.54" 200x200 monochrome display.

Supported products:
  * Adafruit 1.54" Monochrome ePaper Display Breakout
    * https://www.adafruit.com/product/4196
  """

import time
import board
import displayio
import adafruit_ssd1608

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 = displayio.FourWire(spi, command=epd_dc, chip_select=epd_cs, reset=epd_reset,
                                 baudrate=1000000)
time.sleep(1)

display = adafruit_ssd1608.SSD1608(display_bus, width=200, height=200, busy_pin=epd_busy)

g = displayio.Group()

f = open("/display-ruler.bmp", "rb")

pic = displayio.OnDiskBitmap(f)
# CircuitPython 6 & 7 compatible
t = displayio.TileGrid(
    pic, pixel_shader=getattr(pic, "pixel_shader", displayio.ColorConverter())
)
# CircuitPython 7 compatible only
# t = displayio.TileGrid(pic, pixel_shader=pic.pixel_shader)
g.append(t)

display.show(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-ssd1608-1.2.16.tar.gz (32.9 kB view details)

Uploaded Source

Built Distribution

File details

Details for the file adafruit-circuitpython-ssd1608-1.2.16.tar.gz.

File metadata

File hashes

Hashes for adafruit-circuitpython-ssd1608-1.2.16.tar.gz
Algorithm Hash digest
SHA256 a82958253d2319cb35387a9a0645313bd0a5c670c3434a1f338ae96032ef6a07
MD5 9c6df85d22e17beac12bce0c8939bd1f
BLAKE2b-256 012dd2525a6b109e3b1eaf5c61823027dca64aafbf85b793fc99b047a40bb401

See more details on using hashes here.

File details

Details for the file adafruit_circuitpython_ssd1608-1.2.16-py3-none-any.whl.

File metadata

File hashes

Hashes for adafruit_circuitpython_ssd1608-1.2.16-py3-none-any.whl
Algorithm Hash digest
SHA256 da3ccbed2134c73adbf47862c96a9770a72f7eddc2beeaa0b8dcaa428d14e2e6
MD5 9a7a8dbec5b09d63894b760dc6eb8ef2
BLAKE2b-256 5ae36f5b0e3158a9283b12fa2b9997e51dc4acbcb94618b3bb41b408ee670595

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