Skip to main content

CircuitPython `displayio` driver for IL91874-based ePaper displays

Project description

Introduction

Documentation Status Discord Build Status Code Style: Ruff

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

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

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

sudo pip3 install adafruit-circuitpython-il91874

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

Usage Example

"""Simple test script for 2.7" 264x176 Tri-Color display shield

Supported products:
  * Adafruit 2.7" Tri-Color ePaper Display Shield
    * https://www.adafruit.com/product/4229
  """

import time
import board
import busio
import displayio
import fourwire
import adafruit_il91874

displayio.release_displays()

spi = board.SPI()
epd_cs = board.D10
epd_dc = board.D9

display_bus = fourwire.FourWire(spi, command=epd_dc, chip_select=epd_cs, baudrate=1000000)
time.sleep(1)

display = adafruit_il91874.IL91874(display_bus, width=264, height=176, highlight_color=0xff0000, rotation=90)

g = displayio.Group()

pic = displayio.OnDiskBitmap("/display-ruler.bmp")
# Create a Tilegrid with the bitmap and put in the displayio group
t = displayio.TileGrid(pic, pixel_shader=pic.pixel_shader)
g.append(t)

# Place the display group on the screen (does not refresh)
display.root_group = g

# Show the image on the display
display.refresh()

print("refreshed")

# Do Not refresh the screen more often than every 180 seconds
#   for eInk displays! Rapid refreshes will damage the panel.
time.sleep(180)

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_il91874-2.0.2.tar.gz (28.9 kB view details)

Uploaded Source

Built Distribution

File details

Details for the file adafruit_circuitpython_il91874-2.0.2.tar.gz.

File metadata

File hashes

Hashes for adafruit_circuitpython_il91874-2.0.2.tar.gz
Algorithm Hash digest
SHA256 4167752046deea320c18445bb0e272ed72ca5a600c021aeaa249248ef85b4f6c
MD5 577daf737955fe666cc596ba72da4a1f
BLAKE2b-256 5c3131707cb6b573abee75cb850d82ae195b4b6da41838a8855525f75f155bbc

See more details on using hashes here.

File details

Details for the file adafruit_circuitpython_il91874-2.0.2-py3-none-any.whl.

File metadata

File hashes

Hashes for adafruit_circuitpython_il91874-2.0.2-py3-none-any.whl
Algorithm Hash digest
SHA256 e9ad6fd837600f2ea4a37b17c8e08fd77d695c3e8ab4c10b557f6011a1504b90
MD5 86cfee2f5912fec115c938990ca3b59d
BLAKE2b-256 5fd30ad7d75d8ab3e13fe4bfe33d26a46d93b3d5d3b5d947a99a070167a7cb89

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page