====== e-Paper on Khadas VIM Series ======


This guide provides instructions on setting up and using the Waveshare e-Paper 7.3-inch (epd_7in3e) display on Khadas VIM4, VIM3/3L, and VIM1S boards. It also includes information on the InkyPi repository for additional functionality.

== Installation Guide ==

To get started with e-Paper on your Khadas board, follow these steps:

=== Install Dependencies ===
```
sudo apt update
sudo apt install python3-dev python3-venv
python3 -m venv myvenv
source myvenv/bin/activate
```

=== Clone and Install e-Paper Repository ===
```
git clone https://github.com/numbqq/e-Paper.git
cd e-Paper/RaspberryPi_JetsonNano/python/
pip install -r requirements.txt
```

=== Configure SPI Interface ===
Before using the e-Paper display, ensure the correct SPI interface is enabled:

===== Enable SPI =====

In order to use the SPI, you need to enable the SPI function via [[products:sbc:common:configurations:device-tree-overlay|Device Tree Overlay]].

<tabbox VIM3>

Edit ''/boot/dtb/amlogic/kvim3.dtb.overlay.env'' to add spi node to ''fdt_overlays'' node if it doesn't exist.


e.g. Enable ''SPI_B'', you need to add ''spi1'' to node ''fdt_overlays'' if it doesn't exist.

```shell
fdt_overlays=spi1
```

After reboot, you will see the SPI device node.

```shell
$ ls /dev/spidev2.1 
/dev/spidev2.1
```

<tabbox VIM3L>

Edit ''/boot/dtb/amlogic/kvim3l.dtb.overlay.env'' to add spi node to ''fdt_overlays'' node if it doesn't exist.


e.g. Enable ''SPI_B'', you need to add ''spi1'' to node ''fdt_overlays'' if it doesn't exist.

```shell
fdt_overlays=spi1

```

After reboot, you will see the SPI device node.

```shell
$ ls /dev/spidev2.1 
/dev/spidev2.1
```

<tabbox VIM4>

Edit ''/boot/dtb/amlogic/kvim4.dtb.overlay.env'' to add spi node to ''fdt_overlays'' node if it doesn't exist.


e.g. Enable ''SPI_A'', you need to add ''spi0'' to node ''fdt_overlays'' if it doesn't exist.

```shell
fdt_overlays=spi0

```

After reboot, you will see the SPI device node.

```shell
$ ls /dev/spidev1.0 
/dev/spidev1.0

```
<tabbox VIM4N>

Edit ''/boot/dtb/amlogic/kvim4n.dtb.overlay.env'' to add spi node to ''fdt_overlays'' node if it doesn't exist.


e.g. Enable ''SPI_A'', you need to add ''spi0'' to node ''fdt_overlays'' if it doesn't exist.

```shell
fdt_overlays=spi0

```

After reboot, you will see the SPI device node.

```shell
$ ls /dev/spidev1.0 
/dev/spidev1.0
```
<tabbox VIM1S>

Edit ''/boot/dtb/amlogic/kvim1s.dtb.overlay.env'' to add spi node to ''fdt_overlays'' node if it doesn't exist.


e.g. Enable ''SPI_A'', you need to add ''spi0'' to node ''fdt_overlays'' if it doesn't exist.

```shell
fdt_overlays=spi0

```

After reboot, you will see the SPI device node.

```shell
$ ls /dev/spidev1.0 
/dev/spidev1.0
```

</tabbox>


After setting the correct overlay, run the following commands:
```
sync
reboot
```

=== Run the e-Paper Test Script ===
```
su
source myvenv/bin/activate
cd e-Paper/RaspberryPi_JetsonNano/python/examples
python epd_7in3e_test.py
```
This script will refresh the e-Paper display.

== Wiring Guide ==

Connect the e-Paper display to the Khadas VIM series boards according to the following pin mappings:

| Board       || VCC       || GND       || DIN       || SCLK      || CS        || DC        || RST       || BUSY      ||
|          |   |        |   |        |   |        |   |        |   |        |   |        |   |        |   |        |   |
| VIM4/4N     || PIN20     || PIN40     || PIN36     || PIN25     || PIN13     || PIN15     || PIN23     || PIN24     ||
|          |   |        |   |        |   |        |   |        |   |        |   |        |   |        |   |        |   |
| VIM3/3L     || PIN20     || PIN40     || PIN37     || PIN16     || PIN29     || PIN30     || PIN32     || PIN33     ||
|          |   |        |   |        |   |        |   |        |   |        |   |        |   |        |   |        |   |
| VIM1S       || PIN20     || PIN40     || PIN29     || PIN31     || PIN13     || PIN15     || PIN16     || PIN25     ||

== InkyPi Support ==

In addition to the Waveshare e-Paper repository, InkyPi is also supported. To install InkyPi, follow these steps:
```
git clone https://github.com/numbqq/InkyPi.git
cd InkyPi
su
bash install/install.sh
```
Following the scripts to reboot. After rebooting, InkyPi will be ready for use. You can access the web interface via IP to set up images and enjoy your own digital photo album!

Display{{:local:users:jacobe:75e41f82-9e7d-4d4a-acb4-ecbe97616e32.jpg?600|}}

Web Page{{:local:users:jacobe:current-image.png?600|}}

https://github.com/numbqq/InkyPi.git

== Conclusion ==

By following this guide, you can successfully set up and use the Waveshare e-Paper 7.3-inch display on Khadas VIM4, VIM3/3L, and VIM1S boards. You can also utilize the InkyPi repository for additional display functionalities.