Initialization
Let's get started with writing our first Inkplate sketch! Before doing anything with Inkplate in Arduino code, it needs to 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 MOTION is as follows, it will initialize Inkplate in memory and clear the e-paper display:
// Include Inkplate Motion Arduino Library.
#include <InkplateMotion.h>
Inkplate inkplate; // Create Inkplate object
void setup()
{
// Initialize Inkplate
inkplate.begin(INKPLATE_BLACKWHITE);
// Update the display
inkplate.display();
// As the frame buffer is empty upon initialization, this will display a blank screen
}
void loop()
{
// Do nothing here
}
inkplate.begin()
In short, this function initializes the Inkplate object. This starts I2C, allocates required memory for the frame buffer, and initializes the on-board peripherals.
Returns: none
Function parameters:
| Type | Name | Description |
|---|---|---|
uint8_t | _mode | The display mode to be initialized. 0 is BW, 1 is Grayscale. Default is black and white. You may also use the defines INKPLATE_BLACKWHITE and INKPLATE_GRAYSCALE. |
inkplate.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: 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 - this speeds up the consecutive refreshes. It's best to use this with partialUpdate and not with this function. |
Display rotation
In case you want to use Inkplate in portrait mode, or in any 90 degree rotation, use inkplate.setRotation():
inkplate.setRotation()
Set the cardinal rotation of the display, this adjusts the (0, 0) x-y coordinate origin point automatically as well.
Returns: none
Function parameters:
| Type | Name | Description |
|---|---|---|
uint8_t | _rotation | Ranges from 0-. 0 is the default rotation, 1 is rotated by 90, 2 by 180 and 3 by 270 degrees. |