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

Uploaded Source

Built Distribution

File details

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

File metadata

File hashes

Hashes for adafruit-circuitpython-epd-2.11.4.tar.gz
Algorithm Hash digest
SHA256 f87372588c0cdc963143dd6a3218fcab7b353abf169e21e5761a481c61f205b6
MD5 9739291f4934c56873a84c0e0c846893
BLAKE2b-256 b476b132e218c8bab3297391724536af6283489a277071290422d387f62c910b

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for adafruit_circuitpython_epd-2.11.4-py3-none-any.whl
Algorithm Hash digest
SHA256 4f6a42484f4f40e54f4421ff572385d3ebf501aa8acfef6f3380760e0b1f0c79
MD5 0b8d93923f7ef130477b523e84b1f3a0
BLAKE2b-256 de7051958567c6b20c21c355e55a9152871a93596a2125cdd44a014ecd2c8b10

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