# Adafruit 1.54" eInk Display Breakouts
## Overview
Easy e-paper finally comes to microcontrollers, with these breakouts, shields and friends that are designed to make it a breeze to add a tri-color eInk display. Chances are you've seen one of those new-fangled 'e-readers' like the Kindle or Nook. They have gigantic electronic paper 'static' displays - that means the image stays on the display even when power is completely disconnected. The image is also high contrast and very daylight readable. It really does look just like printed paper!
We've liked these displays for a long time, but they were never designed for makers to use. Finally, we decided to make our own!
## We have multiple 1.54" EPD displays:
- The tri-color have black and red ink pixels and a white-ish background. [We have a **152x152 Tri-Color** display (older, lower res screen)](https://www.adafruit.com/product/3625) **and** a [**200x200 Tri-Color** display (newer higher res screen)](https://www.adafruit.com/product/4868)
- [The monochrome (black and white) display has **200x200 black pixels**](https://www.adafruit.com/product/4196) on a white-ish background. The monochrome displays take a lot less time to update, only a couple seconds instead of 15 seconds!
Using our Arduino library, you can create a 'frame buffer' with what pixels you want to have activated and then write that out to the display. Most simple breakouts leave it at that. But if you do the math, using even the smallest 1.54" display: 152 x 152 pixels x 2 colors = 5.7 KBytes. Which won't fit into many microcontroller memories. Heck, even if you do have 32KB of RAM, why waste 6KB?
**So we did you a favor and tossed a small SRAM chip on the back.** This chip shares the SPI port the eInk display uses, so you only need one extra pin. And, no more frame-buffering! **You can use the SRAM to set up whatever you want to display, then shuffle data from SRAM to eInk when you're ready. [The library we wrote does all the work for you](https://github.com/adafruit/Adafruit_EPD)**[, you can just interface with it as if it were an Adafruit\_GFX compatible display](https://github.com/adafruit/Adafruit_EPD).
For ultra-low power usages, the onboard 3.3V regulator has the Enable pin brought out so you can shut down the power to the SRAM, MicroSD and display.
We even added on a MicroSD socket so you can store images, text files, whatever you like to display. Everything is 3 or 5V logic safe so you can use it with any and all microcontrollers.
**Revision History (Monochrome version):**
- **As of February 5, 2024** We've updated this PCB with [Adafruit Pinguin](https://github.com/adafruit/Adafruit_Pinguin) to make a lovely and legible silkscreen. There is also the new EYESPI connector, which makes cabling easier with an 18-pin FPC.
- **As of June 7, 2021** we're selling a version with **SSD1681** chipset, instead of the **SSD1608** chipset. Firmware code will need to be updated as they are not code compatible.
# Adafruit 1.54" eInk Display Breakouts
## Pinouts
Info:
This e-Paper display uses SPI to receive image data. Since the display is SPI, it was easy to add two more SPI devices to share the bus - an SPI SRAM chip and SPI-driven SD card holder. There's quite a few pins and a variety of possible combinations for control depending on your needs.
## EYESPI
Both the 1.54" Monochrome and Tri-Color 200x200 eInk displays now come with an EYESPI connector, which is an 18pin 0.5mm pitch connector that allows you to use a flex cable to connect your display to your microcontroller. For more details, visit the [EYESPI page](https://learn.adafruit.com/adafruit-2-13-eink-display-breakouts-and-featherwings/eyespi).
## Power Pins
- **3-5V / Vin** - this is the power pin, connect to 3-5VDC - it has reverse polarity protection but try to wire it right!
- **3.3V** out - this is the 3.3V output from the onboard regulator, you can 'borrow' about 100mA if you need to power some other 3.3V logic devices
- **GND** - this is the power and signal ground pin
- **ENA** ble - This pin is all the way on the right. It is connected to the enable pin on the onboard regulator that powers everything. If you want to _really_ have the lowest possible power draw, pull this pin low! Note that if you do so you will cut power to the eInk display but also the SPI RAM (thus erasing it) and the SD card (which means you'll have to re-initialize it when you re-power
## Data Control Pins
- **SCK** - this is the SPI clock input pin, required for e-Ink, SRAM and SD card
- **MISO** - this is the SPI Microcontroller In Serial Out pin, its used for the SD card and SRAM. It isn't used for the e-Ink display which is write-only, however you'll likely be using the SRAM to buffer the display so connect this one too!
- **MOSI** - this is the SPI Microcontroller Out Serial In pin, it is used to send data from the microcontroller to the SD card, SRAM and e-Ink display
- **ECS** - this is the **E** -Ink **C** hip **S** elect, required for controlling the display
- **D/C** - this is the e-Ink **D** ata/ **C** ommand pin, required for controlling the display
- **SRCS** - this is the **S**** R **AM** C **hip** S**elect, required for communicating with the onboard RAM chip.
- **SDCS** - this is the **SD** card **C** hip **S** elect, required for communicating with the onboard SD card holder. You can leave this disconnected if you aren't going to access SD cards
- **RST** - this is the E-Ink **R** e **S** e **T** pin, you may be able to share this with your microcontroller reset pin but if you can, connect it to a digital pin.
- **BUSY** - this is the e-Ink busy detect pin, and is optional if you don't want to connect the pin (in which case the code will just wait an approximate number of seconds)
# Adafruit 1.54" eInk Display Breakouts
## EYESPI
This display now comes with an **EYESPI connector**. This connector allows you to connect your display without soldering. There are [EYESPI cables](https://www.adafruit.com/?q=eyespi+cable&sort=BestMatch) available in multiple lengths, which means you can find one to fit any project. This is especially useful if your project requires the display to be freestanding, and not tied directly into a breadboard. Inspired by the popularity of STEMMA QT, it provides plug-n-play for displays!
## The EYESPI Connector and Cables
The EYESPI connector is an 18 pin 0.5mm pitch FPC connector with a flip-top tab for locking in the associated flex cable. It is designed to allow you to connect a display, without needing to solder headers or wires to the display.
The EYESPI connector location on this display is indicated below.
The EYESPI cables are 18 pin 0.5mm pitch flex cables. They are ~9.6mm wide, and designed to fit perfectly into the EYESPI connector. Adafruit currently offers EYESPI cables in three different lengths: [50mm](https://www.adafruit.com/product/5462), [100mm](https://www.adafruit.com/product/5239), and [200mm](https://www.adafruit.com/product/5240).
Warning:
## Wiring Your EYESPI Display
Wiring your EYESPI display to a microcontroller via the EYESPI connector requires the EYESPI breakout board and an EYESPI cable.
Featured
### Adafruit EYESPI Breakout Board - 18 Pin FPC Connector
[Adafruit EYESPI Breakout Board - 18 Pin FPC Connector](https://www.adafruit.com/product/5613)
Our most recent [display breakouts have come with a new feature: an 18-pin "EYE SPI" standard FPC connector with flip-top connector](https://www.adafruit.com/?q=eyespi&sort=BestMatch). This is intended to be a sort-of "
In Stock
[Buy Now](https://www.adafruit.com/product/5613)
[Related Guides to the Product](https://learn.adafruit.com/products/5613/guides)
Featured
### EYESPI Cable - 18 Pin 100mm long Flex PCB (FPC) A-B type
[EYESPI Cable - 18 Pin 100mm long Flex PCB (FPC) A-B type](https://www.adafruit.com/product/5239)
Connect this to that when a 18-pin FPC connector is needed. This 25 cm long cable is made of a flexible PCB. It's A-B style which means that pin one on one side will match with pin one on the other side. How handy!
In Stock
[Buy Now](https://www.adafruit.com/product/5239)
[Related Guides to the Product](https://learn.adafruit.com/products/5239/guides)
The following example shows how to connect the 1.54" Monochrome eInk to a Feather RP2040 using the EYESPI breakout board.
Connect the following Feather pins to the associated EYESPI breakout pins:
- **Breakout Vin** to **Feather Vin (red wire)**
- **Breakout Gnd** to **Feather Gnd (black wire)**
- **Breakout SCK** to **Feather SCK (grey wire)**
- **Breakout MOSI** to **Feather MOSI (purple wire)**
- **Breakout MISO** to **Feather MISO (green wire)**
- **Breakout MEMCS** to **Feather pin 6 (white wire)**
- **Breakout TCS** to **Feather pin 9 (blue wire)**
- **Breakout DC** to **Feather pin 10 (orange wire)**
- **Breakout RST** to **Feather pin 11 (cyan wire)**
- **Breakout BUSY** to **Feather pin 12 (yellow wire)**
- **Breakout SDCS** to **Feather pin 13 (pink wire)**
Finally, connect your **display EYESPI connector** to the **breakout EYESPI connector** using an **EYESPI cable**. For details on using the EYESPI connector properly, visit [Plugging in an EYESPI Cable](https://learn.adafruit.com/adafruit-eyespi-breakout-board/plugging-in-an-eyespi-cable).
## EYESPI Pins
Though there are 18 pins available on the EYESPI connector, many displays do not use all available pins. This display requires the following pins:
- **Vin** - This is the power pin. To power the board (and thus your display), connect to the same power as the logic level of your microcontroller, e.g. for a 3V micro like a Feather, use 3V, and for a 5V micro like an Arduino, use 5V
- **GND** - This is common ground for power and logic
- **SCK** - This is the SPI clock input pin
- **MOSI** - This is the SPI MOSI ( **M** icrocontroller **O** ut / **S** erial **I** n) pin. It is used to send data from the microcontroller to the SD card and/or display
- **MISO** - This is the SPI MISO ( **M** icrocontroller **I** n / **S** erial **O** ut) pin. It's used for the SD card. It isn't used for the display because it's write-only. It is 3.3V logic out (but can be read by 5V logic)
- **ECS/TCS** - eInk Chip Select pin
- **DC** - Data/command pin
- **MEMCS** - **Mem** ory **C** hip **S** elect, required for communicating with the onboard RAM chip ( **SRAMCS** on the breakout)
- **RST** - This is the display reset pin. Connecting to ground resets the display! It's best to have this pin controlled by the library so the display is reset cleanly, but you can also connect it to the microcontroller's Reset pin, which works for most cases. Often, there is an automatic-reset chip on the display which will reset it on power-up, making this connection unnecessary in that case
- **BUSY** - e-Ink busy detect pin
- **SDCS** - This is the SD card chip select pin. This pin is required for communicating with the SD card holder onboard the connected display
- **GPIO1** - This is connected to the **ENA** (enable) pin on the breakout
# Adafruit 1.54" eInk Display Breakouts
## Plugging in an EYESPI Cable
You can connect an EYESPI compatible display to the EYESPI breakout board using an EYESPI cable. An EYESPI cable is an 18 pin flexible PCB (FPC). The FPC can only be connected properly in one orientation, so be sure to follow the steps below to ensure that your display and breakout are plugged in properly.
Each EYESPI cable has **blue stripes** on either end. On the other side of the cable, underneath the blue stripe, are the connector pins that make contact with the FPC connector pins on the display or breakout.
To begin inserting an EYESPI cable to an FPC connector, gently lift the FPC connector black latch up.
Then, insert the EYESPI cable into the open FPC connector by sliding the cable into the connector. You want to **see the blue stripe facing up towards you**. This inserts the cable pins into the FPC connector.
To secure the cable, lower the FPC connector latch onto the EYESPI cable.
Repeat this process for the FPC connector on your display. Again, ensure that the **blue stripe** on either end of the cable is facing up.
# Adafruit 1.54" eInk Display Breakouts
## Assembly
## Assembly
Cut the header down to length if necessary. It will be easier to solder if you insert it into a breadboard - **long pins down**
## Add the E-Ink Display
Place the board over the pins so that the short pins poke through the top of the breakout pads
## And Solder!
Be sure to solder all pins for reliable electrical contact.
_(For tips on soldering, be sure to check out the _[_Guide to Excellent Soldering_](http://learn.adafruit.com/adafruit-guide-excellent-soldering)_)._
OK, you're done!
# Adafruit 1.54" eInk Display Breakouts
## Wiring
## Breakout Wiring
Though it looks like a lot of connections, wiring up an eInk breakout is pretty straightforward! Below shows using hardware SPI to connect it to an Adafruit Metro M4.
- **Vin** connects to the microcontroller board's **5V** or **3.3V** power supply pin
- **GND** connects to ground
- **CLK** connects to SPI clock. It's easiest to connect it to **pin 3 of the ICSP header**.
- **MOSI** connects to SPI MOSI. It's easiest to connect it to **pin 4 of the ICSP header**.
- **MISO** connects to SPI MISO. It's easiest to connect it to **pin 1 of the ICSP header**.
- **ECS** connects to our e-Ink Chip Select pin. We'll be using **Digital 9**
- **D/C** connects to our e-Ink data/command select pin. We'll be using **Digital 10**.
- **SRCS** connects to our SRAM Chip Select pin. We'll be using **Digital 6**
- **RST** connects to our e-Ink reset pin. We'll be using **Digital 8**.
- **BUSY** connects to our e-Ink busy pin. We'll be using **Digital 7**.
- **SDCS** connects to our SD Card Chip Select pin. We'll be using **Digital 5**
## Python Wiring
- **Raspberry Pi 3.3** to **display VIN**
- **Raspberry Pi GND** to **display GND**
- **Raspberry Pi SCLK** to **display SCK**
- **Raspberry Pi MOSI** to **display MOSI**
- **Raspberry Pi GPIO CE0** to **display ECS**
- **Raspberry Pi GPIO 22** to **display D/C**
- **Raspberry Pi GPIO 27** to **display RST**
- **Raspberry Pi GPIO 17** to **display BUSY**
# Adafruit 1.54" eInk Display Breakouts
## Usage & Expectations
One thing to remember with these small e-Ink screens is that its _very slow_ compared to OLEDs, TFTs, or even 'memory displays'. **It will take may seconds to fully erase and replace an image**
There's also a recommended limit on refeshing - **you shouldn't refresh or change the display more than every 3 minutes (180 seconds)**.
You don't have to refresh often, but with tri-color displays, the larger red ink dots will slowly rise, turning the display pinkish instead of white background. **To keep the background color clear and pale, refresh once a day**
Danger:
# Adafruit 1.54" eInk Display Breakouts
## Arduino Setup
To use the display, you will need to [install the Adafruit\_EPD library (code on our github repository)](https://github.com/adafruit/Adafruit_EPD "Link: https://github.com/adafruit/Adafruit\_EPD"). It is available from the Arduino library manager so we recommend using that.
From the IDE open up the library manager...
And type in **adafruit EPD** to locate the library. Click **Install**
If you would like to draw bitmaps, do the same with **adafruit ImageReader** , click **Install**
Do the same to install the latest **adafruit GFX** library, click **Install**
If using an earlier version of the Arduino IDE (pre-1.8.10), locate and install **Adafruit\_BusIO** (newer versions handle this prerequisite automatically).
# Adafruit 1.54" eInk Display Breakouts
## Arduino Usage
Danger:
## 1.54" Monochrome 200x200 Pixel Display
For the [200 x 200 monochrome display](https://www.adafruit.com/product/4196) we will run a monochrome demo.
Featured
### Adafruit 1.54" Monochrome eInk / ePaper Display with SRAM
[Adafruit 1.54" Monochrome eInk / ePaper Display with SRAM](https://www.adafruit.com/product/4196)
Easy e-paper finally comes to microcontrollers, with this breakout that's designed to make it a breeze to add an eInk display. Chances are you've seen one of those new-fangled 'e-readers' like the Kindle or Nook. They have gigantic electronic paper 'static' displays -...
Out of Stock
[Buy Now](https://www.adafruit.com/product/4196)
[Related Guides to the Product](https://learn.adafruit.com/products/4196/guides)
Open up **File→Examples→Adafruit\_EPD→**** ThinkInk\_mono**
## 1.54" Tri-Color 152x152 OR 200x200 Pixel Display
For the 152x152 OR 200x200 Tri-Color display, we will run the tricolor demo.
Featured
### Adafruit 1.54" Tri-Color eInk / ePaper Display with SRAM
[Adafruit 1.54" Tri-Color eInk / ePaper Display with SRAM](https://www.adafruit.com/product/4868)
Easy e-paper finally comes to microcontrollers, with this breakout that's designed to make it a breeze to add a tri-color eInk display. Chances are you've seen one of those new-fangled 'e-readers' like the Kindle or Nook. They have gigantic electronic paper 'static'...
Out of Stock
[Buy Now](https://www.adafruit.com/product/4868)
[Related Guides to the Product](https://learn.adafruit.com/products/4868/guides)
Open up **File→Examples→Adafruit\_EPD→ThinkInk\_tricolor**
# Configure Pins
No matter what display you have, you will need to verify that your pins match your wiring. At the top of the sketch find the lines that look like:
```cpp
#define EPD_DC 10
#define EPD_CS 9
#define SRAM_CS 6
#define EPD_RESET 8 // can set to -1 and share with microcontroller Reset!
#define EPD_BUSY 7 // can set to -1 to not use a pin (will wait a fixed delay)
```
If you wired the display differently than on the wiring page, adjust the pin numbers accordingly.
# Configure Display Type & Size
Find the part of the script where you can pick which display is going to be used. The eInk displays are made up a combination of a Chipset and a Film in different sizes. We have narrowed it down to just a few choices between the size of the display, chipset, and film based on available combinations. In the sketch, we have sorted it by size, so it's easy to find your display.
You will need to uncomment the appropriate initializer and and leave any other type commented.
For the [**1.54" 200x200 Monochrome breakout**](https://www.adafruit.com/product/4196) you will use `ThinkInk_154_Mono_D27` display initializer.
For the [**1.54" 152x152 Tri-Color breakout**](https://www.adafruit.com/product/3625), you will use the `ThinkInk_154_Tricolor_Z17` display initializer.
For the [**1.54" 200x200 Tri-Color breakout**](https://www.adafruit.com/product/4868), you will use the `ThinkInk_154_Tricolor_Z90` display initializer.
For example, for the monochrome 200x200, uncomment this line, and comment any other line that is creating a ThinkInk display object
```python
// 1.54" Monochrome displays with 200x200 pixels and SSD1608 chipset
ThinkInk_154_Mono_D27 display(EPD_DC, EPD_RESET, EPD_CS, SRAM_CS, EPD_BUSY);
```
# Upload Sketch
Go ahead and upload the sketch to your board. Once it is done uploading, open the **Serial Monitor**.
The display should start running a series of monochrome tests
# Adafruit 1.54" eInk Display Breakouts
## Arduino Bitmaps
Not only can you draw shapes but you can also load images from the SD card, perfect for static images!
The 1.54" Monochrome display can show a max of 200x200 pixels and the Standard 1.54" Tri-Color display can show a max of 152x152 pixels and the HD Tri-Color version can show a max of 200x200 pixels. Let's use this Blinka bitmap for our demo. Select the one that is the correct size:
[Download Monochrome blinka.bmp](https://github.com/adafruit/Adafruit_ImageReader/raw/master/images/E-Ink%201.54/blinka_mono.bmp)
[Download Tri-Color blinka.bmp](https://raw.githubusercontent.com/adafruit/Adafruit_ImageReader/master/images/E-Ink%201.54/blinka.bmp)
[Download HD Tri-Color blinka.bmp](https://github.com/adafruit/Adafruit_ImageReader/raw/master/images/E-Ink%201.54/blinka_hd.bmp)
Download the **blinka.bmp** file and place it into the base directory of a microSD card and insert it into the microSD socket in the breakout.
Plug the MicroSD card into the display. You may want to try the **SD library** examples before continuing, especially one that lists all the files on the SD card
Open the **file→examples→Adafruit\_ImageReader→ThinkInkDisplay**** s** example
Upload to your board and you should see an image of Blinka appear.
If you want to later use your own image, use an image editing tool and crop your image to no larger than 152 pixels wide and 152 pixels high on the standard display and no larger than 200 pixels wide and 200 pixels high on the HD display. Save it as a 24-bit color **BMP** file - it must be 24-bit color format to work, even if it was originally a 16-bit color image - because of the way BMPs are stored and displayed!
# Adafruit 1.54" eInk Display Breakouts
## CircuitPython Usage
Danger:
## CircuitPython eInk displayio Library Installation
To use displayio, you will need to install the appropriate library for your display.
First make sure you are running the [latest version of Adafruit CircuitPython](https://learn.adafruit.com/welcome-to-circuitpython/installing-circuitpython) for your board. You will need the latest version of CircuitPython.
Next you'll need to install the necessary libraries to use the hardware--carefully follow the steps to find and install these libraries from [Adafruit's CircuitPython library bundle](https://github.com/adafruit/Adafruit_CircuitPython_Bundle). Our introduction guide has [a great page on how to install the library bundle](https://learn.adafruit.com/welcome-to-circuitpython/circuitpython-libraries) for both express and non-express boards.
You will need to copy the appropriate displayio driver from the bundle **lib** folder to a **lib** folder on your **CIRCUITPY** drive. The displayio driver contains the initialization codes specific to your display that are needed to for it to work. Since there is more than one driver, you will need to copy the correct file over. Here is a list of each of the displays and the correct driver for that display.
Warning:
### Adafruit\_CircuitPython\_SSD1608
[The 200x200 monochrome display with SSD1608 driver](https://www.adafruit.com/product/4196) uses the **Adafruit\_CircuitPython\_SSD1608** library. Copy the `adafruit_ssd1608.mpy` file from the bundle to the **lib** folder on your **CIRCUITPY** drive.
Featured
### Adafruit 1.54" Monochrome eInk / ePaper Display with SRAM
[Adafruit 1.54" Monochrome eInk / ePaper Display with SRAM](https://www.adafruit.com/product/4196)
Easy e-paper finally comes to microcontrollers, with this breakout that's designed to make it a breeze to add an eInk display. Chances are you've seen one of those new-fangled 'e-readers' like the Kindle or Nook. They have gigantic electronic paper 'static' displays -...
Out of Stock
[Buy Now](https://www.adafruit.com/product/4196)
[Related Guides to the Product](https://learn.adafruit.com/products/4196/guides)
### Adafruit\_CircuitPython\_IL0373
[The 152x152 Tri-Color display with IL0373](https://www.adafruit.com/product/3625) uses the **Adafruit\_CircuitPython\_ILI0373** library. Copy the `adafruit_il0373.mpy` file from the bundle to the **lib** folder on your **CIRCUITPY** drive.
### Adafruit\_CircuitPython\_SSD1681
[The 200x200 Tri-Color display with SSD1681 driver](https://www.adafruit.com/product/4868) uses the **Adafruit\_CircuitPython\_SSD1681** library. Copy the `adafruit_ssd1681.mpy` file from the bundle to the **lib** folder on your **CIRCUITPY** drive.
Featured
### Adafruit 1.54" Tri-Color eInk / ePaper Display with SRAM
[Adafruit 1.54" Tri-Color eInk / ePaper Display with SRAM](https://www.adafruit.com/product/4868)
Easy e-paper finally comes to microcontrollers, with this breakout that's designed to make it a breeze to add a tri-color eInk display. Chances are you've seen one of those new-fangled 'e-readers' like the Kindle or Nook. They have gigantic electronic paper 'static'...
Out of Stock
[Buy Now](https://www.adafruit.com/product/4868)
[Related Guides to the Product](https://learn.adafruit.com/products/4868/guides)
## Image File
To show you how to use the eInk with displayio, we'll show you how to draw a bitmap onto it. First start by downloading **display-ruler.bmp**
[Download display-ruler.bmp](https://github.com/adafruit/Adafruit_CircuitPython_IL0373/raw/main/examples/display-ruler.bmp)
Copy **display-ruler.bmp** into the root directory of your **CIRCUITPY** drive.
## Monochrome Display Usage
In the examples folder for your SSD1608 displayio driver, there should be a test for your display which we have listed here:
https://github.com/adafruit/Adafruit_CircuitPython_SSD1608/blob/main/examples/ssd1608_simpletest.py
### Configure and Upload
You will want to change the `epd_reset` and `epd_busy` to **the correct values**. If you wired it up as shown on the Wiring page, you will want to change it to these values:
```python
epd_reset = board.D8
epd_busy = board.D7
```
Save it to your **CIRCUITPY** drive as **code.py** and it should automatically run. Your display will look something like this:
## Tri-Color Display Usage
### HD Tri-Color Display
In the examples folder for your SSD1681 displayio driver, there should be a test for your display which we have listed here:
https://github.com/adafruit/Adafruit_CircuitPython_SSD1681/blob/main/examples/ssd1681_simpletest.py
### Standard Tri-Color Display
In the examples folder for your ILI0373 displayio driver, there should be a test for your display which we have listed here:
https://github.com/adafruit/Adafruit_CircuitPython_IL0373/blob/main/examples/il0373_1.54_color.py
### Configure and Upload
For either display, you will want to change the `epd_reset` and `epd_busy` to **the correct values**. If you wired it up as shown on the Wiring page, you will want to change it to these values:
```python
epd_reset = board.D8
epd_busy = board.D7
```
Save it to your **CIRCUITPY** drive as **code.py** and it should automatically run. Your display will look something like this:
# Adafruit 1.54" eInk Display Breakouts
## Python Setup
It's easy to use eInk breakouts with Python and the [Adafruit CircuitPython EPD](https://github.com/adafruit/Adafruit_CircuitPython_EPD) library. This library allows you to easily write Python code to control the display.
Since there are _dozens_ of Linux computers/boards you can use, we will show wiring for Raspberry Pi. For other platforms, [please visit the guide for CircuitPython on Linux to see whether your platform is supported](https://learn.adafruit.com/circuitpython-on-raspberrypi-linux).
Info:
Warning:
## Setup Virtual Environment
If you are installing on the Bookworm version of Raspberry Pi OS or later, you will need to install your python modules in a virtual environment. You can find more information in the [Python Virtual Environment Usage on Raspberry Pi](https://learn.adafruit.com/python-virtual-environment-usage-on-raspberry-pi) guide. To Install and activate the virtual environment, use the following commands:
```terminal
sudo apt install python3-venv
python -m venv env --system-site-packages
```
To activate the virtual environment:
```terminal
source env/bin/activate
```
## Install Adafruit\_Blinka
You'll need to install the **Adafruit\_Blinka** library that provides the CircuitPython support in Python. This may also require enabling SPI on your platform and verifying you are running Python 3. [Since each platform is a little different, and Linux changes often, please visit the CircuitPython on Linux guide to get your computer ready](https://learn.adafruit.com/circuitpython-on-raspberrypi-linux)!
## Python Installation of EPD Library
Once that's done, from your command line run the following command:
```terminal
pip3 install adafruit-circuitpython-epd
```
If your default Python is version 3 you may need to run 'pip' instead. Just make sure you aren't trying to use CircuitPython on Python 2.x, it isn't supported!
If that complains about pip3 not being installed, then run this first to install it:
```terminal
sudo apt-get install python3-pip
```
## Download font5x8.bin
**This library also requires a font file to run!** You can download it below. Before continuing, make sure the folder you are running scripts from contains the **font5x8.bin** file.
[Download font5x8.bin](https://github.com/adafruit/Adafruit_CircuitPython_framebuf/raw/main/examples/font5x8.bin)
Alternatively, you can use `wget` to directly download the file to your pi:
```terminal
wget https://github.com/adafruit/Adafruit_CircuitPython_framebuf/raw/main/examples/font5x8.bin
```
## DejaVu TTF Font
Raspberry Pi usually comes with the DejaVu font already installed, but in case it didn't, you can run the following to install it:
```terminal
sudo apt-get install fonts-dejavu
```
This package was previously calls **ttf-dejavu** , so if you are running an older version of Raspberry Pi OS, it may be called that.
## Pillow Library
Some of the examples also use PIL, the Python Imaging Library, to allow graphics and using text with custom fonts. There are several system libraries that PIL relies on, so installing via a package manager is the easiest way to bring in everything:
```terminal
sudo apt-get install python3-pil
```
## Chip Enable Lines
Follow [these instructions](https://learn.adafruit.com/circuitpython-on-raspberrypi-linux/spi-sensors-devices#reassigning-or-disabling-the-spi-chip-enable-lines-3097985) for dealing with SPI chip enable line issues.
That's it. You should be ready to go.
# Adafruit 1.54" eInk Display Breakouts
## Python Usage
Warning:
Warning:
To demonstrate the usage of the display, we'll initialize it and draw some lines from the Python REPL.
Run the following code to import the necessary modules and set up the pin assignments. We set the SRAM CS pin to `None` because the Raspberry Pi has lots of RAM, so we don't really need it.
```python
import digitalio
import busio
import board
from adafruit_epd.epd import Adafruit_EPD
spi = busio.SPI(board.SCK, MOSI=board.MOSI, MISO=board.MISO)
ecs = digitalio.DigitalInOut(board.CE0)
dc = digitalio.DigitalInOut(board.D22)
rst = digitalio.DigitalInOut(board.D27)
busy = digitalio.DigitalInOut(board.D17)
srcs = None
```
Info:
Run the following code to initialize the Monochrome display:
Featured
### Adafruit 1.54" Monochrome eInk / ePaper Display with SRAM
[Adafruit 1.54" Monochrome eInk / ePaper Display with SRAM](https://www.adafruit.com/product/4196)
Easy e-paper finally comes to microcontrollers, with this breakout that's designed to make it a breeze to add an eInk display. Chances are you've seen one of those new-fangled 'e-readers' like the Kindle or Nook. They have gigantic electronic paper 'static' displays -...
Out of Stock
[Buy Now](https://www.adafruit.com/product/4196)
[Related Guides to the Product](https://learn.adafruit.com/products/4196/guides)
```python
from adafruit_epd.ssd1608 import Adafruit_SSD1608
display = Adafruit_SSD1608(200, 200, spi, cs_pin=ecs, dc_pin=dc, sramcs_pin=srcs, rst_pin=rst, busy_pin=busy)
```
Run the following code to initialize the lower-res Tri-Color display:
```python
from adafruit_epd.il0373 import Adafruit_IL0373
display = Adafruit_IL0373(152, 152, spi, cs_pin=ecs, dc_pin=dc, sramcs_pin=srcs, rst_pin=rst, busy_pin=busy)
```
Run the following code to initialize the newer high-res Tri-Color display:
Featured
### Adafruit 1.54" Tri-Color eInk / ePaper Display with SRAM
[Adafruit 1.54" Tri-Color eInk / ePaper Display with SRAM](https://www.adafruit.com/product/4868)
Easy e-paper finally comes to microcontrollers, with this breakout that's designed to make it a breeze to add a tri-color eInk display. Chances are you've seen one of those new-fangled 'e-readers' like the Kindle or Nook. They have gigantic electronic paper 'static'...
Out of Stock
[Buy Now](https://www.adafruit.com/product/4868)
[Related Guides to the Product](https://learn.adafruit.com/products/4868/guides)
```python
from adafruit_epd.ssd1681 import Adafruit_SSD1681
display = Adafruit_SSD1681(200, 200, spi, cs_pin=ecs, dc_pin=dc, sramcs_pin=srcs, rst_pin=rst, busy_pin=busy)
```
## Monochrome Example
Now we can clear the screens buffer and draw some shapes. Once we're done drawing, we need to tell the screen to update using the `display()` method.
```python
display.rotation = 2
display.fill(Adafruit_EPD.WHITE)
display.fill_rect(20, 20, 50, 60, Adafruit_EPD.BLACK)
display.hline(80, 30, 60, Adafruit_EPD.BLACK)
display.vline(80, 30, 60, Adafruit_EPD.BLACK)
display.display()
```
## Tri-Color Example
The Tri-Color example is almost the same as the monochrome example, except we added another color in. Once we're done drawing, we need to tell the screen to update using the `display()` method.
```python
display.rotation = 2
display.fill(Adafruit_EPD.WHITE)
display.fill_rect(20, 20, 50, 60, Adafruit_EPD.RED)
display.hline(80, 30, 60, Adafruit_EPD.BLACK)
display.vline(80, 30, 60, Adafruit_EPD.BLACK)
display.display()
```
Your display will look something like this:
That's all there is to drawing simple shapes with eInk displays and CircuitPython!
# Bitmap Example
Here's a complete example of how to display a bitmap image on your display. **Note that any .bmp image you want to display must be exactly the size of your display.** We will be using the image below on the 1.54" display. Click the button below to download the image and save it as **blinka.bmp** on your **Raspberry Pi**. We will be using a Tri-Color bitmap, but it should still work on a monochrome display.
[Click here to download blinka for the 1.54" Low Res Tri-Color display](https://github.com/adafruit/Adafruit_ImageReader/raw/master/images/E-Ink%201.54/blinka.bmp)
[Click here to download blinka for the 1.54" High Res Tri-Color and Mono displays](https://github.com/adafruit/Adafruit_ImageReader/raw/master/images/E-Ink%201.54/blinka_hd.bmp)
Save the following code to your Raspberry Pi as **epd\_bitmap.py**.
https://github.com/adafruit/Adafruit_CircuitPython_EPD/blob/main/examples/epd_bitmap.py
Before running it, we need to change a few pin definitions though. Find the section of code that looks like this:
```python
ecs = digitalio.DigitalInOut(board.D10)
dc = digitalio.DigitalInOut(board.D9)
srcs = digitalio.DigitalInOut(board.D7) # can be None to use internal memory
rst = digitalio.DigitalInOut(board.D11) # can be None to not use this pin
busy = digitalio.DigitalInOut(board.D12) # can be None to not use this pin
```
Change the pins to the following to match the wiring on the Raspberry Pi:
```python
ecs = digitalio.DigitalInOut(board.CE0)
dc = digitalio.DigitalInOut(board.D22)
srcs = None
rst = digitalio.DigitalInOut(board.D27)
busy = digitalio.DigitalInOut(board.D17)
```
Next, find the section that looks like this:
```python
# display = Adafruit_SSD1608(200, 200, # 1.54" HD mono display
# display = Adafruit_SSD1675(122, 250, # 2.13" HD mono display
# display = Adafruit_SSD1681(200, 200, # 1.54" HD Tri-color display
# display = Adafruit_IL91874(176, 264, # 2.7" Tri-color display
# display = Adafruit_IL0373(152, 152, # 1.54" Tri-color display
# display = Adafruit_IL0373(128, 296, # 2.9" Tri-color display
# display = Adafruit_IL0398(400, 300, # 4.2" Tri-color display
display = Adafruit_IL0373(
104,
212,
spi, # 2.13" Tri-color display
cs_pin=ecs,
dc_pin=dc,
sramcs_pin=srcs,
rst_pin=rst,
busy_pin=busy,
)
```
**Comment out** these lines:
```python
display = Adafruit_IL0373(
104,
212, # 2.13" Tri-color display
```
and **uncomment** the line that corresponds with your display.
Next we tell the display the rotation setting we want to use. This can be a value between `0-3`. For the 1.54" displays, a value of `2` seems to work well.
```python
display.rotation = 2
```
Now go to the command prompt on your Raspberry Pi and run the script with the following command:
`python3 epd_bitmap.py`
After a few seconds, your display should show an image like this:
# Full Example Code
Here is the full example code.
Info:
https://github.com/adafruit/Adafruit_CircuitPython_EPD/blob/main/examples/epd_simpletest.py
# Image Drawing with Pillow
In this image, we will use Pillow to resize and crop the image automatically and draw it the the ePaper Display. Pillow is really powerful and with it you can open and render additional file formats such as PNG or JPG. Let's start with downloading a PNG of blinka that has been adjusted down to 3 colors so it prints nicely on an ePaper Display. We are using PNG for this because it is a lossless format and won't introduce unexpected colors in.
Make sure you save it as **blinka.png** and place it in the same folder as your script. Here's the code we'll be loading onto the Raspberry Pi. Go ahead and copy it onto your Raspberry Pi and save it as **epd\_pillow\_image.py**. We'll go over the interesting parts.
https://github.com/adafruit/Adafruit_CircuitPython_EPD/blob/main/examples/epd_pillow_image.py
So we start with our usual imports including a couple of Pillow modules and the ePaper display drivers.
```python
import digitalio
import busio
import board
from PIL import Image, ImageDraw
from adafruit_epd.il0373 import Adafruit_IL0373
from adafruit_epd.il91874 import Adafruit_IL91874
from adafruit_epd.il0398 import Adafruit_IL0398
from adafruit_epd.ssd1608 import Adafruit_SSD1608
from adafruit_epd.ssd1675 import Adafruit_SSD1675
from adafruit_epd.ssd1681 import Adafruit_SSD1681
```
That is followed by initializing the SPI bus and defining a few pins here. The reason we chose these is because they allow you to use the same code with the EPD bonnets if you chose to do so.
```python
spi = busio.SPI(board.SCK, MOSI=board.MOSI, MISO=board.MISO)
ecs = digitalio.DigitalInOut(board.CE0)
dc = digitalio.DigitalInOut(board.D22)
srcs = None
rst = digitalio.DigitalInOut(board.D27)
busy = digitalio.DigitalInOut(board.D17)
```
We wanted to make these examples work on as many displays as possible with very few changes. The 2.13" Tri-color display is selected by default. For other displays, go ahead and comment out the following lines:
`display = Adafruit_IL0373( 104, 212, # 2.13" Tri-color display`
and uncomment the line appropriate for your display.
```python
#display = Adafruit_SSD1608(200, 200, # 1.54" HD mono display
#display = Adafruit_SSD1675(122, 250, # 2.13" HD mono display
#display = Adafruit_SSD1681(200, 200, # 1.54" HD Tri-color display
#display = Adafruit_IL91874(176, 264, # 2.7" Tri-color display
#display = Adafruit_IL0373(152, 152, # 1.54" Tri-color display
#display = Adafruit_IL0373(128, 296, # 2.9" Tri-color display
#display = Adafruit_IL0398(400, 300, # 4.2" Tri-color display
display = Adafruit_IL0373(
104,
212, # 2.13" Tri-color display
spi,
cs_pin=ecs,
dc_pin=dc,
sramcs_pin=srcs,
rst_pin=rst,
busy_pin=busy
)
```
Next change the rotation setting to `2`.
```python
display.rotation = 2
```
Next we open the Blinka image, which we've named **blinka.png** , which assumes it is in the same directory that you are running the script from. Feel free to change it if it doesn't match your configuration.
```python
image = Image.open("blinka.png")
```
Here's where it starts to get interesting. We want to scale the image so that it matches either the width or height of the display, depending on which is smaller, so that we have some of the image to chop off when we crop it. So we start by calculating the width to height ration of both the display and the image. If the height is the closer of the dimensions, we want to match the image height to the display height and let it be a bit wider than the display. Otherwise, we want to do the opposite.
Once we've figured out how we're going to scale it, we pass in the new dimensions and using a **Bicubic** rescaling method, we reassign the newly rescaled image back to `image`. Pillow has quite a few different methods to choose from, but Bicubic does a great job and is reasonably fast.
**Nearest** actually gives a little better result with the Tri-color eInks, but loses detail with displaying a color image on the monochrome display, so we decided to go with the best balance.
```python
image_ratio = image.width / image.height
screen_ratio = display.width / display.height
if screen_ratio < image_ratio:
scaled_width = image.width * display.height // image.height
scaled_height = display.height
else:
scaled_width = display.width
scaled_height = image.height * display.width // image.width
image = image.resize((scaled_width, scaled_height), Image.BICUBIC)
```
Next we want to figure the starting x and y points of the image where we want to begin cropping it so that it ends up centered. We do that by using a standard centering function, which is basically requesting the difference of the center of the display and the center of the image. Just like with scaling, we replace the `image` variable with the newly cropped image.
```python
x = scaled_width // 2 - display.width // 2
y = scaled_height // 2 - display.height // 2
image = image.crop((x, y, x + display.width, y + display.height))
```
Finally, we take our `image`, draw it to the frame buffer and `display` it. At this point, the image should have the exact same dimensions at the display and fill it completely.
```python
display.image(image)
display.display()
```
Now go to the command prompt on your Raspberry Pi and run the script with the following command:
`python3 epd_pillow_image.py`
After a few seconds, your display should show this image:
# Drawing Shapes and Text with Pillow
In the next example, we'll take a look at drawing shapes and text. This is very similar to the displayio example, but it uses Pillow instead. Go ahead and copy it onto your Raspberry Pi and save it as **epd\_pillow\_demo.py**. Here's the code for that.
https://github.com/adafruit/Adafruit_CircuitPython_EPD/blob/main/examples/epd_pillow_demo.py
Just like in the last example, we'll do our imports, but this time we're including the `ImageDraw` and `ImageFont` Pillow modules because we'll be drawing some text this time.
```python
import digitalio
import busio
import board
from PIL import Image, ImageDraw, ImageFont
from adafruit_epd.il0373 import Adafruit_IL0373
from adafruit_epd.il91874 import Adafruit_IL91874
from adafruit_epd.il0398 import Adafruit_IL0398
from adafruit_epd.ssd1608 import Adafruit_SSD1608
from adafruit_epd.ssd1675 import Adafruit_SSD1675
from adafruit_epd.ssd1681 import Adafruit_SSD1681
```
Next we define some colors that can be used with Pillow.
```python
WHITE = (0xFF, 0xFF, 0xFF)
BLACK = (0x00, 0x00, 0x00)
RED = (0xFF, 0x00, 0x00)
```
After that, we create some parameters that are easy to change. If you had a smaller display for instance, you could reduce the `FONTSIZE` and `BORDER` parameters. The `BORDER` will be the size in pixels of the green border between the edge of the display and the inner purple rectangle. The `FONTSIZE` will be the size of the font in points so that we can adjust it easily for different displays. You could play around with the colors as well. One thing to note is that on monochrome displays, the `RED` will show up as `BLACK`.
For the 1.54" display, a `BORDER` value of **10** and a `FONTSIZE` value of **20** looks good.
```python
BORDER = 10
FONTSIZE = 20
BACKGROUND_COLOR = BLACK
FOREGROUND_COLOR = WHITE
TEXT_COLOR = RED
```
After that, the initializer and rotation sections are exactly the same as in the previous example. **If you have are using a different display than the 2.13" Tri-color, go ahead and adjust your initializer as explained in the previous example.** After that, we will create an `image` with our dimensions and use that to create a `draw` object. The `draw` object will have all of our drawing functions.
```python
image = Image.new('RGB', (display.width, display.height))
draw = ImageDraw.Draw(image)
```
Next we clear whatever is on the screen by drawing a rectangle using the `BACKGROUND_COLOR` that takes up the full screen.
```python
draw.rectangle((0, 0, display.width, display.height), fill=BACKGROUND_COLOR)
```
Next we will draw an inner rectangle using the `FOREGROUND_COLOR`. We use the `BORDER` parameter to calculate the size and position that we want to draw the rectangle.
```python
draw.rectangle((BORDER, BORDER, display.width - BORDER - 1, display.height - BORDER - 1),
fill=FOREGROUND_COLOR)
```
Next we'll load a TTF font. The `DejaVuSans.ttf` font should come preloaded on your Pi in the location in the code. We also make use of the `FONTSIZE` parameter that we discussed earlier.
```python
font = ImageFont.truetype('/usr/share/fonts/truetype/dejavu/DejaVuSans.ttf', FONTSIZE)
```
Now we draw the text Hello World onto the center of the display. You may recognize the centering calculation was the same one we used to center crop the image in the previous example. In this example though, we get the font size values using the `getsize()` function of the font object.
```python
text = "Hello World!"
(font_width, font_height) = font.getsize(text)
draw.text((display.width//2 - font_width//2, display.height//2 - font_height//2),
text, font=font, fill=TEXT_COLOR)
```
Finally, just like before, we display the image.
```python
display.image(image)
display.display()
```
Now go to the command prompt on your Raspberry Pi and run the script with the following command:
`python3 epd_pillow_demo.py`
After a few seconds, your display should show this image:
# Adafruit 1.54" eInk Display Breakouts
## Downloads
## Files
- [Fritzing object in Adafruit Fritzing Library](https://github.com/adafruit/Fritzing-Library)
- [IL0376F E-Ink interface chip datasheet](https://cdn-learn.adafruit.com/assets/assets/000/057/648/original/IL0376F.pdf)
- [SSD1608 E-Ink interface chip datasheet](https://cdn-learn.adafruit.com/assets/assets/000/099/574/original/SSD1608.pdf)
- [SSD1681 Datasheet](https://cdn-learn.adafruit.com/assets/assets/000/099/573/original/SSD1681.pdf)
- [PCB Files on GitHub](https://github.com/adafruit/Adafruit-E-Paper-Display-Breakout-PCBs)
## Display shape/outline:
## Schematic and Fab Print - 1.54" Breakout with EYESPI
## Schematic and Fab Print - 1.54" Breakout
## Primary Products
### Adafruit 1.54" 152x152 Tri-Color eInk / ePaper Display with SRAM
[Adafruit 1.54" 152x152 Tri-Color eInk / ePaper Display with SRAM](https://www.adafruit.com/product/3625)
Easy e-paper finally comes to microcontrollers, with this breakout that's designed to make it a breeze to add a tri-color eInk display. Chances are you've seen one of those new-fangled 'e-readers' like the Kindle or Nook. They have gigantic electronic paper 'static'...
No Longer Stocked
[Buy Now](https://www.adafruit.com/product/3625)
[Related Guides to the Product](https://learn.adafruit.com/products/3625/guides)
### Adafruit 1.54" Monochrome eInk / ePaper Display with SRAM
[Adafruit 1.54" Monochrome eInk / ePaper Display with SRAM](https://www.adafruit.com/product/4196)
Easy e-paper finally comes to microcontrollers, with this breakout that's designed to make it a breeze to add an eInk display. Chances are you've seen one of those new-fangled 'e-readers' like the Kindle or Nook. They have gigantic electronic paper 'static' displays -...
Out of Stock
[Buy Now](https://www.adafruit.com/product/4196)
[Related Guides to the Product](https://learn.adafruit.com/products/4196/guides)
### Adafruit 1.54" Tri-Color eInk / ePaper Display with SRAM
[Adafruit 1.54" Tri-Color eInk / ePaper Display with SRAM](https://www.adafruit.com/product/4868)
Easy e-paper finally comes to microcontrollers, with this breakout that's designed to make it a breeze to add a tri-color eInk display. Chances are you've seen one of those new-fangled 'e-readers' like the Kindle or Nook. They have gigantic electronic paper 'static'...
Out of Stock
[Buy Now](https://www.adafruit.com/product/4868)
[Related Guides to the Product](https://learn.adafruit.com/products/4868/guides)
## Related Guides
- [QT Py CH32V203 eInk / ePaper Daily Calendar and Clock](https://learn.adafruit.com/ch32v203-eink-epaper-calendar-and-clock.md)
- [Humidity and Temperature Monitor with E-Ink Display](https://learn.adafruit.com/humidity-and-temperature-monitor-redux-e-ink-display.md)
- [MagTag James Webb Telescope Status](https://learn.adafruit.com/magtag-james-webb-telescope-status.md)
- [Adafruit 2.9" eInk Display Breakouts and FeatherWings](https://learn.adafruit.com/adafruit-2-9-eink-display-breakouts-and-featherwings.md)
- [Adafruit 2.13" Monochrome E-Ink Bonnet for Raspberry Pi](https://learn.adafruit.com/2-13-in-e-ink-bonnet.md)
- [OSHWA Project Display With Adafruit MagTag](https://learn.adafruit.com/oshwa-project-display-with-adafruit-magtag.md)
- [MagTag Showerthoughts and Quotes](https://learn.adafruit.com/magtag-showerthoughts.md)
- [Cheerlights Holiday Wreath with Animations](https://learn.adafruit.com/cheerlights-led-animations.md)
- [Preparing Graphics for E-Ink Displays](https://learn.adafruit.com/preparing-graphics-for-e-ink-displays.md)
- [ePaper Camera](https://learn.adafruit.com/epaper-camera.md)
- [MagTag 3D Printed Stand Case](https://learn.adafruit.com/magtag-3d-printed-stand-case.md)
- [No-Code Pool Party Notifier](https://learn.adafruit.com/pool-party-notification-device.md)
- [Adafruit E-Ink Bonnet for Raspberry Pi](https://learn.adafruit.com/adafruit-e-ink-bonnet-for-raspberry-pi.md)
- [Bare E-Ink Displays Crash Course](https://learn.adafruit.com/bare-e-ink-displays-crash-course.md)
- [RePaper eInk Development Board for ARM + GNU/Linux](https://learn.adafruit.com/repaper-eink-development-board-arm-linux-raspberry-pi-beagle-bone-black.md)