Skip to main content

Introduction

Documentation Status Discord Build Status Code Style: Ruff

This library is for using CircuitPython with e-ink displays with built in SRAM.

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

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

sudo pip3 install adafruit-circuitpython-epd

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

Usage Example

import digitalio
import busio
import board
from adafruit_epd.epd import Adafruit_EPD
from adafruit_epd.il0373 import Adafruit_IL0373

# create the spi device and pins we will need
spi = busio.SPI(board.SCK, MOSI=board.MOSI, MISO=board.MISO)
ecs = digitalio.DigitalInOut(board.D12)
dc = digitalio.DigitalInOut(board.D11)
srcs = digitalio.DigitalInOut(board.D10)    # can be None to use internal memory
rst = digitalio.DigitalInOut(board.D9)    # can be None to not use this pin
busy = digitalio.DigitalInOut(board.D5)   # can be None to not use this pin

# give them all to our driver
print("Creating display")
display = Adafruit_IL0373(104, 212, spi,          # 2.13" Tri-color display
                          cs_pin=ecs, dc_pin=dc, sramcs_pin=srcs,
                          rst_pin=rst, busy_pin=busy)

display.rotation = 1

# clear the buffer
print("Clear buffer")
display.fill(Adafruit_EPD.WHITE)
display.pixel(10, 100, Adafruit_EPD.BLACK)

print("Draw Rectangles")
display.fill_rect(5, 5, 10, 10, Adafruit_EPD.RED)
display.rect(0, 0, 20, 30, Adafruit_EPD.BLACK)

print("Draw lines")
display.line(0, 0, display.width-1, display.height-1, Adafruit_EPD.BLACK)
display.line(0, display.height-1, display.width-1, 0, Adafruit_EPD.RED)

print("Draw text")
display.text('hello world', 25, 10, Adafruit_EPD.BLACK)
display.display()

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.

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_epd-2.20.0.tar.gz (61.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_epd-2.20.0-py3-none-any.whl (56.4 kB view details)

Uploaded Python 3

File details

Details for the file adafruit_circuitpython_epd-2.20.0.tar.gz.

File metadata

File hashes

Hashes for adafruit_circuitpython_epd-2.20.0.tar.gz
Algorithm Hash digest
SHA256 3fde247937e898f5490a6c120d0ff9c89fa1438210d2bd3b13a52eda68994fd9
MD5 7a0dd81b030b4e2389cb936023f02b78
BLAKE2b-256 bab712cdeeaf08735a353e88c1265567755c9d3e01e96d4b79c8c89d3632c94d

See more details on using hashes here.

File details

Details for the file adafruit_circuitpython_epd-2.20.0-py3-none-any.whl.

File metadata

File hashes

Hashes for adafruit_circuitpython_epd-2.20.0-py3-none-any.whl
Algorithm Hash digest
SHA256 3399e21d262995fbf8fabafda1beef60229eb25a357c676f7fea70fbeebcd3a2
MD5 088ce0014830bdcb649340a7a62fc0ad
BLAKE2b-256 a5d1cd999b51ae640a9ba1edfb40efd6c93968325315c2a42440007c7dcd202f

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 Sentry Error logging StatusPage Status page