eLandon_Miix ff99ba9fa8 Initial commit 3 years ago
..
docs ff99ba9fa8 Initial commit 3 years ago
examples ff99ba9fa8 Initial commit 3 years ago
src ff99ba9fa8 Initial commit 3 years ago
tools ff99ba9fa8 Initial commit 3 years ago
CMakeLists.txt ff99ba9fa8 Initial commit 3 years ago
Kconfig ff99ba9fa8 Initial commit 3 years ago
LICENSE ff99ba9fa8 Initial commit 3 years ago
README.md ff99ba9fa8 Initial commit 3 years ago
component.mk ff99ba9fa8 Initial commit 3 years ago
keywords.txt ff99ba9fa8 Initial commit 3 years ago
library.json ff99ba9fa8 Initial commit 3 years ago
library.properties ff99ba9fa8 Initial commit 3 years ago

README.md

M5Stack Library

English | 中文 | 日本語

Welcome to program with M5Stack Core

1. Get Started

Here is the article to get started

1.For MacOS

https://docs.m5stack.com/#/en/quick_start/m5core/m5stack_core_get_started_Arduino_MacOS

2. For Windows

https://docs.m5stack.com/#/en/quick_start/m5core/m5stack_core_get_started_Arduino_Windows

2. Example

https://github.com/m5stack/M5Stack/tree/master/examples

3. API Reference

https://github.com/m5stack/M5Stack/blob/master/src/M5Stack.h#L19

https://docs.m5stack.com/#/en/api

4. H/W Reference

Pinout

We have several kinds of M5Cores, There is their difference in schematic.

LCD & TF Card

LCD Resolution: 320x240

ESP32 ChipGPIO23GPIO19GPIO18GPIO14GPIO27GPIO33GPIO32GPIO4
ILI9341MOSI/MISO/CLKCSDCRSTBL
TF CardMOSIMISOCLK CS

Button & Speaker

ESP32 ChipGPIO39GPIO38GPIO37GPIO25
Button PinBUTTON ABUTTON BBUTTON C
Speaker Speaker Pin

GROVE A

ESP32 ChipGPIO22GPIO21
GROVE ASCLSDA

M-BUS

image

5. USER CASES

Note:

  • How to install USB driver for establishing serial port

https://docs.m5stack.com/#/en/related_documents/establish_serial_connection

  • How to upgrade M5Stack Libary

https://docs.m5stack.com/#/en/related_documents/upgrade_m5stack_lib