diff --git a/docs/assets/img/quick_start/coreink/uiflow_01.webp b/docs/assets/img/quick_start/coreink/uiflow_01.webp new file mode 100644 index 00000000..4ea7cb32 Binary files /dev/null and b/docs/assets/img/quick_start/coreink/uiflow_01.webp differ diff --git a/docs/assets/img/quick_start/coreink/uiflow_02.webp b/docs/assets/img/quick_start/coreink/uiflow_02.webp new file mode 100644 index 00000000..3178970c Binary files /dev/null and b/docs/assets/img/quick_start/coreink/uiflow_02.webp differ diff --git a/docs/assets/img/quick_start/coreink/uiflow_03.webp b/docs/assets/img/quick_start/coreink/uiflow_03.webp new file mode 100644 index 00000000..989979ad Binary files /dev/null and b/docs/assets/img/quick_start/coreink/uiflow_03.webp differ diff --git a/docs/assets/img/quick_start/coreink/uiflow_04.webp b/docs/assets/img/quick_start/coreink/uiflow_04.webp new file mode 100644 index 00000000..174ed23f Binary files /dev/null and b/docs/assets/img/quick_start/coreink/uiflow_04.webp differ diff --git a/docs/assets/img/quick_start/coreink/uiflow_05.webp b/docs/assets/img/quick_start/coreink/uiflow_05.webp new file mode 100644 index 00000000..e55e4505 Binary files /dev/null and b/docs/assets/img/quick_start/coreink/uiflow_05.webp differ diff --git a/docs/assets/img/quick_start/coreink/uiflow_06.webp b/docs/assets/img/quick_start/coreink/uiflow_06.webp new file mode 100644 index 00000000..d63640ce Binary files /dev/null and b/docs/assets/img/quick_start/coreink/uiflow_06.webp differ diff --git a/docs/assets/img/quick_start/coreink/uiflow_07.webp b/docs/assets/img/quick_start/coreink/uiflow_07.webp new file mode 100644 index 00000000..174ed23f Binary files /dev/null and b/docs/assets/img/quick_start/coreink/uiflow_07.webp differ diff --git a/docs/en/arduino/arduino_core2_development.md b/docs/en/arduino/arduino_core2_development.md index 19de0b3e..4f6fd655 100644 --- a/docs/en/arduino/arduino_core2_development.md +++ b/docs/en/arduino/arduino_core2_development.md @@ -1,4 +1,4 @@ -# Arduino IDE Development{docsify-ignore-all} +# Arduino IDE Development ## USB Driver diff --git a/docs/en/core/coreink.md b/docs/en/core/coreink.md index 224ac0f8..e7d98bf0 100644 --- a/docs/en/core/coreink.md +++ b/docs/en/core/coreink.md @@ -9,6 +9,7 @@ view the corresponding tutorial&quick-Start. Arduino +UIFlow ## Description diff --git a/docs/en/quick_start/coreink/quick_start_uiflow.md b/docs/en/quick_start/coreink/quick_start_uiflow.md new file mode 100644 index 00000000..ea754aec --- /dev/null +++ b/docs/en/quick_start/coreink/quick_start_uiflow.md @@ -0,0 +1,138 @@ +# UIFlow Quick Start + +?>This tutorial is for CoreInk + +## USB Driver + +>Before the program is burned, CoreInk users, please click the button below to download the corresponding CP210X driver compressed package according to your operating system. After decompressing the compressed package, select the installation package corresponding to the number of operating systems to install. + +__Download CP210X USB Driver__ + +
+

+ + + Windows10 + +

+ +

+ + + MacOS + +

+ +

+ + + Linux + +

+
+ +> + + +## Burning tool + +>Please click the button below to download the corresponding M5Burner firmware burning tool according to the operating system you are using. Unzip and open the application. + +
+

+ + + Windows10 + +

+ +

+ + + MacOS + +

+ +

+ + + Linux + +

