Quick Start
This page takes you from a new Inkplate 10 to "Hello World!" on the e-paper screen using Arduino IDE. It takes four steps: install the board definition and the library, select the board, upload the first example, and check the result.
1. Install the platform and library
- Install Arduino IDE if you do not have it yet.
- Add the Inkplate board definition. Follow the instructions in the Inkplate board definitions repository, then install Inkplate Boards from the Boards Manager.
- Install the library. In the Library Manager, search for
Inkplateand click Install. This page was written against library version 11.2.0. - If you are not on macOS, install the CH340 USB-to-serial driver, which lets your computer talk to the board over USB. Follow the CH340 driver guide.
Tip: downloading from GitHub. On the library's GitHub page, click the green Code button and choose Download ZIP, then add it in Arduino IDE with Sketch → Include Library → Add .ZIP Library....
2. Select and connect the board
- Connect Inkplate 10 to your computer with the USB-C cable from the box.
- In Arduino IDE, open Tools → Board → Inkplate Boards and pick Soldered Inkplate10, the board entry for this board.
- Select the serial port the board appears on under Tools → Port.
3. Upload the first example
Click Upload. This is the library example with its header comment and board-check lines trimmed. The sketch initializes the display, writes text into the frame buffer and then refreshes the screen. clearDisplay() only clears that buffer in memory, so the call to display() at the end is what draws on the panel.
#include "Inkplate.h" // Include the Inkplate library
Inkplate display(INKPLATE_1BIT); // Create an Inkplate object in 1-bit (black and white) mode
void setup() {
display.begin(); // Initialize the display hardware
display.clearDisplay(); // Clear the frame buffer (does NOT clear the physical screen)
display.setCursor(10, 10); // Set the text position to (10, 10) pixels
display.setTextSize(6); // Set text size to 6 (default is 1)
display.print("Hello World!"); // Print "Hello World!" at the set position
display.display(); // Refresh the e-paper display to show changes
}
void loop() {
// No code needed here for this example
}
🔗Open the complete Arduino example
examples/Inkplate10/Basic/Inkplate10_Hello_World/Inkplate10_Hello_World.ino
4. What to expect
After the upload, the screen flickers through a full refresh and "Hello World!" appears near the top-left corner. The text stays on the panel even if you unplug the board, because e-paper needs no power to hold an image.
If setup fails or the display stays blank, continue with the verified checks on the Troubleshooting page.