12.48inch e-Paper Module (B)

From Waveshare Wiki
Jump to: navigation, search
12.48inch e-Paper (B)
12.48inch-e-Paper-B-3.jpg
12.48inch e-Paper Module (B)
12.48inch-e-Paper-Module-B-1.jpg
{{{name3}}}

{{{name4}}}

{{{name5}}}

Primary Attribute
Category: e-Paper
{{{userDefinedInfo}}}: {{{userdefinedvalue}}}
Brand: Waveshare
Website
English: Website
Chinese: 中文官网
Onboard Interfaces
Related Products

特点

  • Dimension: 12.48inch
  • Outline dimension (raw panel):261.5mm × 211mm × 0.3mm
  • Outline dimension (Acrylic case):280mm x 229.5mm
  • Display size:252.98mm × 190.90mm
  • Working voltage:3.3V/5V
  • Interface:SPI
  • Dot pitch:0.194mm × 0.194mm
  • Resolution:1304 x 984
  • Display color:Black, white, red
  • Grey level:2
  • Full refresh time :16s
  • Refresh power : 26.4mW(typ.)
  • Standby power :<=0.017mW

【Note】: Refresh time:The data provided is experimental data, the actual time may be a little different.It is normal that the e-Paper blink when full updating.
Power:The power data is experimental data.

SPI timing

1.54inch-e-paper-manual-1.png

  • CS is slave chip select, when CS is low, the chip is enabled.
  • DC is data/command control pin, when DC = 0, write command, when DC = 1, write data.
  • SCLK is the SPI communication clock.
  • SDIN is the data line from the master to the slave in SPI communication.

SPI communication has data transfer timing, which is combined by CPHA and CPOL.

  1. CPOL determines the level of the serial synchronous clock at idle state. When CPOL = 0, the level is Low. However, CPOL has little effect to the transmission.
  2. CPHA determines whether data is collected at the first clock edge or at the second clock edge of serial synchronous clock; when CPHL = 0, data is collected at the first clock edge.
  • There are 4 SPI communication modes. SPI0 is commonly used, in which CPHL = 0, CPOL = 0.

As you can see from the figure above, data transmission starts at the first falling edge of SCLK, and 8 bits of data are transferred in one clock cycle. Here, SPI0 is in used, and data is transferred by bits, MSB first.

How do e-Paper display

As we know, this display uses the SPI interface, however, there are two FPC cables. In fact, the 12.48inch e-Paper is combined by four small e-Paper, therefore, to control the e-Paper, you should use four chip select pin.

  • Update essence

It works as below:
12.48inch e-paper-4part.png
We name the four areas as S2, M2, M1 and S1 respectively, in demo codes, we will send data to these four area in order.
The resolution of S2 and M1 are same 648*492, and the resolution of M2 and S1 are the same 656*492.
Combine the four display we get the resolution of 12.48inch e-Paper: 1304*984

  • Control principle

They are four display indeed, therefore, we need to control four SPI salves:
Generally, the control pins of e-Paper are MOSI, SCLK, CS and DC
And power and reset pins: VCC, GND, RST
Because e-Paper will flash when updating, there is a busy pin:BUSY
To reduce pins, four displays use the same VCC, GND, MOSI and SCK pins. Every two displays use the same DC and RST pins.
Therefore, there are total 16 pins for controlling the e-Paper:
12.48inch e-paper-4part2.png

  • Codes analysis

To control the e-Paper, you should first reset and initialize registers. And then transmit image data to e-Paper and update.
Here we show you how to transmit the image data:
We take Black-white or Red-white image as a monochrome bitmap. One byte stands for 8 pixels.

S2 and M1: There are 648 pixels per raw, It needs 648/8 = 81 bytes. One display has 492 column,totally have 81 * 492 = 39852 bytes. The same as the M2 and S1: They totally have 40344 per display。
Registers 0x13 and 0x10 are used to control Black-white image data and Red image data transmitting, here we take two-color display as example