+
+ + + +?>Note: After installation for MacOS users, please put the application into the Application folder, as shown in the figure below. + +> + +?>Note: For Linux users, please switch to the decompressed file path and run `./M5Burner` in the terminal to run the application. + +## Firmware burning + +>1. Double-click to open the Burner burning tool, ①Select the corresponding device type `CoreInk` in the left menu, select the firmware version you need, and click the download button to download. + + + +>2. Then connect the M5 device to the computer through the Type-C data cable, select the corresponding COM port, the baud rate can use the default configuration in M5Burner, click "Burn" to start burning, and fill in WIFI when burning Configuration information. + + + +>3. When the burning log prompts `Burn Successfully`, it means that the firmware has been burned. + + + +?>When burning for the first time or the firmware program runs abnormally, you can click "Erase" in the upper right corner to erase the flash memory. In the subsequent firmware update, there is no need to erase again, otherwise the saved Wi-Fi information will be deleted and refreshed API Key. + +## Configure WIFI + +>UIFlow provides offline and web version programmers. When using web version of UIFlow, we need to configure WiFi connection for the device. The following introduces two ways to configure WiFi connection for the device (burning configuration and AP hotspot configuration). + +### Burn and configure WiFi (recommended) + +?>M5Burner supports the pre-burning configuration of WiFi connection. Users only need to fill in the WiFi information into the WiFi configuration box before the firmware is burned. The filled WiFi information will be burned and saved to the M5 device along with the firmware, as shown in the tutorial above . + +### AP hotspot configuration WiFi + +>1. Press and hold the power button on the right side of the device for 2s to turn it on. When the UIFlow Logo appears on the screen, wait for it to enter the main page and use the dial switch to select the "Setup" option. Dial down to switch to the config Wi-Fi option and press the dial switch inward, and the device will automatically restart. Secelt Wi-Fi is the last connected WiFi. After the device jumps, the WiFi Config page will be displayed. Follow the prompts to connect to the SSID hotspot through the WiFi of the mobile phone or computer, open the browser to access __192.168.4.1__, and enter the WiFi information in the pop-up page to configure the network successfully. After the configuration is successful, the device will automatically restart. And enter programming mode。 + + + +?>Note: Special characters such as "space" are not allowed in the configured WiFi information. + + + + +## Network programming mode and API KEY + +#### Enter network programming mode + +?>Network programming mode is a docking mode between M5 device and UIFlow web programming platform, the screen will display the current network connection status of the device. When the WiFi and cloud connection indicator in the upper left corner of the page does not show `x`, it means that you can receive program pushes at any time. By default, after the first WiFi network configuration is successful, the device will automatically restart and enter the network programming mode. If you do not know how to re-enter the programming mode after running other applications, you can refer to the following operations. + +>After booting, after the menu appears on the screen, quickly press the Flow button in the middle of the screen to enter the API KEY page, and use a computer browser to visit [flow.m5stack.com](http://flow.m5stack.com/) to enter the UIFlow programming page. + + + +#### API KEY pairing + +>API KEY is the communication credential when M5 device uses UIFlow web programming. By configuring the corresponding API KEY on the UIFlow side, the program can be pushed for the specified device. Users need to visit [flow.m5stack.com](http://flow.m5stack.com/) in the computer browser to enter the UIFlow programming page, click the setting button in the menu bar at the upper right corner of the page, and enter the API on the corresponding device Key, select the device type to be used, click OK to save, and wait for the prompt that the connection is successful. + + + +## Hello M5 + +>After completing the above steps, you can start programming with UIFlow. (1. Place the label 2. Add the label block. 3 Click the run button in the upper right corner) + + + +## Desktop IDE + +>When using UIFlow Desktop IDE, you need to switch the CoreInk device to USB mode. After starting the device, enter the `Setup` page for configuration + + + + diff --git a/docs/en/quick_start/m5paper/quick_start_arduino.md b/docs/en/quick_start/m5paper/quick_start_arduino.md index f136aa17..2af363f1 100644 --- a/docs/en/quick_start/m5paper/quick_start_arduino.md +++ b/docs/en/quick_start/m5paper/quick_start_arduino.md @@ -1,4 +1,4 @@ -# Arduino IDE 环境搭建 +# Arduino IDE Development ## USB Driver diff --git a/docs/en/quick_start/timer_cam/quick_start_arduino.md b/docs/en/quick_start/timer_cam/quick_start_arduino.md index eb726191..6a397b9c 100644 --- a/docs/en/quick_start/timer_cam/quick_start_arduino.md +++ b/docs/en/quick_start/timer_cam/quick_start_arduino.md @@ -1,4 +1,4 @@ -# Arduino IDE Development{docsify-ignore-all} +# Arduino IDE Development ## Arduino-IDE diff --git a/docs/zh_CN/arduino/arduino_core2_development.md b/docs/zh_CN/arduino/arduino_core2_development.md index c1b070cc..bb9b1c09 100644 --- a/docs/zh_CN/arduino/arduino_core2_development.md +++ b/docs/zh_CN/arduino/arduino_core2_development.md @@ -1,4 +1,4 @@ -# Arduino IDE 环境搭建{docsify-ignore-all} +# Arduino IDE 环境搭建 ## 驱动安装 diff --git a/docs/zh_CN/core/coreink.md b/docs/zh_CN/core/coreink.md index c533105d..dacf05e6 100644 --- a/docs/zh_CN/core/coreink.md +++ b/docs/zh_CN/core/coreink.md @@ -9,6 +9,7 @@ 查看教程&快速上手。 Arduino +UIFlow ## 描述 diff --git a/docs/zh_CN/quick_start/coreink/quick_start_arduino.md b/docs/zh_CN/quick_start/coreink/quick_start_arduino.md index fbf60f88..331bddda 100644 --- a/docs/zh_CN/quick_start/coreink/quick_start_arduino.md +++ b/docs/zh_CN/quick_start/coreink/quick_start_arduino.md @@ -1,5 +1,40 @@ # Arduino IDE 环境搭建 +## 驱动安装 + +>程序烧录前,用户请根据您使用的操作系统,点击下方按钮下载相应的CP210X驱动程序压缩包.在解压压缩包后,选择对应操作系统位数的安装包进行安装。 + +?> 对于Mac OS,在安装之前确保系统偏好设置->安全性和隐私->通用,并允许从App Store和被认可的开发者 + +> + +* __下载CP2104驱动程序__ + +
+

