Difference between revisions of "12.48inch e-Paper Module"

From Waveshare Wiki
Jump to: navigation, search
Line 115: Line 115:
 
{{12.48e-Paper-connecting-settings}}
 
{{12.48e-Paper-connecting-settings}}
  
==Resources==
+
=Resources=
 
===Document===
 
===Document===
 
*[https://www.waveshare.com/w/upload/0/00/12.48inch_e-Paper_Module_SchDoc.pdf Schematic]<br>
 
*[https://www.waveshare.com/w/upload/0/00/12.48inch_e-Paper_Module_SchDoc.pdf Schematic]<br>

Revision as of 02:21, 18 May 2022

12.48inch e-Paper
12.48inch-e-paper-4.jpg
12.48inch e-Paper Module
12.48inch e-Paper-Module-1.jpg
{{{name3}}}

{{{name4}}}

{{{name5}}}

Introduction

Feature

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

【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 Communication Timing

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

Since the ink screen only needs to be displayed, the data cable (MISO) sent from the machine and received by the host is hidden here.

  • CS: Slave chip select, when CS is low, the chip is enabled
  • DC: data/command control pin, write command when DC=0; write data when DC=1
  • SCLK: SPI communication clock
  • SDIN: SPI communication master sends, slave receives
  • Timing: CPHL=0, CPOL=0 (SPI0)

[Remarks] For specific information about SPI, you can search for information online.

How 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.

Preface

How to Install

Since it was assembled by us when you got the product, it has a bottom plate, you need to take the screwdriver delivered to unscrew the screws on the back and put it into the main control.

  • The Raspberry Pi, Arduino UNO, and ESP32 directly provide interface connections, and the specific control pins are introduced in the following sections.
  • For STM32, the demo is based on the STM32F103ZET6 chip, which was tested using our Open103Z, and connected using the pin headers of the board.

Software Description

Raspberry Pi Programs

We provide two program drivers, C and Python
It takes about 8S to brush a frame of a picture in C language, and about 10S in python. In addition to the basic brushing effect, python also adds the ability to crawl the weather:

Arduino UNO

We provide a C program, and the .c suffix is ​​changed to .cpp to be compatible with CPP.
Because the RAM of UNO is too small, 3 23LC1024 chips are used onboard to expand the memory of UNO. You need to build a picture of the whole picture and initialize it. For black and white pictures, you need 1304/8*984=160392 pieces Bytes, and a 23LC1024 can only have a maximum size of 128K. For black and white red, it needs 160392*2 = 320784 bytes, so 3 chips are needed, so the display speed of the whole frame picture is very slow, about 1 minute. to display a black and white image.

  • The jumper cap needs to be connected to 5V.

STM32

We provide a C program

  • Since STM32F103ZET6 has no interface for direct use, it needs to be connected with the delivered Dupont cable. For the specific connection method, please refer to the pin connection diagram below. There are only some examples here, because the STM32F103ZET6 cannot establish a complete image cache, only part of the screen routines.

ESP32

We provide a C program for the Arduino test program and an example that can be controlled using the web page

  • Arduino: It can be used according to the corresponding ESP32 chapters. ESP32 cannot create a 1304/8*984 cache, so it is refreshed in a different way, 4304/8*492 data is transmitted at one time, and black and white needs to be transmitted twice. Black and white red transmission 4 times. The refresh speed of black and white is about 8S, and the refresh speed of black and white is about 16S.
  • Web page control: Due to my limited skills, I develop web pages while learning the front-end. There may be some bugs in web page control, and you may not be able to complain, but the function can be completed in the end. The IP address will be displayed on the serial port. Under the same wifi, you can use the web page to open the IP address to control it, which will be described in detail in the subsequent chapters.

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.68.tar.gz
tar zxvf bcm2835-1.71.tar.gz 
cd bcm2835-1.71/
sudo ./configure && sudo make && sudo make check && sudo make install
  • Install wiringPi
#Open the Raspberry Pi terminal and run the following command
sudo apt-get install wiringpi
#For Raspberry Pi systems after May 2019 (earlier than before, you may not need to execute), you may need to upgrade:
wget https://project-downloads.drogon.net/wiringpi-latest.deb
sudo dpkg -i wiringpi-latest.deb
gpio -v
# Run gpio -v and version 2.52 will appear. If it does not appear, the installation is wrong

#Bullseye branch system use the following command:
git clone https://github.com/WiringPi/WiringPi
cd WiringPi
./build
gpio -v
# Run gpio -v and version 2.60 will appear. If it does not appear, it means that there is an installation error
  • 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

12in48-epaper-rpi-c1.png
  • 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
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
12in48-epaper-rpi-weather1.jpg
12in48-epaper-rpi-weather2.jpg
For two-color version
sudo python epd_12in48_test.py
For three-color version
sudo python epd_12in48B_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

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

If you are using a black and white screen, select epd12in48-demo on the right
If you are using a black and white red screen, select epd12in48b-demo on the right
Finally, select the corresponding COM port, and then click Compile and Download.

  • Note that the refresh process may take a long time. You can open the serial monitor to check the progress. Generally, it takes 1 minute for black and white, and 2 minutes for black and white.

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

Third-Party examples

It is a "ESP-IDF component", you can drive the e-Paper with GFX and Fonts.

FAQ

 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.


Supports