From 1307df5dde5725832254d897edb51a4739eb0165 Mon Sep 17 00:00:00 2001
From: vany5921 <908744431@qq.com>
Date: Thu, 2 Apr 2020 19:30:13 +0800
Subject: [PATCH] update doc format
---
docs/zh_CN/unit/neoflash.md | 50 ++++++++++++++++++++++++++-----------
docs/zh_CN/unit/neopixel.md | 25 ++++++++++---------
docs/zh_CN/unit/op180.md | 10 ++++----
docs/zh_CN/unit/op90.md | 10 ++++----
docs/zh_CN/unit/pahub.md | 32 ++++++++----------------
5 files changed, 70 insertions(+), 57 deletions(-)
diff --git a/docs/zh_CN/unit/neoflash.md b/docs/zh_CN/unit/neoflash.md
index 21a1e5c3..9ebdaafa 100644
--- a/docs/zh_CN/unit/neoflash.md
+++ b/docs/zh_CN/unit/neoflash.md
@@ -6,7 +6,7 @@
## 描述
-**NEOFLASH** 是一款Neopixel灯板.集成 192 个 RGB LED(24x8),与 PIR 人体感应 Unit,且提供 3 个I2C拓展接口.灯板通过GROVE B接口与M5Core进行连接.(Neopixel连接GPIO26、PIR人体感应连接至GPIO36.)灯板背部安装磁铁,可以将其放置在金属物体表面吸附固定.
+**NEOFLASH** 是一款RGB LED灯板.集成 192 个 RGB LED(24x8),与 PIR 人体感应 Unit,且提供 3 个I2C拓展接口.灯板通过GROVE B接口与M5Core进行连接.(RGB LED连接GPIO26、PIR人体感应连接至GPIO36.)灯板背部安装磁铁,可以将其放置在金属物体表面吸附固定.
@@ -14,9 +14,7 @@
## 产品特性
-- Neopixel灯数量: 192
-- PIR人体感应
-- PORTA 拓展(3个)
+- 人体感应
- 开发平台: Arduino, UIFlow(Blockly, Python)
- 2x LEGO 兼容孔
@@ -25,11 +23,28 @@
- 1x NeoFlash Unit
- 1x Grove 线
-## 相关链接
+## 规格参数
+
+
+
+ | 规格 |
+ 参数 |
+
+
+ | RGB LED |
+ x 192 |
+
+
+ | PORTA接口 |
+ x 3 |
+
+
+ | 孔数量 |
+ 40 |
+
+
-- **[FastLED Library](https://github.com/FastLED/FastLED/wiki/Overview)**
-- **[FastLED Reference(中文版本)](http://www.taichi-maker.com/homepage/reference-index/arduino-library-index/fastled-library/)**
## EasyLoader
@@ -43,13 +58,26 @@
?>3.目前EasyLoader仅适用于Windows操作系统、兼容M5体系采用ESP32作为控制核心的主机.在为M5Core烧录前需要安装CP210X驱动程序(使用M5StickC作为控制器的则无需安装)[点击此处查看驱动安装教程](zh_CN/related_documents/M5Burner#安装串口驱动)
+### 管脚映射
+
+
+| M5Core(GROVE B) | GPIO36 | GPIO26 | 5V | GND |
+ | NEOFLASH Unit | PIR Pin | RGB Pin | 5V | GND |
+
+
+## 相关链接
+
+- **[FastLED Library](https://github.com/FastLED/FastLED/wiki/Overview)**
+
+- **[FastLED Reference(中文版本)](http://www.taichi-maker.com/homepage/reference-index/arduino-library-index/fastled-library/)**
+
## 案例程序
### Arduino IDE
该案例将展示基于网络的PIR人体感应时钟.当检测到人体靠近时,灯板点亮显示实时时间,当检测信号消失,则熄灭灯板.
-[请点击此处下载Arduino示例代码](https://github.com/m5stack/M5-ProductExampleCodes/tree/master/Unit/NEOPIXEL/Arduino)
+- [请点击此处下载Arduino示例代码](https://github.com/m5stack/M5-ProductExampleCodes/tree/master/Unit/NEOPIXEL/Arduino)
@@ -59,12 +87,6 @@
-### 管脚映射
-
-
-| M5Core(GROVE B) | GPIO36 | GPIO26 | 5V | GND |
- | NEOFLASH Unit | PIR Pin | RGB Pin | 5V | GND |
-
## 相关视频
diff --git a/docs/zh_CN/unit/neopixel.md b/docs/zh_CN/unit/neopixel.md
index 5b09ec19..475cb938 100644
--- a/docs/zh_CN/unit/neopixel.md
+++ b/docs/zh_CN/unit/neopixel.md
@@ -22,12 +22,6 @@
- 1x RGB LED Unit
-## 相关链接
-
-- **[FastLED Library](https://github.com/FastLED/FastLED/wiki/Overview)**
-
-- **[FastLED Reference(中文版本)](http://www.taichi-maker.com/homepage/reference-index/arduino-library-index/fastled-library/)**
-
## EasyLoader
@@ -40,6 +34,19 @@
?>3.目前EasyLoader仅适用于Windows操作系统、兼容M5体系采用ESP32作为控制核心的主机.在为M5Core烧录前需要安装CP210X驱动程序(使用M5StickC作为控制器的则无需安装)[点击此处查看驱动安装教程](zh_CN/related_documents/M5Burner#安装串口驱动)
+### 管脚映射
+
+
+ | M5Core(GROVE A) | GPIO22 | GPIO21 | 5V | GND |
+ | NEOPIXEL Unit | / | Signal Pin | 5V | GND |
+
+
+## 相关链接
+
+- **[FastLED Library](https://github.com/FastLED/FastLED/wiki/Overview)**
+
+- **[FastLED Reference(中文版本)](http://www.taichi-maker.com/homepage/reference-index/arduino-library-index/fastled-library/)**
+
## 案例程序
### 1. Arduino IDE
@@ -54,12 +61,6 @@
-### 管脚映射
-
-
- | M5Core(GROVE A) | GPIO22 | GPIO21 | 5V | GND |
- | NEOPIXEL Unit | / | Signal Pin | 5V | GND |
-
## 相关视频
diff --git a/docs/zh_CN/unit/op180.md b/docs/zh_CN/unit/op180.md
index 0b4e1d06..fedda07e 100644
--- a/docs/zh_CN/unit/op180.md
+++ b/docs/zh_CN/unit/op180.md
@@ -13,7 +13,7 @@
- 角度:180°
- 红外限位开关
-## 套件清单
+## 包含
- 1x OP.180 unit
- 1x GROVE 线
@@ -23,10 +23,6 @@
- 自动门
- 自动化机械控制
-## 原理图
-
-
-
## EasyLoader
@@ -39,6 +35,10 @@
?>3.目前EasyLoader仅适用于Windows操作系统、兼容M5体系采用ESP32作为控制核心的主机.在为M5Core烧录前需要安装CP210X驱动程序(使用M5StickC作为控制器的则无需安装)[点击此处查看驱动安装教程](zh_CN/related_documents/M5Burner#安装串口驱动)
+## 原理图
+
+
+
## 案例程序
- [点击此处获取Arduino案例程序](https://github.com/m5stack/M5-ProductExampleCodes/tree/master/Unit/OP90.180).
diff --git a/docs/zh_CN/unit/op90.md b/docs/zh_CN/unit/op90.md
index cc3386a4..077c6de0 100644
--- a/docs/zh_CN/unit/op90.md
+++ b/docs/zh_CN/unit/op90.md
@@ -13,7 +13,7 @@
- 角度:90°
- 红外限位开关
-## 套件清单
+## 包含
- 1x OP.90 unit
- 1x GROVE 线
@@ -23,10 +23,6 @@
- 自动门
- 自动化机械控制
-## 原理图
-
-
-
## EasyLoader
@@ -39,6 +35,10 @@
?>3.目前EasyLoader仅适用于Windows操作系统、兼容M5体系采用ESP32作为控制核心的主机.在为M5Core烧录前需要安装CP210X驱动程序(使用M5StickC作为控制器的则无需安装)[点击此处查看驱动安装教程](zh_CN/related_documents/M5Burner#安装串口驱动)
+## 原理图
+
+
+
## 案例程序
- [点击此处获取Arduino案例程序](https://github.com/m5stack/M5-ProductExampleCodes/tree/master/Unit/OP90.180).
diff --git a/docs/zh_CN/unit/pahub.md b/docs/zh_CN/unit/pahub.md
index 52fb763b..56cf4690 100644
--- a/docs/zh_CN/unit/pahub.md
+++ b/docs/zh_CN/unit/pahub.md
@@ -12,25 +12,19 @@
内部集成**TCA9548A**-I2C多路复用器,配有8个可通过I2C总线控制的双向转换开关.串行时钟/串行数据(SCL /SDA)上行对可扩展为8个下行对或通道.根据可编程控制寄存器的内容,可选择任一单独SCn /SDn通道或者通道组合.
-支持多层 Unit 嵌套,这意味着你可以将PaHUB连接到PaHUB上以获得更多的I2C从设备接口.(例:将7个Unit进行连接,将获得36个**I2C**接口,且在主控仅仅占用了一个GROVE端口)当你的项目需要挂载多个I2C设备或存在I2C地址冲突时,PaHUB Unit 是完美解决方案.
+支持多层 Unit 嵌套,这意味着你可以将PaHUB连接到PaHUB上以获得更多的I2C从设备接口.(例:将7个Unit进行连接,将获得36个**I2C**接口,且在主控仅仅占用了一个GROVE端口)当你的项目需要挂载多个I2C设备或存在I2C地址冲突时,PaHUB Unit 是完美解决方案.该 Unit 的 I2C 地址为0x70(可通过调整电阻进行更改).
-该 Unit 的 I2C 地址为0x70(可通过调整电阻进行更改).
-
-*注意:编程时请注意通道顺序*
+注意:编程时请注意通道顺序
-### 产品特性
+## 产品特性
- I2C GROVE PORTA 拓展
- 2x LEGO 兼容孔
- 允许多个嵌套
- 1-6 拓展
-## 原理图
-
-
-
参考原理图及TCA9548A数据手册可知,该Unit能够通过控制A0~A2引脚的电平组合,修改设备的I2C地址。(默认地址为0x70)
在Unit的PCB板上预留了三个贴片电阻焊接位,分别为A0-A2,如下图所示。
@@ -41,27 +35,23 @@
-### 套件清单
+## 包含
- 1x PaHUB Unit
- 1x Grove 线
-## 参考文档
+## 应用
-- Datasheet - **[TCA9548A](https://m5stack.oss-cn-shenzhen.aliyuncs.com/resource/docs/datasheet/unit/TCA9548A_en.pdf)**
+- I2C扩展
-## 案例程序
+## 原理图
-- 通讯类型 - I2C
-- 地址 - 0x70
+
-### UIFlow
+## 相关链接
-[获取UIFlow示例点击这里](https://github.com/m5stack/M5-ProductExampleCodes/tree/master/Unit/PaHUB/UIFlow)
-
-
-
-[Arduino示例程序](https://github.com/m5stack/M5-ProductExampleCodes/tree/master/Unit/PaHUB/Arduino/PaHUB)
+- **Datasheet**
+ - **[TCA9548A](https://m5stack.oss-cn-shenzhen.aliyuncs.com/resource/docs/datasheet/unit/TCA9548A_en.pdf)**
## EasyLoader