Skip to main content

CircuitPython `displayio` driver for EK79686-based ePaper displays

Project description

Introduction

Documentation Status Discord Build Status Code Style: Black

CircuitPython displayio driver for EK79686-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 or individual libraries can be installed using circup.

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

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

sudo pip3 install adafruit-circuitpython-ek79686

To install in a virtual environment in your current project:

mkdir project-name && cd project-name
python3 -m venv .venv
source .env/bin/activate
pip3 install adafruit-circuitpython-ek79686

Installing to a Connected CircuitPython Device with Circup

Make sure that you have circup installed in your Python environment. Install it with the following command if necessary:

pip3 install circup

With circup installed and your CircuitPython device connected use the following command to install:

circup install adafruit_ek79686

Or the following command to update an existing version:

circup update

Usage Example

import time
import board
import displayio
import adafruit_ek79686

# Used to ensure the display is free in CircuitPython
displayio.release_displays()

# Define the pins needed for display use on the Metro
spi = board.SPI()
epd_cs = board.D10
epd_dc = board.D9
epd_reset = board.D5
epd_busy = board.D6

# Create the displayio connection to the display pins
display_bus = displayio.FourWire(
    spi, command=epd_dc, chip_select=epd_cs, reset=epd_reset, baudrate=1000000
)
time.sleep(1)  # Wait a bit

# Create the display object - the third color is red (0xff0000)
display = adafruit_ek79686.EK79686(
    display_bus,
    width=264,
    height=176,
    busy_pin=epd_busy,
    highlight_color=0xFF0000,
    rotation=90,
)

# Create a display group for our screen objects
g = displayio.Group()


# Display a ruler graphic from the root directory of the CIRCUITPY drive
with open("/display-ruler.bmp", "rb") as f:
    pic = displayio.OnDiskBitmap(f)
    # Create a Tilegrid with the bitmap and put in the displayio group
    # CircuitPython 6 & 7 compatible
    t = displayio.TileGrid(
        pic, pixel_shader=getattr(pic, "pixel_shader", displayio.ColorConverter())
    )
    # CircuitPython 7 compatible only
    # t = displayio.TileGrid(pic, pixel_shader=pic.pixel_shader)
    g.append(t)

    # Place the display group on the screen (does not refresh)
    display.show(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_ek79686-1.1.1.tar.gz (32.7 kB view details)

Uploaded Source

Built Distribution

File details

Details for the file adafruit_circuitpython_ek79686-1.1.1.tar.gz.

File metadata

File hashes

Hashes for adafruit_circuitpython_ek79686-1.1.1.tar.gz
Algorithm Hash digest
SHA256 4db96ace954d6ae5cd739ed890563850f632264293f761b7cf762d42a9872592
MD5 7524b4a4a1853196d8677b3cb62822d1
BLAKE2b-256 3f7883746dce7227f1135b649b219b40b90da7415a9cd7bbb8ab6aa0a4a7f8b8

See more details on using hashes here.

File details

Details for the file adafruit_circuitpython_ek79686-1.1.1-py3-none-any.whl.

File metadata

File hashes

Hashes for adafruit_circuitpython_ek79686-1.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 6e16f453070944ade18bcc5b97fec9f51d505f3d1447490d18b402911c0452cc
MD5 fd296ae967f838e62ef5653794d3a4c0
BLAKE2b-256 8ac7a75c0eb7b3eb6e7930225e1c326ac8ddbf88687c72dc3d29f25cbb035283

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