+ + + Windows10 + +

+ +

+ + + MacOS + +

+ +

+ + + Linux + +

+
+ +> + ## Arduino-IDE >[点击此处访问 Arduino 官网](https://www.arduino.cc/en/Main/Software),选择对应自己操作系统的安装包进行下载. diff --git a/docs/zh_CN/quick_start/coreink/quick_start_uiflow.md b/docs/zh_CN/quick_start/coreink/quick_start_uiflow.md new file mode 100644 index 00000000..604b3061 --- /dev/null +++ b/docs/zh_CN/quick_start/coreink/quick_start_uiflow.md @@ -0,0 +1,142 @@ +# UIFlow 快速上手 + +?>本教程适用于CoreInk + +## 驱动安装 + +>程序烧录前,CoreInk用户请根据您使用的操作系统,点击下方按钮下载相应的CP210X驱动程序压缩包.在解压压缩包后,选择对应操作系统位数的安装包进行安装。 + +__下载CP210X驱动程序__ + +
+

+ + + Windows10 + +

+ +

+ + + MacOS + +

+ +

+ + + Linux + +

+
+ +> + + +## 烧录工具 + +>请根据您所使用的操作系统,点击下方按钮下载相应的M5Burner固件烧录工具.解压打开应用程序。 + +
+

+ + + Windows10 + +

