From Waveshare Wiki
Jump to: navigation, search
 
(13 intermediate revisions by 3 users not shown)
Line 1: Line 1:
{{Infobox item
+
{{#tweekihide:firstHeading|sidebar-left|sidebar-right}}__NOTOC__
|name=2.9inch e-Paper (B)
 
|name2=2.9inch e-Paper Module (B)
 
|img=[[File:2.9inch-e-Paper-B-1.jpg|300px|{{Amazon_nolink|default={{#ifeq: {{#urlget:amazon|0}}|{{#urlget:Amazon|0}}| default|}}|url=link=https://www.waveshare.com/2.9inch-e-Paper-B.htm}}]]
 
|img2=[[File:2.9inch-e-paper-module-b-4.jpg|300px|{{Amazon_nolink|default={{#ifeq: {{#urlget:amazon|0}}|{{#urlget:Amazon|0}}| default|}}|url=link=http://www.waveshare.com/2.9inch-e-paper-module-b.htm}}]]
 
|caption=296x128, 2.9inch EPD panel
 
|caption2=296x128, 2.9inch EPD module, three-color, SPI interface
 
|category=[[:Category:OLEDs / LCDs|OLEDs / LCDs]], [[:Category:LCD|LCD]]
 
|brand=Waveshare
 
|{{#ifeq: {{#urlget:amazon|0}}|{{#urlget:Amazon|0}}| default|}}=display
 
|website_cn=[http://www.waveshare.net/shop/2.9inch-e-Paper-Module-B.htm 官方中文站点]
 
|website_en=[http://www.waveshare.com/2.9inch-e-paper-module-b.htm Waveshare website]
 
|interface1=SPI
 
|related=
 
{{Product List|OLEDs / LCDs/e-Paper}}
 
}}
 
<div class="tabber">
 
<div class="tabbertab" titile="Introduction">
 
=Overview=
 
==Versions==
 
<font backgound=white; color=#DD1223>
 
The 2.9inch e-Paper (B) raw panel was updated to the V3 version. The controller and the driver codes are different and the codes of the two versions are not compatible with each other. Except for the software, the outline of the two versions is the same. If you are the regulars of this display, please note that you need to update your driver codes with the new version refer to our new examples for the V3 version. if your the first time buy and use this display, just need to download and use the new V3 examples. The V2 version has a "V3" sticker on the backside of the display panel. Please confirm the version by the sticker.
 
</font>
 
  
==Introduction ==
+
<div style="background-color: #343434;text-align: center;color: white;padding: 20px;margin: 8px;">
{{E-Paper Raw Panel}}
+
=2.9inch e-Paper Module (B) Manual=
 +
</div>
 +
<p></p>
 +
{{ContentGrid|grid-gap=25px
 +
|content =
  
296x128, 2.9inch EPD (Electronic Paper Display) module, three-color, SPI interface
+
{{StudyCard
 +
|img=[[File:Start-test1.png|121px|link=https://www.waveshare.com/wiki/2.9inch_e-Paper_Module_(B)_Manual#Overview]]
 +
|heading = Introduction
 +
|content = Parameters, principles, and precautions
 +
}}
  
{{Amazon|{{#ifeq: {{#urlget:amazon|0}}|{{#urlget:Amazon|0}}| default|}}=display
+
{{StudyCard
|More = [http://www.waveshare.com/product/2.9inch-e-paper-module-b.htm More]}}
+
|img=[[File:Remote-access-test1.png|121px|link=https://www.waveshare.com/wiki/2.9inch_e-Paper_Module_(B)_Manual#Users_Guides_of_Raspberry_Pi]]
==Features==
+
|heading = Start with Raspberry Pi
*Dimension: 2.9inch
+
|content = Using BCM2835, WiringPi, file IO, RPI (Python) library development routines and instructions
*Outline Dimension (Raw panel): 79.0mm x 36.7mm x 1.15mm
+
}}
*Outline Dimension (Driver board): 89.5mm x 38mm
 
*Display Size: 89.5mm x 38mm
 
*Operating Voltage: 3.3V/5V
 
*Interface: SPI
 
*Dot Pitch: 0.227 x 0.226
 
*Resolution: 296x128
 
*Display Color: Black, White, Red
 
*Full Refresh Time: 15s
 
*Refresh Power: 30mW(Typ.)
 
*Standby Current: <0.01uA (almost none)
 
*Note:
 
1.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
 
  
2.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.
+
{{StudyCard
==SPI Communication Timing==
+
|img=[[File:Linux-test1.png|121px|link=https://www.waveshare.com/wiki/2.9inch_e-Paper_Module_(B)_Manual#User_Guides_of_Jetson_Nano]]
[[File:1.54inch-e-paper-manual-1.png|400px]]
+
|heading = Start with the Jetson Nano
 +
|content = Use C language, Python developed routines and instructions
 +
}}
  
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.
+
{{StudyCard
*CS: Slave chip select, when CS is low, the chip is enabled
+
|img=[[File:Config-test1.png|121px|link=https://www.waveshare.com/wiki/2.9inch_e-Paper_Module_(B)_Manual#User_Guides_of_STM32]]
*DC: data/command control pin, write command when DC=0; write data when DC=1
+
|heading = Starting from the STM32
*SCLK: SPI communication clock
+
|content = Use STM32CubeMX to develop routines based on STM32F103ZET6 and their usage instructions
*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 />
+
{{StudyCard
[[file:e-paper_hardware_work_2.png]]<br />
+
|img=[[File:Tinker Board 2硬件-test1.png|121px|link=https://www.waveshare.com/wiki/2.9inch_e-Paper_Module_(B)_Manual#User_Guides_of_Arduino]]
So we can use two bytes for 16 pixels.<br />
+
|heading = Starting from the Arduino
 +
|content = Routines developed based on Arduino UNO R3 and their usage instructions
 +
}}
  
*For the 2.13inch e-paper B, it is red and black, we need to split the picture into 2 pictures, one black and white picture, one red and white picture, because one register controls the black and white display during transmission, and the other register is the control red and white
+
{{StudyCard
show. 1 byte of 2.13 black and white part controls 8 pixels, and 1 byte of red and white part controls 8 pixels
+
|img=[[File:Linux-test1.png|121px|link=https://www.waveshare.com/wiki/2.9inch_e-Paper_Module_(B)_Manual#Resources]]
For example, suppose there are 8 pixels, the first 4 are red, and the last 4 are black:
+
|heading = Resources
They need to be split into a black and white picture and a red and white picture. Both pictures have 8 pixels, but the first four pixels of the black and white picture are white, the last 4 pixels are black, and the first 4 pixels of the red and white picture are black. pixels are red, the last four pixels are white<br />
+
|content = Documentation, procedures and data sheets, etc
[[file:02.png]]<br />
+
}}
If we specify that white is stored as 1 and red or black is stored as 0, then we have the following representation:<br />
 
[[file:03.png]]<br />
 
  
And 1 byte of black and white part controls 8 pixels, and 1 byte of red and white part controls 8 pixels, then it can be expressed as follows:<br />
+
{{StudyCard
[[file:111.png]]<br />
+
|img=[[File:显示屏-test1.png|121px|link=https://www.waveshare.com/wiki/2.9inch_e-Paper_Module_(B)_Manual#FAQ]]
==Precautions==
+
|heading = FAQ
#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/>
+
|content = e-Paper frequently asked questions
#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 routine, 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/>
 
  
 +
{{StudyCard
 +
|img=[[File:数据表-test1.png|121px|link=https://www.waveshare.com/wiki/2.9inch_e-Paper_Module_(B)_Manual#Support]]
 +
|heading = Support
 +
|content = Technical support
 +
}}
  
{{Raspberry Pi Guides for SPI e-Paper}}
+
}}
</div>
 
<div class="tabbertab" title="User Guides of Jetson Nano">
 
{{Jetson Nano Guides for SPI e-Paper}}
 
</div>
 
<div class="tabbertab" title="User Guides of STM32">
 
{{STM32 Guides for SPI e-Paper}}
 
</div>
 
<div class="tabbertab" title="User Guides of Arduino">
 
{{Arduino Guides for SPI e-Paper}}
 
</div>
 
<div class="tabbertab" title="User Guides of ESP32">
 
{{ESP32 Guides for SPI e-Paper}}
 
</div>
 
<div class="tabbertab" title="User Guides of ESP8266">
 
{{ESP8266 Guides for SPI e-Paper}}
 
</div>
 
<!--
 
=== 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,
 
* 1 byte = 8 pixels, doesn’t support Gray scale (Can only display black and white). A bit set stands for a white pixel, otherwise a bit reset stands for black/red.
 
 
 
For example:
 
<pre>
 
0xC3:8 pixels □□■■■■□□
 
0x00:8 pixels ■■■■■■■■
 
0xFF:8 pixels □□□□□□□□
 
0x66:8 pixels ■□□■■□□■
 
</pre>
 
* 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 15s). Please be patient.
 
-->
 
<div class="tabbertab" title="Resources">
 
=Resources=
 
 
 
==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}}
 
* [[:File:2.9inch_e-Paper_Schematic.pdf|Schematic]]
 
 
 
==Demo code==
 
*[https://github.com/waveshare/e-Paper Github]
 
 
 
==Datasheets==
 
* [[:File:2.9inch-e-paper-b-specification.pdf|Datasheets]]
 
*[https://www.waveshare.com/w/upload/a/af/2.9inch-e-paper-b-v3-specification.pdf 2.9inch e-Paper B V3 Specification]
 
 
 
=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]
 
</div>
 
<div class="tabbertab" title="FAQ">
 
== FAQ ==
 
<!--{{e-Paper FAQ}}-->
 
{{e-Paper FAQ}}
 
</div>
 
</div>
 
==Support==
 
{{Service00}}
 

Latest revision as of 09:58, 21 July 2022


2.9inch e-Paper Module (B) Manual

Start-test1.png

Introduction

Parameters, principles, and precautions
Remote-access-test1.png

Start with Raspberry Pi

Using BCM2835, WiringPi, file IO, RPI (Python) library development routines and instructions
Linux-test1.png

Start with the Jetson Nano

Use C language, Python developed routines and instructions
Config-test1.png

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
Linux-test1.png

Resources

Documentation, procedures and data sheets, etc
显示屏-test1.png

FAQ

e-Paper frequently asked questions
数据表-test1.png

Support

Technical support