m5/m5-docs
0
0
Fork 0
mirror of https://github.com/m5stack/m5-docs.git synced 2026-05-20 10:23:01 -07:00
Code Issues Packages Projects Releases Wiki Activity

add new product file

Browse Source
This commit is contained in:
shaoxiang
2019-07-02 17:28:25 +08:00
parent 405281751e
commit 235a52f32f
22 changed files with 300 additions and 25 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/assets/css/main.css
+8 -2
View File
@@ -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;
docs/assets/img/getting_started_pics/m5stickv/1561458023(1).jpg
BIN
View File
Binary file not shown.
Side by Side

Before

Width:  |  Height:  |  Size: 13 KiB

docs/assets/img/getting_started_pics/m5stickv/1561458061(1).jpg
BIN
View File
Binary file not shown.
Side by Side

Before

Width:  |  Height:  |  Size: 5.9 KiB

docs/assets/img/getting_started_pics/m5stickv/kflash_gui_01.jpg
BIN
View File
Binary file not shown.
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 106 KiB

After

Width:  |  Height:  |  Size: 99 KiB

docs/assets/img/getting_started_pics/m5stickv/kflash_gui_02.jpg
BIN
View File
Binary file not shown.
Side by Side

Before

Width:  |  Height:  |  Size: 98 KiB

docs/assets/img/getting_started_pics/m5stickv/putty_02.jpg
BIN
View File
Binary file not shown.
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 15 KiB

After

Width:  |  Height:  |  Size: 21 KiB

