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 13SPECRA is as follows. It initializes Inkplate in memory and lears 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
}

Inkpate 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 mpde 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:

Type	Name	Description
uint8_t	_rotation