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

...

Browse Source
This commit is contained in:
LiHuashen
2019-03-21 18:38:17 +08:00
parent 4b764a3d1c
commit baec37deb5
8 changed files with 119 additions and 45 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/en/core/face_kit.md
+10
View File
@@ -1,5 +1,7 @@
# FACES Kit {docsify-ignore-all}
**[GameBoy Keyboard](#gameBoy-keyboard)**      **[Calculator Keyboard](#calculator-keyboard)**      **[QWERTY Keyboard](#qeerty-keyboard)**      **[FACES Charger](#faces-charger)**      **[Related Link](#Related-Link)**
**FACES Kit** is a kit composed of M5Core GRAY, functional keyboards, FACES Base, FACES Charger and some accessories(including DuPont lines, lanyard, M3 fixing screws and so on).
Currently, the functional keyboards are composed of GameBoy, Calculator and QWERTY (*For each functional keyboard, it's integrated **MEGA328** chip, so that when you press a button, a corresponding value(**hexadecimal format**) will be sent from keyboard to M5Core. They(keyboard and m5core) are communicating using I2C. And the I2C address of each keyboard is 0x08.*). We'll add other keyboards to FACES Kit.
@@ -59,6 +61,14 @@ Burn the following example(example function: M5Core and serial terminal will pri
<img src="assets/img/product_pics/core/faces_kit/charger.png">
</figure>
### Related Link
- **[Example](https://github.com/m5stack/M5Stack/tree/master/examples/Modules/FACES)**
- **[MEGA328P Firmware](https://github.com/m5stack/FACES-Firmware)**
- **[Purchase](https://www.aliexpress.com/item/M5Stack-NEW-Offer-ESP32-Open-Source-Faces-Pocket-Computer-with-Keyboard-Gameboy-Calculator-for-Micropython-Arduino/32843973578.html?gps-id=pcStoreJustForYou&scm=1007.23125.122752.0&scm_id=1007.23125.122752.0&scm-url=1007.23125.122752.0&pvid=76f21b54-ba10-40cd-86f9-4bf4f522a9a9&spm=a2g1y.12024536.smartJustForYou_39076158.14)**
### NOTE
*The [Gray version](zh_CN/core/gray) core is configured in the FACES Kit, and our Core has several versions. Similarly, other versions of Core can be stacked on the base of the FACES. The following picture is a comparison of their main differences, which is convenient for you to use.*
docs/en/quick_start/m5stick/m5stick_quick_start_with_uiflow.md
+4 -2
View File
@@ -16,6 +16,8 @@
5. **[Related Video](#Related-Video)**
6. **[UIFlow Tutorial](https://m5stack.github.io/UIFlow_doc/cn/index.html)**
## Update firmware
>Update the stick to the latest firmware version for a better experience.
@@ -74,13 +76,13 @@ Click the `Settings` button at the top right of the [WebIDE](http://flow.m5stack
## Related Video
**UIFlow 的简单介绍**
**UIFlow introduce**
<video width="500" height="315" controls>
<source src="https://m5stack.oss-cn-shenzhen.aliyuncs.com/video/%E6%95%99%E7%A8%8B/UIFlow%20Tutorials/A3%20-%20UIflow%E7%AE%80%E4%BB%8B.mp4" type="video/mp4">
</video>
**UIFlow 的快速指南 (Mac & Linux)**
**UIFlow quick start (Mac & Linux)**
<video width="500" height="315" controls>
<source src="https://m5stack.oss-cn-shenzhen.aliyuncs.com/video/LukeVideo/Getting%20started%20with%20UI%20flow%20(Mac_Linux).mp4" type="video/mp4">
docs/en/unit/makey.md
+26 -15
View File
@@ -8,30 +8,41 @@
## Description
**<mark>MAKEY</mark>** is a makey unit with 16 touchable pins.The Unit makey is based on Arduino Uno Mega328p chip.It communicates with M5Stack Core via GROVE(I2C).It's I2C address is 0x51.
**<mark>MAKEY</mark>** is a unit with built-in MEGA328P chip, buzzer and RGB led, with 16 pins.
<!-- **使用方法：**
This Unit communicates with the M5Core via the GROVE A interface. It's I2C address is 0x51.
1）只是unit上的蜂鸣器发声
**Instructions:**
一根杜邦线或普通导线接unit的GND孔，并另一端被握在左手；另一根杜邦线一端握右手，另一端触碰unit上的音调孔，就会发出对应音调。
1）Just the buzzer on the unit sounds
2）m5core上的喇叭发声
A DuPont line or a common wire is connected to the GND hole of the unit, and the other end of this DuPont line is held in the left hand;
unit通过GROVE线连接至m5core的接口A后，烧录[例程](https://github.com/m5stack/M5-ProductExampleCodes/tree/master/Unit/MAKEY/Arduino)，一根杜邦线或普通导线接unit的GND孔，并另一端被握在左手；另一根杜邦线一端握右手，另一端触碰unit上的音调孔，m5core的喇叭会发出对应音调。 -->
Another DuPont line holds the right hand at one end, the other end of this DuPont line touches the tone hole on the unit, and MAKEY will emit the corresponding tone.
2）Speaker sounds on m5core
Unit is connected to the interface A of m5core through the GROVE line, and burns [example](https://github.com/m5stack/M5-ProductExampleCodes/tree/master/Unit/Makey_NewVersion/Arduino/Makey_new_version).
A DuPont line or a common wire is connected to the GND hole of the unit, And the other end of this DuPont line is held in the left hand;
Another DuPont line holds the right hand at one end, the other end of this DuPont line touches the tone hole on the unit, and m5core will emit the corresponding tone.
## Feature
- Arduino Mega328p Controller
- 16 Keys Fruit Piano(PD0-7 & PB0-5 & PC0,1), 1 NeoPixel pin(PC2) and 1 Buzzer pin(PC3)
- Buzzer inside
- GROVE interface, support [UIFlow](http://flow.m5stack.com) and [Arduino](http://www.arduino.cc)
- Two Lego installation holes
- Arduino Mega328p Controller
- Buzzer inside
- GROVE interface, support [UIFlow](http://flow.m5stack.com) and [Arduino](http://www.arduino.cc)
- Two Lego installation holes
## Include
- 1x MAKEY unit
- 1x GROVE Cable
## Application
- Fruit piano
- RGB Application with Adafruit Library
- Fruit piano
<img src="assets/img/product_pics/unit/M5GO_Unit_makey_05.png" width="40%" height="40%">
@@ -47,7 +58,7 @@ unit通过GROVE线连接至m5core的接口A后，烧录[例程](https://github.c
### 1. Arduino IDE
*The below code is incomplete(just for usage). If you want the complete code, please click [here](https://github.com/m5stack/M5-ProductExampleCodes/tree/master/Unit/MAKEY/Arduino).*
*The below code is incomplete(just for usage). If you want the complete code, please click [here](https://github.com/m5stack/M5-ProductExampleCodes/tree/master/Unit/Makey_NewVersion/Arduino/Makey_new_version).*
```arduino
#include <M5Stack.h>
@@ -73,7 +84,7 @@ while (Wire.available()) {
### 2. UIFlow
*If you want the complete code, please click [here](https://github.com/m5stack/M5-ProductExampleCodes/tree/master/Unit/MAKEY/UIFlow).*
*If you want the complete code, please click [here](https://github.com/m5stack/M5-ProductExampleCodes/tree/master/Unit/Makey_NewVersion/UIFlow).*
<img src="assets/img/product_pics/unit/unit_example/MAKEY/example_unit_makey_02.png">
docs/en/unit/pir.md
+22 -5
View File
@@ -8,15 +8,32 @@
## Description
**<mark>PIR</mark>** is a unit can detect human bogy infrared light. You can judge whether someone passed by it.
**<mark>PIR</mark>** is a unit with integrated body sensing module. It's used to sense human activity. Through this Unit, you can perceive whether someone is passing in front of Unit, which is suitable for the project of human body sensing.
If PIR detect that infrared light has changed, the signal pin of PIR will output high level. Otherwise, it'll output low level.
The working process is to output a high level when the infrared is sensed. During the delay period, if a human body is active in its sensing range, its output will remain high. Delay to turn high level low until the person leaves ( The sensing module detects a delay time period after each activity of the human body. And the time of the last activity is the starting point of the delay time).
This Unit communicates with the M5Core via the GROVE B interface.
## Feature
- Detects the distance 150cm
- GROVE interface, support [UIFlow](http://flow.m5stack.com) and [Arduino](http://www.arduino.cc)
- Two Lego installation holes
- Detects the distance: 150cm
- Delay time: 2s
- Sensing range: < 100°
- Quiescent current: < 60uA
- Operating temperature: -20 - 80 °C
- GROVE interface, support [UIFlow](http://flow.m5stack.com) and [Arduino](http://www.arduino.cc)
- Two Lego installation holes
## Include
- 1x PIR unit
- 1x GROVE Cable
## Application
- Human body induction lamp
- security product
- Automatic induction appliance settings
## Related Link
docs/index.html
+1 -1
View File
@@ -84,7 +84,7 @@
<script src="https://unpkg.com/docsify-pagination/dist/docsify-pagination.min.js"></script>
<script src="https://unpkg.com/docsify/lib/plugins/external-script.min.js"></script>
<script src="https://unpkg.com/docsify/lib/plugins/ga.min.js"></script>
<script src="https://unpkg.com/docsify/lib/plugins/search.js"></script>
<!-- <script src="https://unpkg.com/docsify/lib/plugins/search.js"></script> -->
<script src="https://unpkg.com/docsify/lib/plugins/zoom-image.min.js"></script>
<script src="https://unpkg.com/prismjs/components/prism-bash.min.js"></script>
<script src="https://unpkg.com/prismjs/components/prism-python.min.js"></script>
docs/zh_CN/core/face_kit.md
+5 -1
View File
@@ -1,6 +1,6 @@
# FACES 套件 {docsify-ignore-all}
**[GameBoy Keyboard](#gameBoy-keyboard)**&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;**[Calculator Keyboard](#calculator-keyboard)**&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;**[QWERTY Keyboard](#qeerty-keyboard)**&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;**[FACES Charger 充电座](#faces-charger-充电座)**&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;🛒**[购买链接](https://item.taobao.com/item.htm?spm=a1z10.3-c.w4002-1172588106.15.686c425eRw6D4J&id=562810115476)**
**[GameBoy Keyboard](#gameBoy-keyboard)**&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;**[Calculator Keyboard](#calculator-keyboard)**&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;**[QWERTY Keyboard](#qeerty-keyboard)**&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;**[FACES Charger 充电座](#faces-charger-充电座)**&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;**[相关链接](#相关链接)**
**FACES Kit** 是有 M5Core 、功能面板、FACES Base 、充电底座 FACES Charger 和其他配件(杜邦线、FACES Kit挂绳、M3固定螺丝等等)组成的套件。
@@ -66,6 +66,10 @@ M5Core和FACE底板，再加上Calculator键盘之后，烧录您的固件到M5C
### 相关链接
- **[例程](https://github.com/m5stack/M5Stack/tree/master/examples/Modules/FACES)**
- **[面板的 MEGA328P 固件](https://github.com/m5stack/FACES-Firmware)**
- **[购买链接](https://item.taobao.com/item.htm?spm=a1z10.3-c.w4002-1172588106.15.686c425eRw6D4J&id=562810115476)**
### 注意：
docs/zh_CN/unit/makey.md
+26 -12
View File
@@ -8,28 +8,42 @@
## 描述
**<mark>MAKEY</mark>**是一款自带16引脚的Makey Unit，不过比市面上的Makey模块更容易编程，因为该Unit内置了MEGA328芯片来处理触摸引脚产生的信号。该Unit同样也是与M5Core相连之后，通过PORT A(I2C)控制，其I2C地址是0x51。
**<mark>MAKEY</mark>** 是一款内置 MEGA328P 芯片、蜂鸣器和 RGB 灯的 Unit，并附带 16 个引脚。
该 Unit 与 M5Core 通过 GROVE A 接口 ( IIC ) 通信，其 I2C 地址是 0x51 。。
**使用方法：**
1）只是unit上的蜂鸣器发声
1）只是 unit 上的蜂鸣器发声
一根杜邦线或普通导线接unit的GND孔，并另一端被握在左手；另一根杜邦线一端握右手，另一端触碰unit上的音调孔，就会发出对应音调。
一根杜邦线或普通导线接 unit 的 GND 孔，并另一端被握在左手；
2）m5core上的喇叭发声
另一根杜邦线一端握右手，另一端触碰 unit 上的音调孔，就会发出对应音调。
unit通过GROVE线连接至m5core的接口A后，烧录[例程](https://github.com/m5stack/M5-ProductExampleCodes/tree/master/Unit/MAKEY/Arduino)，一根杜邦线或普通导线接unit的GND孔，并另一端被握在左手；另一根杜邦线一端握右手，另一端触碰unit上的音调孔，m5core的喇叭会发出对应音调。
2）m5core 上的喇叭发声
unit 通过 GROVE 线连接至 m5core 的接口 A 后，烧录[例程](https://github.com/m5stack/M5-ProductExampleCodes/tree/master/Unit/Makey_NewVersion/Arduino/Makey_new_version)。
一根杜邦线或普通导线接 unit 的 GND 孔，并另一端被握在左手；
另一根杜邦线一端握右手，另一端触碰 unit 上的音调孔，m5core 的喇叭会发出对应音调。
## 特性
- 内置Mega328p芯片，蜂鸣器，RGBLed
- 内置 Mega328p 芯片，蜂鸣器，RGBLed
<!-- - 16 Keys Fruit Piano(PD0-7 & PB0-5), 1 NeoPixel pin(PC2) and 1 Buzzer pin(PC3) -->
- GROVE接口，支持[UIFlow](http://flow.m5stack.com)编程，[Arduino](http://www.arduino.cc)编程
- Unit内置两个Lego插件孔，方便与Lego件结合
- GROVE 接口，支持 [UIFlow](http://flow.m5stack.com)编程，[Arduino](http://www.arduino.cc) 编程
- Unit 内置两个 Lego 插件孔，方便与 Lego 件结合
## 包含
- 1x MAKEY Unit
- 1x Grove 线
## 应用
- 水果键盘
- 水果键盘
<img src="assets/img/product_pics/unit/M5GO_Unit_makey_05.png" width="40%" height="40%">
@@ -39,7 +53,7 @@ unit通过GROVE线连接至m5core的接口A后，烧录[例程](https://github.c
- **[官方论坛](http://forum.m5stack.com/)**
- **[模块内MEGA328固件](https://github.com/m5stack/M5-ProductExampleCodes/tree/master/Unit/Makey_NewVersion/firmware_328p)**
- **[模块内 MEGA328 固件](https://github.com/m5stack/M5-ProductExampleCodes/tree/master/Unit/Makey_NewVersion/firmware_328p)**
## 例程
@@ -82,8 +96,8 @@ while (Wire.available()) {
### 管脚映射
<table>
<tr><td>M5Core(GROVE接口A)</td><td>GPIO22</td><td>GPIO21</td><td>5V</td><td>GND</td></tr>
<tr><td>MAKEY创意键盘Unit</td><td>SCL</td><td>SDA</td><td>5V</td><td>GND</td></tr>
<tr><td>M5Core ( GROVE 接口 A )</td><td>GPIO22</td><td>GPIO21</td><td>5V</td><td>GND</td></tr>
<tr><td>MAKEY 创意键盘 Unit</td><td>SCL</td><td>SDA</td><td>5V</td><td>GND</td></tr>
</table>
<img src="assets/img/product_pics/unit/M5GO_Unit_makey_03.png" width="30%" height="30%">
docs/zh_CN/unit/pir.md
+25 -9
View File
@@ -1,4 +1,4 @@
# PIR - 人体红外Unit {docsify-ignore-all}
# PIR - 人体红外 Unit {docsify-ignore-all}
<img src="assets/img/product_pics/unit/M5GO_Unit_pir.png" width="30%" height="30%"><img src="assets/img/product_pics/unit/unit_pir_grove_b.png" width="30%" height="30%">
@@ -8,16 +8,32 @@
## 描述
**<mark>PIR</mark>** 是一款感应人体(生物)红外信号的 Unit，通过该 Unit 可以感知 Unit 前面是否有人经过，适用于做人体感应方面的项目。
**<mark>PIR</mark>** 是一款集成小型人体感应模块的 Unit。用于感应人体活动的 Unit，通过该 Unit 可以感知 Unit 前面是否有人经过，适用于做人体感应方面的项目。
如果 PIR 感应到红外变动，信号引脚会输出高电平，否则一直处于低电平状态。
其工作过程是感应到红外时输出高电平，在延时时间段内，如果有人体在其感应范围活动，其输出将一直保持高电平，直到人离开后才延时将高电平变为低电平 ( 感应模块检测到人体的每次活动后会自己顺延一个延时时间段，并且以最后一次活动的时间为延时时间的起始点 )。
该 Unit 与 M5Core 通过 GROVE B 接口通信。
## 特性
- 检测距离：150cm
- PIR如果感应到红外信号变动，会延时2s左右才动作
- GROVE接口，支持[UIFlow](http://flow.m5stack.com)编程，[Arduino](http://www.arduino.cc)编程
- Unit内置两个Lego插件孔，方便与Lego件结合
- 检测距离：150cm
- 延时时间：2s
- 感应范围：< 100°
- 静态电流：< 60uA
- 工作温度：-20 - 80°C
- GROVE 接口，支持 [UIFlow](http://flow.m5stack.com) 编程，[Arduino](http://www.arduino.cc) 编程
- Unit 内置两个 Lego 插件孔，方便与 Lego 件结合
## 包含
- 1x PIR Unit
- 1x Grove 线
## 应用
- 人体感应灯具
- 安防产品
- 自动感应电器设置
## 相关链接
@@ -56,6 +72,6 @@ M5.update();
### 管脚映射
<table>
<tr><td>M5Core(GROVE接口B)</td><td>GPIO36</td><td>GPIO26</td><td>5V</td><td>GND</td></tr>
<tr><td>人体红外感应Unit</td><td>红外感应引脚</td><td> </td><td>5V</td><td>GND</td></tr>
<tr><td>M5Core ( GROVE 接口 B )</td><td>GPIO36</td><td>GPIO26</td><td>5V</td><td>GND</td></tr>
<tr><td>人体红外感应 Unit</td><td>红外感应引脚</td><td> </td><td>5V</td><td>GND</td></tr>
</table>