diff --git a/docs/assets/css/main.css b/docs/assets/css/main.css index f59d7f56..a5e167e7 100644 --- a/docs/assets/css/main.css +++ b/docs/assets/css/main.css @@ -275,7 +275,10 @@ body[data-page="ja/README.md"] #faces-kit { #unit-fan, #op90, #op180, -#accel { +#accel, +#laser-rx, +#laser-tx, +#mini-proto { width: 0; height: 0; overflow: hidden; @@ -337,7 +340,10 @@ body[data-page="ja/README.md"] #application { #hat-spk, #hat-proto, #hat-ncir, -#hat-thermal { +#hat-thermal, +#hat-adc, +#hat-dac, +#hat-rs485 { width: 0; height: 0; overflow: hidden; diff --git a/docs/assets/img/getting_started_pics/m5stickv/1561458023(1).jpg b/docs/assets/img/getting_started_pics/m5stickv/1561458023(1).jpg deleted file mode 100644 index 60835c31..00000000 Binary files a/docs/assets/img/getting_started_pics/m5stickv/1561458023(1).jpg and /dev/null differ diff --git a/docs/assets/img/getting_started_pics/m5stickv/1561458061(1).jpg b/docs/assets/img/getting_started_pics/m5stickv/1561458061(1).jpg deleted file mode 100644 index 5832f75d..00000000 Binary files a/docs/assets/img/getting_started_pics/m5stickv/1561458061(1).jpg and /dev/null differ diff --git a/docs/assets/img/getting_started_pics/m5stickv/kflash_gui_01.jpg b/docs/assets/img/getting_started_pics/m5stickv/kflash_gui_01.jpg index c5491804..60ee26ec 100644 Binary files a/docs/assets/img/getting_started_pics/m5stickv/kflash_gui_01.jpg and b/docs/assets/img/getting_started_pics/m5stickv/kflash_gui_01.jpg differ diff --git a/docs/assets/img/getting_started_pics/m5stickv/kflash_gui_02.jpg b/docs/assets/img/getting_started_pics/m5stickv/kflash_gui_02.jpg deleted file mode 100644 index a50875d1..00000000 Binary files a/docs/assets/img/getting_started_pics/m5stickv/kflash_gui_02.jpg and /dev/null differ diff --git a/docs/assets/img/getting_started_pics/m5stickv/putty_02.jpg b/docs/assets/img/getting_started_pics/m5stickv/putty_02.jpg index 93a751c9..53404887 100644 Binary files a/docs/assets/img/getting_started_pics/m5stickv/putty_02.jpg and b/docs/assets/img/getting_started_pics/m5stickv/putty_02.jpg differ diff --git a/docs/en/hat/hat-adc.md b/docs/en/hat/hat-adc.md new file mode 100644 index 00000000..e69de29b diff --git a/docs/en/hat/hat-dac.md b/docs/en/hat/hat-dac.md new file mode 100644 index 00000000..e69de29b diff --git a/docs/en/hat/hat-rs485.md b/docs/en/hat/hat-rs485.md new file mode 100644 index 00000000..e69de29b diff --git a/docs/en/quick_start/m5stickv/m5stickv_quick_start.md b/docs/en/quick_start/m5stickv/m5stickv_quick_start.md new file mode 100644 index 00000000..df32e733 --- /dev/null +++ b/docs/en/quick_start/m5stickv/m5stickv_quick_start.md @@ -0,0 +1,141 @@ +# M5StickV 上手指南 {docsify-ignore-all} + +## 目录 + +**[1. 下载固件](#下载固件)** + +**[2. 烧录固件](#烧录固件)** + +**[3. 串口调试工具](#串口调试工具)** + +**[4. Hello World](#Hello-World)** + +**[5. 编辑与运行文件](#编辑与运行文件)** + +**[6. 程序库](#程序库)** + + + +## 下载固件 + + + + + +## 烧录固件 + +>1.点击下方对应自己操作系统的 Kflash_GUI烧录工具进行下载. + + + +>2.将设备通过Tpye-C数据线连接至电脑,双击打开烧录工具**Kflash_GUI**应用程序,选择对应的设备端口、固件程序、波特率. 点击下载,开始烧录 . + + + + +### Kflash + +>3.对于习惯使用命令行操作的用户来说还可以选择Kflash作为固件烧录工具.[点击此处查看详情](https://github.com/kendryte/kflash.py) + + +## 串口调试工具 + +>1.编程M5StickV需要使用到串口调试工具,您可以使用Putty作为串口调试工具, [点击此处](https://www.chiark.greenend.org.uk/~sgtatham/putty/latest.html)访问Putty资源页面,选择对应自己操作系统Putty进行下载,并安装. + +>2.运行Putty后,将M5StickV通过Tpye-C数据线连接至电脑端口,在Putty中设置相应的端口号与波特率,点击"open",开始连接. (你可以通过查看设备管理器得到M5StickV所使用的端口号) + + + +> 连接成功后,将自动进入,MaixPy 的交互界面. 此时设备正在运行着默认程序,您可以通过按下快捷键"Ctrl+C"中断其运行,并进入命令行. + + + + +## Hello World + +>在命令行输入下方代码,M5StickV屏幕将显示"hello world". + +``` +import lcd + +lcd.init() +lcd.draw_string(100, 100, "hello world", lcd.RED, lcd.BLACK) + +``` + + +## 编辑与运行文件 + +### 编辑文件 + +>在交互解释器(REPL)中,我们能够便捷的输入程序并马上得到运行结果,但这仅适合用作短程序的验证,在实际项目中,庞大代码量使得我们不得不将代码编辑成一个个的文件. + +>在 MaixPy 中,内置了一款编开源编辑器 [Micropython Editor(pye)](https://github.com/robert-hh/Micropython-Editor),这使得我们能够非常方便的修改程序文件. + +使用 `os.listdir()` 可以查看当前目录下的文件, + +使用 `pye("hello.py")` 可以创建文件并进入编辑模式(已存在同名文件,则仅进入编辑), 快捷键等使用说明可以在[这里查看](https://github.com/robert-hh/Micropython-Editor/blob/master/Pyboard%20Editor.pdf) + +在编辑器中完成编辑后,按 `Ctrl+S` > `Enter` 键进行保存, 按 `Ctrl+Q` 退出编辑 + +**注意**: 使用这款编辑器对使用的串口工具有一定要求, 必须将 `BackSpace` 按键设置为 `DEL` 功能, 否则按 `BackSpace` 调用的是 `Ctrl+H` 一样的功能(即字符替换) + +### 上传文件 + +>虽然 MaixPy 内置编辑器使得我们能够直接操作文件内容.但对于多文件的情况下,使用电脑的其他编辑器编写代码然后再将文件上传,将大大提升工作效率. + +>[uPyLoader](https://github.com/BetaRavener/uPyLoader) 是一款开源软件,使用它可以方便地连接 MaixPy 并且上传、下载、执行文件,同时监控输出等等功能,功能比较完善 + + + + +### 运行文件 + +使用 `os.chdir()` 切换当前目录到文件的目录,比如 `os.chdir("/flash")` + +#### 方法一: `import` + +然后执行 `import hello` + +即可看到输出 `hello maixpy` + +使用此方法简单易用,但是需要注意的是, 目前 `import` 只能使用一次, 如果第二次 `import`, 则文件不会再执行, 如果需要多次执行,建议使用下面的方法 + +#### 方法二: `exec()` + +使用 `exec()` 函数来执行 + +```python +with open("hello.py") as f: + exec(f.read()) + +``` + +### 开机自动运行脚本 + +系统会在 `/flash` 或者 `/sd` 目录创建 `boot.py` 文件, 开机会自动先执行这个脚本, 编辑这个脚本的内容即可实现开机自启 + + + +## 程序库 + + + + + + + \ No newline at end of file diff --git a/docs/en/unit/laser-rx.md b/docs/en/unit/laser-rx.md new file mode 100644 index 00000000..e69de29b diff --git a/docs/en/unit/laser-tx.md b/docs/en/unit/laser-tx.md new file mode 100644 index 00000000..e69de29b diff --git a/docs/en/unit/mini-proto.md b/docs/en/unit/mini-proto.md new file mode 100644 index 00000000..e69de29b diff --git a/docs/index.md b/docs/index.md index 083a5a38..292e2003 100644 --- a/docs/index.md +++ b/docs/index.md @@ -44,7 +44,8 @@ ## M5StickC M5Stick QuickStart     - M5StickC QuickStart » + M5StickC QuickStart     + **M5Stick** @@ -62,6 +63,13 @@

