Skip to main content

Quick start guide

To use Arduino with Inkplate 5V2, you first need to install the required software. Here's how.

1. Install Arduino IDE​

If you haven't installed it yet, download and install the Arduino IDE from the official website.

⚠️
Arduino IDE 2.0 or newer is required for Inkplate 5V2.

Install Arduino IDE
Arduino IDE 2.0

2. Install Inkplate boards definition​

Copy the following URL:

https://github.com/SolderedElectronics/Inkplate-Board-Definitions-for-Arduino-IDE/raw/refs/heads/main/package_Inkplate_Boards_index.json

And add it to the Additional boards manager URLs in the Arduino settings:

Add Inkplate to Arduino boards Manager
Adding the Inkplate boards link to Arduino IDE

Now open the Boards Manager, search for Inkplate Boards, and install the Inkplate Boards board definitions.
Click Install here:

Install Inkplate boards
Adding Inkplate boards to Arduino IDE

3. Install Inkplate library​

In the Arduino Library Manager, search for the Inkplate library and click Install:

Install Inkplate library
Installing Inkplate library
ℹ️
It's also possible to install the library manually by downloading it from the GitHub repository.

4. Install CH340 driver​

ℹ️
Mac and Linux users can skip this step because the CH340 driver is already installed.

The CH340 is an onboard chip that handles serial communication over USB. If you don't have the driver yet, download it from this link, then start the installation and follow the instructions:

Install CH340 Driver
Installing the CH340 Driver on Windows

Done!​

Inkplate 5V2 setup is complete. Try out some examples from the Arduino library, upload them and see the results for yourself.

Light and Versatile Graphics Library (LVGL)​

ℹ️
If you want more customization and room for complex GUI design, LVGL is supported on Inkplate boards. Check out this page to get started.

Uploading code​

Here's how to upload your own sketch, or one of the Arduino examples, to Inkplate 5V2.

1. Connect Inkplate via USB and power it on​

Use the provided USB-C cable to connect Inkplate 5V2 to your computer, then press the POWER ON button. The blue power LED lights up when the board is connected properly.

Inkplate 5V2 onboard USB-C connector
Inkplate 5V2 onboard USB-C connector
Inkplate 5V2 onboard POWER button
Inkplate 5V2 onboard POWER button

2. Create a sketch​

We'll use a pre-made example here. Go to File->Examples->InkplateLibrary->Inkplate5V2->Basic->Inkplate5V2_Hello_World.

Selecting a basic example for Inkplate 5V2
Selecting a basic example for Inkplate 5V2

3. Upload the code​

Click Upload in the Arduino IDE.

Arduino IDE Upload Button
Arduino IDE Upload Button

Once the upload finishes, Inkplate restarts on its own and runs the new code. Arduino's upload log should read:

Leaving...
Hard resetting via RTS pin...

Troubleshooting​

Having problems uploading your first code? Check out our troubleshooting page