Python library for Inky pHAT
Switch branches/tags
Clone or download
Latest commit 4c0ac9f Oct 31, 2018
Type Name Latest commit message Commit time
Failed to load latest commit information.
examples Print usage in all cases where not enough args Oct 16, 2018
library Prep for v1.0.1 Oct 16, 2018
packaging Prep for v1.0.1 Oct 16, 2018
sphinx Updated doc source Jul 12, 2018
tools Fixed white value Jul 18, 2017
.gitignore Initial Commit Jun 20, 2017
LICENSE Added license file Jun 27, 2017 Update Oct 31, 2018
inky-phat-logo.png Added Inky pHAT logo and README. Jun 20, 2017

Inky pHAT

NOTE This library has been superceded by the new Inky Python library that supports both the Inky pHAT e-paper displays and the larger Inky wHAT e-paper displays, all in one library. The new Inky library does however drop support for the very first version of Inky pHAT, so if you have one of them then you'll need to use this older Inky pHAT library.

You have a newer Inky pHAT if:

  • It's any colour other than Red (IE: Yellow and Black/White Inky pHATs were only available as V2)
  • Has a square inductor on the reverse of the board (large compared to the other components, and dark grey)


Full install (recommended):

We've created an easy installation script that will install all pre-requisites and get your Inky pHAT up and running with minimal efforts. To run it, fire up Terminal which you'll find in Menu -> Accessories -> Terminal on your Raspberry Pi desktop, as illustrated below:

Finding the terminal

In the new terminal window type the command exactly as it appears below (check for typos) and follow the on-screen instructions:

curl | bash

If you choose to download examples you'll find them in /home/pi/Pimoroni/inkyphat/.

Manual install:

Library install for Python 3:

sudo apt-get install python3-inkyphat

Library install for Python 2:

sudo apt-get install python-inkyphat


If you want to contribute, or like living on the edge of your seat by having the latest code, you should clone this repository, cd to the library directory, and run:

sudo apt-get install python-dev python-setuptools
sudo python3 install

(or sudo python install whichever your primary Python environment may be)

In all cases you will have to enable the SPI bus.

Documentation & Support