Difference between revisions of "1.54inch e-Paper Module (B)"

From Waveshare Wiki
Jump to: navigation, search
(11 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{Infobox item|colorscheme=blue
+
{{Infobox item
|brief=200x200, 1.54inch E-Ink display module, three-color, SPI interface
+
|name=1.54inch e-Paper (B)
|img=[[File:1.54inch-e-paper-module-b-4.jpg|300px|link=http://www.waveshare.com/1.54inch-e-paper-module-b.htm]]
+
|name2=1.54inch e-Paper Module (B)
|caption=200x200, 1.54inch E-Ink display module, three-color, SPI interface
+
|img=[[File:1.54inch-e-Paper-B-1.jpg|300px|link=https://www.waveshare.com/1.54inch-e-Paper-B.htm]]
 +
|img2=[[File:1.54inch-e-paper-module-b-4.jpg|300px|link=http://www.waveshare.com/1.54inch-e-paper-module-b.htm]]
 +
|caption=200x200, 1.54inch E-Ink display raw panel without driver board.
 +
|caption2=200x200, 1.54inch E-Ink display module, three-color, SPI interface
 
|category=[[:Category:OLEDs / LCDs|OLEDs / LCDs]], [[:Category:LCD|LCD]]
 
|category=[[:Category:OLEDs / LCDs|OLEDs / LCDs]], [[:Category:LCD|LCD]]
 
|brand=Waveshare
 
|brand=Waveshare
Line 13: Line 16:
 
}}
 
}}
 
== Introduction ==
 
== Introduction ==
 +
{{e-Paper Raw Panel}}
 +
 
200x200, 1.54inch E-Ink display module, three-color, SPI interface
 
200x200, 1.54inch E-Ink display module, three-color, SPI interface
  
 
{{Amazon|{{#urlget:amazon|default}}=display
 
{{Amazon|{{#urlget:amazon|default}}=display
 
|More = [http://www.waveshare.com/product/1.54inch-e-Paper-Module-B.htm More]}}
 
|More = [http://www.waveshare.com/product/1.54inch-e-Paper-Module-B.htm More]}}
 +
<!--
 
== Interfaces ==
 
== Interfaces ==
 
{|class="wikitable"
 
{|class="wikitable"
Line 74: Line 80:
 
| CS || CE0
 
| CS || CE0
 
|-
 
|-
| DC || 25 (BCM)
+
| DC || Pin22/GPIO25
 
|-
 
|-
| RST || 17 (BCM)
+
| RST || Pin11/GPIO17
 
|-
 
|-
| BUSY || 24 (BCM)
+
| BUSY || Pin18/GPIO24
 
|}
 
|}
  
Line 92: Line 98:
 
{|class="wikitable"
 
{|class="wikitable"
 
|-
 
|-
! e-Paper !! Arduino
+
! e-Paper !! UNO PLUS (3.3V)
 
|-
 
|-
 
| 3.3V || 3V3
 
| 3.3V || 3V3
Line 110: Line 116:
 
| BUSY || D7
 
| BUSY || D7
 
|}
 
|}
 +
 
==== Expected result ====
 
==== Expected result ====
# Copy the libraries file of Arduino demo code to the libraries folder which is under the installation directory of Arduino IDE, it usually is C:\users\username\documents\arduino\libraries. You can also designate the location on Arduino IDE--> File -->Preferences -->Sketchbook location
+
# Copy the libraries file of Arduino demo code to the libraries folder which is under the installation directory of Arduino IDE, it usually is C:\users\username\documents\arduino\libraries. You can also designate the location on Arduino IDE-> File ->Preferences ->Sketchbook location
 
# Upload the project.
 
# Upload the project.
 
# E-paper will display the image.
 
# E-paper will display the image.
Line 162: Line 169:
  
 
=== Initialization (Init) ===
 
=== Initialization (Init) ===
After powering on the module, initialization function (Init) will configure the parameters of module. It can also wake up module from sleep mode. Process of initialization: reset --> power setting --> booster soft start --> power on --> panel setting --> VCOM and data interval setting --> PLL control --> resolution setting --> VCM DC setting --> look-up table setting.
+
After powering on the module, initialization function (Init) will configure the parameters of module. It can also wake up module from sleep mode. Process of initialization: reset -> power setting -> booster soft start -> power on -> panel setting -> VCOM and data interval setting -> PLL control -> resolution setting -> VCM DC setting -> look-up table setting.
  
 
For detailed explanation of commands, please refer to [[File:1.54inch-e-paper-b-specification.pdf]]
 
For detailed explanation of commands, please refer to [[File:1.54inch-e-paper-b-specification.pdf]]
 
=== Configuration of LUT table(SetLutBw and SetLutRed) ===
 
=== Configuration of LUT table(SetLutBw and SetLutRed) ===
 
Look-up table is stored in the module, which is provided by us. So the table may be different among different batches. If the table changed, we will update the demo code as soon as possible.  
 
Look-up table is stored in the module, which is provided by us. So the table may be different among different batches. If the table changed, we will update the demo code as soon as possible.  
 +
-->
 +
 
=== Display a Frame (DisplayFrame) ===
 
=== Display a Frame (DisplayFrame) ===
 
DisplayFrame is used to send a frame to module, and the screen will refresh and display it.
 
DisplayFrame is used to send a frame to module, and the screen will refresh and display it.
  
Process: Send command data start transmission 1 --> Send data of dark area --> Send command data start transmission 2 --> Send data of red area --> Refresh the screen.
+
Process: Send command data start transmission 1 -> Send data of dark area -> Send command data start transmission 2 -> Send data of red area -> Refresh the screen.
 
Note:
 
Note:
 
* One frame consist of images of black area and red area, so we need to send two images for displaying one frame,
 
* One frame consist of images of black area and red area, so we need to send two images for displaying one frame,
Line 193: Line 202:
 
* This module doesn’t support partial refresh.
 
* This module doesn’t support partial refresh.
 
* The refresh rate of this module is slow, and it will flicker for several times during refreshing (about 8s). Please be patient.
 
* The refresh rate of this module is slow, and it will flicker for several times during refreshing (about 8s). Please be patient.
 
+
<!--
 
=== Sleep mode (Sleep) ===
 
=== Sleep mode (Sleep) ===
 
Sleep can make the module go into sleep mode to reduce the consumption.
 
Sleep can make the module go into sleep mode to reduce the consumption.
  
Process:VCOM and data interval setting --> VCM DC setting --> power setting --> power off
+
Process:VCOM and data interval setting -> VCM DC setting -> power setting -> power off
  
 
If you want to wake up the module from sleep mode, you need to give a LOW pulse to RST pin. Then maybe you need to reconfigure the parameter of power (According to the batches, some of them need to reconfigure, some needn’t). So if you want to wake up module, you had better use the Init function instead of Reset. Reset function and relative commands will be executed while executing the Init function.
 
If you want to wake up the module from sleep mode, you need to give a LOW pulse to RST pin. Then maybe you need to reconfigure the parameter of power (According to the batches, some of them need to reconfigure, some needn’t). So if you want to wake up module, you had better use the Init function instead of Reset. Reset function and relative commands will be executed while executing the Init function.
Line 208: Line 217:
  
 
# Open a picture with drawing tool comes with Windows system, create a new image, and set the pixel to 200x200.
 
# Open a picture with drawing tool comes with Windows system, create a new image, and set the pixel to 200x200.
# Because this module can only display two gray level (Only black and white), we need to convert picture to monochrome bitmap before converting it to array. That is, File --> BMP picture --> Monochrome Bitmap.
+
# Because this module can only display two gray level (Only black and white), we need to convert picture to monochrome bitmap before converting it to array. That is, File -> BMP picture -> Monochrome Bitmap.
 
#: There are two monochrome bitmap on examples pack, which are used for demonstration (raspberrypi/python/black.bmp and raspberrypi/python/red.bmp).
 
#: There are two monochrome bitmap on examples pack, which are used for demonstration (raspberrypi/python/black.bmp and raspberrypi/python/red.bmp).
 
# Use [[:File:Image2Lcd.7z|Image2Lcd.exe]] software to generate corresponding array for picture (.c file). Open picture with this software, set the parameters:
 
# Use [[:File:Image2Lcd.7z|Image2Lcd.exe]] software to generate corresponding array for picture (.c file). Open picture with this software, set the parameters:
Line 218: Line 227:
 
#* Inverse color: Check (Check: the white on image will be inversed to 1, and black is inversed to 0)
 
#* Inverse color: Check (Check: the white on image will be inversed to 1, and black is inversed to 0)
 
# Click “Save”, to generate .c file. Copy the corresponding array into your project, and you can display picture by calling this array.
 
# Click “Save”, to generate .c file. Copy the corresponding array into your project, and you can display picture by calling this array.
 +
-->
  
 
== Resources ==
 
== Resources ==
 
=== Documentation ===
 
=== Documentation ===
* [[:File:1.54inch_e-Paper_module_b_Schematic.pdf|Schematic]]
+
*[https://www.waveshare.com/w/upload/f/fe/1.54inch-e-paper-module-b-user-manual-en.pdf User Manual]
 +
{{Commom Instruction of SPI e-paper}}
 +
* [[:File:1.54inch_e-Paper_Schematic.pdf|Schematic]]
 +
 
 
=== Demo code ===
 
=== Demo code ===
 
* [[:File:1.54inch_e-paper_module_b_code.7z|Demo code]]
 
* [[:File:1.54inch_e-paper_module_b_code.7z|Demo code]]
 +
*[https://github.com/waveshare/e-Paper Github]
 +
 
=== Datasheets ===
 
=== Datasheets ===
 
* [[:File:1.54inch-e-paper-b-specification.pdf|Datasheets]]
 
* [[:File:1.54inch-e-paper-b-specification.pdf|Datasheets]]
 +
===Software===
 +
*[[:File:Image2Lcd.7z|Image2Lcd.7z]]
 +
===Related Resources===
 +
This is a post in Arduino Form about our SPI e-Paper thanks to ZinggJM, maybe you want to refer to.
 +
*[https://forum.arduino.cc/index.php?topic=487007.0 Waveshare e-Paper display with SPI]
 +
 
== FAQ ==
 
== FAQ ==
 
<!--{{e-Paper FAQ}}-->
 
<!--{{e-Paper FAQ}}-->

Revision as of 02:12, 26 March 2019

1.54inch e-Paper (B)
1.54inch-e-Paper-B-1.jpg

200x200, 1.54inch E-Ink display raw panel without driver board.
1.54inch e-Paper Module (B)
1.54inch-e-paper-module-b-4.jpg

200x200, 1.54inch E-Ink display module, three-color, SPI interface
{{{name3}}}

{{{name4}}}

{{{name5}}}

Introduction

Note: As the raw panel requires a driver board, we recommend you to buy the HAT or buy a driver board for use, or you need to make the driver board by yourself. And this instruction is based on the version with PCB or driver board.

200x200, 1.54inch E-Ink display module, three-color, SPI interface

More

Display a Frame (DisplayFrame)

DisplayFrame is used to send a frame to module, and the screen will refresh and display it.

Process: Send command data start transmission 1 -> Send data of dark area -> Send command data start transmission 2 -> Send data of red area -> Refresh the screen. Note:

  • One frame consist of images of black area and red area, so we need to send two images for displaying one frame,
  • The image of black part: 2 bits = 1 pixel, doesn’t support Gray scale (Can only display black and white). 00b stand for black pixel, and 11b stand for white.

For example:

0xC3:4 pixels □■■□
0x00:4 pixels ■■■■
0xFF:4 pixels □□□□
0x66:The state of pixels is uncertain
  • The image of red area: 1 bit = 1 pixel, doesn’t support Gray scale (Can only display red and white). The pixel is white if Bit is set, and it is red on the contrary.

For example:

0xC3:8 pixels □□■■■■□□
0x00:8 pixels ■■■■■■■■
0xFF:8 pixels □□□□□□□□
0x66:8 pixels ■□□■■□□■
  • This module doesn’t support partial refresh.
  • The refresh rate of this module is slow, and it will flicker for several times during refreshing (about 8s). Please be patient.

Resources

Documentation

Demo code

Datasheets

Software

Related Resources

This is a post in Arduino Form about our SPI e-Paper thanks to ZinggJM, maybe you want to refer to.

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.


Support

Support

If you require technical support, please go to the Support page and open a ticket.