diff --git a/docs/assets/img/getting_started_pics/how_to_burn_firmware/download_M5Burner.png b/docs/assets/img/getting_started_pics/how_to_burn_firmware/download_M5Burner.png index f6a3d87a..99b873e1 100644 Binary files a/docs/assets/img/getting_started_pics/how_to_burn_firmware/download_M5Burner.png and b/docs/assets/img/getting_started_pics/how_to_burn_firmware/download_M5Burner.png differ diff --git a/docs/assets/img/getting_started_pics/how_to_burn_firmware/download_M5Burner_02.png b/docs/assets/img/getting_started_pics/how_to_burn_firmware/download_M5Burner_02.png index 9eb9a063..3093edae 100644 Binary files a/docs/assets/img/getting_started_pics/how_to_burn_firmware/download_M5Burner_02.png and b/docs/assets/img/getting_started_pics/how_to_burn_firmware/download_M5Burner_02.png differ diff --git a/docs/assets/img/getting_started_pics/m5stickc/m5stickc_06.png b/docs/assets/img/getting_started_pics/m5stickc/m5stickc_06.png index 28b64955..dc2605db 100644 Binary files a/docs/assets/img/getting_started_pics/m5stickc/m5stickc_06.png and b/docs/assets/img/getting_started_pics/m5stickc/m5stickc_06.png differ diff --git a/docs/assets/img/getting_started_pics/m5stickc/qs_uiflow/qs_uiflow_01.png b/docs/assets/img/getting_started_pics/m5stickc/qs_uiflow/qs_uiflow_01.png new file mode 100644 index 00000000..bf785c85 Binary files /dev/null and b/docs/assets/img/getting_started_pics/m5stickc/qs_uiflow/qs_uiflow_01.png differ diff --git a/docs/assets/img/getting_started_pics/m5stickc/qs_uiflow/qs_uiflow_02.png b/docs/assets/img/getting_started_pics/m5stickc/qs_uiflow/qs_uiflow_02.png new file mode 100644 index 00000000..555ec598 Binary files /dev/null and b/docs/assets/img/getting_started_pics/m5stickc/qs_uiflow/qs_uiflow_02.png differ diff --git a/docs/en/qs.md b/docs/en/qs.md index b568e88a..6cb95726 100644 --- a/docs/en/qs.md +++ b/docs/en/qs.md @@ -27,7 +27,7 @@ Arduino-Mac / Arduino-Win / UIFlow Arduino-Mac / Arduino-Win / UIFlow - Arduino-Win + Arduino-Win 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 6e392cc0..5159fd8f 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 @@ -1,4 +1,4 @@ -# M5Core Quick Start {docsify-ignore-all} +# M5Core Quick Start - Arduino Mac {docsify-ignore-all} :clapper: **[Video Tutorial](#Video-Tutorial)**      :memo: **[Text Tutorial](#Table-of-Contents)** 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 cd4ce7ab..88208e72 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,4 +1,4 @@ -# M5Core Quick Start {docsify-ignore-all} +# M5Core Quick Start - Arduino Win {docsify-ignore-all} diff --git a/docs/en/quick_start/m5core/m5stack_core_get_started_MicroPython.md b/docs/en/quick_start/m5core/m5stack_core_get_started_MicroPython.md index 0f1c1495..66928d13 100644 --- a/docs/en/quick_start/m5core/m5stack_core_get_started_MicroPython.md +++ b/docs/en/quick_start/m5core/m5stack_core_get_started_MicroPython.md @@ -1,4 +1,4 @@ -# UIFlow Quick Start(Blockly/MicroPython) {docsify-ignore-all} +# M5Core Quick Start - UIFlow {docsify-ignore-all} :clapper: **[Video Tutorial](#Video-Tutorial)**      :memo: **[Text Tutorial](#Table-of-Contents)** diff --git a/docs/en/quick_start/m5core/m5stack_core_get_started_MicroPython_m5cloud.md b/docs/en/quick_start/m5core/m5stack_core_get_started_MicroPython_m5cloud.md index 196b6f4b..396a540c 100644 --- a/docs/en/quick_start/m5core/m5stack_core_get_started_MicroPython_m5cloud.md +++ b/docs/en/quick_start/m5core/m5stack_core_get_started_MicroPython_m5cloud.md @@ -1,4 +1,4 @@ -# M5Cloud Quick Start(MicroPython) {docsify-ignore-all} +# M5Core Quick Start - M5Cloud {docsify-ignore-all} ?> If it's first time to use M5Core or you want to change the networkable AP that means the Core can't access [http://cloud.m5stack.com](http://cloud.m5stack.com), you need visit this article for setting wifi [How to connect wifi using Core with M5Cloud](/en/related_documents/how_to_connect_wifi_using_core_with_m5cloud). 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 e7541683..d8e231f0 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 @@ -1,4 +1,4 @@ -# M5Stick Quick Start for Arduino {docsify-ignore-all} +# M5Stick Quick Start - Arduino Mac {docsify-ignore-all} 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 932ad501..2fe7cd82 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,4 +1,4 @@ -# M5Stick Quick Start {docsify-ignore-all} +# M5Stick Quick Start - Arduino Win {docsify-ignore-all} diff --git a/docs/en/quick_start/m5stick/m5stick_quick_start_with_uiflow.md b/docs/en/quick_start/m5stick/m5stick_quick_start_with_uiflow.md index 996eb8d3..3570d677 100644 --- a/docs/en/quick_start/m5stick/m5stick_quick_start_with_uiflow.md +++ b/docs/en/quick_start/m5stick/m5stick_quick_start_with_uiflow.md @@ -1,4 +1,4 @@ -# M5Stick Quick Start for UIFlow {docsify-ignore-all} +# M5Stick Quick Start - UIFlow {docsify-ignore-all} diff --git a/docs/en/quick_start/m5stickc/m5stickc_quick_start_with_arduino_MacOS.md b/docs/en/quick_start/m5stickc/m5stickc_quick_start_with_arduino_MacOS.md new file mode 100644 index 00000000..d8e231f0 --- /dev/null +++ b/docs/en/quick_start/m5stickc/m5stickc_quick_start_with_arduino_MacOS.md @@ -0,0 +1,107 @@ +# M5Stick Quick Start - Arduino Mac {docsify-ignore-all} + + + + + + + + + +## Text Tutorial + +1. [Setting Environment](#setting-environment) + + - [Step1. Install Arduino IDE](#step1-install-arduino-ide) + + - [Step2. ESP32 Board Support](#step2-esp32-board-support) + + - [Step3. Install M5Stack Lib](#step3-install-m5stack-lib) + + - [Step4. Install U8g2 library](#Step4-Install-U8g2-library) + +2. [Example](#example) + +## Setting Environment + +### 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 + + + +### Step2. ESP32 Board Support + +Open Arduino IDE, click `Arduino`->`Peferences`->`Settings` + + + + + +Copy the following last ESP32 Board Manager URL to this option `Additional Boards Manager URLs: ` + +*NOW, last ESP32 board manager URL is 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` + + + + + +### Step3. Install M5Stack Lib + +Start up Arduino IDE, then Select `Sketch`->`Include Library`->`Manage Libraries...` + +Type `M5Stack` into the search box, search it and install. + + + + + +### Step4. Install U8g2 Library + +Open Arduino IDE, click `Sketch`->`Include Library`->`Manage Libraries...`, search `U8g2` for installing. + + + +## 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 + +Start up Arduino IDE, and click `Tools -> Boards -> M5Stack-Core-ESP32` to select your board + +Click `Tools -> Ports ->` to select the serial port which is connected with M5Stick + + + +### 2. Select an example + +Click `File-> Examples`. Here are some test programs in `M5Stack`->`Stick` + +Try to open a sketch called `FactoryTest` inside Basics. + + + +Compile it and upload, the M5Stick screen will show "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.** + +## 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`. + + + + + + + +?> **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 diff --git a/docs/en/quick_start/m5stickc/m5stickc_quick_start_with_arduino_Windows.md b/docs/en/quick_start/m5stickc/m5stickc_quick_start_with_arduino_Windows.md index d93c0909..285acfcb 100644 --- a/docs/en/quick_start/m5stickc/m5stickc_quick_start_with_arduino_Windows.md +++ b/docs/en/quick_start/m5stickc/m5stickc_quick_start_with_arduino_Windows.md @@ -1,4 +1,4 @@ -# M5StickC Quick Start {docsify-ignore-all} +# M5StickC Quick Start - Arduino Win {docsify-ignore-all} diff --git a/docs/en/quick_start/m5stickc/m5stickc_quick_start_with_uiflow.md b/docs/en/quick_start/m5stickc/m5stickc_quick_start_with_uiflow.md new file mode 100644 index 00000000..b691ac5d --- /dev/null +++ b/docs/en/quick_start/m5stickc/m5stickc_quick_start_with_uiflow.md @@ -0,0 +1,120 @@ +# M5StickC Quick Start - UIFlow {docsify-ignore-all} + + + +**[1. Burn UIFlow Firmware](#_1-Burn-UIFlow-Firmware)** + +**[2. Wi-Fi Setting](#_2-Wi-Fi-Setting)** + +**[3. Program](#_3-Program)** + +## 1. Burn UIFlow Firmware + +#### (1) Download M5Burner + +Access [M5Stack Official Website](http://www.m5stack.com/download), and download M5Burner + +Screenshot of coverpage + +Screenshot of coverpage + +#### (2) Burn the firmware + +Connect M5Core to the computer via the USB Type-C cable, unzip the M5Burner archive you just downloaded, and double-click the executable `M5Burner.exe` + +Select the `serial number` and **`115200 baud rate`** that the board is connected to the computer, and select the latest version of UIFlow firmware for M5StickC + +Click `Burn` for downloading UIFlow firmware + + + +The following interface appears, indicating that the firmware is successfully burned. + + + + + + +## Update firmware + +>Update the stick to the latest firmware version for a better experience. + +*If you need to update or burn firmware by yourself, please click [here](en/related_documents/how_to_burn_firmware)* + + + +## Power on + +>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. + +>In addition to the power button, the stick also provides another button `A` for you to program. + + + +## Setting environment + +### Step1. Setting WIFI + +When you turn on stick for the first time, it will enter the configuration page by default. And it's OLED screen will display it's own **AP name(SSID)** and **ap-setting address(192.168.4.1)**. + +At this time, you can use the mobile phone to connect to this hotspot. After the connection is successful, use the browser to enter the network configuration address, enter the WIFI configuration page, enter the personal WIFI information, click `Save`, and wait for the connection to succeed. + + + +## Step2. Setting API Key + +After the WIFI is successfully configured, stick will automatically reset and enter the programming mode. When the screen displays “Done”, it indicates that the network has been successfully connected. Access our WebIDE [flow.m5stack.com](http://flow.m5stack.com/) for programming. + +Click the `Settings` button at the top right of the [WebIDE](http://flow.m5stack.com/), enter the **API Key** displayed on the stick screen and click `Save`. Now, start programming. + + + + + +## Supplement + +>If clicked `Download`, stick will run the last downloaded program straight. In this case, if you want to enter programming mode, you need to press `A` button once the stick screen disappears `UIFlow` logo after it was reset. + + + +>If you want to configurate a new wifi for stick, you need to press and hold `A` button for more than one second and then release once the stick screen disappears `UIFlow` logo after it was reset. + +## Example + +>Click and download [example](https://github.com/m5stack/M5-ProductExampleCodes/tree/master/Core/M5Stick/UIFlow). And open this example code in UIFlow, then run it. Program phenomenon: White squares will scroll back and forth on the screen. + + + +### Note + +>the resolution of stick screen is **64x128**, so if you want to drag a graph at [WebIDE](http://flow.m5stack.com/) to display on stick screen, it's better for you to drag it within a certain range shown as following figure.(Currently only supports the display of rectangular patterns, as well as labels.) + + + +## Related Video + +**UIFlow introduce** + + + +**UIFlow quick start (Mac & Linux)** + + \ No newline at end of file