UIFlow - M5Core

This tutorial applies to BASIC / GRAY / M5GO / FIRE / FACES kit

Driver Installation

Click the link below to download the driver that matches the operating system. There are currently two driver chip versions, CP210X (for CP2104 version)/CP34X (for CH9102 version) driver compressed package. After decompressing the compressed package, select the installation package corresponding to the number of operating systems to install. (If you are not sure which USB chip your device uses, you can install two drivers at the same time. During the installation process of CH9102_VCP_SER_MacOS, an error may occur, but the installation is actually completed, just ignore it.)

Driver name Applicable driver chip Download link
CP210x_VCP_Windows CP2104 Download
CP210x_VCP_MacOS CP2104 Download
CP210x_VCP_Linux CP2104 Download
CH9102_VCP_SER_Windows CH9102 Download
CH9102_VCP_SER_MacOS CH9102 Download


Please click the button below to download the corresponding M5Burner firmware burning tool according to your operating system. Unzip and open the application.

Note: MacOS users please put M5Burner App in the Application folder after the installation 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 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, i In addition, you can also fill in the device to be connected later during the firmware burning stage WIFI information. After configuration, click "Burn" to start burning.

3.When the burning log prompts Burn Successfully, it means that the firmware has been burned.

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.

Configure WIFI

UIFlow provides both offline and web version of the programmer. When using the web version, we need to configure a Wi-Fi connection for the device. The following describes two ways to configure Wi-Fi connection for the device (Burn configuration and AP hotspot configuration).

Burn configuration Wi-Fi(recommend)

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.

AP hotspot configuration Wi-Fi

  1. Click the red power button on the left side of the device to turn on the power. After the UIFlow Logo appears on the screen, quickly press the right button on the panel to enter the "Setup" page. Use the left and right buttons to switch up and down the menu options to the "Wi-Fi via AP" option, press the middle button to select, and enter the AP hotspot Wi-Fi configuration mode.
  1. 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, enter the page to fill in your personal WIFI information, and click Configure to record your Wi-Fi 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 Wi-Fi information.


If you need to modify the configuration file, please connect your M5 device to the computer through the Type-C data cable and select the corresponding COM port. ⑦Then click configuration to modify.

APIKey: Communication credentials when M5 device uses Flow web programming Startup mode: configurable mode to enter after startup Quick start: Quick start to skip the start interface Server: server selection Wifi: Configure the SSID and password of Wifi COM.X & APN: Configure to use LTE network

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 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 Wi-Fi 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 booting, quickly press the right button on the panel to enter the Setup page after the menu appears on the screen, select "Internet Mode", and use a computer browser to access flow.m5stack.com Enter the UIFlow programming page.


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 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

Hello M5

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)

UIFlow Desktop IDE

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 .

USB programming mode

Unzip the downloaded UIFlow Desktop IDE archive and double-click to run the application.

After the app starts, it will automatically detect whether your computer has a USB driver (CP210X), click Install, and follow the prompts to finish installation.

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.

Using UIFlow Desktop IDE requires M5 device with UIFlow firmware and enter USB programming mode.

Click the power button on the left side of the device to restart. Quickly select Setup after entering the menu, enter the configuration page, and select USB mode.

Select the corresponding port, and the programming device, click OK to connect.

-Introduction to UIFlow

-Video tutorial for developing M5Core in UIFlow

On This Page