diff --git a/docs/assets/img/product_pics/hat/env_hat/env_hat_04.jpg b/docs/assets/img/product_pics/hat/env_hat/env_hat_04.jpg new file mode 100644 index 00000000..ad920e08 Binary files /dev/null and b/docs/assets/img/product_pics/hat/env_hat/env_hat_04.jpg differ diff --git a/docs/assets/img/product_pics/hat/pir_hat/pir_hat_04.jpg b/docs/assets/img/product_pics/hat/pir_hat/pir_hat_04.jpg new file mode 100644 index 00000000..af532c5a Binary files /dev/null and b/docs/assets/img/product_pics/hat/pir_hat/pir_hat_04.jpg differ diff --git a/docs/assets/img/product_pics/hat/spk_hat/spk_hat_04.jpg b/docs/assets/img/product_pics/hat/spk_hat/spk_hat_04.jpg new file mode 100644 index 00000000..3aea5526 Binary files /dev/null and b/docs/assets/img/product_pics/hat/spk_hat/spk_hat_04.jpg differ diff --git a/docs/en/app/demo-board.md b/docs/en/app/demo-board.md index 4e969558..984dba3f 100644 --- a/docs/en/app/demo-board.md +++ b/docs/en/app/demo-board.md @@ -4,7 +4,8 @@ *** -:memo:**[Description](#Description)**   :electric_plug:**[Schematic](#Schematic)**      :bulb:**[Quick Start](#Quick-Start)**   :octocat:**[Example](#Example)**   πŸ›’**[Purchase](https://item.taobao.com/item.htm?spm=a2oq0.12575281.0.0.55a11debQawlvD&ft=t&id=595173726730)**       +:memo:**[Description](#Description)**    :electric_plug:**[Schematic](#Schematic)**    :bulb:**[Quick Start](#Quick-Start)**    :octocat:**[Example](#Example)**    πŸ›’**[Purchase](https://item.taobao.com/item.htm?spm=a2oq0.12575281.0.0.55a11debQawlvD&ft=t&id=595173726730)**       + ## Description @@ -41,9 +42,9 @@ -# Quick Start +# Quick-Start -?>[Click here to view the Quick Start](https://m5stack.oss-cn-shenzhen.aliyuncs.com/resource/docs/Demo-Board_cn.pdf) +?>[Click here to view the Quick Start](https://m5stack.oss-cn-shenzhen.aliyuncs.com/resource/docs/Demo-Board_en.pdf) ## Specification diff --git a/docs/en/core/face_kit.md b/docs/en/core/face_kit.md index 0fdc5865..4336a5a2 100644 --- a/docs/en/core/face_kit.md +++ b/docs/en/core/face_kit.md @@ -93,3 +93,8 @@ For more information about Pin assignment and Pin Remapping, Please refer to EPS The error message displayed on the screen, is actually normal, it doesn't mean something wrong with the hardware, don't worry.
+ +## User Work +- **[2048 Game with FACES Kit- Video](https://www.youtube.com/watch?v=ccEq0s7dU84)** +- **[2048 Game with FACES Kit- Source Code](https://github.com/phillowcompiler/2048_M5Stack)** + diff --git a/docs/en/core/m5stick.md b/docs/en/core/m5stick.md index 39197f2f..7e833bb3 100644 --- a/docs/en/core/m5stick.md +++ b/docs/en/core/m5stick.md @@ -121,7 +121,7 @@ M5stick is one of the core devices in M5Stack product series which is built in a -If you want the complete schematic, please click [here](https://github.com/m5stack/M5-Schematic/tree/master/Core/m5stick). +To complete schematic, click [here](https://github.com/m5stack/M5-Schematic/tree/master/Core/m5stick). ## Related Link diff --git a/docs/en/hat/hat-env.md b/docs/en/hat/hat-env.md index 7ef9ac60..ad18153b 100644 --- a/docs/en/hat/hat-env.md +++ b/docs/en/hat/hat-env.md @@ -52,9 +52,18 @@ Typical Magnetic Field： - **[BMM150 Datasheet](https://pdf1.alldatasheet.com/datasheet-pdf/view/608913/ETC2/BMM150.html)** +## Example +- **[Arduino](https://github.com/m5stack/M5StickC/tree/master/examples/Hat/ENV)** + ### Pin Map
M5Core(GROVE A)GPIO22GPIO215VGND
ENV UnitSCLSDA5VGND
+ +## Schematic + + + + diff --git a/docs/en/hat/hat-pir.md b/docs/en/hat/hat-pir.md index 8839ea39..2f51d572 100644 --- a/docs/en/hat/hat-pir.md +++ b/docs/en/hat/hat-pir.md @@ -42,5 +42,15 @@ - **[Official forum](http://forum.m5stack.com/)** +<<<<<<< HEAD +- **[Schematic](https://github.com/m5stack/M5-Schematic/blob/master/Hat/StickHat_PIR.pdf)** + +## Example +- **[Arduino](https://github.com/m5stack/M5StickC/tree/master/examples/Hat/PIR)** +======= +>>>>>>> 6786aadd2684c17d8e8f741bda46cecb710c2ca9 +## Schematic + + diff --git a/docs/en/hat/hat-spk.md b/docs/en/hat/hat-spk.md index ea73ca68..b380f742 100644 --- a/docs/en/hat/hat-spk.md +++ b/docs/en/hat/hat-spk.md @@ -41,3 +41,10 @@ + +## Example +- **[Arduino](https://github.com/m5stack/M5StickC/tree/master/examples/Hat/SPK)** + +## Schematic + + diff --git a/docs/en/module/encoder.md b/docs/en/module/encoder.md index 49062933..94c97c3b 100644 --- a/docs/en/module/encoder.md +++ b/docs/en/module/encoder.md @@ -4,7 +4,7 @@ *** -:memo:**[Description](#Description)**      :octocat:**[Example](#Example)**      :electric_plug:**[Schematic](#Schematic)**      πŸ›’**[Purchase](https://www.aliexpress.com/store/product/M5Stack-Encoder-Panel-for-M5Stack-FACES-ESP32-Pocket-Computer-with-12pcs-NeoPixel-LED-MEGA328-Inside-I2C/3226069_32960440900.html?spm=2114.12010615.8148356.16.24884ead1iqJmC)** +:memo:**[Description](#Description)**      :octocat:**[Example](#Example)**      πŸ›’**[Purchase](https://www.aliexpress.com/store/product/M5Stack-Encoder-Panel-for-M5Stack-FACES-ESP32-Pocket-Computer-with-12pcs-NeoPixel-LED-MEGA328-Inside-I2C/3226069_32960440900.html?spm=2114.12010615.8148356.16.24884ead1iqJmC)** ## Description diff --git a/docs/en/module/proto_kit.md b/docs/en/module/proto_kit.md index 6917948c..a068f122 100644 --- a/docs/en/module/proto_kit.md +++ b/docs/en/module/proto_kit.md @@ -9,7 +9,9 @@ ## Description -In comparision,**PROTO function Module** includes more stuff than PROTO Board.Other than the PROTO board, it also comes with a DHT12(temperature and humility sensor), M-BUS Socket and more. PROTO Board is a pure universal prototype perboard. You can have the total freedom to make your own project as you want it, with prototyping perboards that allows laying out customized circult to interact with the M5 core via M-BUS. +In comparision,**PROTO function Module** includes more stuff than PROTO Board.Other than the PROTO board, it also comes with a DHT12(temperature and humility sensor), M-BUS Socket and more. +
+PROTO Board is a pure universal prototype perboard. You can have the total freedom to make your own project as you want it, with prototyping perboards that allows laying out customized circult to interact with the M5 core via M-BUS. ## Product Features diff --git a/docs/en/module/servo.md b/docs/en/module/servo.md index 140c1443..7f7e5063 100644 --- a/docs/en/module/servo.md +++ b/docs/en/module/servo.md @@ -4,7 +4,7 @@ *** -:clapper: **[Video Tutorial](#Video-Tutorial)**      :memo:**[Description](#Description)**      :octocat:**[Example](#Example)**      :electric_plug:**[Schematic](#Schematic)**      πŸ›’**[Purchase](https://www.aliexpress.com/store/product/M5Stack-New-SERVO-Module-Board-12-Channels-Servo-Controller-with-MEGA328-Inside-Power-Adapter-6-24V/3226069_32951356502.html?spm=a2g1y.12024536.productList_5885011.pic_0)**      :clapper:**[Related Video](#Related-Video)** +:memo:**[Description](#Description)**      :octocat:**[Example](#Example)**      :electric_plug:**[Schematic](#Schematic)**      πŸ›’**[Purchase](https://www.aliexpress.com/store/product/M5Stack-New-SERVO-Module-Board-12-Channels-Servo-Controller-with-MEGA328-Inside-Power-Adapter-6-24V/3226069_32951356502.html?spm=a2g1y.12024536.productList_5885011.pic_0)**      :clapper:**[Related Video](#Related-Video)** ## Description diff --git a/docs/en/quick_start/bala/bala_quick_start.md b/docs/en/quick_start/bala/bala_quick_start.md index c1ea0c37..8f79f510 100644 --- a/docs/en/quick_start/bala/bala_quick_start.md +++ b/docs/en/quick_start/bala/bala_quick_start.md @@ -1,6 +1,6 @@ # BALA Quick Start {docsify-ignore-all} -!>For building a M5Bala program, you need prepare M5Stack Fire or M5GO White as master. +!>To program M5Bala, you will need M5Stack Fire or M5GO as main controller. @@ -17,15 +17,15 @@ 1. Download [UIFlow](http://flow.m5stack.com) firmware - [How to dowmload Firmware](https://docs.m5stack.com/#/en/related_documents/how_to_burn_firmware) 2. WiFi Configuration - [How to Connect wifi on M5Core](https://docs.m5stack.com/#/en/related_documents/how_to_burn_firmware) -3. Find the POGO Pin, and stack M5Core over M5Bala wheel. +3. Align to the POGO Pin, stack M5Core onto the M5Bala wheel. -4. Click the Red button on the side of M5Core (double click for shutdown). +1. Press the Red button on side of M5Core (double click for shutdown). -5. Click the button on the side of M5Bala bottom to power on (double click for shutdown). +1. Press the button on side of M5Bala bottom to power on (double click for shutdown). diff --git a/docs/en/quick_start/m5camera/m5camera_quick_start.md b/docs/en/quick_start/m5camera/m5camera_quick_start.md index 5fd68fc7..f97d32dc 100644 --- a/docs/en/quick_start/m5camera/m5camera_quick_start.md +++ b/docs/en/quick_start/m5camera/m5camera_quick_start.md @@ -4,33 +4,31 @@ ## Text Tutorial -It is really really out of the box. Your ESP32Cam/M5Camera will immediately run without any code after you power it. - -1. plug usb cable into ESP32Cam/M5Camera and open the serial terminal on your computer. +With preloaded firmware, your ESP32Cam/M5Camera would run right after power on. +1. Power on the cable into ESP32Cam/M5Camera by USB cable.
-2. Then waitting a few seconds, you connect to a AP named "`M5CAM`" with your computer(or mobile phone). +1. After waitting for a few seconds, Wi-Fi scan a AP named "`M5CAM`" with your computer(or mobile phone), and connect it.
-3. And you open the browser on the computer(or mobile phone), enter a URL `http://192.168.4.1`. At the moment, your can see the real-time transmission of video by ESP32Cam/M5Camera on the browser. +1. Open up the browser on the computer(or mobile phone), visit the URL `http://192.168.4.1`. At the moment, your can see the real-time transmission of video by ESP32Cam/M5Camera on the browser.
-Now, A WebCam you achieved successfully ! *Note:* -ESP32Cam/M5Camera AP only can connect with one device at a time. +ESP32Cam/M5Camera AP can only connect with one device at a time. ## Video Tutorial diff --git a/docs/en/unit/butterfly.md b/docs/en/unit/butterfly.md index 6140a812..290dc637 100644 --- a/docs/en/unit/butterfly.md +++ b/docs/en/unit/butterfly.md @@ -4,7 +4,11 @@ *** +<<<<<<< HEAD +:memo:**[Description](#Description)**      :bulb:**[Assembly Steps](#Assembly-Steps)**      πŸ›’**[Purchase](https://www.aliexpress.com/store/product/M5Stack-Official-Rubber-Band-Powered-Butterfly-Launcher-with-SERVO-control-and-GROVE-Cable-Adapter-Children-s/3226069_32956965036.html?spm=2114.12010615.8148356.2.486b2682Z5xogF)**       +======= :memo:**[Description](#Description)**      :bulb:**[Steps](#Steps)**      πŸ›’**[Purchase](https://www.aliexpress.com/store/product/M5Stack-Official-Rubber-Band-Powered-Butterfly-Launcher-with-SERVO-control-and-GROVE-Cable-Adapter-Children-s/3226069_32956965036.html?spm=2114.12010615.8148356.2.486b2682Z5xogF)**       +>>>>>>> 6786aadd2684c17d8e8f741bda46cecb710c2ca9 ## Description @@ -24,7 +28,7 @@ For more infomation please check out the video. - GROVE interface, support [UIFlow](http://flow.m5stack.com) and [Arduino](http://www.arduino.cc) -## Steps +## Assembly-Steps 1, download this [example](https://github.com/m5stack/M5-ProductExampleCodes/tree/master/Unit/BUTTERFLY/UIFlow) into Core. 2, Wire the Core with Launcher by GROVE cable and Grove2Pin converter diff --git a/docs/en/unit/finger.md b/docs/en/unit/finger.md index 17ea6c00..96937ce7 100644 --- a/docs/en/unit/finger.md +++ b/docs/en/unit/finger.md @@ -120,6 +120,13 @@ res1 = fpm_deleteAllUser(); - **FINGER Application** + + +- **FINGER UIflow Video Tutorial** + + \ No newline at end of file diff --git a/docs/en/unit/m5camera_f.md b/docs/en/unit/m5camera_f.md index fc067463..883169ca 100644 --- a/docs/en/unit/m5camera_f.md +++ b/docs/en/unit/m5camera_f.md @@ -4,7 +4,7 @@ *** -:memo:**[Description](#Description)**      :bulb:**[Quick Start](en/quick_start/m5camera/m5camera_quick_start)**      :octocat:**[Code](#Code)**      :electric_plug:**[Schematic](#Schematic)**       πŸ›’[Purchase](https://www.aliexpress.com/store/product/M5Stack-New-Fish-eye-Camera-Module-OV2640-Fisheye-Mini-Camera-Unit-Demoboard-with-ESP32-PSRAM-Development/3226069_32973208335.html?spm=a2g1y.12024536.productList_5885013.subject_2)** +:memo:**[Description](#Description)**      :bulb:**[Quick Start](en/quick_start/m5camera/m5camera_quick_start)**      :octocat:**[Code](#Code)**      :electric_plug:**[Schematic](#Schematic)**       πŸ›’[Purchase]**(https://www.aliexpress.com/store/product/M5Stack-New-Fish-eye-Camera-Module-OV2640-Fisheye-Mini-Camera-Unit-Demoboard-with-ESP32-PSRAM-Development/3226069_32973208335.html?spm=a2g1y.12024536.productList_5885013.subject_2)** ## Description diff --git a/docs/en/unit/neoflash.md b/docs/en/unit/neoflash.md index c1306a3c..c3824cd1 100644 --- a/docs/en/unit/neoflash.md +++ b/docs/en/unit/neoflash.md @@ -72,7 +72,7 @@ This is a example that takes real-time time from the network and displays it on ## Related Video -**Neoflash's Tutorial** +**Neoflash Video Tutorial on UIFlow**