From Waveshare Wiki
Jump to: navigation, search
(8 intermediate revisions by 2 users not shown)
Line 1: Line 1:
<div id="saveAsPdfBtn">[ Save as PDF]</div>
<div class="wiki-pages jet-green-color">
{{Infobox item
|name=1.54inch e-Paper
|name2=1.54inch e-Paper Module
|img=[[File:1.54inch1.png|300px|{{Amazon_nolink|default={{#ifeq: {{#urlget:amazon|0}}|{{#urlget:Amazon|0}}| default|}}|url=link=}}]]
|img2=[[File:1.54inch.png|300px|{{Amazon_nolink|default={{#ifeq: {{#urlget:amazon|0}}|{{#urlget:Amazon|0}}| default|}}|url=link=}}]]
|caption=200x200, 1.54inch EPD panel without driver board.
|caption2=200x200, 1.54inch EPD module, Black/White, SPI interface
|category=[[:Category:OLEDs / LCDs|OLEDs / LCDs]], [[:Category:LCD|LCD]]
|{{#ifeq: {{#urlget:amazon|0}}|{{#urlget:Amazon|0}}| default|}}=display
|website_cn=[ 官方中文站点]
|website_en=[ Waveshare website]
{{Product List|OLEDs / LCDs/e-Paper}}
<div class="tabber">
<div class="tabbertab" title="Introduction">
<font backgound=white; color=#DD1223>
'''Due to the chip upgrade, the 1.54inch e-Paper will be upgraded to v2, its old and new programs are not compatible, but their appearances and functions are compatible. If you are an old customer and need to purchase a new screen again, pay attention to the update procedure. If you purchase it for the first time, you can simply use the new version of the program. The new version of the screen has a v2 suffix on the label. Please note the distinction'''<br>
*Dimension: 1.54inch
*Outline dimension (only screen): 37.32mm x 31.8mm x 1.05mm
*Outline dimension (driver board): 48mm x 33mm
* Display dimension: 27.6mm x 27.6mm
*Working voltage: 3.3V/5V
*Communication interfaces: SPI
*Pixel pitch: 0.194 * 0.194
*Resolution: 200*200
*Display color: Black, White
*Gray level: 2
*Partial refresh: 0.3s
*Full refresh: 2s
*Refresh Power Consumption: 26.4mW(typ.)
*Sleep current: <0.01uA(close to0)
** Refresh time: The refresh time is the experimental results, the actual refresh time will have errors, and the actual effect shall prevail. There will be a flickering effect during the global refresh process, this is a normal phenomenon<br />
** Power consumption: The power consumption data is the experimental results. The actual power consumption will have a certain error due to the existence of the driver board and the actual use situation. The actual effect shall prevail.
==SPI Communication Timing==
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.<big>
==Working principle==
This product is an E-paper device adopting the image display technology of Microencapsulated Electrophoretic Display, MED. The initial approach is to create tiny spheres, in which the charged color pigments are suspended in the transparent oil and would move depending on the electronic charge. The E-paper screen display patterns by reflecting the ambient light, so it has no background light requirement. Under ambient light, the E-paper screen still has high visibility with a wide viewing angle of 180 degrees. It is the ideal choice for E-reading. ('''Note that the e-Paper cannot support updating directly under sunlight''')
===Pixel & Byte===
We define the pixels in a monochrome picture, 0 is black and 1 is white.<br />
White:□: Bit 1<br />
Black:■: Bit 0<br />
*The dot in the figure is called a pixel. As we know, 1 and 0 are used to define the color, therefore we can use one bit to define the color of one pixel, and 1 byte = 8pixels<br />
*For example, If we set the first 8 pixels to black and the last 8 pixels to white, we show it by codes, they will be 16 bit as below:<br />
[[file:e-paper_hardware_work_1.png]]<br />
For computer, the data is saved in MSB format:<br />
[[file:e-paper_hardware_work_2.png]]<br />
So we can use two bytes for 16 pixels.<br />
#For the screen that supports partial update, please note that you cannot refresh the screen with the partial mode all the time. After several partial updating, you need to fully refresh the screen once. Otherwise, the screen display effect will be abnormal, which cannot be repaired!<br/>
#Because of the different batches, some of them have aberrations. Store the e-Paper right side up will reduce it. And if the e-Paper didn't be refreshed for a long time, it will become more and more reddish/yellowish. Please use the demo code to refresh the e-paper several times in this case.<br/>
#Note that the screen cannot be powered on for a long time. When the screen is not refreshed, please set the screen to sleep mode, or power off the e-Paper. Otherwise, the screen will remain in a high voltage state for a long time, which will damage the e-Paper and cannot be repaired!<br/>
#When using the e-Paper, it is recommended that the refresh interval be at least 180s, and refresh at least once every 24 hours. If the e-Paper is not used for a long time, the ink screen should be brushed and stored. (Refer to the datasheet for specific storage environment requirements)<br/>
#After the screen enters sleep mode, the sent image data will be ignored, and it can be refreshed normally only after initializing again.<br/>
#Control the 0x3C or 0x50 (refer to the datasheet for details) register to adjust the border color. In the demo, you can adjust the Border Waveform Control register or VCOM AND DATA INTERVAL SETTING to set the border.<br/>
#If you find that the created image data is displayed incorrectly on the screen, it is recommended to check whether the image size setting is correct, change the width and height settings of the image and try again.<br/>
#The working voltage of the e-Paper is 3.3V. If you buy the raw panel and you need to add a level convert circuit for compatibility with 5V voltage. The new version of the driver board (V2.1 and subsequent versions) has added a level processing circuit, which can support both 3.3V and 5V working environments. The old version can only support a 3.3V working environment. You can confirm the version before using it. (The one with the 20-pin chip on the PCB is generally the new version)<br/>
#The FPC cable of the screen is relatively fragile, pay attention to bending the cable along the horizontal direction of the screen when using it, and do not bend the cable along the vertical direction of the screen<br/>
#The screen of e-Paper is relatively fragile, please try to avoid dropping, bumping, and pressing hard.<br/>
#We recommend that customers use the sample program provided by us to test with the corresponding development board after they get the screen.<br/>
<div class="tabbertab" title="User Guides of Pi">
<div style="background-color: #343434;text-align: center;color: white;padding: 20px;margin: 8px;">
We provide several examples for testing, you first test the e-Paper by following the guides. If your developing board is different, you need to write your codes yourself by following the resources.
=1.54inch e-Paper Module Manual=
{{Raspberry Pi Guides for SPI e-Paper}}
|content =
<div class="tabbertab" title="User Guides of Jetson Nano">
{{Jetson Nano Guides for SPI e-Paper}}
|heading = Introduction
|content = Parameters, principles, and precautions
<div class="tabbertab" title="User Guides of STM32">
{{STM32 Guides for SPI e-Paper}}
|heading = Start with Raspberry Pi
|content = Using BCM2835, WiringPi, file IO, RPI (Python) library development routines and instructions
<div class="tabbertab" title="User Guides of Arduino">
{{Arduino Guides for SPI e-Paper}}
|heading = Start with the Jetson Nano
|content = Use C language, Python developed routines and instructions
<div class="tabbertab" title="User Guides of ESP32">
{{ESP32 Guides for SPI e-Paper}}
|heading = Starting from the STM32
|content = Use STM32CubeMX to develop routines based on STM32F103ZET6 and their usage instructions
<div class="tabbertab" title="User Guides of ESP8266">
{{ESP8266 Guides for SPI e-Paper}}
|img=[[File:Tinker Board 2硬件-test1.png|121px|link=]]
|heading = Starting from the Arduino
|content = Routines developed based on Arduino UNO R3 and their usage instructions
=== Display a Frame (DisplayFrame) ===
DisplayFrame is used to send a frame to the module, and the screen will refresh and display it.
|heading = Resources
|content = Documentation, procedures and data sheets, etc
Process: Send command data start transmission 1 -> Send data of an image to display -> Refresh the screen.
|heading = FAQ
|content = e-Paper frequently asked questions
* About the image data: 4 bits = 1 pixel, doesn’t support Gray scale (can only display black and white). 0000 (binary) stands for a black pixel, otherwise 0011 (binary) stands for a white pixel.
|heading = Support
|content = Technical support
For example:
0x00: 2 pixels ■■
0x03: 2 pixels ■□
0x30: 2 pixels □■
0x33: 2 pixels □□
but 0x66: the state of pixels is uncertain
* This module doesn’t support partial refresh.
* The refresh rate of this module is slow (about 6s), and it will flicker for several times during refreshing. Please be patient.
<div class="tabbertab" title="Resources">
{{Commom Instruction of SPI e-paper}}
* [[:File:E-Paper-Driver-HAT-Schematic.pdf|Schematic]]
==Demo code==
*[ Github]
* [https://{{SERVERNAME}}/w/upload/7/77/1.54inch_e-Paper_Datasheet.pdf 1.54inch e-Paper Datasheet](V1)
* [https://{{SERVERNAME}}/w/upload/e/e5/1.54inch_e-paper_V2_Datasheet.pdf 1.54inch e-Paper Datasheet](current version)
==Related Resources==
Notice:<br />
The projects listed are all made and shared by the project owners, Waveshare isn't responsible for project either the update.<br />
*[ Waveshare e-Paper display with SPI]
:This is a post in Arduino Form about our SPI e-Paper thanks to ZinggJM, maybe you want to refer to.
*[ Inkycal Project]
:This is the Inkycal project for reference.
*[ Task List using Raspberry Pi 3 and 7.5" E-paper Display]
*[ E-Paper Calendar with iCal sync and live weather ]
<div class="tabbertab" title="FAQ">
{{e-paper Hat FAQ}}

Latest revision as of 09:07, 21 July 2022

1.54inch e-Paper Module Manual



Parameters, principles, and precautions

Start with Raspberry Pi

Using BCM2835, WiringPi, file IO, RPI (Python) library development routines and instructions

Start with the Jetson Nano

Use C language, Python developed routines and instructions

Starting from the STM32

Use STM32CubeMX to develop routines based on STM32F103ZET6 and their usage instructions
Tinker Board 2硬件-test1.png

Starting from the Arduino

Routines developed based on Arduino UNO R3 and their usage instructions


Documentation, procedures and data sheets, etc


e-Paper frequently asked questions


Technical support