M5StickC

+ + ## M5GO Lite ## M5GO Kit ## FACES Kit @@ -693,6 +701,7 @@ ## PROTO ## Unit-FAN ## VIBRATOR-MOTOR +## MINI-PROTO
@@ -709,6 +718,13 @@

PROTO

+ +
@@ -729,6 +745,8 @@ ## IR ## RS485 ## RFID +## LASER-RX +## LASER-TX
@@ -751,6 +769,20 @@

RFID

+
+ + + +

LASER-RX

+
+ +
+ + + +

LASER-TX

+
+ **C-HAT class** ## HAT-ENV @@ -759,6 +791,7 @@ ## HAT-PROTO ## HAT-THERMAL ## HAT-NCIR +## HAT-RS485
@@ -802,6 +835,30 @@

Thermal

+ + **Visual class** diff --git a/docs/zh_CN/README.md b/docs/zh_CN/README.md index 31893b4f..641cf2b2 100644 --- a/docs/zh_CN/README.md +++ b/docs/zh_CN/README.md @@ -48,7 +48,9 @@ M5Stick上手指南     - M5StickC上手指南 » + M5StickC上手指南     + + **M5Stick** @@ -68,6 +70,13 @@

M5StickC

+ + ## M5GO Lite ## M5GO Kit ## FACES Kit @@ -697,6 +706,7 @@ ## PROTO ## Unit-FAN ## VIBRATOR-MOTOR +## MINI-PROTO
@@ -713,6 +723,13 @@

