diff --git a/docs/assets/img/related_documents/Arduino_IDE/Arduino_5.jpg b/docs/assets/img/related_documents/Arduino_IDE/Arduino_5.jpg index 2793c298..5a2f041c 100644 Binary files a/docs/assets/img/related_documents/Arduino_IDE/Arduino_5.jpg and b/docs/assets/img/related_documents/Arduino_IDE/Arduino_5.jpg differ diff --git a/docs/assets/img/related_documents/Arduino_IDE/Arduino_66.jpg b/docs/assets/img/related_documents/Arduino_IDE/Arduino_66.jpg new file mode 100644 index 00000000..798b8e91 Binary files /dev/null and b/docs/assets/img/related_documents/Arduino_IDE/Arduino_66.jpg differ diff --git a/docs/assets/img/related_documents/Arduino_IDE/Arduino_77.jpg b/docs/assets/img/related_documents/Arduino_IDE/Arduino_77.jpg new file mode 100644 index 00000000..703b818b Binary files /dev/null and b/docs/assets/img/related_documents/Arduino_IDE/Arduino_77.jpg differ diff --git a/docs/en/arduino/arduino_development.md b/docs/en/arduino/arduino_development.md index c0c2e088..02d7bed6 100644 --- a/docs/en/arduino/arduino_development.md +++ b/docs/en/arduino/arduino_development.md @@ -30,8 +30,18 @@ >5.select `Tools`->`Board:`->`ESP32` +### For M5Core and M5Stick + +### For M5StickC + + + +### For Atom Matrix/Lite + + + ## M5Stack Library >Different hardware devices, with different case libraries, please choose to download according to the device you use..Open Arduino IDE, then Select `Sketch`->`Include Library`->`Manage Libraries...` @@ -52,7 +62,7 @@ ### For Atom Matrix/Lite -?>Search `M5Atom` find it and click `Install` +?>Search `M5Atom` find it and click `Install`,You may need to install FastLED library diff --git a/docs/en/quick_start/atom/atom_quick_start.md b/docs/en/quick_start/atom/atom_quick_start.md index 88ea358b..1d19a263 100644 --- a/docs/en/quick_start/atom/atom_quick_start.md +++ b/docs/en/quick_start/atom/atom_quick_start.md @@ -2,18 +2,34 @@ ## Menu -**[1. Menu option introduction](#Menu-option-introduction)** +**[1. Meaning of light working status](#Meaning-of-light-working-status)** -**[2. Meaning of light status](#Meaning-of-light-status)** +**[2. Menu option introduction](#Menu-option-introduction)** -**[3. Menu Usage](#Menu-Usage)** +**[3. Usage](#Usage)** **[4. UIFlow Example](#UIFlow-Example)** +>In the uiflow configuration, light represents two meanings: one is used for the display of menu options, and the other is used for the prompt of current working status. + +## Meaning of light working status + +- Breathing red-light means the WIFI network is connecting + +- Steady red-light means WIFI connection failed, short press the middle button to reconnect + +- Breathing green-light indicates that the UIFlow server is connected normally + +- Steady blue-light means the UIFlow server is not connected properly + +- Breathing blue-light to indicate that USB mode has been entered + +- Steady yellow-light indicates that WEB network configuration is required + ## Menu option introduction ->The breathing light changes color every second in this state +>Press and hold the middle key to turn on the power will enter the menu mode. In this mode, the light will cycle to change the color. The menu options represented by different colors. @@ -25,25 +41,11 @@ - PURPLE Light **APP Run Mode** -## Meaning of light status +## Usage -- Breathing red-light means the WIFI network is connecting +1. Download and Setup [M5Bunner](https://m5stack.com/pages/download).If you have finished burning by referring to this instruction [UIFlow Flash](https://docs.m5stack.com/#/en/uiflow/introduction), the device will automatically connect to your WiFi information filled in M5Bunner. If the connection fails（steady red-light）, you can try to short press the middle button to connect again. If it still fails, you can try to manually redistribute the network(Refer to step 2 to reconfigure WiFi). -- Steady red-light means WIFI connection failed, press the middle button to reconnect - -- Breathing green-light indicates that the UIFlow server is connected normally - -- Steady blue-light means the UIFlow server is not connected properly - -- Breathing blue-light to indicate that USB mode has been entered - -- Steady yellow-light indicates that WEB network configuration is required - -## Menu Usage - -1. After the uiflow firmware is burned, the device will automatically connect to the WiFi information filled in m5bunner. If the connection fails, you can try to press the middle button to connect again. If it still fails, you can try to manually redistribute the network. - -2. When the device is powered on, it will enter the last selected mode by default. If you want to change the mode, just press and hold the middle button while powering on (or when restarting), and do not release it. The menu mode will change color in the form of breathing light, and then release it when the light changes to the required mode color. For example, it is necessary to manually reconfigure WiFi. When the device is powered on or restarted, press and hold the middle button until the Yellow breathing light is displayed and released. At this time, the yellow light is always on and the WiFi configuration mode is entered. +2. When the device is powered on, it will enter the last selected mode by default. If you want to change the mode, just press and hold the middle button while powering on (or when restarting), and do not release it. The menu mode will change color in the form of breathing light, and then release it when the light changes to the required mode color. For example, if you want to enter UIFlow's USB mode(__BLUE Light__), press and hold the middle button, wait until the LED color changes to blue, and then release it. At this time, the LED is breathing, and now it enters USB mode.Another example, it is necessary to manually reconfigure WiFi(__YELLOW Light__). When the device is powered on or restarted, press and hold the middle button until the Yellow breathing light is displayed and released. At this time, the yellow light is always on and the WiFi configuration mode is entered.Switching to app mode is similar to the above method. diff --git a/docs/en/uiflow/introduction.md b/docs/en/uiflow/introduction.md index efe11539..d82524dd 100644 --- a/docs/en/uiflow/introduction.md +++ b/docs/en/uiflow/introduction.md @@ -33,6 +33,10 @@ ## Setup WIFI +>For version 1.4.5 and above, WiFi information can be written directly through M5Burner + +> + * __M5GO__ >__*1.4.5 version and above can be configured directly through M5Bunner__ diff --git a/docs/image/base/Burner_145.png b/docs/image/base/Burner_145.png new file mode 100644 index 00000000..e9543e98 Binary files /dev/null and b/docs/image/base/Burner_145.png differ diff --git a/docs/zh_CN/arduino/arduino_development.md b/docs/zh_CN/arduino/arduino_development.md index 85e319d8..b3bd8080 100644 --- a/docs/zh_CN/arduino/arduino_development.md +++ b/docs/zh_CN/arduino/arduino_development.md @@ -30,8 +30,18 @@ >5.选择 `工具`->`开发板:`->`ESP32` +### For M5Core and M5Stick + +### For M5StickC + + + +### For Atom Matrix/Lite + + + ## 相关库 >不同的硬件设备，有着不同的案例程序库，请根据你所使用的设备选择下载.打开 Arduino IDE, 然后选择 `项目`->`加载库`->`库管理...` @@ -52,7 +62,7 @@ ### For Atom Matrix/Lite -?>搜索 `M5Atom` 并安装，如下图所示 +?>搜索 `M5Atom` 并安装，如下图所示,可能你还需要安装FastLED库 diff --git a/docs/zh_CN/quick_start/atom/atom_quick_start.md b/docs/zh_CN/quick_start/atom/atom_quick_start.md index 85554be2..0fb49601 100644 --- a/docs/zh_CN/quick_start/atom/atom_quick_start.md +++ b/docs/zh_CN/quick_start/atom/atom_quick_start.md @@ -10,10 +10,25 @@ **[4. UIFlow示例](#UIFlow示例)** +>灯光在UIFlow的配置中代表两种意思，一种用于菜单选项的显示，一种用于对当前工作状态的提示。 + +## 灯光状态含义 + +- 红色呼吸灯表示WIFI网络正在连接 + +- 红灯常亮表示WIFI连接失败，按下中间按键可重新连接 + +- 绿色呼吸灯表示UIFLow服务器连接正常 + +- 蓝灯常亮表示UIFlow服务器未正常连接 + +- 蓝色呼吸灯表示已进入USB模式 + +- 黄灯常亮表示需要WEB网络配置 ## 菜单选项介绍 ->呼吸灯不同颜色状态代表不同菜单选项 +>按住中间按键接通电源会进入菜单模式，呼吸灯不同颜色状态代表不同菜单选项 @@ -25,25 +40,11 @@ - 紫灯 **APP 运行模式** -## 灯光状态含义 - -- 红灯闪烁表示WIFI网络正在连接 - -- 红灯常亮表示WIFI连接失败，按下中间按键可重新连接 - -- 绿灯闪烁表示UIFLow服务器连接正常 - -- 蓝灯常亮表示UIFlow服务器未正常连接 - -- 蓝灯闪烁表示已进入USB模式 - -- 黄灯常亮表示需要WEB网络配置 - ## 使用方法 -1. 烧录完UIFlow固件设备会自动连接M5Bunner中填入的WIFI信息，如果连接失败可尝试按下中间按键再次连接，如果仍然失败可尝试手动重新配网。 +1. 下载M5Burner[M5Bunner](https://m5stack.com/pages/download)，并按照此教程烧录完UIFlow固件[UIFlow Flash](https://docs.m5stack.com/#/en/uiflow/introduction)，设备会自动连接M5Bunner中填入的WIFI信息，如果连接失败可尝试按下中间按键再次连接，如果仍然失败可尝试手动重新配网。 -2. 设备通电默认进入最后一次选择的模式，如需改变模式，只需在上电的同时（或重启时）按住中间按键不要松开，菜单模式以呼吸灯形式变色，等到灯光变换为所需模式颜色时再松开。例如需要手动重新配置WIFI，设备上电或重启时按住中间按键不放，直到显示黄色呼吸灯时松开，此时黄灯常亮即进入WIFI配置模式。 +2. 设备通电默认进入最后一次选择的模式，如需改变模式，只需在上电的同时（或重启时）按住中间按键不要松开，菜单模式以呼吸灯形式变色，等到灯光变换为所需模式颜色时再松开。例如，现在需要进入UIFlow的USB模式，设备上电或重启的同时按住中间按键不放，等到LED变为蓝色呼吸灯时松开，此时就进入了USB模式。再比如需要手动重新配置WIFI，设备上电或重启的同时按住中间按键不放，直到显示黄色呼吸灯时松开，此时黄灯常亮即进入WIFI配置模式。 diff --git a/docs/zh_CN/uiflow/introduction.md b/docs/zh_CN/uiflow/introduction.md index ac4e9b07..2df93d80 100644 --- a/docs/zh_CN/uiflow/introduction.md +++ b/docs/zh_CN/uiflow/introduction.md @@ -35,6 +35,10 @@ ## 配置WIFI +>1.4.5以上版本可直接通过M5Burner写入wifi信息 + +> + * __M5GO__ >__*1.4.5以上版本可直接通过M5Bunner配置__