Inkplate Arduino library

Arduino library for all-in-one e-paper display family named Inkplate can be found in this repo. Inkplate is a series of powerful, Wi-Fi enabled ESP32-based e-paper display products. Its main feature is simplicity. Just plug in a USB cable, open Arduino IDE, and change the contents of the screen with few lines of code. Inkplate family currently includes Inkplate 10, Inkplate 6 and Inkplate 6PLUS - learn more about Inkplates on official website. Inkplate 6 was crowdfunded on Crowd Supply, as well as Inkplate 10. Inkplate 6PLUS is funding now.

Setting up Inkplate in Arduino IDE

In order to get a head start with Inkplate (any), follow these steps:

Install Inkplate board definition - add Inkplate 6/10/6PLUS as a board into your Arduino IDE. Follow the instructions on the link.
Install CH340 drivers (if you don't have them yet) - instructions here
Install Inkplate Arduino library - install the library from this repo into your Arduino IDE. If you don't know how, check our tutorial.
You are ready to get started! Select Tools -> Board -> Inkplate (pick correct one), as well as correct COM port and upload!

Code examples

There are many examples in the library that you demonstrate how to use any of the Inkplate functionality. Use Basic folder to get familiar with principles of using the Inkplate, such as modes (BW and Gray), how to write graphics and text or just basic capabilites such as touchscreen or front lighting (if your Inkplate supports it). In Advanced folder, you'll learn how to make HTTP/HTTPS requests, utilise low power, use touchpads or SD card. Finally, get easily started on some projects. More are added regularly, such as projects or community contributions.

Documentation

Find Inkplate documentation here.

Using Inkplate 6 with another microcontroller - Peripheral mode

As promised in an early update, Inkplate 6's screen contents can be updated using 3rd controller (such as Raspberry Pi or another microcontroller). The Peripheral mode enables this. All brand new Inkplates come pre-programmed with slave mode and can be used right away.

It is based on UART (serial) communication - connect the Inkplate to "Controller" ("Master", if using old terminology) board either via USB cable or directly via ESP32 RX and TX pins. Using standard UART at 115200 baud, you can send commands to change screen contents. For example, send *#H(000,000,"/img.bmp")** to show image img.bmp from SD card on the screen. Find very documentation for using it here.

Battery power

Inkplate 6 has two options for powering it. First one is obvious - USB port at side of the board. Just plug any micro USB cable and you are good to go. Second option is battery. Supported batteries are standard Li-Ion/Li-Poly batteries with 3.7V nominal voltage. Connector for the battery is standard 2.00mm pitch JST connector. The onboard charger will charge the battery with 500mA when USB is plugged at the same time. You can use battery of any size or capacity if you don't have a enclosure. If you are using our enclosure, battery size shouldn't exceed 90mm x 40mm (3.5 x 1.57 inch) and 5mm (0.19 inch) in height. This battery is good fit for the Inkplate.

Linux?

Running Linux? You'll need to run few other lines from your Terminal:

apt install python3-pip
pip3 install pyserial
apt install python-is-python3

Micropython

If you are looking for micropython support, please find all details here.

License

This repo uses the source code from another repositories. All their license files are located in "licences" folder.

Open-source

All of Inkplate-related development is open-sourced:

Arduino library
Hardware design: Inkplate 6, Inkplate 10
micropython Inkplate
OSHWA cerfiticate: Inkplate 6, Inkplate 10

Where to buy & other

Inkplate 6 is available for purchase via:

For all questions and issues, please use our forum to ask an question. For sales & collaboration, please reach us via e-mail.

sahwar / inkplate-arduino-library Goto Github PK