mirror of
https://github.com/m5stack/m5-docs.git
synced 2026-05-20 10:23:01 -07:00
change m5core quickstart some content
This commit is contained in:
Sean
@@ -4,7 +4,7 @@
|
||||
|
||||
## Driver Installation
|
||||
|
||||
> Before the program is burned, M5Core host (including BASIC / GRAY / M5GO / FIRE / FACES) users please download the corresponding CP210X driver package according to the operating system you use. After decompressing the package, select the corresponding package The installation package of the operating system digits.
|
||||
> Before the program is burned, M5Core host (including BASIC / GRAY / M5GO / FIRE / FACES) users please download the corresponding CP210X driver package according to the operating system you use. After decompressing the package，select the corresponding installation package base on your operating system digits
|
||||
|
||||
* __Download CP2104 driver__
|
||||
|
||||
@@ -64,42 +64,41 @@
|
||||
|
||||
<img src="assets/img/getting_started_pics/how_to_burn_firmware/M5Burner/M5Burner_01.jpg">
|
||||
|
||||
?>Note: After the installation of MacOS users, please put the application in the Application folder, as shown in the figure below.
|
||||
?>Note: MacOS users please put M5Burner App in the Application folder after the installation as shown in the figure below.
|
||||
|
||||
><img src="/image/base/application.png" width="70%">
|
||||
|
||||
|
||||
## Firmware burning
|
||||
|
||||
> 1. Double-click the Burner burning tool, click the download button in the left menu, download the firmware version you need, and then connect the M5 device to the computer through a Type-C data cable, select the corresponding COM port, and the baud rate , And the type of programming device.
|
||||
> 1. Double-click the Burner burning tool and click the download button in the left menu according to the firmware version you need. Then, connect the M5 device to the computer via a Type-C data cable, select the corresponding COM, baud rate , as well as the type of your programming device.
|
||||
|
||||
?>Note: M5Burner includes UIFlow firmware versions for many M5Stack products. Therefore, you need to select the correct device type before proceeding with the burning process to obtain the firmware that matches the device, as shown in the figure below. (The burning rate can use the default configuration of the burner. In special cases, you can try to reduce it to 115200).
|
||||
?>Note: M5Burner includes different UIFlow firmware versions from different M5Stack products. Therefore, you need to select the correct device type before proceeding with the burning process to obtain the firmware that matches the device, as shown in the figure below. (The default burning rate of the configuration can be chosen. In special cases like malfunction of the burning process, you can try to reduce the burning rate to 115200).
|
||||
|
||||
<img src="/image/base/device_select.jpg" width="70%">
|
||||
|
||||
> 2. Select the firmware version you want to burn, connect the device to the computer via Type-C data cable, select the corresponding COM port and device type. Click "Burn" to start burning.
|
||||
> 2. Select the firmware version you want to burn, connect the device to the computer via Type-C data cable, select the corresponding COM port and device type. Click "Burn" to start burning. When the burning log prompts ' Hard resetting via RTS pin ', it means the firmware has finished burning already.
|
||||
|
||||
?> When first burning or the firmware program runs abnormally, you can click "Erase" 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 the API Key will be refreshed.
|
||||
?> When first burning or the firmware program runs abnormally, you can click "Erase" to erase the flash memory so that there is no need to erase again in the subsequent firmware update. Otherwise, the Wi-Fi information which is saved already will be deleted and the API Key will be refreshed.
|
||||
|
||||
<img src="/image/base/Burner_user.gif " width="70%">
|
||||
|
||||
## Configure WIFI
|
||||
|
||||
> UIFlow provides an offline and web version of the programmer. When using the web version of UIFlow, we need to configure a WiFi connection for the device. The following describes two ways to configure WiFi connection for the device (flash configuration and AP hotspot configuration).
|
||||
> UIFlow provides both offline and web version of the programmer. When using the web version, we need to configure a WiFi connection for the device. The following describes two ways to configure WiFi connection for the device (Burn configuration and AP hotspot configuration).
|
||||
|
||||
### Burn configuration WiFi
|
||||
|
||||
?> UIFlow-1.4.5 and above can write WiFi information directly through M5Burner.
|
||||
?> UIFlow-1.4.5 and the above versions are in support of the pre-burning configuration under WIFI connnection. All users need to do is to fill in WIFI configuration box before setting your firmware to burn. After the configuration of WIFI, clicking 'Burn' to start firmware burning so that the WIFI infomation you filled in together with your firmware will be burned and stored into your M5 device.
|
||||
|
||||
<img src="assets\img\getting_started_pics\m5stack_core\get_started_with_uiflow\m5burner_wifi.jpg " width="70%">
|
||||
|
||||
### AP hotspot configuration WiFi
|
||||
|
||||
> 1. Click the red power button on the left side of the device to turn it on, press button A quickly after the UIFlow Logo appears on the screen, and use a mobile phone to connect to the wifi hotspot displayed on the device screen
|
||||
> 1. Click the red power button on the left side of the device to turn it on, press button A the UIFlow Logo appears on the screen, and use a mobile phone to connect to the wifi hotspot displayed on the device screen
|
||||
|
||||
<img src="assets\img\getting_started_pics\m5stack_core\get_started_with_uiflow\uiflow_wifi_setup1.jpg ">
|
||||
|
||||
> 2. After successfully connecting to the hotspot with your mobile phone, open the mobile phone browser to scan the QR code on the screen, or directly access __192.168.4.1__, enter the page to fill in your personal WIFI information, and click Configure to make the device record your WiFi information. The device will restart automatically after successful configuration. And enter programming mode.
|
||||
> 2. After successfully connecting to the hotspot with your mobile phone, open the mobile phone browser to scan the QR code on the screen or directly access __192.168.4.1__, enter the page to fill in your personal WIFI information, and click Configure to record your WiFi information. The device will restart automatically after successful configuration and enter programming mode.
|
||||
|
||||
?> Note: Special characters such as "space" are not allowed in the configured WiFi information.
|
||||
|
||||
@@ -109,30 +108,30 @@
|
||||
|
||||
#### Enter network programming mode
|
||||
|
||||
?> Network programming mode is a docking mode between M5 device and UIFlow web programming platform. The screen will show the current network connection status of the device. When the indicator is green, it means that you can receive program push at any time. By default, after the first successful WiFi network configuration, 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.
|
||||
?> Network programming mode is a docking mode between M5 device and UIFlow web programming platform. The screen will show the current network connection status of the device. When the indicator is green, it means that you can receive program push at any time. Under default situation, after the first successful WiFi network configuration, 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 powering on, press button A in the main menu interface to select the programming mode. Wait for the right indicator light to turn green in the programming mode page, scan the QR code on the screen with a tablet, or directly access it in a computer browser.[flow.m5stack.com](http://flow.m5stack.com/)Enter the UIFlow programming page.
|
||||
> After turning on your device, you can enter the coding mode by pushing the left button on the front surface of the device once the screen shows UIFlow logo. When the indicator on the coding page turns color from red to green, you can visit website [flow.m5stack.com](http://flow.m5stack.com/) in your computer browser to access UIFlow coding page.
|
||||
|
||||
<img src="assets\img\getting_started_pics\m5stack_core\get_started_with_uiflow\uiflow_program_mode.jpg ">
|
||||
|
||||
|
||||
#### API KEY
|
||||
|
||||
> API KEY is the communication credentials for M5 devices when using UIFlow web programming. By configuring the corresponding API KEY on the UIFlow side, the program can be pushed for the specified device. The user needs to visit in the computer browser[flow.m5stack.com](http://flow.m5stack.com/)Enter the UIFlow programming page, click the setting button in the menu bar at the upper right corner of the page, enter the API Key on the corresponding device, select the hardware used, click OK to save, and wait for the prompt to connect successfully.
|
||||
> API KEY is the communication credential for M5 devices when using UIFlow web programming. By configuring the corresponding API KEY on UIFlow side, programs can be pushed for the specific devices. The user needs to visit [flow.m5stack.com](http://flow.m5stack.com/) in the computer web browser to enter the UIFlow programming page . Click the setting button in the menu bar at the upper right corner of the page, enter the API Key on the corresponding device, select the hardware for connecting, click OK to save and wait till it prompts successfully connecting
|
||||
|
||||
<img src="assets\img\getting_started_pics\m5stack_core\get_started_with_uiflow\uiflow_apikey.jpg ">
|
||||
|
||||
|
||||
## Hello M5
|
||||
|
||||
> Complete the above steps, you can start programming with UIFlow. The following will show you a simple program that drives the screen to display "Hello M5". (1. Place a label 2. Add a label program block .3 Click the run button in the upper right corner)
|
||||
> With the above steps being settled, you can start programming with UIFlow. The following will show you a simple program that drives the screen to display "Hello M5". (1. Place a label 2. Add a label program block .3 Click the run button in the upper right corner)
|
||||
|
||||
<img src="assets\img\getting_started_pics\m5stack_core\get_started_with_uiflow\hello_m5.gif ">
|
||||
|
||||
|
||||
## UIFlow Desktop IDE
|
||||
|
||||
> UIFlow Desktop IDE is an offline version of UIFlow programmer, which does not require network dependencies, and can provide a responsive program push experience. Please click the corresponding version of **UIFlow-Desktop-IDE** to download according to your operating system .
|
||||
> UIFlow Desktop IDE is an offline version of UIFlow programmer which does not require network connection, and can provide you with responsive program push experience. Please click the corresponding version of **UIFlow-Desktop-IDE** to download according to your operating system .
|
||||
|
||||
<div class="files_download">
|
||||
<p class="item">
|
||||
@@ -160,15 +159,15 @@
|
||||
|
||||
#### USB programming mode
|
||||
|
||||
> Unzip the downloaded UIFlow Desktop IDE archive, and double-click to execute the application.
|
||||
> Unzip the downloaded UIFlow Desktop IDE archive and double-click to run the application.
|
||||
|
||||
<img src="assets/img/related_documents/UIFlow_Desktop_IDE/Desktop_IDE_01.jpg">
|
||||
|
||||
?> After the software starts, it will automatically detect whether your computer has a USB driver (CP210X) installed, click Install, and follow the prompts to install it.
|
||||
?> After the software(app) starts, it will automatically detect whether your computer has a USB driver (CP210X), click Install, and follow the prompts to finish installation it.
|
||||
|
||||
<img src="assets/img/related_documents/UIFlow_Desktop_IDE/Desktop_IDE_02.png">
|
||||
|
||||
> After the driver installation is complete, it will automatically enter the UIFlow Desktop IDE and automatically pop up the configuration box. At this time, connect the M5 device to the computer through the Tpye-C data cable.
|
||||
> After the driver installation is completed, it will automatically enter the UIFlow Desktop IDE with the configuration box popping up. At this time, connect the M5 device to the computer via the Tpye-C data cable.
|
||||
|
||||
<img src="assets/img/related_documents/UIFlow_Desktop_IDE/Desktop_IDE_03.png">
|
||||
|
||||
|
||||
@@ -68,7 +68,6 @@
|
||||
|
||||
><img src="/image/base/application.png" width="70%">
|
||||
|
||||
|
||||
## 固件烧录
|
||||
|
||||
>1.双击打开Burner烧录工具，在左侧菜单中点击下载按钮，下载你所需要的固件版本，然后将M5设备通过Type-C数据线连接到电脑，选择对应的COM口，波特率，以及烧录设备的类型。
|
||||
@@ -77,7 +76,7 @@
|
||||
|
||||
<img src="/image/base/device_select.jpg" width="70%">
|
||||
|
||||
>2.选择好您想要烧录的固件版本，将设备通过Type-C数据线连接至电脑，选择对应COM端口与设备类型.点击"Burn"开始烧录.
|
||||
>2.选择好您想要烧录的固件版本，将设备通过Type-C数据线连接至电脑，选择对应COM端口与设备类型.点击"Burn"开始烧录.当烧录日志提示"Hard resetting via RTS pin"时，则表示固件已经烧录完成。
|
||||
|
||||
?>首次烧录或固件程序运行异常时，可点击"Erase"擦除flash内存，在后续的固件更新时，则无需再次擦除，否则将删除已保存的Wi-Fi信息且刷新API Key.
|
||||
|
||||
@@ -89,13 +88,13 @@
|
||||
|
||||
### 烧录配置WiFi
|
||||
|
||||
?>UIFlow-1.4.5以上版本可直接通过M5Burner写入WiFi信息。
|
||||
?>UIFlow-1.4.5以上版本支持WiFi连接的前期烧录配置, 用户只需在固件烧录前将WiFi信息填入WiFi配置框，随后点击"Burn"进行固件烧录，填入的WiFi信息将随同固件一起烧录保存至M5设备。
|
||||
|
||||
<img src="assets\img\getting_started_pics\m5stack_core\get_started_with_uiflow\m5burner_wifi.jpg " width="70%">
|
||||
|
||||
### AP热点配置WiFi
|
||||
|
||||
>1.单击设备左侧的红色电源键开机，在屏幕出现UIFlow Logo后迅速按下按键A，使用手机连接设备屏幕上显示的wifi热点
|
||||
>1.单击设备左侧的红色电源键开机，在屏幕出现UIFlow Logo后迅速按下面板上左测按键，使用手机连接设备屏幕上显示的wifi热点
|
||||
|
||||
<img src="assets\img\getting_started_pics\m5stack_core\get_started_with_uiflow\uiflow_wifi_setup1.jpg ">
|
||||
|
||||
@@ -113,7 +112,7 @@
|
||||
|
||||
?>网络编程模式是M5设备与UIFlow web编程平台的一个对接模式,屏幕会显示出当前设备的网络连接状态。当指示标志为绿色时，则代表随时可接收程序推送。默认情况下，在首次WiFi网络配置成功后，设备将自动重启，并进入网络编程模式。若您在运行其他应用后不知如何重新进入编程模式，你可以参考以下操作。
|
||||
|
||||
>开机后，在主菜单界面按下按键A选择编程模式，在编程模式页面等待信号指示灯右红变成绿色，用平板扫描屏幕上的二维码，或是在电脑浏览器直接访问[flow.m5stack.com](http://flow.m5stack.com/)进入UIFlow编程页面.
|
||||
>开机后，在屏幕出现UIFlow Logo后迅速按下面板上左测按键进入编程模式，在编程模式页面等待信号指示灯右红变成绿色后，使用电脑浏览器访问[flow.m5stack.com](http://flow.m5stack.com/)进入UIFlow编程页面.
|
||||
|
||||
<img src="assets\img\getting_started_pics\m5stack_core\get_started_with_uiflow\uiflow_program_mode.jpg ">
|
||||
|
||||
@@ -131,7 +130,6 @@
|
||||
|
||||
<img src="assets\img\getting_started_pics\m5stack_core\get_started_with_uiflow\hello_m5.gif ">
|
||||
|
||||
|
||||
## UIFlow Desktop IDE
|
||||
|
||||
>UIFlow Desktop IDE是一个离线版的UIFlow编程器，无需网络依赖，且能够提供反应迅速程序推送体验，请根据您的操作系统，点击下方按钮对应版本的 **UIFlow-Desktop-IDE** 进行下载.
|
||||
|
||||
Reference in New Issue
Block a user