Color 0x10 0x13
White 0xFF 0x00
Black 0x00 0x00
Red 0xFF/0x00 0xFF
void EPD_12in48_Display(const UBYTE *Image)
{
    int x,y;
    //S1 part 648*492
    EPD_S2_SendCommand(0x13);
    for(y = 0; y < 492; y++)
        for(x = 0; x < 81; x++) {
            EPD_S2_SendData(*(Image + (y*163 + x)));
        }

    //M2 part 656*492
    EPD_M2_SendCommand(0x13);
    for(y = 0; y < 492; y++)
        for(x = 81; x < 163; x++) {
            EPD_M2_SendData(*(Image+ (y*163) +x));
        }

    //S1 part 656*492
    EPD_S1_SendCommand(0x13);
    for(y = 492; y < 984; y++)
        for(x = 81; x < 163; x++) {
            EPD_S1_SendData(*(Image+ (y*163) +x));
        }

    //M1 part 648*492
    EPD_M1_SendCommand(0x13);
    for(y = 492; y < 984; y++)
        for(x = 0; x < 81; x++) {
            EPD_M1_SendData(*(Image+ (y*163) +x));
        }
        
    EPD_12in48_TurnOnDisplay();
}


We provide demo codes for four popular hardware platforms, Raspberry Pi, Arduino UNO, STM32 and the ESP32. The product you receive may be pre-assembled, you need to remove the back panel and connect your device like Raspberry Pi.

Raspberry Pi

Hardware connection

12in48-epaper-RPIconnet.JPG

The pins used can be found on schematic according to codes

12in48-epaper-rpi1.png

Enable SPI interface

Open terminal and type command

sudo raspi-config

Choose Interfacing Options -> SPI -> Yes. Then reboot the Raspberry Pi

sudo reboot

Libraries installation

  • Install BCM2835
wget http://www.airspayce.com/mikem/bcm2835/bcm2835-1.60.tar.gz
tar zxvf bcm2835-1.60.tar.gz 
cd bcm2835-1.60/
sudo ./configure
sudo make
sudo make check
sudo make install
  • Install wiringPi
sudo apt-get install wiringpi
cd /tmp
wget https://project-downloads.drogon.net/wiringpi-latest.deb
sudo dpkg -i wiringpi-latest.deb
gpio -v
  • Install python2
sudo apt-get update
sudo apt-get install python-pip
sudo apt-get install python-pil
sudo pip install RPi.GPIO
sudo pip install spidev
  • Install python3
sudo apt-get update
sudo apt-get install python3-pip
sudo apt-get install python3-pil
sudo pip3 install RPi.GPIO
sudo pip3 install spidev

Download

Open terminal and run commands to download codes

sudo apt-get install p7zip-full
wget http://www.waveshare.net/w/upload/9/9a/12.48inch_e-Paper_Module_Code_RPI.7z
7z x 12.48inch_e-Paper_Module_Code_RPI.7z  -r -o./12.48inch_e-Paper_Module_Code
sudo chmod 777 -R 12.48inch_e-Paper_Module_Code
cd 12.48inch_e-Paper_Module_Code

Run codes

  • C codes
cd c
sudo nano examples/main.c
Confirm that which kind of 12.48inch e-Paper do you use. If you use the two-color display, modify the file as below
12in48-epaper-rpi-c1.png
If you use the tree-color display, modify the file as below
12in48-epaper-rpi-c2.png
Save then compile and run the code
sudo make clean
sudo make
sudo ./epd
  • Python codes
Open terminal and run the demo codes by commands:
cd python/examples
For two-color version
sudo python epd_12in48_test.py
For three-color version
sudo python epd_12in48_test.py
  • Python codes-Weather
cd python/examples
For two-color display
sudo python Show_EN_Weather.py
For three-color display
sudo python Show_EN_Weather.py B
For help information
sudo python Show_EN_Weather.py help
12in48-epaper-rpi-weather1.jpg12in48-epaper-rpi-weather2.jpg

Arduino

Hardware connection

You can directly insert the Arduino UNO to PCB

