Skip to main content

CircuitPython displayio drivers for IL0398 driven e-paper displays

Project description

Introduction

Documentation Status Discord Build Status Code Style: Ruff

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

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

display.root_group = 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-2.0.5.tar.gz (28.8 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

adafruit_circuitpython_il0398-2.0.5-py3-none-any.whl (5.0 kB view details)

Uploaded Python 3

File details

Details for the file adafruit_circuitpython_il0398-2.0.5.tar.gz.

File metadata

File hashes

Hashes for adafruit_circuitpython_il0398-2.0.5.tar.gz
Algorithm Hash digest
SHA256 18171d4096dbe9b97c88dcd92b27a1c58bed0e03fb89a2b094e27803be0a7099
MD5 0833f7f7cd500a721b504c1ab11fdb7e
BLAKE2b-256 3fd5f27bc379460d9e3a3573cbf3000c87d023f1ce3e964f2d45530d789e1e5c

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for adafruit_circuitpython_il0398-2.0.5-py3-none-any.whl
Algorithm Hash digest
SHA256 202127de3edfd4647121c34681d4b01217a043eea5b6bb4b64fda56dbdac0ffd
MD5 f0431a20816558c86d71b216c994d403
BLAKE2b-256 a7735273ae9eee19eac15c5d16cefefadfa3070425e4f6cb1f2b3483c8da8bcf

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