# M5Stack Library

English | [中文](docs/getting_started_cn.md)

Welcom to program with M5Stack Core

## 1. Get Started

#### Here is the article to get started

*1.For MacOS*

https://m5stack.readthedocs.io/en/latest/get-started/m5stack_core_get_started_Arduino_MacOS.html

*2. For Windows*

https://m5stack.readthedocs.io/en/latest/get-started/m5stack_core_get_started_Arduino_Windows.html


## 2. Example

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

## 3. API Reference



## 4. H/W Reference

#### Pinout

Peripheral Devices | ILI9341 RST | ILI9341 DC | ILI9341 CS | ILI9341 MOSI | ILI9341 CLK | ILI9341 LIGHT | TFCARD MOSI | TFCARD MISO | TFCARD CLK | TFCARD CS | BUTTON A | BUTTON B | BUTTON C | SPEAKER | MPU9250 SDA | MPU9250 SCL | GROVE SDA | GROVE SCL
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---
ESP32 | GPIO33 | GPIO27 | GPIO14 | GPIO23 | GPIO18 | GPIO32 | GPIO23 | GPIO19 | GPIO18 | GPIO4 | GPIO39 | GPIO38 | GPIO37 | GPIO25 | GPIO21 | GPIO22 | GPIO21 | GPIO22


### M-BUS
![image](docs/M-BUS.jpg)

## 5. Awesome

https://m5stack.readthedocs.io/en/latest/m5stack-awesome/index.html

#### Note:
* How to install USB driver for establishing serial port

  https://m5stack.readthedocs.io/en/latest/get-started/establish_serial_connection.html

* How to upgrade M5Stack Libary

  https://m5stack.readthedocs.io/en/latest/get-started/upgrade_m5stack_lib.html