Merge pull request #21 from m5stack/dev-readthedocs
optimized get-started
|
After Width: | Height: | Size: 70 KiB |
|
After Width: | Height: | Size: 26 KiB |
|
After Width: | Height: | Size: 2.8 KiB |
|
After Width: | Height: | Size: 95 KiB |
|
After Width: | Height: | Size: 30 KiB |
|
After Width: | Height: | Size: 8.0 KiB |
|
After Width: | Height: | Size: 47 KiB |
|
After Width: | Height: | Size: 66 KiB |
|
After Width: | Height: | Size: 158 KiB |
|
After Width: | Height: | Size: 14 KiB |
|
After Width: | Height: | Size: 187 KiB |
|
After Width: | Height: | Size: 20 KiB |
|
Before Width: | Height: | Size: 71 KiB |
|
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
|
||||
|
||||

|
||||

|
||||
|
||||
Double click to install Arduino IDE
|
||||
|
||||

|
||||
|
||||

|
||||
|
||||
|
||||
modified the path of Arduino as `D:\Program Files` as shown below
|
||||
#### 3. Download Arduino-ESP32 Support
|
||||
|
||||

|
||||
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.
|
||||
|
||||

|
||||
|
||||
|
||||
Now my path of Arduino is `D:\Program Files\Arduino`
|
||||
Then this a new window will appear as shown below.
|
||||
Please waiting for cloning...
|
||||
|
||||

|
||||

|
||||
|
||||
|
||||
#### 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
|
||||
|
||||

|
||||

|
||||
|
||||
|
||||
> * clone `esp32 idf` at the directory named `esp32`
|
||||
|
||||
git clone --recursive https://github.com/espressif/arduino-esp32.git esp32
|
||||
|
||||

|
||||
|
||||
|
||||
|
||||
#### 3. ESP32 Toolchain
|
||||
|
||||
Enter the path `D:\Program Files\arduino\hardware\espressif\esp32\tools`
|
||||
double click on `get.exe`
|
||||
|
||||

|
||||
|
||||

|
||||
|
||||
|
||||
#### 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
|
||||
|
||||

|
||||

|
||||
|
||||

|
||||

|
||||
|
||||
***Note:***
|
||||
*As shown below, it means you need update*
|
||||
|
||||

|
||||
|
||||
|
||||
### 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`
|
||||
|
||||

|
||||
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 `FactoryTest.ino`
|
||||
|
||||
Comfire your board name, baudrate, the specified serial port: M5Stack-Core-ESP32、921600、COM3
|
||||

|
||||
|
||||

|
||||
Upload it
|
||||
|
||||
After upload seccessfully, open the Serial Monitor
|
||||

|
||||
|
||||

|
||||
|
||||
#### 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>`_
|
||||
|
||||