Merge pull request #21 from m5stack/dev-readthedocs

optimized get-started
This commit is contained in:
LiHuashen
2018-09-27 17:51:09 +08:00
committed by GitHub
17 changed files with 49 additions and 49 deletions
Binary file not shown.

After

Width:  |  Height:  |  Size: 70 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 26 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 2.8 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 95 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 30 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 8.0 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 47 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 66 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 158 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 14 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 187 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 20 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 71 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 13 KiB

@@ -0,0 +1,8 @@
cd C:\Program Files (x86)\Arduino\hardware
md espressif
cd espressif
git clone --recursive https://github.com/espressif/arduino-esp32.git esp32
cd esp32
cd tools
start get.exe
start cmd
@@ -14,68 +14,61 @@
4. [Example](#example)
***Note:***
*If you want to upgrade the M5Stack Lib, please view this article [upgrade M5Stack Lib](www.m5stack.com).*
### Setting Environment
*Before setting the development environment, we suggest you confirm whether the USB driver has installed. If not, please visit this link `establish serial connection`.*
*Before setting the development environment, we suggest you confirm whether the USB driver has installed. If not, please view this article [establish serial connection](https://github.com/m5stack/m5stack-documentation/blob/master/en/get-started/establish_serial_connection.md).*
#### 1. Install `Arduino IDE`
#### 1. Install `Git`
If you has installed `Git`, please following next setp 2 straight.Otherwise, download the client of [Git](https://git-scm.com/download/win) and install it.
#### 2. Install `Arduino IDE`
*download address*
https://www.arduino.cc/en/Main/Software
![image](../../_static/screenshots/arduino_cc_package.png)
![image](../../_static/getting_started_pics/m5stack_core/arduino_cc_package.png)
Double click to install Arduino IDE
![image](../../_static/getting_started_pics/m5stack_core/select_arduino_install_path.png)
![image](../../_static/getting_started_pics/m5stack_core/install_arduino_2.png)
modified the path of Arduino as `D:\Program Files` as shown below
#### 3. Download Arduino-ESP32 Support
![image](../../_static/screenshots/select_arduino_install_path.png)
Download the batch file [download_arduino_esp32_support.bat](https://github.com/m5stack/m5stack-documentation/blob/master/en/get-started/download_arduino_esp32_support.bat), and execte it as Administrator.
![image](../../_static/getting_started_pics/m5stack_core/execute_batch_file.png)
Now my path of Arduino is `D:\Program Files\Arduino`
Then this a new window will appear as shown below.
Please waiting for cloning...
![image](../../_static/screenshots/arduino_path.png)
![image](../../_static/getting_started_pics/m5stack_core/execute_batch_file_for_downloading_arduino_esp32.png)
#### 2. Download Toolchain
When completed, it will show below.
Now my path of Arduino is `D:\Program Files\Arduino`
Enter the path `D:\Program Files\Arduino\hareware` via the terminal of Windows
Execute the following commands on the terminal of Windows
> * new a directory named `espressif`, then enter this directory
mkdir espressif && cd espressif
![image](../../_static/screenshots/mkdir_espressif.png)
![image](../../_static/getting_started_pics/m5stack_core/download_arduino_esp32_completed.png)
> * clone `esp32 idf` at the directory named `esp32`
git clone --recursive https://github.com/espressif/arduino-esp32.git esp32
![image](../../_static/screenshots/download_idf.png)
#### 3. ESP32 Toolchain
Enter the path `D:\Program Files\arduino\hardware\espressif\esp32\tools`
double click on `get.exe`
![image](../../_static/screenshots/select_get_exe_file.png)
![image](../../_static/screenshots/download_xtensa_tools.png)
#### 4. Download the M5Stack Lib via Arduino IDE
#### 4. Download the M5Stack Lib
Open Arduino IDE, then Select `Sketch`->`Include Library`->`Manage Libraries...`
Search `M5Stack` and install it
![image](../../_static/screenshots/select_arduino_lib.png)
![image](../../_static/getting_started_pics/m5stack_core/install_m5stack_lib_01.png)
![image](../../_static/screenshots/download_m5stack_lib.png)
![image](../../_static/getting_started_pics/m5stack_core/install_m5stack_lib_02.png)
***Note:***
*As shown below, it means you need update*
![image](../../_static/getting_started_pics/m5stack_core/update_m5stack_lib.png)
### Example
@@ -83,19 +76,21 @@ Search `M5Stack` and install it
The USB cable connects to M5Stack Core, then select your serial port which is connected M5Stack Core.
Select a demo example, compile and upload
#### 1. Open a example likes `FactoryTest.ino`
#### 1. Execute a example likes `FactoryTest.ino`
![image](../../_static/screenshots/select_demo.png)
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`)
![image](../../_static/getting_started_pics/m5stack_core/select_board_baudrate_serial_port.png)
Then select an example likes `FactoryTest.ino`
Comfire your board name, baudrate, the specified serial port: M5Stack-Core-ESP32、921600、COM3
![image](../../_static/getting_started_pics/m5stack_core/select_an_example.png)
![image](../../_static/screenshots/select_board_and_com.png)
Upload it
After upload seccessfully, open the Serial Monitor
![image](../../_static/getting_started_pics/m5stack_core/arduino_upload.png)
![image](../../_static/screenshots/FactoryTest_result.png)
#### 2. New a M5Stack program
@@ -114,7 +109,7 @@ void setup(){tack
// LCD display
M5.Lcd.print("Hello World!");
M5.Lcd.print("M5Stack is running successfully!");
M5.Lcd.print("M5Stack is running successfully!");
}
// the loop routine runs over and over again forever
@@ -124,5 +119,3 @@ void loop() {
```
compile it and upload, the M5Stack screen will show "Hello World!" "M5Stack is running successfully!"
@@ -17,5 +17,4 @@ FEATURES
DOCUMENTS
---------
- `GitHub <https://github.com/m5stack/M5GO>`__
- `Purchase <https://www.aliexpress.com/store/3226069?spm=2114.search0104.3.5.66051a4dlpB2ti>`_