diff --git a/docs/assets/img/getting_started_pics/how_to_burn_firmware/M5burner_firmware_download_process_01.jpg b/docs/assets/img/getting_started_pics/how_to_burn_firmware/M5burner_firmware_download_process_01.jpg new file mode 100644 index 00000000..24819ab1 Binary files /dev/null and b/docs/assets/img/getting_started_pics/how_to_burn_firmware/M5burner_firmware_download_process_01.jpg differ diff --git a/docs/assets/img/getting_started_pics/how_to_burn_firmware/m5buner_choose_firmware_stickc_01.jpg b/docs/assets/img/getting_started_pics/how_to_burn_firmware/m5buner_choose_firmware_stickc_01.jpg new file mode 100644 index 00000000..1cff7b74 Binary files /dev/null and b/docs/assets/img/getting_started_pics/how_to_burn_firmware/m5buner_choose_firmware_stickc_01.jpg differ diff --git a/docs/assets/img/getting_started_pics/how_to_burn_firmware/m5buner_com_bandrate_01.jpg b/docs/assets/img/getting_started_pics/how_to_burn_firmware/m5buner_com_bandrate_01.jpg new file mode 100644 index 00000000..26702564 Binary files /dev/null and b/docs/assets/img/getting_started_pics/how_to_burn_firmware/m5buner_com_bandrate_01.jpg differ diff --git a/docs/assets/img/getting_started_pics/how_to_burn_firmware/m5buner_com_bandrate_02.jpg b/docs/assets/img/getting_started_pics/how_to_burn_firmware/m5buner_com_bandrate_02.jpg new file mode 100644 index 00000000..52dd9acc Binary files /dev/null and b/docs/assets/img/getting_started_pics/how_to_burn_firmware/m5buner_com_bandrate_02.jpg differ diff --git a/docs/assets/img/getting_started_pics/how_to_burn_firmware/m5burner_choose_firmware_m5stack_01.jpg b/docs/assets/img/getting_started_pics/how_to_burn_firmware/m5burner_choose_firmware_m5stack_01.jpg new file mode 100644 index 00000000..e4fa7b9e Binary files /dev/null and b/docs/assets/img/getting_started_pics/how_to_burn_firmware/m5burner_choose_firmware_m5stack_01.jpg differ diff --git a/docs/assets/img/getting_started_pics/how_to_burn_firmware/m5burner_choose_the_latest_uiflow_01.jpg b/docs/assets/img/getting_started_pics/how_to_burn_firmware/m5burner_choose_the_latest_uiflow_01.jpg new file mode 100644 index 00000000..45d60493 Binary files /dev/null and b/docs/assets/img/getting_started_pics/how_to_burn_firmware/m5burner_choose_the_latest_uiflow_01.jpg differ diff --git a/docs/assets/img/getting_started_pics/how_to_burn_firmware/m5burner_flash_finish_01.jpg b/docs/assets/img/getting_started_pics/how_to_burn_firmware/m5burner_flash_finish_01.jpg new file mode 100644 index 00000000..8d15fb6c Binary files /dev/null and b/docs/assets/img/getting_started_pics/how_to_burn_firmware/m5burner_flash_finish_01.jpg differ diff --git a/docs/assets/img/getting_started_pics/how_to_burn_firmware/m5burner_folder_01.jpg b/docs/assets/img/getting_started_pics/how_to_burn_firmware/m5burner_folder_01.jpg new file mode 100644 index 00000000..a43a4d1d Binary files /dev/null and b/docs/assets/img/getting_started_pics/how_to_burn_firmware/m5burner_folder_01.jpg differ diff --git a/docs/assets/img/getting_started_pics/m5stack_core/get_started_with_arduino_m5core/windows/download_usb_driver_all_os_01.jpg b/docs/assets/img/getting_started_pics/m5stack_core/get_started_with_arduino_m5core/windows/download_usb_driver_all_os_01.jpg new file mode 100644 index 00000000..c61e20ac Binary files /dev/null and b/docs/assets/img/getting_started_pics/m5stack_core/get_started_with_arduino_m5core/windows/download_usb_driver_all_os_01.jpg differ diff --git a/docs/assets/img/getting_started_pics/m5stickc/m5stickc_qs_mac_adn_config_01.png b/docs/assets/img/getting_started_pics/m5stickc/m5stickc_qs_mac_adn_config_01.png new file mode 100644 index 00000000..d6e7d009 Binary files /dev/null and b/docs/assets/img/getting_started_pics/m5stickc/m5stickc_qs_mac_adn_config_01.png differ diff --git a/docs/assets/img/getting_started_pics/m5stickc/m5stickc_qs_mac_search_lib_stickc_01.jpg b/docs/assets/img/getting_started_pics/m5stickc/m5stickc_qs_mac_search_lib_stickc_01.jpg new file mode 100644 index 00000000..7da371c7 Binary files /dev/null and b/docs/assets/img/getting_started_pics/m5stickc/m5stickc_qs_mac_search_lib_stickc_01.jpg differ diff --git a/docs/assets/img/getting_started_pics/m5stickc/m5stickc_qs_mac_serch_esp32_01.jpg b/docs/assets/img/getting_started_pics/m5stickc/m5stickc_qs_mac_serch_esp32_01.jpg new file mode 100644 index 00000000..9d589760 Binary files /dev/null and b/docs/assets/img/getting_started_pics/m5stickc/m5stickc_qs_mac_serch_esp32_01.jpg differ diff --git a/docs/assets/img/getting_started_pics/m5stickc/m5stickc_qs_win_adu_config_01.jpg b/docs/assets/img/getting_started_pics/m5stickc/m5stickc_qs_win_adu_config_01.jpg new file mode 100644 index 00000000..a44f1d01 Binary files /dev/null and b/docs/assets/img/getting_started_pics/m5stickc/m5stickc_qs_win_adu_config_01.jpg differ diff --git a/docs/assets/img/getting_started_pics/m5stickc/m5stickc_qs_win_select_example.jpg b/docs/assets/img/getting_started_pics/m5stickc/m5stickc_qs_win_select_example.jpg new file mode 100644 index 00000000..e484ed73 Binary files /dev/null and b/docs/assets/img/getting_started_pics/m5stickc/m5stickc_qs_win_select_example.jpg differ diff --git a/docs/assets/img/getting_started_pics/m5stickc/m5stickc_qs_win_serch_lib_stickc_01.jpg b/docs/assets/img/getting_started_pics/m5stickc/m5stickc_qs_win_serch_lib_stickc_01.jpg new file mode 100644 index 00000000..0db4af3d Binary files /dev/null and b/docs/assets/img/getting_started_pics/m5stickc/m5stickc_qs_win_serch_lib_stickc_01.jpg differ diff --git a/docs/en/module/goplus.md b/docs/en/module/goplus.md index a9e0e51b..e8c8390f 100644 --- a/docs/en/module/goplus.md +++ b/docs/en/module/goplus.md @@ -4,9 +4,8 @@ *** -:memo:**[Description](#Description)**      :electric_plug:**[Schematic](#Schematic)**      🛒**[Purchase](https://www.aliexpress.com/store/product/M5Stack-New-Arrival-GOPLUS-Module-with-MEGA328P-IR-Transmitter-and-Receiver-suit-for-ESP32-Kit/3226069_33010785963.html?spm=2114.12010615.8148356.1.a8747842tJJMRu)**      :octocat:**[Code](#Code)** +:memo:**[Description](#Description)**      :electric_plug:**[Schematic](#Schematic)**      🛒**[Purchase](https://www.aliexpress.com/store/product/M5Stack-New-Arrival-GOPLUS-Module-with-MEGA328P-IR-Transmitter-and-Receiver-suit-for-ESP32-Kit/3226069_33010785963.html?spm=2114.12010615.8148356.1.a8747842Ll7Apb)**      :octocat:**[Code](#Code)** - ## Description 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 e653d37a..10ce5bc9 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 @@ -18,29 +18,29 @@ -Open your browser, enter the official website of Arduino https://www.arduino.cc/en/Main/Software +Open up your browser, and visit Arduino official website https://www.arduino.cc/en/Main/Software -#### (1) click `Mac OS X` for downloading `Arduino IDE` +#### (1) click `Mac OS X` to download `Arduino IDE` -#### (2) click `JUST DOWNLOAD` +#### (2) click `JUST DOWNLOAD` -#### (3) Once the Arduino IDE is downloaded, you can double-click it to open it +#### (3) Once the Arduino IDE is downloaded, double-click to open it ## 2. Install USB to Serial Driver -Open your browser, enter the official website of M5Stack https://m5stack.com/download +Open up your browser, visite the official website of M5Stack https://m5stack.com/download -#### (1) click `Mac` for downloading this installation package and then unzip this package +#### (1) Navigate to `Explore` `Download`,click `CP210X Driver` `Mac` to download the installation package and then unzip it. -#### (2) After unzipped this package, double click the disk image `SiLabsUSBDriverDisk.dmg` for installing +#### (2) After unzipped this package, double click the disk image `SiLabsUSBDriverDisk.dmg` for installation @@ -64,39 +64,40 @@ Open your browser, enter the official website of M5Stack https://m5stack.com/do #### (3) Check the serial port number `/dev/tty.SLAB_USBtoUART` -Comfirm if the USB to Serial Driver was successfully installed already: +To make sure if the Driver has installed on your MAC: -Open `Terminal`, connect `M5Core` with PC through USB Type-C cable, and execute the following command for viewing serial port list. +Open `Terminal`, connect `M5Core` with your MAC through USB Type-C cable, and type in the following command to view the available serial ports 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. +Disconnect M5Core device, and type in the same command on `Terminal` to see which port disappeared from the list. +That how we identify the name of the serial device. -Now, the serial port name is `tty.SLAB_USBtoUART` +The serial device name is `tty.SLAB_USBtoUART` ## 3. Install ESP32 Boards Manager -#### (1) Open IDE, click `File`->`Peferences`->`Settings` +#### (1) Open up Arduino IDE, navigate to `File`->`Peferences`->`Settings` -#### (2) Copy the following ESP32 Boards Manager url to `Additional Boards Manager URLs:` +#### (2) Copy the following ESP32 Boards Manager url to `Additional Boards Manager URLs:` , hit `OK`. *ESP32 Boards Manager url: https://dl.espressif.com/dl/package_esp32_index.json* -#### (3) Click `Tools`->`Board:`->`Boards Manager...` +#### (3) Navigate to `Tools`->`Board:`->`Boards Manager...` -#### (4) Search `ESP32` in the new pop-up dialog, then click `Install` +#### (4) Search `ESP32` in the pop-up window, find it and click `Install` @@ -106,37 +107,38 @@ Now, the serial port name is `tty.SLAB_USBtoUART` -#### (2) 搜索 `M5Stack` 并安装,如下图所示 +#### (2) Search `M5Stack` , find it and click `Install` ## 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. +Now that everything is ready to go, you can select a demo example from the `Example` list, before that let's do some configuration on the IDE. -Select a demo example, compile and upload +Make sure you have M5Core connected to your computer via USB -#### (1) Select the correct board name and serial port name +#### (1) Select the correct board name and serial device name Open Arduino IDE, select `Tools`->`Board`->`M5Stack-Core-ESP32` for your M5Core, `Tools` -> `Ports` for serial port -#### (2) Then select an example likes `HelloWorld.ino` +#### (2) Then select an example -Select `File`->`Examples`->`M5Stack`->`Basics` +`File`->`Examples`->`M5Stack`->`Basics` -Select a example named `HelloWorld`. +Choose the example named `HelloWorld`. -Upload it, and after this program was uploaded successfully, the screen on M5Core will display "Hello World!" +#### (3) Upload it +Click `Upload`, to flash the code to the device. Once it's done, reset the M5Core, the screen on M5Core will display "Hello World!" ## Note -Although most versions of MacOS have no problem with detecting the COM port, on some newer versions of High Sierra sometimes `Slab_USBtoUART` does not appear. If this is the case, after you connect the M5 open `security and privacy` in the `system preferences` and set it to `permit`. +Most version of MacOS have no problem detecting the serial device that connected to the computer, but might have truble on High Sierra. Sometimes `SLAB_USBtoUART` fail to appear. In this case, after connected the M5,open `security and privacy` in the `system preferences` and set it to `permit`. @@ -144,11 +146,12 @@ Although most versions of MacOS have no problem with detecting the COM port, on -?> **If you want to read more the permission about the CP2104 USB driver, visit the following link please.** https://developer.apple.com/library/archive/technotes/tn2459/\_index.html +?> **If you want to know more about the CP2104 USB driver permission, visit this link.** https://developer.apple.com/library/archive/technotes/tn2459/\_index.html ## 6. Related Video -- Video tutorial for developing M5Core in Arduino +- Arduino video tutorial for M5. + Although This video is a little out of date, some webpage is not available, it still a good tutorial for beginners,and it shows the manual way of adding m5stack library and almost covered every step we have mentioned in the former steps.