M5Paper Library

About this fork

This is a fork of M5EPD. The purpose of this fork is to clear the license issue of M5EPD. See m5stack/M5EPD#21 for more details about the license issue.

This repository does following modifications to the original M5EPD:

• Reimplement some features from scratch.
  • SHT3x (was under GNU GENERAL PUBLIC LICENSE Version 3)
  • Button (was under Creative Commons Attribution-ShareAlike 3.0 Unported License)
• Remove some features.
  • CommUtil (was under GNU Lesser General Public License v2.1)
  • M5Timer (was under GNU Lesser General Public License v2.1 or later)
• Update the LICENSE file to include all license notices for codes in this repository.
  • Please let me know appropriate format for such license notices!
  • Please let me know if this library contains codes with licenses not written here.
  • This repository contains following codes derived from other projects:
    • codes from FreeType, under FreeType license:
      • src/base
      • src/freetype
      • src/ft2build.h
      • src/sfnt
      • src/smooth
      • src/truetype
    • codes under MIT / BSD / FreeBSD license:
      • TFT_eSPI, Sprite, src/Fonts
        • Supposed to come from https://github.com/Bodmer/TFT_eSPI
    • 3-clause BSD license:
      • Tom Thumb 3x5 font
        • See adafruit/Adafruit-GFX-Library#75 for details.
    • codes under MIT license:
      • M5EPD_Canvas
        • Supposed to come from https://github.com/espressif/WROVER_KIT_LCD
      • pngle from https://github.com/kikuchan/pngle
      • qrcode from https://github.com/ricmoo/QRCode
      • SHT3x, Button
        • Contributed in this repository.

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

Related Link

• Datasheet

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

• API

  • Arduino API

Schematic

• M5 PAPER Schematic