inky 1.0.1

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.

Auto Setup

Inky can try to automatically detect your board and set up accordingly:

from inky.auto import auto
board = auto()

You can then get the colour and resolution from the board:

board.colour
board.resolution

Manual Setup

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()

1.0.1

• Enhancement: Tweak setup.py extras for easier dependency install

1.0.0

• New: Support for SSD1608-based displays

• New: Mock Inky pHAT and wHAT displays

• New: Automatic Inky detection and class constructor

• Enhancement: Support for alternate i2c_bus when reading eeprom

• Enhancement: Support for alternate spi_bus

• Enhancement: Support for alternate GPIO driver

• Enhancement: Replaced sys.exit calls with ImportError

• Enhancement: Improved docstrings

0.0.5

• Enhancement: Added support for red/b/w high-temp Inky wHAT

0.0.4

• BugFix: Reverted normal red LUTs to correct values

0.0.3

• Enhancement: Added support for display variant detection

• Enhancement: Added DocStrings

• BugFix: Fixed set_border for all colours

0.0.2

• BugFix: Yellow Inky pHAT now yellow instead of brown/black

• Enhancement: Performance tweak for set_image

0.0.1

• Initial Release