diff --git a/docs/assets/img/getting_started_pics/m5stack_core/get_started_with_arduino_m5core/windows/arduino_cc_package.png b/docs/assets/img/getting_started_pics/m5stack_core/get_started_with_arduino_m5core/windows/arduino_cc_package.png index dca70cfe..4c72fb8a 100644 Binary files a/docs/assets/img/getting_started_pics/m5stack_core/get_started_with_arduino_m5core/windows/arduino_cc_package.png and b/docs/assets/img/getting_started_pics/m5stack_core/get_started_with_arduino_m5core/windows/arduino_cc_package.png differ diff --git a/docs/assets/img/getting_started_pics/m5stack_core/get_started_with_arduino_m5core/windows/arduino_cc_package_02.png b/docs/assets/img/getting_started_pics/m5stack_core/get_started_with_arduino_m5core/windows/arduino_cc_package_02.png new file mode 100644 index 00000000..bbf1114d Binary files /dev/null and b/docs/assets/img/getting_started_pics/m5stack_core/get_started_with_arduino_m5core/windows/arduino_cc_package_02.png differ diff --git a/docs/assets/img/getting_started_pics/m5stack_core/get_started_with_arduino_m5core/windows/arduino_upload_cn.png b/docs/assets/img/getting_started_pics/m5stack_core/get_started_with_arduino_m5core/windows/arduino_upload_cn.png new file mode 100644 index 00000000..8848075b Binary files /dev/null and b/docs/assets/img/getting_started_pics/m5stack_core/get_started_with_arduino_m5core/windows/arduino_upload_cn.png differ diff --git a/docs/assets/img/getting_started_pics/m5stack_core/get_started_with_arduino_m5core/windows/check_serial_port_01.png b/docs/assets/img/getting_started_pics/m5stack_core/get_started_with_arduino_m5core/windows/check_serial_port_01.png new file mode 100644 index 00000000..5e29f6dc Binary files /dev/null and b/docs/assets/img/getting_started_pics/m5stack_core/get_started_with_arduino_m5core/windows/check_serial_port_01.png differ diff --git a/docs/assets/img/getting_started_pics/m5stack_core/get_started_with_arduino_m5core/windows/check_serial_port_02.png b/docs/assets/img/getting_started_pics/m5stack_core/get_started_with_arduino_m5core/windows/check_serial_port_02.png new file mode 100644 index 00000000..ef6912f5 Binary files /dev/null and b/docs/assets/img/getting_started_pics/m5stack_core/get_started_with_arduino_m5core/windows/check_serial_port_02.png differ diff --git a/docs/assets/img/getting_started_pics/m5stack_core/get_started_with_arduino_m5core/windows/download_usb_driver_win_01.png b/docs/assets/img/getting_started_pics/m5stack_core/get_started_with_arduino_m5core/windows/download_usb_driver_win_01.png new file mode 100644 index 00000000..c844175b Binary files /dev/null and b/docs/assets/img/getting_started_pics/m5stack_core/get_started_with_arduino_m5core/windows/download_usb_driver_win_01.png differ diff --git a/docs/assets/img/getting_started_pics/m5stack_core/get_started_with_arduino_m5core/windows/install_m5stack_lib_01_cn.png b/docs/assets/img/getting_started_pics/m5stack_core/get_started_with_arduino_m5core/windows/install_m5stack_lib_01_cn.png new file mode 100644 index 00000000..0d266e99 Binary files /dev/null and b/docs/assets/img/getting_started_pics/m5stack_core/get_started_with_arduino_m5core/windows/install_m5stack_lib_01_cn.png differ diff --git a/docs/assets/img/getting_started_pics/m5stack_core/get_started_with_arduino_m5core/windows/install_m5stack_lib_02.png b/docs/assets/img/getting_started_pics/m5stack_core/get_started_with_arduino_m5core/windows/install_m5stack_lib_02.png index 17c1b314..2c0e4c40 100644 Binary files a/docs/assets/img/getting_started_pics/m5stack_core/get_started_with_arduino_m5core/windows/install_m5stack_lib_02.png and b/docs/assets/img/getting_started_pics/m5stack_core/get_started_with_arduino_m5core/windows/install_m5stack_lib_02.png differ diff --git a/docs/assets/img/getting_started_pics/m5stack_core/get_started_with_arduino_m5core/windows/install_m5stack_lib_02_cn.png b/docs/assets/img/getting_started_pics/m5stack_core/get_started_with_arduino_m5core/windows/install_m5stack_lib_02_cn.png new file mode 100644 index 00000000..92500089 Binary files /dev/null and b/docs/assets/img/getting_started_pics/m5stack_core/get_started_with_arduino_m5core/windows/install_m5stack_lib_02_cn.png differ diff --git a/docs/assets/img/getting_started_pics/m5stack_core/get_started_with_arduino_m5core/windows/quick_start_arduino_win_01.png b/docs/assets/img/getting_started_pics/m5stack_core/get_started_with_arduino_m5core/windows/quick_start_arduino_win_01.png index 928d25b6..45175a24 100644 Binary files a/docs/assets/img/getting_started_pics/m5stack_core/get_started_with_arduino_m5core/windows/quick_start_arduino_win_01.png and b/docs/assets/img/getting_started_pics/m5stack_core/get_started_with_arduino_m5core/windows/quick_start_arduino_win_01.png differ diff --git a/docs/assets/img/getting_started_pics/m5stack_core/get_started_with_arduino_m5core/windows/quick_start_arduino_win_02_cn.png b/docs/assets/img/getting_started_pics/m5stack_core/get_started_with_arduino_m5core/windows/quick_start_arduino_win_02_cn.png new file mode 100644 index 00000000..33d21501 Binary files /dev/null and b/docs/assets/img/getting_started_pics/m5stack_core/get_started_with_arduino_m5core/windows/quick_start_arduino_win_02_cn.png differ diff --git a/docs/assets/img/getting_started_pics/m5stack_core/get_started_with_arduino_m5core/windows/quick_start_arduino_win_03_cn.png b/docs/assets/img/getting_started_pics/m5stack_core/get_started_with_arduino_m5core/windows/quick_start_arduino_win_03_cn.png new file mode 100644 index 00000000..613d8f41 Binary files /dev/null and b/docs/assets/img/getting_started_pics/m5stack_core/get_started_with_arduino_m5core/windows/quick_start_arduino_win_03_cn.png differ diff --git a/docs/assets/img/getting_started_pics/m5stack_core/get_started_with_arduino_m5core/windows/quick_start_arduino_win_04.png b/docs/assets/img/getting_started_pics/m5stack_core/get_started_with_arduino_m5core/windows/quick_start_arduino_win_04.png index 8e8cd18a..a03f13b4 100644 Binary files a/docs/assets/img/getting_started_pics/m5stack_core/get_started_with_arduino_m5core/windows/quick_start_arduino_win_04.png and b/docs/assets/img/getting_started_pics/m5stack_core/get_started_with_arduino_m5core/windows/quick_start_arduino_win_04.png differ diff --git a/docs/assets/img/getting_started_pics/m5stack_core/get_started_with_arduino_m5core/windows/quick_start_arduino_win_04_cn.png b/docs/assets/img/getting_started_pics/m5stack_core/get_started_with_arduino_m5core/windows/quick_start_arduino_win_04_cn.png new file mode 100644 index 00000000..c9f1c48d Binary files /dev/null and b/docs/assets/img/getting_started_pics/m5stack_core/get_started_with_arduino_m5core/windows/quick_start_arduino_win_04_cn.png differ diff --git a/docs/assets/img/getting_started_pics/m5stack_core/get_started_with_arduino_m5core/windows/quick_start_arduino_win_05_cn.png b/docs/assets/img/getting_started_pics/m5stack_core/get_started_with_arduino_m5core/windows/quick_start_arduino_win_05_cn.png new file mode 100644 index 00000000..56d32e9b Binary files /dev/null and b/docs/assets/img/getting_started_pics/m5stack_core/get_started_with_arduino_m5core/windows/quick_start_arduino_win_05_cn.png differ diff --git a/docs/assets/img/getting_started_pics/m5stack_core/get_started_with_arduino_m5core/windows/select_an_example_cn.png b/docs/assets/img/getting_started_pics/m5stack_core/get_started_with_arduino_m5core/windows/select_an_example_cn.png new file mode 100644 index 00000000..5625a032 Binary files /dev/null and b/docs/assets/img/getting_started_pics/m5stack_core/get_started_with_arduino_m5core/windows/select_an_example_cn.png differ diff --git a/docs/assets/img/getting_started_pics/m5stack_core/get_started_with_arduino_m5core/windows/select_board_baudrate_serial_port_cn.png b/docs/assets/img/getting_started_pics/m5stack_core/get_started_with_arduino_m5core/windows/select_board_baudrate_serial_port_cn.png new file mode 100644 index 00000000..b9c4cd0f Binary files /dev/null and b/docs/assets/img/getting_started_pics/m5stack_core/get_started_with_arduino_m5core/windows/select_board_baudrate_serial_port_cn.png differ diff --git a/docs/zh_CN/README.md b/docs/zh_CN/README.md index 699bad4d..e2ad3c85 100644 --- a/docs/zh_CN/README.md +++ b/docs/zh_CN/README.md @@ -4,11 +4,11 @@ -*( **[上手指南](zh_CN/qs)**   **[主控之间的对比](https://github.com/m5stack/M5-Schematic/blob/master/Core/hardware_difference_between_cores_zh_CN.md)**   **[IIC 地址表](https://shimo.im/sheets/GWkjHV3XyCCgwDpQ)** )* +*(**[主控之间的对比](https://github.com/m5stack/M5-Schematic/blob/master/Core/hardware_difference_between_cores_zh_CN.md)**   **[IIC 地址表](https://shimo.im/sheets/GWkjHV3XyCCgwDpQ)** )*   -**主控M5Core** +**主控M5Core** *( **[上手指南](zh_CN/quick_start/m5core/m5stack_core_quick_start)** )* [![core_basic.png](https://m5stack.oss-cn-shenzhen.aliyuncs.com/image/m5-docs_homepage/core/core_basic_01.png)](zh_CN/core/basic)         [![core_gray.png](https://m5stack.oss-cn-shenzhen.aliyuncs.com/image/m5-docs_homepage/core/core_gray_01.png)](zh_CN/core/gray)         [![product_pic_fire.png](https://m5stack.oss-cn-shenzhen.aliyuncs.com/image/m5-docs_homepage/core/core_fire_01.png)](zh_CN/core/fire) @@ -16,7 +16,7 @@   -**MiniCore** +**MiniCore** *( **[上手指南](zh_CN/quick_start/m5stick/m5stick_quick_start)** )* [![minicore_m5stick.png](https://m5stack.oss-cn-shenzhen.aliyuncs.com/image/m5-docs_homepage/core/core_m5stick_01.png)](zh_CN/core/m5stick)         [![minicore_m5stickc.png](https://m5stack.oss-cn-shenzhen.aliyuncs.com/image/m5-docs_homepage/core/core_m5stickc_01.png)](zh_CN/core/m5stickc) 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 a65a4376..025b179a 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 @@ -1,76 +1,135 @@ -# Core 上手指南(Windows, Arudino) {docsify-ignore-all} +# Core 在 Arduino IDE 上开发的上手指南 {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-的板管理)** -2. [示例](#示例) +**[4. 安装 M5Stack 的库](#_4-安装-M5Stack-的库)** +**[5. 示例](#_5-示例)** -## 1. 配置环境 +### 1. 安装 Arduino IDE -### Step1. 下载Arduino-ESP32的支持包 +*注意:如果已经安装了 IDE,请直接从[步骤 2](#_2-安装串口驱动) 开始。* -打开Arduino IDE,选择`File`->`Peferences`->`Settings` +浏览器打开 Arduino 官网 https://www.arduino.cc/en/Main/Software + +#### (1) 点击选择安装包 `Windows ZIP file for non admin install` + + + +#### (2) 选择 `JUST DOWNLOAD` + + + +#### (3) 双击下载好的 IDE 可执行文件,全过程保持默认的选择,包括安装路径也是默认。 + + + + + +### 2. 安装串口驱动 + +*注意:如果已经安装了 CP21x 的串口驱动的话,请直接从[步骤 3](#_3-安装-ESP32-的板管理) 开始。* + +浏览器打开 M5Stack 官网 https://m5stack.com/download + +#### (1) 点击 `Windows`,下载 Windows 版本的驱动安装包并解压 + + + +#### (2) 根据您的 windows 操作系统类型,选择对应的驱动安装包 + +* 32 位的 Windows 操作系统,选择 `CP210xVCPInstaller_x86_vx.x.x.x.exe` + +* 64 位的 Windows 操作系统,选择 `CP210xVCPInstaller_x64_vx.x.x.x.exe` + + + +#### (3) 双击执行 + + + + + +#### (4) 检查确认 COM 串口号 + +检查确认 COM 串口号,以确定串口驱动是否安装成功: + +将 Core 通过 USB Type-C 线连接电脑,打开 Windows 设备管理器,点击 `端口 (COM 和 LPT)` 以查看串口号。然后拔掉 USB 线,此时`端口 (COM 和 LPT)` 上消失的 COM 口就是该 Core 对应的 串口号。 + + + +拔掉 USB 线之后,COM 口消失 + + + + + +## 3. 安装 ESP32 的板管理 + +#### (1) 打开 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* - + -选择 `Tools`->`Board:`->`Boards Manager...`,在新弹出的对话框中,输入并搜索 `ESP32`,点击`安装` +#### (3) 选择 `工具`->`开发板:`->`开发板管理器...` - + - +#### (4) 在新弹出的对话框中,输入并搜索 `ESP32`,点击`安装` + -### Step2. 安装Arduino-M5Stack库 +## 4. 安装 M5Stack 的库 -打开 Arduino IDE, 然后选择 `Sketch`->`Include Library`->`Manage Libraries...` -搜索 `M5Stack` 并安装,如下图所示。 +#### (1) 打开 Arduino IDE, 然后选择 `项目`->`加载库`->`库管理...` - + - +#### (2) 搜索 `M5Stack` 并安装,如下图所示 -!> *如果显示下图这样,表示您需要升级Arduino-M5Stack库* + - + + +## 5. 示例 这部分是为了验证现在您是否能通过 Arduino IDE 对 M5Core 编程。 -现在,用 USB 线连接 M5Core 和 PC ,然后打开 Arduino IDE,并选择正确的串口号。这个串口号其实就是连接 M5Core 的串口号,注意不要选错啦。 +现在,用 USB 线连接 M5Core 和 PC ,然后打开 Arduino IDE,并选择正确的串口号。这个串口号其实就是连接 M5Core 的串口号,注意不要选错。 选择一个 example 例程,然后上传运行试试。 -### 1. 运行一个示例程序,比如`FactoryTest.ino` +#### (1) 运行一个示例程序,比如 `FactoryTest.ino` 选择您板子的名字,波特率和串口号: M5Stack-Core-ESP32, 921600, COM4 ( 像我现在与 M5Core 相连的串口就是 `COM4`,所以我应该选择 `COM4` ) - + -选择示例程序`FactoryTest.ino` +#### (2) 选择示例程序`FactoryTest.ino` - + -点击上传 +#### (3) 点击上传 - + -### 2. 自己尝试新建一个M5Stack程序 +#### (4) 新建一个 M5Stack 程序 打开 Arduino IDE,然后新建一个 `.ino` 后缀的文件,并且重命名它为 `my_test.ino` @@ -98,4 +157,4 @@ void loop() { 编译并上传这个程序,如果成功后,就会看到屏幕上显示"Hello World!" "M5Stack is running successfully!"啦! -?> *如果您想升级Arduino-M5Stack库的话,请移步阅读这篇文档[如何升级Arduino-M5Stack库](zh_CN/related_documents/upgrade_m5stack_lib).* \ No newline at end of file +