From f3108ef0fc772a580c717a32dd1d81250c616910 Mon Sep 17 00:00:00 2001 From: vany5921 <908744431@qq.com> Date: Thu, 2 Apr 2020 11:05:52 +0800 Subject: [PATCH] update doc format --- docs/en/core/atom_lite.md | 2 +- docs/en/core/atom_matrix.md | 2 +- docs/en/core/basic.md | 2 +- docs/en/core/face_kit.md | 32 ++------------ docs/en/core/fire.md | 5 +-- docs/en/core/gray.md | 3 +- docs/en/core/m5go.md | 5 +-- docs/en/core/m5go_lite.md | 4 +- docs/en/core/m5stick.md | 4 +- docs/en/core/m5stickc.md | 6 +-- docs/en/core/m5stickt.md | 9 ++-- docs/en/core/m5stickv.md | 3 +- docs/zh_CN/core/face_kit.md | 19 --------- docs/zh_CN/core/fire.md | 2 - docs/zh_CN/core/m5go_lite.md | 4 +- docs/zh_CN/core/m5stick.md | 2 +- docs/zh_CN/core/m5stickc.md | 6 +-- docs/zh_CN/core/m5stickt.md | 9 ++-- docs/zh_CN/unit/396port.md | 42 ++++++++++++++----- docs/zh_CN/unit/accel.md | 81 +++++++++++++++++++++++------------- docs/zh_CN/unit/adc.md | 62 ++++++++++++++++++++------- docs/zh_CN/unit/angle.md | 37 +++++++++++----- docs/zh_CN/unit/butterfly.md | 41 +++++++++++++----- docs/zh_CN/unit/button.md | 21 +++++----- 24 files changed, 231 insertions(+), 172 deletions(-) diff --git a/docs/en/core/atom_lite.md b/docs/en/core/atom_lite.md index bbb47c00..1e798656 100644 --- a/docs/en/core/atom_lite.md +++ b/docs/en/core/atom_lite.md @@ -27,7 +27,7 @@ - IoT node - Wearable peripherals -## Parameter +## Specification diff --git a/docs/en/core/atom_matrix.md b/docs/en/core/atom_matrix.md index 394e8198..5f00a732 100644 --- a/docs/en/core/atom_matrix.md +++ b/docs/en/core/atom_matrix.md @@ -30,7 +30,7 @@ - IoT node - Wearable peripherals -## Parameter +## Specification
diff --git a/docs/en/core/basic.md b/docs/en/core/basic.md index 3c0eddf9..8f1a995f 100644 --- a/docs/en/core/basic.md +++ b/docs/en/core/basic.md @@ -40,7 +40,7 @@ M5Stack Basic is consist with two separable parts. the upside part has all kinds - DIY creation - Smart home equipment -## Parameter +## Specification
diff --git a/docs/en/core/face_kit.md b/docs/en/core/face_kit.md index eda589a9..aa8f8aab 100644 --- a/docs/en/core/face_kit.md +++ b/docs/en/core/face_kit.md @@ -11,12 +11,10 @@ ### GameBoy Keyboard If your up for some classic video games. GameBoy panel plus M5Core is the perfect combination. All you need to do is to upload an emulator onto the M5Stack 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* +Download a gameboy game: https://docs.m5stack.com/#/en/quick_start/faces/gameboy_burn_a_nes_game Click here to download the one-click writer of the case game program - - The other panels are Calculator, Keyboard, Encoder, Joystick, Fingerprint, RFID and QWERTY Keyboard. To reduce the difficulty of disassembly when removing the replacement panel, it is recommended to remove the M5Core and then disassemble the panel. @@ -56,9 +54,6 @@ The other panels are Calculator, Keyboard, Encoder, Joystick, Fingerprint, RFID - DIY creation -### Calculator Keyboard - - Key string values
@@ -149,22 +144,9 @@ Key Int Values (Int values are the ASCII value of each key)
48-57424543 619646
-### QWERTY Keyboard - - - -### FACE Charger -Other than 3 functional panels, this development kit comes with more stuff like a charging base with Magnet and POGO pin connector. - - - *For more information on M5Stack series development board, please check the **Gray Kit*** - - - - -## PARAMETER +## Specification @@ -300,9 +282,6 @@ Other than 3 functional panels, this development kit comes with more stuff like - [ESP32](https://m5stack.oss-cn-shenzhen.aliyuncs.com/resource/docs/datasheet/core/esp32_datasheet_en.pdf) - [MPU6886](https://m5stack.oss-cn-shenzhen.aliyuncs.com/resource/docs/datasheet/core/MPU-6886-000193%2Bv1.1_GHIC_en.pdf) - [BMM150](https://m5stack.oss-cn-shenzhen.aliyuncs.com/resource/docs/datasheet/core/BMM150_datasheet_en.pdf) - -- **Register Manual** - - [IP5306](https://m5stack.oss-cn-shenzhen.aliyuncs.com/resource/docs/datasheet/core/IIC_IP5306_REG_V1.4_cn.pdf) **IP5306 charging/discharging，Voltage parameter** @@ -398,12 +377,7 @@ For more information about Pin assignment and Pin Remapping, Please refer to [ES ## Example -- Click [here](https://github.com/m5stack/M5Stack/tree/master/examples/Modules/FACES) to download Arduino code - -
-**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, it means that the main.py file is missing, but you can add your own, don't worry.
- +- Click [here](https://github.com/m5stack/M5Stack/tree/master/examples/Face) to download Arduino code ## User Work - **[2048 Game with FACES Kit- Video](https://www.youtube.com/watch?v=ccEq0s7dU84)** diff --git a/docs/en/core/fire.md b/docs/en/core/fire.md index d8cab19f..9e886b23 100644 --- a/docs/en/core/fire.md +++ b/docs/en/core/fire.md @@ -49,7 +49,7 @@ The GPIO 16 / 17 in Fire is connected to the PSRAM by default, so when you conne - Stem education product - DIY creation -## PARAMETER +## Specification
@@ -323,9 +323,6 @@ For more information about Pin assignment and Pin Remapping, Please refer to [ES - [MPU6886](https://m5stack.oss-cn-shenzhen.aliyuncs.com/resource/docs/datasheet/core/MPU-6886-000193%2Bv1.1_GHIC_en.pdf) - [BMM150](https://m5stack.oss-cn-shenzhen.aliyuncs.com/resource/docs/datasheet/core/BMM150_datasheet_en.pdf) - [SH200Q](https://m5stack.oss-cn-shenzhen.aliyuncs.com/resource/docs/datasheet/core/SH200Q_en.pdf) - -- **Register Manual** - - [IP5306](https://m5stack.oss-cn-shenzhen.aliyuncs.com/resource/docs/datasheet/core/IIC_IP5306_REG_V1.4_cn.pdf) ## Version Change diff --git a/docs/en/core/gray.md b/docs/en/core/gray.md index 1b292686..587d11b3 100644 --- a/docs/en/core/gray.md +++ b/docs/en/core/gray.md @@ -43,7 +43,7 @@ If you ever played with ESP8266, you would realize that ESP32 is a perfect upgra - Stem education product - DIY creation -## PARAMETER +## Specification
@@ -305,6 +305,7 @@ For more information about Pin assignment and Pin Remapping, Please refer to [ES ## Example ### ArduinoIDE + - Click [here](https://github.com/m5stack/M5Stack/tree/master/examples/Basics)to download Arduino code diff --git a/docs/en/core/m5go.md b/docs/en/core/m5go.md index eca62294..4d5dc2ee 100644 --- a/docs/en/core/m5go.md +++ b/docs/en/core/m5go.md @@ -39,7 +39,7 @@ This M5GO kit is specifically designed for STEM education. The pack includes 1 M - Stem education product - DIY creation -## PARAMETER +## Specification
@@ -318,8 +318,7 @@ To complete schematic, click [here](https://github.com/m5stack/M5-Schematic/tree ## Schematic -- **Schematic** - - [BASIC](https://m5stack.oss-cn-shenzhen.aliyuncs.com/resource/docs/schematic/Core/M5-Core-Schematic(20171206).pdf) +- [BASIC](https://m5stack.oss-cn-shenzhen.aliyuncs.com/resource/docs/schematic/Core/M5-Core-Schematic(20171206).pdf) ## Version Change diff --git a/docs/en/core/m5go_lite.md b/docs/en/core/m5go_lite.md index cab333fe..79ee76ed 100644 --- a/docs/en/core/m5go_lite.md +++ b/docs/en/core/m5go_lite.md @@ -38,7 +38,7 @@ The newly-produced M5Core replaces the screen with better display performance an - Stem education product - DIY creation -## PARAMETER +## Specification
@@ -313,7 +313,7 @@ For more information about Pin assignment and Pin Remapping, Please refer to [ES ## Schematic -- **Schematic** - [BASIC](https://m5stack.oss-cn-shenzhen.aliyuncs.com/resource/docs/schematic/Core/M5-Core-Schematic(20171206).pdf) +- [BASIC](https://m5stack.oss-cn-shenzhen.aliyuncs.com/resource/docs/schematic/Core/M5-Core-Schematic(20171206).pdf) ## Version Change diff --git a/docs/en/core/m5stick.md b/docs/en/core/m5stick.md index 24bbdcc9..e41abca8 100644 --- a/docs/en/core/m5stick.md +++ b/docs/en/core/m5stick.md @@ -46,7 +46,7 @@ This tiny block is able to realize your idea, enlighten your creativity, and hel - DIY creation -## PARAMETER +## Specification
@@ -225,7 +225,7 @@ This tiny block is able to realize your idea, enlighten your creativity, and hel -To complete schematic, click [here](https://github.com/m5stack/M5-Schematic/tree/master/Core/m5stick). +[schematic](https://github.com/m5stack/M5-Schematic/tree/master/Core/m5stick). ## Related Link diff --git a/docs/en/core/m5stickc.md b/docs/en/core/m5stickc.md index 2283aaee..3eb4d971 100644 --- a/docs/en/core/m5stickc.md +++ b/docs/en/core/m5stickc.md @@ -59,7 +59,7 @@ Installation steps: 1. Click the link below to download the driver installation Driver download Link -## PARAMETER +## Specification
@@ -292,9 +292,9 @@ Resolution：80 * 160 **Arduino** -[M5StickC facory test code](https://github.com/m5stack/M5StickC/tree/master/examples/Basics/FactoryTest) +- [M5StickC facory test code](https://github.com/m5stack/M5StickC/tree/master/examples/Basics/FactoryTest) -[M5StickC Vending Machine](https://github.com/m5stack/M5-ProductExampleCodes/tree/master/App/M5StickC_Slot) +- [M5StickC Vending Machine](https://github.com/m5stack/M5-ProductExampleCodes/tree/master/App/M5StickC_Slot) **UIFlow** diff --git a/docs/en/core/m5stickt.md b/docs/en/core/m5stickt.md index 0d48bcfc..90ca0b7a 100644 --- a/docs/en/core/m5stickt.md +++ b/docs/en/core/m5stickt.md @@ -61,7 +61,7 @@ Installation steps: 1. Click the link below to download the driver installation ## Usage Press the reset button to power on. The default display screen is RGB display mode. The left side is the temperature image, the upper right is the power display, and the lower right is the histogram and temperature range. The temperature range is automatically adjusted with the target temperature. The default bulls-eye automatically tracks the maximum temperature. Press the right button-A to switch the tracking mode (minimum / center / maximum value), press the button-B to switch the image display mode (GRAY / GOLDEN / RAINBOW / IRONBLACK / RGB). Dial encoder controls the display sensitivity (adjust the display temperature and color gamut), and long press the reset button for 6 seconds to turn off. -## PARAMETER +## Specification
@@ -232,16 +232,15 @@ Resolution：135 * 240 - [Lepton enigneering datasheet](https://m5stack.oss-cn-shenzhen.aliyuncs.com/resource/docs/datasheet/application/flir-lepton-engineering-datasheet_en.pdf) - [Lepton software interface description](https://m5stack.oss-cn-shenzhen.aliyuncs.com/resource/docs/datasheet/application/flir-lepton-software-interface-description-document_en.pdf) +- **3D Printer STL File** + - [STL](https://github.com/m5stack/m5-structural-design-file/tree/master/M5StickT) + ## Example ### Arduino IDE - If you want the complete code, please click [here](https://github.com/m5stack/M5-StickT/tree/master/M5_StickC_Lepton_opensource_v1) -### 3D Printer STL File - -[STL](https://github.com/m5stack/m5-structural-design-file/tree/master/M5StickT) -