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

Uploaded Source

Built Distribution

File details

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

File metadata

File hashes

Hashes for adafruit-circuitpython-il0398-1.1.15.tar.gz
Algorithm Hash digest
SHA256 699145e0b6aa76d54e9f6b7b87545b665c0af6ae2aa3939cea14e8357602645e
MD5 2e29ab6071f014a830d69ccaf9fe9607
BLAKE2b-256 26bfab2b04f4a7f16640c76be1a253c8ffb0c262c920cb2204d3bd435abb9aaa

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for adafruit_circuitpython_il0398-1.1.15-py3-none-any.whl
Algorithm Hash digest
SHA256 3fa0bb1cdbcd50c72c99893bcb72949d6d8a49f4359bffe5e2444ea2d192056b
MD5 0ff4ff74aa94755d25fb4d0ef747ad42
BLAKE2b-256 a697d43a2c1d6d97a67e58c0990adfb5893674f91905e6f69f9e92a2d2177db7

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