Driver Installation

Connect the device to the PC, open the device manager to install FTDI driver for the device. Take the win10 environment as an example, download the driver file that matches the operating system, unzip it, and install it through the device manager. (Note: In some system environments, the driver needs to be installed twice for the driver to take effect. The unrecognized device name is usually M5Stack or USB Serial. Windows recommends using the driver file to install directly in the device manager (custom Update), the executable file installation method may not work properly). Click here to download FTDI driver

For MacOS users, please check System Preferences -> Security and Privacy -> General -> Allow downloadable apps from the following locations -> App Store and Approved Developer Options .

Burning tool

Please click the button below to download the corresponding M5Burner firmware burning tool according to the operating system you are using. Open the application after decompression.

Software Link
M5Burner_Windows Download
M5Burner_MacOS Download
M5Burner_Linux Download

For MacOS users, please put the application in the Application folder after the installation is complete, as shown in the figure below.
For Linux users, please switch to the unzipped file path and run ./M5Burner in the terminal to run the application.

Firmware burning

Double-click to open the Burner burning tool, select the corresponding device class in the left menu, select the firmware of the matching device, and click the download button to download.

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 on Burn.

In the firmware burning stage, you need to fill in the WiFi information into the WiFi configuration box. The information will be burned and saved to the M5 device along with the firmware, and click on Start to start burning. Note: If the programming timeout occurs, try to reduce the baud rate to 115200.

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.


Please connect your M5 device to the computer through the Type-C data cable and select the corresponding COM port
1. Click configuration to view, API KEY information will appear in the configuration box. (Please copy and save the APIKEY, it is the credential for subsequent UIFlow communication)
2. Configure Start Mode as Internet Mode (After completing the configuration, the device will automatically restart and enter the online programming mode)
3. For the description of other configuration items in the configuration box, please refer to the configuration description below.

M5Burner configuration item description

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, and then click configuration to modify.

APIKEY: Communication credentials for M5 devices when using UIFlow web programming
Start Mode: Configurable mode to enter after startup
Quick Start: You can select Quick Start to skip the startup interface/devices without UI interface, you can ignore this option.
Server: Server selection
Wifi: Configure Wifi SSID and Password

API KEY pairing

After configuring the device in online programming mode, we need to establish a connection between the device and UIFlow through API KEY, so that it can push programs for the specified device. Users need to visit flow.m5stack.com in the computer browser to enter the UIFlow programming page, click the settings button in the menu bar at the upper right corner of the page, and enter what we did in the previous step Get the API KEY, click OK to save, and wait for the prompt that the connection is successful.

Light up the RGB light

After completing the above configuration, we try to program the LED light. First, from the left block menu, select Hardware->RGB->Set RGB Bar color. Drag it to the workspace and connect it to setup. Click the triangle run button in the upper right corner to execute the program.

Run/download the program

The Run/Download of the program:
1. The Run button (triangle) in the menu bar of UIFlow online version is the Single test operation, and the device will re-enter the online programming mode after reset.
2. The download button will download the current program to the device and configure it to start automatically. Note: If the downloaded program involves network communication, please add a WiFi connection program at the beginning of the program. If you need to re-enter the programming mode in offline operation mode, you can refer to the mode switching instructions at the bottom of this document.

Device mode switch

When the device is powered on or restarted, press and hold the middle button to enter different modes. The different colors of the LED light indicate that it enters different modes. Release the button to enter the corresponding mode.

Green light: UIFlow online programming mode
Blue light UIFlow offline programming mode
Yellow light Configure WIFI mode
Purple light Run the last downloaded program

UIFlow offline programming mode

UIFlow Desktop IDE is an offline version of UIFlow programmer. It does not require network dependencies and can provide a fast-responsive program push experience. Please click on the corresponding version of UIFlow-Desktop-IDE according to your operating system to download it.

Software version Download link
UIFlow-Desktop-IDE_Windows Download
UIFlow-Desktop-IDE_MacOS Download
UIFlow-Desktop-IDE_Linux Download

Unzip the downloaded UIFlow Desktop IDE compression package, and double-click to execute the application. After the software is started, it will automatically detect whether your computer has a USB driver (CP210X) installed. ATOM devices can ignore this step and click Skip to skip.

After the driver is installed, 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. Then while the device is powered on or restarted, press and hold the middle button until the blue breathing light is displayed and release it. At this time, the blue light is always on to enter the UIFlow offline programming mode. Select the corresponding in the configuration box of UIFlow Desktop IDE To connect to the programming device, click OK to connect. If you cannot connect normally, you can try to replace the data cable or plug in and out to replace the port and check whether there is port occupancy.

Supplementary description

AP hotspot configuration WiFi

M5 devices support the use of mobile phones to configure WiFi. While the device is powered on or restarted, press and hold the middle button until it releases when the yellow breathing light is displayed. At this time, the yellow light is always on to enter the WIFI configuration mode.

1. In the WIFI configuration mode, ATOM will enable the AP hotspot, and its SSID is: M5Stack-XXX
2. After connecting the AP with a mobile phone, open the browser and enter to enter the WiFi configuration page , Enter the SSID and password to connect to the network.
3. After the configuration is complete, the device indicator will show the current status:
- Red light flashes (WiFi is not connected, staying in this state for a long time, you need to check the input Whether the WiFi information is correct, or reconfigure)
- Blue light is always on (WiFi is connected, UIFlow server is not connected)
- Green light flashes (everything is connected normally, you can start online programming, push the program) .

WIFI connection status prompt:
Blue light is always on: WiFi has been connected to the network but not connected to the UIFlow server
Red light is on: WiFi connection to the network failed, you can try to reconnect by pressing the middle button Network or restart the device.

On This Page