Arduino Library
The Inkplate Arduino library draws text, shapes and images on Inkplate 10 and handles the e-paper refresh, deep sleep, the RTC, the microSD slot and Wi-Fi. Each page below explains one example from the library: the code, the functions it calls, and what to expect on the screen.
RepositorySolderedElectronics/Inkplate-Arduino-library, version 11.2.0
Model folderexamples/Inkplate10
🔗Open the pinned Arduino library
Public source for these pages
Haven't installed the library yet? Follow Quick Start first.
Feature pages
ExampleHello world and printing textThe smallest Inkplate 10 sketch: it initializes the display, writes `Hello World!` into the frame buffer and refreshes the panel.ExampleText boxWriting a paragraph inside a rectangle with `drawTextBox()`.ExampleDrawing graphicsDrawing pixels, lines, rectangles, circles and text on the 1200 × 825 panel in black and white mode.ExampleDisplay modesSwitching Inkplate 10 to 3-bit grayscale mode.ExamplePartial updateScrolling text across the screen with `partialUpdate()`, which redraws only what changed, so there is no full-screen flicker.ExampleImages and Image ConverterShowing a picture on the panel.ExampleBurn-in cleanReducing heavy ghosting (faint traces of old content) with `burnInClean()`, which repeats full refresh cycles.ExampleDeep sleep slideshowDeep sleep is a low-power state where the ESP32 stops running your program until something wakes it up.ExampleDeep sleep and wake buttonWake the Inkplate 10 from deep sleep with the WakeUp button, or let a 30 second timer do it.ExampleRTC clockSet the time and date on the onboard real-time clock (RTC), read them back once a second and show them on the screen.ExampleRTC alarmSet an alarm on the onboard real-time clock (RTC) and detect it by checking the alarm flag.ExampleRTC interrupt alarmReact to the RTC alarm with an interrupt instead of polling.ExampleRTC timerUse the countdown timer of the onboard real-time clock (RTC).ExampleRTC alarm and deep sleepUse the RTC alarm as the wake-up source for deep sleep.ExamplePartial update and deep sleepUse partial updates together with deep sleep.ExampleIO expandersControl extra GPIO pins through the two IO expanders on the Inkplate 10.ExampleQwiic I2C scannerScan the I2C bus for connected Qwiic or I2C devices and list their addresses, both on the screen and in the Serial Monitor.ExampleBluetooth serialExchange text between the Inkplate 10 and a phone over Bluetooth.ExamplemicroSD picturesReading image files from a microSD card and drawing them on the display: a BMP by file name, a second BMP through an opened `SdFile`, and a JPEG.ExamplemicroSD text readOpening `text.txt` on a FAT, FAT32 or exFAT microSD card, reading up to 200 characters and printing them on the display.ExamplemicroSD text writeCreating `test.txt` on a FAT, FAT32 or exFAT microSD card and writing a line of text into it.ExampleGIF from microSDPlaying a GIF animation from a FAT, FAT32 or exFAT microSD card with partial updates.ExamplePNG from bufferReading a whole PNG file from the microSD card into a RAM buffer and drawing it from there with `drawPngFromBuffer()`.ExampleDither kernelsDrawing the same picture from the microSD card once per dithering kernel, so you can compare the results.ExampleCustom diacriticsPrinting German characters (ä, ö, ü, ß, Ä, Ö, Ü) with a custom font.ExampleFaster refreshesSpeeding up repeated partial updates by keeping the e-paper panel powered between them.ExampleEEPROMClearing, writing and reading back user data in the EEPROM, which survives resets and power cycles.ExampleDisplay mutexRunning two FreeRTOS tasks that each draw and partially update their own half of the screen.ExampleBattery voltageReading the voltage of a connected Li-ion or Li-Po battery with `readBattery()` and showing it on the display every 10 seconds.ExampleTemperatureReading the temperature from the basic sensor inside the TPS65186 e-paper power chip and showing it on the display every 10 seconds.ExampleHTTP POST requestSending a small HTTP POST request over Wi-Fi every 20 seconds to webhook.site, a free service that shows the requests it receives.ExampleHTTPS POST requestSending an HTTPS POST request with a small JSON body (`"title":"Hello Inkplate"`) to the JSONPlaceholder test API, every 10 seconds, and printing the status code and response in the Serial Monitor.ExampleHTTPS with certificateDownloading an image over HTTPS while checking the website certificate.ExampleWeb serverTurning Inkplate 10 into its own Wi-Fi access point with a small web page.ExampleImages from the webDownloading images over Wi-Fi and drawing them on the display.ExampleGIF from the webDownloading a GIF over Wi-Fi and playing it on the display in a loop.