Skip to main content

CircuitPython `displayio` drivers for SSD1608-based ePaper displays

Project description

Introduction

Documentation Status Discord Build Status Code Style: Ruff

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 fourwire
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 = fourwire.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()

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_ssd1608-1.3.9.tar.gz (28.7 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_ssd1608-1.3.9.tar.gz.

File metadata

File hashes

Hashes for adafruit_circuitpython_ssd1608-1.3.9.tar.gz
Algorithm Hash digest
SHA256 af776e6d7cb0b6a9bf4f0ac50f8b9bf8c3e3e9be5f0370e50458a5a54beb38c7
MD5 5599708a8ec4c4f274516e16153a5a71
BLAKE2b-256 9a990ecc772dbe0592bf7a788074e6c317100d054462dc6866c2cbf116be2c0f

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for adafruit_circuitpython_ssd1608-1.3.9-py3-none-any.whl
Algorithm Hash digest
SHA256 b45ede8784fe377e2a9524a6cc5750eddf08469d90f7ac6172d10368e2b5b74b
MD5 bd3a0071f6ea16157befdf0dfccc6e93
BLAKE2b-256 55f1c6b5abcd75ef278a8339453ad50062f0921dd4be3e9b7663b0f49c23d05f

See more details on using hashes here.

Supported by

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