12in48-epaper-Arduinoconne.JPG

About the pins used:

12in48-epaper-arduino1.png

Run codes

Download demo codes from wiki and unzio it.
Copy the 12in48 folder to the libraries directory which is under the installation directory of Arduino IDE.(The installation directory generally is C:\Program Files (x86)\Arduino\libraries)
Open Ardunin IDE software, choose Tool->Board->Arduino UNO:
12in48-epaper-arduino2.png
Click File -> Examples -> EPD12in48 to opem demo cods
12in48-epaper-arduino3.png
If your e-Paper is two-color version, use the epd12in48-demo, otherwise, use the epd12in48b-demo
Compile and download the codes to board

STM32

The development board we use is Waveshare Open103Z. The project is developed based on STM32 HAL libraries.

Hardware connection

To assemble the Open32, you should connect it by wires provided.

12in48-epaper-STM32connet.jpg

About the pins used, you can refer to e-paper.ioc file.

12in48-epaper-STM32-5.png
12in48-epaper-STM32-6.png

Run codes

Open the project (~\STM32\NUCLEO-F103RB\MDK-ARM\e-paper.uvprojx), compile and download to developmen board. It requires about 10s for the two-color version and 20s for three-color display.

ESP32

The demo codes for ESP32 are developed with Arduino IDE as well.

Software setup

To develop ESP32, you should first set up the environment.

12in48-epaper-esp32-1.png
  • Enter the tools folder, and run the get.exe file as administrator. After installing, Copy the esp32-epd-12in48 folder of ESP32 demo codes to [Arduino IDE installation directory]/Hardware/espressif/esp32/libraries
12in48-epaper-esp32-2.png

Hardware connection

Here we use Waveshare e-Paper ESP32 Driver Board as an example. Attach it on PCB.

12in48-epaper-esp32connet.JPG

About the pins used, you can refer to schematic and codes

12in48-epaper-esp32-connet1.png

Examples 1

Open Arduino IDE software, and find the examples on File->Examples

12in48-epaper-esp32-3.png

If you use two-color e-Paper, choose the epd12in48-demo, otherwise, use the epd12in48B-demo

WiFi example

As we know, ESP32 features WIFI, you can set it as master or slave. Here we provide demo codes that control the e-Paper on the web by WIFI.

  • You need to first modify the wifi connection information. Open the Web_App.cpp file and modify the line 50 and line 51:

12in48-epaper-esp32-4.png

  • Open wifi.ino file, compile and download it to your ESP32 board. Open Serial monitor to query the IP address
12in48-epaper-esp32-5.png
  • Open the Chrome browser, and enter the web with the IP address
12in48-epaper-esp32-html0.png
  • Select the display type, here we take 12.48inch e-Paper (two-color version) as example:
Click 12.48 e-Paper, and there are six functions provided. You can use them to draw points, lines and so on. On the top of the webpage, the type of e-Paper and display color are shown.
12in48-epaper-esp32-html1.png
  • The corresponding coordination of display is as below.
12in48-epaper-esp32-html2.png
  1. Draw points
    Click Draw point then you will get the window as below.
    12in48-epaper-esp32-html3.png
  2. Draw lines
    Click Draw Line, you will get the window as below
    12in48-epaper-esp32-html4.png
  3. Draw Rectangle
    Click Draw Rectangle, you will get the window as below
    12in48-epaper-esp32-html5.png
  4. Draw circle
    Click Draw Circle, you will get the window as below
    12in48-epaper-esp32-html6.png
  5. Draw String
    Click Draw String, you will get the windows as below
    12in48-epaper-esp32-html7.png
  6. Display picture
    Click Show picture, you will get the window like below. Click upload image to choose a picture.
    12in48-epaper-esp32-html8.png
    Draw the page to bottom to check the original picture.
    12in48-epaper-esp32-html9.png
    Select a process algorithm, for two-color display, only the mono methods work.
    12in48-epaper-esp32-html10.png
    12in48-epaper-esp32-html11.png
  7. Finally, click the upload image button on left to upload image to e-Paper for displaying.
    12in48-epaper-esp32-html12.png
