Skip to main content

Inkplate 2 – Initialization and display

Initializing Inkplate​

Here is a basic Inkplate object creation and display initialization, which we'll use in every example in the following tutorials:

# Include inkplate library
from inkplate2 import Inkplate

# Create Inkplate object
inkplate = Inkplate()

# Initialize the display, needs to be called only once
inkplate.begin()

# Draw what is currently stored in frame buffer, needs to be called to update the display
inkplate.display()

inkplate.Inkplate()

Creates an Inkplate object from the Inkplate class.

Returns type: none

inkplate.begin()

Initializes the Inkplate object. It starts I2C, allocates the required memory for the frame buffer, and initializes the onboard peripherals.

Returns type: none

inkplate.display()

This function refreshes the display and draws what is currently in the frame buffer. It must be called to update the display. This is a full refresh that completely wipes the e-Paper and then draws everything from the frame buffer.

Returns type: none

Clear display​

inkplate.clear_display()

This function clears everything stored in display buffer.

Returns type: none

ℹ️
Screen refresh time takes about 12 - 15 seconds. The screen may flicker while updating, which is normal.

Full example​

hello_world.py

Displays 'Hello world!' text on the Inkplate 2 screen.