PROTO

+ +
@@ -732,6 +749,8 @@ ## IR ## RS485 ## RFID +## LASER-RX +## LASER-TX
@@ -754,6 +773,20 @@

RFID

+ + **C-HAT 类** ## HAT-ENV @@ -762,6 +795,7 @@ ## HAT-PROTO ## HAT-THERMAL ## HAT-NCIR +## HAT-RS485
@@ -805,6 +839,31 @@

Thermal

+ + + **视觉类** ## RGB_LED diff --git a/docs/zh_CN/hat/hat-adc.md b/docs/zh_CN/hat/hat-adc.md new file mode 100644 index 00000000..e69de29b diff --git a/docs/zh_CN/hat/hat-dac.md b/docs/zh_CN/hat/hat-dac.md new file mode 100644 index 00000000..e69de29b diff --git a/docs/zh_CN/hat/hat-rs485.md b/docs/zh_CN/hat/hat-rs485.md new file mode 100644 index 00000000..e69de29b diff --git a/docs/zh_CN/quick_start/m5stickv/m5stickv_quick_start.md b/docs/zh_CN/quick_start/m5stickv/m5stickv_quick_start.md index f3f90107..df32e733 100644 --- a/docs/zh_CN/quick_start/m5stickv/m5stickv_quick_start.md +++ b/docs/zh_CN/quick_start/m5stickv/m5stickv_quick_start.md @@ -2,7 +2,7 @@ ## 目录 -**[1. 准备工作](#准备工作)** +**[1. 下载固件](#下载固件)** **[2. 烧录固件](#烧录固件)** @@ -16,44 +16,43 @@ +## 下载固件 -## 准备工作 ->1.下载固件文件,访问PASSSSSSS,根据你的需求下载相应的固件文件,下方为固件类型基本介绍. + -
- -
## 烧录固件 +>1.点击下方对应自己操作系统的 Kflash_GUI烧录工具进行下载. ->1.下载固件烧录工具[Kflash_GUI](https://github.com/sipeed/kflash_gui/releases). + + +>2.将设备通过Tpye-C数据线连接至电脑,双击打开烧录工具**Kflash_GUI**应用程序,选择对应的设备端口、固件程序、波特率. 点击下载,开始烧录 . ->2.将设备通过Tpye-C数据线连接至电脑,双击打开烧录工具**Kflash_GUI**应用程序,选择对应的设备端口、固件程序、波特率. 点击下载,开始烧录. (固件文件与模型文件可分开烧录,二者不冲突) ### Kflash ->1.对于习惯使用命令行操作的用户来说还可以选择Kflash作为固件烧录工具.[点击此处查看详情](https://github.com/kendryte/kflash.py) +>3.对于习惯使用命令行操作的用户来说还可以选择Kflash作为固件烧录工具.[点击此处查看详情](https://github.com/kendryte/kflash.py) ## 串口调试工具 -### For Windows +>1.编程M5StickV需要使用到串口调试工具,您可以使用Putty作为串口调试工具, [点击此处](https://www.chiark.greenend.org.uk/~sgtatham/putty/latest.html)访问Putty资源页面,选择对应自己操作系统Putty进行下载,并安装. ->[点击此处](https://www.chiark.greenend.org.uk/~sgtatham/putty/latest.html)访问Putty资源页面,选择对应自己操作系统Putty进行下载,并安装. +>2.运行Putty后,将M5StickV通过Tpye-C数据线连接至电脑端口,在Putty中设置相应的端口号与波特率,点击"open",开始连接. (你可以通过查看设备管理器得到M5StickV所使用的端口号) -> MaixPy 的交互界面. +> 连接成功后,将自动进入,MaixPy 的交互界面. 此时设备正在运行着默认程序,您可以通过按下快捷键"Ctrl+C"中断其运行,并进入命令行. @@ -93,7 +92,8 @@ lcd.draw_string(100, 100, "hello world", lcd.RED, lcd.BLACK) >[uPyLoader](https://github.com/BetaRavener/uPyLoader) 是一款开源软件,使用它可以方便地连接 MaixPy 并且上传、下载、执行文件,同时监控输出等等功能,功能比较完善 -[下载uPyLoader](https://github.com/BetaRavener/uPyLoader/releases) + + ### 运行文件 @@ -123,7 +123,19 @@ with open("hello.py") as f: - ## 程序库 ->1.[查看更多程序案例](https://github.com/sipeed/kflash_gui/releases). \ No newline at end of file + + + + + + \ No newline at end of file diff --git a/docs/zh_CN/unit/laser-rx.md b/docs/zh_CN/unit/laser-rx.md new file mode 100644 index 00000000..e69de29b diff --git a/docs/zh_CN/unit/laser-tx.md b/docs/zh_CN/unit/laser-tx.md new file mode 100644 index 00000000..e69de29b diff --git a/docs/zh_CN/unit/mini-proto.md b/docs/zh_CN/unit/mini-proto.md new file mode 100644 index 00000000..e69de29b