From 5e7a689d9613b19eb1aa804e4ac760eab12b8463 Mon Sep 17 00:00:00 2001
From: LiHuashen <854410664@qq.com>
Date: Tue, 9 Apr 2019 15:17:43 +0800
Subject: [PATCH] ...
---
.../m5core/m5stack_core_quick_start.md | 6 +-
.../m5stick/m5stick_quick_start.md | 6 +-
.../m5stickc/m5stickc_quick_start.md | 6 +-
...5stack_core_get_started_Arduino_Windows.md | 4 -
.../m5core/m5stack_core_quick_start.md | 6 +-
.../m5stick/m5stick_quick_start.md | 8 +-
.../m5stick_quick_start_with_arduino_MacOS.md | 119 ++++++++++++-----
...5stick_quick_start_with_arduino_Windows.md | 126 +++++++++++++-----
.../m5stick_quick_start_with_uiflow.md | 4 +-
.../m5stickc/m5stickc_quick_start.md | 6 +-
10 files changed, 193 insertions(+), 98 deletions(-)
diff --git a/docs/en/quick_start/m5core/m5stack_core_quick_start.md b/docs/en/quick_start/m5core/m5stack_core_quick_start.md
index 81f5cf9f..64014b62 100644
--- a/docs/en/quick_start/m5core/m5stack_core_quick_start.md
+++ b/docs/en/quick_start/m5core/m5stack_core_quick_start.md
@@ -2,6 +2,6 @@
**Pick up your programming mode below for getting started**
-
|
|
----|---|---
-[Arduino-MacOS](en/quick_start/m5core/m5stack_core_get_started_Arduino_MacOS) | [Arduino-Windows](en/quick_start/m5core/m5stack_core_get_started_Arduino_Windows) | [UIFlow](en/quick_start/m5core/m5stack_core_get_started_MicroPython)
+|
|
|
|
+|:---:|:---:|:---:|
+|[Arduino-MacOS](en/quick_start/m5core/m5stack_core_get_started_Arduino_MacOS) | [Arduino-Windows](en/quick_start/m5core/m5stack_core_get_started_Arduino_Windows) | [UIFlow](en/quick_start/m5core/m5stack_core_get_started_MicroPython)|
diff --git a/docs/en/quick_start/m5stick/m5stick_quick_start.md b/docs/en/quick_start/m5stick/m5stick_quick_start.md
index 7b22978b..7f325562 100644
--- a/docs/en/quick_start/m5stick/m5stick_quick_start.md
+++ b/docs/en/quick_start/m5stick/m5stick_quick_start.md
@@ -2,6 +2,6 @@
**Pick up your programming mode below for getting started**
-
|
|
----|---|---
-[Arduino-MacOS](en/quick_start/m5stick/m5stick_quick_start_with_arduino_MacOS) | [Arduino-Windows](en/quick_start/m5stick/m5stick_quick_start_with_arduino_Windows) | [UIFlow](en/quick_start/m5stick/m5stick_quick_start_with_uiflow)
+|
|
|
|
+|:---:|:---:|:---:|
+|[Arduino-MacOS](en/quick_start/m5stick/m5stick_quick_start_with_arduino_MacOS) | [Arduino-Windows](en/quick_start/m5stick/m5stick_quick_start_with_arduino_Windows) | [UIFlow](en/quick_start/m5stick/m5stick_quick_start_with_uiflow)|
diff --git a/docs/en/quick_start/m5stickc/m5stickc_quick_start.md b/docs/en/quick_start/m5stickc/m5stickc_quick_start.md
index a656059d..4db5dedf 100644
--- a/docs/en/quick_start/m5stickc/m5stickc_quick_start.md
+++ b/docs/en/quick_start/m5stickc/m5stickc_quick_start.md
@@ -2,6 +2,6 @@
**Pick up your programming mode below for getting started**
-
|
----|---
-[Arduino-Windows](en/quick_start/m5stickc/m5stickc_quick_start_with_arduino_Windows) | [UIFlow](en/quick_start/m5stickc/m5stickc_quick_start_with_uiflow)
+|
|
|
+|:---:|:---:|
+|[Arduino-Windows](en/quick_start/m5stickc/m5stickc_quick_start_with_arduino_Windows) | [UIFlow](en/quick_start/m5stickc/m5stickc_quick_start_with_uiflow)|
diff --git a/docs/zh_CN/quick_start/m5core/m5stack_core_get_started_Arduino_Windows.md b/docs/zh_CN/quick_start/m5core/m5stack_core_get_started_Arduino_Windows.md
index 1f724c47..7eaf69d0 100644
--- a/docs/zh_CN/quick_start/m5core/m5stack_core_get_started_Arduino_Windows.md
+++ b/docs/zh_CN/quick_start/m5core/m5stack_core_get_started_Arduino_Windows.md
@@ -36,8 +36,6 @@
## 2. 安装串口驱动
-
-
浏览器打开 M5Stack 官网 https://m5stack.com/download
#### (1) 点击 `Windows`,下载 Windows 版本的驱动安装包并解压
@@ -70,8 +68,6 @@
-
-
## 3. 安装 ESP32 的板管理
#### (1) 打开 IDE,选择 `文件`->`首选项`->`设置`
diff --git a/docs/zh_CN/quick_start/m5core/m5stack_core_quick_start.md b/docs/zh_CN/quick_start/m5core/m5stack_core_quick_start.md
index 09fbbee9..b3a7ca92 100644
--- a/docs/zh_CN/quick_start/m5core/m5stack_core_quick_start.md
+++ b/docs/zh_CN/quick_start/m5core/m5stack_core_quick_start.md
@@ -4,6 +4,6 @@
*使用 Arduino/C++ 编程的话,选择 MacOS/Windows;使用 Blockly/MicroPython,选择 UIFlow(Blockly/MicroPython)*
-
|
|
----|---|---
-[Arduino-MacOS](zh_CN/quick_start/m5core/m5stack_core_get_started_Arduino_MacOS) | [Arduino-Windows](zh_CN/quick_start/m5core/m5stack_core_get_started_Arduino_Windows) | [UIFlow](zh_CN/quick_start/m5core/m5stack_core_get_started_MicroPython)
\ No newline at end of file
+|
|
|
|
+|:---:|:---:|:---:|
+|[Arduino-MacOS](zh_CN/quick_start/m5core/m5stack_core_get_started_Arduino_MacOS) | [Arduino-Windows](zh_CN/quick_start/m5core/m5stack_core_get_started_Arduino_Windows) | [UIFlow](zh_CN/quick_start/m5core/m5stack_core_get_started_MicroPython)|
\ No newline at end of file
diff --git a/docs/zh_CN/quick_start/m5stick/m5stick_quick_start.md b/docs/zh_CN/quick_start/m5stick/m5stick_quick_start.md
index b0e738b7..d6303a58 100644
--- a/docs/zh_CN/quick_start/m5stick/m5stick_quick_start.md
+++ b/docs/zh_CN/quick_start/m5stick/m5stick_quick_start.md
@@ -2,8 +2,8 @@
## 选择你需要的编程语言
-*使用Arduino/C++编程的话,选择Arduino;使用Blockly/MicroPython,选择UIFlow(Blockly/MicroPython)*
+*使用 Arduino/C++ 编程的话,选择 Arduino;使用 Blockly/MicroPython,选择 UIFlow(Blockly/MicroPython)*
-
|
|
----|---|---
-[Arduino-MacOS](zh_CN/quick_start/m5stick/m5stick_quick_start_with_arduino_MacOS) | [Arduino-Windows](zh_CN/quick_start/m5stick/m5stick_quick_start_with_arduino_Windows) | [UIFlow](zh_CN/quick_start/m5stick/m5stick_quick_start_with_uiflow)
\ No newline at end of file
+|
|
|
|
+|:---:|:---:|:---:|
+|[Arduino-MacOS](zh_CN/quick_start/m5stick/m5stick_quick_start_with_arduino_MacOS) | [Arduino-Windows](zh_CN/quick_start/m5stick/m5stick_quick_start_with_arduino_Windows) | [UIFlow](zh_CN/quick_start/m5stick/m5stick_quick_start_with_uiflow)|
\ No newline at end of file
diff --git a/docs/zh_CN/quick_start/m5stick/m5stick_quick_start_with_arduino_MacOS.md b/docs/zh_CN/quick_start/m5stick/m5stick_quick_start_with_arduino_MacOS.md
index 42a91dc2..3b816411 100644
--- a/docs/zh_CN/quick_start/m5stick/m5stick_quick_start_with_arduino_MacOS.md
+++ b/docs/zh_CN/quick_start/m5stick/m5stick_quick_start_with_arduino_MacOS.md
@@ -1,76 +1,127 @@
-# M5Stick 上手指南(macOS, Arudino) {docsify-ignore-all}
-
-
-
-?> 在配置环境之前,先确保您已经安装了 USB 驱动,并且 M5Stick 能通过串口与 PC 通信。 如果还没的话,看这篇文章[如何建立串口连接](zh_CN/related_documents/establish_serial_connection).
+# M5Stick 上手指南 - Arudino Mac {docsify-ignore-all}


