Initialization

Let's get started writing our first Inkplate sketch! Before using Inkplate in your 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 6 is as follows: it initializes Inkplate in memory and clears the e-paper display:

// Include Inkplate Arduino Library.
#include <Inkplate.h>
Inkplate display(INKPLATE_1BIT); // 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(INKPLATE_1BIT)

Creates an Inkplate object from the Inkplate class.

Returns type: none

Function parameters:

Type	Name	Description
uint8_t	_mode	The display mode to be initialized. INKPLATE_1BIT is BW, INKPLATE_3BIT is Grayscale.

display.begin()

In short, this function initializes the Inkplate object. This starts I2C, allocates the required memory for the frame buffer, and initializes the on-board peripherals.

Returns type: none

display.display()

This function refreshes the display and draws what's currently in the frame buffer. To update the display, this function must be called. This is a full refresh, completely wiping the e-paper and then drawing what's in the frame buffer.

Returns type: none

Function parameters:

Type	Name	Description
uint8_t	_leaveOn	Optional. If set to true, the e-paper won't get turned off after the refresh, which speeds up consecutive refreshes. It's best to use this with partialUpdate and not with this function.

---

Display rotation

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

display.setRotation()

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

Returns type: none

Function parameters:

Type	Name	Description
uint8_t	_rotation	Accepts 0 to 3. 0 is the default rotation, 1 is 90 degrees, 2 is 180 degrees, and 3 is 270 degrees. The value is masked with & 3, so passing 90, 180 or 270 will not do what you expect.