Skip to content

Latest commit

 

History

History
110 lines (62 loc) · 6.76 KB

README.md

File metadata and controls

110 lines (62 loc) · 6.76 KB
Raw

M5Stack Library

Arduino Lint Clang Format

English | 中文 | 日本語

The M5Stack library provides access to the built-in hardware of the M5Stack Core (including Basic and Gray) controllers.

Recommendation

This library is not recommended for new projects, nor for projects using M5Stack products other than Basic and Gray. See M5Unified and M5GFX for libraries that are more up-to-date and with support for many newer M5Stack products.

Usage

This library's functionality is available through the M5Stack class, referenced as M5, including:

  • LCD display via M5.Lcd, a customized version of the TFT_eSPI LCD library, adapted for Basic and Gray. The display resolution is 320x240 supporting 262K colors. Several fonts, graphics primitives, QR code rendering, and PNG/BMP/JPEG support are included.
  • Power control, including device shutoff and battery level detection via M5.Power and the IP5306 power management chip
  • Hardware buttons via M5.BtnA, M5.BtnB, M5.BtnC
  • Speaker, via M5.Speaker, supporting tones, volume control, and basic wave audio playback using ESP32's DAC function
  • Accelerometer, via M5.Imu, M5.Mpu6886, or M5.Sh200Q (accelerometer type depends on version of Basic/Gray)

To use the M5Stack library, #include "M5Stack.h" must appear at the top of your sketch.

The most productive way to become acquainted with the class is through the numerous included examples. Additional documentation within this library:

Additional optional include files:

  • M5Faces.h for access to M5Stack Faces accessories (EOL)
  • LoRaWan.h

basicgray

Comparison of M5Stack controllers

M-BUS

More Information

UIFlow Quick Start: Click Here

MicroPython API: Click Here

Arduino IDE Development: Click Here

Gray PinMap: Click Here

Basic PinMap: v1.0 (EOL) v2.6 (EOL) v2.7**

USER CASES