1.. _waveshare_epaper:
2
3WAVESHARE e-Paper Raw Panel Shield
4##################################
5
6Overview
7********
8
9The WAVESHARE e-Paper Raw Panel Shield is a universal driver shield.
10The shield can be used to drive various Electrophoretic (electronic ink)
11Display (EPD) with a SPI interface.
12This shield includes a 23LC1024 1Mb SPI Serial SRAM that is
13not currently supported by the Zephyr RTOS.
14
15More information about the shield can be found
16at the `Universal e-Paper Raw Panel Driver Shield website`_.
17
18Pins Assignment of the e-Paper Shield
19=====================================
20
21+-----------------------+------------+----------------------------+
22| Shield Connector Pin  | Function   |                            |
23+=======================+============+============================+
24| D5                    | RAM CSn    |  RAM Chip Select           |
25+-----------------------+------------+----------------------------+
26| D6                    | SD CSn     |  EPD SD Card Chip Select   |
27+-----------------------+------------+----------------------------+
28| D7                    | EPD BUSY   |  EPD Busy Output           |
29+-----------------------+------------+----------------------------+
30| D8                    | EPD RESETn |  EPD Reset Input           |
31+-----------------------+------------+----------------------------+
32| D9                    | EPD DC     |  EPD Data/Command Input    |
33+-----------------------+------------+----------------------------+
34| D10                   | EPD CSn    |  EPD Chip Select Input     |
35+-----------------------+------------+----------------------------+
36| D11                   | SPI MOSI   |  Serial Data Input         |
37+-----------------------+------------+----------------------------+
38| D12                   | SPI MISO   |  Serial Data Out           |
39+-----------------------+------------+----------------------------+
40| D13                   | SPI SCK    |  Serial Clock Input        |
41+-----------------------+------------+----------------------------+
42
43Current supported displays
44==========================
45
46+--------------+-----------------+--------------+------------------------------+
47| Display      | Ribbon Cable    | Controller / | Shield Designation           |
48|              | Label           | Driver       |                              |
49+==============+=================+==============+==============================+
50| Good Display | HINK-E0213      | SSD1673 /    | waveshare_epaper_gdeh0213b1  |
51| GDEH0213B1   |                 | ssd16xx      |                              |
52+--------------+-----------------+--------------+------------------------------+
53| Good Display | HINK-E0213A22   | SSD1675A /   | waveshare_epaper_gdeh0213b72 |
54| GDEH0213B72  |                 | ssd16xx      |                              |
55+--------------+-----------------+--------------+------------------------------+
56| Good Display | E029A01         | SSD1608 /    | waveshare_epaper_gdeh029a1   |
57| GDEH029A1    |                 | ssd16xx      |                              |
58+--------------+-----------------+--------------+------------------------------+
59| Good Display | WFT0583CZ61     | UC8179 /     | waveshare_epaper_gdew075t7   |
60| GDEW075T7    |                 | gd7965       |                              |
61+--------------+-----------------+--------------+------------------------------+
62| Good Display | HINK-E0154A07   | SSD1681 /    | waveshare_epaper_gdeh0154a07 |
63| GDEH0154D67  |                 | ssd16xx      |                              |
64+--------------+-----------------+--------------+------------------------------+
65| Good Display | WFT0420CZ15     | UC8176 /     | waveshare_epaper_gdew042t2   |
66| GDEW042T2    |                 | gd7965       | waveshare_epaper_gdew042t2-p |
67+--------------+-----------------+--------------+------------------------------+
68| Good Display | FPC-A002        | SSD1680 /    | waveshare_epaper_gdey0213b74 |
69| GDEY0213B74  |                 | ssd16xx      |                              |
70+--------------+-----------------+--------------+------------------------------+
71
72
73Requirements
74************
75
76This shield can only be used with a board that provides a configuration
77for Arduino connectors and defines node aliases for SPI and GPIO interfaces
78(see :ref:`shields` for more details).
79
80Programming
81***********
82
83Correct shield designation (see the table above) for your display must
84be entered when you invoke ``west build``.
85For example:
86
87.. zephyr-app-commands::
88   :zephyr-app: samples/subsys/display/lvgl
89   :board: nrf52840dk/nrf52840
90   :shield: waveshare_epaper_gdeh0213b1
91   :goals: build
92
93References
94**********
95
96.. target-notes::
97
98.. _Universal e-Paper Raw Panel Driver Shield website:
99   https://www.waveshare.com/e-paper-shield.htm
100