You can open the Serial monitor of IDE to check the debug information
12in48-epaper-esp32-html13.png
You can also press F12 button to open the debug console of browser
12in48-epaper-esp32-html14.png

Resources

Document

Demo codes

Datasheet

FAQ

Question:
Working requirements of e-Paper?
Answer:
  • Two-color B/W e-paper
    • 【Working】Temperature: 0~50°C; Humidity: 35%~65%RH
    • 【Storage】Temperature: ≤30°C; Humidity: ≤55%RH; Max storage time: 6 months
    • 【Transport】Temperature: -25~70°C; Max transport time: 10 days
    • 【Unpack】Temperature: 20°C±5°C; Humidity: 50%RH±5%RH; Max storage time: Should be assembled in 72h
  • Three-Color e-Paper
    • 【Working】Temperature: 0~40°C; Humidity: 35%~65%RH
    • 【Storage】Temperature: ≤30°C; Humidity: ≤55%RH; Max storage time: 3 months
    • 【Transport】Temperature: -25~60°C; Max transport time: 10 days
    • 【Unpack】Temperature: 20°C±5°C; Humidity: 50%RH±5%RH; Max storage time: Should be assembled in 72h

When store three-color e-Paper, please refresh it to white, and keep the screen upward. Note that you need to update it at least every three months.


Question:
What do you need to note about e-Paper refreshing?
Answer:
  • Refresh mode
    • Full refresh: e-Paper flicker when full refreshing to remove ghost image for best display.
    • Partial refresh: It don't flicker if you use partial refresh (only some of the two-color e-paper support partial refresh). Note that you cannot use Partial refresh all the time, you should full refresh e-paper regularly, otherwise, ghost problem will get worse even damage.
  • Refresh rate
    • When using, you should set the update interval at least 180s.(except Partial supportable types)
    • Please set the e-Paper to sleep mode or power off it directly, otherwise, the e-Paper is damaged because of working in high voltage for long time.
    • You need to update the content of three-color e-Paper at least one time every 24h to avoid from burn-in problem.
  • Working place
  • We recommend you to use the e-Paper indoor. If you need to set the e-paper outdoor, Please place the e-paper in shadow and protect it from UV. When you designed you e-paper product, you should take care about the working situation like temperature, humidity, etc.


Question:
How much could the flexible e-paper be bended
Answer:
  • The IC part of e-Paper cannot be bended, you can bend the display area in degree larger than 60°C


Question:
Why the e-Paper cant work with Arduino?
Answer:

The I/O level of Arduino is 5V, and the e-Paper should be driven with 3V3. If your Arduino cant drive the e-Paper successfully, please try to convert the level to 3.3V

You can also try to connect the Vcc pin to the 5V of Arduino to see whether the e-Paper works, but we recommend you not to use 5V for a long time.


Question:
Why does the color of e-Paper look a little black or grey?
Answer:

You can try to change the value of Vcom on demo codes.


Question:
Three-color e-paper looks more red/yellow than the picture on website?
Answer:

Because of different batch, some of them have aberration. Store the e-Paper right side up will reduce it. And if the e-Paper didn't be refreshed for long time, it will become more and more red/yellow. Please use the demo code to refresh the e-paper for several times in this case.


Question:
Why my e-paper has ghosting problem after working for some days
Answer:

Please set the e-paper to sleep mode or disconnect it if you needn't refresh the e-paper but need to power on your development board or Raspberry Pi for long time.Otherwise, the voltage of panel keeps high and it will damage the panel



Question:
Why the FPC of the e-Paper is broken after using for some times?
Answer:
Please make sure you have used it in correct way.

E-Paper FAQ FPC.jpg



Supports

Mail.png Contact your seller (fast response and most recommended)

or send emails to [email protected] (not fast enough but please be patient) for help.

Our working time: 09:00-18:00 (UTC+8 Monday to Saturday)