From aa002896571ef0d54e301db651edde25f91bcb79 Mon Sep 17 00:00:00 2001 From: LiHuashen <854410664@qq.com> Date: Tue, 9 Apr 2019 15:45:55 +0800 Subject: [PATCH] .. --- ...5stack_core_get_started_Arduino_Windows.md | 2 - .../m5stick_quick_start_with_arduino_MacOS.md | 110 ++++++++++++----- ...5stick_quick_start_with_arduino_Windows.md | 112 ++++++++++++------ .../m5stack_core_get_started_MicroPython.md | 8 -- 4 files changed, 161 insertions(+), 71 deletions(-) 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 88208e72..b3427081 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,7 +1,5 @@ # M5Core Quick Start - Arduino Win {docsify-ignore-all} - - ## Table of Contents **[1. Install Arduino IDE](#_1-install-Arduino-IDE)** diff --git a/docs/en/quick_start/m5stick/m5stick_quick_start_with_arduino_MacOS.md b/docs/en/quick_start/m5stick/m5stick_quick_start_with_arduino_MacOS.md index d8e231f0..cf56a687 100644 --- a/docs/en/quick_start/m5stick/m5stick_quick_start_with_arduino_MacOS.md +++ b/docs/en/quick_start/m5stick/m5stick_quick_start_with_arduino_MacOS.md @@ -8,73 +8,129 @@ -## Text Tutorial +## Table of Contents -1. [Setting Environment](#setting-environment) +**[1. Install Arduino IDE](#_1-install-Arduino-IDE)** - - [Step1. Install Arduino IDE](#step1-install-arduino-ide) +**[2. Install USB to Serial Driver](#_2-Install-USB-to-Serial-Driver)** - - [Step2. ESP32 Board Support](#step2-esp32-board-support) +**[3. Install ESP32 Boards Manager](#_3-Install-ESP32-Boards-Manager)** - - [Step3. Install M5Stack Lib](#step3-install-m5stack-lib) +**[4. Install M5Stack Library](#_4-Install-M5Stack-Library)** - - [Step4. Install U8g2 library](#Step4-Install-U8g2-library) +**[5. Install U8g2 Library](#_5-Install-U8g2-Library)** -2. [Example](#example) +**[6. Example](#_6-Example)** -## Setting Environment +## 1. Install Arduino IDE -### Step1. Install `Arduino IDE` + -First, if Arudino IDE is not installed, install it. It's *download address* is https://www.arduino.cc/en/Main/Software +Open your browser, enter the official website of Arduino https://www.arduino.cc/en/Main/Software + +#### (1) click `Mac OS X` for downloading `Arduino IDE` -### Step2. ESP32 Board Support +#### (2) click `JUST DOWNLOAD` -Open Arduino IDE, click `Arduino`->`Peferences`->`Settings` + + +#### (3) Once the Arduino IDE is downloaded, you can double-click it to open it + + + +## 2. Install USB to Serial Driver + +Open your browser, enter the official website of M5Stack https://m5stack.com/download + +#### (1) click `Mac` for downloading this installation package and then unzip this package + + + +#### (2) After unzipped this package, double click the disk image `SiLabsUSBDriverDisk.dmg` for installing + + + + + + + + + + + + + + + + + + + + + +#### (3) Check the serial port number `/dev/tty.SLAB_USBtoUART` + +Comfirm if the USB to Serial Driver was successfully installed already: + +Open `Terminal`, connect `M5Core` with PC through USB Type-C cable, and execute the following command for viewing serial port list. + + + + + +Disconnect M5Core device, and execute the just executed command to verify which port disappears from the list. The disappearing COM port is the serial port name corresponding to M5Core. + + + +Now, the serial port name is `tty.SLAB_USBtoUART` + +## 3. Install ESP32 Boards Manager + +#### (1) Open IDE, click `File`->`Peferences`->`Settings` -Copy the following last ESP32 Board Manager URL to this option `Additional Boards Manager URLs: ` +#### (2) Copy the following ESP32 Boards Manager url to `Additional Boards Manager URLs:` -*NOW, last ESP32 board manager URL is https://dl.espressif.com/dl/package_esp32_index.json* +*ESP32 Boards Manager url: https://dl.espressif.com/dl/package_esp32_index.json* -Confirm OK and click `Tools`->`Board:`->`Boards Manager...` for installing esp32 - -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` + -### Step3. Install M5Stack Lib +## 4. Install M5Stack Library -Start up Arduino IDE, then Select `Sketch`->`Include Library`->`Manage Libraries...` +#### (1) Open Arduino IDE, then Select `Sketch`->`Include Library`->`Manage Libraries...` -Type `M5Stack` into the search box, search it and install. + - +#### (2) Search `M5Stack` and install it - + -### Step4. Install U8g2 Library +## 5. Install U8g2 Library -Open Arduino IDE, click `Sketch`->`Include Library`->`Manage Libraries...`, search `U8g2` for installing. +#### (1) Open Arduino IDE, then Select `Sketch`->`Include Library`->`Manage Libraries...`, search `M5Stack` and install it -## Example +## 6. Example The USB cable connects to [M5Stick built in MPU9250](https://ae01.alicdn.com/kf/HTB1pICNXznuK1RkSmFPq6AuzFXa1.jpg), then select your serial port which is connected the M5Stick. Select a demo example, compile and upload -### 1. Select your board and the serial port +#### (1) Select your board and the serial port Start up Arduino IDE, and click `Tools -> Boards -> M5Stack-Core-ESP32` to select your board @@ -82,7 +138,7 @@ Click `Tools -> Ports ->` to select the serial port which is connected with M5St -### 2. Select an example +#### (2) Select an example Click `File-> Examples`. Here are some test programs in `M5Stack`->`Stick` diff --git a/docs/en/quick_start/m5stick/m5stick_quick_start_with_arduino_Windows.md b/docs/en/quick_start/m5stick/m5stick_quick_start_with_arduino_Windows.md index 75ada4b0..cae1f8fb 100644 --- a/docs/en/quick_start/m5stick/m5stick_quick_start_with_arduino_Windows.md +++ b/docs/en/quick_start/m5stick/m5stick_quick_start_with_arduino_Windows.md @@ -1,89 +1,133 @@ # M5Stick Quick Start - Arduino Win {docsify-ignore-all} - - ## Table of Contents -1. [Setting Environment](#setting-environment) +**[1. Install Arduino IDE](#_1-install-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)** - - [Step3. Install U8g2 library](#Step3-Install-U8g2-library) +**[4. Install M5Stack Library](#_4-Install-M5Stack-Library)** -2. [Example](#example) +**[5. Install U8g2 Library](#_5-Install-U8g2-Library)** -## 1. Setting Environment +**[6. Example](#_6-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://m5stack.com/download + +#### (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* + - +## 5. Install U8g2 Library -### Step3. Install U8g2 library +#### (1) Open Arduino IDE, then Select `Sketch`->`Include Library`->`Manage Libraries...`, search `M5Stack` and install it -If you have installed `U8g2`, then just run and upload your m5stick's poject. -If not, then open Arduino IDE, and click `Sketch`->`Include Library`->`Manage Libraries...` for installing `U8g2` library + -
- -
- -## Example +## 6. Example This section for verifying whether you can program with Arduino or not. Now, The USB cable connects to [M5Stick built in MPU9250](https://ae01.alicdn.com/kf/HTB1pICNXznuK1RkSmFPq6AuzFXa1.jpg), then select your serial port which is connected the M5Stick. Select a demo example, compile and upload -### 1. Execute a example likes `FactoryTest.ino` +#### (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`) -Then select an example likes `M5Stack` -> `Stick` -> `FactoryTest.ino` +#### (2) Then select an example likes `FactoryTest.ino` + +Then select an example likes M5Stack -> Stick -> FactoryTest.ino -Upload it +#### (3) Upload it **Phenomenon: After pressing button A, the screen displays "Hello World! Exist"** **The button located at the bottom left of stick is the power button, click to turn it on, press again to reset when running. If you want to let stick enter deep sleep status, you need to press the power button twice quickly.** - -?> *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 diff --git a/docs/zh_CN/quick_start/m5core/m5stack_core_get_started_MicroPython.md b/docs/zh_CN/quick_start/m5core/m5stack_core_get_started_MicroPython.md index 26a62b8c..1de5115d 100644 --- a/docs/zh_CN/quick_start/m5core/m5stack_core_get_started_MicroPython.md +++ b/docs/zh_CN/quick_start/m5core/m5stack_core_get_started_MicroPython.md @@ -2,14 +2,6 @@ :clapper: **[视频教程](#相关视频)**      :memo: **[文本教程](#目录)** - - - - ## 目录 **[1. 安装串口驱动](#_1-安装串口驱动)**