diff --git a/_static/getting_started_pics/m5stack_core/arduino_cc_package.png b/_static/getting_started_pics/m5stack_core/arduino_cc_package.png new file mode 100644 index 00000000..dca70cfe Binary files /dev/null and b/_static/getting_started_pics/m5stack_core/arduino_cc_package.png differ diff --git a/_static/getting_started_pics/m5stack_core/arduino_upload.png b/_static/getting_started_pics/m5stack_core/arduino_upload.png new file mode 100644 index 00000000..9eb642ed Binary files /dev/null and b/_static/getting_started_pics/m5stack_core/arduino_upload.png differ diff --git a/_static/getting_started_pics/m5stack_core/download_arduino_esp32_completed.png b/_static/getting_started_pics/m5stack_core/download_arduino_esp32_completed.png new file mode 100644 index 00000000..27773efa Binary files /dev/null and b/_static/getting_started_pics/m5stack_core/download_arduino_esp32_completed.png differ diff --git a/_static/getting_started_pics/m5stack_core/execute_batch_file.png b/_static/getting_started_pics/m5stack_core/execute_batch_file.png new file mode 100644 index 00000000..d9d7405c Binary files /dev/null and b/_static/getting_started_pics/m5stack_core/execute_batch_file.png differ diff --git a/_static/getting_started_pics/m5stack_core/execute_batch_file_for_downloading_arduino_esp32.png b/_static/getting_started_pics/m5stack_core/execute_batch_file_for_downloading_arduino_esp32.png new file mode 100644 index 00000000..c764b273 Binary files /dev/null and b/_static/getting_started_pics/m5stack_core/execute_batch_file_for_downloading_arduino_esp32.png differ diff --git a/_static/getting_started_pics/m5stack_core/install_arduino_2.png b/_static/getting_started_pics/m5stack_core/install_arduino_2.png new file mode 100644 index 00000000..106f8c3e Binary files /dev/null and b/_static/getting_started_pics/m5stack_core/install_arduino_2.png differ diff --git a/_static/getting_started_pics/m5stack_core/install_m5stack_lib_01.png b/_static/getting_started_pics/m5stack_core/install_m5stack_lib_01.png new file mode 100644 index 00000000..f4bcba72 Binary files /dev/null and b/_static/getting_started_pics/m5stack_core/install_m5stack_lib_01.png differ diff --git a/_static/getting_started_pics/m5stack_core/install_m5stack_lib_02.png b/_static/getting_started_pics/m5stack_core/install_m5stack_lib_02.png new file mode 100644 index 00000000..17c1b314 Binary files /dev/null and b/_static/getting_started_pics/m5stack_core/install_m5stack_lib_02.png differ diff --git a/_static/getting_started_pics/m5stack_core/select_an_example.png b/_static/getting_started_pics/m5stack_core/select_an_example.png new file mode 100644 index 00000000..a98032ce Binary files /dev/null and b/_static/getting_started_pics/m5stack_core/select_an_example.png differ diff --git a/_static/getting_started_pics/m5stack_core/select_arduino_install_path.png b/_static/getting_started_pics/m5stack_core/select_arduino_install_path.png new file mode 100644 index 00000000..e993a15a Binary files /dev/null and b/_static/getting_started_pics/m5stack_core/select_arduino_install_path.png differ diff --git a/_static/getting_started_pics/m5stack_core/select_board_baudrate_serial_port.png b/_static/getting_started_pics/m5stack_core/select_board_baudrate_serial_port.png new file mode 100644 index 00000000..34cc26fc Binary files /dev/null and b/_static/getting_started_pics/m5stack_core/select_board_baudrate_serial_port.png differ diff --git a/_static/getting_started_pics/m5stack_core/update_m5stack_lib.png b/_static/getting_started_pics/m5stack_core/update_m5stack_lib.png new file mode 100644 index 00000000..ef191cbc Binary files /dev/null and b/_static/getting_started_pics/m5stack_core/update_m5stack_lib.png differ diff --git a/_static/screenshots/arduino_cc_package.png b/_static/screenshots/arduino_cc_package.png deleted file mode 100644 index 4ebf5bf8..00000000 Binary files a/_static/screenshots/arduino_cc_package.png and /dev/null differ diff --git a/_static/screenshots/select_arduino_install_path.png b/_static/screenshots/select_arduino_install_path.png deleted file mode 100644 index e0e0db86..00000000 Binary files a/_static/screenshots/select_arduino_install_path.png and /dev/null differ diff --git a/en/get-started/download_arduino_esp32_support.bat b/en/get-started/download_arduino_esp32_support.bat new file mode 100644 index 00000000..7fcbaffa --- /dev/null +++ b/en/get-started/download_arduino_esp32_support.bat @@ -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 \ No newline at end of file diff --git a/en/get-started/m5stack_core_get_started_Arduino_Windows.md b/en/get-started/m5stack_core_get_started_Arduino_Windows.md index b9dccf81..cd2b65b4 100644 --- a/en/get-started/m5stack_core_get_started_Arduino_Windows.md +++ b/en/get-started/m5stack_core_get_started_Arduino_Windows.md @@ -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!" - - diff --git a/en/product-documents/units/m5go_unit_hub.rst b/en/product-documents/units/m5go_unit_hub.rst index 30920611..4dbafde9 100644 --- a/en/product-documents/units/m5go_unit_hub.rst +++ b/en/product-documents/units/m5go_unit_hub.rst @@ -17,5 +17,4 @@ FEATURES DOCUMENTS --------- -- `GitHub `__ - `Purchase `_