From dc10886e8a25bb445f5a6be6c47f74ba67b17128 Mon Sep 17 00:00:00 2001 From: LiHuashen <854410664@qq.com> Date: Sat, 26 Jan 2019 14:30:38 +0800 Subject: [PATCH] add youku videios for products --- docs/en/base/btc_base.md | 15 +++++--- .../m5stick_quick_start_with_uiflow.md | 16 +++++++-- .../related_documents/how_to_burn_firmware.md | 26 ++++++++++++-- docs/zh_CN/app/bala.md | 10 ++++-- docs/zh_CN/app/lidarbot.md | 10 ++++-- docs/zh_CN/base/btc_base.md | 11 ++++-- docs/zh_CN/base/node_base.md | 8 ++++- docs/zh_CN/core/basic.md | 10 +++++- docs/zh_CN/core/gray.md | 20 +++++++++-- docs/zh_CN/module/joystick.md | 12 +++++-- docs/zh_CN/module/plus.md | 10 ++++-- .../m5stick_quick_start_with_uiflow.md | 16 +++++++-- .../related_documents/how_to_burn_firmware.md | 34 ++++++++++++++++--- docs/zh_CN/unit/cardkb.md | 12 +++++-- docs/zh_CN/unit/catear.md | 10 ++++-- docs/zh_CN/unit/m5camera.md | 16 +++++++-- docs/zh_CN/unit/neoflash.md | 10 ++++-- 17 files changed, 205 insertions(+), 41 deletions(-) diff --git a/docs/en/base/btc_base.md b/docs/en/base/btc_base.md index 1643c48d..246e809c 100644 --- a/docs/en/base/btc_base.md +++ b/docs/en/base/btc_base.md @@ -12,11 +12,16 @@ # Description -BTC is a base including DHT12 module which can detect -temperature and humidity. Your M5Stack Core board can stay as a small -displayer(like a small TV or a small IOT central contronller) after -adding this BTC Module. Absolutely, it is more easier to charge M5Stack -Core via Type-C Cable after adding this BTC Module. +**BTC** is a base including DHT12 module which can detect +temperature and humidity. + +Your M5Stack Core board can stay as a small displayer(like a small TV or a small IOT central contronller) after adding this BTC Module. + +**Note:** + +* Although M5Core [BASIC](en/core/basic) or [GRAY](en/core/gray) can be attached to this base, but BTC can not charge them. Actually, our Cores, as we know, are built in chargin chip (IP5306). After plugged a USB cable in, the Core was charging without any charger. + +* Once M5Core has been attached to BTC, it can not controll ENV Unit at this time. Because BTC has been built in DHT12 sensor which will cause IIC address conflit. # Feature diff --git a/docs/en/quick_start/m5stick/m5stick_quick_start_with_uiflow.md b/docs/en/quick_start/m5stick/m5stick_quick_start_with_uiflow.md index 323102b6..cc9f5918 100644 --- a/docs/en/quick_start/m5stick/m5stick_quick_start_with_uiflow.md +++ b/docs/en/quick_start/m5stick/m5stick_quick_start_with_uiflow.md @@ -14,6 +14,8 @@ 4. **[Example](#example)** +5. **[Related Video](#Related-Video)** + ## Update firmware >Update the stick to the latest firmware version for a better experience. @@ -64,8 +66,18 @@ Click the `Settings` button at the top right of the [WebIDE](http://flow.m5stack -## Note +### Note >the resolution of stick screen is **64x128**, so if you want to drag a graph at [WebIDE](http://flow.m5stack.com/) to display on stick screen, it's better for you to drag it within a certain range shown as following figure.(Currently only supports the display of rectangular patterns, as well as labels.) - \ No newline at end of file + + +## Related Video + +**UIFlow instroduce** + + + +**UIFlow 的快速指南 (Mac & Linux)** + + \ No newline at end of file diff --git a/docs/en/related_documents/how_to_burn_firmware.md b/docs/en/related_documents/how_to_burn_firmware.md index 90c4080d..bd1a4959 100644 --- a/docs/en/related_documents/how_to_burn_firmware.md +++ b/docs/en/related_documents/how_to_burn_firmware.md @@ -64,9 +64,29 @@ If M5Burner means be busy after clicking `Burn`, please wait for a few minutes. ## Linux -### 1. Install esptool +### 1. Install pip and esptool -Open Terminal, and enter `sudo pip install esptool` for installing `esptool`. +Open the terminal, enter the following command according to your system version for installing Python package management tool `pip`. + +* Centos7: + +```shell +sudo yum install python-pip +``` + +* Ubuntu and Debian: + +```shell +sudo apt-get install python-pip +``` + +* Arch: + +```shell +sudo pacman -S --needed python-pip +``` + +After installing `pip` successfully, enter `sudo pip install esptool` for installing `esptool`. @@ -84,6 +104,6 @@ If you want to bun v1.1.1 version firmware, switch the current directory to the -Plug the M5Core in, and run `sudo ./flash.sh` +Plug the M5Core in, and enter `sudo chmod +x *.sh` for granting `root` authority, and run `sudo ./flash.sh` \ No newline at end of file diff --git a/docs/zh_CN/app/bala.md b/docs/zh_CN/app/bala.md index 29da0f88..110e518b 100644 --- a/docs/zh_CN/app/bala.md +++ b/docs/zh_CN/app/bala.md @@ -4,7 +4,7 @@ * * * -:memo:**[描述](#描述)**   :bulb:**[上手指南](/zh_CN/quick_start/bala/bala_quick_start)**   :octocat:**[例程](https://github.com/m5stack/M5Bala/tree/master/examples)**   🛒**[购买链接](https://item.taobao.com/item.htm?spm=a1z10.3-c.w4002-1172588106.13.3b6d425eZah7wG&id=574761698176)** +:memo:**[描述](#描述)**   :bulb:**[上手指南](/zh_CN/quick_start/bala/bala_quick_start)**   :octocat:**[例程](https://github.com/m5stack/M5Bala/tree/master/examples)**   🛒**[购买链接](https://item.taobao.com/item.htm?spm=a1z10.3-c.w4002-1172588106.13.3b6d425eZah7wG&id=574761698176)**      :clapper:**[相关视频](#相关视频)** ## 描述 @@ -25,4 +25,10 @@ - 2x 带编码器的N20电机 - Type-C USB线 - \ No newline at end of file + + +## 相关视频 + +**BALA 的演示** + + \ No newline at end of file diff --git a/docs/zh_CN/app/lidarbot.md b/docs/zh_CN/app/lidarbot.md index ae51fffa..819e8353 100644 --- a/docs/zh_CN/app/lidarbot.md +++ b/docs/zh_CN/app/lidarbot.md @@ -4,7 +4,7 @@ * * * -:memo:**[描述](#描述)**   :octocat:**[例程](#例程)**   🛒**[购买链接](https://item.taobao.com/item.htm?spm=a1z10.3-c.w4002-1172588106.10.17fd425e0xq2aq&id=580401820385)** +:memo:**[描述](#描述)**   :octocat:**[例程](#例程)**   🛒**[购买链接](https://item.taobao.com/item.htm?spm=a1z10.3-c.w4002-1172588106.10.17fd425e0xq2aq&id=580401820385)**      :clapper:**[相关视频](#相关视频)** ## 描述 @@ -151,4 +151,10 @@ void loop() AccessPort accessport; accessport.AnalzyCommand();// 发送地图数据给PC上位机 - ``` \ No newline at end of file + ``` + +## 相关视频 + +**Lidar Bot 在迷宫中巡线** + + diff --git a/docs/zh_CN/base/btc_base.md b/docs/zh_CN/base/btc_base.md index ffd019e3..95437022 100644 --- a/docs/zh_CN/base/btc_base.md +++ b/docs/zh_CN/base/btc_base.md @@ -13,7 +13,14 @@ # 描述 -BTC模块是一款包含DHT12(温湿度)传感器的底座。有了BTC底座之后，可以方便给M5Core充电。 +**BTC** 是一款包含 **DHT12(温湿度)传感器**的底座。 + +**注意：** + +* 虽然 M5Core [BASIC](zh_CN/core/basic) 或 [GRAY](zh_CN/core/gray) 接在 BTC 底座上，可是插入USB线之后，不能通过 BTC 不能给它充电。实际上每个 Core 都内置了充电芯片 (IP5306)，接入 Type-C USB 线之后，就能给底座上的电池充电，不需要专门的充电模块。 + +* 在 M5Core BASIC 接上 BTC 底座之后，不能再控制 ENV Unit，因为 BTC 已经内置了 DHT12 传感器，会 IIC 地址冲突。 + # 特性 @@ -32,7 +39,7 @@ BTC模块是一款包含DHT12(温湿度)传感器的底座。有了BTC底座之 **DHT12** - +
ESP32 ChipGPIO22GNDGPIO213V3
ESP32 芯片GPIO22GNDGPIO213V3
DHT12SCLGNDSDA3V3
diff --git a/docs/zh_CN/base/node_base.md b/docs/zh_CN/base/node_base.md index 38eee03a..047db04a 100644 --- a/docs/zh_CN/base/node_base.md +++ b/docs/zh_CN/base/node_base.md @@ -6,7 +6,7 @@ -:memo:**[描述](#描述)**      :octocat:**[例程](https://github.com/m5stack/M5StackModule-Node/tree/master/example)**      :electric_plug:**[原理图](https://github.com/m5stack/Bases-Node/tree/master/schematic)**      🛒**[购买链接](https://item.taobao.com/item.htm?spm=a1z10.5-c.w4002-1172588093.16.6c2275f4nUJEfh&id=581064610318)** +:memo:**[描述](#描述)**      :octocat:**[例程](https://github.com/m5stack/M5StackModule-Node/tree/master/example)**      :electric_plug:**[原理图](https://github.com/m5stack/Bases-Node/tree/master/schematic)**      🛒**[购买链接](https://item.taobao.com/item.htm?spm=a1z10.5-c.w4002-1172588093.16.6c2275f4nUJEfh&id=581064610318)**      :clapper:**[相关视频](#相关视频)** ## 描述 @@ -62,3 +62,9 @@ - **[官方论坛](http://forum.m5stack.com/)** - **数据手册** - [WM8978](http://pdf1.alldatasheet.com/datasheet-pdf/view/96647/WOLFSON/WM8978.html) + +## 相关视频 + +**NODE 的演示 - 语音识别** + + diff --git a/docs/zh_CN/core/basic.md b/docs/zh_CN/core/basic.md index 3c27d115..3d85f40e 100644 --- a/docs/zh_CN/core/basic.md +++ b/docs/zh_CN/core/basic.md @@ -121,6 +121,14 @@ ## 相关视频 -- **m5stack的简介** +- **M5Stack的简介** + +**M5Core 的演示 - 语音识别** + + + +**M5Core 的演示 - 与 Alexa 的互动** + + \ No newline at end of file diff --git a/docs/zh_CN/core/gray.md b/docs/zh_CN/core/gray.md index 9eee22db..98a17fd9 100644 --- a/docs/zh_CN/core/gray.md +++ b/docs/zh_CN/core/gray.md @@ -140,9 +140,25 @@ ## 相关视频 -- **m5stack的简介** +**M5Stack的简介** - + + +**M5Core 拓展LCD显示** + + + +**M5Core 的演示 - 语音识别** + + + +**M5Core 的演示 - 与 Alexa 的互动** + + + +**M5Core 的演示 - 陀螺仪的应用** + + + ## 描述 @@ -117,4 +117,10 @@ Wire.write(r); Wire.write(g); Wire.write(b); Wire.endTransmission(); -``` \ No newline at end of file +``` + +## 相关视频 + +**Joystick 的演示 - 遥控轮椅** + + \ No newline at end of file diff --git a/docs/zh_CN/module/plus.md b/docs/zh_CN/module/plus.md index 1a2e5acb..4d536fa6 100644 --- a/docs/zh_CN/module/plus.md +++ b/docs/zh_CN/module/plus.md @@ -4,7 +4,7 @@ *** -:memo:**[描述](#描述)**      :octocat:**[例程](#原理图)**      :electric_plug:**[原理图](#原理图)**      🛒**[购买链接](https://item.taobao.com/item.htm?spm=a1z10.3-c.w4002-1172588106.11.6e32425el3pHvc&id=579821616764)** +:memo:**[描述](#描述)**      :octocat:**[例程](#原理图)**      :electric_plug:**[原理图](#原理图)**      🛒**[购买链接](https://item.taobao.com/item.htm?spm=a1z10.3-c.w4002-1172588106.11.6e32425el3pHvc&id=579821616764)**      :clapper:**[相关视频](#相关视频)** ## 描述 @@ -72,4 +72,10 @@ while(Wire.available()) { ## 原理图 - \ No newline at end of file + + +## 相关视频 + +**PLUS 的演示 - 菜单界面的翻页与选择** + + \ No newline at end of file diff --git a/docs/zh_CN/quick_start/m5stick/m5stick_quick_start_with_uiflow.md b/docs/zh_CN/quick_start/m5stick/m5stick_quick_start_with_uiflow.md index aec203bc..ebe046f1 100644 --- a/docs/zh_CN/quick_start/m5stick/m5stick_quick_start_with_uiflow.md +++ b/docs/zh_CN/quick_start/m5stick/m5stick_quick_start_with_uiflow.md @@ -14,6 +14,8 @@ 4. **[例程](#例程)** +5. **[相关视频](#相关视频)** + ## 更新固件 >将stick更新到最新固件版本，以获得更棒的体验 @@ -66,10 +68,20 @@ -## 注意 +### 注意 >stick的屏幕**分辨率为64x128**，所以当你UIFlow中往屏幕添加图形的时候，需要将形状放置到一定范围之内才能显示，目前只支持显示矩形图案，以及标签 ->我们会尽快针对stick做出一系列兼容UIFlow的优化，敬请期待 \ No newline at end of file +>我们会尽快针对stick做出一系列兼容UIFlow的优化，敬请期待 + +## 相关视频 + +**UIFlow 的简单介绍** + + + +**UIFlow 的快速指南 (Mac & Linux)** + + diff --git a/docs/zh_CN/related_documents/how_to_burn_firmware.md b/docs/zh_CN/related_documents/how_to_burn_firmware.md index a6b50cf0..662c2298 100644 --- a/docs/zh_CN/related_documents/how_to_burn_firmware.md +++ b/docs/zh_CN/related_documents/how_to_burn_firmware.md @@ -69,9 +69,29 @@ b. 如果你想有ESP32CAM (或 M5CAMERA)，并且想编程它的话，请选择 ## Linux -### 1. 安装 esptool +### 1. 安装 pip 和 esptool -打开终端，输入 `sudo pip install esptool`，安装 esptool +打开终端，根据系统版本，输入如下命令，安装 python的包管理工具 `pip` + +* Centos7: + +```shell +sudo yum install python-pip +``` + +* Ubuntu and Debian: + +```shell +sudo apt-get install python-pip +``` + +* Arch: + +```shell +sudo pacman -S --needed python-pip +``` + +安装完 `pip` 之后，输入 `sudo pip install esptool`，安装 esptool @@ -89,6 +109,12 @@ b. 如果你想有ESP32CAM (或 M5CAMERA)，并且想编程它的话，请选择 -插入 M5Core 设备，在终端执行 `sudo ./flash.sh` +插入 M5Core 设备，在终端执行 `sudo chmod +x *.sh`，对所有的 shell 脚本文件赋予可执行权限，然后再执行 `sudo ./flash.sh` 烧录固件。 - \ No newline at end of file + + +## 相关视频 + +**更新 UIFlow 固件** + + diff --git a/docs/zh_CN/unit/cardkb.md b/docs/zh_CN/unit/cardkb.md index 4100beac..051bca3a 100644 --- a/docs/zh_CN/unit/cardkb.md +++ b/docs/zh_CN/unit/cardkb.md @@ -4,9 +4,9 @@ *** -:memo:**[描述](#描述)**      :octocat:**[例程](#例程)**      🛒**[购买链接](https://item.taobao.com/item.htm?spm=a1z10.3-c.w4002-1172588106.11.270c425eSKImzN&id=584854269757)** +:memo:**[描述](#描述)**      :octocat:**[例程](#例程)**      🛒**[购买链接](https://item.taobao.com/item.htm?spm=a1z10.3-c.w4002-1172588106.11.270c425eSKImzN&id=584854269757)**      :clapper:**[相关视频](#相关视频)** - + ## 描述 @@ -104,4 +104,10 @@ void loop() -
M5Core(GROVE接口A)GPIO22GPIO215VGND
CardKBSCLSDA5VGND
\ No newline at end of file + + +## 相关视频 + +**CarKB 的使用演示** + + \ No newline at end of file diff --git a/docs/zh_CN/unit/catear.md b/docs/zh_CN/unit/catear.md index b52c9db0..6929e3e7 100644 --- a/docs/zh_CN/unit/catear.md +++ b/docs/zh_CN/unit/catear.md @@ -4,7 +4,7 @@ *** -:memo:**[描述](#描述)**      :octocat:**[例程](#例程)**      🛒**[购买链接](https://www.aliexpress.com/store/product/M5Stack-Official-Cute-Cat-Ears-Acrylic-Handbands-with-118Pcs-NeoPixel-LED-Lights-Control-by-UI-Flow/3226069_32956969127.html?spm=2114.12010615.8148356.2.7e9f55cfahQyM2)**       +:memo:**[描述](#描述)**      :octocat:**[例程](#例程)**      🛒**[购买链接](https://www.aliexpress.com/store/product/M5Stack-Official-Cute-Cat-Ears-Acrylic-Handbands-with-118Pcs-NeoPixel-LED-Lights-Control-by-UI-Flow/3226069_32956969127.html?spm=2114.12010615.8148356.2.7e9f55cfahQyM2)**      :clapper:**[相关视频](#相关视频)** ## 描述 @@ -56,4 +56,10 @@ -
M5Core(GROVE接口C)GPIO16GPIO175VGND
CATEAR Unit CATEAR 引脚5VGND
\ No newline at end of file + + +## 相关视频 + +**CatEAR 的演示** + + \ No newline at end of file diff --git a/docs/zh_CN/unit/m5camera.md b/docs/zh_CN/unit/m5camera.md index 8c128996..e922811b 100644 --- a/docs/zh_CN/unit/m5camera.md +++ b/docs/zh_CN/unit/m5camera.md @@ -7,9 +7,9 @@ *** -:memo:**[描述](#描述)**      :bulb:**[上手指南](zh_CN/quick_start/m5camera/m5camera_quick_start)**      :octocat:**[代码](#代码)**      🛒**[购买链接](https://item.taobao.com/item.htm?spm=2013.1.20141001.1.7e6a3f17eDikoR&id=575652539758&scm=1007.12144.95220.42296_0&pvid=922f08d2-0a50-42fe-b89b-d5fef17bc52a&utparam=%7B%22x_hestia_source%22%3A%2242296%22%2C%22x_object_type%22%3A%22item%22%2C%22x_mt%22%3A0%2C%22x_src%22%3A%2242296%22%2C%22x_pos%22%3A1%2C%22x_pvid%22%3A%22922f08d2-0a50-42fe-b89b-d5fef17bc52a%22%2C%22x_object_id%22%3A575652539758%7D)** +:memo:**[描述](#描述)**      :bulb:**[上手指南](zh_CN/quick_start/m5camera/m5camera_quick_start)**      :octocat:**[代码](#代码)**      🛒**[购买链接](https://item.taobao.com/item.htm?spm=2013.1.20141001.1.7e6a3f17eDikoR&id=575652539758&scm=1007.12144.95220.42296_0&pvid=922f08d2-0a50-42fe-b89b-d5fef17bc52a&utparam=%7B%22x_hestia_source%22%3A%2242296%22%2C%22x_object_type%22%3A%22item%22%2C%22x_mt%22%3A0%2C%22x_src%22%3A%2242296%22%2C%22x_pos%22%3A1%2C%22x_pvid%22%3A%22922f08d2-0a50-42fe-b89b-d5fef17bc52a%22%2C%22x_object_id%22%3A575652539758%7D)**      :clapper:**[相关视频](#相关视频)** - + ## 描述 @@ -181,4 +181,14 @@ float pressure = bme.readPressure();//pressure \ No newline at end of file + --> + +## 相关视频 + +**M5Camera 颜色识别** + + + +**应用** + + \ No newline at end of file diff --git a/docs/zh_CN/unit/neoflash.md b/docs/zh_CN/unit/neoflash.md index 026deba4..2ea5abb3 100644 --- a/docs/zh_CN/unit/neoflash.md +++ b/docs/zh_CN/unit/neoflash.md @@ -4,7 +4,7 @@ *** -:memo:**[描述](#描述)**      :octocat:**[例程](#例程)**      🛒**[购买链接](https://item.taobao.com/item.htm?spm=a1z10.3-c.w4002-1172588106.11.36da425eorzBcg&id=582828472414)** +:memo:**[描述](#描述)**      :octocat:**[例程](#例程)**      🛒**[购买链接](https://item.taobao.com/item.htm?spm=a1z10.3-c.w4002-1172588106.11.36da425eorzBcg&id=582828472414)**      :clapper:**[相关视频](#相关视频)** @@ -46,4 +46,10 @@ -
M5Core(GROVE接口B)GPIO36GPIO265VGND
NEOFLASH UnitPIR引脚RGB引脚5VGND
\ No newline at end of file + + +## 相关视频 + +**Neoflash 在 UIFlow 上的使用** + +