diff --git a/docs/assets/img/product_pics/bases/faces_06.jpg b/docs/assets/img/product_pics/bases/faces_06.jpg new file mode 100644 index 00000000..5ad6e207 Binary files /dev/null and b/docs/assets/img/product_pics/bases/faces_06.jpg differ diff --git a/docs/assets/img/product_pics/bases/faces_07.png b/docs/assets/img/product_pics/bases/faces_07.png new file mode 100644 index 00000000..3907e705 Binary files /dev/null and b/docs/assets/img/product_pics/bases/faces_07.png differ diff --git a/docs/assets/img/product_pics/core/faces_kit/calculator.jpg b/docs/assets/img/product_pics/core/faces_kit/calculator.jpg new file mode 100644 index 00000000..4a1b4e18 Binary files /dev/null and b/docs/assets/img/product_pics/core/faces_kit/calculator.jpg differ diff --git a/docs/assets/img/product_pics/core/faces_kit/charger.jpg b/docs/assets/img/product_pics/core/faces_kit/charger.jpg new file mode 100644 index 00000000..ffdbbfd0 Binary files /dev/null and b/docs/assets/img/product_pics/core/faces_kit/charger.jpg differ diff --git a/docs/assets/img/product_pics/core/faces_kit/faces_base.jpg b/docs/assets/img/product_pics/core/faces_kit/faces_base.jpg new file mode 100644 index 00000000..bc0b5f3a Binary files /dev/null and b/docs/assets/img/product_pics/core/faces_kit/faces_base.jpg differ diff --git a/docs/assets/img/product_pics/core/faces_kit/faces_kit.jpg b/docs/assets/img/product_pics/core/faces_kit/faces_kit.jpg new file mode 100644 index 00000000..5b1f7c69 Binary files /dev/null and b/docs/assets/img/product_pics/core/faces_kit/faces_kit.jpg differ diff --git a/docs/assets/img/product_pics/core/faces_kit/faces_power_on.png b/docs/assets/img/product_pics/core/faces_kit/faces_power_on.png new file mode 100644 index 00000000..e0d1ed84 Binary files /dev/null and b/docs/assets/img/product_pics/core/faces_kit/faces_power_on.png differ diff --git a/docs/assets/img/product_pics/core/faces_kit/gameboy.jpg b/docs/assets/img/product_pics/core/faces_kit/gameboy.jpg new file mode 100644 index 00000000..3cf24d3f Binary files /dev/null and b/docs/assets/img/product_pics/core/faces_kit/gameboy.jpg differ diff --git a/docs/assets/img/product_pics/core/faces_kit/gameboy_01.jpg b/docs/assets/img/product_pics/core/faces_kit/gameboy_01.jpg new file mode 100644 index 00000000..f90d9e65 Binary files /dev/null and b/docs/assets/img/product_pics/core/faces_kit/gameboy_01.jpg differ diff --git a/docs/assets/img/product_pics/core/faces_kit/qwerty.jpg b/docs/assets/img/product_pics/core/faces_kit/qwerty.jpg new file mode 100644 index 00000000..d3abd066 Binary files /dev/null and b/docs/assets/img/product_pics/core/faces_kit/qwerty.jpg differ diff --git a/docs/en/product_documents.md b/docs/en/product_documents.md index 51976898..c834fd3b 100644 --- a/docs/en/product_documents.md +++ b/docs/en/product_documents.md @@ -12,6 +12,7 @@ | [GRAY](/en/product_documents/m5stack-core/m5core_gray) | / | | [WHITE(M5GO Main Board)](/en/product_documents/m5stack-core/m5core_white) | / | | [FIRE](/en/product_documents/m5stack-core/m5core_fire) | / | +| [FACES Kit](/en/product_documents/m5stack-core/face_kit) | / | | [M5GO IOT Kit](/en/product_documents/m5stack-core/m5go_iot_starter_kit) | / | diff --git a/docs/en/product_documents/bases/face_base.md b/docs/en/product_documents/bases/face_base.md index 9b4bd436..dcdf1959 100644 --- a/docs/en/product_documents/bases/face_base.md +++ b/docs/en/product_documents/bases/face_base.md @@ -1,78 +1,30 @@ -# FACE-Base +# FACE Base -*This document will introduct FACE Base and FACE Kit. FACE Base is just a base, FACE Kit is composed of one M5Core, three keyboards and one FACE Base* - -## DESCRIPTION - -FACE Base is a base among FACE Kit. - -FACE Kit is a excellent device composed of a GRAY M5Core, 3 keyboards(*QWERTY, GameBoy, Calculator*) and a FACE Base. When you are working on a project need a QWERTY for input, you just need to stack QWERTY keyboard on FACE Base. When you are working on a calculating project, you just need to change QWERTY to Calculator. You can event program FACE Kit through [M5Cloud](http://cloud.m5stack.com)(**MicroPython**) after burnning `M5Cloud` firmware. In the near future, you can program it through [M5Flow](http://flow.m5stack.com) platform. - -The URL of M5Cloud is [http://cloud.m5stack.com](http://cloud.m5stack.com) or [http://io.m5stack.com](http://io.m5stack.com). - -Absolutely, there are some expanding gpio of M-Bus at the back of FACE Base. Each expanding gpio is expanded as pin and port for convenience and flexibility. - -FACE Kit can be pocket computer because a Battery(650mAh) has been built in the FACE Base. Surely, when the battery has been low-power, you can charge it by put it on a charge base. - -## FEATURES - -- Programming Support: MicroPython -- Support Nintendo emulator -- TF Card Support(Up to 16G) - -## INCLUDES - -**FACE Base** - -- 1x FACE Base - - -**FACE Kit** - -- 1x M5Stack GrayCore -- 3x KeyBoard - - 1x QWERTY - - 1x GameBoy - - 1x Calculator -- 1x FACE Base -- 1x CHG Base -- Type-C USB Cable -- User Manual - - -## APPLICATIONS - -- DIY Gameboy Games: -- Nintendo emulator -- Tetris -- DIY Calculator -- DIY PocketComputer - -## DOCUMENTS - -- **Example** - - [Arduino](https://github.com/m5stack/M5Stack/tree/master/examples/Modules/FACES) - - [MicroPython](https://github.com/m5stack/M5Cloud/tree/master/examples/FACES) - -- **Quick Start** - - Arduino - [MacOS](/en/quick_start/m5core/m5stack_core_get_started_Arduino_MacOS) - [Windows_64](/en/quick_start/m5core/m5stack_core_get_started_Arduino_Windows) - - [MicroPython(M5Cloud)](en/quick_start/m5core/m5stack_core_get_started_MicroPython_m5cloud) - -- **[Purchase](https://www.aliexpress.com/store/product/M5Stack-NEW-Offer-ESP32-Open-Source-Faces-Pocket-Computer-with-Keyboard-Gameboy-Calculator-for-Micropython-Arduino/3226069_32843973578.html?spm=2114.12010615.8148356.8.25e96be7Jd99Pb.html)** +## Description +FACE Base is a base of [FACES Kit](en/product_documents/m5stack-core/face_kit). It's composed of M5Core base and battery as shown below.
- faces_01 +
+ +There are some expanding gpio(see the last picture) of M-Bus at the back of FACES Base, in order for you make a complex project conveniently. Obsolutely, a battery(600mAh) is built in base, so that you can use FACES Kit without usb cable. + +## Usage + +**Please stack M5Core and FACES Keyboard(*i.e. QWERTY, GameBoy, Calculator*) over Base when use it as shown below** +
- faces_02 +
+ +## Related Link + +- **[Purchase FACES Kit](https://www.aliexpress.com/store/product/M5Stack-NEW-Offer-ESP32-Open-Source-Faces-Pocket-Computer-with-Keyboard-Gameboy-Calculator-for-Micropython-Arduino/3226069_32843973578.html?spm=2114.12010615.8148356.2.75cdb3ceTGkLQo)** + + +## M-Bus +
- faces_03 -
-
- faces_04 -
-
- faces_05 + basic_05
diff --git a/docs/en/product_documents/m5stack-core/face_kit.md b/docs/en/product_documents/m5stack-core/face_kit.md new file mode 100644 index 00000000..938a02d1 --- /dev/null +++ b/docs/en/product_documents/m5stack-core/face_kit.md @@ -0,0 +1,52 @@ +# FACES Kit + +**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. We'll add other keyboards to FACES Kit. You can program it through Arduino IDE or MicroPython. For different applications, you can stack corresponding keyboard on FACES Base and burn corresponding firmware into M5Core. And here, you can learn more about [FACES Base](en/product_documents/bases/face_base). + +*For each 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.* + +Now, here's the picture of the whole kit. + +
+ +
+ +### 1. GameBoy Keyboard + +When create a handheld game, you can stack a GameBoy keyboard over FACES Base straight. And burn a Nintendo Entertainment System emulator. + +Here is the method of burning emulator and a game: [download game](en/quick_start/faces/gameboy_burn_a_nes_game) + +
+ +
+ +### 2. Calculator Keyboard + +When create a calculator, you need the Calculator Keyboard. Burn your firmware into M5Core. The button which was pressed will execute the callback specifical function, so the calculator is created. + +
+ +
+ +### 3. QWERTY Keyboard + +When your project needs full keyboard input, just to stack QWERTY over Base. + +Burn the following example(example function: M5Core and serial terminal will print button you pressed) + +- **source file of example** - a. [Arduino](https://github.com/m5stack/M5Stack/tree/master/examples/Modules/FACES) - b. [MicroPython](https://github.com/m5stack/M5Cloud/tree/master/examples/FACES)(for M5Cloud) + +- **M5Cloud usage** - [MicroPython(M5Cloud)](en/quick_start/m5core/m5stack_core_get_started_MicroPython_m5cloud) + +
+ +
+ + +### 4. FACES Charger + +**FACES Charger** built in some magnets. When charging, the FACES can be attached with charger. They are connected by PIGO Pin. + +
+ +
diff --git a/docs/en/product_documents/m5stack-core/m5core_basic.md b/docs/en/product_documents/m5stack-core/m5core_basic.md index d1b7e584..8e0d0102 100644 --- a/docs/en/product_documents/m5stack-core/m5core_basic.md +++ b/docs/en/product_documents/m5stack-core/m5core_basic.md @@ -90,8 +90,6 @@ The a Bottom board on the back of M5Core. It's designed for expanding gpio on M- - Type-C USB Cable - User Manual -### - ## DOCUMENTS - **[Schematic](https://github.com/m5stack/M5-3D_and_PCB/blob/master/M5_Core_SCH%2820171206%29.pdf)** diff --git a/docs/en/product_documents/m5stack-core/m5go_iot_starter_kit.md b/docs/en/product_documents/m5stack-core/m5go_iot_starter_kit.md index d29dc237..716e868a 100644 --- a/docs/en/product_documents/m5stack-core/m5go_iot_starter_kit.md +++ b/docs/en/product_documents/m5stack-core/m5go_iot_starter_kit.md @@ -93,7 +93,7 @@ We also supply some courses for teaching IOT programming. If you are interesting **MEMS Chip** -*MPU9250 i2c address: 0x68* +*MPU9250 i2c address: 0x68* | MPU9250 | ESP32 Chip | | :----------: |:------------: | diff --git a/docs/en/quick_start/faces/gameboy_burn_a_nes_game.md b/docs/en/quick_start/faces/gameboy_burn_a_nes_game.md index 42a9b667..c96b141d 100644 --- a/docs/en/quick_start/faces/gameboy_burn_a_nes_game.md +++ b/docs/en/quick_start/faces/gameboy_burn_a_nes_game.md @@ -37,3 +37,9 @@ Open Flash Download Tools[点击下载](https://www.espressif.com/sites/default/ ## 3. Reset you device After reset FACES, enjoy your game now. + +
+ +
+ +?> Tip **If you want another game, please change the `Game file`(.nes)** diff --git a/docs/zh_CN/product_documents.md b/docs/zh_CN/product_documents.md index 88ac3234..1378a843 100644 --- a/docs/zh_CN/product_documents.md +++ b/docs/zh_CN/product_documents.md @@ -11,6 +11,7 @@ | [BASIC](zh_CN/product_documents/m5stack-core/m5core_basic) | [Stick](zh_CN/product_documents/m5stack-core/minicore_stick) | | [GRAY](zh_CN/product_documents/m5stack-core/m5core_gray) | / | | [FIRE](zh_CN/product_documents/m5stack-core/m5core_fire) | / | +| [FACE Kit](zh_CN/product_documents/m5stack-core/face_kit) | / | @@ -32,7 +33,7 @@ | | | | | :------------------: |:------------------:| :--------------------:| -| [M5GO底座](/zh_CN/file_to_diplay_null) | [PLC底座](/zh_CN/product_documents/modules/module_plc) | [FACE底座](/zh_CN/product_documents/modules/module_face) | +| [M5GO底座](/zh_CN/file_to_diplay_null) | [PLC底座](/zh_CN/product_documents/modules/module_plc) | [FACE底座](/zh_CN/product_documents/bases/face_base) | | [LAN底座](/zh_CN/product_documents/bases/lan_base) | / | / | | [Node底座](/zh_CN/product_documents/bases/node_base) | / | / | diff --git a/docs/zh_CN/product_documents/bases/face_base.md b/docs/zh_CN/product_documents/bases/face_base.md index b07a0f96..246e4204 100644 --- a/docs/zh_CN/product_documents/bases/face_base.md +++ b/docs/zh_CN/product_documents/bases/face_base.md @@ -1,3 +1,30 @@ -# FACE-Base +# FACE Base -## (coming soon...) \ No newline at end of file +## 描述 + +FACE Base是[FACES Kit](zh_CN/product_documents/m5stack-core/face_kit)套件中的底座，主要由M5Core底座和电池模块组成，如下图。 + +
+ +
+ +FACE Base其背面拓展了`M-Bus总线`的部分GPIO接口(*见最后一张图片*)，方便做拓展功能，其下部分内嵌600mAh的电池，方便使用FACES套件时，能离线操作。 + +## 使用 + +**使用时堆叠M5Core主控和功能面板(*如: QWERTY, GameBoy, Calculator*)，如下图所示** + +
+ +
+ +## 相关链接 + +- **[FACES Kit购买链接](https://www.aliexpress.com/store/product/M5Stack-NEW-Offer-ESP32-Open-Source-Faces-Pocket-Computer-with-Keyboard-Gameboy-Calculator-for-Micropython-Arduino/3226069_32843973578.html?spm=2114.12010615.8148356.2.75cdb3ceTGkLQo)** + + +## M-Bus总线 + +
+ basic_05 +
diff --git a/docs/zh_CN/product_documents/m5stack-core/face_kit.md b/docs/zh_CN/product_documents/m5stack-core/face_kit.md new file mode 100644 index 00000000..7788983b --- /dev/null +++ b/docs/zh_CN/product_documents/m5stack-core/face_kit.md @@ -0,0 +1,56 @@ +# FACES Kit + +**FACES Kit**是有M5Core、功能面板、FACES Base、充电底座FACES Charger和其他配件(杜邦线、FACES Kit挂绳、M3固定螺丝等等)组成的套件。目前功能面板有GameBoy、Calculator和QWERTY三种，以后会继续增加。可以通过Arduino IDE或者M5Cloud对套件编程，在不同的应用场景下，堆叠不一样的功能面板，烧录对应固件到M5Core，实现对应的功能。其中FACES底座的电池是650mAh。而关于FACES底座的详情欢迎阅读介绍[FACES Base](zh_CN/product_documents/bases/face_base)的介绍。 + +*每个功能面板都集成了**MEGA328**芯片，在按下每个独立按键都可以返回唯一的键值。功能面板与M5Core之间通过**I2C**通信，而从机(即功能面板)的I2C地址为0x08。* + + +下图是整个套件的内容 + +
+ +
+ +### 1. GameBoy Keyboard + +在做游戏娱乐时，需要GameBoy键盘。 +M5Core和FACE底板，再加上GameBoy键盘之后，点击[这里](zh_CN/quick_start/faces/gameboy_burn_a_nes_game)烧录游戏模拟器，然后能玩多款经典的电子游戏。 + +GameBoy游戏烧录方法：[下载游戏](zh_CN/quick_start/faces/gameboy_burn_a_nes_game) + +
+ +
+ +### 2. Calculator Keyboard + +在做计算器，需要Calculator键盘。 +M5Core和FACE底板，再加上Calculator键盘之后，烧录你的固件到M5Core，固件里读取所按下按键的键值，并执行该按键触发的事件，就可以Calculator键盘功能。 + +
+ +
+ +### 3. QWERTY Keyboard + +在你做以M5Core为主控的终端需要全键盘输入时，堆叠QWERTY模块，烧录对应固件到M5Core，固件里读取所按下按键的键值，并执行该按键触发的事件，。 + + +烧录如下例程(例程功能: M5Core显示屏和串口终端打印按下的按键) + +- **例程文件** - a. [Arduino](https://github.com/m5stack/M5Stack/tree/master/examples/Modules/FACES) - b. [MicroPython](https://github.com/m5stack/M5Cloud/tree/master/examples/FACES)(for M5Cloud) + +- **M5Cloud使用方法** - [MicroPython(M5Cloud)](en/quick_start/m5core/m5stack_core_get_started_MicroPython_m5cloud) + +
+ +
+ + +### 4. FACES Charger充电座 + +**FACES Charger充电座**内置磁铁，充电时，能稳定地吸附FACES主机，并与FACES主机之间通过PIGO Pin连接。 + +
+ +
diff --git a/docs/zh_CN/quick_start/faces/gameboy_burn_a_nes_game.md b/docs/zh_CN/quick_start/faces/gameboy_burn_a_nes_game.md new file mode 100644 index 00000000..92693ad6 --- /dev/null +++ b/docs/zh_CN/quick_start/faces/gameboy_burn_a_nes_game.md @@ -0,0 +1,45 @@ +# 烧录GameBoy游戏 + +*这篇文档将引导你如何烧录游戏模拟器，并烧录想用的经典游戏，这样你就可以使用FACES Kit来玩GameBoy游戏。* + +## 目录 + +1. [下载固件](#1-download-firmware) + +2. [烧录固件和游戏文件](#2-burn-Game-file) + +3. [重启FACES](#3-reset-you-device) + +## 1. 下载固件 + +下载Gameboy模拟器，固件名为`firmware.zip`，下载地址：[Github](https://github.com/m5stack/M5Stack-nesemu)， 然后解压`firmware.zip`(*包括启动文件bootloader.bin,分区表文件, 模拟器文件, 游戏文件SuperMario*)。 + +
+ +
+ +
+ +
+ +## 2. 烧录固件和游戏文件 + +打开乐鑫提供的烧录工具[Flash Download Tools](https://www.espressif.com/sites/default/files/tools/flash_download_tools_v3.6.4.rar>)，选择 `ESP32 DownloadTool` 选项，选择`firmware.zip`解压后的四个文件，并执行如下图的**步骤2-4**( *选择正确的串口号，擦除flash和烧录固件* ) + +
+ +
+ +
+ +
+ +## 3. 重启FACES + +重启FACES之后，这时候就可以玩游戏啦。 + +
+ +
+ +?> Tip *如果你想换另一个游戏，只需替换**游戏文件**，再用以上工具烧录即可。注意是要使用NES格式的游戏文件。**