Skip to content

Commit 97ffa29

Browse files
lbuquelbuque
committed
docs: Add quick reference
Signed-off-by: lbuque <[email protected]>
1 parent bba1bae commit 97ffa29

File tree

8 files changed

+206
-0
lines changed

8 files changed

+206
-0
lines changed

‎docs/_static/quick-reference/burn_firmware.gif

1.84 MB
Loading

‎docs/_static/quick-reference/login_m5burner.gif

607 KB
Loading

‎docs/_static/quick-reference/login_uiflow2.gif

3.57 MB
Loading

‎docs/en/index.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,4 +10,5 @@ MicroPython documentation and references
1010
software/index.rst
1111
hardware/index.rst
1212
units/index.rst
13+
quick-reference/index.rst
1314
COPYRIGHT.rst

‎docs/en/quick-reference/index.rst

Lines changed: 92 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,92 @@
1+
###############
2+
Quick Reference
3+
###############
4+
5+
.. include:: ../refs/quick-reference.ref
6+
7+
***********
8+
Preparation
9+
***********
10+
11+
Driver Installation
12+
===================
13+
14+
Click the link below to download the driver that matches the operating system.
15+
There are currently two driver chip versions (CP210X/CH9102). Please download
16+
the corresponding driver compressed package according to the version you are
17+
using. After decompressing the compressed package, select the installation
18+
package corresponding to the number of operating systems to install.
19+
20+
If you are not sure of the USB chip used by your device, you can install both
21+
drivers at the same time.
22+
23+
.. warning::
24+
25+
During the installation process of CH9102_VCP_SER_MacOS v1.7, an error may
26+
occur, but the installation is actually completed, just ignore it.
27+
28+
========================= ======================= =========================
29+
Driver name Applicable driver chip Download link
30+
========================= ======================= =========================
31+
CP210x_VCP_Windows CP2104 |CP210x_VCP_Windows|_
32+
------------------------- ----------------------- -------------------------
33+
CP210x_VCP_MacOS CP2104 |CP210x_VCP_MacOS|_
34+
------------------------- ----------------------- -------------------------
35+
CP210x_VCP_Linux CP2104 |CP210x_VCP_Linux|_
36+
------------------------- ----------------------- -------------------------
37+
CH9102_VCP_SER_Windows CH9102 |CH9102_VCP_SER_Windows|_
38+
------------------------- ----------------------- -------------------------
39+
CH9102_VCP_SER_MacOS v1.7 CH9102 |CH9102_VCP_MacOS_v1.7|_
40+
========================= ======================= =========================
41+
42+
M5Burner
43+
========
44+
45+
Please click the button below to download the corresponding M5Burner firmware
46+
burning tool according to your operating system. Open the application after
47+
decompression.
48+
49+
================ =============================
50+
Software Link
51+
================ =============================
52+
M5Burner_Windows |M5Burner-v3-beta-win-x64|_
53+
---------------- -----------------------------
54+
M5Burner_MacOS |M5Burner-v3-beta-mac-x64|_
55+
---------------- -----------------------------
56+
M5Burner_Linux |M5Burner-v3-beta-linux-x64|_
57+
================ =============================
58+
59+
********************
60+
Installation UIFLOW2
61+
********************
62+
63+
Login M5Burner
64+
==============
65+
66+
Before using UIFlow2, you need to log in to your M5Stack account first.
67+
If you don't have an account yet, please register an account first.
68+
69+
|login_m5burner.gif|
70+
71+
Firmware Burning
72+
================
73+
74+
Before burning firmware, first put the host into download mode. Each device has
75+
different ways of entering download mode. For details, please refer to the
76+
corresponding host product documentation.
77+
78+
Before burning, M5Burner will bind your host and M5Stack account.
79+
After binding, you can use your host in UIFlow2.
80+
81+
|burn_firmware.gif|
82+
83+
*******************
84+
Start using UIFLOW2
85+
*******************
86+
87+
Login UIFlow2
88+
=============
89+
90+
Log in to https://uiflow2.m5stack.com/
91+
92+
|login_uiflow2.gif|

