Skip to content
Combined library for V2/V3 Inky pHAT and Inky wHAT.
Python Makefile CSS HTML Shell
Branch: master
Clone or download

Latest commit

Files

Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
examples Add window main loop for #47 Mar 11, 2020
library Add window main loop for #47 Mar 11, 2020
sphinx Updated sphinx reqs and config May 24, 2019
tools Adding indexed colour palette file for Inky displays Oct 25, 2018
.gitignore Updated gitignore Jan 30, 2019
.stickler.yml Added Stickler config Feb 8, 2019
.travis.yml Test fixtures Jan 25, 2019
LICENSE Added LICENSE to clarify MIT for #5 Nov 13, 2018
Makefile Prep for 0.0.5 Jun 6, 2019
README.md Update README.md Dec 29, 2019
install.sh Rename package to Inky Mar 13, 2019
uninstall.sh Rename package to Inky Mar 13, 2019

README.md

Inky

Build Status Coverage Status PyPi Package Python Versions

Python library for the Inky pHAT and Inky wHAT e-paper displays.

Inky pHAT

Inky pHAT is a 212x104 pixel e-paper display, available in red/black/white, yellow/black/white and black/white. It's great for nametags and displaying very low frequency information such as a daily calendar or weather overview.

Inky wHAT

Inky wHAT is a 400x300 pixel e-paper display available in red/black/white, yellow/black/white and black/white. It's got tons of resolution for detailed daily todo lists, multi-day weather forecasts, bus timetables and more.

Installation

The Python pip package is named inky, install with:

sudo pip install inky

Usage

The Inky library contains modules for both the pHAT and wHAT, load the InkyPHAT one as follows:

from inky import InkyPHAT

You'll then need to pick your colour, one of 'red', 'yellow' or 'black' and instantiate the class:

inkyphat = InkyPHAT('red')

If you're using the wHAT you'll need to load the InkyWHAT class from the Inky library like so:

from inky import InkyWHAT
inkywhat = InkyWHAT('red')

Once you've initialised Inky, there are only three methods you need to be concerned with:

Set Image

Set a PIL image, numpy array or list to Inky's internal buffer. The image dimensions should match the dimensions of the pHAT or wHAT you're using.

inkyphat.set_image(image)

You should use PIL to create an image. PIL provides an ImageDraw module which allow you to draw text, lines and shapes over your image. See: https://pillow.readthedocs.io/en/stable/reference/ImageDraw.html

Set Border

Set the border colour of you pHAT or wHAT.

inkyphat.set_border(colour)

colour should be one of inky.RED, inky.YELLOW, inky.WHITE or inky.BLACK with available colours depending on your display type.

Update The Display

Once you've prepared and set your image, and chosen a border colour, you can update your e-ink display with:

inkyphat.show()

Migrating

If you're migrating code from the inkyphat library you'll find that much of the drawing and image manipulation functions have been removed from Inky. These functions were always supplied by PIL, and the recommended approach is to use PIL to create and prepare your image before setting it to Inky with set_image().

You can’t perform that action at this time.