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.19.tar.gz (31.6 kB view details)

Uploaded Source

Built Distribution

File details

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

File metadata

File hashes

Hashes for adafruit-circuitpython-ssd1608-1.2.19.tar.gz
Algorithm Hash digest
SHA256 1bf95ff25ed67ff269616ddf4ed04b2c91a85158c55bb6db450e51442112f71b
MD5 699bacf423ef46eb85e37072c0e8a58c
BLAKE2b-256 71218f5f86cfe5238cf3d7b65d0998dc8c06f24e9160845f8bbddcc0f9f10157

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for adafruit_circuitpython_ssd1608-1.2.19-py3-none-any.whl
Algorithm Hash digest
SHA256 b65381a22dfd625a830fb99dbe4801d3d74569444aa05ce39d10a4b203092d8b
MD5 063ca21a5ff3be0a1fa59ebe2966698f
BLAKE2b-256 43ce8d9266a548c95fd34f1b08d801a7da11c6127db277d7e7bcf7ce3e97cd0f

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