Welcome

This documentation will guide you through the methods available in the Inky python library.

At A Glance

Inky e-Ink Display Driver.

Inky.set_border(colour)

Set the border colour.

Inky.set_image(image)

Copy an image to the display.

Inky.set_pixel(x, y, v)

Set a single pixel.

Parameters:

• x – x position on display
• y – y position on display
• v – colour to set

Inky.setup()

Set up Inky GPIO and reset display.

Inky.show()

Show buffer on display.

Setup Inky

Note: If you’re using a Pimoroni Inky board, the subclasses InkyPHAT and InkyWHAT set most of these options on your behalf, so you only need to specify colour.

For example:

phat = InkyPHAT('red')

Or:

what = InkyWHAT('yellow')

Inky.__init__(resolution=(400, 300), colour='black', cs_pin=0, dc_pin=22, reset_pin=27, busy_pin=17, h_flip=False, v_flip=False)

Initialise an Inky Display.

Parameters:

• resolution – (width, height) in pixels, default: (400, 300)
• colour – one of red, black or yellow, default: black
• cs_pin – chip-select pin for SPI communication
• dc_pin – data/command pin for SPI communication
• reset_pin – device reset pin
• busy_pin – device busy/wait pin
• h_flip – enable horizontal display flip, default: False
• v_flip – enable vertical display flip, default: False

Set A Border

Inky.set_border(colour)

Set the border colour.

Set An Image

Inky.set_image(image)

Copy an image to the display.

Set A Pixel

Inky.set_pixel(x, y, v)

Set a single pixel.

Parameters:

• x – x position on display
• y – y position on display
• v – colour to set

Set Up Inky

Inky.setup()

Set up Inky GPIO and reset display.

Show The Buffer

Inky.show()

Show buffer on display.