add arduino code

1.54inch_e-paper_b_code/RaspberryPi/python3/epd1in54b.py

@@ -0,0 +1,310 @@
+# /*****************************************************************************
+# * | File        :	  EPD_1in54.py
+# * | Author      :   Waveshare team
+# * | Function    :   Electronic paper driver
+# * | Info        :
+# *----------------
+# * |	This version:   V3.0
+# * | Date        :   2018-11-05
+# * | Info        :   python2 demo
+# * 1.Remove:
+#   digital_write(self, pin, value)
+#   digital_read(self, pin)
+#   delay_ms(self, delaytime)
+#   set_rotate(self, rotate)
+#   set_pixel(self, frame_buffer, x, y, colored)
+#   set_absolute_pixel(self, frame_buffer, x, y, colored)
+#   display_string_at(self, frame_buffer, x, y, text, font, colored)
+#   draw_line(self, frame_buffer, x0, y0, x1, y1, colored)
+#   draw_horizontal_line(self, frame_buffer, x, y, width, colored)
+#   draw_vertical_line(self, frame_buffer, x, y, height, colored)
+#   draw_rectangle(self, frame_buffer, x0, y0, x1, y1, colored):
+#   draw_filled_rectangle(self, frame_buffer, x0, y0, x1, y1, colored):
+#   draw_circle(self, frame_buffer, x, y, radius, colored):
+#   draw_filled_circle(self, frame_buffer, x, y, radius, colored):
+# * 2.Change:
+#   get_frame_buffer -> getbuffer
+#   display_frame -> display
+# * 3.How to use
+#   epd = epd1in54b.EPD()
+#   epd.init()
+#   image = Image.new('1', (epd1in54b.EPD_WIDTH, epd1in54b.EPD_HEIGHT), 255)
+#   ...
+#   drawing ......
+#   ...
+#   epd.display(getbuffer(image))
+# ******************************************************************************/
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documnetation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and//or sell
+# copies of the Software, and to permit persons to  whom the Software is
+# furished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS OR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+# THE SOFTWARE.
+#
+
+
+import epdconfig
+import Image
+import RPi.GPIO as GPIO
+
+# Display resolution
+EPD_WIDTH       = 200
+EPD_HEIGHT      = 200
+
+# EPD1IN54B commands
+PANEL_SETTING                               = 0x00
+POWER_SETTING                               = 0x01
+POWER_OFF                                   = 0x02
+POWER_OFF_SEQUENCE_SETTING                  = 0x03
+POWER_ON                                    = 0x04
+POWER_ON_MEASURE                            = 0x05
+BOOSTER_SOFT_START                          = 0x06
+DEEP_SLEEP                                  = 0x07
+DATA_START_TRANSMISSION_1                   = 0x10
+DATA_STOP                                   = 0x11
+DISPLAY_REFRESH                             = 0x12
+DATA_START_TRANSMISSION_2                   = 0x13
+PLL_CONTROL                                 = 0x30
+TEMPERATURE_SENSOR_COMMAND                  = 0x40
+TEMPERATURE_SENSOR_CALIBRATION              = 0x41
+TEMPERATURE_SENSOR_WRITE                    = 0x42
+TEMPERATURE_SENSOR_READ                     = 0x43
+VCOM_AND_DATA_INTERVAL_SETTING              = 0x50
+LOW_POWER_DETECTION                         = 0x51
+TCON_SETTING                                = 0x60
+TCON_RESOLUTION                             = 0x61
+SOURCE_AND_GATE_START_SETTING               = 0x62
+GET_STATUS                                  = 0x71
+AUTO_MEASURE_VCOM                           = 0x80
+VCOM_VALUE                                  = 0x81
+VCM_DC_SETTING_REGISTER                     = 0x82
+PROGRAM_MODE                                = 0xA0
+ACTIVE_PROGRAM                              = 0xA1
+READ_OTP_DATA                               = 0xA2
+
+class EPD:
+    def __init__(self):
+        self.reset_pin = epdconfig.RST_PIN
+        self.dc_pin = epdconfig.DC_PIN
+        self.busy_pin = epdconfig.BUSY_PIN
+        self.cs_pin = epdconfig.CS_PIN
+        self.width = EPD_WIDTH
+        self.height = EPD_HEIGHT
+
+    lut_vcom0 = [  
+        0x0E, 0x14, 0x01, 0x0A, 0x06, 0x04, 0x0A, 0x0A,
+        0x0F, 0x03, 0x03, 0x0C, 0x06, 0x0A, 0x00   
+    ]
+
+    lut_w = [  
+        0x0E, 0x14, 0x01, 0x0A, 0x46, 0x04, 0x8A, 0x4A,
+        0x0F, 0x83, 0x43, 0x0C, 0x86, 0x0A, 0x04   
+    ]
+
+    lut_b = [  
+        0x0E, 0x14, 0x01, 0x8A, 0x06, 0x04, 0x8A, 0x4A,
+        0x0F, 0x83, 0x43, 0x0C, 0x06, 0x4A, 0x04   
+    ]
+
+    lut_g1 = [
+        0x8E, 0x94, 0x01, 0x8A, 0x06, 0x04, 0x8A, 0x4A,
+        0x0F, 0x83, 0x43, 0x0C, 0x06, 0x0A, 0x04   
+    ]
+
+    lut_g2 = [ 
+        0x8E, 0x94, 0x01, 0x8A, 0x06, 0x04, 0x8A, 0x4A,
+        0x0F, 0x83, 0x43, 0x0C, 0x06, 0x0A, 0x04   
+    ]
+
+    lut_vcom1 = [  
+        0x03, 0x1D, 0x01, 0x01, 0x08, 0x23, 0x37, 0x37,
+        0x01, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00   
+    ]
+
+    lut_red0 = [   
+        0x83, 0x5D, 0x01, 0x81, 0x48, 0x23, 0x77, 0x77,
+        0x01, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00   
+    ]
+
+    lut_red1 = [   
+        0x03, 0x1D, 0x01, 0x01, 0x08, 0x23, 0x37, 0x37,
+        0x01, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00   
+    ] 
+    
+    # Hardware reset
+    def reset(self):
+        epdconfig.digital_write(self.reset_pin, GPIO.HIGH)
+        epdconfig.delay_ms(200) 
+        epdconfig.digital_write(self.reset_pin, GPIO.LOW)         # module reset
+        epdconfig.delay_ms(200)
+        epdconfig.digital_write(self.reset_pin, GPIO.HIGH)
+        epdconfig.delay_ms(200)   
+
+    def send_command(self, command):
+        epdconfig.digital_write(self.cs_pin, GPIO.LOW)
+        epdconfig.digital_write(self.dc_pin, GPIO.HIGH)
+        epdconfig.spi_writebyte([command])
+        epdconfig.digital_write(self.cs_pin, GPIO.HIGH)
+
+    def send_data(self, data):
+        epdconfig.digital_write(self.cs_pin, GPIO.LOW)
+        epdconfig.digital_write(self.dc_pin, GPIO.HIGH)
+        epdconfig.spi_writebyte([data])
+        epdconfig.digital_write(self.cs_pin, GPIO.HIGH)
+        
+    def wait_until_idle(self):
+        while(epdconfig.digital_read(self.busy_pin) == 0):      # 0: idle, 1: busy
+            epdconfig.delay_ms(100)    
+      
+    def set_lut_bw(self):
+        self.send_command(0x20)               # vcom
+        for count in range(0, 15):
+            self.send_data(self.lut_vcom0[count])
+        self.send_command(0x21)         # ww --
+        for count in range(0, 15):
+            self.send_data(self.lut_w[count])
+        self.send_command(0x22)         # bw r
+        for count in range(0, 15):
+            self.send_data(self.lut_b[count])
+        self.send_command(0x23)         # wb w
+        for count in range(0, 15):
+            self.send_data(self.lut_g1[count])
+        self.send_command(0x24)         # bb b
+        for count in range(0, 15):
+            self.send_data(self.lut_g2[count])
+
+    def set_lut_red(self):
+        self.send_command(0x25)
+        for count in range(0, 15):
+            self.send_data(self.lut_vcom1[count])
+        self.send_command(0x26)
+        for count in range(0, 15):
+            self.send_data(self.lut_red0[count])
+        self.send_command(0x27)
+        for count in range(0, 15):
+            self.send_data(self.lut_red1[count])
+            
+    def init(self):
+        if (epdconfig.module_init() != 0):
+            return -1
+        # EPD hardware init start
+        self.reset()
+        
+        self.send_command(POWER_SETTING) 
+        self.send_data(0x07)
+        self.send_data(0x00)
+        self.send_data(0x08)
+        self.send_data(0x00)
+        self.send_command(BOOSTER_SOFT_START)
+        self.send_data(0x07)
+        self.send_data(0x07)
+        self.send_data(0x07)
+        self.send_command(POWER_ON)
+
+        self.wait_until_idle()
+
+        self.send_command(PANEL_SETTING)
+        self.send_data(0xCF)
+        self.send_command(VCOM_AND_DATA_INTERVAL_SETTING)
+        self.send_data(0x17)
+        self.send_command(PLL_CONTROL)
+        self.send_data(0x39)
+        self.send_command(TCON_RESOLUTION)
+        self.send_data(0xC8)
+        self.send_data(0x00)
+        self.send_data(0xC8)
+        self.send_command(VCM_DC_SETTING_REGISTER)
+        self.send_data(0x0E)
+        
+        self.set_lut_bw()
+        self.set_lut_red()
+        return 0
+
+    def getbuffer(self, image):
+        buf = [0xFF] * ((self.width/8) * self.height)
+        image_monocolor = image.convert('1')
+        imwidth, imheight = image_monocolor.size
+        pixels = image_monocolor.load()
+        if(imwidth == self.width and imheight == self.height):
+            print("Horizontal")
+            for y in range(imheight):
+                for x in range(imwidth):
+                    # Set the bits for the column of pixels at the current position.
+                    if pixels[x, y] == 0:
+                        buf[(x + y * self.width) / 8] &= ~(0x80 >> (x % 8))
+        elif(imwidth == self.height and imheight == self.width):
+            print("Vertical")
+            for y in range(imheight):
+                for x in range(imwidth):
+                    newx = y
+                    newy = self.height - x - 1
+                    if pixels[x, y] == 0:
+                        buf[(newx + newy*self.width) / 8] &= ~(0x80 >> (y % 8))
+        return buf
+
+    def display(self, blackimage, redimage):
+        if (blackimage != None):
+            self.send_command(DATA_START_TRANSMISSION_1)
+            for i in range(0, self.width * self.height // 8):
+                temp = 0x00
+                for bit in range(0, 4):
+                    if (blackimage[i] & (0x80 >> bit) != 0):
+                        temp |= 0xC0 >> (bit * 2)
+                self.send_data(temp)  
+                temp = 0x00
+                for bit in range(4, 8):
+                    if (blackimage[i] & (0x80 >> bit) != 0):
+                        temp |= 0xC0 >> ((bit - 4) * 2)
+                self.send_data(temp)          
+        if (redimage != None):
+            self.send_command(DATA_START_TRANSMISSION_2)
+            for i in range(0, self.width * self.height // 8):
+                self.send_data(redimage[i])  
+
+        self.send_command(DISPLAY_REFRESH)
+        self.wait_until_idle()
+##
+ #  @brief: clear the frame memory with the specified color.
+ #          this won't update the display.
+ ##
+    def Clear(self):
+        self.send_command(DATA_START_TRANSMISSION_1)
+        for i in range(0, self.width * self.height // 8):
+            self.send_data(0xFF)
+            self.send_data(0xFF)
+            
+        self.send_command(DATA_START_TRANSMISSION_2)
+        for i in range(0, self.width * self.height // 8):
+            self.send_data(0xFF)
+
+        self.send_command(DISPLAY_REFRESH)
+        self.wait_until_idle()
+
+
+    # after this, call epd.init() to awaken the module
+    def sleep(self):
+        self.send_command(VCOM_AND_DATA_INTERVAL_SETTING)
+        self.send_data(0x17)
+        self.send_command(VCM_DC_SETTING_REGISTER)         #to solve Vcom drop 
+        self.send_data(0x00)        
+        self.send_command(POWER_SETTING)         #power setting      
+        self.send_data(0x02)        #gate switch to external
+        self.send_data(0x00)
+        self.send_data(0x00) 
+        self.send_data(0x00) 
+        self.wait_until_idle()
+        self.send_command(POWER_OFF)         #power off
+
+### END OF FILE ###
+

1.54inch_e-paper_b_code/RaspberryPi/python3/epdconfig.py

@@ -0,0 +1,71 @@
+# /*****************************************************************************
+# * | File        :	  EPD_1in54.py
+# * | Author      :   Waveshare team
+# * | Function    :   Hardware underlying interface
+# * | Info        :
+# *----------------
+# * |	This version:   V2.0
+# * | Date        :   2018-11-01
+# * | Info        :   
+# * 1.Remove:
+#   digital_write(self, pin, value)
+#   digital_read(self, pin)
+#   delay_ms(self, delaytime)
+# ******************************************************************************/
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documnetation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to  whom the Software is
+# furished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS OR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+# THE SOFTWARE.
+#
+
+
+import spidev
+import RPi.GPIO as GPIO
+import time
+
+# Pin definition
+RST_PIN         = 17
+DC_PIN          = 25
+CS_PIN          = 8
+BUSY_PIN        = 24
+
+# SPI device, bus = 0, device = 0
+SPI = spidev.SpiDev(0, 0)
+
+def digital_write(pin, value):
+    GPIO.output(pin, value)
+
+def digital_read(pin):
+    return GPIO.input(pin)
+
+def delay_ms(delaytime):
+    time.sleep(delaytime / 1000.0)
+
+def spi_writebyte(data):
+    SPI.writebytes(data)
+
+def module_init():
+    GPIO.setmode(GPIO.BCM)
+    GPIO.setwarnings(False)
+    GPIO.setup(RST_PIN, GPIO.OUT)
+    GPIO.setup(DC_PIN, GPIO.OUT)
+    GPIO.setup(CS_PIN, GPIO.OUT)
+    GPIO.setup(BUSY_PIN, GPIO.IN)
+    SPI.max_speed_hz = 2000000
+    SPI.mode = 0b00
+    return 0;
+
+### END OF FILE ###

1.54inch_e-paper_b_code/RaspberryPi/python3/main.py

@@ -0,0 +1,58 @@
+#!/usr/bin/python
+# -*- coding:utf-8 -*-
+
+import epd1in54b
+import time
+import Image
+import ImageDraw
+import ImageFont
+import traceback
+
+try:
+    epd = epd1in54b.EPD()
+    epd.init()
+    epd.Clear()
+    
+    # Drawing on the image
+    blackimage = Image.new('1', (epd1in54b.EPD_WIDTH, epd1in54b.EPD_HEIGHT), 255)  # 255: clear the frame
+    redimage = Image.new('1', (epd1in54b.EPD_WIDTH, epd1in54b.EPD_HEIGHT), 255)  # 255: clear the frame
+    print("drawing")
+    drawblack = ImageDraw.Draw(blackimage)
+    drawred = ImageDraw.Draw(redimage)
+    font = ImageFont.truetype('/usr/share/fonts/truetype/wqy/wqy-microhei.ttc', 24)
+    drawblack.rectangle((0, 10, 200, 34), fill = 0)
+    drawblack.text((8, 12), 'hello world', font = font, fill = 255)
+    drawblack.text((8, 36), 'e-Paper Demo', font = font, fill = 0)
+    drawblack.line((16, 60, 56, 60), fill = 0)
+    drawblack.line((56, 60, 56, 110), fill = 0)
+    drawblack.line((16, 110, 56, 110), fill = 0)
+    drawred.line((16, 110, 16, 60), fill = 0)
+    drawred.line((16, 60, 56, 110), fill = 0)
+    drawred.line((56, 60, 16, 110), fill = 0)
+    drawred.arc((90, 60, 150, 120), 0, 360, fill = 0)
+    drawred.rectangle((16, 130, 56, 180), fill = 0)
+    drawred.chord((90, 130, 150, 190), 0, 360, fill = 0)
+    epd.display(epd.getbuffer(blackimage),epd.getbuffer(redimage))
+    time.sleep(1)
+ 
+    print("open pic")
+    blackimage = Image.open('1in54b-b.bmp')
+    redimage = Image.open('1in54b-r.bmp')    
+    epd.display(epd.getbuffer(blackimage),epd.getbuffer(redimage))
+    time.sleep(1)
+    
+    print("show windows")
+    blackimage1 = Image.new('1', (epd1in54b.EPD_WIDTH, epd1in54b.EPD_HEIGHT), 255)  # 255: clear the frame
+    redimage2 = Image.new('1', (epd1in54b.EPD_WIDTH, epd1in54b.EPD_HEIGHT), 255)
+    
+    newimage = Image.open('100x100.bmp')
+    blackimage1.paste(newimage, (50,50))    
+    epd.display(epd.getbuffer(blackimage1), epd.getbuffer(redimage2))
+    
+    print("sleep")
+    epd.sleep()
+        
+except:
+    print('traceback.format_exc():\n%s',traceback.format_exc())
+    exit()
+

1.54inch_e-paper_b_code/RaspberryPi/python3/readme.txt

@@ -0,0 +1,92 @@
+/******************************************************************************
+ * File Name          : readme.txt
+ * Description        : Readme file
+ * Date               : 2019-04-08
+ ******************************************************************************
+ *
+ * Copyright (c) 2017 Waveshare
+ * All rights reserved.
+ *
+ * THIS SOFTWARE IS PROVIDED BY COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" 
+ * AND ANY EXPRESS, IMPLIED OR STATUTORY WARRANTIES, INCLUDING, BUT NOT 
+ * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A 
+ * PARTICULAR PURPOSE AND NON-INFRINGEMENT OF THIRD PARTY INTELLECTUAL PROPERTY
+ * RIGHTS ARE DISCLAIMED TO THE FULLEST EXTENT PERMITTED BY LAW. IN NO EVENT 
+ * SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
+ * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+ * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, 
+ * OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF 
+ * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING 
+ * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
+ * EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ *
+ ******************************************************************************
+  
+  == Development Environment ==
+  * OS: Raspbian for Raspberry Pi
+  * Libraries required: 
+        SPI library of Python
+        PIL (Python Imaging Library) library
+
+  == Raspberry Pi GPIO Pin map ==
+ +-----+-----+---------+------+---+---Pi 3---+---+------+---------+-----+-----+
+ | BCM | wPi |   Name  | Mode | V | Physical | V | Mode | Name    | wPi | BCM |
+ +-----+-----+---------+------+---+----++----+---+------+---------+-----+-----+
+ |     |     |    3.3v |      |   |  1 || 2  |   |      | 5v      |     |     |
+ |   2 |   8 |   SDA.1 |   IN | 1 |  3 || 4  |   |      | 5v      |     |     |
+ |   3 |   9 |   SCL.1 |   IN | 1 |  5 || 6  |   |      | 0v      |     |     |
+ |   4 |   7 | GPIO. 7 |   IN | 1 |  7 || 8  | 1 | ALT5 | TxD     | 15  | 14  |
+ |     |     |      0v |      |   |  9 || 10 | 1 | ALT5 | RxD     | 16  | 15  |
+ |  17 |   0 | GPIO. 0 |   IN | 0 | 11 || 12 | 0 | IN   | GPIO. 1 | 1   | 18  |
+ |  27 |   2 | GPIO. 2 |   IN | 0 | 13 || 14 |   |      | 0v      |     |     |
+ |  22 |   3 | GPIO. 3 |   IN | 0 | 15 || 16 | 0 | IN   | GPIO. 4 | 4   | 23  |
+ |     |     |    3.3v |      |   | 17 || 18 | 0 | IN   | GPIO. 5 | 5   | 24  |
+ |  10 |  12 |    MOSI | ALT0 | 0 | 19 || 20 |   |      | 0v      |     |     |
+ |   9 |  13 |    MISO | ALT0 | 0 | 21 || 22 | 0 | IN   | GPIO. 6 | 6   | 25  |
+ |  11 |  14 |    SCLK | ALT0 | 0 | 23 || 24 | 1 | OUT  | CE0     | 10  | 8   |
+ |     |     |      0v |      |   | 25 || 26 | 1 | OUT  | CE1     | 11  | 7   |
+ |   0 |  30 |   SDA.0 |   IN | 1 | 27 || 28 | 1 | IN   | SCL.0   | 31  | 1   |
+ |   5 |  21 | GPIO.21 |   IN | 1 | 29 || 30 |   |      | 0v      |     |     |
+ |   6 |  22 | GPIO.22 |   IN | 1 | 31 || 32 | 0 | IN   | GPIO.26 | 26  | 12  |
+ |  13 |  23 | GPIO.23 |   IN | 0 | 33 || 34 |   |      | 0v      |     |     |
+ |  19 |  24 | GPIO.24 |  OUT | 1 | 35 || 36 | 1 | OUT  | GPIO.27 | 27  | 16  |
+ |  26 |  25 | GPIO.25 |   IN | 0 | 37 || 38 | 0 | IN   | GPIO.28 | 28  | 20  |
+ |     |     |      0v |      |   | 39 || 40 | 0 | IN   | GPIO.29 | 29  | 21  |
+ +-----+-----+---------+------+---+----++----+---+------+---------+-----+-----+
+ | BCM | wPi |   Name  | Mode | V | Physical | V | Mode | Name    | wPi | BCM |
+ +-----+-----+---------+------+---+---Pi 3---+---+------+---------+-----+-----+
+
+  == Hardware connection ==
+    EPD    =>    Raspberry Pi
+  * VCC    ->    3.3
+  * GND    ->    GND
+  * DIN    ->    MOSI
+  * CLK    ->    SCLK
+  * CS     ->    24 (Physical, BCM: CE0, 8)
+  * D/C    ->    22 (Physical, BCM: 25)
+  * RES    ->    11 (Physical, BCM: 17)
+  * BUSY   ->    18 (Physical, BCM: 24)
+  
+    == How to use ==
+    1, open spidev.
+        spi is enabled in config.txt:
+        dtparam=spi=on
+    or in shell:
+        sudo raspi-config
+            - 5 Interfacing Options  Configure connections to peripherals
+                - 5 Interfacing Options  Configure connections to peripherals
+        
+    2, install the Python libraries.
+        sudo apt-get install python-pip 
+        sudo pip install RPi.GPIO
+        sudo pip install spidev
+        sudo apt-get install ttf-wqy-zenhei ttf-wqy-microhei
+
+    3, change the current directory to where the demo files located.
+
+    4, run the demo with: 
+        sudo python main.py
+    # if use python3:
+        sudo python3 main.py
+*/
+