docs/en/hat/hat-adc.md
View File
docs/en/hat/hat-dac.md
View File
docs/en/hat/hat-rs485.md
View File
docs/en/quick_start/m5stickv/m5stickv_quick_start.md
+141
View File
@@ -0,0 +1,141 @@
# M5StickV 上手指南 {docsify-ignore-all}
## 目录
**[1. 下载固件](#下载固件)**
**[2. 烧录固件](#烧录固件)**
**[3. 串口调试工具](#串口调试工具)**
**[4. Hello World](#Hello-World)**
**[5. 编辑与运行文件](#编辑与运行文件)**
**[6. 程序库](#程序库)**
## 下载固件
<a href="https://m5stack.oss-cn-shenzhen.aliyuncs.com/resource/docs/m5stickV_Firmware_0630Fixed.kfpkg"><button type="button" class="btn btn-primary">点击下载固件文件</button></a>
## 烧录固件
>1.点击下方对应自己操作系统的 Kflash_GUI烧录工具进行下载.
<div class="link">
<h4><span>Kflash_GUI:</span></h4>
<p>
<a href="http://dl.cdn.sipeed.com/kflash_gui_v1.2.5_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="http://dl.cdn.sipeed.com/kflash_gui_v1.2.5_macOS.dmg" 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="http://dl.cdn.sipeed.com/kflash_gui_v1.2.5_7_linux.tar.xz" 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>
>2.将设备通过Tpye-C数据线连接至电脑，双击打开烧录工具**Kflash_GUI**应用程序,选择对应的设备端口、固件程序、波特率. 点击下载，开始烧录 .
<img src="assets\img\getting_started_pics\m5stickv\kflash_gui_01.jpg">
### 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所使用的端口号）
<img src="assets\img\getting_started_pics\m5stickv\putty_01.jpg">
> 连接成功后，将自动进入，MaixPy 的交互界面. 此时设备正在运行着默认程序，您可以通过按下快捷键"Ctrl+C"中断其运行，并进入命令行.
<img src="assets\img\getting_started_pics\m5stickv\putty_02.jpg">
## 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 并且上传、下载、执行文件，同时监控输出等等功能，功能比较完善
<a href="https://github.com/BetaRavener/uPyLoader/releases"><button type="button" class="btn btn-primary">下载uPyLoader</button></a>
### 运行文件
使用 `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` 文件， 开机会自动先执行这个脚本， 编辑这个脚本的内容即可实现开机自启
## 程序库
<a href="https://maixpy.sipeed.com/zh/libs/standard/"><button type="button" class="btn btn-primary">查看更多程序案例</button></a>
<style>
.link a{
padding-left: 13%;
}
</style>
docs/en/unit/laser-rx.md
View File
docs/en/unit/laser-tx.md
View File
docs/en/unit/mini-proto.md
View File
docs/index.md
+58 -1
View File
@@ -44,7 +44,8 @@
## M5StickC
<a class="btn btn btn-primary" href="#en/quick_start/m5stick/m5stick_quick_start" role="button" style="color:white;text-decoration:none">M5Stick QuickStart</a>&nbsp;&nbsp;&nbsp;&nbsp;
<a class="btn btn btn-primary" href="#en/quick_start/m5stickc/m5stickc_quick_start" role="button" style="color:white;text-decoration:none">M5StickC QuickStart »</a>
<a class="btn btn btn-primary" href="#en/quick_start/m5stickc/m5stickc_quick_start" role="button" style="color:white;text-decoration:none">M5StickC QuickStart</a>&nbsp;&nbsp;&nbsp;&nbsp;
<!-- <a class="btn btn btn-primary" href="#en/quick_start/m5stickv/m5stickv_quick_start" role="button" style="color:white;text-decoration:none">M5StickV QuickStart »</a> -->
**M5Stick**
@@ -62,6 +63,13 @@
<p class="item-title" style="font-style:italic;">M5StickC</p>
</div>
<!-- <div class="item">
<a href="/#/en/core/m5stickv">
<img src="https://m5stack.oss-cn-shenzhen.aliyuncs.com/image/m5-docs_homepage/core/core_m5stickc_01.png">
</a>
<p class="item-title" style="font-style:italic;">M5StickV</p>
</div> -->
## M5GO Lite
## M5GO Kit
## FACES Kit
@@ -693,6 +701,7 @@
## PROTO
## Unit-FAN
## VIBRATOR-MOTOR
## MINI-PROTO
<div class="item">
<a href="/#/en/unit/m5-bit">
@@ -709,6 +718,13 @@
<p class="item-title" style="font-style:italic;">PROTO</p>
</div>
<!-- <div class="item">
<a href="/#/en/unit/mini-proto">
<img src="https://m5stack.oss-cn-shenzhen.aliyuncs.com/image/m5-docs_homepage/unit/unit_proto_01.png">
</a>
<p class="item-title" style="font-style:italic;">MINI-PROTO</p>
</div> -->
<div class="item">
<a href="/#/en/unit/unit_fan">
<img src="https://m5stack.oss-cn-shenzhen.aliyuncs.com/image/m5-docs_homepage/unit/unit_fan_01.jpg">
@@ -729,6 +745,8 @@
## IR
## RS485
## RFID
## LASER-RX
## LASER-TX
<div class="item">
<a href="/#/en/unit/ir">
@@ -751,6 +769,20 @@
<p class="item-title" style="font-style:italic;">RFID</p>
</div>
<div class="item">
<a href="/#/en/unit/laser-rx">
<img src="https://m5stack.oss-cn-shenzhen.aliyuncs.com/image/m5-docs_homepage/unit/unit_rs485_01.png">
</a>
<p class="item-title" style="font-style:italic;">LASER-RX</p>
</div>
<div class="item">
<a href="/#/en/unit/laser-tx">
<img src="https://m5stack.oss-cn-shenzhen.aliyuncs.com/image/m5-docs_homepage/unit/unit_rfid_01.png">
</a>
<p class="item-title" style="font-style:italic;">LASER-TX</p>
</div>
**C-HAT class**
## HAT-ENV
@@ -759,6 +791,7 @@
## HAT-PROTO
## HAT-THERMAL
## HAT-NCIR
## HAT-RS485
<div class="item">
<a href="/#/en/hat/hat-env">
@@ -802,6 +835,30 @@
<p class="item-title" style="font-style:italic;">Thermal</p>
</div>
<!-- <div class="item">
<a href="/#/en/hat/hat-rs485">
<img src="https://m5stack.oss-cn-shenzhen.aliyuncs.com/image/m5-docs_homepage/hat/hat_thermal_01.jpg">
</a>
<p class="item-title" style="font-style:italic;">RS485</p>
</div>
## HAT-ADC
## HAT-DAC
<div class="item">
<a href="/#/en/hat/hat-adc">
<img src="https://m5stack.oss-cn-shenzhen.aliyuncs.com/image/m5-docs_homepage/hat/hat_thermal_01.jpg">
</a>
<p class="item-title" style="font-style:italic;">ADC</p>
</div>
<div class="item">
<a href="/#/en/hat/hat-dac">
<img src="https://m5stack.oss-cn-shenzhen.aliyuncs.com/image/m5-docs_homepage/hat/hat_thermal_01.jpg">
</a>
<p class="item-title" style="font-style:italic;">DAC</p>
</div> -->
**Visual class**
docs/zh_CN/README.md
+60 -1
View File
@@ -48,7 +48,9 @@
<!-- <div class="btn-group"> -->
<a class="btn btn btn-primary" href="#zh_CN/quick_start/m5stick/m5stick_quick_start" role="button" style="color:white;text-decoration:none">M5Stick上手指南</a>&nbsp;&nbsp;&nbsp;&nbsp;
<a class="btn btn btn-primary" href="#zh_CN/quick_start/m5stickc/m5stickc_quick_start" role="button" style="color:white;text-decoration:none">M5StickC上手指南 »</a>
<a class="btn btn btn-primary" href="#zh_CN/quick_start/m5stickc/m5stickc_quick_start" role="button" style="color:white;text-decoration:none">M5StickC上手指南</a>&nbsp;&nbsp;&nbsp;&nbsp;
<!-- <a class="btn btn btn-primary" href="#zh_CN/quick_start/m5stickv/m5stickv_quick_start" role="button" style="color:white;text-decoration:none">M5StickV上手指南 »</a> -->
<!-- </div> -->
**M5Stick**
@@ -68,6 +70,13 @@
<p class="item-title" style="font-style:italic;">M5StickC</p>
</div>
<!-- <div class="item">
<a href="/#/zh_CN/core/m5stickv">
<img src="https://m5stack.oss-cn-shenzhen.aliyuncs.com/image/m5-docs_homepage/core/core_m5stickc_01.png">
</a>
<p class="item-title" style="font-style:italic;">M5StickV</p>
</div> -->
## M5GO Lite
## M5GO Kit
## FACES Kit
@@ -697,6 +706,7 @@
## PROTO
## Unit-FAN
## VIBRATOR-MOTOR
## MINI-PROTO
<div class="item">
<a href="/#/zh_CN/unit/m5-bit">
@@ -713,6 +723,13 @@
<p class="item-title" style="font-style:italic;">PROTO</p>
</div>
<!-- <div class="item">
<a href="/#/zh_CN/unit/mini-proto">
<img src="https://m5stack.oss-cn-shenzhen.aliyuncs.com/image/m5-docs_homepage/unit/unit_proto_01.png">
</a>
<p class="item-title" style="font-style:italic;">MINI-PROTO</p>
</div> -->
<div class="item">
<a href="/#/zh_CN/unit/fan">
<img src="https://m5stack.oss-cn-shenzhen.aliyuncs.com/image/m5-docs_homepage/unit/unit_fan_01.jpg">
@@ -732,6 +749,8 @@
## IR
## RS485
## RFID
## LASER-RX
## LASER-TX
<div class="item">
<a href="/#/zh_CN/unit/ir">
@@ -754,6 +773,20 @@
<p class="item-title" style="font-style:italic;">RFID</p>
</div>
<!-- <div class="item">
<a href="/#/zh_CN/unit/laser-rx">
<img src="https://m5stack.oss-cn-shenzhen.aliyuncs.com/image/m5-docs_homepage/unit/unit_rs485_01.png">
</a>
<p class="item-title" style="font-style:italic;">LASER-RX</p>
</div>
<div class="item">
<a href="/#/zh_CN/unit/laser-tx">
<img src="https://m5stack.oss-cn-shenzhen.aliyuncs.com/image/m5-docs_homepage/unit/unit_rfid_01.png">
</a>
<p class="item-title" style="font-style:italic;">LASER-TX</p>
</div> -->
**C-HAT 类**
## HAT-ENV
@@ -762,6 +795,7 @@
## HAT-PROTO
## HAT-THERMAL
## HAT-NCIR
## HAT-RS485
<div class="item">
<a href="/#/zh_CN/hat/hat-env">
@@ -805,6 +839,31 @@
<p class="item-title" style="font-style:italic;">Thermal</p>
</div>
<!-- <div class="item">
<a href="/#/zh_CN/hat/hat-rs485">
<img src="https://m5stack.oss-cn-shenzhen.aliyuncs.com/image/m5-docs_homepage/hat/hat_thermal_01.jpg">
</a>
<p class="item-title" style="font-style:italic;">RS485</p>
</div>
## HAT-ADC
## HAT-DAC
<div class="item">
<a href="/#/zh_CN/hat/hat-adc">
<img src="https://m5stack.oss-cn-shenzhen.aliyuncs.com/image/m5-docs_homepage/hat/hat_thermal_01.jpg">
</a>
<p class="item-title" style="font-style:italic;">ADC</p>
</div>
<div class="item">
<a href="/#/zh_CN/hat/hat-dac">
<img src="https://m5stack.oss-cn-shenzhen.aliyuncs.com/image/m5-docs_homepage/hat/hat_thermal_01.jpg">
</a>
<p class="item-title" style="font-style:italic;">DAC</p>
</div> -->
**视觉类**
## RGB_LED
docs/zh_CN/hat/hat-adc.md
View File
docs/zh_CN/hat/hat-dac.md
View File
docs/zh_CN/hat/hat-rs485.md
View File
docs/zh_CN/quick_start/m5stickv/m5stickv_quick_start.md
+33 -21
View File
@@ -2,7 +2,7 @@
## 目录
**[1. 准备工作](#准备工作)**
**[1. 下载固件](#下载固件)**
**[2. 烧录固件](#烧录固件)**
@@ -16,44 +16,43 @@
## 下载固件
## 准备工作
>1.下载固件文件，访问PASSSSSSS，根据你的需求下载相应的固件文件，下方为固件类型基本介绍.
<a href="https://m5stack.oss-cn-shenzhen.aliyuncs.com/resource/docs/m5stickV_Firmware_0630Fixed.kfpkg"><button type="button" class="btn btn-primary">点击下载固件文件</button></a>
<div class="container">
<ul class="list-group">
<li class="list-group-item list-group-item-light"><mark>maixpy_v*_no_lvgl.bin</mark>： MaixPy固件, 不带LVGL版本.(LVGL是嵌入式GUI框架, 写界面的时候需要用到)</li>
<li class="list-group-item list-group-item-light"><mark>maixpy_v*_full.bin</mark>： 完整版的MaixPy固件(MicroPython + OpenMV API + lvgl )</li>
<li class="list-group-item list-group-item-light"><mark>maixpy_v0.3.1_minimum.bin</mark>： MaixPy固件最小集合，不支持 MaixPy IDE， 不包含OpenMV的相关算法</li>
<li class="list-group-item list-group-item-light"><mark>face_model_at_0x300000.kfpkg</mark>： 人脸模型，放置在地址位 0x300000， 可以和.bin分开多次下载，不冲突</li>
<li class="list-group-item list-group-item-light"><mark>elf.7z</mark>： elf 文件，用于死机调试</li>
</ul>
</div>
## 烧录固件
>1.点击下方对应自己操作系统的 Kflash_GUI烧录工具进行下载.
>1.下载固件烧录工具[Kflash_GUI](https://github.com/sipeed/kflash_gui/releases).
<div class="link">
<h4><span>Kflash_GUI:</span></h4>
<p>
<a href="http://dl.cdn.sipeed.com/kflash_gui_v1.2.5_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="http://dl.cdn.sipeed.com/kflash_gui_v1.2.5_macOS.dmg" 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="http://dl.cdn.sipeed.com/kflash_gui_v1.2.5_7_linux.tar.xz" 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>
>2.将设备通过Tpye-C数据线连接至电脑，双击打开烧录工具**Kflash_GUI**应用程序,选择对应的设备端口、固件程序、波特率. 点击下载，开始烧录 .
>2.将设备通过Tpye-C数据线连接至电脑，双击打开烧录工具**Kflash_GUI**应用程序,选择对应的设备端口、固件程序、波特率. 点击下载，开始烧录. （固件文件与模型文件可分开烧录，二者不冲突）
<img src="assets\img\getting_started_pics\m5stickv\kflash_gui_01.jpg">
### 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所使用的端口号）
<img src="assets\img\getting_started_pics\m5stickv\putty_01.jpg">
> MaixPy 的交互界面.
> 连接成功后，将自动进入，MaixPy 的交互界面. 此时设备正在运行着默认程序，您可以通过按下快捷键"Ctrl+C"中断其运行，并进入命令行.
<img src="assets\img\getting_started_pics\m5stickv\putty_02.jpg">
@@ -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)
<a href="https://github.com/BetaRavener/uPyLoader/releases"><button type="button" class="btn btn-primary">下载uPyLoader</button></a>
### 运行文件
@@ -123,7 +123,19 @@ with open("hello.py") as f:
## 程序库
>1.[查看更多程序案例](https://github.com/sipeed/kflash_gui/releases).
<a href="https://maixpy.sipeed.com/zh/libs/standard/"><button type="button" class="btn btn-primary">查看更多程序案例</button></a>
<style>
.link a{
padding-left: 13%;
}
</style>
docs/zh_CN/unit/laser-rx.md
View File

Some files were not shown because too many files have changed in this diff Show More