mirror of
https://github.com/m5stack/m5-docs.git
synced 2026-05-20 10:23:01 -07:00
add Arduino tutorial en
This commit is contained in:
shaoxiang
@@ -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)
|
||||
|
||||
|
||||
@@ -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.
|
||||
|
||||
<div class="link">
|
||||
<h4><span>M5Burner:</span></h4>
|
||||
<p>
|
||||
<a href="https://m5stack.oss-cn-shenzhen.aliyuncs.com/resource/software/M5Burner.zip" target="_blank" rel="noopener noreferrer"><img src="https://cdn.shopify.com/s/files/1/0056/7689/2250/files/windows_89cc6ea0-2a3c-4327-97e5-8f51f448c38b_icon.png?v=1557026574" alt="">Windows</a>
|
||||
<a href="https://m5stack.oss-cn-shenzhen.aliyuncs.com/resource/software/M5Burner_MacOS.zip" target="_blank" rel="noopener noreferrer"><img src="https://cdn.shopify.com/s/files/1/0056/7689/2250/files/mac_large.png?v=1557026570" alt="">MacOS</a>
|
||||
<a href="https://m5stack.oss-cn-shenzhen.aliyuncs.com/resource/software/M5Burner_Linux.zip" target="_blank" rel="noopener noreferrer"><img src="https://cdn.shopify.com/s/files/1/0056/7689/2250/files/linux_icon.png?v=1557026584" alt="">Linux</a></p>
|
||||
|
||||
<h4><span>CP210X Driver:</span></h4>
|
||||
<p>
|
||||
<a href="https://m5stack.oss-cn-shenzhen.aliyuncs.com/resource/drivers/CP210x_VCP_Windows.zip" target="_blank" rel="noopener noreferrer"><img src="https://cdn.shopify.com/s/files/1/0056/7689/2250/files/windows_89cc6ea0-2a3c-4327-97e5-8f51f448c38b_icon.png?v=1557026574" alt="">Windows</a>
|
||||
<a href="https://m5stack.oss-cn-shenzhen.aliyuncs.com/resource/drivers/CP210x_VCP_MacOS.zip" target="_blank" rel="noopener noreferrer"><img src="https://cdn.shopify.com/s/files/1/0056/7689/2250/files/mac_large.png?v=1557026570" alt="">MacOS</a>
|
||||
<a href="https://m5stack.oss-cn-shenzhen.aliyuncs.com/resource/drivers/CP210x_VCP_Linux.zip" target="_blank" rel="noopener noreferrer"><img src="https://cdn.shopify.com/s/files/1/0056/7689/2250/files/linux_icon.png?v=1557026584" alt="">Linux</a>
|
||||
</p>
|
||||
</div>
|
||||
|
||||
## Install USB Driver
|
||||
|
||||
### For Windows
|
||||
|
||||
>Decompress the downloaded CP210X driver package, select the installer for your operating system, and double-click to install.
|
||||
|
||||
<img src="assets/img/getting_started_pics/how_to_burn_firmware/M5Burner/CP210X_WIN.jpg">
|
||||
|
||||
|
||||
### For Mac
|
||||
|
||||
>Unzip the downloaded CP210X driver package, install the program, double-click the image file to start the installation.
|
||||
|
||||
<img src="assets/img/getting_started_pics/how_to_burn_firmware/M5Burner/CP210X_MAC.png">
|
||||
|
||||
|
||||
## M5Burner
|
||||
|
||||
>1.Decompress the downloaded burning tool package.
|
||||
|
||||
<img src="assets/img/getting_started_pics/how_to_burn_firmware/M5Burner/M5Burner_01.jpg">
|
||||
|
||||
>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..
|
||||
|
||||
<img src="assets/img/getting_started_pics/how_to_burn_firmware/M5Burner/M5Burner_02.jpg">
|
||||
|
||||
>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.
|
||||
|
||||
<img src="assets/img/getting_started_pics/how_to_burn_firmware/M5Burner/M5Burner_03.jpg">
|
||||
|
||||
|
||||
## 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.
|
||||
|
||||
<img src="assets/img/getting_started_pics/how_to_burn_firmware/M5Burner/M5Burner_04.jpg">
|
||||
|
||||
|
||||
>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.
|
||||
|
||||
<img src="assets/img/getting_started_pics/how_to_burn_firmware/M5Burner/M5Burner_05.jpg">
|
||||
|
||||
|
||||
>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**
|
||||
|
||||
<video width="500" height="315" controls>
|
||||
<source src="https://m5stack.oss-cn-shenzhen.aliyuncs.com/video/%E6%95%99%E7%A8%8B/Firmware%20Upgrade/A1%20-%20Firmware%20Upgrade.mp4" type="video/mp4">
|
||||
</video>
|
||||
|
||||
<style>
|
||||
|
||||
.link a{
|
||||
|
||||
padding-left: 13%;
|
||||
|
||||
}
|
||||
|
||||
</style>
|
||||
@@ -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.**
|
||||
|
||||
<figure>
|
||||
<img src="assets/img/getting_started_pics/m5stack_core/get_started_with_uiflow/core_home_page.png">
|
||||
</figure>
|
||||
|
||||
***
|
||||
|
||||
## 文本教程
|
||||
|
||||
1. [按下 UPLOAD 按键](#按下-UPLOAD-按键)
|
||||
|
||||
2. [选择可联网的 Wi-Fi](#选择可联网的-Wi-Fi)
|
||||
|
||||
3. [重启 M5Core](#重启-M5Core)
|
||||
|
||||
|
||||
## 1. 按下 UPLOAD 按键
|
||||
|
||||
**现在, 按下 `upload` 按键. 屏幕会出现如下界面.**
|
||||
|
||||
<figure>
|
||||
<img src="assets/img/getting_started_pics/m5stack_core/get_started_with_uiflow/m5stack_connet_wifi.png">
|
||||
</figure>
|
||||
|
||||
## 2. 选择可联网的Wi-Fi
|
||||
|
||||
**用手机或者PC去连接屏幕上显示的M5Core的热点(like `M5Stack-a67c`)，然后打开浏览器输入网址`192.168.4.1`，然后选择可联网的路由器Wi-Fi，然后输入密码。(您看，像我这样，我现在可以联网的Wi-Fi是`MasterHax_5G`)**
|
||||
|
||||
<figure>
|
||||
<img src="assets/img/getting_started_pics/m5stack_core/get_started_with_uiflow/input_wifi_password.png">
|
||||
</figure>
|
||||
|
||||
## 3. 重启M5Core
|
||||
|
||||
**输入密码后，成功连接可联网的路由器Wi-Fi之后，重启M5Core**
|
||||
|
||||
<figure>
|
||||
<img src="assets/img/getting_started_pics/m5stack_core/get_started_with_uiflow/connect_wifi_successfully.png">
|
||||
</figure>
|
||||
|
||||
## 完成
|
||||
|
||||
重启M5Core之后，按`upload`按键，这时候，看到下图带二维码的界面。这很好我们就可以跟着这篇文章[UIFlow编程](zh_CN/quick_start/m5core/m5stack_core_get_started_MicroPython)学习UIFlow的编程啦！
|
||||
|
||||
<figure>
|
||||
<img src="assets/img/getting_started_pics/m5stack_core/get_started_with_uiflow/apikey.jpg">
|
||||
</figure>
|
||||
|
||||
?> **Note** 同样地，如果您想换一个可联网的wifi的话，按`SETUP`按键。
|
||||
|
||||
<figure>
|
||||
<img src="assets/img/getting_started_pics/m5stack_core/get_started_with_uiflow/change_wifi.jpg">
|
||||
</figure>
|
||||
|
||||
## 最后
|
||||
|
||||
现在，您可以阅读这篇文章开始使用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)**
|
||||
|
||||
<video width="500" height="315" controls>
|
||||
<source src="https://m5stack.oss-cn-shenzhen.aliyuncs.com/video/%E6%95%99%E7%A8%8B/WiFi%20Configuration/A2%20-%20WIFI%20Configuration.mp4" type="video/mp4">
|
||||
</video>
|
||||
@@ -0,0 +1,90 @@
|
||||
# UIFlow Desktop IDE 部署{docsify-ignore-all}
|
||||
|
||||
<!-- ### 1. 打开Arduino IDE，然后点击`Sketch`->`Include Library`->`Manage Libraries...`
|
||||
|
||||
### 2. 在搜索框输入`M5Stack`，并搜索
|
||||
|
||||
<figure class="thumbnails">
|
||||
<img src="assets/img/getting_started_pics/m5stack_core/get_started_with_arduino_m5core/mac/macOS_install_m5stack_lib.png" alt="Screenshot of coverpage" title="Cover page">
|
||||
</figure>
|
||||
|
||||
### 3. 如果显示如下，则点击`Update`.
|
||||
|
||||
**但是如果显示`Install`，这意味着您之前还没安装M5Stack库，所以点击`Install`进行安装。**
|
||||
|
||||
<figure class="thumbnails">
|
||||
<img src="assets/img/getting_started_pics/m5stack_core/get_started_with_arduino_m5core/mac/macOS_search_m5stack.png" alt="Screenshot of coverpage" title="Cover page">
|
||||
</figure> -->
|
||||
|
||||
|
||||
1. [安装UIFlow-Desktop-IDE](#安装UIFlow-Desktop-IDE)
|
||||
|
||||
2. [基本配置](#基本配置)
|
||||
|
||||
3. [使用案例](#使用案例)
|
||||
|
||||
4. [附加功能](#附加功能)
|
||||
|
||||
|
||||
|
||||
## 安装UIFlow-Desktop-IDE
|
||||
|
||||
>点击下方对应自己操作系统的 **UIFlow-Desktop-IDE** 进行下载.
|
||||
|
||||
<div class="link">
|
||||
<h4><span>UIFlow Desktop IDE:</span></h4>
|
||||
<p>
|
||||
<a href="https://m5stack.oss-cn-shenzhen.aliyuncs.com/resource/software/UIFlow-Desktop-IDE.zip" target="_blank" rel="noopener noreferrer"><img src="https://cdn.shopify.com/s/files/1/0056/7689/2250/files/windows_89cc6ea0-2a3c-4327-97e5-8f51f448c38b_icon.png?v=1557026574" alt="">Windows</a>
|
||||
<a href="https://m5stack.oss-cn-shenzhen.aliyuncs.com/resource/software/UIFlow-Desktop-IDE_MacOS.zip" target="_blank" rel="noopener noreferrer"><img src="https://cdn.shopify.com/s/files/1/0056/7689/2250/files/mac_large.png?v=1557026570" alt="">MacOS</a>
|
||||
<a href="https://m5stack.oss-cn-shenzhen.aliyuncs.com/resource/software/UIFlow-Desktop-IDE_Linux.zip" target="_blank" rel="noopener noreferrer"><img src="https://cdn.shopify.com/s/files/1/0056/7689/2250/files/linux_icon.png?v=1557026584" alt="">Linux</a>
|
||||
</p>
|
||||
</div>
|
||||
|
||||
## 基本配置
|
||||
|
||||
>将下载好的UIFlow Desktop IDE压缩包解压，双击执行应用程序.
|
||||
|
||||
<img src="assets/img/related_documents/UIFlow_Desktop_IDE/Desktop_IDE_01.jpg">
|
||||
|
||||
?>软件启动后，将自动检测你的电脑是否安装有USB驱动（CP210X），点击Install，根据提示，进行安装.
|
||||
|
||||
<img src="assets/img/related_documents/UIFlow_Desktop_IDE/Desktop_IDE_02.png">
|
||||
|
||||
>驱动安装完成后，将自动进入UIFlow Desktop IDE并自动弹出配置框，此时将M5设备通过Tpye-C数据线连接至电脑.
|
||||
|
||||
<img src="assets/img/related_documents/UIFlow_Desktop_IDE/Desktop_IDE_03.png">
|
||||
|
||||
!>使用UIFlow Desktop IDE需要M5设备搭载UIFlow固件且进入**USB编程模式**.
|
||||
|
||||
>单击设备左侧电源键重启，进入菜单后快速选择Setup，进入配置页面，选择**USB mode**.
|
||||
|
||||
<img src="assets/img/related_documents/UIFlow_Desktop_IDE/Desktop_IDE_04.png">
|
||||
|
||||
>选择好对应的端口，与编程设备，点击OK进行连接.
|
||||
|
||||
<img src="assets/img/related_documents/UIFlow_Desktop_IDE/Desktop_IDE_05.jpg">
|
||||
|
||||
## 使用案例
|
||||
|
||||
>完成连接后，就可以开始编程创作了，拖拽左侧的程序块列表中的程序块到编程区域，完成程序编辑后点击右上角的运行按钮，执行程序.
|
||||
|
||||
<img src="assets/img/related_documents/UIFlow_Desktop_IDE/Desktop_IDE_06.jpg">
|
||||
|
||||
## 附加功能
|
||||
|
||||
!>UIFlow Desktop IDE除了是一个强大的程序编辑器以外，它同时还集成了**USB驱动**安装、**M5Burner**烧录工具等功能，无需另外下载其他的软件，一站式解决编程环境的部署需求.
|
||||
|
||||
>在IDE的上方菜单栏，能够找到对应的附加功能，点击即可打开使用，关于M5Burner的使用方式，详情可以参考我们的另一篇文档 ["烧录固件"](zh_CN/related_documents/M5Burner).
|
||||
|
||||
<img src="assets/img/related_documents/UIFlow_Desktop_IDE/Desktop_IDE_07.jpg">
|
||||
|
||||
<style>
|
||||
|
||||
.link a{
|
||||
|
||||
padding-left: 13%;
|
||||
|
||||
}
|
||||
|
||||
</style>
|
||||
|
||||
@@ -7,7 +7,7 @@
|
||||
***
|
||||
|
||||
*This article will guide you how to burn a right firmware to your board via M5Burner.*
|
||||
|
||||
Update
|
||||
***
|
||||
|
||||
## Text Tutorial
|
||||
|
||||
@@ -89,103 +89,6 @@
|
||||
|
||||
|
||||
|
||||
<!-- 解压刚刚下载的M5Burner压缩包, 然后双击`M5Burner.exe`.
|
||||
|
||||
**选择板子正与PC相连的`串口号`和`921600 波特率`, 选择合适的固件文件, 点击`Erase`, 然后等擦除固件完成，点击`Burn`**
|
||||
|
||||
?> **Tip** **a.** 如果您想通过 [UIFlow](http://flow.m5stack.com)(/[M5Cloud](http://cloud.m5stack.com)) 来编程的话，请选择最新的 `M5Flow-vx.x`(/`M5Cloud-vx.x.x`) **b.** 如果您想有 ESP32CAM (或 M5CAMERA)，并且想编程它的话，请选择最新版的`M5Cam-vx.x (/M5Cam-psram)`
|
||||
|
||||
<img src="assets/img/getting_started_pics/how_to_burn_firmware/burn_flow_firmware.gif">
|
||||
|
||||
!> **注意** 如何 M5Burner 的串口号选项框没有显示任何的 `COMx` 号或者只显示 `COM1`, 这时候您需要参考这篇文档[建立串口通信](zh_CN/related_documents/establish_serial_connection)来重新安装USB驱动.
|
||||
|
||||
**a. 选择合适的固件文件**
|
||||
|
||||
a. 如果您想通过 [UIFlow](http://flow.m5stack.com)来编程的话，请选择最新的 `M5Flow-vx.x`
|
||||
|
||||
b. 如果您想有 ESP32CAM (或 M5CAMERA)，并且想编程它的话，请选择最新版的 `M5Cam-vx.x (/M5Cam-psram)`
|
||||
|
||||
**b. 点击 `Erase`**
|
||||
|
||||
<img src="assets/img/getting_started_pics/how_to_burn_firmware/burn_firmware_01.png" alt="Screenshot of coverpage" title="Cover page">
|
||||
|
||||
*如果 M5Burner 打印出这样的信息的话`Hard resetting via RTS pin...`，这就表明您擦除固件成功了.*
|
||||
|
||||
<img src="assets/img/getting_started_pics/how_to_burn_firmware/burn_firmware_04.png" alt="Screenshot of coverpage" title="Cover page">
|
||||
|
||||
*如果 M5Burner 打印出这样的信息的话`Leaving... Staying in bootloader.`，这就表明您烧录固件成功了.*
|
||||
|
||||
<img src="assets/img/getting_started_pics/how_to_burn_firmware/burn_firmware_05.png" alt="Screenshot of coverpage" title="Cover page">
|
||||
|
||||
### 3. 然后重启板子
|
||||
|
||||
?> **提示**
|
||||
如果 M5Burner 在点击 `Burn` 之后，显示 `busy...`, 也就是卡顿的话，不要慌张，稍微等几分钟，软件自然就会烧录成功。
|
||||
|
||||
?> **提示** 如果 M5Burner 在擦除或者烧录过程中被中断了(如突然关闭软件), 为了保证板子能正常工作，您最好重新擦除和烧录一遍固件. -->
|
||||
|
||||
|
||||
|
||||
|
||||
<!--
|
||||
## MacOS -->
|
||||
|
||||
<!-- ### 1. 安装 USB 驱动 (如果您还没安装 USB 驱动的话，跟着这个步骤完成。如果已经安装的话，您可以直接跳转到步骤 2。)
|
||||
|
||||
首先，打开官网 https://m5stack.com，然后在页面最顶部选择 `Explore` -> `Download`，下载 MacOS 版本的 `M5Burner` 和 `CP21X Driver`。
|
||||
|
||||
<img src="assets/img/getting_started_pics/how_to_burn_firmware/burn_firmware_mac_01.png">
|
||||
|
||||
<img src="assets/img/getting_started_pics/how_to_burn_firmware/burn_firmware_mac_02.png">
|
||||
|
||||
USB 驱动 `CP21X Driver` 下载完之后，打开这个文件，如下图所示安装这个驱动。
|
||||
|
||||
<img src="assets/img/getting_started_pics/how_to_burn_firmware/burn_firmware_mac_03.png">
|
||||
|
||||
<img src="assets/img/getting_started_pics/how_to_burn_firmware/burn_firmware_mac_04.png">
|
||||
|
||||
<img src="assets/img/getting_started_pics/how_to_burn_firmware/burn_firmware_mac_05.png">
|
||||
|
||||
<img src="assets/img/getting_started_pics/how_to_burn_firmware/burn_firmware_mac_06.png">
|
||||
|
||||
<img src="assets/img/getting_started_pics/how_to_burn_firmware/burn_firmware_mac_07.png">
|
||||
|
||||
<img src="assets/img/getting_started_pics/how_to_burn_firmware/burn_firmware_mac_08.png">
|
||||
|
||||
<img src="assets/img/getting_started_pics/how_to_burn_firmware/burn_firmware_mac_09.png">
|
||||
|
||||
<img src="assets/img/getting_started_pics/how_to_burn_firmware/burn_firmware_mac_10.png"> -->
|
||||
|
||||
<!-- 执行到这里，USB 驱动安装成功了。不过您需要执行以下步骤来允许 Mac 系统执行第三方应用软件。打开 Mac 的 `search`，然后搜索 `Terminal`，并敲击键盘 `Enter` 按键以执行它。
|
||||
|
||||
<img src="assets/img/getting_started_pics/how_to_burn_firmware/burn_firmware_mac_11.png">
|
||||
|
||||
在 `Terminal` 中，输入下图的命令，然后敲击键盘 `Enter` 按键。
|
||||
|
||||
<img src="assets/img/getting_started_pics/how_to_burn_firmware/burn_firmware_mac_12.png">
|
||||
|
||||
现在点击屏幕左上角的苹果 LOGO，选择 `System Preferences...`，然后打开 `Security & Privacy`.
|
||||
|
||||
<img src="assets/img/getting_started_pics/how_to_burn_firmware/burn_firmware_mac_13.png">
|
||||
|
||||
在打开的窗口中，选择选项 `Allow apps downloaded from:` 下的 `Anywhere`.
|
||||
|
||||
<img src="assets/img/getting_started_pics/how_to_burn_firmware/burn_firmware_mac_14.png">
|
||||
|
||||
### 2. 打开 M5Burner
|
||||
|
||||
回到浏览器，点击浏览器右上角的 `Downloads` 按钮，打开 `M5Burner` 文件。
|
||||
|
||||
<img src="assets/img/getting_started_pics/how_to_burn_firmware/burn_firmware_mac_15.png">
|
||||
|
||||
### 3. 烧录固件
|
||||
|
||||
接下来，通过 Type-C USB 线连接您的设备到 Mac 电脑，然后选择对应的固件版本（一般是选择最新的版本），点击 `Flash` 按钮。
|
||||
|
||||
<img src="assets/img/getting_started_pics/how_to_burn_firmware/burn_firmware_mac_16.png">
|
||||
|
||||
固件烧录完成后，拔了 USB 线，按下您的 M5 上的复位按键（M5Core 是红色按键，同时也是电源键）。 -->
|
||||
|
||||
## ESPTool
|
||||
|
||||
>1.对于习惯使用命令行操作的用户来说还可以选择ESPTool作为固件烧录工具.[点击此处查看详情](https://github.com/espressif/esptool)
|
||||
|
||||
Reference in New Issue
Block a user