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.3.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.3.tar.gz.

File metadata

File hashes

Hashes for adafruit_circuitpython_il91874-2.0.3.tar.gz
Algorithm Hash digest
SHA256 a666688d115730195763f18ca546e5268660b2a529134122225081c0d71106b6
MD5 7dacfb8b4ac60582fe0119854e86b3d3
BLAKE2b-256 18ed7cbe63911f7e4c41740b9b8590ce7118568b48c1c2263998e4a6212ce043

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for adafruit_circuitpython_il91874-2.0.3-py3-none-any.whl
Algorithm Hash digest
SHA256 fe04b89888cf69a5d69481a000e28a01eb6b97582f095c9badb234e0efc01738
MD5 b864d16ad4f02e827fa1676b23bd1813
BLAKE2b-256 d421708665bd4becb8b7eab6e94e84bf182353abe07659c36bff471d897ce6ec

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