Skip to main content

CircuitPython library for EPD e-ink displays.

Project description

Introduction

Documentation Status Discord Build Status Code Style: Black

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

Uploaded Source

Built Distribution

File details

Details for the file adafruit-circuitpython-epd-2.12.1.tar.gz.

File metadata

File hashes

Hashes for adafruit-circuitpython-epd-2.12.1.tar.gz
Algorithm Hash digest
SHA256 2429055e4687480c914eac0933e6a282655ea28d9b27c0339ddca4e8b82dac6a
MD5 d45fa97bc9fe93e4df8db91653847a88
BLAKE2b-256 32c0744e59989fb71c4a1a91f9d8a7516e6f036e20fb2e1ce772b928dd35eb81

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for adafruit_circuitpython_epd-2.12.1-py3-none-any.whl
Algorithm Hash digest
SHA256 7609fe701927274aa7ffc7b11cb57fda86f20f986023d37a9d8cebe2975e49e0
MD5 c441d7d3e82c48eba0d2f2459351f528
BLAKE2b-256 a2bcca7a27f3c51ab3f1624678c62885d2c677ee7695a8f903960001840ebdbb

See more details on using hashes here.

Supported by

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