Skip to content

Commit

Permalink
updated chinese description
Browse files Browse the repository at this point in the history
  • Loading branch information
graydonli committed Apr 9, 2019
1 parent 02a0470 commit 2b5b04f
Show file tree
Hide file tree
Showing 2 changed files with 41 additions and 103 deletions.
2 changes: 2 additions & 0 deletions .gitignore
Expand Up @@ -48,3 +48,5 @@ Temporary Items

examples/Advanced/Proof
docs/datesheet

.vscode/*
142 changes: 39 additions & 103 deletions docs/getting_started_cn.md
@@ -1,132 +1,68 @@
# M5Stack Arduino — 快速上手
# M5Stack

English | [中文](docs/getting_started_cn.md) | [日本語](docs/getting_started_ja.md)

## 一、安装 USB 驱动
## 1. 上手指南

点击以下链接,下载 M5Stack-Core 的 USB 转串口驱动
*1.For MacOS*

https://www.silabs.com/products/development-tools/software/usb-to-uart-bridge-vcp-drivers
https://docs.m5stack.com/#/zh_CN/quick_start/m5core/m5stack_core_get_started_Arduino_MacOS

下载完之后,解压,根据系统位数,双击对应可执行文件
*2. For Windows*

(Windows 32位,执行 CP210xVCPInstaller_x68.exe;Windows 64位,执行 CP210xVCPInstaller_x64.exe;)
https://docs.m5stack.com/#/zh_CN/quick_start/m5core/m5stack_core_get_started_Arduino_Windows

*判断驱动安装是否成功:*
如果安装成功,在插入 M5Stack 主控之后,设备管理器如下图所示出现,Silicon Labs 的 CP21x 系列串口端口号
(我的电脑当前串口号是 COM3)

![image](arduino-ide/win-screenshots_cn/my_com.png)
## 2. 例程

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

## 二、开发环境
## **Windows**
### 1、安装 Arduino IDE
## 3. API 参考

*下载地址*
https://www.arduino.cc/en/Main/Software
https://github.com/m5stack/M5Stack/blob/master/src/M5Stack.h#L19

![image](arduino-ide/win-screenshots_cn/arduino_cc_package.png)
## 4. H/W 参考

#### 管脚映射

如下图所示修改 Arduino 路径为 D:\Program Files
*我们有几款不同配置的主控 M5Cores,这是他们之间的[对比](https://github.com/m5stack/M5-Schematic/blob/master/Core/hardware_difference_between_cores.md).*

![image](arduino-ide/win-screenshots_cn/select_arduino_install_path.png)
**LCD & TF Card**

*LCD 分辨率: 320x240*

此时,Arduino 的安装路径为 D:\Program Files\Arduino
<table>
<tr><td>ESP32 Chip</td><td>GPIO23</td><td>GPIO19</td><td>GPIO18</td><td>GPIO14</td><td>GPIO27</td><td>GPIO33</td><td>GPIO32</td><td>GPIO4</td></tr>
<tr><td>ILI9341</td><td>/</td><td>MISO</td><td>CLK</td><td>CS</td><td>DC</td><td>RST</td><td>BL</td><td> </td></tr>
<tr><td>TF Card</td><td>MOSI</td><td>MISO</td><td>CLK</td><td> </td><td> </td><td> </td><td> </td><td>CS</td></tr>

![image](arduino-ide/win-screenshots_cn/arduino_path.png)
</table>

**Button & Speaker**

### 2、下载 ESP32 相关支持包
<table>
<tr><td>ESP32 Chip</td><td>GPIO39</td><td>GPIO38</td><td>GPIO37</td><td>GPIO25</td></tr>
<tr><td>Button Pin</td><td>BUTTON A</td><td>BUTTON B</td><td>BUTTON C</td></tr>
<tr><td>Speaker</td><td> </td><td> </td><td> </td><td>Speaker Pin</td></tr>
</table>

(我的 Arduino 当前路径是 D:\Program Files\arduino)
**GROVE A**

进入 Arduino 安装路径的 hareware 文件夹,按住 Shift 键的同时,右键选择“在此处打开命令窗口”
<table>
<tr><td>ESP32 Chip</td><td>GPIO22</td><td>GPIO21</td></tr>
<tr><td>GROVE A</td><td>SCL</td><td>SDA</td></tr>
</table>


在打开的 Windows 终端 CMD 中输入如下命令
### M-BUS
![image](../docs/M-BUS.jpg)

> * 创建 espressif 目录,并切换到此目录下
#### Note:

mkdir espressif && cd espressif
* 如何安装 CP210x 串口驱动

![image](arduino-ide/win-screenshots_cn/mkdir_espressif.png)


> * 将 esp32 idf clone 在文件夹 esp32 下
git clone --recursive https://github.com/espressif/arduino-esp32.git esp32

![image](arduino-ide/win-screenshots_cn/download_idf.png)



### 3、下载 ESP32 编译链 tools

进入此路径 D:\Program Files\arduino\hardware\espressif\esp32\tools
选中并双击执行 get.exe 文件

![image](arduino-ide/win-screenshots_cn/select_get_exe_file.png)

![image](arduino-ide/win-screenshots_cn/download_xtensa_tools.png)


### 4、Arduino IDE 中下载 M5Stack 的库

打开 Arduino IDE 之后,选择“项目”->“加载库”->“管理库...”,搜索“M5Stack”并点击“安装”

![image](arduino-ide/win-screenshots_cn/select_arduino_lib.png)

![image](arduino-ide/win-screenshots_cn/download_m5stack_lib.png)


## 三、示例

USB 线连接 M5Stack 主控,选择串口和一个示例程序,compile and upload

### 1、打开一个示例程序,如打开 FactoryTest.ino

![image](arduino-ide/win-screenshots_cn/select_demo.png)



确认连接板子名称、串口波特率和当前串口号分别:M5Stack-Core-ESP32、921600、COM3(当前电脑串口号)

![image](arduino-ide/win-screenshots_cn/select_board_and_com.png)


编译运行成功之后,串口监视窗口显示如下


![image](arduino-ide/win-screenshots_cn/FactoryTest_result.png)

### 2、新建一个 M5Stack 程序

打开 Arduino IDE 之后,新建 .ino 文件,并保存为 my_test.ino

将如下代码拷贝进文件中。

```cpp
#include <M5Stack.h>

// the setup routine runs once when M5Stack starts up
void setup(){

// Initialize the M5Stack object
M5.begin();

// LCD display
M5.Lcd.print("Hello World!");
M5.Lcd.print("M5Stack is running successfully!");
}

// the loop routine runs over and over again forever
void loop() {

}
```

点击编译运行,此时 M5Stack 显示器显示 "Hello World!" "M5Stack is running successfully!"
https://docs.m5stack.com/#/zh_CN/related_documents/establish_serial_connection

* 如何升级 M5Stack 库

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

0 comments on commit 2b5b04f

Please sign in to comment.