‎docs/en/refs/quick-reference.ref

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
.. _CP210x_VCP_Windows: https://m5stack.oss-cn-shenzhen.aliyuncs.com/resource/drivers/CP210x_VCP_Windows.zip
2+
.. |CP210x_VCP_Windows| replace:: CP210x_VCP_Windows
3+
4+
.. _CP210x_VCP_MacOS: https://m5stack.oss-cn-shenzhen.aliyuncs.com/resource/drivers/CP210x_VCP_MacOS.zip
5+
.. |CP210x_VCP_MacOS| replace:: CP210x_VCP_MacOS
6+
7+
.. _CP210x_VCP_Linux: https://m5stack.oss-cn-shenzhen.aliyuncs.com/resource/drivers/CP210x_VCP_Linux.zip
8+
.. |CP210x_VCP_Linux| replace:: CP210x_VCP_Linux
9+
10+
.. _CH9102_VCP_SER_Windows: https://m5stack.oss-cn-shenzhen.aliyuncs.com/resource/drivers/CH9102_VCP_SER_Windows.exe
11+
.. |CH9102_VCP_SER_Windows| replace:: CH9102_VCP_SER_Windows
12+
13+
.. _CH9102_VCP_MacOS_v1.7: https://m5stack.oss-cn-shenzhen.aliyuncs.com/resource/drivers/CH9102_VCP_MacOS_v1.7.zip
14+
.. |CH9102_VCP_MacOS_v1.7| replace:: CH9102_VCP_MacOS_v1.7
15+
16+
17+
.. _M5Burner-v3-beta-win-x64: https://m5burner.m5stack.com/app/M5Burner-v3-beta-win-x64.zip
18+
.. |M5Burner-v3-beta-win-x64| replace:: M5Burner-v3-beta-win-x64
19+
20+
.. _M5Burner-v3-beta-mac-x64: https://m5burner.m5stack.com/app/M5Burner-v3-beta-mac-x64.zip
21+
.. |M5Burner-v3-beta-mac-x64| replace:: M5Burner-v3-beta-mac-x64
22+
23+
.. _M5Burner-v3-beta-linux-x64: https://m5burner.m5stack.com/app/M5Burner-v3-beta-linux-x64.zip
24+
.. |M5Burner-v3-beta-linux-x64| replace:: M5Burner-v3-beta-linux-x64
25+
26+
.. |burn_firmware.gif| image:: ../../_static/quick-reference/burn_firmware.gif
27+
.. |login_m5burner.gif| image:: ../../_static/quick-reference/login_m5burner.gif
28+
.. |login_uiflow2.gif| image:: ../../_static/quick-reference/login_uiflow2.gif

‎docs/zh_CN/index.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,4 +12,5 @@ MicroPython documentation and references
1212
hardware/index.rst
1313
module/index.rst
1414
unit/index.rst
15+
quick-reference/index.rst
1516
COPYRIGHT.rst

‎docs/zh_CN/quick-reference/index.rst

Lines changed: 84 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,84 @@
1+
###############
2+
Quick Reference
3+
###############
4+
5+
.. include:: ../refs/quick-reference.ref
6+
7+
********
8+
准备工作
9+
********
10+
11+
驱动安装
12+
========
13+
14+
点击下方连接下载匹配操作系统的驱动程序。目前存在两种驱动芯片版本(CP210X/CH9102), 请根
15+
据你所使用的版本下载对应的驱动程序压缩包. 在解压压缩包后,选择对应操作系统位数的安装包
16+
进行安装。
17+
18+
若您不确定您的设备所使用的USB芯片, 可同时安装两种驱动。
19+
20+
.. warning::
21+
22+
CH9102_VCP_SER_MacOS v1.7在安装过程中，可能出现报错，但实际上已经完成安装，忽略即可。
23+
24+
========================= ============= =========================
25+
驱动名称 适用驱动芯片 下载链接
26+
========================= ============= =========================
27+
CP210x_VCP_Windows CP2104 |CP210x_VCP_Windows|_
28+
------------------------- ------------- -------------------------
29+
CP210x_VCP_MacOS CP2104 |CP210x_VCP_MacOS|_
30+
------------------------- ------------- -------------------------
31+
CP210x_VCP_Linux CP2104 |CP210x_VCP_Linux|_
32+
------------------------- ------------- -------------------------
33+
CH9102_VCP_SER_Windows CH9102 |CH9102_VCP_SER_Windows|_
34+
------------------------- ------------- -------------------------
35+
CH9102_VCP_SER_MacOS v1.7 CH9102 |CH9102_VCP_MacOS_v1.7|_
36+
========================= ============= =========================
37+
38+
M5Burner
39+
========
40+
41+
请根据您所使用的操作系统,点击下方按钮下载相应的M5Burner固件烧录工具。解压后打开应用程序。
42+
43+
================ =============================
44+
软件版本 下载链接
45+
================ =============================
46+
M5Burner_Windows |M5Burner-v3-beta-win-x64|_
47+
---------------- -----------------------------
48+
M5Burner_MacOS |M5Burner-v3-beta-mac-x64|_
49+
---------------- -----------------------------
50+
M5Burner_Linux |M5Burner-v3-beta-linux-x64|_
51+
================ =============================
52+
53+
************
54+
安装UIFLOW2
55+
************
56+
57+
登录M5Burner
58+
============
59+
60+
在使用UIFlow2之前, 你需要先登录M5Stack账号。如果你还没有账号, 请先注册账号。
61+
62+
63+
|login_m5burner.gif|
64+
65+
固件烧录
66+
=========
67+
68+
在烧录固件之前，先将主机进入下载模式。各个设备的进入下载模式的方式不同，具体请参考相应的主机产品文档。
69+
70+
烧录之前，M5Burner会将你的主机和M5Stack账号进行绑定。绑定之后，你可以在UIFlow2中使用你的主机。
71+
72+
|burn_firmware.gif|
73+
74+
75+
****************
76+
开始使用UIFLOW2
77+
****************
78+
79+
登录UIFlow2.0
80+
=============
81+
82+
登录到 https://uiflow2.m5stack.com/
83+
84+
|login_uiflow2.gif|

0 commit comments

Comments
 (0)