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

update docs format

Browse Source
This commit is contained in:
vany5921
2020-03-18 14:39:31 +08:00
parent 479f81ea00
commit 5aa706b967
3 changed files with 13 additions and 72 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/zh_CN/module/encoder.md
+3 -45
View File
@@ -1,7 +1,6 @@
# Module ENCODER {docsify-ignore-all}
<img src="assets/img/product_pics/module/module_encoder_01.png" width="30%" height="30%"> <img src="assets/img/product_pics/module/module_encoder_02.png" width="30%" height="30%">
# Module ENCODER
<div class="product_pic"><img src="assets/img/product_pics/module/module_encoder_01.png"><img src="assets/img/product_pics/module/module_encoder_02.png"></div>
<!-- :memo:**[描述](#描述)**&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;:octocat:**[例程](#例程)**&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;:electric_plug:**[原理图](#原理图)**&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;🛒**[购买链接](https://item.taobao.com/item.htm?spm=a1z10.3-c.w4002-1172588106.11.12b9425efVP5Y2&id=583870225775)** -->
@@ -10,8 +9,6 @@
**ENCODER** 是一款兼容 FACE 套件的旋钮控制面板.专为旋转编码控制而设计,其内部集成Mega328微处理器，在旋钮的周围嵌入了由12个LED组成的LED灯环.
M5Core与ENCODER之间的串行通信协议是I2C（地址：0x5E）
<img src="assets/img/product_pics/module/module_encoder_03.png" width="60%" height="60%">
## 产品特性
- 12 RGB Led
@@ -71,12 +68,10 @@ void get_encoder_increment(void){
- 1x M5Stack ENCODER 模块
- 1x 编码器转盘
## 相关链接
- **[ENCODER 固件](https://github.com/m5stack/M5-ProductExampleCodes/tree/master/Module/ENCODER/firmware_328p/FacesEncoder328)**
## EasyLoader
>EasyLoader是一个简洁快速的程序烧录器，其内置了一个产品相关的案例程序，通过简单步骤将其烧录至主控，即可进行一系列的功能验证.**(程序烧录前，请根据设备类型安装相应驱动程序. M5Core型主机[请点击此处查看CP210X驱动安装教程](zh_CN/arduino/arduino_development?id=安装串口驱动)，M5StickC/V/T/ATOM系列可免驱动使用)**
@@ -114,53 +109,16 @@ void get_encoder_increment(void){
### Arduino IDE
*以下代码仅为片段，如需获取完整代码， [请点击此处.](https://github.com/m5stack/M5-ProductExampleCodes/tree/master/Module/ENCODER/Arduino/faces_encoder).*
```arduino
/*
* faces_encoder.ino
*/
#include <M5Stack.h>
#define Faces_Encoder_I2C_ADDR 0X5E
// declaration
int encoder_increment;//positive: clockwise nagtive: anti-clockwise
uint16_t encoder_value=0;
int button_state;
uint8_t direction;//0: clockwise 1: anti-clockwise
int temp_encoder_increment;
// initialization
M5.begin();
Wire.begin();
// get data from ENCONDER
Wire.requestFrom(Faces_Encoder_I2C_ADDR, 3);
if(Wire.available()){
temp_encoder_increment = Wire.read();// the first byte: increment
button_state = Wire.read();// the second byte: button value
}
// IIC send data, 4bytes
Wire.beginTransmission(Faces_Encoder_I2C_ADDR);
Wire.write(led_index);
Wire.write(r);
Wire.write(g);
Wire.write(b);
Wire.endTransmission();
```
[点击此处下载Arduino代码](https://github.com/m5stack/M5-ProductExampleCodes/tree/master/Module/ENCODER/Arduino/faces_encoder)
### UIFlow
<img src="assets/img/product_pics/module/module_example/ENCODER/encoder.png">
<script>
var purchase_link = 'https://m5stack.com/collections/m5-module/products/encoder-module';
anchor_search(purchase_link);
scrollFunc();
docs/zh_CN/module/faces_finger.md
+5 -14
View File
@@ -1,21 +1,15 @@
# Module FACES FINGER {docsify-ignore-all}
<img src="assets/img/product_pics/module/faces_finger/faces_finger_01.jpg" width="30%" height="30%"> <img src="assets/img/product_pics/module/faces_finger/faces_finger_02.jpg" width="30%" height="30%">
# Module FACES FINGER
<div class="product_pic"><img src="assets/img/product_pics/module/faces_finger/faces_finger_01.jpg"><img src="assets/img/product_pics/module/faces_finger/faces_finger_02.jpg"></div>
## 描述
**FACE-FINGER** 是一款兼容 FACE 套件的指纹识别面板.内部集成 FPC1020A 电容式指纹识别模组,具备多指纹录入、图像处理、特征值提取、指纹比对、搜索等功能.支持设定不同安全级别，能够为您的项目提供稳定可靠的指纹添加、验证、管理机制.
<img src="assets/img/product_pics/module/faces_finger/faces_finger_03.jpg" width="30%" height="30%">
通信协议: UART.
## 产品特性
- FACES套件兼容
- UART2（16/17）
- 串口通讯：UART2（16/17）
- FPC1020A:
- 感应阵列尺寸：160*160像素
- 像素分辨率：256灰度级（8位）
@@ -35,7 +29,6 @@
- 指纹考勤机
- 指纹储物柜
## EasyLoader
<img src="https://m5stack.oss-cn-shenzhen.aliyuncs.com/image/EasyLoader_logo.png" width="100px" style="margin-top:20px">
@@ -52,11 +45,11 @@
### Arduino IDE
*获取完整代码，[请点击此处. ](https://github.com/m5stack/M5-ProductExampleCodes/tree/master/Module/FACES_FINGER)*
[请点击此处获取Arudino代码 ](https://github.com/m5stack/M5-ProductExampleCodes/tree/master/Module/FACES_FINGER)
### 2. UIFlow
*获取完整代码点击此处[下载](https://github.com/m5stack/M5-ProductExampleCodes/tree/master/Module/FACES_FINGER/UIFlow).*
[获取完整代码点击此处下载](https://github.com/m5stack/M5-ProductExampleCodes/tree/master/Module/FACES_FINGER/UIFlow)
<img src="assets/img/product_pics/module/faces_finger/finger.png">
@@ -81,8 +74,6 @@
- 数据手册 **[FPC1020A](https://m5stack.oss-cn-shenzhen.aliyuncs.com/resource/docs/datasheet/hat/1020A_datasheet_cn.pdf)**
## 相关视频
<video class="video_size" controls>
docs/zh_CN/module/faces_rfid.md
+5 -13
View File
@@ -1,22 +1,15 @@
# Module FACES RFID {docsify-ignore-all}
<img src="assets/img/product_pics/module/faces_rfid/faces_rfid_01.jpg" width="30%" height="30%"> <img src="assets/img/product_pics/module/faces_rfid/faces_rfid_02.jpg" width="30%" height="30%">
# Module FACES RFID
<div class="product_pic"><img src="assets/img/product_pics/module/faces_rfid/faces_rfid_01.jpg"> <img src="assets/img/product_pics/module/faces_rfid/faces_rfid_02.jpg"></div>
## 描述
**FACE-RFID** 是一款兼容 FACE 套件的无线射频识别面板.内置**MFRC522**芯片，工作频率为13.56MHz. 支持读卡、写卡、识别、记录、对RF卡进行编码和授权等多个功能.利用磁场感应技术，能够实现非接触式双向信息交互、读取感应卡的信息并验证.
<img src="assets/img/product_pics/module/faces_rfid/faces_rfid_03.jpg" width="30%" height="30%">
通信协议: I2C.
## 产品特性
- FACES套件兼容
- UART2（16/17）
- IIC通讯协议(0x28)
- MFRC522:
- 工作频率: 13.56 MHz
- I2C 数据速率: 快速模式: 最高400 Kbit/s; 高速模式: 最高3400 Kbit/s
@@ -58,11 +51,11 @@
### Arduino IDE
*获取完整代码，[请点击此处. ](https://github.com/m5stack/M5-ProductExampleCodes/tree/master/Module/FACES_RFID)*
[获取完整Arduino代码请点击此处](https://github.com/m5stack/M5-ProductExampleCodes/tree/master/Module/FACES_RFID)
### UIFlow
*下载UIFlow示例，[请点击此处. ](https://github.com/m5stack/M5-ProductExampleCodes/tree/master/Module/FACES_RFID/UIFlow)*
[下载UIFlow示例请点击此处](https://github.com/m5stack/M5-ProductExampleCodes/tree/master/Module/FACES_RFID/UIFlow)
<img src="assets/img/product_pics/module/faces_rfid/faces_rfid.jpg" width="50%" height="50%">
@@ -79,7 +72,6 @@
<tr><td>FACES RFID</td><td>SCL</td><td>SDA</td><td>5V</td><td>GND</td></tr>
</table>
## 相关链接
- Datasheet **[MFRC522](https://m5stack.oss-cn-shenzhen.aliyuncs.com/resource/docs/datasheet/module/MFRC522_en.pdf)**