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

Uploaded Source

Built Distribution

File details

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

File metadata

File hashes

Hashes for adafruit-circuitpython-il0398-1.1.17.tar.gz
Algorithm Hash digest
SHA256 6e77311df25f0f90852204626c5f7fb39e92e25ac19d33f5f8ee40ac3bbec46b
MD5 b29daacdd8fee8de1466bf97bdb2ef09
BLAKE2b-256 ac1b96820d20ea453b3dd4e2a814333c7513c4974a94c930083053770fdc0a17

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for adafruit_circuitpython_il0398-1.1.17-py3-none-any.whl
Algorithm Hash digest
SHA256 fbd36f0dd0862141701612a527ce6308353a1b3a22e7888bd698c3d7686b72d9
MD5 7a1672659d220abf70ca2da3eae932d8
BLAKE2b-256 31f0f8e78ec054b6739b09ef10813a42ea62618fd6d5b944fafcd4076dbb6bbb

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