Skip to main content

CircuitPython displayio drivers for IL0398 driven e-paper displays

Project description

Introduction

Documentation Status Discord Build Status Code Style: Black

CircuitPython displayio drivers for IL0398 driven e-paper 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-il0398

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

sudo pip3 install adafruit-circuitpython-il0398

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

Usage Example

"""Simple test script for 4.2" 400x300 black and white displays.

Supported products:
  * WaveShare 4.2" Black and White
    * https://www.waveshare.com/product/modules/oleds-lcds/e-paper/4.2inch-e-paper.htm
    * https://www.waveshare.com/product/modules/oleds-lcds/e-paper/4.2inch-e-paper-module.htm
  """

import time
import board
import displayio
import adafruit_il0398

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_il0398.IL0398(display_bus, width=400, height=300, seconds_per_frame=20,
                                 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()

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-il0398-1.1.14.tar.gz (33.3 kB view details)

Uploaded Source

Built Distribution

File details

Details for the file adafruit-circuitpython-il0398-1.1.14.tar.gz.

File metadata

File hashes

Hashes for adafruit-circuitpython-il0398-1.1.14.tar.gz
Algorithm Hash digest
SHA256 3ea3f0d61eeffe61826e41b4365a1a1f3228cdb8dc7f269afd0059cb15331365
MD5 402240f071c5c32b766ece7b2ff7ece2
BLAKE2b-256 a813b4d5b48f457b1e4dbf2f8420abddc615eff6c37d122e12d3878991b12b35

See more details on using hashes here.

File details

Details for the file adafruit_circuitpython_il0398-1.1.14-py3-none-any.whl.

File metadata

File hashes

Hashes for adafruit_circuitpython_il0398-1.1.14-py3-none-any.whl
Algorithm Hash digest
SHA256 2f71f5ddf08aec821c3f2d152d9c4c767354522f67b11b91389e9ae0d8ea6630
MD5 7c4f6eb27e4eda1e1b7413978f6aca94
BLAKE2b-256 7d8f7de5a93ccdc3414ac5c073a0e58ea8c0fe9a581af2e9547a8c607e355d79

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