From 4455c2a4dee0837f4afc1c0fb347279e670cdef1 Mon Sep 17 00:00:00 2001 From: shaoxiang <1026025056@qq.com> Date: Mon, 10 Jun 2019 11:36:55 +0800 Subject: [PATCH] add Arduino tutorial en --- docs/en/related_documents.md | 2 +- docs/en/related_documents/M5Burner.md | 113 ++++++++++++++++++ docs/en/related_documents/Setting_WIFI.md | 74 ++++++++++++ .../related_documents/UIFlow_Desktop_IDE.md | 90 ++++++++++++++ .../related_documents/how_to_burn_firmware.md | 2 +- docs/zh_CN/related_documents/M5Burner.md | 97 --------------- 6 files changed, 279 insertions(+), 99 deletions(-) create mode 100644 docs/en/related_documents/M5Burner.md create mode 100644 docs/en/related_documents/Setting_WIFI.md create mode 100644 docs/en/related_documents/UIFlow_Desktop_IDE.md diff --git a/docs/en/related_documents.md b/docs/en/related_documents.md index 296e5a51..55aa0b2c 100644 --- a/docs/en/related_documents.md +++ b/docs/en/related_documents.md @@ -6,7 +6,7 @@ 2. [Arduino IDE Development](en/related_documents/Arduino_IDE) -4. [How to Burn Firmware](en/related_documents/how_to_burn_firmware) +4. [Upgrade Firmware](en/related_documents/M5Burner) 5. [How to Connect WiFi Using Core](en/related_documents/how_to_connect_wifi_using_core) diff --git a/docs/en/related_documents/M5Burner.md b/docs/en/related_documents/M5Burner.md new file mode 100644 index 00000000..a8c052d9 --- /dev/null +++ b/docs/en/related_documents/M5Burner.md @@ -0,0 +1,113 @@ +# Burn Firmware {docsify-ignore-all} + +:clapper: **[Video Tutorial](#Video-Tutorial)**      :memo: **[Text Tutorial](#Text-Tutorial)** + +*** + +**This article will guide you how to burn a right firmware to your board via M5Burner.** + +*** + +## 文本教程 + +**[1. related resources](#related-resources)** + +**[2. Install USB Driver](#Install-USB-Driver)** + +**[3. M5Burner](#M5Burner)** + +**[4. Add custom firmware](#Add-custom-firmware)** + +**[5. ESPTool](#ESPTool)** + +## related resources + +>1.Click on the M5Burner burning tool and CP210X driver for your operating system below to download. + + + +## Install USB Driver + +### For Windows + +>Decompress the downloaded CP210X driver package, select the installer for your operating system, and double-click to install. + + + + +### For Mac + +>Unzip the downloaded CP210X driver package, install the program, double-click the image file to start the installation. + + + + +## M5Burner + +>1.Decompress the downloaded burning tool package. + + + +>2.Double-click to open the "M5Burner" application. The left side of the tool is the firmware version list. Click the download arrow in the list to download the corresponding firmware (gray stands for undownloaded, white stands for download). +>Click on the refresh button above to refresh the list and see if there is a new firmware release.. + + + +>3.选择好您想要烧录的固件版本,将设备通过Type-C数据线连接至电脑,选择对应COM端口与设备类型.点击"Burn"开始烧录. + +!>When burning for the first time, it is recommended to click "Erase" to clear the memory. In the subsequent firmware update, there is no need to clear it again, otherwise the saved Wi-Fi information will be deleted and the API Key will be refreshed. + + + + +## Add custom firmware + +>1.In addition to being able to burn the official firmware released by M5Stack, M5Burner also allows users to package the firmware and add it to the firmware list for burning. + + + + +>2.When you package your own firmware, you need to follow the specified file directory rules, add the json configuration file, and finally package it into a "zip" format to add. + + + + +>3.[Click to download the firmware package case](https://m5stack.oss-cn-shenzhen.aliyuncs.com/resource/docs/demo-firmware.zip). + + + +## ESPTool + +>1.For users who are accustomed to using command line operations, you can also choose ESPTool as a firmware burning tool.[Click here for details](https://github.com/espressif/esptool) + + +## Video Tutorial + +**Windows M5Burne Tutorial** + + + + \ No newline at end of file diff --git a/docs/en/related_documents/Setting_WIFI.md b/docs/en/related_documents/Setting_WIFI.md new file mode 100644 index 00000000..08a50989 --- /dev/null +++ b/docs/en/related_documents/Setting_WIFI.md @@ -0,0 +1,74 @@ +# 连接Wi-Fi(For UIFlow) {docsify-ignore-all} + +:clapper: **[视频教程](#视频教程)**      :memo: **[文本教程](#文本教程)** + +*** + +?> *以下的Wi-Fi配置内容,仅针对于烧录了UIFlow固件的M5Core设备,若您的设备还未安装UIFlow固件,[请点击此处查看固件烧录教程](zh_CN/related_documents/M5Burner))* + +**烧录了UIFlow的固件,并重启M5Core之后,您会看到如下的欢迎界面,然后我们开始连接Wi-Fi.** + +
+ +
+ +*** + +## 文本教程 + +1. [按下 UPLOAD 按键](#按下-UPLOAD-按键) + +2. [选择可联网的 Wi-Fi](#选择可联网的-Wi-Fi) + +3. [重启 M5Core](#重启-M5Core) + + +## 1. 按下 UPLOAD 按键 + +**现在, 按下 `upload` 按键. 屏幕会出现如下界面.** + +
+ +
+ +## 2. 选择可联网的Wi-Fi + +**用手机或者PC去连接屏幕上显示的M5Core的热点(like `M5Stack-a67c`),然后打开浏览器输入网址`192.168.4.1`,然后选择可联网的路由器Wi-Fi,然后输入密码。(您看,像我这样,我现在可以联网的Wi-Fi是`MasterHax_5G`)** + +
+ +
+ +## 3. 重启M5Core + +**输入密码后,成功连接可联网的路由器Wi-Fi之后,重启M5Core** + +
+ +
+ +## 完成 + +重启M5Core之后,按`upload`按键,这时候,看到下图带二维码的界面。这很好我们就可以跟着这篇文章[UIFlow编程](zh_CN/quick_start/m5core/m5stack_core_get_started_MicroPython)学习UIFlow的编程啦! + +
+ +
+ +?> **Note** 同样地,如果您想换一个可联网的wifi的话,按`SETUP`按键。 + +
+ +
+ +## 最后 + +现在,您可以阅读这篇文章开始使用UIFlow编程啦![UIFlow上手指南](zh_CN/quick_start/m5core/m5stack_core_get_started_MicroPython) + +## 视频教程 + +**[连接 WIFI](https://v.youku.com/v_show/id_XNDAxOTEyNTQ2NA==.html?spm=a2hzp.8253869.0.0)** + + diff --git a/docs/en/related_documents/UIFlow_Desktop_IDE.md b/docs/en/related_documents/UIFlow_Desktop_IDE.md new file mode 100644 index 00000000..9155e067 --- /dev/null +++ b/docs/en/related_documents/UIFlow_Desktop_IDE.md @@ -0,0 +1,90 @@ +# UIFlow Desktop IDE 部署{docsify-ignore-all} + + + + +1. [安装UIFlow-Desktop-IDE](#安装UIFlow-Desktop-IDE) + +2. [基本配置](#基本配置) + +3. [使用案例](#使用案例) + +4. [附加功能](#附加功能) + + + +## 安装UIFlow-Desktop-IDE + +>点击下方对应自己操作系统的 **UIFlow-Desktop-IDE** 进行下载. + + + +## 基本配置 + +>将下载好的UIFlow Desktop IDE压缩包解压,双击执行应用程序. + + + +?>软件启动后,将自动检测你的电脑是否安装有USB驱动(CP210X),点击Install,根据提示,进行安装. + + + +>驱动安装完成后,将自动进入UIFlow Desktop IDE并自动弹出配置框,此时将M5设备通过Tpye-C数据线连接至电脑. + + + +!>使用UIFlow Desktop IDE需要M5设备搭载UIFlow固件且进入**USB编程模式**. + +>单击设备左侧电源键重启,进入菜单后快速选择Setup,进入配置页面,选择**USB mode**. + + + +>选择好对应的端口,与编程设备,点击OK进行连接. + + + +## 使用案例 + +>完成连接后,就可以开始编程创作了,拖拽左侧的程序块列表中的程序块到编程区域,完成程序编辑后点击右上角的运行按钮,执行程序. + + + +## 附加功能 + +!>UIFlow Desktop IDE除了是一个强大的程序编辑器以外,它同时还集成了**USB驱动**安装、**M5Burner**烧录工具等功能,无需另外下载其他的软件,一站式解决编程环境的部署需求. + +>在IDE的上方菜单栏,能够找到对应的附加功能,点击即可打开使用,关于M5Burner的使用方式,详情可以参考我们的另一篇文档 ["烧录固件"](zh_CN/related_documents/M5Burner). + + + + + diff --git a/docs/en/related_documents/how_to_burn_firmware.md b/docs/en/related_documents/how_to_burn_firmware.md index 2a1913bf..a750e1a8 100644 --- a/docs/en/related_documents/how_to_burn_firmware.md +++ b/docs/en/related_documents/how_to_burn_firmware.md @@ -7,7 +7,7 @@ *** *This article will guide you how to burn a right firmware to your board via M5Burner.* - +Update *** ## Text Tutorial diff --git a/docs/zh_CN/related_documents/M5Burner.md b/docs/zh_CN/related_documents/M5Burner.md index 60e8dea1..ac036ca2 100644 --- a/docs/zh_CN/related_documents/M5Burner.md +++ b/docs/zh_CN/related_documents/M5Burner.md @@ -89,103 +89,6 @@ - - - - - - - - - - - ## ESPTool >1.对于习惯使用命令行操作的用户来说还可以选择ESPTool作为固件烧录工具.[点击此处查看详情](https://github.com/espressif/esptool)