+ +

+ + + MacOS + +

+ +

+ + + Linux + +

+
+ + + +?>注意:MacOS用户安装完成后请将应用放入Application文件夹内,如下图所示。 + +> + +?>注意:Linux用户请切换至解压文件路径下,在终端中运行`./M5Burner`, 运行应用。 + +## 固件烧录 + +>1.双击打开Burner烧录工具,①在左侧菜单中选择对应的设备类型`CoreInk`,选择你所需要的固件版本,点击下载按钮进行下载。 + + + +>2.然后将M5设备通过Type-C数据线连接到电脑,选择对应的COM口,波特率可使用M5Burner中的默认配置,点击"Burn"开始烧录,在烧录时可填入WIFI配置信息。 + + + +>3.当烧录日志提示`Burn Successfully`时,则表示固件已经烧录完成。 + + + + +?>首次烧录或固件程序运行异常时,可点击右上角的"Erase"擦除flash内存,在后续的固件更新时,则无需再次擦除,否则将删除已保存的Wi-Fi信息且刷新API Key. + + +## 配置WIFI + +>UIFlow提供了离线与web版本的编程器,在使用web版本的UIFlow时,我们需要为设备配置WiFi连接。下面介绍为设备配置WiFi连接的两种方式(烧录配置与AP热点配置)。 + + +### 烧录配置WiFi(推荐) + +?>M5Burner支持WiFi连接的前期烧录配置, 用户只需在固件烧录前将WiFi信息填入WiFi配置框,填入的WiFi信息将随同固件一起烧录保存至M5设备, 如上方教程所示。 + + +### AP热点配置WiFi + +>1.长按设备右侧电源键2s开机,屏幕出现UIFlow Logo时候,等待进入主页面后,使用拨轮开关选择"Setup"选项。下拨切换至config Wi-Fi选项的向内按下拨轮开关,设备会自动重启,其中Secelt Wi-Fi为上次连接的WiFi。设备跳转后将显示WiFi Config页面,按照提示通过手机或电脑的WiFi连接SSID热点,打开浏览器访问 __192.168.4.1__,在弹出的页面内输入WiFi信息进行配置即可成功配网。配置成功后设备将自动重启。并进入编程模式。 + + + +?>注意:配置的WiFi信息中,不允许出现"空格"等特殊字符。 + + + + +## 网络编程模式与API KEY + +#### 进入网络编程模式 + +?>网络编程模式是M5设备与UIFlow web编程平台的一个对接模式,屏幕会显示出当前设备的网络连接状态。当页面左上角的WiFi与云端连接指示标志没有出现`x`的时候,则代表随时可接收程序推送。默认情况下,在首次WiFi网络配置成功后,设备将自动重启,并进入网络编程模式。若您在运行其他应用后不知如何重新进入编程模式,你可以参考以下操作。 + +>开机后,在屏幕出现菜单后迅速按下屏幕中间Flow按键进入API KEY页面,使用电脑浏览器访问[flow.m5stack.com](http://flow.m5stack.com/)进入UIFlow编程页面. + + + +#### API KEY配对 + +>API KEY是M5设备在使用UIFlow web编程时的通信凭证。通过在UIFlow端配置相应的API KEY,能够为指定的设备推送程序。用户需在电脑端浏览器访问[flow.m5stack.com](http://flow.m5stack.com/)进入UIFlow编程页面,点击页面右上角的菜单栏中的设置按钮,输入对应设备上的API Key,选择使用的设备类型,点击OK保存,等待提示连接成功。 + + + +## Hello M5 + +>完成以上步骤,就可以开始使用UIFlow进行编程了。(1. 放置标签 2. 添加标签程序块 .3 点击右上角运行按钮 ) + + + +## Desktop IDE + +>使用UIFlow Desktop IDE时,你需要将CoreInk设备切换至USB模式,可以启动设备后,进入`Setup`页面进行配置 + + + +