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

Uploaded Source

Built Distribution

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

File details

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

File metadata

File hashes

Hashes for adafruit_circuitpython_il91874-2.0.4.tar.gz
Algorithm Hash digest
SHA256 e50e0feac894e209ada4dc169c530c2b64261a9b0e80bb22b3aad8d9d44e00ee
MD5 1841205d3b230aa3cb29d7c959b23e7c
BLAKE2b-256 61528af40aefb7d470dead1f8257e013da8b03070c970acdb2cb256cdc4f7b96

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for adafruit_circuitpython_il91874-2.0.4-py3-none-any.whl
Algorithm Hash digest
SHA256 87bb84862b9391e41db11f6e3dc1caa2d9e8525891893e436030c4da183ee766
MD5 a041b16579658fe2099947df64c05273
BLAKE2b-256 e47b9491e15b95908ca507f51d2775894a33b654c167b797b136a19e6ecbace4

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