Skip to main content

CircuitPython library for EPD e-ink displays.

Project description

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.

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_epd-2.13.6.tar.gz (41.4 kB view details)

Uploaded Source

Built Distribution

adafruit_circuitpython_epd-2.13.6-py3-none-any.whl (31.0 kB view details)

Uploaded Python 3

File details

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

File metadata

File hashes

Hashes for adafruit_circuitpython_epd-2.13.6.tar.gz
Algorithm Hash digest
SHA256 ca9cf8c62d8f5bcedc69c9267d265cd43ab5f8807337a04f2c78747c14edc9dc
MD5 e6ee45ef383a7ba029e9708152c116ad
BLAKE2b-256 04e67d129b04785ab5cb50b4c3c424ec3b1adc5102884ed5c09251c7d8118673

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for adafruit_circuitpython_epd-2.13.6-py3-none-any.whl
Algorithm Hash digest
SHA256 6a2c5c73815b655e735b9ae858dc4b8f39fd8e297c0e5b258282fe6fbdc0fbde
MD5 b6a074b9291ba45a0f48c0bfec0e30bd
BLAKE2b-256 be9ab0524d4c6e582d8c8a87cfc33ef3be40f5354eebf046fd9515e4be95af28

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