diff --git a/docs/assets/img/getting_started_pics/m5stack_core/get_started_with_arduino_m5core/windows/arduino_upload.png b/docs/assets/img/getting_started_pics/m5stack_core/get_started_with_arduino_m5core/windows/arduino_upload.png index 9eb642ed..dc409670 100644 Binary files a/docs/assets/img/getting_started_pics/m5stack_core/get_started_with_arduino_m5core/windows/arduino_upload.png and b/docs/assets/img/getting_started_pics/m5stack_core/get_started_with_arduino_m5core/windows/arduino_upload.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 index 5e29f6dc..640fc8e3 100644 Binary files a/docs/assets/img/getting_started_pics/m5stack_core/get_started_with_arduino_m5core/windows/check_serial_port_01.png 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_01_cn.png b/docs/assets/img/getting_started_pics/m5stack_core/get_started_with_arduino_m5core/windows/check_serial_port_01_cn.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_cn.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_cn.png similarity index 100% rename from docs/assets/img/getting_started_pics/m5stack_core/get_started_with_arduino_m5core/windows/check_serial_port_02.png rename to docs/assets/img/getting_started_pics/m5stack_core/get_started_with_arduino_m5core/windows/check_serial_port_02_cn.png diff --git a/docs/assets/img/getting_started_pics/m5stack_core/get_started_with_arduino_m5core/windows/install_m5stack_lib_01.png b/docs/assets/img/getting_started_pics/m5stack_core/get_started_with_arduino_m5core/windows/install_m5stack_lib_01.png index f4bcba72..b21346d6 100644 Binary files a/docs/assets/img/getting_started_pics/m5stack_core/get_started_with_arduino_m5core/windows/install_m5stack_lib_01.png and b/docs/assets/img/getting_started_pics/m5stack_core/get_started_with_arduino_m5core/windows/install_m5stack_lib_01.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 45175a24..f11936c0 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_01_cn.png b/docs/assets/img/getting_started_pics/m5stack_core/get_started_with_arduino_m5core/windows/quick_start_arduino_win_01_cn.png new file mode 100644 index 00000000..45175a24 Binary files /dev/null and b/docs/assets/img/getting_started_pics/m5stack_core/get_started_with_arduino_m5core/windows/quick_start_arduino_win_01_cn.png differ diff --git a/docs/assets/img/getting_started_pics/m5stack_core/get_started_with_arduino_m5core/windows/select_an_example.png b/docs/assets/img/getting_started_pics/m5stack_core/get_started_with_arduino_m5core/windows/select_an_example.png index a98032ce..ef579b0b 100644 Binary files a/docs/assets/img/getting_started_pics/m5stack_core/get_started_with_arduino_m5core/windows/select_an_example.png and b/docs/assets/img/getting_started_pics/m5stack_core/get_started_with_arduino_m5core/windows/select_an_example.png differ diff --git a/docs/assets/img/getting_started_pics/m5stack_core/get_started_with_arduino_m5core/windows/select_board_baudrate_serial_port.png b/docs/assets/img/getting_started_pics/m5stack_core/get_started_with_arduino_m5core/windows/select_board_baudrate_serial_port.png index 34cc26fc..e927f7d5 100644 Binary files a/docs/assets/img/getting_started_pics/m5stack_core/get_started_with_arduino_m5core/windows/select_board_baudrate_serial_port.png and b/docs/assets/img/getting_started_pics/m5stack_core/get_started_with_arduino_m5core/windows/select_board_baudrate_serial_port.png differ diff --git a/docs/en/quick_start/m5core/m5stack_core_get_started_Arduino_MacOS.md b/docs/en/quick_start/m5core/m5stack_core_get_started_Arduino_MacOS.md index 9564afb2..d306a778 100644 --- a/docs/en/quick_start/m5core/m5stack_core_get_started_Arduino_MacOS.md +++ b/docs/en/quick_start/m5core/m5stack_core_get_started_Arduino_MacOS.md @@ -1,4 +1,4 @@ -# M5Core Quick Start(macOS, Arudino) {docsify-ignore-all} +# M5Core Quick Start On Arduino IDE {docsify-ignore-all} :clapper: **[Video Tutorial](#Video-Tutorial)**      :memo: **[Text Tutorial](#Text-Tutorial)** diff --git a/docs/en/quick_start/m5core/m5stack_core_get_started_Arduino_Windows.md b/docs/en/quick_start/m5core/m5stack_core_get_started_Arduino_Windows.md index 96fe55ae..41c59cb8 100644 --- a/docs/en/quick_start/m5core/m5stack_core_get_started_Arduino_Windows.md +++ b/docs/en/quick_start/m5core/m5stack_core_get_started_Arduino_Windows.md @@ -1,75 +1,128 @@ -# M5Core Quick Start(Windows, Arudino) {docsify-ignore-all} +# M5Core Quick Start {docsify-ignore-all} -?> We suggest you confirm whether the `USB driver`, `Git` and `Arduino IDE` has installed first. If not, please view this two articles [establish serial connection](/en/related_documents/establish_serial_connection) and [Install Git and Arduino IDE](/en/related_documents/how_to_install_git_and_arduino). + -## CONTENT +## Table of Contents -1. [Setting Environment](#setting-environment) +**[1. Install Arduino IDE](#_1-安装-Arduino-IDE)** - - [Step1. Download Arduino-ESP32 Support](#step1-download-arduino-esp32-support) +**[2. Install USB to Serial Driver](#_2-Install-USB-to-Serial-Driver)** - - [Step2. Download the M5Stack Lib](#step2-download-the-m5stack-lib) +**[3. Install ESP32 Boards Manager](#_3-Install-ESP32-Boards-Manager)** -2. [Example](#example) +**[4. Install M5Stack Library](#_4-Install-M5Stack-Library)** -## 1. Setting Environment +**[5. Example](#_5-Example)** -*(Only two steps to complete setting)* +### 1. Install Arduino IDE -### Step1. Download Arduino-ESP32 Support + -Open Arduino IDE, and click `File`->`Peferences`->`Settings` +Open your browser, enter the official website of Arduino https://www.arduino.cc/en/Main/Software + +#### (1) click `Windows ZIP file for non admin install` for downloading `Arduino IDE` + + + +#### (2) click `JUST DOWNLOAD` + + + +#### (3) To install IDE, double click Arduino executable file. Keep the default selection throughout this process, including the installation path is also the default. + + + + + +### 2. Install USB to Serial Driver + +Open your browser, enter the official website of M5Stack https://www.arduino.cc/en/Main/Software + +#### (1) click `Windows` for downloading this installation package and then unzip this package. + + + +#### (2) According to your Windows operating system type, select the corresponding driver installation package + +* 32-bit Windows operating system, choose `CP210xVCPInstaller_x86_vx.x.x.x.exe` + +* 64-bit Windows operating system, choose `CP210xVCPInstaller_x64_vx.x.x.x.exe` + + + +#### (3) double click the executable file for installing. + + + + + +#### (4) Check the serial port number `COMx` + +To comfirm if the USB to Serial Driver was successfully installed already, Check the list of identified COM ports in the `Windows Device Manager`: + +Connect the Core to the computer via a USB Type-C cable, open `Windows Device Manager`, click `Ports(COM & LPT)` for checking the list of identified COM ports. + +Disconnect M5Core device and connect it back, to verify which port disappears from the list and then shows back again. + + + +## 3. Install ESP32 Boards Manager + +#### (1) Open IDE, click `File`->`Peferences`->`Settings` -Input last esp32 board manager URL +#### (2) Copy the following ESP32 Boards Manager url to `Additional Boards Manager URLs:` -*Now the last board manager URL: https://dl.espressif.com/dl/package_esp32_index.json* +*ESP32 Boards Manager url: https://dl.espressif.com/dl/package_esp32_index.json* -Click `Tools`->`Board:`->`Boards Manager...`, search `ESP32` in the new pop-up dialog, then click `install` +#### (3) Click `Tools`->`Board:`->`Boards Manager...` +#### (4) Search `ESP32` in the new pop-up dialog, then click `Install` + -### Step2. Download the M5Stack Lib +## 4. Install M5Stack Library -Open Arduino IDE, then Select `Sketch`->`Include Library`->`Manage Libraries...` -Search `M5Stack` and install it +#### (1) Open Arduino IDE, then Select `Sketch`->`Include Library`->`Manage Libraries...` - + - +#### (2) Search `M5Stack` and install it -!> **Note:** *As shown below, it means you need update* + - + -This section for verifying whether you can program with Arduino or not. Now, The USB cable connects to M5Stack Core, then select your serial port which is connected M5Stack Core. +## 5. Example + +This section for verifying whether you can program with Arduino or not. Now, The USB cable connects to M5Core, then select your serial port which is connected M5Core. Select a demo example, compile and upload ### 1. Execute a example likes `FactoryTest.ino` -Select your board name, baudrate, the specified serial port: M5Stack-Core-ESP32, 921600, COM4(Now, my serial port which is connected with PC is `COM4`) +Select your board name, baudrate, the specified serial port: M5Stack-Core-ESP32, 921600, COM26(Now, my serial port which is connected with PC is `COM26`) -Then select an example likes `FactoryTest.ino` +#### (2) Then select an example likes `FactoryTest.ino` -Upload it +#### (3) Upload it -### 2. New a M5Stack program +#### (4) New a M5Stack program Open Arduino IDE, then new a `.ino` file, rename it as `my_test.ino` @@ -97,4 +150,4 @@ void loop() { compile it and upload, the M5Stack screen will show "Hello World!" "M5Stack is running successfully!" -?> *If you want to upgrade the M5Stack Lib, please view this article [upgrade M5Stack Lib](/en/related_documents/upgrade_m5stack_lib).* \ No newline at end of file + \ No newline at end of file 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 025b179a..f8694e49 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,4 +1,4 @@ -# Core 在 Arduino IDE 上开发的上手指南 {docsify-ignore-all} +# M5Core 的上手指南 {docsify-ignore-all} @@ -16,7 +16,7 @@ ### 1. 安装 Arduino IDE -*注意:如果已经安装了 IDE,请直接从[步骤 2](#_2-安装串口驱动) 开始。* + 浏览器打开 Arduino 官网 https://www.arduino.cc/en/Main/Software @@ -36,7 +36,7 @@ ### 2. 安装串口驱动 -*注意:如果已经安装了 CP21x 的串口驱动的话,请直接从[步骤 3](#_3-安装-ESP32-的板管理) 开始。* + 浏览器打开 M5Stack 官网 https://m5stack.com/download @@ -64,11 +64,11 @@ 将 Core 通过 USB Type-C 线连接电脑,打开 Windows 设备管理器,点击 `端口 (COM 和 LPT)` 以查看串口号。然后拔掉 USB 线,此时`端口 (COM 和 LPT)` 上消失的 COM 口就是该 Core 对应的 串口号。 - + 拔掉 USB 线之后,COM 口消失 - + @@ -76,7 +76,7 @@ #### (1) 打开 IDE,选择 `文件`->`首选项`->`设置` - + @@ -117,7 +117,7 @@ #### (1) 运行一个示例程序,比如 `FactoryTest.ino` -选择您板子的名字,波特率和串口号: M5Stack-Core-ESP32, 921600, COM4 ( 像我现在与 M5Core 相连的串口就是 `COM4`,所以我应该选择 `COM4` ) +选择您板子的名字,波特率和串口号: M5Stack-Core-ESP32, 921600, COM26 ( 像我现在与 M5Core 相连的串口就是 `COM26`,所以我应该选择 `COM26` ) 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 ee79cda7..09fbbee9 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 @@ -1,8 +1,8 @@ -# M5Core上手指南 {docsify-ignore-all} +# M5Core 上手指南 {docsify-ignore-all} ## 选择你需要的编程语言 -*使用Arduino/C++编程的话,选择MacOS/Windows;使用Blockly/MicroPython,选择UIFlow(Blockly/MicroPython)* +*使用 Arduino/C++ 编程的话,选择 MacOS/Windows;使用 Blockly/MicroPython,选择 UIFlow(Blockly/MicroPython)* | | ---|---|---