M5Paper Library

English | 中文

Description

M5Paper is M5Stacks latest core device with a touch enabled E-ink display. Powered by the ESP32-D0WDQ6-V3 this is our first device to integrate a super sized 540*960 @4.7" E-ink display，which supports 16 grayscale levels. The display is a GT911 capacitive touch screen，which supports two point touch and a variety of gesture controls . Compared to a regular LCD，E-ink displays are easier on the eyes, which makes them a great choice for reading or viewing for longer periods. Other benefits are the low power consumption and the ability to retain the image even if power to the display is terminated. Integrated in the CoreInk are an multi-function button for operation, SHT30 temperature and moisture sensor, physical buttons and an TF card port for data storage.

Additionally the FM24C02 internal eeprom chip(256KB-EEPROM)can be used to store vital data even when the device is off. A 1150mAh lipo battery keeps the device going for long periods and battery life can be further preserved by using the RTC(BM8563)to set the device into deep sleep and wake it up again when needed。Three HY2.0-4P expansion ports are included which allow for building complex projects using the existing sensors in the M5Stack ecosystem.

?>Warning: Do not expose to ultraviolet rays for a long time, otherwise it may cause irreversible damage to the ink screen.

PinMap

E-INK & TF Card

Resolution：540*960

ESP32 Chip	GPIO13	GPIO12	GPIO14	GPIO15	GPIO4
IT8951	MISO	MOSI	SCK	CS	/
TF Card	MISO	MOSI	SCK	/	CS

Multi-function button

ESP32 Chip	GPIO37	GPIO38	GPIO39
Multi-function button	Right	BTN/PWR	Left

Internal I2C Connection

ESP32 Chip	GPIO21	GPIO22	GPIO36
GT911	SDA	SCL	INT
SHT30	SDA	SCL	/
BM8563	SDA	SCL	/
FM24C02	SDA	SCL	/

USB Serial

ESP32 Chip	GPIO1	GPIO3
CP2104	RXD	TXD

M5Paper-HY2.0 4P Port

PORT	PIN	Protocol:
PORT.A	G25,G32	I2C
PORT.B	G26,G33	DAC/ADC
PORT.C	G18,G19	UART

ESP32 ADC/DAC Mappable Pins

ADC1	ADC2	DAC1	DAC2
8 Channel	10 Channel	2 Channel	2 Channel
G32-39	G0/2/4/12-15/25-27	G25	G26

For more info on specific pin functions refer to the official ESP32 DocsESP32 datasheet

How to compile it

For Windows

1. Install ESP-IDF v4.4. For further info, read: ESP-IDF Getting Started for Windows

   • Either the Online or Offline version shoud work
   • When asked which components to install, don't change anything. Default options are Ok.
   • When asked whether ESP can modify the system, answer "Yes"

2. Launch the "ESP-IDF v4.4 CMD" (type that in the Windows search box)

3. From the ESP-IDF cmd, clone the template

   git clone --recursive https://github.com/m5stack/M5EPD.git my_project

4. Compile it

   # Compile it
   cd my_project
   idf.py build
   
   # Flash + open debug terminal
   idf.py flash monitor

For Linux / macOS

1. Requirements and permissions

   Install ESP-IDF dependencies (taken from here):

   # For Ubuntu / Debian
   sudo apt-get install git wget flex bison gperf python3 python3-pip python3-setuptools cmake ninja-build ccache libffi-dev libssl-dev dfu-util libusb-1.0-0

   And in case you don't have permissions to open /dev/ttyUSB0, do: (taken from here)

   # You MUST logout/login (or in some cases reboot Linux) after running this command
   sudo usermod -a -G dialout $USER

2. Install and setup ESP-IDF

   # Needs to be done just once
   # Clone the ESP-IDF git repo
   mkdir ~/esp && cd ~/esp
   git clone -b release/v4.4 --recursive https://github.com/espressif/esp-idf.git
   
   # Then install the toolchain
   cd ~/esp/esp-idf
   ./install.sh

3. Compile the template

   Clone the template:

   # Do it everytime you want to start a new project
   # Clone the template somewhere
   mkdir ~/src && cd ~/src
   git clone --recursive https://github.com/m5stack/M5EPD.git my_project

   Export the ESP-IDF environment variables in your shell:

   # Do it everytime you open a new shell
   # Optional: add it in your ~/.bashrc or ~/.profile
   source ~/esp/esp-idf/export.sh

   And finally compile and install your project.

   # Compile it
   cd ~/src/my_project
   idf.py build
   
   # Flash + open debug terminal
   idf.py flash monitor

Using 3rd party Arduino libraries

To include 3rd party Arduino libraries in your project, you have to:

• Add them to the components folder.
• Add a file component.mk and/or CMakeLists.txt inside the component's folder

component.mk is needed if you use make to compile it. And CMakeLists.txt is needed if you use idf.py to compile it.

Let's use a real case as example:

Example: Adding ESP32Servo

Suppose you want to use ESP32Servo project. The first thing to notice is that the source files are placed in the src folder. We have to create a component.mk and/or CMakeLists.txt files that tells the ESP-IDF to look for the sources in the src folder.

Example:

# 1) We clone ESP32Servo into components folder
cd components
git clone https://github.com/madhephaestus/ESP32Servo.git
cd ESP32Servo

And now create create these files files inside components/ESP32Servo folder:

# 2) Create component.mk file
# Only needed if you use "make" to compile the project
# Copy & paste the following lines to the terminal:
cat << EOF > component.mk
COMPONENT_ADD_INCLUDEDIRS := src
COMPONENT_SRCDIRS := src
EOF

# 3) Create CMakeLists.txt file
# Only needed if you use "idf.py" to compile the project
# Copy & paste the following lines to the terminal:
cat << EOF > CMakeLists.txt
idf_component_register(SRC_DIRS "src"
                    INCLUDE_DIRS "src"
                    REQUIRES "arduino")
EOF

Finally, if you use idf.py, you have to update the dependencies in the main/CMakeLists.txt. E.g:

# Needed if you use "idf.py" to compile the project
cd main
edit CMakeLists.txt

...and append ESP32Servo to REQUIRES. The main/CMakeLists.txt should look like this:

idf_component_register(SRCS "${srcs}"
                    INCLUDE_DIRS "."
                    REQUIRES "${requires}" "ESP32Servo")

And that's it. Now you can include ESP32Servo from your code. E.g:

// Add this include in your arduino_main.cpp file
#include <ESP32Servo.h>

IDE

Arduino IDE is not supported, but you can use Visual Studio Code + ESP-IDF plugin.

You can do:

• All the regular Visual Studio Code regular features
• ...plus configure, build, flash and monitor your project
• ...and much more

Subjective opinion: VSCode + ESP-IDF plugin is muuuuuch better than Arduino IDE. Highly recommended!

Related Link

This detailed compilation instruction comes from this awesome repository: Bluepad32 for Arduino

• Datasheet

  • ESP32
  • SHT30 Datasheet
  • BM8563
  • SY7088
  • GT911-datasheet

• API

  • Arduino API

Schematic

• M5 PAPER Schematic