diff --git a/docs/assets/img/product_pics/core/faces_kit/face_01.jpg b/docs/assets/img/product_pics/core/faces_kit/face_01.jpg new file mode 100644 index 00000000..f6300699 Binary files /dev/null and b/docs/assets/img/product_pics/core/faces_kit/face_01.jpg differ diff --git a/docs/assets/img/product_pics/core/faces_kit/face_02.jpg b/docs/assets/img/product_pics/core/faces_kit/face_02.jpg new file mode 100644 index 00000000..9669e5ee Binary files /dev/null and b/docs/assets/img/product_pics/core/faces_kit/face_02.jpg differ diff --git a/docs/assets/img/product_pics/core/faces_kit/face_03.jpg b/docs/assets/img/product_pics/core/faces_kit/face_03.jpg new file mode 100644 index 00000000..18436d17 Binary files /dev/null and b/docs/assets/img/product_pics/core/faces_kit/face_03.jpg differ diff --git a/docs/assets/img/product_pics/core/faces_kit/face_04.jpg b/docs/assets/img/product_pics/core/faces_kit/face_04.jpg new file mode 100644 index 00000000..8a57d1dc Binary files /dev/null and b/docs/assets/img/product_pics/core/faces_kit/face_04.jpg differ diff --git a/docs/assets/img/product_pics/core/faces_kit/face_05.jpg b/docs/assets/img/product_pics/core/faces_kit/face_05.jpg new file mode 100644 index 00000000..5e50135b Binary files /dev/null and b/docs/assets/img/product_pics/core/faces_kit/face_05.jpg differ diff --git a/docs/en/core/basic.md b/docs/en/core/basic.md index b4a20431..06885c37 100644 --- a/docs/en/core/basic.md +++ b/docs/en/core/basic.md @@ -4,7 +4,7 @@ * * * -:memo:**[Description](#Description)**      :bulb:**[Quick Start](en/quick_start/m5core/m5stack_core_quick_start)**      :octocat:**[Example](https://github.com/m5stack/M5Stack/tree/master/examples/Basics)**      :electric_plug:**[Schematic](https://github.com/m5stack/M5-Schematic/blob/master/Core/Basic/M5-Core-Schematic(20171206).pdf)**        πŸ›’**[Purchase](https://www.aliexpress.com/store/product/M5Stack-Official-Stock-Offer-ESP32-Basic-Core-Development-Kit-Extensible-Micro-Control-Wifi-BLE-IoT-Prototype/3226069_32837164440.html?spm=2114.12010615.8148356.2.3b9b2de96y27jH)**      :clapper:**[Related Video](#Related-Video)** +:memo:**[Description](#Description)**      :bulb:**[Quick Start](en/quick_start/m5core/m5stack_core_quick_start)**      :octocat:**[Example](https://github.com/m5stack/M5Stack/tree/master/examples/Basics)**      :electric_plug:**[Schematic](https://github.com/m5stack/M5-Schematic/blob/master/Core/Basic/M5-Core-Schematic(20171206).pdf)**        πŸ›’**[Purchase](https://m5stack.com/collections/m5-core/products/m5stack-official-stock-offer-esp32-basic-core-development-kit-extensible-micro-control-wifi-ble-iot-prototype-board-for-arduino)**      :clapper:**[Related Video](#Related-Video)** ## Description @@ -176,7 +176,7 @@ For more information about Pin assignment and Pin Remapping, Please refer to EPS -## Related Link +## Learn - **Datasheet** - [ESP32](https://www.espressif.com/sites/default/files/documentation/esp32_datasheet_cn.pdf) - [IP5306](https://github.com/m5stack/M5-Schematic/blob/master/Core/IIC_IP5306_REG_V1.4.pdf) @@ -186,7 +186,7 @@ For more information about Pin assignment and Pin Remapping, Please refer to EPS **M5Stack Instroduce** **M5Core Cases** diff --git a/docs/en/core/face_kit.md b/docs/en/core/face_kit.md index bbc8146f..19382766 100644 --- a/docs/en/core/face_kit.md +++ b/docs/en/core/face_kit.md @@ -1,23 +1,29 @@ # 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)** + + +:memo:**[Description](#Description)**   :bulb:**[Quick Start](en/quick_start/m5core/m5stack_core_quick_start)**   :octocat:**[Example](https://github.com/m5stack/M5Stack/tree/master/examples/Modules/FACES)**   :electric_plug:**[Schematic](https://github.com/m5stack/M5-Schematic/blob/master/Core/Basic/M5-Core-Schematic(20171206).pdf)**   πŸ›’**[Purchase](https://m5stack.com/collections/m5-core/products/face)**    + +## Description **FACES Kit** is a feast of functional panels, contains the most commonly used panels and keyboards with **MEGA328** processor inside, communication protocol through IIC(0x08) as slave mode. With these 3 different panels, it will be very easy to support keyboard interaction with your M5Core. +### GameBoy Keyboard If you up for some classic video game, GameBoy panel plus M5Core is the perfect combination. All you need to do is upload an game simulator onto M5 controller, and attach the GameBoy panel underneath. this is how it looks: *Download a gameboy game: https://docs.m5stack.com/#/en/quick_start/faces/gameboy_burn_a_nes_game* - + The other two panels are Calculator Keyboard and QWERTY Keyboard. - +### Calculator Keyboard ### QWERTY Keyboard - + +### FACE Charger Other than 3 functional panels, this development kit comes with more stuff like a charger table with Mangent and POGO pin connector. @@ -53,16 +59,6 @@ Other than 3 functional panels, this development kit comes with more stuff like -## Download the factory test code (Win) - -1. Go to [M5stack](https://m5stack.com/download) and download M5Burner. -2. Connect FACES to PC thru Type-C. -3. Find `FACES Kit` firmware and click **Burn** - - - - - ### Related Link @@ -70,36 +66,30 @@ Other than 3 functional panels, this development kit comes with more stuff like - **Register Manual** - [IP5306](https://github.com/m5stack/M5-Schematic/blob/master/Core/IIC_IP5306_REG_V1.4.pdf) -- **[M5Core Schematic](https://github.com/m5stack/M5-Schematic/blob/master/Core/Basic/M5-Core-Schematic(20171206).pdf)** - -- **[Example](https://github.com/m5stack/M5Stack/tree/master/examples/Modules/FACES)** - -- **[Panel 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 +**Notice1** +*The [Gray](zh_CN/core/gray) M5core is included in the FACES Kit. Similarly, other versions of M5Core can be stacked on the base of the FACES. The following picture is a comparison of their main differences.* -*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.* +- *For details click [here](https://github.com/m5stack/M5-Schematic/blob/master/Core/hardware_difference_between_cores_zh_CN.md)* -- *If you want to **view** the detailed defference with them, please click [here](https://github.com/m5stack/M5-Schematic/blob/master/Core/hardware_difference_between_cores.md).* - -- *If you want to **download** the detailed defference with them, please click [here](https://github.com/m5stack/M5-Schematic/blob/master/Core/M5%20Core%20Detailed%20Comparison.xlsx).* - - +- *Download chart click[here](https://github.com/m5stack/M5-Schematic/blob/master/Core/M5%20Core%20Detailed%20Comparison.xlsx)* - -**Notice：M5PORT EXPLAIN** +**Notice2：M5PORT EXPLAIN**
*You can identify the port name and function by its color, red is PortA(21/22) mainly used for I2C, black is PortB(26/36) which can be used for AD/DA, Singel-bus communication, Blue is PortC(16/17) can be used for Uart. Correspondingly, most of the M5 Units have the Port with matched color for specify which port it should go in on the M5Core. Those port identification is a convenience for UIFlow (Blockly) Users. For advanced using ,you can do you own customization, since most of the PIN on ESP32 are remapping-able. Unfortunatly, PortA(red) can not be used as analog read in. It refers to GPIO 21 & 22 from ESP32, which doesn't have AD channel alternatives:
- +
To use AD read function : 1, Use Dupont cable refers to the pins on the side which can be used as an AD channel. 2, Get a M5GO bottom, which comes with a PortB. 3, Get a PbHUB and connect it with PortA, then you can have 6 PortBs. For more information about Pin assignment and Pin Remapping, Please refer to EPS32 Datasheet* +
+**Notice3：Face Kit factory test code**
+The error message displayed on the screen, is actually normal, it doesn't mean something wrong with the hardware, don't worry.
+ + diff --git a/docs/en/core/fire.md b/docs/en/core/fire.md index a8cfb476..0ae13947 100644 --- a/docs/en/core/fire.md +++ b/docs/en/core/fire.md @@ -4,7 +4,7 @@ * * * -:memo:**[Description](#Description)**   :bulb:**[Quick Start](en/quick_start/m5core/m5stack_core_quick_start)**   :octocat:**[Example](https://github.com/m5stack/M5Stack/tree/master/examples/Basics)**   :electric_plug:**[Schematic](https://github.com/m5stack/M5-Schematic/blob/master/Core/Basic/M5-Core-Schematic(20171206).pdf)**   πŸ›’**[Purchase](https://www.aliexpress.com/store/product/M5Stack-NEW-PSRAM-2-0-FIRE-IoT-Kit-Dual-Core-ESP32-16M-FLash-4M-PSRAM-Development/3226069_32847906756.html?spm=2114.12010615.8148356.10.1c93724d7cJ5rG.html)**   :clapper:**[Related Video](#Related-Video)** +:memo:**[Description](#Description)**   :bulb:**[Quick Start](en/quick_start/m5core/m5stack_core_quick_start)**   :octocat:**[Example](https://github.com/m5stack/M5Stack/tree/master/examples/Basics)**   :electric_plug:**[Schematic](https://github.com/m5stack/M5-Schematic/blob/master/Core/Basic/M5-Core-Schematic(20171206).pdf)**   πŸ›’**[Purchase](https://m5stack.com/collections/m5-core/products/m5stack-new-psram-2-0-fire-iot-kit-dual-core-esp32-16m-flash-4m-psram-development-board-mic-ble-mpu9250-of-micropython)**   :clapper:**[Related Video](#Related-Video)** ## Description @@ -179,9 +179,9 @@ Supported development platforms and program languages: Arduino, Blockly language - *Download chart click[here](https://github.com/m5stack/M5-Schematic/blob/master/Core/M5%20Core%20Detailed%20Comparison.xlsx)。* - + - + **Notice2：M5PORT EXPLAIN ** *You can identify the port name and function by its color, red is PortA(21/22) mainly used for I2C, black is PortB(26/36) which can be used for AD/DA, Singel-bus communication, Blue is PortC(16/17) can be used for Uart. Correspondingly, most of the M5 Units have the Port with matched color for specify which port it should go in on the M5Core. @@ -214,7 +214,7 @@ For more information about Pin assignment and Pin Remapping, Please refer to EPS **m5stack instroduce** **m5stack Case - Piu UI framework with Moddable SDK** diff --git a/docs/en/core/gray.md b/docs/en/core/gray.md index f2da848f..c6091435 100644 --- a/docs/en/core/gray.md +++ b/docs/en/core/gray.md @@ -6,7 +6,7 @@ * * * -:memo:**[Description](#Description)**   :bulb:**[Quick Start](en/quick_start/m5core/m5stack_core_quick_start)**   :octocat:**[Example](https://github.com/m5stack/M5Stack/tree/master/examples/Basics)**   :electric_plug:**[Schematic](https://github.com/m5stack/M5-Schematic/blob/master/Core/Basic/M5-Core-Schematic(20171206).pdf)**   πŸ›’**[Purchase](https://www.aliexpress.com/store/product/M5Stack-Official-In-Stock-ESP32-Mpu9250-9Axies-Motion-Sensor-Core-Development-Kit-Extensible-IoT-Development-Board/3226069_32836393710.html?spm=2114.12010615.8148356.12.25e96be7zRik8r.html)**   :clapper:**[Related Video](#Related-Video)** +:memo:**[Description](#Description)**   :bulb:**[Quick Start](en/quick_start/m5core/m5stack_core_quick_start)**   :octocat:**[Example](https://github.com/m5stack/M5Stack/tree/master/examples/Basics)**   :electric_plug:**[Schematic](https://github.com/m5stack/M5-Schematic/blob/master/Core/Basic/M5-Core-Schematic(20171206).pdf)**   πŸ›’**[Purchase](https://m5stack.com/collections/m5-core/products/m5stack-official-in-stock-esp32-mpu9250-9axies-motion-sensor-core-development-kit-extensible-iot-development-board-for-arduino)**   :clapper:**[Related Video](#Related-Video)** ## Description @@ -169,9 +169,9 @@ Supported development platforms and program languages: Arduino, Blockly language - *Download chart click[here](https://github.com/m5stack/M5-Schematic/blob/master/Core/M5%20Core%20Detailed%20Comparison.xlsx)。* - + - + **Notice2：M5PORT EXPLAIN** *You can identify the port name and function by its color, red is PortA(21/22) mainly used for I2C, black is PortB(26/36) which can be used for AD/DA, Singel-bus communication, Blue is PortC(16/17) can be used for Uart. Correspondingly, most of the M5 Units have the Port with matched color for specify which port it should go in on the M5Core. @@ -195,7 +195,7 @@ For more information about Pin assignment and Pin Remapping, Please refer to EPS gray_04 -## Related Link +## Learn - **datasheet** - [ESP32](https://www.espressif.com/sites/default/files/documentation/esp32_datasheet_cn.pdf) - [MPU9250](https://www.invensense.com/download-pdf/mpu-9250-datasheet/) @@ -208,7 +208,7 @@ For more information about Pin assignment and Pin Remapping, Please refer to EPS **m5stack instroduce** **M5Core Cases** diff --git a/docs/en/core/m5go.md b/docs/en/core/m5go.md index 1cb4dba0..acc33449 100644 --- a/docs/en/core/m5go.md +++ b/docs/en/core/m5go.md @@ -6,7 +6,7 @@ * * * -:memo:**[Description](#Description)**   :bulb:**[Quick Start](en/quick_start/m5core/m5stack_core_quick_start)**   :octocat:**[Example](https://github.com/m5stack/M5Stack/tree/master/examples/Basics)**   :electric_plug:**[Schematic](https://github.com/m5stack/M5-Schematic/blob/master/Core/Basic/M5-Core-Schematic(20171206).pdf)**   πŸ›’**[Purchase](https://www.aliexpress.com/store/product/M5Stack-Official-Stock-Offer-M5GO-IoT-Starter-Kit-ESP32-for-Arduino-MicroPython-Programming-Development-IR-MIC/3226069_32881911596.html?spm=2114.12010615.8148356.4.44fa29faDagj56)**   :clapper:**[Related Video](#Related-Video)** +:memo:**[Description](#Description)**   :bulb:**[Quick Start](en/quick_start/m5core/m5stack_core_quick_start)**   :octocat:**[Example](https://github.com/m5stack/M5Stack/tree/master/examples/Basics)**   :electric_plug:**[Schematic](https://github.com/m5stack/M5-Schematic/blob/master/Core/Basic/M5-Core-Schematic(20171206).pdf)**   πŸ›’**[Purchase](https://m5stack.com/collections/m5-core/products/m5stack-official-stock-offer-m5go-iot-starter-kit-esp32-for-arduino-micropython-programming-development-ir-mic-600mah-battery)**   :clapper:**[Related Video](#Related-Video)** ## Description @@ -172,9 +172,9 @@ This M5GO kit is specifically designed for STEM education. The pack includes 1 M - *Download chart click[here](https://github.com/m5stack/M5-Schematic/blob/master/Core/M5%20Core%20Detailed%20Comparison.xlsx)。* - + - + **Notice2：M5PORT EXPLAIN** *You can identify the port name and function by its color, red is PortA(21/22) mainly used for I2C, black is PortB(26/36) which can be used for AD/DA, Singel-bus communication, Blue is PortC(16/17) can be used for Uart. Correspondingly, most of the M5 Units have the Port with matched color for specify which port it should go in on the M5Core. @@ -214,5 +214,5 @@ For more information about Pin assignment and Pin Remapping, Please refer to EPS - **m5stack instroduce** \ No newline at end of file diff --git a/docs/en/core/m5go_lite.md b/docs/en/core/m5go_lite.md index 2ca58d9a..426a2a99 100644 --- a/docs/en/core/m5go_lite.md +++ b/docs/en/core/m5go_lite.md @@ -9,7 +9,7 @@ * * * -:memo:**[Description](#Description)**   :bulb:**[Quick Start](en/quick_start/m5core/m5stack_core_quick_start)**   :octocat:**[Example](#Example)**   :electric_plug:**[Schematic](https://github.com/m5stack/M5-Schematic/blob/master/Core/Basic/M5-Core-Schematic(20171206).pdf)**   πŸ›’**[Purchase](https://www.aliexpress.com/store/product/M5Stack-NEW-Lite-IoT-Development-Board-Kit-ESP32-MPU9250-Grove-16MFlash-DHT12-Temperature-Humidity-Sensor-Module/3226069_32965981279.html?spm=a2g1y.12024536.productList_5885013.subject_3)**   :clapper:**[Related Video](#Related-Video)** +:memo:**[Description](#Description)**   :bulb:**[Quick Start](en/quick_start/m5core/m5stack_core_quick_start)**   :octocat:**[Example](#Example)**   :electric_plug:**[Schematic](https://github.com/m5stack/M5-Schematic/blob/master/Core/Basic/M5-Core-Schematic(20171206).pdf)**   πŸ›’**[Purchase](https://m5stack.com/collections/m5-core/products/m5stack-new-lite-iot-development-board-kit-esp32-mpu9250-grove-16mflash-dht12-temperature-humidity-sensor-module-for-arduino)**   :clapper:**[Related Video](#Related-Video)** ## DESCRIPTION @@ -173,9 +173,9 @@ All M5stack development board can be programmed through Arduino IDE, WebIDE UIFl - *Download chart click[here](https://github.com/m5stack/M5-Schematic/blob/master/Core/M5%20Core%20Detailed%20Comparison.xlsx)。* - + - + **Notice2：M5PORT EXPLAIN** *You can identify the port name and function by its color, red is PortA(21/22) mainly used for I2C, black is PortB(26/36) which can be used for AD/DA, Singel-bus communication, Blue is PortC(16/17) can be used for Uart. Correspondingly, most of the M5 Units have the Port with matched color for specify which port it should go in on the M5Core. @@ -253,5 +253,5 @@ float pressure = bme.readPressure(); - **m5stack instroduce** \ No newline at end of file diff --git a/docs/en/core/m5stick.md b/docs/en/core/m5stick.md index e3b2a81a..39197f2f 100644 --- a/docs/en/core/m5stick.md +++ b/docs/en/core/m5stick.md @@ -5,7 +5,7 @@ * * * -:memo:**[Description](#Description)**   :bulb:**[Quick Start](en/quick_start/m5stick/m5stick_quick_start)**   :octocat:**[Example](#Example)**     :electric_plug:**[Schematic](#Schematic)**     πŸ›’**[Purchase](https://www.aliexpress.com/store/product/M5Stack-Official-New-M5Stick-Mini-Development-Kit-ESP32-1-3-OLED-80mAh-Battery-Inside-Buzzer-IR/3226069_32947692973.html?spm=a2g1y.12024536.productList_5885011.subject_1)**   :clapper:**[Related Video](#Related-Video)** +:memo:**[Description](#Description)**   :bulb:**[Quick Start](en/quick_start/m5stick/m5stick_quick_start)**   :octocat:**[Example](#Example)**     :electric_plug:**[Schematic](#Schematic)**     πŸ›’**[Purchase](https://m5stack.com/collections/m5-core/products/m5stack-official-new-m5stick-mini-development-kit-esp32-1-3oled-80mah-battery-inside-buzzer-ir-transmitter-mpu9250-optional)**   :clapper:**[Related Video](#Related-Video)** ## Description @@ -102,9 +102,9 @@ M5stick is one of the core devices in M5Stack product series which is built in a - *Download chart click[here](https://github.com/m5stack/M5-Schematic/blob/master/Core/M5%20Core%20Detailed%20Comparison.xlsx)。* - + - + ## Include diff --git a/docs/en/core/m5stickc.md b/docs/en/core/m5stickc.md index e7c4c94d..6d86a055 100644 --- a/docs/en/core/m5stickc.md +++ b/docs/en/core/m5stickc.md @@ -4,7 +4,7 @@ * * * -:memo:**[Description](#Description)**   :bulb:**[Quick Start](en/quick_start/m5stickc/m5stickc_quick_start)**   :octocat:**[Example](#Example)**   πŸ›’**[Purchase](https://www.aliexpress.com/item/New-Arrival-2019-M5StickC-1-of-Limited-Trial-Edition-ESP32-PICO-Mini-IoT-Development-Board-Finger/32985247364.html)**   :clapper:**[Related Video](#Related-Video)** +:memo:**[Description](#Description)**   :bulb:**[Quick Start](en/quick_start/m5stickc/m5stickc_quick_start)**   :octocat:**[Example](#Example)**   πŸ›’**[Purchase](https://m5stack.com/collections/m5-core/products/new-arrival-2019-m5stickc-esp32-pico-mini-iot-development-board-finger-computer-with-color-lcd)**   :clapper:**[Related Video](#Related-Video)** ## Description @@ -131,6 +131,16 @@ M5stickC is one of the core devices in M5Stack product series which is built in ## Example +*Comparision Between Different Development Kits of M5* + +- *For details click [here](https://github.com/m5stack/M5-Schematic/blob/master/Core/hardware_difference_between_cores_zh_CN.md)。* + +- *Download chart click [here](https://github.com/m5stack/M5-Schematic/blob/master/Core/M5%20Core%20Detailed%20Comparison.xlsx)。* + + + + + * **Arduino** - [M5StickC facory test code](https://github.com/m5stack/M5StickC/tree/master/examples/Basics/FactoryTest)