Skip to main content

CircuitPython `displayio` driver for SSD1677-based ePaper displays

Project description

Introduction

Documentation Status Discord Build Status Code Style: Ruff

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

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

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

sudo pip3 install adafruit-circuitpython-ssd1677

To install in a virtual environment in your current project:

mkdir project-name && cd project-name
python3 -m venv .venv
source .env/bin/activate
pip3 install adafruit-circuitpython-ssd1677

Installing to a Connected CircuitPython Device with Circup

Make sure that you have circup installed in your Python environment. Install it with the following command if necessary:

pip3 install circup

With circup installed and your CircuitPython device connected use the following command to install:

circup install adafruit_ssd1677

Or the following command to update an existing version:

circup update

Usage Example

import time
import board
import displayio
import fourwire
import adafruit_ssd1677

displayio.release_displays()

spi = board.SPI()
epd_cs = board.EPD_CS
epd_dc = board.EPD_DC
epd_reset = board.EPD_RESET
epd_busy = board.EPD_BUSY

display_bus = fourwire.FourWire(
    spi, command=epd_dc, chip_select=epd_cs, reset=epd_reset, baudrate=1000000
)
time.sleep(1)
display = adafruit_ssd1677.SSD1677(
    display_bus,
    width=800,
    height=480,
    busy_pin=epd_busy,
    rotation=0,
)

g = displayio.Group()

pic = displayio.OnDiskBitmap("/display-ruler-720p.bmp")
t = displayio.TileGrid(pic, pixel_shader=pic.pixel_shader)

g.append(t)
display.root_group = g
display.refresh()

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_ssd1677-1.0.2.tar.gz (31.8 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_ssd1677-1.0.2.tar.gz.

File metadata

File hashes

Hashes for adafruit_circuitpython_ssd1677-1.0.2.tar.gz
Algorithm Hash digest
SHA256 6a00ebdab84143d381415b7b3c1a98cb199c4b8e17267054a49ac95b5e9242ad
MD5 1ef2933b65b52e12c28d4d3db4d6c576
BLAKE2b-256 4efc61066ec3249ea8d10e35dd41d136c122af93c1e5a1b24ba1495fb31227f9

See more details on using hashes here.

File details

Details for the file adafruit_circuitpython_ssd1677-1.0.2-py3-none-any.whl.

File metadata

File hashes

Hashes for adafruit_circuitpython_ssd1677-1.0.2-py3-none-any.whl
Algorithm Hash digest
SHA256 79f38d2665c600a0865c2fe9e42e1480a257b58ca153fcab8cc879b5900ab0ca
MD5 2847048f7265c770ac0558fa19171776
BLAKE2b-256 1cf36c3b9309af20723b01754d7d36dffd283658d372d85da1a3ac68c8769354

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