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

From Waveshare Wiki
Jump to: navigation, search
(Documentation)
(Demo code)
(3 intermediate revisions by 2 users not shown)
Line 22: Line 22:
 
{{Amazon|{{#urlget:amazon|default}}=display
 
{{Amazon|{{#urlget:amazon|default}}=display
 
|More = [http://www.waveshare.com/product/2.9inch-e-paper-module-b.htm More]}}
 
|More = [http://www.waveshare.com/product/2.9inch-e-paper-module-b.htm More]}}
 +
<!--
 
== Interfaces ==
 
== Interfaces ==
 
{|class="wikitable"
 
{|class="wikitable"
Line 117: Line 118:
  
 
==== 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 167: Line 168:
  
 
=== 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 --> booster soft start --> power on --> panel setting --> VCOM and data interval setting --> resolution setting --> VCM DC 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 -> booster soft start -> power on -> panel setting -> VCOM and data interval setting -> resolution setting -> VCM DC setting.
  
 
For detailed explanation of commands, please refer to [[File:2.9inch-e-paper-b-specification.pdf]]
 
For detailed explanation of commands, please refer to [[File:2.9inch-e-paper-b-specification.pdf]]
Line 173: Line 174:
 
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 190: Line 191:
 
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: VCM DC setting --> power setting --> power off
+
Process: 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 201: Line 202:
  
 
# Open a picture with drawing tool comes with Windows system, create a new image, and set the pixel to 128x296.
 
# Open a picture with drawing tool comes with Windows system, create a new image, and set the pixel to 128x296.
# 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 211: Line 212:
 
#* 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 ===
 +
*[https://www.waveshare.com/w/upload/5/55/2.9inch-e-paper-module-b-user-manual-en.pdf User Manual]
 
{{Commom Instruction of SPI e-paper}}
 
{{Commom Instruction of SPI e-paper}}
* [[:File:2.9inch_e-Paper_module_b_Schematic.pdf|Schematic]]
+
* [[:File:2.9inch_e-Paper_Schematic.pdf|Schematic]]
  
 
=== Demo code ===
 
=== Demo code ===
 
* [[:File:2.9inch_e-paper_module_b_code.7z|Demo code]]
 
* [[:File:2.9inch_e-paper_module_b_code.7z|Demo code]]
 +
*[https://github.com/waveshare/e-Paper Github]
 +
 
=== Datasheets ===
 
=== Datasheets ===
 
* [[:File:2.9inch-e-paper-b-specification.pdf|Datasheets]]
 
* [[:File:2.9inch-e-paper-b-specification.pdf|Datasheets]]
 +
===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:14, 26 March 2019

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

296x128, 2.9inch E-Ink display raw panel
2.9inch e-Paper Module (B)
2.9inch-e-paper-module-b-4.jpg

296x128, 2.9inch E-Ink display module, three-color, SPI interface
{{{name3}}}

{{{name4}}}

{{{name5}}}

Primary Attribute
Category: OLEDs / LCDs, LCD
{{{userDefinedInfo}}}: {{{userdefinedvalue}}}
Brand: Waveshare
Website
English: Waveshare website
Chinese: 官方中文站点
Onboard Interfaces
SPI
Related Products

Introduction

Note: The raw panel require a driver board, If you are the first time use this e-Paper, we recommend you to buy the HAT version or buy more one driver hat for easy use, otherwise you need to make the driver board yourself. And this instruction is based on the version with PCB or driver board.

296x128, 2.9inch E-Ink display module, three-color, SPI interface

More

Resources

Documentation

Demo code

Datasheets

Related Resources

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

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



Support

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)