Skip to main content

Initialization

Let's get started writing our first Inkplate sketch! Before using Inkplate in Arduino code, it must be initialized in the setup() function of your sketch. This page contains details on how to do that.

Initializing Inkplate and updating the display​

The most basic sketch on Inkplate 13SPECTRA is as follows. It initializes Inkplate in memory and clears the e-paper display:

#include <Inkplate.h>
Inkplate display;   // Create Inkplate object

void setup(){
    // Initialize Inkplate
    display.begin();    
    // Update the display
    display.display();
    // As the frame buffer is empty upon initialization, this will display a blank screen
}
void loop(){
    // Do nothing here
}

Inkplate display

Creates an Inkplate object from the Inkplate class.

Returns type: none

display.begin()

In short, this function initializes the Inkplate object. It starts I2C, allocates the required memory for the frame buffer, and initializes the onboard peripherals.

Returns type: none

Display rotation​

In case you want to use Inkplate in portrait mode or in any 90-degree rotation, use inkplate.setRotation():

display.setRotation()

Sets the cardinal rotation of the display. This automatically adjusts the (0, 0) x-y coordinate origin point.

Returns value: none

Function parameters:

TypeNameDescription
uint8_t_rotationRanges from 0 to 270. 0 is the default rotation; 1 rotates by 90 degrees, 2 by 180 degrees, and 3 by 270 degrees.