zephyr/boards/shields/waveshare_epaper/doc/index.rst

100 lines
4.7 KiB
ReStructuredText

.. _waveshare_epaper:
WAVESHARE e-Paper Raw Panel Shield
##################################
Overview
********
The WAVESHARE e-Paper Raw Panel Shield is a universal driver shield.
The shield can be used to drive various Electrophoretic (electronic ink)
Display (EPD) with a SPI interface.
This shield includes a 23LC1024 1Mb SPI Serial SRAM that is
not currently supported by the Zephyr RTOS.
More information about the shield can be found
at the `Universal e-Paper Raw Panel Driver Shield website`_.
Pins Assignment of the e-Paper Shield
=====================================
+-----------------------+------------+----------------------------+
| Shield Connector Pin | Function | |
+=======================+============+============================+
| D5 | RAM CSn | RAM Chip Select |
+-----------------------+------------+----------------------------+
| D6 | SD CSn | EPD SD Card Chip Select |
+-----------------------+------------+----------------------------+
| D7 | EPD BUSY | EPD Busy Output |
+-----------------------+------------+----------------------------+
| D8 | EPD RESETn | EPD Reset Input |
+-----------------------+------------+----------------------------+
| D9 | EPD DC | EPD Data/Command Input |
+-----------------------+------------+----------------------------+
| D10 | EPD CSn | EPD Chip Select Input |
+-----------------------+------------+----------------------------+
| D11 | SPI MOSI | Serial Data Input |
+-----------------------+------------+----------------------------+
| D12 | SPI MISO | Serial Data Out |
+-----------------------+------------+----------------------------+
| D13 | SPI SCK | Serial Clock Input |
+-----------------------+------------+----------------------------+
Current supported displays
==========================
+--------------+-----------------+--------------+------------------------------+
| Display | Ribbon Cable | Controller / | Shield Designation |
| | Label | Driver | |
+==============+=================+==============+==============================+
| Good Display | HINK-E0213 | SSD1673 / | waveshare_epaper_gdeh0213b1 |
| GDEH0213B1 | | ssd16xx | |
+--------------+-----------------+--------------+------------------------------+
| Good Display | HINK-E0213A22 | SSD1675A / | waveshare_epaper_gdeh0213b72 |
| GDEH0213B72 | | ssd16xx | |
+--------------+-----------------+--------------+------------------------------+
| Good Display | E029A01 | SSD1608 / | waveshare_epaper_gdeh029a1 |
| GDEH029A1 | | ssd16xx | |
+--------------+-----------------+--------------+------------------------------+
| Good Display | WFT0583CZ61 | UC8179 / | waveshare_epaper_gdew075t7 |
| GDEW075T7 | | gd7965 | |
+--------------+-----------------+--------------+------------------------------+
| Good Display | HINK-E0154A07 | SSD1681 / | waveshare_epaper_gdeh0154a07 |
| GDEH0154D67 | | ssd16xx | |
+--------------+-----------------+--------------+------------------------------+
| Good Display | WFT0420CZ15 | UC8176 / | waveshare_epaper_gdew042t2 |
| GDEW042T2 | | gd7965 | waveshare_epaper_gdew042t2-p |
+--------------+-----------------+--------------+------------------------------+
| Good Display | FPC-A002 | SSD1680 / | waveshare_epaper_gdey0213b74 |
| GDEY0213B74 | | ssd16xx | |
+--------------+-----------------+--------------+------------------------------+
Requirements
************
This shield can only be used with a board that provides a configuration
for Arduino connectors and defines node aliases for SPI and GPIO interfaces
(see :ref:`shields` for more details).
Programming
***********
Correct shield designation (see the table above) for your display must
be entered when you invoke ``west build``.
For example:
.. zephyr-app-commands::
:zephyr-app: samples/subsys/display/lvgl
:board: nrf52840dk/nrf52840
:shield: waveshare_epaper_gdeh0213b1
:goals: build
References
**********
.. target-notes::
.. _Universal e-Paper Raw Panel Driver Shield website:
https://www.waveshare.com/e-paper-shield.htm