-## 文本教程
+## 目录
-1. [配置环境](#配置环境)
+**[1. 安装 Arduino IDE](#_1-安装-Arduino-IDE)**
- - [Step1. 安装Arduino IDE](#Step1-安装arduino-ide)
+**[2. 安装串口驱动](#_2-安装串口驱动)**
- - [Step2. 安装ESP32的支持包](#Step2-安装ESP32的支持包)
+**[3. 安装 ESP32 的板管理](#_3-安装-ESP32-的板管理)**
- - [Step3. 安装Arduino-M5Stack库](#Step3-安装arduino-m5stack库)
+**[4. 安装 M5Stack 的库](#_4-安装-M5Stack-的库)**
- - [Step4. 安装U8g2库](#Step4-安装U8g2库)
+**[5. 安装 U8g2 库](#_5-安装-U8g2-的库)**
-2. [示例](#示例)
+**[6. 示例](#_6-示例)**
-## 配置环境
+## 1. 安装 Arduino IDE
-### Step1. 安装Arduino IDE
+浏览器打开 Arduino 官网 https://www.arduino.cc/en/Main/Software
-首先,如果 Arduino IDE 还没安装的话,先安装它。 这是下载地址 *download address* https://www.arduino.cc/en/Main/Software
+#### (1) 点击选择安装包 `Mac OS X`
-### Step2. 安装ESP32的支持包
+#### (2) 选择 `JUST DOWNLOAD`
-打开 Arduino IDE,选择`Arduino`->`Peferences`->`Settings`
+
+
+#### (3) Arduino IDE 下载下来就可以直接双击打开使用
+
+
+
+## 2. 安装串口驱动
+
+
+
+浏览器打开 M5Stack 官网 https://m5stack.com/download
+
+#### (1) 点击 `Mac`,下载 Mac 版本的驱动安装包并解压
+
+
+
+#### (2) 解压后,双击镜像文件 SiLabsUSBDriverDisk.dmg,开始安装
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+#### (3) 检查确认 COM 串口名
+
+检查确认 `/dev/tty.SLAB_USBtoUART` 串口名,以确定串口驱动是否安装成功:
+
+打开终端 `Terminal`,将 Core 通过 USB Type-C 线连接电脑,执行以下命令
+
+
+
+
+
+拔掉 USB 线,再执行一次刚刚的命令,此时终端 `Terminal` 上显示的 COM 列表里消失的 COM 口就是该 Core 对应的 串口名。
+
+
+
+## 3. 安装 ESP32 的板管理
+
+#### (1) 打开 Arduino IDE,选择 `文件`->`首选项`->`设置`
-复制下面最新的 ESP32 板管理网址到`Additional Boards Manager URLs: `选项中
+#### (2) 复制下面的 ESP32 板管理网址到 `附加开发板管理器:` 中
-*目前最新的板管理网址是这个:https://dl.espressif.com/dl/package_esp32_index.json*
+*ESP32 的板管理网址是这个:https://dl.espressif.com/dl/package_esp32_index.json*
-都确定 OK 之后,选择`Tools`->`Board:`->`Boards Manager...`,在新弹出的对话框中,输入并搜索 `ESP32`,点击`安装`
+#### (3) 选择 `工具`->`开发板:`->`开发板管理器...`
+#### (4) 在新弹出的对话框中,输入并搜索 `ESP32`,点击`安装`
+
-### Step3. 安装Arduino-M5Stack库
+## 4. 安装 M5Stack 的库
-打开 Arduino IDE, 然后选择`Sketch`->`Include Library`->`Manage Libraries...`
-
-在搜索框输入`M5Stack`搜索并安装。
+#### (1) 打开 Arduino IDE, 然后选择 `项目`->`加载库`->`库管理...`
+#### (2) 搜索 `M5Stack` 并安装,如下图所示
+
-### Step4. 安装U8g2库
-如果您还没安装 `U8g2` 库的话,打开 Arduino IDE,并点击`Sketch`->`Include Library`->`Manage Libraries...`,搜索 `U8g2` 进行安装。
+## 5. 安装 U8g2 的库
-
-
-
+#### (1) 打开 Arduino IDE, 然后选择 `项目`->`加载库`->`库管理...`,搜索 `U8g2` 并安装,如下图所示
-## 示例
+
+
+## 6. 示例
用 USB 线连接 [带 MPU9250 的 M5Stick](https://img.alicdn.com/imgextra/i4/136588748/O1CN012EUdFpJIthEANlx_!!136588748.jpg) 和 PC,然后选择 PC 上正与 M5Stick 连接的串口号。
-### 1. 选择板子和串口
+#### (1) 选择板子和串口
打开 Arduino IDE, 并点击 `Tools`->`Boards`->`M5Stack-Core-ESP32`
@@ -78,7 +129,7 @@
-### 2. 选择一个例程
+#### (2) 选择一个例程
点击 `File`->`Examples`->`M5Stack`->`Stick`
@@ -102,7 +153,3 @@
?> **如果您想了解更多关于CP2104 USB驱动的资料,请阅读这个链接的内容** https://developer.apple.com/library/archive/technotes/tn2459/\_index.html
-
-
diff --git a/docs/zh_CN/quick_start/m5stick/m5stick_quick_start_with_arduino_Windows.md b/docs/zh_CN/quick_start/m5stick/m5stick_quick_start_with_arduino_Windows.md
index 1821f072..186b50de 100644
--- a/docs/zh_CN/quick_start/m5stick/m5stick_quick_start_with_arduino_Windows.md
+++ b/docs/zh_CN/quick_start/m5stick/m5stick_quick_start_with_arduino_Windows.md
@@ -1,66 +1,118 @@
# M5Stick 上手指南 - Arduino Win{docsify-ignore-all}
-?> 建议你先确认安装了 `USB驱动` 和 `Arduino IDE`。 如果还没的话,阅读这两篇文档[如何建立串口连接](zh_CN/related_documents/establish_serial_connection)和[安装 Arduino IDE](zh_CN/related_documents/how_to_install_git_and_arduino)。
-


## 目录
-1. [配置环境](#配置环境)
+**[1. 安装 Arduino IDE](#_1-安装-Arduino-IDE)**
- - [Step1. 下载Arduino-ESP32的支持包](#Step1-下载Arduino-ESP32的支持包)
+**[2. 安装串口驱动](#_2-安装串口驱动)**
- - [Step2. 安装Arduino-M5Stack库](#Step2-安装Arduino-M5Stack库)
+**[3. 安装 ESP32 的板管理](#_3-安装-ESP32-的板管理)**
- - [Step3. 安装U8g2库](#Step3-安装U8g2库)
+**[4. 安装 M5Stack 的库](#_4-安装-M5Stack-的库)**
-2. [示例](#示例)
+**[5. 安装 U8g2 库](#_5-安装-U8g2-的库)**
+**[6. 示例](#_6-示例)**
-## 1. 配置环境
+## 1. 安装 Arduino IDE
-### Step1. 下载Arduino-ESP32的支持包
+
-打开Arduino IDE,选择`File`->`Peferences`->`Settings`
+浏览器打开 Arduino 官网 https://www.arduino.cc/en/Main/Software
-
+#### (1) 点击选择安装包 `Windows ZIP file for non admin install`
-
+
-复制下面最新的ESP32板管理网址到 `Additional Boards Manager URLs: `中
+#### (2) 选择 `JUST DOWNLOAD`
-*目前最新的板管理网址是这个:https://dl.espressif.com/dl/package_esp32_index.json*
+
-
+#### (3) 双击下载好的 IDE 可执行文件,全过程保持默认的选择,包括安装路径也是默认。
-选择`Tools`->`Board:`->`Boards Manager...`,在新弹出的对话框中,输入并搜索`ESP32`,点击`安装`
+
-
+
-
+## 2. 安装串口驱动
-### Step2. 安装Arduino-M5Stack库
+浏览器打开 M5Stack 官网 https://m5stack.com/download
-打开Arduino IDE, 然后选择`Sketch`->`Include Library`->`Manage Libraries...`
-搜索`M5Stack`并安装,如下图所示。
+#### (1) 点击 `Windows`,下载 Windows 版本的驱动安装包并解压
-
+
-
+#### (2) 根据您的 windows 操作系统类型,选择对应的驱动安装包
-!> *如果显示下图这样,表示你需要升级Arduino-M5Stack库*
+* 32 位的 Windows 操作系统,选择 `CP210xVCPInstaller_x86_vx.x.x.x.exe`
-
+* 64 位的 Windows 操作系统,选择 `CP210xVCPInstaller_x64_vx.x.x.x.exe`
-### Step3. 安装U8g2库
+
-如果您还没安装`U8g2`库的话,打开Arduino IDE,并点击`Sketch`->`Include Library`->`Manage Libraries...`,搜索`U8g2`进行安装。
+#### (3) 双击执行
-
-
-
+
-## 示例
+
+
+#### (4) 检查确认 COM 串口号
+
+检查确认 COM 串口号,以确定串口驱动是否安装成功:
+
+将 Core 通过 USB Type-C 线连接电脑,打开 Windows 设备管理器,点击 `端口 (COM 和 LPT)` 以查看串口号。然后拔掉 USB 线,此时`端口 (COM 和 LPT)` 上消失的 COM 口就是该 Core 对应的 串口号。
+
+
+
+拔掉 USB 线之后,COM 口消失
+
+
+
+## 3. 安装 ESP32 的板管理
+
+#### (1) 打开 IDE,选择 `文件`->`首选项`->`设置`
+
+
+
+
+
+#### (2) 复制下面的 ESP32 板管理网址到 `附加开发板管理器:` 中
+
+*ESP32 的板管理网址是这个:https://dl.espressif.com/dl/package_esp32_index.json*
+
+
+
+#### (3) 选择 `工具`->`开发板:`->`开发板管理器...`
+
+
+
+#### (4) 在新弹出的对话框中,输入并搜索 `ESP32`,点击`安装`
+
+
+
+## 4. 安装 M5Stack 的库
+
+#### (1) 打开 Arduino IDE, 然后选择 `项目`->`加载库`->`库管理...`
+
+
+
+#### (2) 搜索 `M5Stack` 并安装,如下图所示
+
+
+
+
+
+## 5. 安装 U8g2 的库
+
+#### 打开 Arduino IDE, 然后选择 `项目`->`加载库`->`库管理...`,搜索 `U8g2` 并安装,如下图所示
+
+
+
+## 6. 示例
这部分是为了验证现在你是否能通过 Arduino IDE 对 M5Stick 编程。
@@ -68,22 +120,22 @@
选择一个 example 例程,然后上传运行试试。
-### 1. 运行一个示例程序,比如`FactoryTest.ino`
+### (1) 运行一个示例程序,比如`FactoryTest.ino`
-选择你板子的名字,波特率和串口号: M5Stack-Core-ESP32, 921600, COM4 (你看,像我现在与 M5Stick 相连的串口就是 `COM4`,所以我应该选择 `COM4`)
+选择你板子的名字,波特率和串口号: M5Stack-Core-ESP32, 921600, COM4 (像我现在与 M5Stick 相连的串口就是 `COM4`,所以我应该选择 `COM4`)
-选择示例程序 `M5Stack` -> `Stick` -> `FactoryTest.ino`
+#### (2) 选择示例程序`FactoryTest.ino`
+
+选择示例程序 M5Stack -> Stick -> FactoryTest.ino
-点击上传
+#### (3) 点击上传
**现象: 按下按键 A 之后,屏幕显示 "Hello World! Exist"**
**单击电源键开机,双击电源键休眠。**
-
-?> *如果你想升级Arduino-M5Stack库的话,请移步阅读这篇文档[如何升级Arduino-M5Stack库](zh_CN/related_documents/upgrade_m5stack_lib).*
\ No newline at end of file
diff --git a/docs/zh_CN/quick_start/m5stick/m5stick_quick_start_with_uiflow.md b/docs/zh_CN/quick_start/m5stick/m5stick_quick_start_with_uiflow.md
index 879caf85..04090ff3 100644
--- a/docs/zh_CN/quick_start/m5stick/m5stick_quick_start_with_uiflow.md
+++ b/docs/zh_CN/quick_start/m5stick/m5stick_quick_start_with_uiflow.md
@@ -1,6 +1,6 @@
-# M5Stick快速上手 {docsify-ignore-all}
+# M5Stick 快速上手 - UIFlow {docsify-ignore-all}
-
+

1. **[更新固件](#更新固件)**
diff --git a/docs/zh_CN/quick_start/m5stickc/m5stickc_quick_start.md b/docs/zh_CN/quick_start/m5stickc/m5stickc_quick_start.md
index a19ae83a..e3196332 100644
--- a/docs/zh_CN/quick_start/m5stickc/m5stickc_quick_start.md
+++ b/docs/zh_CN/quick_start/m5stickc/m5stickc_quick_start.md
@@ -4,6 +4,6 @@
-
|
----|---
-[Arduino-Windows](zh_CN/quick_start/m5stickc/m5stickc_quick_start_with_arduino_Windows) | [UIFlow](zh_CN/quick_start/m5stickc/m5stickc_quick_start_with_uiflow)
\ No newline at end of file
+|
|
|
+|:---:|:---:|
+|[Arduino-Windows](zh_CN/quick_start/m5stickc/m5stickc_quick_start_with_arduino_Windows) | [UIFlow](zh_CN/quick_start/m5stickc/m5stickc_quick_start_with_uiflow)|
\ No newline at end of file